v2

latestSwagger 2.02026-07-1311828.8 KB

The Traffic Incident API provides traffic incidents like construction, traffic congestion and accidents, etc. within a bounding box. It also provides traffic metadata for detailed information about each incident.

The API provides a GeoJSON feature collection of traffic incidents. Each incident includes two point features: the location where you encounter the incident and the end location of a traffic incident like the end of a construction zone. For traffic incident coverage by country/region, see traffic coverage.

get/traffic/incident

Query parameters

api-versionstring required

The API version to use for this operation.

incidentType'Accident' | 'Congestion' | 'DisabledVehicle' | 'Miscellaneous' | 'RoadHazard' | 'Construction' | 'Weather'

Specifies the type of traffic incident to be returned. Multiple incident types within a single request are supported. If not specified, the results will include all incident types within the provided bounding box.

Example, '&incidentType=Accident' or '&incidentType=Accident,Construction'.

bboxnumber[] required

Defines a rectangular area of interest on the Earth's surface. The sides of the rectangle are specified by longitude and latitude values and must adhere to the GeoJSON format: [minLon, minLat, maxLon, maxLat]. For more information, see RFC 7946, Section 5.

<ul><li>**Minimum Dimensions**: The height or width of the bounding box must be at least 12 meters.</li><li>**Maximum Area**: The bounding box can cover an area up to 10,000 square kilometers.</li><li>**Incident Inclusion**: Traffic incidents will be included in the response if they overlap with the bounding box, or if their start, end, or any part of the incident passes through the bounding box. The start and end locations of the incident can be outside the bounding box.</li></ul>**Example**: `bbox=-105,37,-94,45`

Headers

x-ms-client-idstring

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps.

Accept-Languagestring

Language in which traffic incident results should be returned.

For more information, see Supported Languages for reference.

Response

The request has succeeded.

type'FeatureCollection'

Specifies the GeoJSON type. The only supported object type is FeatureCollection. For more information, see RFC 7946.

All 1 operations