Along Route Search

Service version: 2

Last edit: 2023.08.01

Purpose

The Along Route Search endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying a detour time-limiting measure. To send the route points you will use a POST request whose body will contain the route parameter in JSON format. The minimum number of route points is 2.

It is possible that the original route will be altered, and some of its points may be skipped. If the route that passes through the found point is faster than the original one, the detour time value is negative. POST requests require the Content-Type header to be set to application/json.

For performance reasons and large data sets, you may use Content-Encoding: gzip, Content-Type: application/json, and Accept-Encoding: gzip headers together with the compressed payload.

Run this endpoint

You can easily run this and other endpoints. Go to the TomTom API Explorer page and follow the directions.

post
Example POST request body (JSON) 
1{
"route": {
  "points": [
    {
      "lat": 52.18553,
      "lon": 21.06509
    },
    {
      "lat": 52.197664,
      "lon": 21.051643
    },
    {
      "lat": 52.230605,
      "lon": 21.041937
    },
    {
      "lat": 52.24528,
      "lon": 21.02332
    },
    {
      "lat": 52.263516,
      "lon": 21.004784
    },
    {
      "lat": 52.28144,
      "lon": 20.99158
    }
  ]
}
30}

Request data

HTTPS Method: `POST`

Constants and parameters enclosed in curly brackets { } must be replaced with their values.
Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

post

URL request format

https://{baseURL}/search/{versionNumber}/searchAlongRoute/{query}.{ext}?key={Your_API_Key}&maxDetourTime={maxDetourTime}&typeahead={typeahead}&limit={limit}&categorySet={categorySet}&brandSet={brandSet}&connectorSet={connectorSet}&fuelSet={fuelSet}&vehicleTypeSet={vehicleTypeSet}&view={view}&detourOffset={detourOffset}&sortBy={sortBy}&openingHours={openingHours}&spreadingMode={spreadingMode}&timeZone={timeZone}&mapcodes={mapcodes}&relatedPois={relatedPois}&minPowerKW={minPowerKW}&maxPowerKW={maxPowerKW}

post

URL request example

https://api.tomtom.com/search/2/searchAlongRoute/pizza.json?key={Your_API_Key}&maxDetourTime=1000

post
curl command request example
1curl -XPOST -d '{
"route": {
  "points": [
    {
      "lat": 52.18553,
      "lon": 21.06509
    },
    {
      "lat": 52.197664,
      "lon": 21.051643
    },
    {
      "lat": 52.230605,
      "lon": 21.041937
    },
    {
      "lat": 52.24528,
      "lon": 21.02332
    },
    {
      "lat": 52.263516,
      "lon": 21.004784
    },
    {
      "lat": 52.28144,
      "lon": 20.99158
    }
  ]
}
30}' 'https://api.tomtom.com/search/2/searchAlongRoute/pizza.json?key={Your_API_Key}&maxDetourTime=1000'

Request parameters

The following table describes the parameters that can be used in a request.

Required parameters must be used or the call will fail.
Optional parameters may be used.
If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
The order of request parameters is not important.

Required parameters	Description
`baseURL` string	Base URL for calling the API. Values: `api.tomtom.com` `kr-api.tomtom.com` (see the Region-specific content page)
`versionNumber` string	The service version. Value: The current value is `2`.
`ext` string	A valid response format. Values: `json` , `jsonp` , `js` , or `xml`.
`key` string	An API Key valid for the requested service. Value: Your valid `API Key`.
`maxDetourTime` integer	Maximum detour time. Maximum value: `3600` seconds.

