Location autocomplete suggestions
Returns location suggestions based on search query. Supports typo-tolerant search, postal code prefixes, administrative subregion codes (French department numbers), usual abbreviations, and filtering by administrative type.
Authorization
apiKey Value for the X-API-KEY header parameter.
In: header
Query Parameters
Search query string (minimum 1 character): a name, a postal code prefix, the code of an administrative subregion (a French department number such as 83), or a usual abbreviation such as PACA.
1 <= lengthAdministrative type filter. Supports a single value (?type=MUNICIPALITY) or array syntax (?type[]=MUNICIPALITY&type[]=MUNICIPAL_DISTRICT).
Maximum number of results.
0 <= value <= 3030The collection page number
1Response Body
curl -X GET "https://example.com/geo/autocomplete?query=paris&type=MUNICIPALITY&limit=10"[ { "name": "Paris", "locationType": "MUNICIPALITY", "parentName": "Paris", "regionName": "Île-de-France", "countryCode": "FR", "postalCode": "75001", "centroid": { "type": "Point", "coordinates": [ 2.3522, 48.8566 ] }, "metadata": { "depth": 3, "population": 2102650, "postalCodes": [ "75001", "75002", "75003" ], "uniqueCode": "75056" }, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }]List the descendants of an administrative division, at any depth GET
Returns every division below the given one, across intermediate levels, optionally filtered by type and bounded by maxDepth. maxDepth of 1 returns only the direct children. Use this to list, for example, every neighborhood of a city — including Paris, Lyon and Marseille, whose neighborhoods sit under an arrondissement. Set includeSelf=true to also return the division itself (its full scope: the division and everything below).
Get billable API usage analytics GET
Returns billable API usage aggregates for the authenticated API customer.