Sign in
geocode

Autocompletion & geocoding that resolves user input addresses including coordinates

get/api/v1/geocode

Query parameters

textstring required

the (potentially partially typed) address to resolve

languagestring[]

language tags as used in OpenStreetMap (usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)

type'ADDRESS' | 'PLACE' | 'STOP'

location type

Optional. Default is all types.

Only return results of the given types. For example, this can be used to allow only ADDRESS and STOP results.

modeMode[]

Optional. Filter stops by available transport modes. Defaults to applying no filter.

placestring

Optional. Used for biasing results towards the coordinate.

Format: latitude,longitude in degrees

placeBiasnumber

Optional. Used for biasing results towards the coordinate. Higher number = higher bias.

numResultsinteger

Optional. Number of suggestions to return.

If omitted, 10 suggestions are returned by default. Must be <= server config variable geocode_max_suggestions.

Response

A list of guesses to resolve the text to a location

type'ADDRESS' | 'PLACE' | 'STOP' required

location type

categorystring

Experimental. Type categories might be adjusted.

For OSM stop locations: the amenity type based on https://wiki.openstreetmap.org/wiki/OpenStreetMap_Carto/Symbols

namestring required

name of the location (transit stop / PoI / address)

idstring required

unique ID of the location

latnumber required

latitude

lonnumber required

longitude

levelnumber

level according to OpenStreetMap (at the moment only for public transport)

streetstring

street name

houseNumberstring

house number

countrystring

ISO3166-1 country code from OpenStreetMap

zipstring

zip code

tzstring

timezone name (e.g. "Europe/Berlin")

scorenumber required

score according to the internal scoring system (the scoring algorithm might change in the future)

modesMode[]

available transport modes for stops

importancenumber

importance of a stop, normalized from [0, 1]

Changes