Optional parameters	Description
`query` string	The query string. It must be properly URL-encoded. Value: A properly URL-encoded query string.
`typeahead` boolean	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`
`limit` integer	The maximum number of responses that will be returned. Default value: `10` Maximum value: `20`
`categorySet` string	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`
`brandSet` string	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)
`connectorSet` string	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` )
`minPowerKW` double	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`.
`maxPowerKW` double	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`.
`fuelSet` string	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)
`vehicleTypeSet` string	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)
`view` string	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`
`detourOffset` boolean	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`.
`sortBy` string	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` string	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.
`openingHours` string	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`
`spreadingMode` string	Enables the even distribution of returned results along the route or closer to the starting point. Default value: `auto` Values: `auto` , `plan` Usage examples: `spreadingMode=auto` : Results are distributed closer to the starting point. `spreadingMode=plan` : The results are evenly distributed along the route.
`mapcodes` string	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)
`timeZone` string	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`
`relatedPois` string	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.

Request headers

Optional headers Description

Optional headers	Description
Accept-Encoding	Enables response compression. Value: `gzip`
Tracking-ID	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.

Accept-Encoding

Enables response compression.
Value: gzip

Tracking-ID

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.

Response data

Response body

For illustrative purposes the example below is neatly indented and includes all possible response fields. Actual responses are more compact and the fields present will vary based on the result type and the data available. See the following response field documentation for more information. When requesting JSON output, the response has the following structure:

Response body - JSON
1{
"summary": {
  "query": "pizza",
  "queryType": "NON_NEAR",
  "queryTime": 137,
  "numResults": 1,
  "offset": 0,
  "totalResults": 1,
  "fuzzyLevel": 1
},
"results": []
12}

Each element of the results array is in the following format:

Results array elements format - JSON

1{
"type": "POI",
"id": "g6JpZK84NDAwNjEwMDE4NjUxNDKhY6NVU0GhdqdVbmlmaWVk",
"score": 4.999,
"dist": 32.32909635789851,
"info": "search:ta:840061001865142-US",
"poi": {
  "name": "Upper Crust Pizza & Pasta",
  "phone": "+(1)-(831)-4762333",
  "url": "www.uppercrustsc.com/",
  "brands": [
    {
      "name": "Upper Crust"
    }
  ],
  "categorySet": [
    {
      "id": 7315015
    }
  ],
  "categories": ["pizza", "restaurant"],
  "openingHours": {
    "mode": "nextSevenDays",
    "timeRanges": [
      {
        "startTime": {
          "date": "2019-02-05",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-05",
          "hour": 21,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-06",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-06",
          "hour": 21,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-07",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-07",
          "hour": 21,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-08",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-08",
          "hour": 21,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-09",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-09",
          "hour": 21,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-10",
          "hour": 7,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-10",
          "hour": 12,
          "minute": 0
        }
      },
      {
        "startTime": {
          "date": "2019-02-10",
          "hour": 14,
          "minute": 0
        },
        "endTime": {
          "date": "2019-02-10",
          "hour": 21,
          "minute": 0
        }
      }
    ]
  },
  "classifications": [
    {
      "code": "RESTAURANT",
      "names": [
        {
          "nameLocale": "en-US",
          "name": "pizza"
        },
        {
          "nameLocale": "en-US",
          "name": "restaurant"
        }
      ]
    }
  ],
  "timeZone": {
    "ianaId": "Europe/Andorra"
  }
},
"relatedPois": [
  {
    "relationType": "child",
    "id": "g6JpZK83ODQwMDkwMDAwMjUxMTWhY6NBUkWhdqdVbmlmaWVk"
  },
  {
    "relationType": "child",
    "id": "u234HsadasKHZK81MjgwMDkwMDQyNDY3jashfsaASDHkjhdA"
  }
],
"address": {
  "streetNumber": "2501",
  "streetName": "Soquel Dr",
  "municipalitySubdivision": "Santa Cruz, Live Oak",
  "municipality": "Santa Cruz, Live Oak",
  "countrySecondarySubdivision": "Santa Cruz",
  "countryTertiarySubdivision": "Santa Cruz",
  "countrySubdivision": "CA",
  "postalCode": "95065",
  "extendedPostalCode": "950652023",
  "countryCode": "US",
  "country": "United States Of America",
  "countryCodeISO3": "USA",
  "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",
  "countrySubdivisionName": "California",
  "localName": "Santa Cruz"
},
"position": {
  "lat": 36.98844,
  "lon": -121.97483
},
"mapcodes": [
  {
    "type": "Local",
    "fullMapcode": "US-CA FS.WRH3",
    "territory": "US-CA",
    "code": "FS.WRH3"
  },
  {
    "type": "International",
    "fullMapcode": "S4ZW4.990V"
  },
  {
    "type": "Alternative",
    "fullMapcode": "US-CA 4349.S8W",
    "territory": "US-CA",
    "code": "4349.S8W"
  },
  {
    "type": "Alternative",
    "fullMapcode": "US-CA JJCH.H9DF",
    "territory": "US-CA",
    "code": "JJCH.H9DF"
  },
  {
    "type": "Alternative",
    "fullMapcode": "USA JJCH.H9DF",
    "territory": "USA",
    "code": "JJCH.H9DF"
  }
],
"viewport": {
  "topLeftPoint": {
    "lat": 36.98934,
    "lon": -121.97596
  },
  "btmRightPoint": {
    "lat": 36.98754,
    "lon": -121.9737
  }
},
"entryPoints": [
  {
    "type": "main",
    "position": {
      "lat": 36.98817,
      "lon": -121.97487
    }
  },
  {
    "type": "minor",
    "functions": ["FrontDoor"],
    "position": {
      "lat": 52.30987,
      "lon": 4.76093
    }
  }
],
"detourTime": 113,
"detourDistance": 211,
"detourOffset": 156,
"chargingPark": {
  "connectors": [
    {
      "connectorType": "IEC62196Type2CCS",
      "ratedPowerKW": 22.2,
      "currentA": 32,
      "currentType": "AC3",
      "voltageV": 380
    },
    {
      "connectorType": "Tesla",
      "ratedPowerKW": 43.2,
      "currentA": 16,
      "currentType": "AC3",
      "voltageV": 480
    }
  ]
},
"dataSources": {
  "chargingAvailability": {
    "id": "442009000132285"
  },
  "parkingAvailability": {
    "id": "00000000-0005-36de-0009-20d4467654e2"
  },
  "fuelPrice": {
    "id": "1:cf81fe50-6218-11ea-a677-d05099d5f839"
  },
  "geometry": {
    "id": "00004e4c-3100-3c00-0000-0000685e23c7"
  }
}
253}

