O endpoint forecast
fornece até 96 horas (4 dias) de informações de previsão de qualidade do ar
por hora para um determinado local. Cada previsão inclui índices de qualidade do ar por hora, além de outras informações:
- Hora e data específicas ou período para previsão
- Código do idioma dos campos traduzidos
- Índice de qualidade do ar (IQA) local ou personalizado
- Recomendações de saúde
- Poluentes dominantes
- Concentração de poluentes
- Mais informações sobre poluentes
- Tamanho da página de resposta
- Paleta de cores
O APIs Explorer permite fazer solicitações em tempo real para que você se familiarize com a API e as opções dela:
Sobre as solicitações de estimativa
Para solicitar informações de previsão de qualidade do ar por hora usando o endpoint de previsão, envie uma solicitação POST HTTP para:
https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY
Inclua os parâmetros no corpo da solicitação. O corpo da solicitação contém o local para o qual você quer receber informações de previsão de qualidade do ar por hora e várias opções para controlar quais informações adicionais incluir na resposta.
Sobre as respostas de previsão
O corpo da resposta fornece a data e a hora UTC para exibir informações de previsão da qualidade do ar, índices de qualidade do ar e outras informações personalizadas. O corpo da resposta também inclui um token para recuperar a próxima página se as informações não couberem no tamanho de página solicitado.
Exemplo de solicitação básica
O código a seguir mostra como criar uma solicitação de previsão. Neste exemplo, você especifica o local, a data e a hora (começando na próxima hora até 96 horas) para mostrar as informações de previsão da qualidade do ar por hora.
curl -X POST -d '{
"location": {
"latitude": 37.4125333,
"longitude": -122.0840937
},
"dateTime": "2024-02-09T08:00:00Z"
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
A chamada gera a seguinte resposta JSON.
{ "hourlyForecasts": [ { "dateTime": "2024-02-09T08:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 80, "aqiDisplay": "80", "color": { "red": 0.34509805, "green": 0.74509805, "blue": 0.20784314 }, "category": "Excellent air quality", "dominantPollutant": "pm25" } ] } ], "regionCode": "us" }
Exemplo de solicitação com vários parâmetros
O código a seguir mostra como criar um corpo de solicitação com vários parâmetros. Neste exemplo, especifique o seguinte:
- Local
- Período para mostrar informações de previsão da qualidade do ar
- Código do idioma
- Cálculos extras (como recomendações de saúde, a concentração do poluente dominante e outras informações sobre poluentes)
- Paleta de cores
curl -X POST -d '{
"pageSize": "10",
"universalAqi": "true",
"location": {
"latitude": "40.741895",
"longitude": "-73.989308"
},
"period": {
"startTime": "2024-02-27T13:58:14+02:00",
"endTime": "2024-02-28T16:58:14+02:00"
},
"languageCode": "en",
"extraComputations": [
"HEALTH_RECOMMENDATIONS",
"DOMINANT_POLLUTANT_CONCENTRATION",
"POLLUTANT_ADDITIONAL_INFO"
],
"uaqiColorPalette": "RED_GREEN"
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
A chamada gera a seguinte resposta JSON.
{ { "hourlyForecasts": [ { "dateTime": "2024-02-27T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 75, "aqiDisplay": "75", "color": { "red": 0.43137255, "green": 0.7764706, "blue": 0.20392157 }, "category": "Good air quality", "dominantPollutant": "pm25" } ], "pollutants": [ { "code": "pm25", "displayName": "PM2.5", "fullName": "Fine particulate matter (\u003c2.5µm)", "concentration": { "value": 15.1, "units": "MICROGRAMS_PER_CUBIC_METER" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "..." } }, { "dateTime": "2024-02-27T12:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 67, "aqiDisplay": "67", "color": { "red": 0.5882353, "green": 0.8392157, "blue": 0.16862746 }, "category": "Good air quality", "dominantPollutant": "pm25" } ], "pollutants": [ { "code": "pm25", "displayName": "PM2.5", "fullName": "Fine particulate matter (\u003c2.5µm)", "concentration": { "value": 19.96, "units": "MICROGRAMS_PER_CUBIC_METER" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, /.../ ] } "regionCode": "us", "nextPageToken": "CjMKEglwCFVq9l5EQBH0aoDSUH9SwBoQCgYI1pDirgYSBgiGiOiuBiABKgMCBAMyAmVuOAEQGA==" }
Para ver a próxima página de informações de previsão, transmita o nextPageToken
retornado no final do corpo da resposta:
curl -X POST -d '{
"universalAqi": "true",
"location": {
"latitude": "40.741895",
"longitude": "-73.989308"
},
"period": {
"startTime": "2024-02-27T13:58:14+02:00",
"endTime": "2024-02-28T16:58:14+02:00"
},
"languageCode": "en",
"extraComputations": [
"HEALTH_RECOMMENDATIONS",
"DOMINANT_POLLUTANT_CONCENTRATION",
"POLLUTANT_ADDITIONAL_INFO"
],
"uaqiColorPalette": "RED_GREEN",
"pageToken": "CjMKEglwCFVq9l5EQBH0aoDSUH9SwBoQCgYI1pDirgYSBgiGiOiuBiABKgMCBAMyAmVuOAEQGA=="
}' \
-H "Content-Type: application/json" \
-H "Accept-Language: *" \
"https://airquality.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY"
Isso retorna a próxima página de informações de previsão:
{ "hourlyForecasts": [ { "dateTime": "2024-02-27T21:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 74, "aqiDisplay": "74", "color": { "red": 0.44705883, "green": 0.78431374, "blue": 0.2 }, "category": "Good air quality", "dominantPollutant": "o3" } ], "pollutants": [ { "code": "o3", "displayName": "O3", "fullName": "Ozone", "concentration": { "value": 32.07, "units": "PARTS_PER_BILLION" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "elderly": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, { "dateTime": "2024-02-27T22:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 75, "aqiDisplay": "75", "color": { "red": 0.43137255, "green": 0.7764706, "blue": 0.20392157 }, "category": "Good air quality", "dominantPollutant": "o3" } ], "pollutants": [ { "code": "o3", "displayName": "O3", "fullName": "Ozone", "concentration": { "value": 30.94, "units": "PARTS_PER_BILLION" }, "additionalInfo": { "sources": "...", "effects": "..." } } ], "healthRecommendations": { "generalPopulation": "...", "lungDiseasePopulation": "...", "heartDiseasePopulation": "...", "athletes": "...", "pregnantWomen": "...", "children": "..." } }, /.../ ] "regionCode": "us" }
Confira!
Com o APIs Explorer, é possível fazer solicitações de amostra para se familiarizar com a API e as opções dela.
Selecione o ícone da API api no lado direito da página.
Se quiser, edite os parâmetros da solicitação.
Selecione o botão Executar. Na caixa de diálogo, escolha a conta que você quer usar para fazer a solicitação.
No painel do APIs Explorer, selecione o ícone de tela cheia fullscreen para expandir a janela do APIs Explorer.