Along Route Search

Base URL for calling the API.
Values:

• api.tomtom.com

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

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

Maximum detour time.
Maximum value: 3600 seconds.

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.

The query string. It must be properly URL-encoded.
Value: A properly URL-encoded query string.

If the typeahead flag is set the query will be interpreted as a partial input, and the search will enter predictive mode.
Default value: false

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

A comma-separated list of categories which could be used to restrict the result to the Points Of Interest of specific categories. The list of categories can be discovered using the POI Categories endpoint.
Value: A comma-separated list of category identifiers (in any order). When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned.
Usage examples:

• categorySet=7315 (search Points Of Interest of category Restaurant.)

• categorySet=7315025,7315017 (search Points Of Interest of a category, in this example an Italian ( italian ) or French ( french ) Restaurant.)

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
Value: A comma-separated list of brand names (in any order). When multiple brands are provided, only POIs that belong to (at least) one of the brands from the provided list will be returned. Brands that contain a "," (comma) in their name should be put into quotes, for example: "A,B,C".
Usage examples:

• brandSet=Tomtom (search Points Of Interest of the "Tomtom" brand)

• brandSet=Tomtom,Foobar (search Points Of Interest of the "Tomtom" brand OR "Foobar" brand)

• brandSet="A,B,C Comma" (search Points Of Interest of the "Adam,Batsman,and,Bowling" brand)

A comma-separated list of connector types which could be used to restrict the result to the Points Of Interest of type Electric Vehicle Station supporting specific connector types. See List of supported connector types
Value: A comma-separated list of connector types (in any order). When multiple connector types are provided, only POIs that support (at least) one of the connector types from the provided list will be returned.
Usage examples:

• connectorSet=IEC62196Type2CableAttached (search Points Of Interest of type Electric Vehicle Station supporting IEC62196Type2CableAttached)

• connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached (search Points Of Interest of type Electric Vehicle Station supporting IEC62196Type2CableAttached or IEC62196Type2Outlet )

An optional parameter which could be used to restrict the result to the Points Of Interest of type Electric Vehicle Station supporting at least one connector with a specific minimal value of power in kilowatts (closed interval - with that value).
Value: A double value representing the power rate in kilowatts.
Usage example: minPowerKW=22.2: Returns a Points Of Interest of type Electric Vehicle Station supporting at least one connector with a power rate in the range from 22.2 kW. This parameter might be used together with maxPowerKW.

An optional parameter which could be used to restrict the result to the Points Of Interest of type Electric Vehicle Station supporting at least one connector with a specific maximum value of power in kilowatts (closed interval - with that value).
Value: A double value representing the power rate in kilowatts.
Usage example: maxPowerKW=43.2 : Returns a Points Of Interest of type Electric Vehicle Station supporting at least one connector with a power rate in the range to 43.2 kW. This parameter might be used together with minPowerKW.

A comma-separated list of fuel types which could be used to restrict the result to the Points Of Interest of specific fuels. If fuelSet is specified, the query can remain empty. Only POIs with a proper fuel type will be returned.
Value: A comma-separated list of fuel type identifiers (in any order). When multiple fuel types are provided, only POIs that belong to (at least) one of the fuel types from the provided list will be returned.
Fuel Types available
Usage examples:

• fuelSet=Diesel (search Points Of Interest of the Diesel fuel type)

• fuelSet=Petrol,LPG (search Points Of Interest of either the Petrol or LPG fuel type)

A comma-separated list of vehicle types that could be used to restrict the result to the Points Of Interest of specific vehicles. If vehicleTypeSet is specified, the query can remain empty. Only POIs with a proper vehicle type will be returned.
Value: A comma-separated list of vehicle type identifiers (in any order). When multiple vehicles types are provided, only POIs that belong to (at least) one of the vehicle types from the provided list will be returned.
Available vehicle types: Car , Truck
Usage examples:

• vehicleTypeSet=Car (search Points Of Interest of the Car car type)

• vehicleTypeSet=Car,Truck (search Points Of Interest of either the Car or Truck vehicle type)

Geopolitical View. The context used to resolve the handling of disputed territories. Views include only Unified.
Default value: Unified

Parameter which turns on calculation of the distance between the start of the route and the starting point of the detour to a POI.
Default value: false Detour offset is also calculated when sortBy parameter is set to detourOffset. Value is provided in a response only when detourOffset is set to true.

Parameter which provides the possibility to sort returned results.
Default value: detourTime
Values:

• detourTime
• detourDistance
• detourOffset

Detour distance will be calculated as a difference between the original distance and the distance of a new route with Point Of Interest location. detourDistance field will be present in every response regardless of sorting parameter. If detour offset is set to false detourOffset=false and sorting parameter is set to detourOffset ( sortBy=detourOffset ) then detour offset will be calculated and results will be sorted as expected, but detourOffset value will not be present in the response.
Usage examples:

• sortBy=detourTime (sorts returned results by detour distance)

• sortBy=detourOffset (sorts returned results by detourOffset)

Language in which search results should be returned. It should be one of the TomTom supported IETF 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: One of the TomTom supported IETF language tags.

List of opening hours for a POI (Points of Interest).
Value: nextSevenDays Mode shows the opening hours for next week, starting with the current day in the local time of the POI.
Usage example: openingHours=nextSevenDays

