Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Places

Browse a search area using a free text query

get/browse

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.

atstring latitude,longitude
Example:at=52.5308,13.3856

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.

categoriesstring
Example:categories: schools

This is a category filter consisting of a comma-separated list of categories. Places with any assigned categories that match any of the requested categories are included in the response.

instring
Example:in=countryCode:CAN,MEX,USA

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

Sets the maximum number of results to be returned.

langstring
Example:lang=en

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

Response