Fuzzy Search

Service version: 1
Last edit: 2024.08.30
PUBLIC PREVIEW
TomTom Orbis Maps

Public Preview Notice

Important notes:

  • This TomTom Orbis Maps Search API document collection is in Public Preview. Go to the Public Preview - what is it? page to see what this means.
  • This API is powered by TomTom Orbis Maps.
  • See the TomTom Orbis Maps documentation for more information.

Purpose

The generic, default service is Fuzzy Search which handles the most fuzzy of inputs containing any combination of Indexes abbreviation values. See the Indexes abbreviation values section at the bottom of this page.

This Search service is the canonical single line search. The service is a seamless combination of POI, PAD, Addr, Geo, Str, XStr search and geocoding. The service can be weighted with a contextual position (geobias=point:lat,lon), or fully constrained by a position (geobias=point:lat,lon) and radius, or it can be executed more generally without any geo biasing anchor point. It can also be used for predictive search by "guessing" user intentions.

The default behavior will be to search the entire world. If you want the result for a specific region(-s) use the countrySet parameter, for example: countrySet=US,MX,USA,MEX. See the Search API Market Coverage page for a list of all the countries supported by the Search API engine.

Run this endpoint

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

Request data

HTTPS Method: GET

For ease of viewing and identification:

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

Important note: this request will only work when the coordinates are the only elements in the {query} parameter.

Important note: Either apiVersion parameter or TomTom-Api-Version header needs to be present.

get
URL request format
https://{baseURL}/maps/orbis/places/search/{query}
.{ext}?key={Your_API_Key}&apiVersion={apiVersion}&typeahead={typeahead}&limit={limit}&countrySet={countrySet}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&geobias={geobias}&language={language}&idxSet={idxSet}&extendedPostalCodesFor={extendedPostalCodesFor}&categorySet={categorySet}&brandSet={brandSet}&connectorSet={connectorSet}&fuelSet={fuelSet}&vehicleTypeSet={vehicleTypeSet}&view={view}&openingHours={openingHours}&timeZone={timeZone}&mapcodes={mapcodes}&minPowerKW={minPowerKW}&maxPowerKW={maxPowerKW}&entityTypeSet={entityTypeSet}
get
URL request example
https://api.tomtom.com/maps/orbis/places/search/123%20main%20st.json?key={Your_API_Key}&apiVersion=1
get
curl command request example
curl 'https://api.tomtom.com/maps/orbis/places/search/123%20main%20st.json?key={Your_API_Key}&apiVersion=1'

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

ext
string

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

key
string

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

Value: Your valid API Key.

Optional parameters

Description

apiVersion
string

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.

query
string

The query string. It must be properly URL-encoded.
Value: A properly URL-encoded query string. A user can provide latitude and longitude coordinates or mapcodes directly in the query. Details can be found in the Coordinates in query section and in the Mapcodes in query sections.

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

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

ofs
integer
Deprecated

Starting offset of the returned results within the full result set.
Default value: 0

Deprecated:
As of Sep 28, 2023

  • The request ofs parameter has been deprecated.

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

  • The planned withdrawal date is Sep 28, 2024.

countrySet
string

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.
Values: FR,ES or FRA,ESP , etc. Visit the Search API Market Coverage page for a list of all the countries supported by the Search engine.

lat
float
Deprecated

Latitude, e.g., lat=37.337 lat,lon where results should be biased. Note: supplying a lat/lon without a radius will only bias the search results to that area.
Values: min/max : -90 to +90
Reference: Latitude, Longitude, and Coordinate System Grids

Deprecated: Use geoBias instead.
As of Sep 28, 2023

  • The request lat parameter has been deprecated.

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

  • The planned withdrawal date is Sep 28, 2024.

lon
float
Deprecated

Longitude, e.g., lon=-121.89 lat,lon where results should be biased. Note: supplying a lat/lon without a radius will only bias the search results to that area.
Values: min/max: -180 to +180
Reference: Latitude, Longitude, and Coordinate System Grids

Deprecated: Use geoBias instead.
As of Sep 28, 2023

  • The request lon parameter has been deprecated.

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

  • The planned withdrawal date is Sep 28, 2024.

radius
integer

If radius and position (geobias=point:lat,lon) are set the results will be constrained to the defined area. The radius parameter is specified in meters. Valid radius values are numbers greater than 0. Supplying values equal to or lesser than 0 causes the parameter to be ignored.
Value: A radius.

topLeft
string

Top-left position of the bounding box. Note: the btmRight parameter should always go along with the topLeft parameter as they both define the bounding box.
Value: A comma-separated string composed by lat,lon. 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.

