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

List sprites

Service version: 1Last edit: 2025.01.24TomTom Orbis Maps

Important notes:

Purpose

The list sprites endpoint functionality displays the available sprites for users, enabling them to select the required one.

  • The service presents an array of sprites accompanied by URLs to services that facilitate fetching them.
  • Subsequently, users can proceed to Fetch sprite .

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/sprites/{assetVersion}?key={Your_API_Key}&apiVersion={API_Version}&assetCategories={category},{category}
get
URL request example
https://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0?key={Your_API_Key}&apiVersion=1&assetCategories={category},{category}
get
URL request example - asset version with wildcards
https://api.tomtom.com/maps/orbis/assets/sprites/0.*?key={Your_API_Key}&apiVersion=1&assetCategories={category},{category}
get
curl command request example
curl 'https://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0?key={Your_API_Key}&apiVersion=1&assetCategories={category},{category}'
get
curl command request example - asset version with wildcards
curl 'https://api.tomtom.com/maps/orbis/assets/sprites/0.*?key={Your_API_Key}&apiVersion=1&assetCategories={category},{category}'

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.
Optional parametersDescription

assetCategories array

  • A filter for categories of particular asset types to be returned in the result.
  • The parameter accepts a comma-separated list of categories, in which case multiple categories are listed.
  • If this parameter is not provided, all of the categories are returned.

  • The URLs returned in a response lead only to a simple sprite. If a user wants to have a sprite that is a combination of multiple available categories, the fetch query should be modified to allow sprite merging. See more information at Fetch sprite .

Values:

  • map
  • trafficFlow
  • trafficIncidents

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.

Response schema

Response body schema
{
  "assets": [
    {
      "category": "string",
      "name": "string",
      "resolutions": [
        {
          "json": {
            "url": "string"
          },
          "png": {
            "url": "string"
          },
        "resolution": "string"
        }
      ]
    }
  ]
}

Response field structure

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

FieldDescription

category string

The asset category. It can be one of the following predefined values:

  • map
  • trafficFlow
  • trafficIncidents

name
string

The name of the sprite.

url
string

The URL that can be used to fetch the asset.

Example

Response example
{
  "assets": [
    {
      "category": "map",
      "name": "basic_street-light",
      "resolutions": [
        {
          "json": {
            "url": "http://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite.json?apiVersion=1&map=basic_street-light&key={api_key}"
          },
          "png": {
            "url": "http://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite.png?apiVersion=1&map=basic_street-light&key={api_key}"
          },
          "resolution": "@1x"
        },
        {
          "json": {
            "url": "http://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite@2x.json?key={api_key}&apiVersion=1&map=basic_street-light&key={api_key}"
          },
          "png": {
            "url": "http://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite@2x.png?key={api_key}&apiVersion=1&map=basic_street-light&key={api_key}"
          },
          "resolution": "@2x"
        }
      ]
    }
  ]
}

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 .