Details

GET

Service version: 3

Last edit: 2026.07.03

TomTom Orbis Maps

Purpose

Delivers detailed information for a location.

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.

get

URL request format

https://{baseURL}/maps/orbis/places/details/{type}/{id}?origin={origin}&geopoliticalView={geopoliticalView}

get

URL request example

https://api.tomtom.com/maps/orbis/places/details/pois/qv3FAP2e0GnYgS-KeAgciA

get
curl command request example
1curl 'https://api.tomtom.com/maps/orbis/places/details/pois/qv3FAP2e0GnYgS-KeAgciA' \
2  -H 'TomTom-Api-Key: {Your_API_Key}' \
3  -H 'TomTom-Api-Version: 3' \
4  -H 'Attributes: id,type,title,subtitles,position,address,additionalDetails.tripAdvisor,chargingLocation,contacts'

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
`baseURL` string	Base URL for calling the API. Values: `api.tomtom.com` `kr-api.tomtom.com` `eu-api.tomtom.com` `us-api.tomtom.com`
`type` string path	The type of result to retrieve details for. Values: `addresses`, `streets`, `intersections`, `pois`, `areas`
`id` string path	The unique identifier of the result to retrieve details for. This may be the be an identifier exposed by other services serving map data from the same sources consumed by TomTom search.
`TomTom-Api-Key` string header	An API Key valid for the requested service. See: How do I get a TomTom API Key? Value: Your valid API Key.
`TomTom-Api-Version` integer header	Version of the API. The API version MUST be specified in all requests. Value: The current value is `3`. Supported Api Versions: `3`
`Attributes` string header	A comma-separated list of response attributes to return. Nested attributes are specified in dot notation. Multiple attributes sharing the same parent can be grouped together using parentheses. Specifying a non-leaf attribute returns all available subattributes implicitly. Note: New response fields may be added over time without notice. When (sub)attributes are requested implicitly, the client must be forward-compatible with respect to new subattributes. Requesting attributes implicitly may have variable cost/billing implications and is therefore not recommended for production use. An empty top-level `Attributes` parameter is not valid. Invalid attributes are rejected with a `400 Bad Request` response. Examples: `id,type,title,subtitles,position,address` `address,additionalDetails.tripAdvisor,chargingLocation,contacts` `chargingLocation(chargingStations)`

Optional parameters	Description
`origin` string query	The position from which result distances are calculated, populating the `distanceInMeters` field on each result. It does not affect result ranking or ordering. Typically the position of the user making the request. Format: `longitude,latitude` Example: `0.0098,51.4934`
`geopoliticalView` string query	Geopolitical view. The context used to resolve the handling of addressing schemes in disputed territories. Default value: `"Unified"` Enum: `"AR"` `"CN"` `"IL"` `"IN"` `"KR"` `"MA"` `"PK"` `"RU"` `"RS"` `"TR"` `"TW"` `"Unified"` Supported geopolitical views: `Unified` `AR`: Argentina `CN`: China `IL`: Israel `IN`: India `KR`: South Korea `MA`: Morocco `PK`: Pakistan `RU`: Russia `RS`: Serbia `TR`: Türkiye `TW`: Taiwan The default and available values depend on the country where the request is made in. If valid value but non available one is used the 403 error is raised. Possible values and defaults(per request-origin country) are as follows: Argentina - default view: `AR`, available views: All China - default view: `CN`, available views: All India - default view: `IN`, available views: `IN` (no other views available) Israel - default view: `IL`, available views: All South Korea (check for region specific contents) - default view: `KR`, available views: `KR` (no other views available) Morocco - default view: `MA`, available views: All Pakistan - default view: `PK`, available views: All Russia - default view: `RU`, available views: All Türkiye - default view: `TR`, available views: All Taiwan - default view: `TW`, available views: All Serbia - default view: `RS`, available views: All Others - default view: `Unified`, available views: All When not specified, the appropriate geopolitical view is applied based on the origin location of the request.
`Session-Id` string header	A unique identifier that must be a 36-character hyphenated UUID (v4 or v7) in the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` (8-4-4-4-12, 36 characters including hyphens), for a places search flow session. A places search application user journey (flow) may start with a `suggest`, `discover` or `details` request. Typically, the application is responsible for identifying the beginning of a places search session and thus is responsible for generating a unique `SessionId` for the session. The session identifier should be reused for all requests within the same user journey. Suggest, Discover and Details results include follow-up places search requests with an embedded `SessionId`. As the user progresses through a search query typing session, interacts with suggestions or discover / details results by making followup places search requests, the session id is propagated via the `SessionId` header prescribed in the followup request specification. A places search session is terminated when either no request has been received by the server for a given `SessionId` within a dynamic server-controlled use-case dependent timeout, or a suggest request is received not preceded by a suggest request with the same `SessionId`. Format: 36-character hyphenated UUID (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`) Min Length: 36 Max Length: 36
`Tracking-Id` string header	A unique identifier for tracking the request across services. The client should provide a globally unique value, preferably a UUID (v4 or v7). While any string format is accepted, the tracking ID must be unique to enable effective request tracing and correlation in logs. Min Length: 10 Max Length: 50
`Accept-Language` string header	Sequence of preferred response IETF BCP 47 language tags compliant with RFC 7231 (section 5.3.5). The API makes best effort to return results in one of the preferred languages, falling back to the prevalent local language in the result's geographical region if none of the preferred languages is available. Example: `en-US,en,hi-Deva;q=0.9`
`Accept` string header	The standard HTTP Accept header indicating the media type(s) the client is able to understand. HTTP reference Allowed Values: `application/json`