btmRight
string

Bottom-right position of the bounding box. Note: The btmRight parameter should always go along with the topLeft parameter as they both define the bounding box.
Value: A comma-separated string composed by lat,lon. 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.

geobias
string

Location bias for search, which can be specified in different shapes. Location bias is used to communicate a location preference to the search engine - for example, to bias search results to the user's viewport. Currently two types are supported: point and rectangle.


Value: Colon-separated key-value pair, composed of type of shape as a key and the encoded shape as a value. Each shape has its own encoding format:

  • point: point:lat,lon - comma-separated coordinates of the geobias location
  • rectangle: rectangle:topLeftLat,topLeftLon,btmRightLat,btmRightLon - comma-separated coordinates of the rectangle's top left and bottom right vertices

Usage examples:

  • geobias=point:40.7128,-74.0060

  • geobias=rectangle:52.43123,4.7289,52.27801,5.10767

Notes:

  • Difference of rectangle 'geobias' to bounding box ('topLeft', 'btmRight') parameters is that 'geobias' rectangle specifies preference for ranking purpose, but does not act as a hard location filter, whereas results only within bounding box, specified by 'topLeft', 'btmRight' are returned.

  • Point ('lat' + 'lon') parameters and geobias parameters are mutually exclusive. 'geobias' parameter take precedence when both are passed.

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.

extendedPostalCodesFor
string

Indexes for which extended postal codes should be included in the results.
Value: A comma-separated list of index types (in any order). Available values are described in the 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 an extendedPostalCode property of an address. Availability is region-dependent.
Usage examples:

  • extendedPostalCodesFor=POI

  • extendedPostalCodesFor=PAD,Addr,POI

  • extendedPostalCodesFor=None

minFuzzyLevel
integer
Deprecated

Minimum fuzziness level to be used.
Default value: 1
Maximum value: 2

Deprecated:
As of Sep 28, 2023

  • The request minFuzzyLevel parameter has been deprecated.

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

  • The planned withdrawal date is Sep 28, 2024.

maxFuzzyLevel
integer
Deprecated

Maximum fuzziness level to be used.
Default value: 2
Maximum value: 2

Deprecated:
As of Sep 28, 2023

  • The request maxFuzzyLevel parameter has been deprecated.

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

  • The planned withdrawal date is Sep 28, 2024.

idxSet
string

A comma-separated list of indexes which should be utilized for the search.
Value: A comma-separated list of index types (in any order). Available values are described in the Additional information: Indexes abbreviation values section at the bottom of this page. Item order does not matter.
Usage examples:

  • idxSet=POI (search Points Of Interest only)

  • idxSet=PAD,Addr (search addresses only)

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 only Unified.
Default value: Unified

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

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

mapcodes
string

Enables the return of a comma-separated mapcodes list. 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)

relatedPois
string
Not supported

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.

entityTypeSet
string

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 entity types. Item order in the list does not matter. Values are case sensitive.
Available values:

  • Country

  • CountrySubdivision

  • CountrySecondarySubdivision

  • CountryTertiarySubdivision

  • Municipality

  • MunicipalitySubdivision

  • MunicipalitySecondarySubdivision

  • Neighbourhood

  • PostalCodeArea


Usage examples:

  • entityTypeSet=Municipality : Only returns results with a Municipality entity type.

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

Request headers

Optional headers

Description

TomTom-Api-Version

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.

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

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 structure - JSON
1{
2 "summary": {
3 "query": "pizza",
4 "queryTime": 99,
5 "numResults": 10,
6 "totalResults": 4427,
7 "geoBias": {
8 "lat": 36.98844,
9 "lon": -121.97483
10 },
11 "queryIntent": []
12 },
13 "results": []
14}

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

Results array elements format - JSON
1{
2 "type": "POI",
3 "id": "g6JpZK84NDAwNjEwMDE4NjUxNDKhY6NVU0GhdqdVbmlmaWVk",
4 "score": 5,
5 "dist": 0,
6 "entityType": "Municipality",
7 "poi": {
8 "name": "Upper Crust Pizza & Pasta",
9 "phone": "+(1)-(831)-4762333",
10 "url": "www.uppercrustsc.com/",
11 "brands": [
12 {
13 "name": "Upper Crust"
14 }
15 ],
16 "categorySet": [
17 {
18 "id": 7315015
19 }
20 ],
21 "openingHours": {
22 "mode": "nextSevenDays",
23 "timeRanges": [
24 {
25 "startTime": {
26 "date": "2019-02-05",
27 "hour": 7,
28 "minute": 0
29 },
30 "endTime": {
31 "date": "2019-02-05",
32 "hour": 21,
33 "minute": 0
34 }
35 },
36 {
37 "startTime": {
38 "date": "2019-02-06",
39 "hour": 7,
40 "minute": 0
41 },
42 "endTime": {
43 "date": "2019-02-06",
44 "hour": 21,
45 "minute": 0
46 }
47 },
48 {
49 "startTime": {
50 "date": "2019-02-07",
51 "hour": 7,
52 "minute": 0
53 },
54 "endTime": {
55 "date": "2019-02-07",
56 "hour": 21,
57 "minute": 0
58 }
59 },
60 {
61 "startTime": {
62 "date": "2019-02-08",
63 "hour": 7,
64 "minute": 0
65 },
66 "endTime": {
67 "date": "2019-02-08",
68 "hour": 21,
69 "minute": 0
70 }
71 },
72 {
73 "startTime": {
74 "date": "2019-02-09",
75 "hour": 7,
76 "minute": 0
77 },
78 "endTime": {
79 "date": "2019-02-09",
80 "hour": 21,
81 "minute": 0
82 }
83 },
84 {
85 "startTime": {
86 "date": "2019-02-10",
87 "hour": 7,
88 "minute": 0
89 },
90 "endTime": {
91 "date": "2019-02-10",
92 "hour": 12,
93 "minute": 0
94 }
95 },
96 {
97 "startTime": {
98 "date": "2019-02-10",
99 "hour": 14,
100 "minute": 0
101 },
102 "endTime": {
103 "date": "2019-02-10",
104 "hour": 21,
105 "minute": 0
106 }
107 }
108 ]
109 },
110 "timeZone": {
111 "ianaId": "Europe/Andorra"
112 },
113 "features": [
114 {
115 "order": 0,
116 "category": "company_or_office",
117 "group": "business"
118 },
119 {
120 "order": 1,
121 "category": "theater",
122 "group": "cultural"
123 }
124 ]
125 },
126 "address": {
127 "streetNumber": "2501",
128 "streetName": "Soquel Dr",
129 "municipalitySubdivision": "Santa Cruz, Live Oak",
130 "municipality": "Santa Cruz, Live Oak",
131 "countrySecondarySubdivision": "Santa Cruz",
132 "countryTertiarySubdivision": "Santa Cruz",
133 "countrySubdivision": "CA",
134 "postalCode": "95065",
135 "extendedPostalCode": "950652023",
136 "countryCode": "US",
137 "country": "United States Of America",
138 "countryCodeISO3": "USA",
139 "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",
140 "countrySubdivisionName": "California",
141 "localName": "Santa Cruz"
142 },
143 "position": {
144 "lat": 36.98844,
145 "lon": -121.97483
146 },
147 "mapcodes": [
148 {
149 "type": "Local",
150 "fullMapcode": "US-CA FS.WRH3",
151 "territory": "US-CA",
152 "code": "FS.WRH3"
153 },
154 {
155 "type": "International",
156 "fullMapcode": "S4ZW4.990V"
157 },
158 {
159 "type": "Alternative",
160 "fullMapcode": "US-CA 4349.S8W",
161 "territory": "US-CA",
162 "code": "4349.S8W"
163 },
164 {
165 "type": "Alternative",
166 "fullMapcode": "US-CA JJCH.H9DF",
167 "territory": "US-CA",
168 "code": "JJCH.H9DF"
169 },
170 {
171 "type": "Alternative",
172 "fullMapcode": "USA JJCH.H9DF",
173 "territory": "USA",
174 "code": "JJCH.H9DF"
175 }
176 ],
177 "viewport": {
178 "topLeftPoint": {
179 "lat": 36.98934,
180 "lon": -121.97596
181 },
182 "btmRightPoint": {
183 "lat": 36.98754,
184 "lon": -121.9737
185 }
186 },
187 "entryPoints": [
188 {
189 "type": "main",
190 "position": {
191 "lat": 36.98817,
192 "lon": -121.97487
193 }
194 },
195 {
196 "type": "minor",
197 "functions": ["FrontDoor"],
198 "position": {
199 "lat": 52.30987,
200 "lon": 4.76093
201 }
202 }
203 ],
204 "addressRanges": {
205 "rangeLeft": "1 - 3",
206 "rangeRight": "2 - 12",
207 "from": {
208 "lat": 51.16561,
209 "lon": 19.48489
210 },
211 "to": {
212 "lat": 51.16545,
213 "lon": 19.4863
214 }
215 },
216 "chargingPark": {
217 "connectors": [
218 {
219 "connectorType": "IEC62196Type2CCS",
220 "ratedPowerKW": 22.2,
221 "currentA": 32,
222 "currentType": "AC3",
223 "voltageV": 380
224 },
225 {
226 "connectorType": "Tesla",
227 "ratedPowerKW": 43.2,
228 "currentA": 16,
229 "currentType": "AC3",
230 "voltageV": 480
231 }
232 ]
233 },
234 "dataSources": {
235 "chargingAvailability": {
236 "id": "442009000132285"
237 },
238 "parkingAvailability": {
239 "id": "00000000-0005-36de-0009-20d4467654e2"
240 },
241 "fuelPrice": {
242 "id": "1:cf81fe50-6218-11ea-a677-d05099d5f839"
243 },
244 "geometry": {
245 "id": "00004e4c-3100-3c00-0000-0000685e23c7"
246 }
247 }
248}

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 the order that they appear in the response.

