List styles
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.
Purpose
The list styles endpoint functionality displays the available styles for users, enabling them to select the required one.
- The service presents an array of styles accompanied by URLs to services that facilitate fetching them.
- Subsequently, users can proceed to the fetch style service.
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}?key={Your_API_Key}&apiVersion={API_Version}&assetCategories[]={asset_category}
https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0?key={Your_API_Key}&apiVersion=1&assetCategories[]={asset_category}
https://api.tomtom.com/maps/orbis/assets/styles/0.*?key={Your_API_Key}&apiVersion=1&assetCategories[]={asset_category}
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0?key={Your_API_Key}&apiVersion=1&assetCategories[]={asset_category}'
curl 'https://api.tomtom.com/maps/orbis/assets/styles/0.*?key={Your_API_Key}&apiVersion=1&assetCategories[]={asset_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 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. |
Optional parameters | Description |
---|---|
|
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.
Response schema
1{2 "assets": [3 {4 "asset_category": "string",5 "name": "string",6 "url": "string"7 }8 ]9}
Response field structure
The following table describes JSON element fields that can appear in a response.
Field | Description |
---|---|
| The asset category. It can be one of the following predefined values:
|
| The name of the asset. |
| The URL that can be used to fetch the asset. |
Example
1{2 "assets": [3 {4 "asset_category": "map",5 "name": "basic_street-light",6 "url": "https://api.tomtom.com/maps/orbis/assets/styles/0.0.0-0/style.json?map=basic_street-light&apiVersion=1&key={api_key}"7 }8 ]9}
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.