登录 注册 关于

API文档

总体来说,本站API返回JSON格式的数据,URL即为浏览器网页URL前面加上/api/,如54511站的天气实况网页地址为https://q-weather.info/weather/54511/realtime/,对应API地址为https://q-weather.info/api/weather/54511/realtime/。除此以外有以下两个可选GET参数:

参数含义
key提供您登录之后在个人页面展示的API Key。如果不提供或者为错误值,将按游客计算。注意,登录cookie不是登录状态判断依据,这与浏览器网页不同。
jsonp如果提供这个参数,将会返回一个JSONP而不是JSON,以所给的参数为回调函数。

基本数据单位

一个基本数据单位是一个字典,包括主要部分、修饰部分和时间戳部分。
主要部分是各个气象/空气质量要素的值,关键字为要素的缩写,详细说明见以下各节。
修饰部分包括一个以acc为关键字的字典,表示各个要素的精确度,字典的关键字同主要部分。如果一个要素的值是v,精确度是d,那么这个要素实际的值可能在v±d/2之间。
时间戳部分以time为关键字,具体的值与API的类型有关,所有时间戳都是世界时。

频率调用限制

有频率限制的API包括实时从数据源获取数据的API和从数据库读取历史数据的API。这两种类型的API基本频率配额如下。游客单个IP的配额是下述配额的一半,而所有游客的总配额是下述配额的五倍。注意本节内容可能会随时调整。

类型单秒限制单分钟限制单小时限制单日限制
实时获取24次每秒4次共240次每秒0.6次共2160次每5秒1次共17280次
数据库读取240次每秒40次共2400次每秒6次共21600次每秒2次共172800次

气象查询API

各要素的缩写包括两部分:全大写字母的前缀和数字加小写字母的可选修饰后缀。前缀表示这个要素的类型,可选后缀表示这个要素的测量时间长度。具体列举如下。

缩写含义
T温度
RH相对湿度
DT24h24小时变温
P本站气压
WD?m?分钟平均风向(?=0表示瞬时)
WS?m?分钟平均风速
R1h1小时降水
V报告能见度(中国气象站中该量通过某种自动计算得出)
V?m?分钟平均能见度
SD积雪深度

API列表如下。

API名称URL(省略开头域名)返回数据格式频率限制类型
站点信息/api/weather/<station>/字典,包括:名称(name)、所属市(city)、代码(wmo)、纬度(lat)、经度(lon)、海拔高度(alt)等。
当前实况/api/weather/<station>/realtime/字典,除传入的站点外,realtime关键字的值为返回的一个基本数据单位。时间戳是一个字典,表示各个要素的更新时间(不一定相同)。实时获取
过去24小时实况/api/weather/<station>/today/字典,除传入的站点外,today关键字的值为返回的基本数据单位组成的列表,按时间降序排列。每个单位的时间戳是一个字符串,表示这条数据的更新时间。实时获取
历史单日实况/api/weather/<station>/history/?date=<YYYY-mm-dd>字典,除传入的站点和日期外,res关键字的值为基本数据单位组成的列表,按时间升序排列。每个单位的时间戳是一个字符串,表示这条数据的更新时间。对于中国的站点为数据库读取,对于美国的站点为实时获取

空气质量查询API

各要素列表如下。

缩写含义
PM2_5PM2.5
PM10PM10
SO2SO2
NO2NO2
COCO
O3O3

API列表如下。

API名称URL(省略开头域名)返回数据格式频率限制类型
站点信息/api/airquality/<station>/字典,包括:名称(name)、所属市(city)、代码(code)、纬度(lat)、经度(lon)等。
当前实况/api/airquality/<station>/realtime/字典,除传入的站点外,realtime关键字的值为返回的一个基本数据单位。时间戳是一个字典,表示各个要素的更新时间(不一定相同)。数据库读取
城市所有站点实况/api/airquality/<city_name>/realtime/字典,除传入的城市名外,res关键字的值为返回的基本数据单位组成的列表,每个基本单位附加name、code两个域表示站点的名称和代码,每个单位的时间戳是一个字符串,表示这条数据的更新时间。数据库读取
历史单日实况/api/airquality/<station>/history/?date=<YYYY-mm-dd>字典,除传入的站点和日期外,res关键字的值为基本数据单位组成的列表,按时间升序排列。每个单位的时间戳是一个字符串,表示这条数据的更新时间。数据库读取

其他API

API名称URL(省略开头域名)返回数据格式频率限制类型
城市站点列表/api/city/?q=<city_name>字典,包括:名称(name)、所属省(prov)、气象站点信息组成的列表(weather_stations)、空气质量站点信息组成的列表(airquality_stations)。