Geometry Search

Base URL for calling the API.
Values:

• api.tomtom.com
• kr-api.tomtom.com (see the Region-specific content page)

List of geometries to search in (JSON).
Available types are:

• POLYGON with an array of vertices ( lat,lon string )
• CIRCLE with position ( lat,lon string ) and radius (in meters).

The format is as in the example above. The circle radius unit is in meters and must be greater than 0. The list (array) can contain up to 50 geometries, each consisting of up to 50 vertices.
Value: A list of geometries. See the following code example.

1{
2  "type":"POLYGON",
3  "vertices":[
4    "37.7524152343544,-122.43576049804686",
5    "37.70660472542312,-122.43301391601562",
6    "37.712059855877314,-122.36434936523438",
7    "37.75350561243041,-122.37396240234374"
8  ]
9},
10{
11  "type":"CIRCLE",
12  "position":"37.71205,-121.36434",
13  "radius":6000
14}

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

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

Language in which search results should be returned. It should be one of the TomTom IETF Supported Languages 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: A TomTom IETF Supported Languages tag.

Latitude, e.g., lat=37.337 lat,lon where results should be biased.
Values: min/max : -90 to +90
Reference: Latitude, Longitude, and Coordinate System Grids

Longitude, e.g., lon=-121.89 lat,lon where results should be biased.
Values: min/max: -180 to +180
Reference: Latitude, Longitude, and Coordinate System Grids

Indexes for which extended postal codes should be included in the results. Available values are described in 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.
Value: A comma-separated list of index types.
Usage examples:

• extendedPostalCodesFor=POI

• extendedPostalCodesFor=PAD,Addr,POI

• extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

The idxSet parameter allows for fine tuning Search by specifying which indexes to utilize for the search. The pre-defined indexes are:

• Addr = Address range interpolation (when there is no PAD)

• Geo = Geographies

• PAD = Point Addresses

• POI = Points of Interest

• Str = Streets

• XStr = Cross Streets (intersections)

Values: See the preceding list of pre-defined indexes.
Usage examples:

• idxSet=POI (search Points Of Interest only)

• idxSet=PAD,Addr (search addresses only)

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 POI s that belong to (at least) one of the categories from the provided list will be returned.
Usage examples:

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

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

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

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

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

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

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

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

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

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

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

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

Usage examples:

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

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

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

Usage examples:

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

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

Geopolitical View. The context used to resolve the handling of disputed territories. Views include 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

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

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

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)

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.

A comma-separated list of entity types which can be used to restrict the result to a specific entity type. Parameter should be used with the idxSet parameter set to the Geography value.
Value: A comma-separated list of 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 Municipaliy or MunicipalitySubdivision entity type.

Enables response compression.
Value: gzip

Specifies an identifier for the request. It can be used to trace a call. The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'. An example of the format that matches this regular expression is UUID: (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1 ). For details check RFC 4122. If specified, it is replicated in the Tracking-ID response header. It is only meant to be used for support and does not involve tracking of you or your users in any form.
Value: An identifier for the request.

Summary information about the search that was performed.
summary object

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

Response type. Can be NEARBY or NON_NEAR.

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

Position used to bias the results.
LatLon

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

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

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

• Country

• CountrySubdivision

• CountrySecondarySubdivision

• CountryTertiarySubdivision

• Municipality

• MunicipalitySubdivision

• MunicipalitySecondarySubdivision

• Neighbourhood

• PostalCodeArea

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

List of related Points Of Interest.
relatedPois object

Structured address for the result.
address object

Position of the result:
LatLon

List of mapcode objects
mapcodes object

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

List of entry points of the POI.
entryPoints array

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

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

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

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

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

Name of the POI.

The list of POI brands.
brands array

The list of 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.

The list of the most specific POI categories.
categorySet array

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

The list of POI category classifications.
classifications array

Time zone information for the POI.
timeZone object

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

Fixed top level category code. Supported Category Codes

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

Relation type: child , parent

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

An address 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.

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.

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 prefixed by countryCode ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Only present if the returned document has entityType == CountrySubdivision.

