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)

typeLocationType[]

Optional. Default is all types.

Only return results matching one 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.

minstring

latitude,longitude pair of the lower right coordinate of the bounding box containing all results

maxstring

latitude,longitude pair of the upper left coordinate of the bounding box containing all results

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

Changed in 6 of the 52 revisions of this API.9715

  • dbfe4b7f2bab11See the full diff
    • ●

      added the new HGV enum value to the items/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value HGV to the property items/ of the query request parameter mode

      request-parameter-property-enum-value-added

  • 2ad91806777f2See the full diff
    • ○

      added the new optional query request parameter max

      new-optional-request-parameter

    • ○

      added the new optional query request parameter min

      new-optional-request-parameter

  • 26803b66a16b4See the full diff
    • ▲

      removed the enum value ADDRESS from the query request parameter type

      request-parameter-enum-value-removed

    • ▲

      removed the enum value PLACE from the query request parameter type

      request-parameter-enum-value-removed

    • ▲

      removed the enum value STOP from the query request parameter type

      request-parameter-enum-value-removed

    • ▲

      for the query request parameter type, the type/format was changed from string/ to array/

      request-parameter-type-changed

  • fcec2b4dd9761See the full diff
    • ○

      added the new optional query request parameter numResults

      new-optional-request-parameter

  • 6775a2d6764d33See the full diff
    • ●

      added the new DEBUG_BUS_ROUTE enum value to the items/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DEBUG_FERRY_ROUTE enum value to the items/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DEBUG_RAILWAY_ROUTE enum value to the items/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value DEBUG_BUS_ROUTE to the property items/ of the query request parameter mode

      request-parameter-property-enum-value-added

    • ○

      added the enum value DEBUG_FERRY_ROUTE to the property items/ of the query request parameter mode

      request-parameter-property-enum-value-added

    • ○

      added the enum value DEBUG_RAILWAY_ROUTE to the property items/ of the query request parameter mode

      request-parameter-property-enum-value-added

  • b7bf68a0d6f3538See the full diff
    • ▲

      the query request parameter type was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      removed the enum value DEBUG_BUS_ROUTE from the property items/ of the query request parameter mode

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value DEBUG_FERRY_ROUTE from the property items/ of the query request parameter mode

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value DEBUG_RAILWAY_ROUTE from the property items/ of the query request parameter mode

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value HGV from the property items/ of the query request parameter mode

      request-parameter-property-enum-value-removed

    • ●

      deleted the query request parameter max

      request-parameter-removed

    • ●

      deleted the query request parameter min

      request-parameter-removed

    • ●

      deleted the query request parameter numResults

      request-parameter-removed

    • ○

      added the new enum value ADDRESS to the query request parameter type

      request-parameter-enum-value-added

    • ○

      added the new enum value PLACE to the query request parameter type

      request-parameter-enum-value-added

    • ○

      added the new enum value STOP to the query request parameter type

      request-parameter-enum-value-added

    • ○

      for the query request parameter type, the type/format was generalized from array/ to string/

      request-parameter-type-generalized

    • ○

      removed the DEBUG_BUS_ROUTE enum value from the items/modes/items/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DEBUG_FERRY_ROUTE enum value from the items/modes/items/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the DEBUG_RAILWAY_ROUTE enum value from the items/modes/items/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HGV enum value from the items/modes/items/ response property for the response status 200

      response-property-enum-value-removed

    This revision also has 30 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog