Sorry, you need to enable JavaScript to visit this website.

Raster Flow Tiles

 

Service version: 4
Last edit: 2019.11.06

On this page

Purpose

The TomTom 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 Traffic 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. See the following image.

raster image

Run this endpoint

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.

Request data

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 -XGET '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.
Required parameters
Parameter Description
baseURL
string
Base URL for calling TomTom services.
Value: api.tomtom.com
versionNumber
string
Version of the service to call.
Value: The current value is 4.
style
string
The style to be used to render the tile.

  • When the style is absolute, the colors will reflect the absolute speed measured.
  • Calls using the relative style return the speed relative to free-flow, highlighting areas of congestion.
  • Relative-delay displays relative speeds only where they are different from the freeflow speeds.
  • Reduced-sensitivity displays relative speeds but larger difference from freeflow (depending on FRC) is required for segment to change the color.

Value:

  • absolute
  • relative
  • relative-delay
  • reduced-sensitivity
zoom
integer
Zoom level of the tile to be rendered.
Value: 0..22
x
integer
x coordinate of the tile on the zoom grid.
Value: 0..2 zoom -1
y
integer
y coordinate of tile on zoom grid.
Value: 0..2 zoom -1
mimeType
string
The mime type for the Response.
Value: png
apiKey
string
API Key valid for requested service.
Value: Your valid API Key.
Optional parameters
Parameter Description
[thickness]
integer
The segment width multiplier.
Value: 1..20
Default value: 10
[tileSize]
integer
The tile size dimension in pixels.
Value:

  • 256
  • 512

Default value: 256

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 Response headers of particular interest to clients of the Traffic Incident Raster Tiles API endpoint.

Required headers
Note: There are no required headers in this endpoint.
Optional headers
Parameter Description
Tracking-ID Specifies an identifier for the Request.

  • It can be used to trace a call.
  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
  • An example of the format that matches this regular expression is a UUID (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122.
  • If specified, it is replicated in the Tracking-ID Response header.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: <string>

▲ Return to top

Response data

HTTP Response Codes

Code Meaning and possible causes
200 OK
400 Bad request

  • Unknown style: The requested style is not available.
  • zoom n is out of range [0,22]: The requested zoom level is out of the possible range.
  • x n is out of range [0,2zoom-1]: The requested x coordinate is out of the possible range.
  • y n is out of range [0,2zoom-1]: The requested y coordinate is out of the possible range.
  • Unknown format: The requested format is not supported.
  • Invalid thickness parameter value.
403 Forbidden: The supplied API Key is not valid for this request.
429 Too Many Requests: Too many requests were sent in a given amount of time for the supplied API Key.
500 Internal Server Error.
503 Service currently unavailable.
596 Service Not Found: Unknown version of the service.

▲ Return to top

HTTP Response headers

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

Header Description
Access-Control-Allow-Origin Indicates that cross-origin resource sharing (CORS) is allowed.
Value: *
Cache-Control Contains directives for a caching mechanism.
Value: <private, no-cache, no-store, max-age=0, must-revalidate>
Content-Length Contains information about the size of the Response body.
Value: <decimal number>
Content-Type Indicates the media type of the resource returned.
Value: <image/png; charset=utf-8>
Date Contains the date and time at which the message was originated.
Value: <http-date>
Tracking-ID An identifier for the Request.

  • If the Tracking-ID header was specified in the Request, it is replicated in the Response.
  • Otherwise, it is generated automatically by the service. For details check RFC 4122.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: <string>

▲ Return to top

You are here