Weather - Get Air Quality Daily Forecasts

Use to get daily air quality forecasts for the next one to seven days that include pollutant levels, potential risks and suggested precautions.
The Get Air Quality Daily Forecasts API is an HTTP GET request that returns detailed information about the concentration of pollutants and overall status of forecasted daily air quality. The service can provide forecasted daily air quality information for the upcoming 1 to 7 days, including pollution levels, air quality index values, the dominant pollutant, and a brief statement summarizing risk level and suggested precautions.

GET {endpoint}/weather/airQuality/forecasts/daily/json?api-version=1.1&query={query}

GET {endpoint}/weather/airQuality/forecasts/daily/json?api-version=1.1&language={language}&query={query}&duration={duration}

URI Parameters

Request Header

Responses

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.

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

Scopes

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: header

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 Daily Air Quality Forecasts

GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3

{
  "results": [
    {
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "dateTime": "2021-07-18T07:00:00+00:00",
      "dominantPollutant": "Ozone",
      "globalIndex": 42.2,
      "index": 35.1
    },
    {
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "dateTime": "2021-07-19T07:00:00+00:00",
      "dominantPollutant": "Ozone",
      "globalIndex": 37,
      "index": 31.6
    },
    {
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "dateTime": "2021-07-20T07:00:00+00:00",
      "dominantPollutant": "Ozone",
      "globalIndex": 40,
      "index": 33.6
    }
  ]
}

Definitions

DailyAirQuality

The forecasted air-quality reading for a single day at the queried location, returned as one entry in DailyAirQualityForecastResult.results. Each entry summarizes the day's expected air quality on the same scales used by AirQuality for the current reading - the local AQI (index), the internationally normalized index (globalIndex), the dominantPollutant, a short category label (for example, Fair) and matching categoryColor swatch (for example, #FFC300), and a textual description of what the reading means for people. Across the entries in a single forecast response the values typically evolve from day to day - in the example response globalIndex runs 42.2 -> 37 -> 40 across three consecutive days while the dominant pollutant stays Ozone.

DailyAirQualityForecastResult

The response returned by the Get Daily Air Quality Forecasts operation, containing one forecasted air-quality reading per day for the queried location across the requested forecast horizon. The horizon is set by the caller's requested forecast duration (a DailyDuration value of 1, 2, 3, 4, 5, 6, or 7 days), so results carries that many entries in chronological order - for example, a 3-day request returns daily readings for 2021-07-18, 2021-07-19, and 2021-07-20. Each entry summarizes the day's expected air quality on the same scales used by the current air-quality reading, so it pairs naturally with AirQualityResult for showing "today plus the next several days" views.

DailyDuration

Defines the duration for the air quality forecast, with options ranging from 1 to 7 days. The default duration is 1 day.

DominantPollutant

Identifies the pollutant with the highest concentration.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

JsonFormat

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