/v4/geocoding/reverse

Reverse Geocoding

Attempt to match a latitude, longitude pair to an address.

Reverse search is supported for points on the land. If the client requests a point far away from the land (e.g. in the ocean), a 400 Bad Request is returned.

Request Headers

X-Application-Id

string

Required authentication header. Get API Key here

X-Api-Key

string

Required authentication header.

Accept-Language

BCP47 | optional

Request geocoding results to be in specific language if it is available. If it is not - it will default to English. BCP47 spec

Request GET parameters

lat

float

Latitude of the point to reverse geocode.

lng

float

Longitude of the point to reverse geocode.

Response Headers

Content-Language

BCP47

Language tag in which results were returned.
It will default to Content-Language: en if requested language was not available. BCP47 spec.

Response Body

type

FeatureCollection

attribution

string

features

array[object]

Hide child attributes

features.type

Feature

features.geometry

object

Show child attributes

features.geometry.type

Point

features.geometry.coordinates

array[number, number]

The coordinates of the locations. [lng, lat]

features.properties

object

Hide child attributes

features.properties.name

experimental | string

Well formatted, human-readable address of the location.

features.properties.label

string

Full comma-separated address of the location, composed of names of all enclosing regions/boundaries.

features.properties.category

string

features.properties.type

string

features.properties.score

float | optional

Result confidence score, maximum value is 1.

features.properties.house_number

string | optional

features.properties.street

string | optional

features.properties.region

string | optional

features.properties.region_code

string | optional

features.properties.neighbourhood

string | optional

features.properties.county

string | optional

features.properties.macroregion

string | optional

features.properties.city

string | optional

features.properties.town

string | optional

features.properties.district

string | optional

features.properties.country

string | optional

features.properties.local_admin

string | optional

features.properties.country_code

ISO 3166-1 alpha-3 | optional

features.properties.continent

string | optional

features.properties.postcode

string | optional

features.properties.features

object | optional

Show child attributes

features.properties.features.public_transport

object | optional

Public transport support information. Public transport is not supported if this object is missing.

Show child attributes

features.properties.features.public_transport.date_start

date in extended ISO-8601 format

features.properties.features.public_transport.date_end

date in extended ISO-8601 format

features.properties.features.time_filter_fast

object | optional

Fast time-filter support information. The time-filter/fast endpoint is not supported if this object is missing.

Show child attributes

features.properties.features.time_filter_fast.periods

array[object]

Each entry in the array describes a time period and time filter modes that are available for this country.

Show child attributes

features.properties.features.time_filter_fast.periods.time_period

string

The arrival or departure time period for which this time filter fast endpoint is available. Possible values: weekday_morning

features.properties.features.time_filter_fast.periods.supported

array[object]

Lists available transportation and time-filter modes for this time period.

Show child attributes

features.properties.features.time_filter_fast.periods.supported.search_type

string

Possible values arrival.many_to_one, arrival.one_to_many.

features.properties.features.time_filter_fast.periods.supported.transportation_mode

string

Possible values public_transport, driving, driving+public_transport.

features.properties.features.cross_country_modes

array[string]

Array of supported transportation modes while doing cross country search

features.properties.features.fares

boolean

Indicates whether or not we have fare data

features.properties.features.postcode

boolean

Indicates whether or not postcode searches are supported

Examples

Request

Loading

Response Body

Loading

Example Request

Loading

Response Body

Loading