Reverse Geocode

Base URL for calling the API.
Value: api.tomtom.com

The service version. If the TomTom-Api-Version header is not present, the apiVersion parameter is required.
Value: A service version value. The current value is 1.

This is specified as a comma-separated string composed by lat,lon.
Value: lat,lon
Example: 37.553,-122.453.

A valid response format:
Values: json, jsonp, js, or xml

An API Key valid for the requested service.
Value: Your valid TomTom API Key.
See: How do I get a TomTom API Key?

Enables the return of the posted speed limit (where available).
Default value: false

The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North,
90 is East and so on. The precision can include up to one decimal place.
Values: Values range from -360 to 360.

The maximum distance in meters from the specified position for the reverseGeocode to consider.
Default value: 10000 meters (10 km).

Enables the return of the roadClass array for reverseGeocodes at street level.
Value: Functional Represents a classification of roads based on the importance that the constituting roads have in the total road network.

Note: Right now, the service supports only a single value, but in future, it may change.

This parameter specifies the level of filtering performed on geographies. Providing this parameter narrows the search for specified geography entity types. The resulting response will contain the matched entity type. The following parameters are ignored when entityType is set:

• heading
• returnRoadClass
• returnSpeedLimit
• returnMatchType

Values: One or more of:

• Country
• CountrySubdivision
• CountrySecondarySubdivision
• CountryTertiarySubdivision
• Municipality
• MunicipalitySubdivision
• MunicipalitySecondarySubdivision
• Neighbourhood
• PostalCodeArea

Specifies the callback method.
Default value: cb

The language in which the reverse geocode result should be returned. It should be one of the TomTom IETF Supported Languages
tags, case insensitive. When data in a specified language is not available for a specific field, the default language is used.
Default value: NGT

The format of newlines in the formatted address. If true, the address will contain newlines. Otherwise, newlines will be converted to spaces.
Default value: false.

This includes information on the type of match the geocoder achieved in the response.

Geopolitical View. The context used to resolve the handling of disputed territories. Views include Unified along with AR and IL which are respectively tailored for Argentina and Israel.
Default values:

