Place by ID

Base URL for calling the API.
Values:

• api.tomtom.com

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

Service version.
Value: The current value is 2.

Endpoint name.
Value: place

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

A unique POI, Street, Geography, Point Address, Address Range, or Cross Street identifier.
Value: The identifier of a specific POI, Street, Geography, Point Address, Address Range, or Cross Street.

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

Language in which details about a specific POI should be returned. When information about a specific POI is not available in the requested language or the language is not specified, the NGT (neutral ground truth) language is used.
Value: One of the TomTom IETF Supported Languages tags except NGT and NGT-Latn.

List of opening hours for a POI (Points of Interest).
Values: 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. Can also filter the response to only show selected mapcode types. See the mapcodes object in the response.
Values: One or more of: Local, International, and 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 of the 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: only returns Points Of Interest with a child relation.

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

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

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 value: Unified

Enables response compression.
Value: gzip

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.

Type of result. One of: POI, Street, Geography, Point Address, Address Range, or 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 does not 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. 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

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

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.
Fuel Types available
fuelTypes array

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

The list of POI brands.
brands array

The list of POI categories.

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.

Category Codes

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. A full list of available categories is available under the POI Categories endpoint.

Fixed top level category code. Supported Category Codes](/search-api/documentation/product-information/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 that 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.

Country (Note: this is a two-letter code, not a country name.)

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

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.

Types 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

Top-left position of the bounding box. LatLon

Bottom-right position of the bounding box. 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: 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

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 methods GET, POST, etc. are not supported for this request.

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

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
Value: type/subtype is one of application/json, text/javascript, or text/xml.

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