Raster Flow Tiles

Service version: 4
Last edit: 2019.02.21

Purpose

The TomTom Flow Tile service serves 256 x 256 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

You can easily run this and other endpoints.

Go to the TomTom API Explorer page.
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.
Review the Response.

For ease of viewing and identification:

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

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

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

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 there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

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. Values: `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. Values: `0..2 ^zoom -1`
`y` integer	y coordinate of tile on zoom grid. Values: `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. Default value: `10` Other values: `1..20`

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

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 <= zoom < 23: The requested zoom level is out of the possible range. x n is out of range [0,m]: The requested x coordinate is out of the possible range (the value of m will vary depending on zoom level). y n is out of range [0,m]: The requested y coordinate is out of the possible range (the value of m will vary depending on zoom level). Unknown format: The requested format is not supported. Invalid `thickness` parameter value.
`403`	Forbidden: The supplied API Key is not valid for this request.
`500`	Internal Server Error
`503`	Service currently unavailable: The service is currently unavailable.
`596`	Service Not Found: Unknown version of the service.