El extremo history proporciona información histórica por hora sobre la calidad del aire de una ubicación específica, para un período determinado, hasta un máximo de 30 días. Puedes controlar qué IAQ y qué información pertinente se devuelven (como el nivel de concentración de contaminantes y las recomendaciones de salud).
Puedes solicitar el historial de la calidad del aire por hora con el extremo history. Para ello, envía una solicitud HTTP POST a la siguiente URL:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Incluye las opciones de la solicitud en el cuerpo de la solicitud en formato JSON. El cuerpo de la solicitud contiene la ubicación y el período para los que deseas obtener el historial de calidad del aire por hora. También puede incluir varias opciones para controlar qué información sobre la calidad del aire se incluye en la respuesta.
El Explorador de APIs te permite realizar solicitudes en vivo para que puedas familiarizarte con la API y sus opciones:
Ejemplo de una solicitud de una sola hora
Cuerpo de la solicitud de una sola hora
En el siguiente código, se muestra cómo construir un cuerpo de solicitud para una solicitud de historial de una sola hora con el método history.
En este ejemplo, se configuran la ubicación y la marca de tiempo anterior.
curl -X POST -d '{
"dateTime": "2023-06-26T15:01:23Z",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Respuesta en una hora
La llamada anterior genera la siguiente respuesta JSON. Para obtener más detalles sobre los datos de respuesta, consulta Datos de respuesta.
{ "hoursInfo": [ { "dateTime": "2023-06-26T15:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 73, "aqiDisplay": "73", "color": { "red": 118, "green": 202, "blue": 51, "alpha": 255 }, "category": "Good air quality", "dominantPollutant": "pm10" } ] } ], "regionCode": "us" }
Ejemplo de solicitud de intervalo
Solicitud de período
En el siguiente código, se muestra cómo construir un cuerpo de solicitud para un history que devuelve varios registros del historial de la calidad del aire por hora.
Puedes solicitar varios registros especificando un intervalo de tiempo, es decir, una marca de tiempo de inicio y de finalización, o bien especificando la cantidad de horas anteriores a la hora actual.
En el siguiente ejemplo, como estableciste el tamaño de la página en 2, tu solicitud de cuatro horas de historial de calidad del aire se devuelve en dos páginas, en las que cada una contiene dos horas de datos.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Puedes realizar una solicitud similar pasando las marcas de tiempo de inicio y finalización:
curl -X POST -d '{
"period": {
"startTime":"2023-06-15T08:00:00Z",
"endTime":"2023-06-15T12:00:00Z"
},
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Respuesta del intervalo de tiempo
Las llamadas anteriores generan una respuesta JSON con el siguiente formato. Para obtener más detalles sobre los datos de respuesta, consulta Datos de respuesta.
Ambas llamadas anteriores solicitan datos de calidad del aire de cuatro horas. Sin embargo, como estableciste la propiedad pageSize en 2 en la solicitud, la respuesta solo incluye resultados de las últimas dos horas.
{ "hoursInfo": [ { "dateTime": "2023-06-15T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 83, "aqiDisplay": "83", "color": { "red": 74, "green": 185, "blue": 54, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] }, { "dateTime": "2023-06-15T10:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 89, "aqiDisplay": "89", "color": { "red": 48, "green": 175, "blue": 55, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] } ], "regionCode": "us", "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA" }
Ten en cuenta que la respuesta también incluye la propiedad nextPageToken. Usa esta propiedad para acceder a la siguiente página de resultados, que contiene los datos de las próximas dos horas.
Para acceder a la siguiente página de resultados, haz una segunda solicitud al extremo history, pero, esta vez, establece la propiedad pageToken en el valor de nextPageToken de la primera respuesta.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Pruébalo
El Explorador de APIs te permite realizar solicitudes de ejemplo para que te familiarices con la API y sus opciones.
Selecciona el ícono de la API api en el lado derecho de la página.
De manera opcional, edita los parámetros de la solicitud.
Selecciona el botón Ejecutar. En el diálogo, elige la cuenta que deseas usar para hacer la solicitud.
En el panel del Explorador de APIs, selecciona el ícono de pantalla completa fullscreen para expandir la ventana del Explorador de APIs.