Weather - Get Air Quality Hourly Forecasts

Service:

Maps

API Version:

1.1

Use to get hourly air quality forecasts for the next one to 96 hours that include pollutant levels, potential risks and suggested precautions.

The Get Air Quality Hourly Forecasts API is an HTTP GET request that returns detailed information about the concentration of pollutants and overall status for forecasted upcoming hourly air quality. The service can provide forecasted hourly air quality information for the upcoming time spans of 1, 12, 24, 48, 72, and 96 hours, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.

GET https://atlas.microsoft.com/weather/airQuality/forecasts/hourly/json?api-version=1.1&query={query}

With optional parameters:

GET https://atlas.microsoft.com/weather/airQuality/forecasts/hourly/json?api-version=1.1&language={language}&query={query}&duration={duration}&pollutants={pollutants}

URI Parameters

Name	In	Required	Type	Description
format	path	True	JsonFormat	Desired format of the response. Only json format is supported.
api-version	query	True	string	Version number of Azure Maps API.
query	query	True	number[]	The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". Weather information is generally available for locations on land, bodies of water surrounded by land, and areas of the ocean that are within approximately 50 nautical miles of a coastline.
duration	query		HourlyDuration int32	Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
language	query		string	Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.
pollutants	query		boolean	Boolean value that returns detailed information about each pollutant. By default is True.

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	AirQualityResult	OK
Other Status Codes	ErrorResponse	An unexpected error occurred.

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

Get Hourly Air Quality Forecasts

Sample request

HTTP

GET https://atlas.microsoft.com/weather/airQuality/forecasts/hourly/json?api-version=1.1&query=47.632346,-122.138874&duration=12

Sample response

Status code:

200

