Map Styles

The Traffic API Resource service delivers resources required to display vector traffic 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.

HTTPS method: GET

URL format

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

The generic URL format is as follows:

http|https://baseURL/traffic/map/versionNumber/resourceType/resourceVersion/resourceVariant/metadata.format?key=Your_API_Key

Examples

http://api.tomtom.com/traffic/map/4/style/metadata.xml?key=Your_API_Key

http://api.tomtom.com/traffic/map/4/sprite/20.0.0-0/metadata.json?key=Your_API_Key

curl command

curl -XGET 'http://api.tomtom.com/traffic/map/4/sprite/20.0.0-0/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.
• If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

HTTPS method: GET

URL format

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

The generic URL format is as follows:

http|https://baseURL/traffic/map/versionNumber/resourceType/resourceVersion/resourceVariant/resourceName?key=Your_API_Key

Example

http://api.tomtom.com/traffic/map/4/style/20.0.0-0/flow_absolute.json?key=Your_API_Key

curl command

curl -XGET 'http://api.tomtom.com/traffic/map/4/style/20.0.0-0/flow_absolute.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.
• If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

Most web browsers have a default limitation on the number of active connections that can be allowed to each host.

• This means if map tiles are being loaded via the api.tomtom.com host name, they will be loaded one at a time.
• A trick that can be used to get around this limitation is to cycle through the hosts we have created as aliases.
• These host names are:
  • a.api.tomtom.com
  • b.api.tomtom.com
  • c.api.tomtom.com
  • d.api.tomtom.com
• By cycling through these four different host names, the web browser will be tricked into retrieving four map resources at a time rather than just one.
• This will significantly speed up the performance of map loading.

For instance, if four map styles are being requested, you would request the first one as:

http://a.api.tomtom.com/traffic/map/4/style/(further parameters)

The second would be:

http://b.api.tomtom.com/traffic/map/4/style/(further parameters)

The third would be:

http://c.api.tomtom.com/traffic/map/4/style/(further parameters)

The fourth would be:

http://d.api.tomtom.com/traffic/map/4/style/(further parameters)

When more than four styles are being requested, start back again at a.api.tomtom.com.

Metadata method

The Response to a successful call will be the list of requested resources as shown in the following JSON Response code example. Exception responses will use the Response codes described in the following HTTP Response codes section.

Response body (JSON)

{
  "content" : [
    {
      "name" : "flow_absolute.json",
      "type" : "resource"
    },
    {
      "name" : "flow_reduced-sensitivity.json",
      "type" : "resource"
    },
    {
      "name" : "flow_relative.json",
      "type" : "resource"
    },
    {
      "name" : "flow_relative-delay.json",
      "type" : "resource"
    },
    {
      "name" : "incidents_night.json",
      "type" : "resource"
    },
    {
      "name" : "incidents_s1.json",
      "type" : "resource"
    },
    {
      "name" : "incidents_s2.json",
      "type" : "resource"
    },
    {
      "name" : "incidents_s3.json",
      "type" : "resource"
    }
  ]
}

Resource method

The Response to a successful Request will be the requested resource (style or sprite). Exception responses will use the Response codes described in the following HTTP Response codes section.

HTTP Response codes

HTTP Response headers

The following table lists HTTP Response headers of particular interest to clients of the Traffic Incident Details API endpoint.