Fetch sprite
Important notes:
- This TomTom Orbis API is in public preview.
- This API is powered by the TomTom Orbis Maps.
- See the TomTom Orbis Maps documentation for more information.
Purpose
- The fetch sprite endpoint functionality provides the user with the selected sprites, adhering to the MapLibre specification.
- Sprites from different asset categories can be downloaded individually with the URLs provided when listing sprites List sprites.
- Users can combine multiple sprites by submitting multiple parameters associated with available asset categories for sprites:
map
,trafficFlow
, andtrafficIncidents
. See theasset_category
parameter in List sprites. - When a user is using a high-resolution screen, this must be reflected in the sprite request by the scale factor. See the Request parameters section.
- The scale factor refers to the resolution at which the icons are rendered.
- The scale factor adjusts the size of the icons to accommodate different screen resolutions and pixel densities, ensuring that the icons look sharp and crisp on various devices.
- Two scale factors are supported - for standard resolution screens and for high-resolution screens like Retina displays on Apple devices.
- For a higher scale factor, the sprite icons are rendered at larger sizes to maintain their visual quality at different zoom levels and screen resolutions.
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.
https://{baseURL}/maps/orbis/assets/sprites/{assetVersion}/{spriteScaleFactor}.{format}?key={Your_API_Key}&apiVersion={API_Version}&map={Map}&trafficFlow={Traffic_Flow}&trafficIncidents={Traffic_Incidents}
https://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite@2x.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
https://api.tomtom.com/maps/orbis/assets/sprites/0.*/sprite@2x.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
curl 'https://api.tomtom.com/maps/orbis/assets/sprites/0.0.0-0/sprite@2x.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light'
curl 'https://api.tomtom.com/maps/orbis/assets/sprites/0.*/sprite@2x.json?key={Your_API_Key}&apiVersion=1&map=basic_street-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 parameters | Description |
---|---|
| The base URL for calling TomTom services. |
| The chosen version of the asset. |
| The sprite's scale factor. It can be one of the predefined values.
|
| The format of the sprite. It can be one of the predefined values.
|
| The API version of the service to call. |
| An API Key valid for the requested service. |
At least one of the following optional parameters must be provided, or the call fails.
Optional parameters | Description |
---|---|
| The map sprite sheet. It can be one of the following values.
|
| The traffic flow sprite sheet. It can be one of the following values.
|
| The traffic incidents sprite sheet. It can be one of the following values.
|
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 either JSON or PNG format. Refer to the MapLibre style specification to understand the content.
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.