Fuzzy Search
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.
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}
https://api.tomtom.com/maps/orbis/places/search/123%20main%20st.json?key={Your_API_Key}&apiVersion=1
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 |
---|---|
| Base URL for calling the API.
|
| A valid response format. |
| An API Key valid for the requested service. See: How do I get a TomTom API Key? |
Optional parameters | Description |
---|---|
| Service version. |
| The query string. It must be properly URL-encoded. |
| If the |
| Maximum number of responses that will be returned. |
| Starting offset of the returned results within the full result set.
|
| 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. |
| Latitude, e.g.,
|
| Longitude, e.g.,
|
| If |
| Top-left position of the bounding box. Note: the
|
| Bottom-right position of the bounding box. Note: The
|
| 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:
Usage examples:
Notes:
|
| 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. |
| Indexes for which extended postal codes should be included in the
results.
|
| Minimum fuzziness level to be used.
|
| Maximum fuzziness level to be used.
|
| A comma-separated list of indexes which should be utilized for the
search.
|
| 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.
|
| A comma-separated list of brand names which could be used to restrict
the result to Points Of Interest of specific brands.
|
| 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
|
| 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). |
| 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). |
| A comma-separated list of fuel types which could be used to restrict the
result to the Points Of Interest of specific fuels. If
Usage examples:
|
| A comma-separated list of vehicle types that could be used to restrict the
result to the Points Of Interest of specific vehicles. If
Usage examples:
|
| Geopolitical View. The context used to resolve the handling of disputed
territories. Views include only |
| List of opening hours for a POI (Points of Interest). |
| Used to indicate the mode in which the timeZone object should be
returned. |
| 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.
|
| An optional parameter that provides the possibility to return related
Points Of Interest.
|
| 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
Usage examples:
|
Request headers
Optional headers | Description |
---|---|
TomTom-Api-Version | Service version. |
Enables response compression. | |
Tracking-ID | Specifies an identifier for the request. It can be used to trace a call.
The value must match the regular expression
|
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:
1{2 "summary": {3 "query": "pizza",4 "queryTime": 99,5 "numResults": 10,6 "totalResults": 4427,7 "geoBias": {8 "lat": 36.98844,9 "lon": -121.9748310 },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": 731501519 }20 ],21 "openingHours": {22 "mode": "nextSevenDays",23 "timeRanges": [24 {25 "startTime": {26 "date": "2019-02-05",27 "hour": 7,28 "minute": 029 },30 "endTime": {31 "date": "2019-02-05",32 "hour": 21,33 "minute": 034 }35 },36 {37 "startTime": {38 "date": "2019-02-06",39 "hour": 7,40 "minute": 041 },42 "endTime": {43 "date": "2019-02-06",44 "hour": 21,45 "minute": 046 }47 },48 {49 "startTime": {50 "date": "2019-02-07",51 "hour": 7,52 "minute": 053 },54 "endTime": {55 "date": "2019-02-07",56 "hour": 21,57 "minute": 058 }59 },60 {61 "startTime": {62 "date": "2019-02-08",63 "hour": 7,64 "minute": 065 },66 "endTime": {67 "date": "2019-02-08",68 "hour": 21,69 "minute": 070 }71 },72 {73 "startTime": {74 "date": "2019-02-09",75 "hour": 7,76 "minute": 077 },78 "endTime": {79 "date": "2019-02-09",80 "hour": 21,81 "minute": 082 }83 },84 {85 "startTime": {86 "date": "2019-02-10",87 "hour": 7,88 "minute": 089 },90 "endTime": {91 "date": "2019-02-10",92 "hour": 12,93 "minute": 094 }95 },96 {97 "startTime": {98 "date": "2019-02-10",99 "hour": 14,100 "minute": 0101 },102 "endTime": {103 "date": "2019-02-10",104 "hour": 21,105 "minute": 0106 }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.97483146 },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.97596181 },182 "btmRightPoint": {183 "lat": 36.98754,184 "lon": -121.9737185 }186 },187 "entryPoints": [188 {189 "type": "main",190 "position": {191 "lat": 36.98817,192 "lon": -121.97487193 }194 },195 {196 "type": "minor",197 "functions": ["FrontDoor"],198 "position": {199 "lat": 52.30987,200 "lon": 4.76093201 }202 }203 ],204 "addressRanges": {205 "rangeLeft": "1 - 3",206 "rangeRight": "2 - 12",207 "from": {208 "lat": 51.16561,209 "lon": 19.48489210 },211 "to": {212 "lat": 51.16545,213 "lon": 19.4863214 }215 },216 "chargingPark": {217 "connectors": [218 {219 "connectorType": "IEC62196Type2CCS",220 "ratedPowerKW": 22.2,221 "currentA": 32,222 "currentType": "AC3",223 "voltageV": 380224 },225 {226 "connectorType": "Tesla",227 "ratedPowerKW": 43.2,228 "currentA": 16,229 "currentType": "AC3",230 "voltageV": 480231 }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 information about the search that was performed. |
| Result list, sorted in descending order by score. |
summary object | |
Field | Description |
| Query as interpreted by the search engine. |
| Time spent on resolving the query. |
| Number of results in the response. |
| Starting offset of the returned results within the full result set.
|
| Total number of results found. |
| Maximum fuzzy level required to provide results.
|
| Position used to bias the results. |
| List of detected query intents. |
Query intent object | |
Field | Description |
| Type of query intent. One of:
|
| 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 | |
Field | Description |
| Latitude of the (parsed) user input coordinate. See LatLon. The results will be places nearby this coordinate.
If |
| Longitude of the (parsed) user input coordinate. See LatLon. |
Nearby intent details object | |
Field | Description |
| Latitude of the place, near which the user searches for something. See LatLon. For example, for the input |
| Longitude of the place, near which the user searches for something. See LatLon. |
| Normalized phrase referring to what the user is searching for near some place. For example, for the input |
| Normalized phrase referring to where the user is searching for some place.
For example, for the input |
W3W intent details object | |
Field | Description |
| What3words address. For example, for the query |
Bookmark details object | |
Field | Description |
| One of: |
results array | |
Field | Description |
| Type of result. One of: |
| 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 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 if |
| Information about the original data source of the result.
|
| Optional section. Only present if
|
| Information about the Points of Interest in the result. Optional
section. Only present if |
| List of related Points Of Interest.
|
| Structured address for the result. address object |
| Position of the result: |
| List of |
| A viewport which can be used to display the result on a map. |
| Optional section. Only present if |
| List of entry points of the POI. |
| Address ranges on a street segment. Available only for results where the
result type is equal to "Address Range". |
| A list of chargingPark |
| Optional section. Reference ids for use with the
Additional Data service. |
| Optional section. List of fuel types served by the petrol station. |
| Optional section. List of vehicle types supported by the petrol station. |
poi object | |
Field | Description |
| Name of the POI. |
| Telephone number. |
| The list of POI brands. |
| Website URL. |
| The list of the most specific POI categories. |
| List of opening hours for a POI (Points of Interest). |
| The list of POI category classifications.
|
| Time zone information for the POI. |
| The list of the POI features. |
categorySet array | |
Field | Description |
| Category id. A full list of available categories is available under the POI Categories endpoint. |
brands array | |
Field | Description |
| Brand name. |
classifications array | |
Field | Description |
| Fixed top level category code. Supported Category Codes |
| List of category names with locale code information. Currently only the
|
names array | |
Field | Description |
| Locale code of this category name. |
| Category name in given locale. |
relatedPois object | |
Field | Description |
| Relation type: |
| Pass this as |
address object | |
Field | Description |
| The building number on the street. |
| The street name. |
| Sub City |
| Sub Sub City |
| Neighbourhood |
| City / Town |
| County |
| Named Area |
| State or Province |
| Postal Code / Zip Code |
| 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
|
| Extended postal code (availability dependent on region). |
| Country ( Note: this is a two-letter code, not a country name.) |
| Country name |
| ISO alpha-3 country code |
| 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
|
| The full name of the first level of a country's administrative
hierarchy. This field appears only in case
|
|
|
| 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 of mapcode. |
| The full form of a mapcode ( |
| The
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
|
| The mapcode without the |
viewport object | |
Field | Description |
| Top-left corner of the rectangle. |
| Bottom-right corner of the rectangle. |
boundingBox object | |
Field | Description |
| Top-left position of the bounding box. |
| Bottom-right position of the bounding box. |
entryPoints array | |
Field | Description |
| The main entry point. One of: |
| If present, represents the type of access for the POI. Example:
|
| Position of the entry point. |
addressRanges object | |
Field | Description |
| An address range on the left side of a street segment (assuming looking from the "from" end toward the "to" end). |
| An address range on the right side of a street segment (assuming looking from the "from" end toward the "to" end). |
| A beginning point of a street segment. |
| An end point of a street segment. |
chargingPark object | |
Field | Description |
| A list of connectors available in the Points Of Interest of an Electric
Vehicle Station type. |
connectors array | |
Field | Description |
| Type of the connector available in Electric Vehicle Station. See: Supported Connector Types. |
| Rated power of the connector in kilowatts (kW). |
| Current value of the connector in amperes (A). |
| Current type of the connector. |
| Voltage of the connector in Volts (V). |
dataSources object | |
Field | Description |
| Information about the charging stations availability. Only present if
|
| Information about the parking site availability. Only present if
|
| Information about the fuel station prices. Only present if
|
| Information about the geometric shape of the result. Only present if
|
chargingAvailability object | |
Field | Description |
| Pass this as |
parkingAvailability object | |
Field | Description |
| Pass this as |
fuelPrice object | |
Field | Description |
| Pass this as |
geometry object | |
Field | Description |
| Pass this as |
| Name of an additional data provider. |
LatLon | |
Field | Description |
| Latitude. min/max: |
| Longitude. min/max: |
openingHours object | |
Field | Description |
| Mode used in the request. |
| List of time ranges for the next 7 days. |
timeRanges array | |
Field | Description |
| 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. |
| 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. |
startTime object, endTime object | |
Field | Description |
| 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 |
| Minutes are in the local time of a POI; possible values are
|
timeZone object | |
Field | Description |
| ID from the IANA Time Zone Database. |
features array | |
Field | Description |
| 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. |
Response codes
Code | Meaning & possible causes |
---|---|
| OK : The search successfully returned zero or more results. |
| Bad request : One or more parameters were incorrectly specified. |
| Forbidden : Possible causes include:
|
| Method Not Allowed : The HTTP method ( |
| Not Found : The HTTP request method ( |
| Too Many Requests : The API Key is over QPS (Queries per second). |
| Server Error : The service was unable to process your request. Contact support to resolve the issue. |
Response headers
The following data table contains response headers sent back from an API server.
Header | Description |
---|---|
Ensures that clients implementing the
CORS security model
are able to access the response from this service. | |
Indicates the format of the response as chosen by the client. Format:
| |
If requested by the client, the Search service applies gzip compression
to the responses with the
Accept-Encoding
header. | |
Tracking-ID | An |
Error response
The error response content type depends on the ext
parameter.
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}
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 |
| A human-readable description of the error. |
| Detailed information about the error. |
| Response codes signifying failed requests to an API server. |
detailedError object | |
Field | Description |
| One of a server-defined set of error codes. |
| A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users. |
| Optional. Target of the particular error. |
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.