Historial

El extremo history proporciona información histórica de la calidad del aire por hora de una ubicación específica para un intervalo de tiempo determinado, hasta un máximo de 30 días. Puedes controlar qué ICA y qué información pertinente se muestran (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 enviando una solicitud HTTP POST a la siguiente dirección:

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

Incluye las opciones de solicitud en el cuerpo de la solicitud JSON. El cuerpo de la solicitud contiene la ubicación y el intervalo de tiempo durante el cual quieres obtener el historial de calidad del aire por hora. También puede incluir varias opciones para controlar qué información de calidad del aire se debe incluir en la respuesta.

Ejemplo de una solicitud de una sola hora

Cuerpo de la solicitud de una hora

En el siguiente código, se muestra cómo crear un cuerpo de solicitud para una solicitud de historial de una sola hora con el método history. En este ejemplo, se establece la ubicación y la marca de tiempo del pasado.

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 de 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 de tiempo

Solicitud de intervalo de tiempo

En el siguiente código, se muestra cómo construir un cuerpo de solicitud para una history que devuelve varios registros de la calidad del aire por hora histórica.

Para solicitar varios registros, especifica un intervalo de tiempo, es decir, una marca de tiempo de inicio y finalización, o especifica una cantidad de horas desde la hora actual.

En el siguiente ejemplo, como configuras el tamaño de la página en 2, tu solicitud de cuatro horas del historial de calidad del aire se muestra 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'

Para hacer una solicitud similar, pasa 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 de intervalo de tiempo

Las llamadas anteriores generan una respuesta JSON en el siguiente formulario. Para obtener más detalles sobre los datos de respuesta, consulta Datos de respuesta.

Las dos llamadas anteriores solicitan datos de la calidad del aire de cuatro horas. Sin embargo, debido a que configuras la propiedad pageSize como 2 en la solicitud, la respuesta solo incluye los resultados de las dos horas más recientes.

{
    "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 las siguientes dos horas de datos.

Para acceder a la página siguiente de resultados, realiza 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'