Skip to main content
GET
Search geo IDs

Endpoint

Authentication

Include your API key in the request header:

Parameters

The place to look up, as you would type it in a location filter: a city (Lyon), a region (Île-de-France), a metropolitan area or a country (France). At most 100 characters.

Response

array
The places matching the text, best match first (up to 20), the same suggestions a location filter’s autocompletion offers.

Example Request

Example Response

Errors

See Error Handling for the full list of error codes and recommended handling.
  • 400 — MISSING_PARAMETER / INVALID_PARAMETER
  • 401 — INVALID_API_KEY
  • 402 — QUOTA_EXHAUSTED
  • 429 — RATE_LIMITED
  • 500 — INTERNAL_ERROR
  • 503 — SERVICE_UNAVAILABLE
A text that matches no place answers 200 with an empty elements list.

Notes

This endpoint consumes 1 credit per call. Errors are free. See Quotas.
A geo ID is stable: look it up once and keep it. Passing a location text to Search Jobs does this lookup for you on every call and keeps the first suggestion.

Authorizations

X-API-Key
string
header
required

Query Parameters

The place to look up: a city, region, metropolitan area or country (at most 100 characters).

Example:

"Lyon"

Response

Matching places

elements
object[]