• Argentina, default view: AR, other available views: Unified, IL
• Others, default view: Unified, other available views: AR, `IL

Enables the return of mapcodes. Can also filter the response to only show selected mapcode types. See mapcode in the response. A mapcode represents a specific location, to within a few meters. Every location on Earth can be represented by a mapcode. Mapcodes are designed to be short, easy to recognize, remember and communicate. Visit the Mapcode project website for more information.
Values: One or more of: Local, International, and Alternative.

Excludes a certain group of inspected address-carrying elements in order to find the closest match to a requested point. Right now service supports only single value, but in future it may change.
Value: BackRoads
BackRoads: Roads that do not have an official name and any other kind of address information attached: unaddressable paths, forest paths, tracks, commercial driveways used as service roads, hiking paths, etc. Use of this filter is advised in cases where obtaining accurate address is top priority. It should not be used in a 'vehicle/asset tracking' use case or in road elements 'matching/focus' use case(s).

Service version. If the apiVersion parameter is not present the TomTom-Api-Version header is required.
Value: A service version value. The current value is 1.

Enables response compression.
Value: gzip

Specifies an identifier for the request.

• It can be used to trace a call.
• The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
• An example of the format that matches this regular expression is UUID: (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1).
• For details check RFC 4122.
• If specified, it is replicated in the Tracking-ID response header.
• It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: An identifier for the request.

Summary information about the search that was performed.
summary object

The result list containing a single record.
addresses array

The structured address for the result.
address object

Position of the result in the form of "latitude,longitude" coordinates. Position of the entry point. Position on the street where you can enter the location.
Example: 37.553,-122.453

Road classes at the address.
roadclass object

Information on the type of match. One of:

• AddressPoint

• HouseNumberRange

• Street

Optional section. Reference ids for use with the Additional Data service.

• dataSources object
• geometry object

Optional section. It can be returned only if the 'mapcodes' input parameter is used.
mapcode object

A stable, unique id for a given entity.

The building number on the street.

Use streetNumber instead.

The street name.

Use streetName instead.

The speed limit for the street in the form (D)(D)D.DDUUU, For example:

• 30.00KPH

• (D)(D)D.DD is a number with two decimal places (for example: 5.00, 30.00 or 120.00).

• UUU is either KPH or MPH (whichever is correct for the address).

Country

Note: This is a two-letter code, not a country name.

An address component which represents the name for a postal code that is related to a single administrative area, city, town, or other populated place. Only present when the parameter entityType == PostalCodeArea is present.

ISO 3166-1 alpha-3 country code

An address line formatted according to the formatting rules of a result's country of origin, or in the case of a country, its full country name.

The bounding box of the location.
boundingBox object

The full name of a first level of country administrative hierarchy.

countrySubdivisionCode prefixed by countryCode and the hyphen (countryCode-countrySubdivisionCode) forms the ISO 3166-2 code.
countrySubdivisionCode examples: TX for Texas, SCT for Scotland, ON for Ontario, ZE for Zeeland and BB for Brandenburg.

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit.

Northeast (top-left) latitude, longitude coordinate of the bounding box.

Southwest (bottom-right) latitude, longitude coordinate of the bounding box.

Entity type source of the bounding box.

Note: For reverse-geocoding this is always equal to string: 'position'.

Possible value: Functional. Represents a classification of roads based on the importance that the constituting roads have in the total road network.

Possible values:

• for type Functional:

  • Motorway: Includes all roads officially designated as members of an internationally, nationally, and/or regionally important network of limited-access highways.

  • Trunk: Includes all roads of high importance (but not officially assigned as motorways) that are part of a connection for international and national traffic and transport.

  • Primary: Includes all roads used to travel between neighboring regions of a country.

  • Secondary: Includes all roads used to travel between different parts of the same region.

  • Tertiary: Includes:

    • All roads that make each settlement or parts (north, south, east, west and central) of a settlement accessible.
    • All roads on the local level are the main connections in a settlement or represent frequently used rural connections. These are roads where important through traffic is possible.
    • All roads used to travel within a part of a settlement or roads of minor connecting importance in a rural area.

  • Street: Includes all roads that only have a destination function. Such roads reach a particular address or destination (e.g., dead-end streets, roads inside a living area, alleys [narrow roads between buildings], or roads found in a park or garden).

  • Ferry: Includes all ferry routes.

  • Other: Includes all other roads that are less important for the navigation system.

Note: For the Functional type, the service always returns a single element from possible values.

Information about the geometric shape of the result. Only present if type == Geography.
geometry object

Pass this as geometryId to the Additional Data service to fetch geometry information for this result.

Type of mapcode. Possible values:

• Local: The shortest possible (and easiest to remember) mapcode. Local mapcodes are especially useful when the user knows what territory the mapcode is in (for example, when an application is designed to be used inside just one European country or US state).
  Note that the code element of a Local mapcode is ambiguous when used without the territory element - e.g.,: the "4J.P2" mapcode can mean the Eiffel Tower location (48.858380, 2.294440) (with the territory set to FRA ), but also some place in Amsterdam-Noord, Netherlands (52.382184, 4.911021) (with the territory set to NLD).
• International: This mapcode is unambiguous. It is also the longest.
• Alternative: Alternatives to Local mapcodes. Each Alternative mapcode points to slightly different coordinates due to the way mapcodes are computed (see the mapcode documentation). For example: the position from a response can be encoded as "5DM.WC" (51.759244, 19.448316) and the "VHJ.036" (51.759245, 19.448264), which are close to each other, but not exactly the same place.

The full form of a mapcode (territory + code). It is always unambiguous. The territory element is always in the Latin alphabet. In an International mapcode, the territory part is empty.

The territory element of the mapcode. The territory element is always in the Latin alphabet. Usually, the territory is the ISO 3166-1 alpha 3 abbreviation for the country name. However in these eight very large countries:

• USA,
• Canada,
• Mexico,
• Brazil,
• India,
• Australia,
• Russia,
• China

an address has little meaning unless the user also knows what state it's in (just as, elsewhere, an address has little meaning if the user doesn't know what country it's in). More information about territory codes is available at Territories for mapcodes. This field is not returned for an International mapcode.

The mapcode without the territory element. It consists of two groups of letters and digits separated by a dot. The code is using the same language and alphabet as the response. The language parameter may be used to modify the language and alphabet of both the response and the code (for example: Cyrillic for the language 'ru-RU'). This field is not returned for the International mapcodes - use fullMapcode instead.

OK: The search successfully returned zero or more results.

Bad request: One or more parameters were incorrectly specified.

Forbidden: Possible causes include:

• Service requires SSL
• Not authorized
• Over QPS (Queries per second), or over QPD (Queries per day)
• Unknown referer

Method Not Allowed: The HTTP method ( GET, POST, etc.) is not supported for this request.

Not Found: The HTTP request method ( GET, POST, etc.) or path is incorrect.

Too Many requests: The API Key is over QPS (Queries per second).

Server Error: The service was unable to process your request. Contact support to resolve the issue.

Ensures that clients implementing the CORS security model are able to access the response from this service.
Value: An asterisk * that signifies access to the TomTom API using the Access-Control-Allow-Origin (ACAO) header in its response indicating which origin sites are allowed.

Indicates the format of the response, as chosen by the client.
Format: type/subtype; charset=utf-8
Values: type/subtype is one of: application/json, text/javascript, or text/xml.

The Reverse Geocode service endpoint applies gzip compression to the responses if requested by the client with the Accept-Encoding header.
Value: gzip

An identifier for the request. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service. It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: An identifier for the request.

A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.

Detailed information about the error.
detailedError object

One of the defined error codes.

A human-readable representation of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.

Optional. Target of the particular error.
Value: The name of the request parameter.

The code for requests which ended with an HTTP 400 Bad Request.

The code for requests which ended with an HTTP 403 Forbidden.

The code for requests which ended with an HTTP 500 Internal Server Error. The service cannot handle the request right now, an unexpected condition was encountered.

The code for requests which ended with an HTTP 504 Gateway Timeout. The service cannot handle the request right now, this is certainly a temporary state.