Traffic API Developer's Guide

Selecting a Request Pattern

Each request must conform to the format appropriate to the resource (service function) and the addressing scheme (geospatial filter) the request uses to define the area for which to retrieve traffic information.

The supported addressing schemes are:

  • Tile addressing schemes:
    • [Z]/[X]/[Y] – specifies the map zoom level and the coordinates of the map tile in the tile grid corresponding to that zoom level, see The Mercator Projection for details
    • quadkey – an alternative to the [Z]/[X]/[Y] addressing scheme that uses a single value to identify the map tile, see also Quadkeys
  • Area filters:
    • bounding box – defines the area for which to retrieve information as a bounding box (using the parameter bbox, whose value is specified as the latitude and longitude of the top left and bottom right corners of the area, for example, bbox=52.516,13.355;52.511,13.400)
    • proximity – defines the area for which to retrieve information as a circle (using the parameter prox, whose value is the latitude and longitude of the search center, followed by the radius of the search area in meters)
    • corridor – defines the area for which to retrieve information along a specified path (using the parameter corridor, with path and width. The path is a line along the center of the corridor represented by a series of latitude/longitude pairs. Corridor width is given in meters.)

For information about addressing schemes and available resources, see Table 1.

Once you have determined the resource and the addressing scheme, select the appropriate request format pattern, following the guidelines below (listed according to the API resource, whose name is shown in brackets).

Traffic Flow Data (flow)

You can obtain a traffic flow using one of the following request patterns, which reflect the addressing scheme:

Table 1. Traffic Flow Data Request Patterns
Addressing scheme URL pattern
[Z]/[X]/[Y] {base-url}/{path}/{resource}/{format}/{zoom}/{column}/{row}?
Quadkey {base-url}/{path}/{resource}.{format}?quadkey={quadkey}
Bounding box {base-url}/{path}/{resource}.{format}?bbox={bounding box coordinates}
Proximity {base-url}/{path}/{resource}.{format}?prox={proximity coordinates}
Corridor {base-url}/{path}/{resource}.{format}?corridor={corridor coordinates}
Note: In the request patterns above, {path} must be /traffic/6.2/ .

Traffic Incidents (incidents)

You can obtain traffic incident reports using one of the following request patterns which reflect the addressing scheme (this applies for both incident endpoints traffic/6.1/incidents and traffic/6.2/incidents):

Table 2. Traffic Incident Request Patterns
Addressing scheme URL pattern
[Z]/[X]/[Y] {base-url}/{path}/{resource}/{format}/{zoom}/{column}/{row}?
Quadkey {base-url}/{path}/{resource}.{format}?quadkey={quadkey}
Bounding box {base-url}/{path}/{resource}.{format}?bbox={bounding box coordinates}
Proximity {base-url}/{path}/{resource}.{format}?prox={proximity coordinates}
Corridor coordinates {base-url}/{path}/{resource}.{format}?corridor={corridor coordinates}

Traffic Tile (tiles)

You can obtain traffic tiles using one of the following request patterns which reflect the addressing scheme:

Table 3. Traffic Tile Request Patterns
Addressing Scheme URL Pattern
[Z]/[X]/[Y] {tile-base-url}/{path}/{resource}/{format}/{resource}/{zoom}/{column}/{row}/{size}?
Quadkey {tile-base-url}/{path}/{resource}/quadkeytraffic?quadkey={quadkey}
Note: When using the [Z]/[X]/[Y] tile addressing scheme, you can specify tile size and color depth as follows:
  • {size}: tile size, can be one the following values 512, 256, or 128.
  • {format}: color-depth, can be one of the following png, png8, or png32.
For more information, see Selecting a Tile Size and Selecting a Tile Color Depth.

Traffic Flow Availability (flowavailability)

Traffic flow availability information can be retrieved for your profile with an address following the pattern shown below:

Table 4. Traffic flow availability request pattern
Addressing scheme URL pattern
Profile {base-url}/{path}/{resource}.{format}?profile={profile name}