Search Locations

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

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.

Show LocationSuggestion object

label

string

Display label for the suggestion (e.g. Lyon 69000).

city

string

City name (nullable).

zipcode

string

Postal code (nullable).

region_id

string

French region id (nullable).

region_name

string

Region name (nullable).

department_id

string

Department id (nullable).

department_name

string

Department name (nullable).

lat

number

Latitude (nullable).

lng

number

Longitude (nullable).

type

string

Suggestion type: city, department, or region.

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.

List Departments List Markets

Overview

Search

Ads

Sellers

Reference

Query Parameters

Response

Example Response

​Query Parameters

​Response

​Example Response

Query Parameters

Response

Example Response