Response data

Response body - JSON

See the response body example and the response field documentation below for more information.

Response body example - JSON
1{
"type": "poi",
"more": {
  "operation": "details",
  "requestBody": null,
  "poiTypes": [
    "charging_location"
  ],
  "origin": {
    "type": "point",
    "coordinates": [
      0.0098,
      51.4934
    ]
  },
  "pathParameters": [
    {
      "parameter": "type",
      "argument": "pois"
    },
    {
      "parameter": "id",
      "argument": "qv3FAP2e0GnYgS-KeAgciA"
    }
  ],
  "queryParameters": {
    "origin": "1.0098,53.4934"
  }
},
"id": "qv3FAP2e0GnYgS-KeAgciA",
"address": {
  "country": "Germany",
  "countryCodeIso2": "DE",
  "countrySubdivision": "Berlin",
  "countrySubdivisionCodeIso": "DE-BE",
  "postalCode": "10715",
  "municipality": "Berlin",
  "municipalitySubdivision": "Wilmersdorf",
  "street": "Mainzer Straße",
  "houseNumber": "8"
},
"title": "Dalbhat",
"subtitles": [
  "Mainzer Straße 8, 10715 Berlin-Wilmersdorf"
],
"distanceInMeters": 4321,
"position": {
  "type": "Point",
  "coordinates": [
    0.0098,
    51.4934
  ]
},
"timeZones": {
  "ianaId": "Europe/Berlin",
  "currentUTCOffsetSeconds": 7200
},
"poiTypes": [
  {
    "id": "indian_restaurant",
    "name": "Indian Restaurant"
  },
  {
    "id": "nepalese_restaurant",
    "name": "Nepalese Restaurant"
  }
],
"accessPoints": [
  {
    "position": {
      "type": "Point",
      "coordinates": [
        0.0098,
        51.4934
      ]
    }
  }
],
"openingHours": [
  {
    "date": "2025-06-06",
    "timeRanges": [
      {
        "start": "11:00",
        "end": "23:00",
        "utcOffsetSeconds": 7200
      }
    ]
  }
],
"chargingLocation": {
  "chargingStations": [
    {
      "id": "67335c40-4e72-11e8-8f53-42010a840002",
      "chargingPoints": [
        {
          "capabilities": [
            "RemoteStartStopCapable",
            "RfidReader"
          ],
          "connectors": [
            {
              "id": "1",
              "currentInAmperes": 16,
              "currentType": "AC3",
              "ratedPowerInKilowatts": 11,
              "type": "IEC62196Type2Outlet",
              "voltageInVolts": 230
            },
            {
              "id": "2",
              "currentInAmperes": 16,
              "currentType": "AC3",
              "ratedPowerInKilowatts": 11,
              "type": "IEC62196Type2Outlet",
              "voltageInVolts": 230
            }
          ],
          "evseId": "NL-GFX-EEVB-P1552388-1",
          "physicalReference": "1552388",
          "status": "Occupied"
        },
        {
          "capabilities": [
            "RemoteStartStopCapable",
            "RfidReader"
          ],
          "connectors": [
            {
              "id": "2",
              "currentInAmperes": 16,
              "currentType": "AC3",
              "ratedPowerInKilowatts": 11,
              "type": "IEC62196Type2Outlet",
              "voltageInVolts": 230
            }
          ],
          "evseId": "NL-GFX-EEVB-P1552388-2",
          "physicalReference": "1552388",
          "status": "Available"
        }
      ]
    }
  ]
}
146}

Response fields

The following table describes all of the fields that can appear in a response.

