Premium Geocoding API

Base URL for calling the API.

Values:

• api.tomtom.com

Service version number.

Value: The current value is 2.

Query string (can include unit info). Must be properly URL encoded.

Value: A properly URL encoded query string.

A valid response format:

Values: json , jsonp , js , or xml

An API Key valid for the requested service.

Value: Your valid API Key.

unit details for the detailed address search (e.g., apt 110 or ste 110 ). This will provide a detailed premium result for the unit level details provided. For data availability, visit the Premium Geocoding API Market Coverage page for a list of all the countries supported by the Premium Geocoding API engine. Values: apartment 131 , Ste B101 , etc.

The maximum number of responses that will be returned.
Default value: 10
Maximum value: 100

The starting offset of the returned results within the full result set. The total number of results can be no more than 2000. If you want to receive all the results, you need to limit the number of results by using, for example the radius parameter.
Default value: 0
Maximum value: 1900

Latitude, e.g., lat=37.337 lat,lon where results should be biased. Note: supplying a lat/lon without a radius will bias the search results to that area.
Value: lat

Longitude, e.g., lon=-121.89 lat,lon where results should be biased. Note: supplying a lat/lon without a radius will bias the search results to that area.
Value: lon

Comma separated string of country codes in ISO 3166-1 alpha-2 or alpha-3 code formats (e.g., FR,ES or FRA,ESP ). This will limit the search to the specified countries. The choice of view may restrict which countries are available. Visit the Geocoding API Market Coverage page for a list of all the countries supported by the Geocoding API engine. Values: FR , ES or FRA , ESP , etc.

If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.
Value: A radius.

Top-left position of the bounding box. This is specified as a comma-separated string composed by lat,lon (e.g., 37.553,-122.453 ). Important note: Point-Radius parameters and Bounding Box parameters are mutually exclusive. Point-Radius parameters take precedence when both are passed.
Value: A comma-separated string composed by lat , lon.
Example: 37.553,-122.453

Bottom-right position of the bounding box. This is specified as a comma-separated string composed by lat,lon (e.g., 37.553,-122.453 ). Important note: Point-Radius parameters and Bounding Box parameters are mutually exclusive. Point-Radius parameters take precedence when both are passed.
Value: A comma-separated string composed by lat , lon.
Example: 37.553,-122.453

Language in which search results should be returned. It should be one of the TomTom IETF Supported Language Tags , case insensitive. When data in the specified language is not available for a specific field or the language is not specified, the language best matched with your query is used.
Value: A TomTom IETF Supported Language Tag.

Indexes for which extended postal codes should be included in the results. Available values are described in Additional Information indexes abbreviation values section. The value should be a comma-separated list of index types (in any order) or "None" for no indexes. By default, extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long, so they have to be explicitly requested when needed. Extended postal code is returned as the extendedPostalCode property of an address. Availability is region-dependent.
Value: A comma-separated list of index types.
Usage examples:

• extendedPostalCodesFor=POI
• extendedPostalCodesFor=PAD,Addr,POI
• extendedPostalCodesFor=None

Geopolitical View. The context used to resolve the handling of disputed territories. Views include Unified , along with AR IL , IN , MA , PK , RU , TR , and CN which are respectively tailored for Argentina, Israel, India, Morocco, Pakistan, Russia, Turkey, and China.
Default values:

• Argentina , default view: AR , available views: Unified , IL , IN , MA , PK , RU , TR , CN
• India , default view: IN , available views: -
• Morocco , default view: MA , available views: Unified , AR , IL , IN , PK , RU , TR , CN
• Pakistan , default view: PK , available views: Unified , AR , IL , IN , MA , RU , TR , CN
• Russia , default view: RU , available views: Unified , AR , IL , IN , MA , PK , TR , CN
• Turkey , default view: TR , available views: Unified , AR , IL , IN , MA , PK , RU , CN
• China , default view: CN , available views: Unified , AR , IL , IN , MA , PK , RU , TR
• Others , default view: Unified , available views: AR , IL , IN , MA , PK , RU , TR , CN

Enables the return of a comma-separted mapcodes list. It can also filter the response to only show selected mapcode types. See mapcodes 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
• Alternative

Usage examples:

• mapcodes=Local (returns only the local mapcode for a location)
• mapcodes=Local,Alternative (returns both, local and alternative, mapcodes for a location)
• mapcodes=Local,Alternative,International (returns all possible mapcodes for a location)

A comma-separated list of entity types which can be used to restrict the result to the Geography result of a specific entity type. If entityTypeSet is specified, only a Geography result with a proper entity type will be returned.
Value: A comma-separated list of of entity types. Item order in the list does not matter. Values are case sensitive.
Available values:

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

Usage examples:

• entityTypeSet=Municipality : Only returns results with a Municipality entity type.
• entityTypeSet=Municipality,MunicipalitySubdivision : Returns results with a Municipality or MunicipalitySubdivision entity type.

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, sorted in descending order by score.
results array

Response type. Can be NEARBY or NON_NEAR.