Primary fields

Description

summary
object

Summary information about the search that was performed.
summary object

results
array

Result list, sorted in descending order by score.
results array

summary object

FieldDescription

query
string

Query as interpreted by the search engine.

queryTime
integer

Time spent on resolving the query.

numResults
integer

Number of results in the response.

offset
integer
Deprecated

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.

totalResults
integer

Total number of results found.

fuzzyLevel
integer
Deprecated

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.

geoBias
object

Position used to bias the results.
LatLon

queryIntent
array

List of detected query intents.
Query intents

Query intent object

FieldDescription

type
string

Type of query intent. One of:

  • COORDINATE: the query is a coordinate in one of the supported formats (e.g., "48.858380, 2.294440").
  • NEARBY: the query asks for some entity in the proximity of another entity (e.g., "hotel near Lyon").
  • W3W: the query contains a (likely) what3words code (e.g., "///classic.calls.replace").
  • BOOKMARK: the query contains one or more keywords that can refer to saved locations (e.g., "home").

details
object

Details of query intent. Depends on the query intent type. See coordinate intent details, nearby intent details, W3W intent details, bookmark intent details

Coordinate intent details object

FieldDescription

lat
float

Latitude of the (parsed) user input coordinate. See LatLon. The results will be places nearby this coordinate. If lat and lon parameters are specified, the dist field will have the distance between the geoBias and the searched coordinate. See Coordinates in query.

lon
float

Longitude of the (parsed) user input coordinate. See LatLon.

Nearby intent details object

FieldDescription

lat
float

Latitude of the place, near which the user searches for something. See LatLon. For example, for the input restaurant near Berlin central station this is the position of "Berlin Central Station". If lat and lon parameters are specified, the dist field will have the distance between the geoBias and the returned restaurants.

lon
float

Longitude of the place, near which the user searches for something. See LatLon.

query
string

Normalized phrase referring to what the user is searching for near some place. For example, for the input restaurant near Berlin central station the query is restaurant.

text
string

Normalized phrase referring to where the user is searching for some place. For example, for the input restaurant near Berlin central station the text is berlin central station.

W3W intent details object

FieldDescription

address
string

What3words address. For example, for the query classic.calls.replace the address is ///classic.calls.replace. You can use the what3words service to convert this address to a coordinate.

Bookmark details object

FieldDescription

bookmark
string

One of: HOME, WORK. The user possibly searched for a bookmark in your application. You probably want to suggest the user's home or work address as search result.

results array

FieldDescription

type
string

Type of result. One of: POI , Street , Geography , Point Address , Address Range , Cross Street

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

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 if geoBias was provided.

info
string
Deprecated

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.

entityType
string

Optional section. Only present if type == Geography. One of:

  • Country

  • CountrySubdivision

  • CountrySecondarySubdivision

  • CountryTertiarySubdivision

  • Municipality

  • MunicipalitySubdivision

  • MunicipalitySecondarySubdivision

  • Neighbourhood

  • PostalCodeArea

poi
object

Information about the Points of Interest in the result. Optional section. Only present if type == POI.
poi object

relatedPois
object
Not supported

List of related Points Of Interest.
relatedPois object

Not supported As of Sep 28, 2023

  • The request relatedPois parameter field is not supported.

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

boundingBox
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

entrypoints
array

List of entry points of the POI.
entryPoints array

addressRanges
object

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

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

FieldDescription

name
string

Name of the POI.

phone
string

Telephone number.

brands
array

The list of POI brands.
brands array

url
string

Website URL.

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
Deprecated

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.

timeZone
object

Time zone information for the POI.
timeZone object

features
array

The list of the POI features.
features array

categorySet array

FieldDescription

id
number

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

brands array