Field	Description
`id` string	Unique identifier of the result. Example: `qv3FAP2e0GnYgS-KeAgciA`
`type` string	Type of the result. Values: `poi`, `address`, `street`, `intersection`, `area`
`title` string	Localized display title for the result.
`subtitles` array	An ordered list of localized text lines that help to understand the result, such as providing additional information or display a colloquial, region-specific address.
`distanceInMeters` integer	Distance of the result from the origin in meters.
`position` object	Position of the location. GeoJSON Point restricted to 2D coordinates (Longitude, Latitude). Contains `type` (`Point`) and `coordinates` (array of [longitude, latitude] in degrees).
`more` object	Follow-up request information. Contains `operation`, `pathParameters`, `queryParameters`, and optional `requestBody`.
address object
Field	Description
`country` string	Country name.
`countryCodeIso2` string	ISO 3166-1 alpha-2 country code.
`countrySubdivision` string	State or province.
`countrySubdivisionCodeIso` string	ISO 3166-2 country subdivision code.
`countrySecondarySubdivision` string	County.
`countryTertiarySubdivision` string	Named area.
`municipality` string	City or town.
`municipalitySubdivision` string	Subdivision of a city.
`municipalitySecondarySubdivision` string	Smaller subdivision of a city.
`neighborhood` string	Neighborhood.
`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.
`extendedPostalCode` string	Extended postal code (availability dependent on region).
`street` string	Name of the street.
`houseNumber` string	The building number on the street.
timeZones array
Field	Description
`ianaId` string	IANA timezone identifier. Example: `Europe/Berlin`
`currentUTCOffsetSeconds` integer	Current UTC offset in seconds, takes into account daylight saving time if applicable. Example: `7200`
accessPoints array
Field	Description
`position` object	GeoJSON Point position of the access point. Contains `type` (`Point`) and `coordinates` (array of [longitude, latitude], optionally followed by elevation in meters). Access points are always on the road network.
poi result (Place of Interest)
Field	Description
`poiTypes` array	Types of places of interest associated with this place of interest. Each object contains `id`, `name`, and optional `parentId`.
`poiBrands` array	Brands associated with this place of interest. Each object contains `id` and `name`. The `id` is a case-sensitive uppercase brand identifier (e.g. `STARBUCKS`).
`openingHours` array	The opening hours for specific dates. The date is in the local time of the place. Each object contains `date` (RFC 3339 format "YYYY-MM-DD") and `timeRanges` array with `start`, `end`, and `utcOffsetSeconds`.
`contacts` array	Contact information. Each object contains `type` (label like "Reservations", "Customer Support"), `phones` (array), `emails` (array), and `websites` (array).
`additionalDetails` object	Additional details about the place of interest curated from various sources. Contains `tripAdvisor` with `id` (the TripAdvisor ID of the place of interest).
`relatedPois` array	Places of interest related to the requested location. Each object contains `id`, `title`, `poiTypes`, and `position` (GeoJSON Point).
chargingLocation object (for EV charging POIs)
Field	Description
`chargingStations` array	Array of charging station objects. Each contains `id` and `chargingPoints` array. Each charging point has `evseId`, `status`, `physicalReference`, `capabilities` array, and `connectors` array. Each connector includes `type`, `ratedPowerInKilowatts`, `currentType`, `currentInAmperes`, and `voltageInVolts`.

Response codes

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

Code	Meaning & possible causes
`200`	OK: Details of one place or location.
`400`	Bad Request: The request was invalid.
`403`	Forbidden: The API Key is missing, inactive, invalid, not entitled to use this API, or the geopolitical view is not available for the request origin.
`404`	Not Found: The requested resource could not be found.
`429`	Too Many Requests: The API Key is over QPS (Queries per second).
`5xx`	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
Session-Id	A unique identifier that must be a 36-character hyphenated UUID (v4 or v7) in the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` (8-4-4-4-12, 36 characters including hyphens), for a places search flow session.
Tracking-Id	A unique identifier for tracking the request across services. If the client provided a Tracking-Id in the request header, this value is echoed back. If not provided, TomTom systems will generate a tracking identifier automatically. This identifier enables effective request tracing and correlation in logs.
Content-Type	Indicates the format of the response as chosen by the client. Value: `application/json`
Content-Language	The HTTP Content-Language representation header is used to describe the language(s) intended for the audience.

Error response

When an error occurs, the response contains detailed error information.

Response 4XX/5XX body structure - JSON
1{
"detailedError": {
  "code": "string",
  "message": "string",
  "target": "string",
  "details": [
    {
      "code": "string",
      "message": "string",
      "target": "string"
    }
  ],
  "innerError": {
    "code": "string",
    "innerError": {}
  }
}
18}

Field	Description
detailedError object
Field	Description
`code` string	A unique identifier for this particular occurrence of the problem that SHOULD be human-readable.
`message` string	It is intended as an aid to developers and is not suitable for exposure to end users. Do not build logic on the content of this field and rely on the `code` instead.
`target` string	The target of the error (e.g., the name of the property in error).
`details` array	Additional details about the error.
`innerError` object	The contents of this object are service-defined. Each nested `innerError` object represents a higher level of detail than its parent.