Locations

GET 
/api/locations

Returns a list of locations with their associated country codes. Each location includes the city, region, and country name in a structured format along with its ISO 3166-1 alpha-2 country code. In order to use the location with our google seearch api, you should use the full string provided in the location field.

Request

Query Parameters

country_code Country Code
location_contains Location Contains
limit Limit

Default value: 1000

Responses

200

OK

application/json

Schema

Schema

any

No filter location

Example of response without any filters

{
  "total_locations": 10,
  "locations": [
    {
      "location": "Kabul,Kabul,Afghanistan",
      "country_code": "AF"
    },
    {
      "location": "Luanda,Luanda Province,Angola",
      "country_code": "AO"
    },
    {
      "location": "The Valley,Anguilla",
      "country_code": "AI"
    },
    {
      "location": "Kralendijk,Bonaire,Caribbean Netherlands",
      "country_code": "BQ"
    },
    {
      "location": "Philipsburg,Sint Maarten",
      "country_code": "SX"
    },
    {
      "location": "Willemstad,Curacao",
      "country_code": "CW"
    },
    {
      "location": "Abu Dhabi,Abu Dhabi,United Arab Emirates",
      "country_code": "AE"
    },
    {
      "location": "Ajman,Ajman,United Arab Emirates",
      "country_code": "AE"
    },
    {
      "location": "Al Ain,Abu Dhabi,United Arab Emirates",
      "country_code": "AE"
    },
    {
      "location": "Dubai,Dubai,United Arab Emirates",
      "country_code": "AE"
    }
  ]
}

Country filter

Example of response when using the country filter

{
  "total_locations": 10,
  "locations": [
    {
      "location": "Algolsheim,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Cernay,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Colmar,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Ensisheim,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Erstein,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Ferrette,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Geispolsheim,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Haguenau,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Horbourg-Wihr,Grand Est,France",
      "country_code": "FR"
    },
    {
      "location": "Illkirch-Graffenstaden,Grand Est,France",
      "country_code": "FR"
    }
  ]
}

Country and location filter

Example of response when using the country filter and location filter

{
  "total_locations": 4,
  "locations": [
    {
      "location": "Paris,Paris,Ile-de-France,France",
      "country_code": "FR"
    },
    {
      "location": "Cormeilles-en-Parisis,Ile-de-France,France",
      "country_code": "FR"
    },
    {
      "location": "Villeparisis,Ile-de-France,France",
      "country_code": "FR"
    },
    {
      "location": "Seyssinet-Pariset,Auvergne-Rhone-Alpes,France",
      "country_code": "FR"
    }
  ]
}

Loading...