Search location

//native

type Foxentry = {

  apiKey: string;

};

/**

 * Search location

 * This enpoint mainly serves as autocomplete but can be used to search for specific addresses based on filter criteria as well. Foxentry will automatically offer you suggestions to complete the address you are writing down. Pay attention to the client section in the request body. You can specify the user's location in order to receive more relevant suggestions.

 */

export async function main(

  auth: Foxentry,

  api_version: string | undefined,

  foxentry_include_request_details: string | undefined,

  body: {

    request: {

      customId?: string;

      query: {

        type:

          | "street"

          | "streetWithNumber"

          | "number.full"

          | "number.part1"

          | "number.part2"

          | "city"

          | "zip"

          | "full";

        value: string;

        filter?: {

          street?: string;

          streetWithNumber?: string;

          "number.full"?: string;

          "number.part1"?: string;

          "number.part2"?: string;

          city?: string;

          zip?: string;

          country?: string;

        };

      };

      options?: {

        dataScope?: "full" | "basic";

        dataSource?: string[];

        zipFormat?: false | true;

        countryFormat?:

          | "alpha2"

          | "alpha3"

          | "local"

          | "localShortened"

          | "international"

          | "internationalShortened";

        cityFormat?: "basic" | "minimal" | "extended";

      };

      client?: {

        ip?: string;

        country?: string;

        location?: { lat?: number; lon?: number };

      };

    };

  },

) {

  const url = new URL(`https://api.foxentry.com/location/search`);

  const headers: Record<string, string> = {

    "Content-Type": "application/json",

    Authorization: "Bearer " + auth.apiKey,

  };

  if (api_version) {

    headers["api-version"] = api_version;

  }

  if (foxentry_include_request_details) {

    headers["foxentry-include-request-details"] = foxentry_include_request_details;

  }

  const response = await fetch(url, {

    method: "POST",

    headers,

    body: JSON.stringify(body),

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}