GuidesAPI Reference
Guides

Traffic flow

The current traffic on a road network is rendered using color-coded lines on a transparent background, known as the traffic flow.

Free-flowing traffic

Free-flowing traffic represents road segments where the average speed of the traffic is around the expected free-flow speed, mostly due to a small volume of cars. Example of free-flowing traffic

Heavy traffic

Heavy traffic represents road segments with a higher volume of cars, which would lead to an average speed that is less than the expected free-flow speed. Example of heavy traffic

Queuing traffic

Queuing traffic represents road segments with a very high volume of cars that would lead to an average speed closer that is closer to stopping, and that would reduce the distance between two successive vehicles, which has the effect of creating a queue. Example of queuing traffic

Blocked traffic

Blocked traffic represents road segments that are blocked due to temporary issues, such as construction sites or accidents. Example of blocked traffic

Mandatory request parameters

All mandatory request parameters are provided within the path of the request: /v3/flow/mc/{zoom}/{row}/{column}/{format} The following sections explore the mandatory request parameters.

Zoom, row and column parameters

The combination of zoom, row, and column identify a location to render traffic information on the grid-based representation of the globe, based on the Mercator projection.

zoom

The zoom level of the image. This parameter defines how "close" to the earth the view of the map information is rendered. Smaller road networks will be rendered at higher zoom levels.

row

The row is the horizontal position of the tile on the grid representation of the globe.

column

The column is the vertical position of the tile on the grid representation of the globe.

format

The format the traffic tile is rendered in. The available formats are png and png8.

Optional request parameters

The following sections explore the optional request parameters.

Headers

If-Modified-Since

The If-Modified-Since header can be passed as an HTTP-date as defined by RFC-7232. This header makes a GET request conditionally based on if the traffic data has changed since that date. If the traffic data has not changed, a 304 response code is sent.

If-None-Match

The If-None-Match header can be passed to specify an entity tag of a resource cached in the client.

X-Request-ID

A special header that can be provided to allow identification of a request or group of requests. For more information on X-Request-Id, see Request tracing.

Query Parameters

minTrafficCongestion

Only displays traffic from a specified congestion level. The available options are:

  • free
  • heavy
  • queuing
  • blocked

For example, if minTrafficCongestion=queuing is provided, only queuing and blocked traffic flow are rendered.

size

The size of the image in pixels to be rendered. The available options are:

  • 512 - 512x512 (default)
  • 256 - 256x256

style

The style used to render the traffic information. A list of available styles are available from the info endpoint. The default style is explore.day.