Traffic - Get Traffic Flow Tile

Service:

Maps

API Version:

1.0

Use to get 256 x 256 pixel tiles showing traffic flow.

The Traffic Flow Tile API is an HTTP GET request that returns real-time information about traffic conditions in 256 x 256 pixel tiles that show 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 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.

GET https://atlas.microsoft.com/traffic/flow/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}

With optional parameters:

GET https://atlas.microsoft.com/traffic/flow/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}&thickness={thickness}

URI Parameters

Name	In	Required	Type	Description
format	path	True	TileFormat	Desired format of the response. Possible values are png & pbf.
api-version	query	True	string	Version number of Azure Maps API.
style	query	True	TrafficFlowTileStyle	The style to be used to render the tile.
x	query	True	integer int32	X coordinate of the tile on zoom grid. Value must be in the range [0, 2zoom -1]. Please see Zoom Levels and Tile Grid for details.
y	query	True	integer int32	Y coordinate of the tile on zoom grid. Value must be in the range [0, 2zoom -1]. Please see Zoom Levels and Tile Grid for details.
zoom	query	True	integer int32	Zoom level for the desired tile. For raster tiles, value must be in the range: 0-22 (inclusive). For vector tiles, value must be in the range: 0-22 (inclusive). Please see Zoom Levels and Tile Grid for details.
thickness	query		integer int32	The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10. This parameter is not valid when format is pbf.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name	Type	Description
200 OK	object	This image is returned from a successful Traffic Flow Tile call Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	An unexpected error occurred. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

• This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

• For more information on Microsoft identity platform, see Microsoft identity platform overview.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Request tile depicting the traffic flow

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/flow/tile/png?api-version=1.0&style=absolute&zoom=12&x=2044&y=1360

Sample Response

Status code:

200

"binary string image"

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
TileFormat	Desired format of the response. Possible values are png & pbf.
TrafficFlowTileStyle	The style to be used to render the tile.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

TileFormat

Desired format of the response. Possible values are png & pbf.

Name	Type	Description
pbf	string	Vector graphic in the pbf format. Supports zoom levels 0 through 22.
png	string	An image in the png format. Supports zoom levels 0 through 18.

TrafficFlowTileStyle

The style to be used to render the tile.

Name	Type	Description
absolute	string	Colors will reflect the absolute speed measured. Absolute speed is the capability to access the full speed.
reduced-sensitivity	string	Displays relative colors but a larger difference from freeflow is required for segments to change the color. This mode only valid when format is png.
relative	string	This is the speed relative to free-flow, highlighting areas of congestion visualizing the traffic flow. Free-flow refers to conditions where there is no congestion and traffic can follow the speed limits. The most used option to visualize traffic flow on a map.
relative-delay	string	Displays relative colors only where they are different from the free-flow speeds. This option will only highlights areas of congestion.