Fetch style
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 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
, andtrafficIncidents
. See theasset_category 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.
https://{baseURL}/maps/orbis/assets/styles/{assetVersion}/style.json?key={Your_API_Key}&apiVersion={API_Version}&map={Map}&hillshade={Hillshade}&trafficFlow={Traffic_Flow}&trafficIncidents={Traffic_Incidents}
https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0/style.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
https://api.tomtom.com/maps/orbis/assets/styles/0.*/style.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0/style.json?key={Your_API_Key}&apiVersion=1&map=basic_street-light&hillshade=hillshade_light&trafficFlow=flow_relative-light&trafficIncidents=incidents_light'
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.*/style.json?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 parameters | Description |
---|---|
| The base URL for calling TomTom services. |
| The chosen version of the asset. |
| 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 hillshade style. It can be one of the following values.
|
| The map style. It can be one of the following values.
|
| The traffic flow style. It can be one of the following values.
|
| The traffic incidents style. 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 JSON format according to the MapLibre style specification. This way it can be used with MapLibre compatible renderers.
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.