FieldDescription

name
string

Brand name.

classifications array

FieldDescription

code
string

Fixed top level category code. Supported Category Codes

names
array

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

names array

FieldDescription

nameLocale
string

Locale code of this category name.

name
string

Category name in given locale.

relatedPois object

FieldDescription

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

FieldDescription

streetNumber
string

The building number 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

postalName
string

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.

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. For the USA, in the case of geographies with entityType == PostalCodeArea it will contain the postalName field value.

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.

countrySubdivisionCode
string

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.

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

FieldDescription

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

FieldDescription

topLeftPoint
object

Top-left corner of the rectangle.
LatLon

btmRightPoint
object

Bottom-right corner of the rectangle.
LatLon

boundingBox object

FieldDescription

topLeftPoint
object

Top-left position of the bounding box.
LatLon

btmRightPoint
object

Bottom-right position of the bounding box.
LatLon

entryPoints array

FieldDescription

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

addressRanges object

FieldDescription

rangeLeft
string

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

rangeRight
string

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

from
object

A beginning point of a street segment.
LatLon

to
object

An end point of a street segment.
LatLon

chargingPark object

FieldDescription

connectors
array

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

connectors array

FieldDescription

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

FieldDescription

chargingAvailability
object

Information about the charging stations availability. Only present if type == POI.
chargingAvailability object

parkingAvailability
object

Information about the parking site availability. Only present if type == POI.
parkingAvailability object

fuelPrice
object

Information about the fuel station prices. Only present if type == POI.
fuelPrice object

geometry
object

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

chargingAvailability object

FieldDescription

id
string

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

parkingAvailability object

FieldDescription

id
string

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

fuelPrice object

FieldDescription

id
string

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

geometry object

FieldDescription

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

FieldDescription

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

FieldDescription

mode
string

Mode used in the request.

timeRanges
array

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

timeRanges array

FieldDescription

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

FieldDescription

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

FieldDescription

ianaId
string

ID from the IANA Time Zone Database.

features array

FieldDescription

order
number

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

category
string

The POI feature category.

group
string

The group of the POI feature category.

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 service was unable to process your request. Contact support to resolve the issue.

Response headers

The following data 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{
2 "errorText": "Error parsing 'language': Language tag 'en-ES' not supported",
3 "detailedError": {
4 "code": "BadRequest",
5 "message": "Error parsing 'language': Language tag 'en-ES' not supported",
6 "target": "language"
7 },
8 "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

FieldDescription

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.

Additional information

Coordinates in query

Fuzzy search will also detect if the user has entered coordinates as a query text. In such a case, the search will switch to the reverse geocoding mode, looking for entities closest to the specified location. Coordinates in format

[+-]<LATITUDE>[,; ][one or more space][+-]<LONGITUDE>

can be used together with the radius parameter (if the radius parameter is not provided as the default, radius value is equal to 2 km).

<LATITUDE> - latitude value in format <value><.><value>. Range: +-90.0.
<LONGITUDE> - longitude value in format <value><.><value>. Range: +-180.0.

Examples

  • 12.123,14.5672
  • 12.123;14.5672
  • 12.123 14.5672
  • 12.345678° N, 14.56789° E
  • 12°34'56.7" N, 14°01'02.3" E
  • 12°34.567' N, 14°56.789' W

Mapcodes in query

Fuzzy Search will also detect if the user has entered mapcodes as a query text. All mapcode types are supported:

  • Local
  • Alternative
  • International

Mapcodes in format

<TERRITORY>[space]<CODE>
  • <TERRITORY> - the value is ISO 3166-1 alpha 3 abbreviation for the country name.
    • All alphabets are supported.
    • It can be omitted when International mapcode is queried (for more details see the territory element).
  • <CODE> - the value consists of two groups of letters and digits separated by a dot (for more details see the code element).

Examples

  • US-CA FS.WRH3
  • USA JJCH.H9DF
  • S4ZW4.990V

Indexes abbreviation values

In some cases, a list of indexes can be passed as a parameter to a query, which should be listed with their abbreviations. Available values are:

  • Geo = Geographies - areas on a map which represent administrative division of a land i.e., country, state, city.
  • PAD = Point Addresses - points on map where a specific address with a street name and number can be found in the index, i.e., Soquel Dr 2501.
  • Addr = Address ranges - for some streets there are address points that are interpolated from the beginning and end of the street, those points are represented as address ranges.
  • Str = Streets - representation of streets on the map.
  • XStr = Cross Streets (intersections) - representations of junctions; places where two streets intersect.
  • POI = Points of Interest - points on map that are worth attention and may be interesting.