history
端点可提供特定地点在给定时间范围(最长 30 天)内的每小时历史空气质量信息。您可以控制系统返回哪些 AQI 和相关信息(例如污染物浓度水平和健康建议)。
您可以使用 history
端点请求每小时空气质量历史记录,方法是将 HTTP POST 请求发送到:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
在 JSON 请求正文中添加请求选项。请求正文包含您要获取小时空气质量历史记录的位置和时间范围。它还可能包括各种选项,用于控制要在响应中包含的空气质量信息。
借助 API Explorer,您可以发出实时请求,以便熟悉 API 和 API 选项:
单小时请求示例
单小时请求正文
以下代码展示了如何使用 history
方法为单小时历史记录请求构建请求正文。在此示例中,您需要设置位置和过去的时间戳。
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'
一小时内响应
上述调用会生成以下 JSON 响应。如需详细了解响应数据,请参阅响应数据。
{ "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" }
时间范围请求示例
时间范围请求
以下代码展示了如何为 history
构建请求正文,该请求会返回多个历史小时空气质量记录。
您可以通过指定时间范围(即开始时间戳和结束时间戳)或指定距离当前时间的小时数来请求多个记录。
在以下示例中,由于您将页面大小设置为 2
,因此系统会将您请求的四小时空气质量历史记录分为两页返回,每页包含两个小时的数据。
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'
您可以通过传递开始和结束时间戳来发出类似的请求:
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'
时间范围响应
上述调用会生成以下形式的 JSON 响应。如需详细了解响应数据,请参阅响应数据。
上述两个调用都请求四小时的空气质量数据。不过,由于您在请求中将 pageSize
属性设置为 2
,因此响应中仅包含最近两个小时的结果。
{ "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" }
请注意,该响应还包含 nextPageToken
属性。使用此属性可访问下一页结果,其中包含接下来两小时的数据。
如需访问下一页结果,请向 history
端点发出第二个请求,但这次将 pageToken
属性设置为第一个响应中 nextPageToken
的值。
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'