{
  "results": [
    {
      "dateTime": "2021-07-19T04:00:00+00:00",
      "index": 20.1,
      "globalIndex": 19.9,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 7.5,
          "globalIndex": 7.5,
          "concentration": {
            "value": 14.9,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 20.1,
          "globalIndex": 19.9,
          "concentration": {
            "value": 49.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.6,
          "globalIndex": 12.6,
          "concentration": {
            "value": 12.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.3,
          "globalIndex": 6.9,
          "concentration": {
            "value": 3.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.2,
          "globalIndex": 0.6,
          "concentration": {
            "value": 125.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.6,
          "globalIndex": 1.2,
          "concentration": {
            "value": 1.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T05:00:00+00:00",
      "index": 19.2,
      "globalIndex": 19.1,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 7.8,
          "globalIndex": 7.7,
          "concentration": {
            "value": 15.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 19.2,
          "globalIndex": 19.1,
          "concentration": {
            "value": 47.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.9,
          "globalIndex": 12.8,
          "concentration": {
            "value": 12.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.9,
          "globalIndex": 7.1,
          "concentration": {
            "value": 3.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.4,
          "globalIndex": 0.7,
          "concentration": {
            "value": 143.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.7,
          "globalIndex": 1.3,
          "concentration": {
            "value": 1.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T06:00:00+00:00",
      "index": 18.3,
      "globalIndex": 18.2,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8,
          "globalIndex": 8,
          "concentration": {
            "value": 16,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 18.3,
          "globalIndex": 18.2,
          "concentration": {
            "value": 45.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.1,
          "globalIndex": 13.1,
          "concentration": {
            "value": 13.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 15.4,
          "globalIndex": 7.4,
          "concentration": {
            "value": 3.7,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.6,
          "globalIndex": 0.8,
          "concentration": {
            "value": 162.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.4,
          "concentration": {
            "value": 1.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T07:00:00+00:00",
      "index": 17.5,
      "globalIndex": 17.3,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.3,
          "globalIndex": 8.3,
          "concentration": {
            "value": 16.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 17.5,
          "globalIndex": 17.3,
          "concentration": {
            "value": 43.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.4,
          "globalIndex": 13.4,
          "concentration": {
            "value": 13.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 16,
          "globalIndex": 7.7,
          "concentration": {
            "value": 3.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 180.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.5,
          "concentration": {
            "value": 1.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T08:00:00+00:00",
      "index": 16.9,
      "globalIndex": 16.8,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.2,
          "globalIndex": 8.2,
          "concentration": {
            "value": 16.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 16.9,
          "globalIndex": 16.8,
          "concentration": {
            "value": 42,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.4,
          "globalIndex": 13.3,
          "concentration": {
            "value": 13.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 15.4,
          "globalIndex": 7.4,
          "concentration": {
            "value": 3.7,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 180.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.9,
          "globalIndex": 1.6,
          "concentration": {
            "value": 1.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T09:00:00+00:00",
      "index": 16.4,
      "globalIndex": 16.3,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.1,
          "globalIndex": 8.1,
          "concentration": {
            "value": 16.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 16.4,
          "globalIndex": 16.3,
          "concentration": {
            "value": 40.7,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.3,
          "globalIndex": 13.3,
          "concentration": {
            "value": 13.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.8,
          "globalIndex": 7.1,
          "concentration": {
            "value": 3.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 181.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.9,
          "globalIndex": 1.6,
          "concentration": {
            "value": 1.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T10:00:00+00:00",
      "index": 15.9,
      "globalIndex": 15.7,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.1,
          "globalIndex": 8,
          "concentration": {
            "value": 16.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 15.9,
          "globalIndex": 15.7,
          "concentration": {
            "value": 39.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.3,
          "globalIndex": 13.3,
          "concentration": {
            "value": 13.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.2,
          "globalIndex": 6.8,
          "concentration": {
            "value": 3.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 181.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.9,
          "globalIndex": 1.6,
          "concentration": {
            "value": 1.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T11:00:00+00:00",
      "index": 15.8,
      "globalIndex": 15.7,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.1,
          "globalIndex": 8.1,
          "concentration": {
            "value": 16.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 15.8,
          "globalIndex": 15.7,
          "concentration": {
            "value": 39.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 12.8,
          "globalIndex": 13.8,
          "concentration": {
            "value": 13.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.5,
          "globalIndex": 6.9,
          "concentration": {
            "value": 3.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 179.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.6,
          "concentration": {
            "value": 1.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T12:00:00+00:00",
      "index": 15.7,
      "globalIndex": 15.6,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.2,
          "globalIndex": 8.1,
          "concentration": {
            "value": 16.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 15.7,
          "globalIndex": 15.6,
          "concentration": {
            "value": 39,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 13.3,
          "globalIndex": 14.3,
          "concentration": {
            "value": 14.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.7,
          "globalIndex": 7.1,
          "concentration": {
            "value": 3.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.8,
          "globalIndex": 0.9,
          "concentration": {
            "value": 176.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.5,
          "concentration": {
            "value": 1.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T13:00:00+00:00",
      "index": 15.7,
      "globalIndex": 15.5,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 8.2,
          "globalIndex": 8.2,
          "concentration": {
            "value": 16.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 15.7,
          "globalIndex": 15.5,
          "concentration": {
            "value": 38.9,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 13.7,
          "globalIndex": 14.8,
          "concentration": {
            "value": 14.8,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 15,
          "globalIndex": 7.2,
          "concentration": {
            "value": 3.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.7,
          "globalIndex": 0.9,
          "concentration": {
            "value": 173.7,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.5,
          "concentration": {
            "value": 1.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T14:00:00+00:00",
      "index": 18.7,
      "globalIndex": 18.6,
      "dominantPollutant": "Ozone",
      "category": "Excellent",
      "categoryColor": "#00E39B",
      "description": "The air quality is ideal for most individuals; enjoy your normal outdoor activities.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 7.7,
          "globalIndex": 7.7,
          "concentration": {
            "value": 15.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 18.7,
          "globalIndex": 18.6,
          "concentration": {
            "value": 46.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 13.8,
          "globalIndex": 14.9,
          "concentration": {
            "value": 14.9,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.7,
          "globalIndex": 7.1,
          "concentration": {
            "value": 3.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.6,
          "globalIndex": 0.8,
          "concentration": {
            "value": 165.3,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.5,
          "concentration": {
            "value": 1.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    },
    {
      "dateTime": "2021-07-19T15:00:00+00:00",
      "index": 21.8,
      "globalIndex": 22.4,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 7.3,
          "globalIndex": 7.2,
          "concentration": {
            "value": 14.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 21.8,
          "globalIndex": 22.4,
          "concentration": {
            "value": 54.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 13.9,
          "globalIndex": 15,
          "concentration": {
            "value": 15,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 14.5,
          "globalIndex": 6.9,
          "concentration": {
            "value": 3.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.6,
          "globalIndex": 0.8,
          "concentration": {
            "value": 157,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.8,
          "globalIndex": 1.6,
          "concentration": {
            "value": 1.6,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    }
  ]
}

Definitions

Name	Description
AirQuality	Information about the air quality in a specific location at a specific time.
AirQualityResult	This object is returned from a successful Get Air Quality call.
DominantPollutant	Type of pollutant. Please note that more may be added at any time.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HourlyDuration	Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.
JsonFormat	Desired format of the response. Only json format is supported.
Pollutant	Detailed information about an individual pollutant. Not returned if pollutants=false.
PollutantType	Type of pollutant. Please note that more may be added at any time.
UnitType	Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.
WeatherUnit	Specific value of a given unit related to weather.

AirQuality

Information about the air quality in a specific location at a specific time.

Name	Type	Description
category	string	One-word description of the air quality in the requested language. For example, "Excellent".
categoryColor	string	A unique color corresponding to the category of this air quality result.
dateTime	string	Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.
description	string	A textual explanation of this air quality result in the requested language.
dominantPollutant	DominantPollutant	The pollutant with the highest concentration.
globalIndex	number	Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality.
index	number	Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See Wikipedia for more information.
pollutants	Pollutant[]	Information about individual pollutants.

AirQualityResult

This object is returned from a successful Get Air Quality call.

Name	Type	Description
nextLink	string	The is the link to the next page of the features returned. If it's the last page, no this field.
results	AirQuality[]	A list of all air quality results for the queried location.

DominantPollutant

Type of pollutant. Please note that more may be added at any time.

Name	Type	Description
Carbon Monoxide	string	Carbon monoxide ("CO")
Nitrogen Dioxide	string	Nitrogen dioxide ("NO2")
Ozone	string	Ozone ("O3")
Particulate Matter 10	string	Particulate matter 10 ("PM10")
Particulate Matter 2.5	string	Particulate matter 2.5 ("PM2.5")
Sulfur Dioxide	string	Sulfur dioxide ("SO2")

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.

HourlyDuration

Specifies for how many hours from now we would like to know about the air quality. Available values are 1, 12, 24, 48, 72, 96. Default value is 1 hour.

Name	Type	Description
1	string
12	string
24	string
48	string
72	string
96	string

JsonFormat

Desired format of the response. Only json format is supported.

Name	Type	Description
json	string	The JavaScript Object Notation Data Interchange Format

Pollutant

Detailed information about an individual pollutant. Not returned if pollutants=false.

Name	Type	Description
concentration	WeatherUnit	An object containing the number of pollutant particles per volume of air.
globalIndex	number	Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality.
index	number	Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See Wikipedia for more information.
name	string	The name of the pollutant in English.
type	PollutantType	Type of pollutant. Please note that more may be added at any time.

PollutantType

Type of pollutant. Please note that more may be added at any time.

Name	Type	Description
CO	string	Carbon monoxide ("CO")
NO2	string	Nitrogen dioxide ("NO2")
O3	string	Ozone ("O3")
PM10	string	Particulate matter 10 ("PM10")
PM2.5	string	Particulate matter 2.5 ("PM2.5")
SO2	string	Sulfur dioxide ("SO2")

UnitType

Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.

Name	Type	Description
0	Integer
1	Integer
10	Integer
11	Integer
12	Integer
13	Integer
14	Integer
15	Integer
16	Integer
17	Integer
18	Integer
19	Integer
2	Integer
20	Integer
21	Integer
22	Integer
3	Integer
31	Integer
4	Integer
5	Integer
6	Integer
7	Integer
8	Integer
9	Integer

WeatherUnit

Specific value of a given unit related to weather.

Name	Type	Description
unit	string	Type of unit for the returned value.
unitType	UnitType	Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to Weather services in Azure Maps for details.
value	number	Rounded value.