HTTP request headers

Service version: 1

Last edit: 2024.05.29

TomTom Orbis Maps

Important notes:

Orbis Maps Assets API is currently in public preview.

This API is powered by the TomTom Orbis Maps.

See the TomTom Orbis Maps documentation for more information on Orbis Maps.

See the Orbis Maps Assets API Migration page page for information on how to migrate and use the new Orbis Maps Assets API.

Use of the Orbis Maps Assets API requires an API Key with access rights to Assets API and, depending on the requested assets, Map Display API and/or Traffic API.

Purpose

The following table describes HTTP request headers.
These headers allow fine tuning of the service behavior to the customer needs.

HTTP request headers

Required headers

Required headers	Description
TomTom-Api-Version	The API version of the service to call. This can be omitted if the version is already provided as a query parameter for the particular service. If the version is given both as a query parameter and as a header value, the one from the query parameter takes precedence. Value: `1`

Optional Headers

Optional headers	Description
Accept-Encoding	Contains the content encoding (usually a compression algorithm), that the client is able to understand. Value: `gzip`
If-None-Match	It is used to specify conditions for a resource to be fetched, allowing the server to skip sending the resource if the client already has an up-to-date version, identified by values provided in the Etag header. Value: `string`
Tracking-ID	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 a 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: `string`

Optional headers

Description

Accept-Encoding

Contains the content encoding (usually a compression algorithm), that the client is able to understand.
Value: gzip

If-None-Match

It is used to specify conditions for a resource to be fetched, allowing the server to skip sending the resource if the client already has an up-to-date version, identified by values provided in the Etag header.
Value: string

Tracking-ID

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 a 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: string