Histórico

O endpoint history fornece informações históricas por hora sobre a qualidade do ar de um local específico para um determinado máximo de 30 dias. É possível controlar quais IQAs e informações pertinentes são retornadas (como nível de concentração de poluentes e recomendações de saúde).

É possível solicitar o histórico da qualidade do ar por hora usando o history endpoint enviando uma solicitação POST HTTP para:

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

Incluir suas opções de solicitação no JSON corpo da solicitação. O corpo da solicitação contém o local e o período para os quais você gostaria de obter a histórico horário da qualidade do ar. Ele também pode incluir várias opções para controlar quais informações de qualidade do ar incluir na resposta.

O APIs Explorer permite que você faça solicitações ativas para se familiarizar com API e as opções de API:

Faça um teste

Exemplo de uma solicitação de uma única hora

Corpo da solicitação de uma única hora

O código a seguir mostra como criar um corpo de solicitação para uma única hora. solicitação de histórico usando método history. Neste exemplo, você define o local e o carimbo de data/hora no passado.

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'

Resposta de uma hora

A chamada acima gera o seguinte Resposta JSON. Para mais detalhes sobre os dados de resposta, consulte Dados de resposta.

{
    "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"
}

Exemplo de solicitação de intervalo de tempo

Solicitação de período

O código a seguir mostra como construir um corpo de solicitação para uma history, que retorna vários registros históricos da qualidade do ar por hora.

Você pode solicitar vários registros especificando um intervalo de tempo, ou seja, um início e data e hora de término ou especificando o número de horas de volta a partir da tempo de resposta.

No exemplo abaixo, como você definiu o tamanho da página como 2, sua solicitação de quatro horas de histórico de qualidade do ar é retornada em duas páginas, onde cada página contém duas horas de dados.

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'

É possível fazer uma solicitação semelhante transmitindo os carimbos de data/hora de início e término:

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'

Resposta do período

As chamadas acima geram uma resposta JSON no formato a seguir. Para mais detalhes sobre os dados de resposta, consulte Dados de resposta.

As duas chamadas acima solicitam dados de qualidade do ar para quatro horas. No entanto, como você definiu propriedade pageSize para 2 na solicitação, a resposta incluirá apenas resultados para as últimas duas 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"
}

A resposta também inclui a propriedade nextPageToken. Use essa propriedade para acessar a próxima página dos resultados, que contém os próximos dois horários de dados.

Para acessar a próxima página de resultados, faça uma segunda solicitação ao endpoint history, mas, desta vez, defina a propriedade pageToken como o valor de nextPageToken da primeira resposta.

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'