geocode

Translate coordinates to the closest address(es)/places/stops.

Changed on
get/api/v1/reverse-geocode

Request

  • Base URL
    https://api.transitous.org
  • URL
    https://api.transitous.org/api/v1/reverse-geocode
  • Auth
    none declared

Query parameters

placestring required

latitude, longitude in degrees

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.

numResultsinteger

Optional. Number of results to return.

If omitted, 5 results are returned by default. Must be <= server config variable reverse_geocode_max_results.

Response

A list of guesses to resolve the coordinates 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

  • dbfe4b7f2babRevision changes
    • warning

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

  • 26803b66a16bRevision changes
    • breaking

      removed the enum value ADDRESS from the query request parameter type

    • breaking

      removed the enum value PLACE from the query request parameter type

    • breaking

      removed the enum value STOP from the query request parameter type

    • breaking

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