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, até um máximo de 30 dias. É possível controlar quais AQIs e informações pertinentes são retornadas (como o 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 endpoint history. Para isso, envie 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 para os quais 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 serão incluídas 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:

Exemplo de solicitação de uma única hora

Corpo da solicitação de uma hora

O código a seguir mostra como criar um corpo de solicitação para um histórico de uma única 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 período

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

É possível solicitar vários registros especificando um período, ou seja, um carimbo de data/hora de início e término, ou especificando o número de horas anteriores ao 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'

É 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 sobre o período

As chamadas acima geram uma resposta JSON no formato 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 inclui apenas 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"
}

Observe que a resposta também inclui a propriedade nextPageToken. Use essa propriedade para acessar a próxima página dos resultados, que contém as próximas duas horas 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'

Confira!

Com o APIs Explorer, é possível fazer solicitações de amostra para se familiarizar com a API e as opções dela.

  1. Selecione o ícone da API api no lado direito da página.

  2. Se quiser, edite os parâmetros da solicitação.

  3. Selecione o botão Executar. Na caixa de diálogo, escolha a conta que você quer usar para fazer a solicitação.

  4. No painel do APIs Explorer, selecione o ícone de tela cheia fullscreen para expandir a janela do APIs Explorer.