Place by ID

Service version: 1
Last edit: 2024.05.31
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 Place by Id service endpoint provides detailed information about the Place found by its identifier (entityId). Currently, Place by Id supports all types by ids.

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: Either apiVersion parameter or TomTom-Api-Version header needs to be present.

get
URL request format
https://{baseURL}/maps/orbis/places/place.{ext}?entityId={Poi_id}&key={Your_API_Key}&apiVersion={apiVersion}&language={one_of_the_supported_languages}&openingHours={openingHours}&timeZone={timeZone}&mapcodes={mapcodes}&view={view}
get
https://api.tomtom.com/maps/orbis/places/place.json?entityId=00004e4c-3100-3c00-0000-0000685e23c7&key={Your_API_Key}&apiVersion=1
get
curl command request example
curl 'https://api.tomtom.com/maps/orbis/places/place.json?entityId=00004e4c-3100-3c00-0000-0000685e23c7&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.
Required parametersDescription

baseURL
string

Base URL for calling the API.
Values:

  • api.tomtom.com

place
string

Endpoint name.
Value: place

ext
string

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

entityId
string

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.

key
string

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

Optional parametersDescription

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.

language
string

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.

openingHours
string

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

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

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

Not supported As of Sep 28, 2023

  • The request relatedPois parameter field is not supported.

view
string

Geopolitical View. The context used to resolve the handling of disputed territories. Views include only Unified.
Default value: Unified

Request headers

Optional headersDescription

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

Response data

Response body

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

Response structure - JSON
1{
2 "summary": {
3 "query": "n/a",
4 "queryTime": 24,
5 "numResults": 1,
6 "totalResults": 1,
7 },
8 "results": []
9}

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 "poi": {
7 "name": "Upper Crust Pizza & Pasta",
8 "phone": "+(1)-(831)-4762333",
9 "url": "www.uppercrustsc.com/",
10 "brands": [
11 {
12 "name": "Upper Crust"
13 }
14 ],
15 "categorySet": [
16 {
17 "id": 7315015
18 }
19 ],
20 "openingHours": {
21 "mode": "NEXT_SEVEN_DAYS",
22 "timeRanges": [
23 {
24 "startTime": {
25 "date": "2019-02-05",
26 "hour": 7,
27 "minute": 0
28 },
29 "endTime": {
30 "date": "2019-02-05",
31 "hour": 21,
32 "minute": 0
33 }
34 },
35 {
36 "startTime": {
37 "date": "2019-02-06",
38 "hour": 7,
39 "minute": 0
40 },
41 "endTime": {
42 "date": "2019-02-06",
43 "hour": 21,
44 "minute": 0
45 }
46 },
47 {
48 "startTime": {
49 "date": "2019-02-07",
50 "hour": 7,
51 "minute": 0
52 },
53 "endTime": {
54 "date": "2019-02-07",
55 "hour": 21,
56 "minute": 0
57 }
58 },
59 {
60 "startTime": {
61 "date": "2019-02-08",
62 "hour": 7,
63 "minute": 0
64 },
65 "endTime": {
66 "date": "2019-02-08",
67 "hour": 21,
68 "minute": 0
69 }
70 },
71 {
72 "startTime": {
73 "date": "2019-02-09",
74 "hour": 7,
75 "minute": 0
76 },
77 "endTime": {
78 "date": "2019-02-09",
79 "hour": 21,
80 "minute": 0
81 }
82 },
83 {
84 "startTime": {
85 "date": "2019-02-10",
86 "hour": 7,
87 "minute": 0
88 },
89 "endTime": {
90 "date": "2019-02-10",
91 "hour": 12,
92 "minute": 0
93 }
94 },
95 {
96 "startTime": {
97 "date": "2019-02-10",
98 "hour": 14,
99 "minute": 0
100 },
101 "endTime": {
102 "date": "2019-02-10",
103 "hour": 21,
104 "minute": 0
105 }
106 }
107 ]
108 },
109 "timeZone": {
110 "ianaId": "Europe/Andorra"
111 },
112 "features": [
113 {
114 "order": 0,
115 "category": "company_or_office",
116 "group": "business"
117 },
118 {
119 "order": 1,
120 "category": "theater",
121 "group": "cultural"
122 }
123 ]
124 },
125 "address": {
126 "streetNumber": "2501",
127 "streetName": "Soquel Dr",
128 "municipalitySubdivision": "Santa Cruz, Live Oak",
129 "municipality": "Santa Cruz, Live Oak",
130 "countrySecondarySubdivision": "Santa Cruz",
131 "countryTertiarySubdivision": "Santa Cruz",
132 "countrySubdivision": "CA",
133 "postalCode": "95065",
134 "extendedPostalCode": "950652023",
135 "countryCode": "US",
136 "country": "United States Of America",
137 "countryCodeISO3": "USA",
138 "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",
139 "countrySubdivisionName": "California",
140 "localName": "Santa Cruz"
141 },
142 "position": {
143 "lat": 36.98844,
144 "lon": -121.97483
145 },
146 "mapcodes": [
147 {
148 "type": "Local",
149 "fullMapcode": "US-CA FS.WRH3",
150 "territory": "US-CA",
151 "code": "FS.WRH3"
152 },
153 {
154 "type": "International",
155 "fullMapcode": "S4ZW4.990V"
156 },
157 {
158 "type": "Alternative",
159 "fullMapcode": "US-CA 4349.S8W",
160 "territory": "US-CA",
161 "code": "4349.S8W"
162 },
163 {
164 "type": "Alternative",
165 "fullMapcode": "US-CA JJCH.H9DF",
166 "territory": "US-CA",
167 "code": "JJCH.H9DF"
168 },
169 {
170 "type": "Alternative",
171 "fullMapcode": "USA JJCH.H9DF",
172 "territory": "USA",
173 "code": "JJCH.H9DF"
174 }
175 ],
176 "viewport": {
177 "topLeftPoint": {
178 "lat": 36.98934,
179 "lon": -121.97596
180 },
181 "btmRightPoint": {
182 "lat": 36.98754,
183 "lon": -121.9737
184 }
185 },
186 "entryPoints": [
187 {
188 "type": "main",
189 "position": {
190 "lat": 36.98817,
191 "lon": -121.97487
192 }
193 }
194 ],
195 "chargingPark": {
196 "connectors": [
197 {
198 "connectorType": "Tesla",
199 "ratedPowerKW": 25,
200 "voltageV": 400,
201 "currentA": 62,
202 "currentType": "DC"
203 }
204 ]
205 },
206 "dataSources": {
207 "chargingAvailability": {
208 "id": "442009000132285"
209 },
210 "geometry": {
211 "id": "00004e4c-3100-3c00-0000-0000685e23c7"
212 }
213 }
214}

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.

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

The following table contains response codes signifying successful and failed requests to an API server.

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

5xx

Server Error : The service was unable to process your request. Contact support to resolve the issue.

Response headers

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

HeaderDescription

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 , or 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