• countrySubdivisionCode examples:

  • TX for Texas

  • SCT for Scotland

  • ON for Ontario

  • ZE for Zeeland

  • BB for Brandenburg

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit.

Type of mapcode.
Local
The shortest possible (and easiest to remember) mapcode. Local mapcodes are especially useful when the user knows what territory the mapcode is in (for example, when an application is designed to be used inside just one European country or US state). Note that the code element of a Local mapcode is ambiguous when used without the territory element. For example, the "4J.P2" mapcode can mean the Eiffel Tower location ( 48.858380, 2.294440 ) (with the territory set to FRA ), but also some place in Amsterdam-Noord, Netherlands (52.382184, 4.911021) (with the territory set to NLD ).
International
This mapcode is unambiguous. It is also the longest.
Alternative
Alternatives to Local mapcodes. Each Alternative mapcode points to slightly different coordinates due to the way mapcodes are computed (see the mapcode documentation ). For example, the position from a response can be encoded as "5DM.WC" ( 51.759244, 19.448316 ) and the "VHJ.036" ( 51.759245, 19.448264 ), which are close to each other, but not exactly the same place.

The full form of a mapcode ( territory + code ). It is always unambiguous. The territory element is always in the Latin alphabet. In an International mapcode, the territory part is empty.

The territory element of the mapcode. The territory element is always in the Latin alphabet. Usually, the territory is the ISO 3166-1 alpha 3 abbreviation for the country name. However in these eight very large countries:

• USA
• Canada
• Mexico
• Brazil
• India
• Russia
• China

an address has little meaning unless the user also knows what state it's in (just as, elsewhere, an address has little meaning if the user doesn’t know what country it’s in). More information about territory codes is available at Territories for mapcodes. This field is not returned for an International mapcode.

The mapcode without the territory element. It consists of two groups of letters and digits separated by a dot. The code is using the same language and alphabet as the response. The language parameter may be used to modify the language and alphabet of both the response and the code (for example: Cyrillic for the language 'ru-RU'). This field is not returned for the International mapcodes. Use fullMapcode instead.

Top-left corner of the rectangle:
LatLon

Bottom-right corner of the rectangle:
LatLon

The main entry point. One of: main , minor

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

Position of the entry point:
LatLon

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

An end point of a street segment.
LatLon

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

Type of the connector available in Electric Vehicle Station. See the: List of supported connector types.

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

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

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

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

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

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

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

Pass this as geometryId to the Additional Data service to fetch geometry information for this result.

Latitude. min/max: -90 to +90
Reference: Latitude, Longitude, and Coordinate System Grids

Longitude. min/max: -180 to `+180``
Reference: Latitude, Longitude, and Coordinate System Grids

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

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

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

Represents the current day in the calendar year in the POI time zone.

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

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

Represents current day in calendar year in POI time zone.

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

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

ID from the IANA Time Zone Database.

OK : The search successfully returned zero or more results.

Bad Request : One or more parameters were incorrectly specified.

Forbidden : Possible causes include: Service requires SSL, Not authorized, Rate or volume limit exceeded, Unknown referer

Method Not Allowed : The HTTP method ( GET , POST , etc.) is not supported for this request.

Not Found : The HTTP request method ( GET , POST , etc.) or path is incorrect.

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.

Ensures that clients implementing the CORS security model are able to access the response from this service.
Value: An asterisk * that signifies access to the TomTom API using the Access-Control-Allow-Origin (ACAO) header in its response indicating which origin sites are allowed.

Indicates the format of the response, as chosen by the client.
Format: type/subtype; charset=utf-8
Values: type/subtype is one of application/json , text/javascript , text/xml

If requested by the client, the Search service applies gzip compression to the responses with the Accept-Encoding header.
Value: gzip

An identifier for the request. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service. It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: An identifier for the request.

Detailed information about the error.
detailedError object

Response codes signifying failed requests to an API server.

A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users.

Optional.
Target of the particular error.
Value: The name of the request parameter causing the error.