API Reference

Geocoding API Reference

Base URL

https://geocoder.maptoolkit.net

Endpoints

`GET /reverse`

Reverse geocoding — get address from coordinates

Returns the address at the given latitude and longitude.

Parameter	In	Type	Required	Description
`lat`	query	number	Yes	Latitude of the location.
`lon`	query	number	Yes	Longitude of the location. Also accepted as `lng`.
`callback`	query	string	No	Wraps the response in a JSONP callback function with this name.
`language`	query	string	No	Language for the result as an ISO 639-1 code. Default: de.
`lng`	query	number	No	Alias for `lon`.
`polygon`	query	integer	No	Set to `1` to include a GeoJSON polygon outline in the result. Default: 0. One of: `0`, `1`.

Status Description

200 Address at the given coordinates.

Status	Description
`200`	Address at the given coordinates.
`400`	Bad request or upstream geocoding error. General errors Upstream Nominatim error message forwarded as-is. Network or connection error message.

400

Bad request or upstream geocoding error.

General errors

Upstream Nominatim error message forwarded as-is.
Network or connection error message.

`POST /reverse`

Reverse geocoding — get address from coordinates (POST)

Same as GET but accepts parameters in the request body.

Status Description

200 Address at the given coordinates.

Status	Description
`200`	Address at the given coordinates.
`400`	Bad request or upstream geocoding error. General errors Upstream Nominatim error message forwarded as-is. Network or connection error message.

400

Bad request or upstream geocoding error.

General errors

Upstream Nominatim error message forwarded as-is.
Network or connection error message.

`GET /search`

Forward geocoding — search for places by name or address

Returns a ranked list of places matching the search term.

Parameter	In	Type	Required	Description
`q`	query	string	Yes	Address or place name to search for.
`bounded`	query	integer	No	Set to `1` to restrict results to the `viewbox` area. Default: 0. One of: `0`, `1`.
`callback`	query	string	No	Wraps the response in a JSONP callback function with this name.
`countrycodes`	query	string	No	Limits results to the specified countries as comma-separated ISO 3166-1 alpha-2 codes.
`language`	query	string	No	Language for result names as an ISO 639-1 code. Default: de.
`limit`	query	integer	No	Maximum number of results to return. Default: 10.
`polygon`	query	integer	No	Set to `1` to include a GeoJSON polygon outline for each result. Default: 0. One of: `0`, `1`.
`viewbox`	query	string	No	Preferred bounding box for results in `minLng,minLat,maxLng,maxLat` format. Default: -180,-85,180,85.

Status Description

200 Array of geocoding results ordered by relevance.

Status	Description
`200`	Array of geocoding results ordered by relevance.
`400`	Bad request or upstream geocoding error. General errors Upstream Nominatim error message forwarded as-is. Network or connection error message.

400

Bad request or upstream geocoding error.

General errors

Upstream Nominatim error message forwarded as-is.
Network or connection error message.

`POST /search`

Forward geocoding — search for places by name or address (POST)

Same as GET but accepts parameters in the request body.

Status Description

200 Array of geocoding results ordered by relevance.

Status	Description
`200`	Array of geocoding results ordered by relevance.
`400`	Bad request or upstream geocoding error. General errors Upstream Nominatim error message forwarded as-is. Network or connection error message.

400

Bad request or upstream geocoding error.

General errors

Upstream Nominatim error message forwarded as-is.
Network or connection error message.

Try it

The console below sends live requests against the endpoints above. You can browse it without an API key; Execute needs one, because every endpoint requires the api_key query parameter and returns 403 without it. Use Authorize to add your key. See First Steps if you do not have one yet.