Azure Maps Traffic API

The Traffic API from Azure Maps — 1 operation(s) for traffic.

GitHub OpenAPI

Operations 1

GET /traffic/incident The Traffic Incident API provides traffic incidents like construction, traffic… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-maps:microsoft-azure-maps-traffic-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-maps-traffic-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Maps Traffic API
  version: '2025-01-01'
  description: Azure Maps Traffic REST APIs
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- AadToken:
  - https://atlas.microsoft.com/.default
- SharedKey: []
- SasToken: []
tags:
- name: Traffic
paths:
  /traffic/incident:
    get:
      operationId: Traffic_GetTrafficIncident
      summary: The Traffic Incident API provides traffic incidents like construction, traffic…
      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.'
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: x-ms-client-id
        in: header
        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. For more

          information on using Microsoft Entra ID security in Azure Maps, see [Manage

          authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).'
        required: false
        x-ms-client-name: clientId
        schema:
          type: string
      - name: incidentType
        in: query
        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
        x-ms-enum:
          name: IncidentType
          modelAsString: true
          values:
          - name: Accident
            value: Accident
            description: Accident
          - name: Congestion
            value: Congestion
            description: Congestion
          - name: DisabledVehicle
            value: DisabledVehicle
            description: DisabledVehicle
          - name: Miscellaneous
            value: Miscellaneous
            description: Miscellaneous
          - name: RoadHazard
            value: RoadHazard
            description: RoadHazard
          - name: Construction
            value: Construction
            description: Construction
          - name: Weather
            value: Weather
            description: Weather
        schema:
          type: string
          enum:
          - Accident
          - Congestion
          - DisabledVehicle
          - Miscellaneous
          - RoadHazard
          - Construction
          - Weather
      - name: bbox
        in: query
        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).

          <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`'
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: number
            format: double
      - name: Accept-Language
        in: header
        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
        x-ms-client-name: acceptLanguage
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficIncidentResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Traffic
components:
  schemas:
    ErrorResponse:
      type: object
      description: 'Common error response for all Azure Resource Manager APIs to return error

        details for failed operations. (This also follows the OData error response

        format.).'
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    FeatureTypeEnum:
      type: string
      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
      x-ms-enum:
        name: FeatureTypeEnum
        modelAsString: true
        values:
        - name: FeatureCollection
          value: FeatureCollection
          description: Specifies the `GeoJSON` `FeatureCollection` object type.
    FeaturesItemTypeEnum:
      type: string
      description: 'Specifies the `GeoJSON` type. The only supported object type is Feature. For

        more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).'
      enum:
      - Feature
      x-ms-enum:
        name: FeaturesItemTypeEnum
        modelAsString: true
        values:
        - name: Feature
          value: Feature
          description: Specifies the `GeoJSON` Feature object type.
    TrafficIncidentFeaturesItem:
      type: object
      description: 'GeoJSON feature object that contains Geometry object and additional properties

        of traffic incidents.'
      properties:
        type:
          $ref: '#/components/schemas/FeaturesItemTypeEnum'
          description: 'Specifies the `GeoJSON` type. The only supported object type is Feature. For

            more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).'
        id:
          type: integer
          format: int64
          description: A unique ID for the incident.
        geometry:
          $ref: '#/components/schemas/GeoJsonPoint'
          description: 'A valid `GeoJSON Point` geometry type. Please refer to [RFC

            7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.'
        properties:
          $ref: '#/components/schemas/TrafficIncidentFeatureProperties'
          description: Specifies detailed information about the traffic incidents.
    GeoJsonPoint:
      type: object
      description: 'A valid `GeoJSON Point` geometry type. Please refer to [RFC

        7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.'
      properties:
        coordinates:
          type: array
          description: 'A `Position` is an array of numbers with two or more elements. The first two

            elements are _longitude_ and _latitude_, precisely in that order.

            _Altitude/Elevation_ is an optional third element. Please refer to [RFC

            7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.'
          items:
            type: number
            format: double
      required:
      - coordinates
      allOf:
      - $ref: '#/components/schemas/GeoJsonGeometry'
      x-ms-discriminator-value: Point
    GeoJsonObjectType:
      type: string
      description: 'Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object

        types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,

        GeometryCollection, Feature and FeatureCollection.'
      enum:
      - Point
      - MultiPoint
      - LineString
      - MultiLineString
      - Polygon
      - MultiPolygon
      - GeometryCollection
      - Feature
      - FeatureCollection
      x-ms-enum:
        name: GeoJsonObjectType
        modelAsString: false
        values:
        - name: GeoJsonPoint
          value: Point
          description: '`GeoJSON Point` geometry.'
        - name: GeoJsonMultiPoint
          value: MultiPoint
          description: '`GeoJSON MultiPoint` geometry.'
        - name: GeoJsonLineString
          value: LineString
          description: '`GeoJSON LineString` geometry.'
        - name: GeoJsonMultiLineString
          value: MultiLineString
          description: '`GeoJSON MultiLineString` geometry.'
        - name: GeoJsonPolygon
          value: Polygon
          description: '`GeoJSON Polygon` geometry.'
        - name: GeoJsonMultiPolygon
          value: MultiPolygon
          description: '`GeoJSON MultiPolygon` geometry.'
        - name: GeoJsonGeometryCollection
          value: GeometryCollection
          description: '`GeoJSON GeometryCollection` geometry.'
        - name: GeoJsonFeature
          value: Feature
          description: '`GeoJSON Feature` object.'
        - name: GeoJsonFeatureCollection
          value: FeatureCollection
          description: '`GeoJSON FeatureCollection` object.'
    ErrorAdditionalInfo:
      type: object
      description: The resource management error additional info.
      properties:
        type:
          type: string
          description: The additional info type.
          readOnly: true
        info:
          type: object
          description: The additional info.
          additionalProperties:
            type: string
          readOnly: true
    TrafficIncidentFeatureProperties:
      type: object
      description: Specifies detailed information about the traffic incidents.
      properties:
        description:
          type: string
          description: 'A description of the incident that includes the road name and the event

            impacting the traffic flow.


            Examples:


            • W 95th St between Switzer Rd and Bluejacket Dr - construction


            • WB Johnson Dr at I-435 - bridge repair'
        startTime:
          type: string
          description: 'The date and time in UTC when the incident occurred, formatted as a dateTime

            value as defined in [RFC 3339, section

            5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6).'
        endTime:
          type: string
          description: 'The date and time in UTC when the traffic incident will end, formatted as a

            dateTime value as defined in [RFC 3339, section

            5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6).'
        lastModifiedTime:
          type: string
          description: 'The date and time in UTC when the incident information was last updated,

            formatted as a dateTime value as defined in [RFC 3339, section

            5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6).'
        isRoadClosed:
          type: boolean
          description: A value of `true` indicates that there is a road closure.
        severity:
          type: integer
          format: int32
          description: 'Specifies the level of importance of the incident.


            - 0: Unknown


            - 1: Minor


            - 2: Moderate


            - 3: Major


            - 4: Undefined (used for road closures and other indefinite delays)'
        incidentType:
          $ref: '#/components/schemas/IncidentType'
          description: 'Specifies the type of traffic incident. This can be used to request and

            differentiate between various types of incidents.'
        title:
          type: string
          description: Specifies the road names and direction of affected roads.
        delay:
          type: number
          format: double
          description: 'The delay caused by the incident in seconds. If no delay or not applicable, it

            returns zero.'
        endPoint:
          type: object
          description: 'A GeoJson Point object that specified the end location of a traffic incident

            such as end of a construction zone.


            This location is part of the incident properties object and by default, cannot

            be interpreted by parsers for display on the map.'
          additionalProperties: {}
        isTrafficJam:
          type: boolean
          description: 'A value of `true` indicates that the area of road covered by this incident is

            experiencing abnormal traffic conditions resulting in non-typical delays.'
    GeoJsonGeometry:
      type: object
      description: 'A valid `GeoJSON` geometry object. The type must be one of the seven valid

        GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString,

        Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC

        7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.'
      properties:
        type:
          $ref: '#/components/schemas/GeoJsonObjectType'
          description: 'Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object

            types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,

            GeometryCollection, Feature and FeatureCollection.'
        bbox:
          type: array
          description: Bounding box. Projection used - EPSG:3857. Please refer to [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946#section-5) for details.
          minItems: 4
          maxItems: 4
          items:
            type: number
            format: double
      discriminator:
        propertyName: type
      required:
      - type
    IncidentType:
      type: string
      description: 'Specifies the type of traffic incident. This can be used to request and

        differentiate between various types of incidents.'
      enum:
      - Accident
      - Congestion
      - DisabledVehicle
      - Miscellaneous
      - RoadHazard
      - Construction
      - Weather
      x-ms-enum:
        name: IncidentType
        modelAsString: true
        values:
        - name: Accident
          value: Accident
          description: Accident
        - name: Congestion
          value: Congestion
          description: Congestion
        - name: DisabledVehicle
          value: DisabledVehicle
          description: DisabledVehicle
        - name: Miscellaneous
          value: Miscellaneous
          description: Miscellaneous
        - name: RoadHazard
          value: RoadHazard
          description: RoadHazard
        - name: Construction
          value: Construction
          description: Construction
        - name: Weather
          value: Weather
          description: Weather
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
    TrafficIncidentResponse:
      type: object
      description: 'A GeoJSON feature collection object that contains a list of traffic incidents

        features.'
      properties:
        type:
          $ref: '#/components/schemas/FeatureTypeEnum'
          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).'
        features:
          type: array
          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.'
          items:
            $ref: '#/components/schemas/TrafficIncidentFeaturesItem'
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    AadToken:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://atlas.microsoft.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: 'These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) 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](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.


        > [!NOTE]

        >

        > * 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](https://aka.ms/amauthdetails).

        > * 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](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

        > * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.

        > * For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).'
    SasToken:
      type: apiKey
      description: 'This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) 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](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.'
      name: SAS Token
      in: header
    SharedKey:
      type: apiKey
      description: 'This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#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](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.'
      name: subscription-key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography or a sovereign cloud, see [Azure Maps geographic scope](https://learn.microsoft.com/azure/azure-maps/geographic-scope).
    required: true
    type: string
    format: uri
    default: https://atlas.microsoft.com
    x-ms-skip-url-encoding: true