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.

What is the Assets API?

The Assets API is designed to provide customers with official TomTom assets, adhering to MapLibre Style Specification. These assets are used for visualizing tiles from a diverse range of Vector Tiles endpoints on client devices (in both web and mobile applications).

Components of the Assets API

  • Styles define the visual appearance of data: what to draw, in which order, and how. They are created with a JSON-based style specification language, which defines various components like layers, sources, and properties.
  • Sprites are image files, usually in PNG format, accompanied by a JSON file containing metadata. Sprites are composed of small images called icons. The metadata defines each icon's position, size, and other properties. Icons from the sprite can be used to display graphical elements on a map, such as points of interest, road shields, and more.
  • Fonts are used to display textual elements on a map, such as text labels. They are represented by glyph ranges, which are protocol buffer-encoded signed distance fields. A glyph is a single character representation for a given font.
  • All of these Assets API components follow a consistent versioning scheme. Users of the Assets API should ensure to keep styles up to date in their applications. This in turn ensures access to the latest features and visually enhancing improvements for an optimal user experience. See more information at the Assets versioning page.
  • The Assets API provides a means of discovery that lists paths to available services in this suite, that in turn allow users to list and download desired assets.


The Assets API allows users to fetch Map Styles, Traffic Flow Styles, Traffic Incidents Styles, and Hillshade Styles.

List Styles

The list styles endpoint allows users to list the available styles.


The Assets API allows users to fetch sprites containing icons used to visualize points of interest on maps.

List Sprites

The list sprites endpoint allows users to list the available sprites.


The Assets API allows users to fetch font files which can be used to display text on maps.

List Fonts

The list fonts endpoint allows users to list the available fonts.

Getting started

How to get a TomTom API Key

How to get a TomTom API Key

When you use our location Service APIs, we need a way to identify that it is your application that is making the request to use the service (API).

The TomTom Knowledge Base

TomTom Knowledge Base

The TomTom Knowledge Base optimizes the retrieval of information via articles, blogs, FAQs, tutorials, and videos for your use and reference.

The basics

HTTPS method: GET

  • 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.
Generic URL request format
URL request example{Your_API_Key}&apiVersion=1
curl command request example
curl '{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.
  • Parameters and values are case-sensitive.
  • Optional parameters may be used.

Required parameters



The base URL for calling TomTom services.
Value: The default global API endpoint.


The API version of the service to call.
This can be omitted if the version is already provided as a request header for the particular service, see HTTP request headers.
If the version is given both as a query parameter and as a header value, the one from the query parameter takes precedence.
Value: The current value is 1.


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

Request headers

HTTP request headers are common among all the Assets API service. For details, see HTTP request headers.

Response data

Successful response

For a single request, the service returns its response body in JSON format.

Response schema
Response body schema
2 "asset_types": [
3 {
4 "type": "string",
5 "url": "string"
6 }
7 ]
Response field structure

The following table describes JSON element fields that can appear in a response.




The asset type. It can be fonts, styles, or sprites.


The URL to the asset.

Response example
2 "asset_types": [
3 {
4 "type": "styles",
5 "url": "{api_key}"
6 },
7 {
8 "type": "sprites",
9 "url": "{api_key}"
10 },
11 {
12 "type": "fonts",
13 "url": "{api_key}"
14 }
15 ]

Response codes

HTTP response codes are common in the Assets API service. See HTTP response codes for details.

Response headers

HTTP response headers are common in the Assets API service. For details, see HTTP response headers.