Raster Flow Tiles

The TomTom Traffic Raster Flow Tile service serves 256 x 256 pixel or 512 x 512 pixel tiles showing traffic flow.

• All tiles use the same grid system.
• Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display.
• The Raster Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.

You can easily run this and other endpoints.

1. Go to the TomTom API Explorer page.
2. Click an endpoint.
   1. Click Try it out.
   2. Enter/select all required parameter values and any optional parameter values.
   3. At the bottom of the form, click Execute.
3. Review the Response.

Style examples

Example of relative0 style

Example of relative0-dark style

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.

http(s)://baseURL/traffic/map/versionNumber/tile/flow/style/zoom/x/y.mimeType?key=Your_API_Key&thickness=thickness

Example

https://api.tomtom.com/traffic/map/4/tile/flow/absolute/12/2044/1360.png?key=Your_API_Key

curl command

curl 'http(s)://baseURL/traffic/map/versionNumber/tile/flow/style/zoom/x/y.mimeType?key=Your_API_Key&thickness=thickness'

▲ Return to top

Request parameters

The following table describes all of 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 an optional parameter is not specified, where applicable, the default value listed in the table below will be used.

Note that the flow layer can create a patchwork tile effect if the flow traffic data changes between calls of adjacent tiles.

▲ Return to top

HTTP request headers

The following table lists HTTP request headers of particular interest to clients of the Raster Flow Tiles API endpoint.

Successful response

The Raster Flow Tiles API endpoint for a valid single request returns a response in PNG format. See: style examples for more.

Error response

The Raster Flow Tiles API endpoint, for an invalid single request, returns a response body in XML or JSON format.

• By default the Error response is returned in XML format.
• In order to obtain an Error response in JSON format, the Accept request header with a proper value must be used.
• The types of the fields refer to a JSON response.

Error response field structure

Error response XML example

<errorResponse errorCode="400" description="z out of range 0 <= z <= 22" version="traffic-rasterizer 2.0.009">
  <detailedError>
    <code>INVALID_REQUEST</code>
    <message>z out of range 0 <= z <= 22</message>
  </detailedError>
</errorResponse>

Error response JSON example

{
  "detailedError" : {
    "code" : "INVALID_REQUEST",
    "message" : "z out of range 0 <= z <= 22"
  }
}

▲ Return to top

HTTP response codes

▲ Return to top

HTTP response headers

The following table lists HTTP response headers of particular interest to clients of the Raster Flow Tiles API endpoint.