Skip to main content
Resolve a free-text place name (city, department, or region) into structured location suggestions you can use with the city, zipcode, region_id, or department_id search parameters.

​
Query Parameters

​
q
string
required
The location name to autocomplete (e.g. Lyon).

​
Response

​
query
string
The location query that was executed.
​
suggestions
array
Array of matching location suggestions.

​
Example Response

{
  "query": "Lyon",
  "suggestions": [
    {
      "label": "Lyon (69000)",
      "city": "Lyon",
      "zipcode": "69000",
      "region_id": "20",
      "region_name": "Auvergne-Rhône-Alpes",
      "department_id": "69",
      "department_name": "Rhône",
      "lat": 45.7578,
      "lng": 4.832,
      "type": "city"
    },
    {
      "label": "Rhône (69)",
      "region_id": "20",
      "region_name": "Auvergne-Rhône-Alpes",
      "department_id": "69",
      "department_name": "Rhône",
      "type": "department"
    }
  ]
}
Each location-search request costs 2 credits. Failed requests are not charged.