Azure Maps Traffic Service (stable:2025-01-01)

2025/07/10 • 1 updated methods

Traffic_GetTrafficIncident (updated)
Description :  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](https://learn.microsoft.com/azure/azure-maps/traffic-coverage?pivots=latest).
Reference :  Link ¶

⚶ Changes

{
  "#id": "Traffic_GetTrafficIncident",
  "$parameters": [
    {
      "#name": "bbox",
      "Description": {
        "new": "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](https://www.rfc-editor.org/rfc/rfc7946#section-5). 
  • **Minimum Dimensions**: The height or width of the bounding box must be at least 12 meters.
  • **Maximum Area**: The bounding box can cover an area up to 10,000 square kilometers.
  • **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.
**Example**: `bbox=-105,37,-94,45`",
        "old": "A rectangular area for the area of interest on the Earth. The sides of the rectangles are defined by longitude and latitude values. It must conform to the GeoJSON format [minLon, minLat, maxLon, maxLat]. For more information, see\u202f [RFC 7946, Section 5](https://www.rfc-editor.org/rfc/rfc7946#section-5). \n\n The height or width of the bounding box should be at least 12m. The maximum area of a bounding box is 10,000 km\u202f^2. \n\nExample: bbox=-105,37,-94,45"
      }
    }
  ]
}

⚼ Request

GET:  /traffic/incident
{
x-ms-client-id:
{
Description: 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. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
incidentType:
{
Description: 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'. ,
Required: False ,
}
string ,
bbox:
{
Description: 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](https://www.rfc-editor.org/rfc/rfc7946#section-5).
  • **Minimum Dimensions**: The height or width of the bounding box must be at least 12 meters.
  • **Maximum Area**: The bounding box can cover an area up to 10,000 square kilometers.
  • **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.
**Example**: `bbox=-105,37,-94,45` ,
Required: True ,
}
array ,
Accept-Language:
{
Description: Language in which traffic incident results should be returned. For more information, see [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for reference. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: `GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}