Response fields

The following table describes all of the fields that can appear in a response. Fields are listed by the response section they belong to and in the order that they appear in the response.

Primary fields
Field	Description
`summary` object	Summary information about the search that was performed. summary object
`results` array	The result list, sorted in descending order by score. results array
summary object
Field	Description
`query` string	The query as interpreted by the search engine.
`queryType` string	Response type. Can be `NEARBY` or `NON_NEAR`.
`queryTime` integer	Time spent on resolving the query.
`numResults` integer	The number of results in the response.
`offset` integer	The starting offset of the returned results within the full result set.
`totalResults` integer	The total number of results found.
`fuzzyLevel` integer	The maximum fuzzy level required to provide results.
results array
Field	Description
`type` string	Type of result. Value: `POI`
`id` string	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.
`score` double	The score of the result. A larger score means there is a probability that a result meeting the query criteria is higher.
`dist` double	Unit: meters. This is the distance to an object from the provided route.
`info` string	Information about the original data source of the result.
`poi` object	Information about the Points of Interest in the result. poi object
`relatedPois` object	List of related Points Of Interest. relatedPois object
`address` object	Structured address for the result. address object
`position` object	Position of the result: LatLon
`mapcodes` array	List of `mapcode` objects mapcodes object
`viewport` object	A viewport which can be used to display the result on a map. viewport object
`entrypoints` array	List of entry points of the `POI` (Point of Interest). entryPoints array
`detourTime` integer	Detour time in seconds.
`detourDistance` integer	Detour distance in meters.
`detourOffset` integer	Detour offset in meters.
`chargingPark` object	A list of `chargingPark` objects. Present only when the Points of Interest are of the Electric Vehicle Station type. chargingPark object
`dataSources` object	Optional section. Reference ids for use with the Additional Data service. dataSources object
`fuelTypes` array	Optional section. List of fuel types served by the petrol station. fuelTypes array Fuel Types available
`vehicleTypes` array	Optional section. List of vehicle types supported by the petrol station. vehicleTypes array Available vehicle types: `Car` , `Truck`
poi object
Field	Description
`name` string	Name of the `POI`.
`phone` string	Telephone number.
`brands` array	The list of `POI` brands. brands array
`url` string	Website URL.
`categories` array Deprecated	The list of `POI` categories. Supported Category Codes Deprecated: Use `classifications` instead. As of May 1, 2018 The response `categories` field has been deprecated. It will be withdrawn following a 12 month deprecation period. The planned withdrawal date is May 1, 2019.
`categorySet` array	The list of the most specific `POI` categories. categorySet array
`openingHours` object	List of opening hours for a `POI` (Points of Interest). openingHours object
`classifications` array	The list of `POI` category classifications. classifications array
`timeZone` object	Time zone information for the `POI`. timeZone object
categorySet array
Field	Description
`id` number	Category id. Full list of available categories is available under POI Categories endpoint.
brands array
Field	Description
`name` string	Brand name.
classifications array
Field	Description
`code` string	Fixed top level category code. Supported Category Codes
`names` array	List of category names with locale code information. Currently only `en-US` locale is returned. names array
names array
Field	Description
`nameLocale` string	The locale code of this category name.
`name` string	Category name in the given locale.
relatedPoi object
Field	Description
`relationType` string	Relation type: `child` `parent`
`id` string	Pass this as `entityId` to the Place by ID service to fetch additional data for the Point Of Interest.
address object
Field	Description
`streetNumber` string	The number of the building on the street.
`streetName` string	The street name.
`municipalitySubdivision` string	Sub City
`municipalitySecondarySubdivision` string	Sub Sub City
`neighbourhood` string	Neighbourhood
`municipality` string	City / Town
`countrySecondarySubdivision` string	County
`countryTertiarySubdivision` string	Named Area
`countrySubdivision` string	State or Province
`postalCode` string	Postal Code / Zip Code
`extendedPostalCode` string	Extended postal code (availability dependent on region)
`countryCode` string	Country (Note: This is a two-letter code, not a country name.)
`country` string	Country name
`countryCodeISO3` string	ISO alpha-3 country code
`freeformAddress` string	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.
`countrySubdivisionName` string	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 USA, Canada, and Great Britain.
`localName` string	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.
mapcodes object
Field	Description
`type` string	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.
`fullMapcode` string	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.
`territory` string	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.
`code` string	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.
viewport object
Field	Description
`topLeftPoint` object	Top-left corner of the rectangle: LatLon
`btmRightPoint` object	Bottom-right corner of the rectangle: LatLon
entryPoints array
Field	Description
`type` string	The main entry point. One of: `main` `minor`
`functions` array	If present, represents the type of access for the `POI`. Example: `FrontDoor`
`position` object	Position of the entry point. LatLon
chargingPark object
Field	Description
`connectors` array	A list of connectors available in the Points Of Interest of an Electric Vehicle Station type. connectors array
connectors array
Field	Description
`connectorType` string	Type of the connector available in Electric Vehicle Station. See: Supported Connector Types.
`ratedPowerKW` double	Rated power of the connector in kilowatts (kW).
`currentA` integer	Current value of the connector in amperes (A).
`currentType` string	Current type of the connector.
`voltageV` integer	Voltage of the connector in Volts (V).
dataSources object
Field	Description
`chargingAvailability` object	Information about the charging stations availability. chargingAvailability object
`parkingAvailability` object	Information about the parking site availability. parkingAvailability object
`fuelPrice` object	Information about the fuel station prices. fuelPrice object
`geometry` object	Information about the geometric shape of the result. geometry object
chargingAvailability object
Field	Description
`id` string	Pass this as `chargingAvailability` to the EV Charging Stations Availability service to fetch charging availability information for this result.
parkingAvailability object
Field	Description
`id` string	Pass this as `parkingAvailability` to the Parking Availability service to fetch parking availability information for this result.
fuelPrice object
Field	Description
`id` string	Pass this as `fuelPrice` to the Fuel Prices service to fetch fuel price information for this result.
geometry object
Field	Description
`id` string	Pass this as `geometryId` to the Additional Data service to fetch geometry information for this result.
`sourceName` string	Name of an additional data provider.
LatLon
Field	Description
`lat` float	Latitude. min/max: -90 to +90 Reference: Latitude, Longitude, and Coordinate System Grids
`lon` float	Longitude. min/max: -180 to +180 Reference: Latitude, Longitude, and Coordinate System Grids
openingHours object
Field	Description
`mode` string	Mode used in the request.
`timeRanges` array	List of time ranges for the next 7 days. timeRanges array
timeRanges array
Field	Description
`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), inclusive startTime object
`endTime` 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
startTime object, endTime object
Field	Description
`date` string	Represents current day in calendar year in `POI` time zone.
`hour` integer	Hours are in the 24 hour format in the local time of a `POI` ; possible values are `0` - `23`.
`minute` integer	Minutes are in the local time of a `POI` ; possible values are `0` - `59`.
timeZone object
Field	Description
`ianaId` string	ID from the IANA Time Zone Database.

Response codes

Code	Meaning & possible causes
`200`	OK : The search successfully returned zero or more results.
`400`	Bad Request : One or more parameters were incorrectly specified.
`403`	Forbidden : Possible causes include: Service requires SSL Not authorized Rate or volume limit exceeded Unknown referer
`405`	Method Not Allowed : The HTTP method ( `GET` , `POST` , etc. is not supported for this request.
`404/596`	Not Found : The HTTP request method ( `GET` , `POST` , etc.) or path is incorrect.
`429`	Too Many Requests : The API key is over QPS (Queries per second).
`5xx`	Server Error : The server was unable to process your request. Contact support to resolve the issue.

Response headers

The following table contains response headers sent back from an API server.

Header	Description
Access-Control-Allow-Origin	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.
Content-Type	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`
Content-Encoding	If requested by the client, the Search service applies gzip compression to the responses with the Accept-Encoding header. Value: `gzip`
Tracking-ID	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.

Error response

The error response content type depends on the ext parameter.

Error response example - JSON
1{
"errorText": "Error parsing 'language': Language tag 'en-ES' not supported",
"detailedError": {
  "code": "BadRequest",
  "message": "Error parsing 'language': Language tag 'en-ES' not supported",
  "target": "language"
},
"httpStatusCode": "400"
9}

Error response example - XML
1<?xml version="1.0" encoding="UTF-8"?>
2<response>
3  <errorText>Error parsing 'language': Language tag 'en-ES' not supported</errorText>
4  <detailedError>
5    <code>BadRequest</code>
6    <message>Error parsing 'language': Language tag 'en-ES' not supported</message>
7    <target>language</target>
8  </detailedError>
9  <httpStatusCode>400</httpStatusCode>
10</response>

Error response fields

Primary fields
Field	Description
`errorText` string	A human-readable description of the error.
`detailedError` object	Detailed information about the error. detailedError object
`httpStatusCode` integer	Response codes signifying failed requests to an API server.
detailedError object
Field	Description
`code` string	One of a server-defined set of error codes.
`message` string	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.
`target` string	Optional. Target of the particular error. Value: The name of the request parameter causing the error.