Histórico

O endpoint history fornece informações históricas de qualidade do ar por hora para um local específico, em um determinado período de tempo, por até 30 dias. É possível controlar quais AQIs e informações relevantes são retornadas, como o nível de concentração de poluentes e as recomendações de saúde.

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

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

Inclua as opções de solicitação no corpo da solicitação JSON. O corpo da solicitação contém o local e o período em que você quer receber o histórico de qualidade do ar por hora. 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 fazer solicitações em tempo real para que você se familiarize com a API e as opções dela:

Faça um teste

Exemplo de solicitação de uma hora

Corpo da solicitação de uma hora

O código a seguir mostra como criar um corpo de solicitação para uma solicitação de histórico de uma hora usando o método history. Neste exemplo, você define o local e o carimbo de data/hora 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'

Resposta em uma hora

A chamada acima gera a 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 período

Solicitação de intervalo de tempo

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

É possível solicitar vários registros especificando um intervalo de tempo, ou seja, um carimbo de data/hora de início e de término, ou especificando o número de horas de volta a partir do horário atual.

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, em que 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'

Você pode 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 intervalo de tempo

As chamadas acima geram uma resposta JSON no formulário abaixo. Para mais detalhes sobre os dados de resposta, consulte Dados de resposta.

As duas chamadas acima solicitam dados de qualidade do ar de quatro horas. No entanto, como você definiu a propriedade pageSize como 2 na solicitação, a resposta só inclui os resultados das duas horas mais recentes.

{
    "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 para o endpoint history, mas dessa 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'