• The queryType parameter has been deprecated and will be withdrawn.
• The planned withdrawal date is Dec 31, 2024.
• Following withdrawal, API requests that include the queryType parameter will receive an HTTP 400 error in the response.

The starting offset of the returned results within the full result set.

The position used to bias the results: Latitude, Longitude

LatLon

Indicates if premium content in the response.

Value: One of:

• standard - no premium content in any of the results

• premium - premium content returned in at least one result

Indicates if premium content returned in the given result.

Value: One of:

• standard - no premium content in the given result

• premium - premium content in the given result

Type of result.

Value: One of:

• Street

• Geography

• Point Address

• Address Range

• Cross Street

The score of the result. A larger score means there is a probability that a result meeting the query criteria is higher.

• The score parameter has been deprecated and will be withdrawn.
• The planned withdrawal date is Dec 31, 2024.
• Following withdrawal, API requests that include the score parameter will receive an HTTP 400 error in the response.

The confidence of the result's textual match with the query.

matchConfidence object

Unit: meters. This is the distance to an object if geobias was provided.

The structured address for the result.

address object

The additional premium details around the address.

addressDetails object

The position of the result: Latitude, Longitude.

Premium content - The position represents the high-accuracy coordinates of the house, building or unit address.

LatLon

List of mapcode objects.

mapcodes object

A viewport which can be used to display the result on a map.

viewport object

Optional section. Only present if type == Geography. A bounding box which can be used to display the result on a map defined by minimum and maximum longitudes and latitudes.

boundingBox object

A list of entry points.

Standard content - This is a list of points that give access to the Address.

Premium content - These are sequenced array of waypoints intended to be used for delivery or navigation leading up to the house, building or unit address.

entryPoints array

The address ranges on a street segment. Available only for results where the result type is equal to Address Range. addressRanges object

An optional section. These are unique reference ids for use with the Additional Data service.

dataSources object

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. Note: This field only appears for geographies having entityType == PostalCodeArea. It is only supported for the USA.

A country's code (Note: This is a two-letter code, not a country name.).

An address line formatted according to the formatting rules of the result's country of origin. In the case of countries, its full country name. For the USA, in the case of geographies with entityType == PostalCodeArea it will contain the postalName field value.

The full name of the first level of country administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. It is only supported for the USA, Canada, and Great Britain.

countrySubdivisionCode prefixed by countryCode ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. It is only present if the returned document has entityType == CountrySubdivision. 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.

This refers to the next level of address granularity. Usually, apartment unit number. For example, in the USA, this is the second line of the address.

Represents the overall textual match score, in the range of [0..1], where 1 means a perfect match and 0 - no match.

Example:
A Point Address result with freeformAddress 9390 Santa Monica Boulevard, Beverly Hills, CA 90210 has:

• score: 1 for a query that matches perfectly, like "9390 santa monica boulevard beverly hills california los angeles"

• score: 0.88 for a query that matches, despite a spelling error and synonym, like "9390 snta monica avenue beverly hills california los angeles"

• score: 0.42 for a query that contains many unmatched terms, like "mr smith apartment 20 ground floor 9390 santa monica boulevard beverly hills california los angeles"

Score is calculated on primary address components only; the secondary address line is not considered

Type of mapcode:

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. For example, 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.

Top-left corner of the rectangle:

LatLon

Bottom-right corner of the rectangle:

LatLon

Top-left position of the bounding box:

LatLon

Bottom-right position of the bounding box:

LatLon

The main entry point. One of:

• main

• minor

• route

If present, represents the type of access for the Address.

Standard content, the Entrypoint type is main/minor.   The functions that can be returned:

• Main

• Postal

• Routing

• Emergency

• Pedestrian

• Delivery

• Authorized

• FrontDoor

Premium content, the entrypoint type is route; these represent highly accurate navigational waypoints towards the address.   The functions that can be returned.

• PARKING - Represents the on-street or covered parking location close to the entrance.

• ENTRANCE - Represents the primary entrance to the building.

• ELEVATOR - represents the elevator inside the building

• STAIR - A staircase inside the building.

The navigational modality to the next entryPoint.

One of:

• DRIVING

• WALKING

• UNKNOWN

Position of the entry point.

LatLon

An address range on the left side of a street segment (assuming looking from the "from" end toward the "to" end).

An address range on the right side of a street segment (assuming looking from the "from" end toward the "to" end).

The beginning point of a street segment: Latitude, Longitude

LatLon

The end point of a street segment: Latitude, Longitude

LatLon

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.

Latitude. min/max: -90 to +90

Reference: Latitude, Longitude, and Coordinate System Grids

Longitude. min/max: -180 to +180

Reference: Latitude, Longitude, and Coordinate System Grids

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
• Rate or volume limit exceeded
• Unknown referer
• Channel not allowed

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

Not Found : The HTTPS 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.

If requested by the client, the Search service applies gzip compression to the responses 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.

Detailed information about the error.

detailedError object

HTTP response codes signifying failed requests to an API server.

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.

Optional.

Target of the particular error.

Value: The name of the request parameter causing the error.