Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Places_Geocoding

Batch Geocode

post/geocode/batch

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

qstring required

Specify the free-text search query. Please note that whitespace, urls, email addresses, or other out-of-scope queries will yield no results.

atstring latitude,longitude

Specify the center of the search context expressed as coordinates.

Please note that one of "at", "in=circle" or "in=bbox" should be provided for relevant results.

instring

Search within a geographic area. This is a hard filter. Results will be returned if they are located within the specified area.

A geographic area can be

  • a country (or multiple countries), provided as comma-separated ISO 3166-1 alpha-3 country codes

    The country codes are to be provided in all uppercase.

    Format: countryCode:{countryCode}[,{countryCode}]

  • a circular area, provided as latitude, longitude, and radius (an integer with meters as unit)

    Format: circle:{latitude},{longitude};r={radius}

  • a bounding box, provided as west longitude, south latitude, east longitude, north latitude

    Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude}

Please provide one of 'at', 'in=circle' or 'in=bbox' input for a relevant result.

limitinteger

Maximum number of results to be returned. Please note that the minimum value that can be provided is 1 and the maximum that can be provided is 100.

langstring

Select the language to be used for result rendering from a list of BCP 47 compliant language codes.

Example request

[
  {
    "q": "\"q\":\"125, Berliner, berlin\"",
    "at": "\"at\": \"52.5308,13.3856\"",
    "in": "\"in\":\"countryCode:CAN,MEX,USA\"",
    "lang": "\"lang\":\"en\""
  }
]

Response