Map Styles

Service version: 2
Last edit: 2022.05.16

Public Preview Notice

This API is in Public Preview. Go to the Public Preview - what is it? page to see what this means.

We welcome your contribution to the development of this version. Please share your observations and suggestions on our forum or send an email to our software engineers.

We appreciate your feedback, and we will keep you posted on how it's used.


Purpose

The Maps API Resource service delivers resources required to display vector maps. The service consists of the:

  • Metadata method: This retrieves a list of resources of a selected type.
  • Resource method: This retrieves a selected resource.
  • Merged style method: This retrieves a merged style depending on the passed params.
  • Merged sprite method: This retrieves a merged sprite depending on the passed params.

Request data

Metadata method

HTTPS method: GET

Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

GET
Request URL
https://{baseURL}/map/{versionNumber}/{resourceType}/{resourceVersion}/{resourceVariant}/metadata.{format}?key={Your_API_Key}

Examples

GET
Example request URLs
1https://api.tomtom.com/map/1/style/metadata.json?key={Your_API_Key}
2
3https://api.tomtom.com/map/1/style/22.2.1-9/2/metadata.json?key={Your_API_Key}
4
5https://api.tomtom.com/map/1/style/22.*/2/metadata.json?key={Your_API_Key}
6
7https://api.tomtom.com/map/1/sprite/22.2.1-9/2/metadata.json?key={Your_API_Key}
8
9https://api.tomtom.com/map/1/glyph/22.2.1-9/metadata.json?key={Your_API_Key}

curl command format

GET
Request curl command
curl 'https://api.tomtom.com/map/1/style/22.2.1-9/2/metadata.json?key={Your_API_Key}'

Request parameters (Metadata method)

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
Base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 1.
resourceType
string
The type of the requested resource.
Values:
  • style
  • sprite
  • glyph
format
string
The requested response format.
Values:
  • xml
  • json
  • jsonp
key
string
The authorization key for access to the API.
Value: Your valid API Key.
Optional parametersDescription
resourceVersion
string
Version of the requested resource. If the version string contains a wildcard, the latest matching version of the resource will be provided.
Values:
  • A version.
  • A partial version ending with a wildcard character, e.g., *, 22.*, 22.2.1-*.
resourceVariant
string
Variant of the requested resource. Can only be used when resourceVersion is provided.
Value: The variant name, e.g., 2

Resource method

HTTPS method: GET

Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

GET
Request URL
https://{baseURL}/map/{versionNumber}/{resourceType}/{resourceVersion}/{resourceVariant}/{resourceName}?key={Your_API_Key}

Examples

GET
Example request URL
1https://api.tomtom.com/map/1/style/22.*/2/basic_street-light.json?key={Your_API_Key}
2
3https://api.tomtom.com/map/1/style/22.2.1-9/2/basic_street-light.json?key={Your_API_Key}
4
5https://api.tomtom.com/map/1/sprite/22.2.1-9/2/basic_street-light/sprite.png?key={Your_API_Key}

curl command format

GET
Request curl command
curl 'https://api.tomtom.com/map/1/style/22.2.1-9/2/basic_street-light.json?key={Your_API_Key}'

Request parameters (Resource method)

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
Base URL for calling TomTom services
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 1.
resourceType
string
The type of the requested resource.
Values:
  • style
  • sprite
  • glyph
resourceVersion
string
The version of the requested resource. If the version string contains a wildcard, the latest matching version of the resource will be provided. Available versions can be listed using the Metadata method.
Values:
  • A version.
  • A partial version ending with a wildcard character, e.g., *, 22.*, 22.2.1-*.
resourceName
string
The requested resource name (with an extension if applicable). Available resources can be listed using the Metadata method.
Value: A resource name.
key
string
Authorization key for access to the API.
Value: Your valid API Key.
Optional parametersDescription
resourceVariant
string
The variant of the requested resource. Available variants can be listed using the Metadata method.
Value: For example, 2

Merged style method

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.

URL format

GET
Request URL
https://{baseURL}/style/{versionNumber}/style/{resourceVersion}?key={Your_API_Key}&map={map_style}&traffic_incidents={traffic_incident_style}&traffic_flow={traffic_flow_style}&poi={poi_style}

Examples

GET
Example request URLs
1https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light&poi=2/poi_light
2
3https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light
4
5https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light

curl command format

GET
Request curl command
curl 'https://api.tomtom.com/style/1/style/22.2.1-9?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light'

Request parameters (Merged style method)

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.
  • At least one optional parameter; map, traffic_incidents, traffic_flow or poi must be used or the call will fail.
Required parametersDescription
baseURL
string
Base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 1.
resourceVersion
string
Version of the requested resource. Must be newer than or equal to 22.2.1-9. If the version string contains a wildcard, the latest matching version of the resource will be provided.
Values:
  • A version.
  • A partial version ending with a wildcard character, e.g., *, 22.*, 22.2.1-*.
key
string
The authorization key for access to the API.
Value: Your valid API Key.
Optional parametersDescription
map
string
Map style name (including variant if applicable) to be used for the merged style.
Values: See Available map styles.
traffic_incidents
string
Traffic incidents style name (including variant if applicable) to be used for the merged style.
Values: See Available incidents styles.
traffic_flow
string
Traffic flow style name (including variant if applicable) to be used for the merged style.
Values: See Available flow styles.
poi
string
POI style name (including variant if applicable) to be used for the merged style.
Values: See Available POI styles.

Available Map styles

