Weather - Get Current Air Quality

Servicio:: Maps

Versión de la API:: 1.1

Úselo para obtener información actualizada sobre la calidad del aire que incluya los riesgos potenciales y las precauciones sugeridas.

La Get Current Air Quality API es una solicitud HTTP GET que devuelve información detallada sobre la concentración de contaminantes y el estado general de la calidad del aire actual, incluidos los niveles de contaminación, los valores del índice de calidad del aire, el contaminante dominante y una breve declaración que resume el nivel de riesgo y las precauciones sugeridas.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
api-version	query	True	string	Número de versión de Azure Maps API.
query	query	True	number[]	La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679". La información meteorológica generalmente está disponible para ubicaciones en tierra, cuerpos de agua rodeados de tierra y áreas del océano que se encuentran dentro de aproximadamente 50 millas náuticas de una costa.
language	query		string	Idioma en el que se deben devolver los resultados de la búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte idiomas admitidos para obtener más información.
pollutants	query		boolean	Valor booleano que devuelve información detallada sobre cada contaminante. De forma predeterminada es True.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps.

Respuestas

Nombre	Tipo	Description
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

AADToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para las APIs REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué Azure Maps recurso solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de de Maps.

El Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. * El control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, Azure SDKs o APIs REST. * El uso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, Azure SDKs o REST API.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque confidenciales para acceder a Azure Maps APIs REST y así almacenar tu clave de forma segura.

Tipo: apiKey
En: query

SAS Token

Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión Azure mediante portal Azure, PowerShell, CLI, Azure SDKs o APIs REST.

Con este token, cualquier aplicación está autorizada para acceder mediante Azure a controles de acceso basados en roles y a un control minucioso de la expiración, tasa y región(es) de uso para el token en particular. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get Current Air Quality

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "results": [
    {
      "dateTime": "2021-07-19T02:00:00+00:00",
      "index": 21.6,
      "globalIndex": 22.1,
      "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": 6.7,
          "globalIndex": 6.7,
          "concentration": {
            "value": 13.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 21.6,
          "globalIndex": 22.1,
          "concentration": {
            "value": 53.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.3,
          "globalIndex": 12.2,
          "concentration": {
            "value": 12.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 13.5,
          "globalIndex": 6.5,
          "concentration": {
            "value": 3.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.2,
          "globalIndex": 0.6,
          "concentration": {
            "value": 118.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.6,
          "globalIndex": 1.1,
          "concentration": {
            "value": 1.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
AirQuality	El objeto Calidad del Aire proporciona información completa sobre la calidad actual del aire en la ubicación especificada. Esto incluye los niveles de concentración de varios contaminantes, valores numéricos del Índice de Calidad del Aire (AQI) que indican la calidad general del aire y la identificación del contaminante dominante que afecta a la calidad del aire. Además, ofrece un resumen del nivel de riesgo, que describe brevemente los posibles riesgos para la salud y sugiere precauciones.
AirQualityResult	Una variedad de objetos de calidad del aire , cada uno proporcionando información completa sobre la calidad actual del aire en la ubicación especificada.
DominantPollutant	Identifica el contaminante con mayor concentración.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
Pollutant	Información detallada sobre un contaminante individual. No se devuelve si `pollutants`=false.
PollutantType	Especifica los seis tipos de contaminantes que realiza el servicio Azure Maps Weather.
UnitType	Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para una lista completa, véase Servicios meteorológicos en Azure Maps.
WeatherUnit	Valor específico de una unidad dada en relación con el clima.

AirQuality

Objeto

El objeto Calidad del Aire proporciona información completa sobre la calidad actual del aire en la ubicación especificada. Esto incluye los niveles de concentración de varios contaminantes, valores numéricos del Índice de Calidad del Aire (AQI) que indican la calidad general del aire y la identificación del contaminante dominante que afecta a la calidad del aire. Además, ofrece un resumen del nivel de riesgo, que describe brevemente los posibles riesgos para la salud y sugiere precauciones.

Nombre	Tipo	Description
category	string	Proporciona una descripción de una sola palabra de la calidad del aire para el periodo de previsión en el lenguaje especificado, como Pobre, Regular o Excelente.
categoryColor	string	Proporciona un código de color hexadecimal único correspondiente a la categoría de calidad del aire para cada día del periodo de previsión. Este color ayuda a los usuarios a identificar rápidamente el nivel de calidad del aire visualmente, siendo cada color correspondiente a una categoría como Pobre, Regular o Excelente.
dateTime	string (date-time)	Fecha y hora de la observación actual, mostradas en formato ISO 8601 (aaaaaa-mm-ddThh:mm:ss-hh:mm). Por ejemplo, 2025-04-29T07:00:00-07:00.
description	string	Una explicación textual de esta calidad del aire da como resultado el idioma solicitado.
dominantPollutant	DominantPollutant	Identifica el contaminante con mayor concentración.
globalIndex	number (float)	Representa un índice global normalizado de calidad del aire alineado con estándares científicos internacionales, incluyendo las directrices de la Organización Mundial de la Salud (OMS) y las definiciones de la EAQ de la EPA de EE. UU. El valor refleja la calidad general del aire basada en concentraciones de contaminantes medidas, donde el contaminante que presenta el mayor impacto potencial en la salud determina el valor final del índice. El valor devuelto utiliza un rango tipo IQA de 0 a 250+ y se corresponde a categorías definidas de calidad del aire. El contaminante dominante es el contaminante con el índice individual más alto. Por ejemplo, si los valores del índice de contaminantes son: COVs: 10 PM2.5: 25 PM10:30 NO₂: 50 El valor resultante del globalIndex es 50, y el contaminante dominante es NO₂. Las categorías de calidad del aire asociadas al valor del índice son: 0-20: Excelente 21-50: Justo 51-100: Pobre 101-150: Poco saludable 151-250: Muy poco saludable 251+: Peligroso
index	number (float)	El índice de calidad del aire (AQI) es una escala de valoración de la calidad del aire establecida por organismos reguladores locales. Las escalas pueden variar ampliamente según la ubicación. Para más información, véase Índice de calidad del aire en Wikipedia.
pollutants	Pollutant[]	Un array que contiene información detallada sobre cada contaminante en la respuesta. Devuelta cuando el `pollutants` parámetro URI es verdadero.

AirQualityResult

Objeto

Una variedad de objetos de calidad del aire , cada uno proporcionando información completa sobre la calidad actual del aire en la ubicación especificada.

Nombre	Tipo	Description
nextLink	string	Contiene la URL para obtener la siguiente página de resultados si la respuesta está paginada. Esto es útil cuando la respuesta es demasiado grande para ser devuelta en una sola llamada, permitiendo a los usuarios navegar por varias páginas de resultados.
results	AirQuality[]	Resultados detallados de la calidad del aire dentro de la ubicación especificada, incluyendo propiedades como el índice de calidad del aire (IQA), el contaminante dominante, los niveles de contaminantes, el nivel de riesgo y las precauciones sugeridas.

DominantPollutant

Enumeración

Identifica el contaminante con mayor concentración.

Valor	Description
Carbon Monoxide	El monóxido de carbono (CO) es un gas incoloro, inodoro e insípido pero altamente tóxico producido por la combustión incompleta de combustibles que contienen carbono. Las fuentes comunes incluyen gases de escape de vehículos, estufas de gas, hornos y fuegos de leña.
Nitrogen Dioxide	El dióxido de nitrógeno (NO2) es un contaminante atmosférico importante. Está regulado y sujeto a las pautas de límite recomendadas establecidas por la Organización Mundial de la Salud (OMS).
Ozone	El ozono (O3) es un componente clave del smog fotoquímico, la neblina marrón y dañina que envuelve muchas grandes ciudades, como resultado de una reacción fotoquímica entre la luz solar y ciertos contaminantes específicos.
Particulate Matter 2.5	El material particulado 2.5 (PM2.5) se refiere a partículas finas con diámetros que generalmente son de 2.5 micrómetros o menos. Estas partículas son más de 100 veces más delgadas que un cabello humano y pueden permanecer suspendidas en el aire durante períodos prolongados
Particulate Matter 10	El material particulado 10 (PM10) se refiere a partículas con diámetros que generalmente son de 10 micrómetros o menos. Estas partículas pueden incluir polvo, polen, hollín, humo y gotas de líquido.
Sulfur Dioxide	El dióxido de azufre (SO2) es un gas inorgánico pesado e incoloro con un olor acre e irritante. Se produce principalmente mediante la quema de combustibles fósiles en centrales eléctricas e instalaciones industriales, pero también puede ser emitido por fuentes naturales como los volcanes.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Enumeración

Formato deseado de la respuesta. Solo se admite json formato.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript

Pollutant

Objeto

Información detallada sobre un contaminante individual. No se devuelve si pollutants=false.

Nombre	Tipo	Description
concentration	WeatherUnit	Objeto que contiene el número de partículas contaminantes por volumen de aire.
globalIndex	number (float)	Representa un índice global normalizado de calidad del aire alineado con estándares científicos internacionales, incluyendo las directrices de la Organización Mundial de la Salud (OMS) y las definiciones de la EAQ de la EPA de EE. UU. El valor refleja la calidad general del aire basada en concentraciones de contaminantes medidas, donde el contaminante que presenta el mayor impacto potencial en la salud determina el valor final del índice. El valor devuelto utiliza un rango tipo IQA de 0 a 250+ y se corresponde a categorías definidas de calidad del aire. El contaminante dominante es el contaminante con el índice individual más alto. Por ejemplo, si los valores del índice de contaminantes son: COVs: 10 PM2.5: 25 PM10:30 NO₂: 50 El valor resultante del globalIndex es 50, y el contaminante dominante es NO₂. Las categorías de calidad del aire asociadas al valor del índice son: 0-20: Excelente 21-50: Justo 51-100: Pobre 101-150: Poco saludable 151-250: Muy poco saludable 251+: Peligroso
index	number (float)	Calificación de la calidad del aire en una escala establecida por los organismos reguladores locales. Las escalas pueden variar ampliamente según la ubicación. Véase Wikipedia para más información.
name	string	El nombre del contaminante en inglés.
type	PollutantType	Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

PollutantType

Enumeración

Especifica los seis tipos de contaminantes que realiza el servicio Azure Maps Weather.

Valor	Description
CO	Monóxido de carbono
NO2	Dióxido de nitrógeno
O3	Ozono
PM2.5	Partículas 2.5
PM10	Partículas 10
SO2	Dióxido de azufre

UnitType

Enumeración

Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para una lista completa, véase Servicios meteorológicos en Azure Maps.

Valor	Description
0	feet
1	inches
2	miles
3	millimeter
4	centimeter
5	meter
6	kilometer
7	kilometersPerHour
8	knots
9	milesPerHour
10	metersPerSecond
11	hectoPascals
12	inchesOfMercury
13	kiloPascals
14	millibars
15	millimetersOfMercury
16	poundsPerSquareInch
17	Grados centígrados
18	Fahrenheit
19	kelvin
20	percent
21	flotante
22	entero
31	MicrogramsPerCubicMeterOfAir

WeatherUnit

Objeto

Valor específico de una unidad dada en relación con el clima.

Nombre	Tipo	Description
unit	string	Tipo de unidad para el valor devuelto.
unitType	UnitType (int32)	Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para una lista completa, véase Servicios meteorológicos en Azure Maps.
value	number (float)	Valor redondeado.

Compartir a través de

Weather - Get Current Air Quality

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Get Current Air Quality

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AirQuality

AirQualityResult

DominantPollutant

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

Pollutant

PollutantType

UnitType

WeatherUnit