O endpoint history fornece informações históricas, por hora, sobre a qualidade do ar em um local específico, durante um determinado período, de até 30 dias no máximo. É possível controlar quais IQAs e
informações relevantes 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 enviando uma solicitação POST HTTP para:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Inclua suas opções no corpo da solicitação JSON. O corpo da solicitação contém o local e o período para o qual você quer ter o histórico por hora da qualidade do ar. Ela também pode incluir várias opções para controlar quais informações de qualidade do ar são incluídas na resposta.
Exemplo de uma solicitação de hora única
Corpo da solicitação de hora única
O código a seguir mostra como construir um corpo de solicitação para uma única solicitação de histórico de hora usando o 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 a seguinte resposta JSON. Para mais detalhes sobre os dados da 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 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 da qualidade do ar é retornada em duas páginas, cada uma contendo 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 passando 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 formato abaixo. Para mais detalhes sobre os dados de resposta, consulte Dados de resposta.
As duas ligações acima solicitam quatro horas de dados sobre a qualidade do ar. No entanto, como você definiu a propriedade pageSize como 2 na solicitação, a resposta incluirá apenas os resultados referentes às 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 de 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 para o 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'