Name (and variant if applicable) Preview Available since Available until
2/basic_street-light 2/basic_street-light 22.2.1-9 -
2/basic_street-dark 2/basic_street-dark 22.2.1-9 -
2/basic_street-light-driving 2/basic_street-light-driving 22.2.1-9 -
2/basic_street-dark-driving 2/basic_street-dark-driving 22.2.1-9 -
2/basic_street-satellite 2/basic_street-satellite 22.2.1-9 -
2/hybrid_street-light 2/hybrid_street-light 22.2.1-9 -
2/hybrid_street-dark 2/hybrid_street-dark 22.2.1-9 -
2/hybrid_street-light-driving 2/hybrid_street-light-driving 22.2.1-9 -
2/hybrid_street-dark-driving 2/hybrid_street-dark-driving 22.2.1-9 -
2/hybrid_street-satellite 2/hybrid_street-satellite 22.2.1-9 -
2/labels_street-light 2/labels_street-light 22.2.1-9 -
2/labels_street-dark 2/labels_street-dark 22.2.1-9 -
2/labels_street-light-driving 2/labels_street-light-driving 22.2.1-9 -
2/labels_street-dark-driving 2/labels_street-dark-driving 22.2.1-9 -
2/labels_street-satellite 2/labels_street-satellite 22.2.1-9 -
basic_main basic_main 20.3.2-3 -
basic_night basic_night 20.3.2-3 -
basic_main-lite basic_main-lite 20.3.2-3 -
basic_night-lite basic_night-lite 20.3.2-3 -
hybrid_main hybrid_main 20.3.2-3 -
hybrid_night hybrid_night 20.3.2-3 -
hybrid_main-lite hybrid_main-lite 20.3.2-3 -
hybrid_night-lite hybrid_night-lite 20.3.2-3 -
labels_main labels_main 20.3.2-3 -
labels_night labels_night 20.3.2-3 -
labels_main-lite labels_main-lite 20.3.2-3 -
labels_night-lite labels_night-lite 20.3.2-3 -

Available Incidents styles

Name (and variant if applicable) Preview Available since Available until
2/incidents_light 2/incidents_light 22.2.1-9 -
2/incidents_dark 2/incidents_dark 22.2.1-9 -
incidents_day incidents_day 20.3.2-3 -
incidents_dark incidents_dark 20.3.2-3 -
incidents_night incidents_night 20.3.2-3 -
incidents_s0 incidents_s0 20.3.2-3 -
incidents_s0-dark incidents_s0-dark 20.3.2-3 -
incidents_s1 incidents_s1 20.3.2-3 -
incidents_s2 incidents_s2 20.3.2-3 -
incidents_s3 incidents_s3 20.3.2-3 -

Available Flow styles

Name (and variant if applicable) Preview Available since Available until
2/flow_relative-light 2/flow_relative-light 22.2.1-9 -
2/flow_relative-dark 2/flow_relative-dark 22.2.1-9 -
flow_absolute flow_absolute 20.3.2-3 -
flow_reduced-sensitivity flow_reduced-sensitivity 20.3.2-3 -
flow_relative-delay flow_relative-delay 20.3.2-3 -
flow_relative0 flow_relative0 20.3.2-3 -
flow_relative0-dark flow_relative0-dark 20.3.2-3 -

Available POI styles

Name (and variant if applicable) Preview Available since Available until
2/poi_light 2/poi_light 22.2.1-9 -
2/poi_dark 2/poi_dark 22.2.1-9 -
2/poi_satellite 2/poi_satellite 22.2.1-9 -
2/poi_dynamic-light 2/poi_dynamic-light 22.2.1-9 -
2/poi_dynamic-dark 2/poi_dynamic-dark 22.2.1-9 -
2/poi_dynamic-light 2/poi_dynamic-light 22.2.1-9 -
poi_main poi_main 20.3.4-6 -
poi_dynamic poi_dynamic 20.4.5-8 -

Merged sprite method

HTTPS method: GET

Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

GET
Request URL
https://{baseURL}/style/{versionNumber}/sprite/{resourceVersion}/{type}?key={Your_API_Key}&map={map_style}&traffic_incidents={traffic_incident_style}&traffic_flow={traffic_flow_style}&poi={poi_style}

Examples

GET
Example request URL
1https://api.tomtom.com/style/1/sprite/22.2.1-9/sprite.png?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light&poi=2/poi_light
2
3https://api.tomtom.com/style/1/sprite/22.2.1-9/sprite@2x.json?key={Your_API_Key}&map=2/basic_street-light&traffic_incidents=2/incidents_light
4
5https://api.tomtom.com/style/1/sprite/22.2.1-9/sprite@2x.png?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light

curl command format

GET
Request curl command
curl 'https://api.tomtom.com/style/1/sprite/22.2.1-9/sprite.json?key={Your_API_Key}&traffic_incidents=2/incidents_light&traffic_flow=2/flow_relative-light'

Request parameters (Merged sprite method)

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.
  • At least one optional parameter; map, traffic_incidents, traffic_flow or poi must be used or the call will fail.
Required parametersDescription
baseURL
string
Base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
The version of the service to call.
Value: The current version is 1.
resourceVersion
string
Version of the requested resource. Must be newer than or equal to 22.2.1-9. If the version string contains a wildcard, the latest matching version of the resource will be provided.
Values:
  • A version.
  • A partial version ending with a wildcard character, e.g., *, 22.*, 22.2.1-*.
type
string
The requested type of data.
Values:
  • sprite.png
  • sprite@2x.png
  • sprite.json
  • sprite@2x.json
key
string
The authorization key for access to the API.
Value: Your valid API Key.
Optional parametersDescription
map
string
Map style name to be used for the merged sprite.
Values: See available map styles.
traffic_incidents
string
Traffic incidents style name to be used for the merged sprite.
Values: See available incidents styles.
traffic_flow
string
Traffic flow style name to be used for the merged sprite.
Values: See available flow styles.
poi
string
POI style name to be used for the merged sprite.
Values: See available poi styles.