Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Places_Geocoding

Structured Geocode

get/geocode/structured

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.

countryCodestring required

Specify a valid ISO 3166-1 alpha-3 country code in which the place being searched should be located. Please note that this is a case-sensitive field and the country code should be in all uppercase.

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.

instring
Example:in=circle:52.53,13.38;r=10000

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 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.

statestring

Specify the state division of the country in which the place being searched should be located.

citystring

Specify the city in which the place being searched should be located.

countystring

Specify the county division of the state in which the place being searched should be located.

streetstring

Specify the name of the street in which the place being searched should be located.

houseNumberstring

Specify the house number of the place being searched.

postalCodestring

Specify the postal code in which the place being searched should be located.

Response