Autocomplete

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

The query string.
Value: Must be properly URL encoded.

A valid response format.
Values: json, xml

An API Key valid for the requested service.
Value: Your valid TomTom API Key.

Language in which autocomplete results should be returned.
Value: One of the TomTom IETF Supported Language Tags.

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.

Maximum number of autocomplete results that will be returned.
Default value: 5
Maximum value: 10

Latitude, e.g., lat=37.337. It must be used in conjunction with the lon parameter. Results should be biased to the position defined by the lat,lon parameters.
Note: Supplying a lat/lon without a radius will bias the autocomplete results only to that point.
Value: min/max: -90 to +90
Reference: Latitude, Longitude, and Coordinate System Grids

Longitude, e.g., lon=-121.89. It must be used in conjunction with the lat parameter. Results should be biased to the position defined by the lat,lon parameters.
Note: Supplying a lat/lon without a radius will bias the autocomplete results only to that point.
Value: min/max: -180 to +180
Reference: Latitude, Longitude, and Coordinate System Grids

The radius parameter must be used in conjunction with the lat,lon parameters. If radius, lat, and lon are set, the results will be constrained to the defined area.
Value: min/max: 0 to 5000000 Note: The radius parameter is specified in meters.
Values greater than 5000000 meters are reduced to 5000000. Values less than 0 will respond with a code 400 Bad request.

A comma-separated string of country codes (e.g., FR,ES). This will limit the autocomplete results to the specified countries. See the Search API Market Coverage page for a list of all the countries supported by the Autocomplete API engine.
Values: FR,ES, etc.

Restricts the result space based on their segment types. A result is only included if it contains a segment of any of the indicated types.
Value: A comma-separated list that consists of the types of segments.
Usage examples:

• resultSet=category

• resultSet=brand

• resultSet=category,brand

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.

Should contain a list of encodings acceptable by the client. Usually used to demand a compressed response.
Value: gzip

Specifies an identifier for the request.

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

Value: A request identifier, e.g., 3c8ea54d-e217-49b3-8c16-d13accf2e84a

Information about the autocomplete request that was performed.
context object

List of the results returned by the autocomplete engine.
result object

The geo bias passed to the autocomplete engine by setting the position (lat, lon) and radius parameters.
geoBias object

Position used to bias the results by setting the optional lat and lon request parameters.
LatLon

The optional radius request parameter passed by the user.

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

Describes recognized entities of the result.
segment object

The type of a detected entity. Currently we can detect: category, brand, and plaintext, but more types can appear in the future.

The value of the detected entity. It may be a category name, brand name, or a part of unrecognized text. For the brand segment type, the value of this field can be used to restrict results of other search endpoints to the Points Of Interest (POI) of specific brands. See the brandSet parameter in the Search service documentation, e.g., the Fuzzy Search endpoint.

Defines a mapping between the inputQuery and segment.
matches object

Provided for the category segment type. This can be used to restrict the results of other search endpoints to the Points Of Interest (POI) of specific categories. See the categorySet parameter in the Search service documentation , e.g., the Fuzzy Search endpoint.

Optionally provided for the category segment type. Present only if a part of the user query matched to the alternative name instead of a primary name. For example, for the input query "petrol station" the category segment value will be "gas station" and the matchedAlternativeName will be "petrol station".

Informs which part of the input query is represented by segment. Input query matching may not be continuous, so the mapping is defined by an array of matched substrings.
match object

Starting offset of the inputQuery substring matching the segment.

OK: The autocomplete engine 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: Used HTTP method is not supported for this request.

Not Found: Used HTTP request path is incorrect.

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

Server Error: The service was unable to process your request. Retry your request, and if it doesn't solve the problem please 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
Value: type/subtype is one of:

• application/json

• application/xml

Service applies gzip compression to the responses if it is requested by the client with the Accept-Encoding header.
Value: gzip

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

Detailed information about the error.
detailedError object

One of the defined error Response codes.

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.

Optional. An array of root causes (more detailed errors) that led to this error.
detailedError array

Optional. A higher level of details about this error.
innerError object

One of the defined error response codes.

Optional. 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. A higher level of details about this error.
innerError object

One of the request parameters was missing or did not pass validation. The target field contains the name of the related parameter.
Possible inner errors:

• MissingRequiredParameter

• InvalidParameterValue

• MissingDependentParameter

• ValueOutOfRange

Top level code for requests which ended with HTTP 400 Bad Request.
Possible root causes: BadArgument.

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

One of the parameters that is required by another parameter was not specified (for example: parameter lon is missing when lat was specified).

Top level code for requests which ended with HTTP 404 Not Found caused by providing an incorrect request path.

Top level code for requests which ended with HTTP 503 Service Unavailable. The service cannot handle the request right now, this is certainly a temporary state.