Place by ID
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.
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}
https://api.tomtom.com/maps/orbis/places/place.json?entityId=00004e4c-3100-3c00-0000-0000685e23c7&key={Your_API_Key}&apiVersion=1
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 parameters | Description |
---|---|
| Base URL for calling the API.
|
| Endpoint name. |
| A valid response format. |
| A unique |
| An API Key valid for the requested service. |
Optional parameters | Description |
---|---|
| Service version. |
| 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. |
| List of opening hours for a POI (Points of Interest). |
| Used to indicate the mode in which the |
| 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.
|
| An optional parameter that provides the possibility to return related
Points Of Interest.
|
| Geopolitical View. The context used to resolve the handling of disputed
territories. Views include only |
Request headers
Optional headers | Description |
---|---|
TomTom-Api-Version | Service version. |
Enables response compression. |
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:
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": 731501518 }19 ],20 "openingHours": {21 "mode": "NEXT_SEVEN_DAYS",22 "timeRanges": [23 {24 "startTime": {25 "date": "2019-02-05",26 "hour": 7,27 "minute": 028 },29 "endTime": {30 "date": "2019-02-05",31 "hour": 21,32 "minute": 033 }34 },35 {36 "startTime": {37 "date": "2019-02-06",38 "hour": 7,39 "minute": 040 },41 "endTime": {42 "date": "2019-02-06",43 "hour": 21,44 "minute": 045 }46 },47 {48 "startTime": {49 "date": "2019-02-07",50 "hour": 7,51 "minute": 052 },53 "endTime": {54 "date": "2019-02-07",55 "hour": 21,56 "minute": 057 }58 },59 {60 "startTime": {61 "date": "2019-02-08",62 "hour": 7,63 "minute": 064 },65 "endTime": {66 "date": "2019-02-08",67 "hour": 21,68 "minute": 069 }70 },71 {72 "startTime": {73 "date": "2019-02-09",74 "hour": 7,75 "minute": 076 },77 "endTime": {78 "date": "2019-02-09",79 "hour": 21,80 "minute": 081 }82 },83 {84 "startTime": {85 "date": "2019-02-10",86 "hour": 7,87 "minute": 088 },89 "endTime": {90 "date": "2019-02-10",91 "hour": 12,92 "minute": 093 }94 },95 {96 "startTime": {97 "date": "2019-02-10",98 "hour": 14,99 "minute": 0100 },101 "endTime": {102 "date": "2019-02-10",103 "hour": 21,104 "minute": 0105 }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.97483145 },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.97596180 },181 "btmRightPoint": {182 "lat": 36.98754,183 "lon": -121.9737184 }185 },186 "entryPoints": [187 {188 "type": "main",189 "position": {190 "lat": 36.98817,191 "lon": -121.97487192 }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 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.
|
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 object |
| 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
The following table contains response codes signifying successful and failed requests to an API server.
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 ( |
| 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.
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. | |
If requested by the client, the Search service applies gzip compression
to the responses with the Accept-Encoding header. |