Enables the spreading of returned results evenly along the route.
Value: auto

Enables the return of a comma-separated mapcodes list. It can also filter the response to only show selected mapcode types. See mapcodes in the response.
Values: One or more of: Local, International, Alternative
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.
Usage examples:

• mapcodes=Local (only returns 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)

Used to indicate the mode in which the timeZone object should be returned.
Values: iana Mode shows the IANA ID which allows the user to determine the current time zone for the POI.
Usage example: timeZone=iana

An optional parameter that provides the possibility to return related Points Of Interest.
Default value: off
Values: off , child , parent, all
Points Of Interest can be related to each other when one is physically part of another. For example, an airport terminal can physically belong to an airport. This relationship is expressed as a parent/child relationship: the airport terminal is a child of the airport. If the value child or parent is given, a related Points Of Interest with a specified relation type will be returned in the response. If the value all is given, then both child and parent relations are returned.
Usage examples:

• relatedPois=child : Returns only Points Of Interest with a child relation.

• relatedPois=parent : Returns only Points Of Interest with a parent relation.

• relatedPois=all : Returns Points Of Interest with all possible relations.

Not supported As of Sep 28, 2023

• The request relatedPois parameter field is not supported.

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

Starting offset of the returned results within the full result set.

Deprecated:
As of Sep 28, 2023

• The response offset field has been deprecated.

• It will be withdrawn following a 12 month deprecation period.

• The planned withdrawal date is Sep 28, 2024.

Maximum fuzzy level required to provide results.

Deprecated:
As of Sep 28, 2023

• The response fuzzyLevel field has been deprecated.

• It will be withdrawn following a 12 month deprecation period.

• The planned withdrawal date is Sep 28, 2024.

Type of result.
Value: POI

A stable unique id for the POI index, and a non-stable unique id for the other indexes. Note: Stable id means that it doesn't change between data releases without changing the location, attribution, or classification.

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

Unit: meters. This is the distance to an object from the provided route.

Information about the original data source of the result.

Deprecated:
As of Sep 28, 2023

• The response info field has been deprecated.

• It will be withdrawn following a 12 month deprecation period.

• The planned withdrawal date is Sep 28, 2024.

Information about the Points of Interest in the result.
poi object

List of related Points Of Interest.
relatedPois
object

Not supported As of Sep 28, 2023

• The request relatedPois parameter field is not supported.

Structured address for the result.
address object

Position of the result:
LatLon

List of mapcode objects
mapcodes object

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

List of entry points of the POI (Point of Interest).
entryPoints array

A list of chargingPark objects. Present only when the Points of Interest are of the Electric Vehicle Station type.
chargingPark object

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

Optional section. List of fuel types served by the petrol station.
fuelTypes array
Fuel Types available

Optional section. List of vehicle types supported by the petrol station.
vehicleTypes array
Available vehicle types: Car, Truck

Name of the POI.

The list of POI brands.
brands array

The list of the most specific POI categories.
categorySet array

List of opening hours for a POI (Points of Interest).
openingHours object

The list of POI category classifications.
classifications array

Deprecated:
As of Sep 28, 2023

• The response classifications field has been deprecated.

• It will be withdrawn following a 12 month deprecation period.

• The planned withdrawal date is Sep 28, 2024.

Time zone information for the POI.
timeZone object

The list of the POI features.
features array

Category id. Full list of available categories is available under the POI Categories endpoint.

Fixed top level category code.
Supported Category Codes

List of category names with locale code information. Currently only en-US locale is returned.
names array

Relation type:

• child

• parent

Pass this as entityId to the Place by ID service to fetch additional data for the Point Of Interest.

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.

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

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.

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
• 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

The main entry point. One of:

• main

• minor

If present, represents the type of access for the POI.
Example: FrontDoor

Position of the entry point.
LatLon

A list of connectors available in the Points Of Interest of an Electric Vehicle Station type.
connectors array

Type of the connector available in Electric Vehicle Station.
See: Supported Connector Types.

Information about the charging stations availability.
chargingAvailability object

Information about the parking site availability.
parkingAvailability object

Information about the fuel station prices.
fuelPrice object

Information about the geometric shape of the result.
geometry object

Pass this as chargingAvailability to the EV Charging Stations Availability service to fetch charging availability information for this result.

Pass this as parkingAvailability to the Parking Availability service to fetch parking availability information for this result.

Pass this as fuelPrice to the Fuel Prices service to fetch fuel price information for this result.

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

List of time ranges for the next 7 days.
timeRanges array

The point in the next 7 days range when a given POI
is being opened (or the beginning of the range if it was opened before the range), inclusive.
startTime object

The point in the next 7 days range when a given POI
is being opened (or the beginning of the range if it was opened before the range), exclusive.
endTime object

Represents current day in calendar year in POI time zone.

Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23.

Minutes are in the local time of a POI ; possible values are 0 - 59.

ID from the IANA Time Zone Database.

The order is a 0-based value indicating relative order. The order defines the importance of the category.

The POI feature category.

The group of the POI feature category.

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

Method Not Allowed: The HTTP methods GET, POST, etc. are not supported for this request.

Not Found: The HTTP request methods GET, POST, etc. or the path is incorrect.

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

Server Error: The server 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
Value: type/subtype is one of:

• application/json

• text/javascript

• 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

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.