TomTom LogoDocs
Products
Resources
Pricing
Sign in
Assets API
Documentation
API Explorer

Fetch style

Service version: 1Last edit: 2025.01.24TomTom Orbis Maps

Important notes:

Purpose

  • The fetch style endpoint functionality allows users to fetch the selected styles, adhering to the MapLibre specification .
  • Styles from different asset categories can be downloaded individually with the URLs provided when listing styles with List styles .
  • Users can combine multiple styles by submitting multiple parameters associated with available asset categories for styles: map, hillshade, trafficFlow, and trafficIncidents. See the assetCategories parameter in List styles .

Request data

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.
get
Generic URL request format
https://{baseURL}/maps/orbis/assets/styles/{assetVersion}/style?key={Your_API_Key}&apiVersion={API_Version}&map={Map}&hillshade={Hillshade}&trafficFlow={Traffic_Flow}&trafficIncidents={Traffic_Incidents}
get
URL request example
https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0/style?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
get
URL request example - asset version with wildcards
https://api.tomtom.com/maps/orbis/assets/styles/0.*/style?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
get
curl command request example
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0/style?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light'
get
curl command request example - asset version with wildcards
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.*/style?key={Your_API_Key}&apiVersion=1&&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light'

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 parametersDescription

baseURL
string

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

assetVersion
string

The chosen version of the asset.
Versions with wildcards can be used; more information is available at Assets versioning .
Value: string

apiVersion
string

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.

key
string

An API Key valid for the requested service.
This can be omitted if the key is already provided as a request header for the particular service, see HTTP request headers . If the key is given both as a query parameter and as a header value, the one from the header parameter takes precedence. Using the header over the query parameter is the recommended approach, as it avoids exposing the key in URLs and is generally more secure. Value: Your valid API Key.

At least one of the following optional parameters must be provided, or the call fails.

Optional parametersDescription

hillshade
string

The hillshade style. It can be one of the following values.
Values:

  • hillshade_dark
  • hillshade_light
  • hillshade_mono-dark
  • hillshade_mono-light
  • hillshade_satellite

map
string

The map style. It can be one of the following values.
Values:

  • basic_street-light
  • basic_street-dark
  • basic_street-light-driving
  • basic_street-dark-driving
  • basic_mono-light
  • basic_mono-dark
  • basic_street-satellite

trafficFlow
string

The traffic flow style. It can be one of the following values.
Values:

  • flow_relative-light
  • flow_relative-dark

trafficIncidents
string

The traffic incidents style. It can be one of the following values.
Values:

  • incidents_light
  • incidents_dark

Request headers

HTTP request headers are common in 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 according to the MapLibre style specification . This way it can be used with MapLibre compatible renderers.

Error response

Error response field structure

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

FieldDescription

detailedError object

Main object of the error response.

code string

One of a server-defined set of error codes.

message string

A human-readable description of the error code.

Example

Error response example
{
  "detailedError" : {
    "code" : "BAD_REQUEST",
    "message" : "Invalid format of the api version."
  }
}

Response codes

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

Response headers

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