Difference between revisions of "空气污染实况城市排名接口"

From CaiyunWiki
Jump to: navigation, search
(Created page with " =='''授权与认证'''== 请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册],注册后可以获得 token 。开发者token需要额外开通...")
 
(授权与认证)
Line 9: Line 9:
  
 
=='''请求样例'''==
 
=='''请求样例'''==
<blockquote>[http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN http://api.caiyunapp.com/v1/aqi/latest?token=TAkhjf8d1nlSlspN]</blockquote>
+
<blockquote>http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25<nowiki/>&type=desc&number=10</blockquote>'''参数:'''
 +
 
 +
'''field 排名所用的变量:'''【'pm25', 'pm10', 'o3', 'no2', 'so2', 'co', 'aqi'】,默认pm25
 +
 
 +
'''type 排名所用的变量:'''【'asc', 'desc'】,默认asc(空气质量好的城市排名靠前)
 +
 
 +
'''number 排名返回的城市数量:'''<=200,默认100
  
 
=='''返回结构和说明'''==
 
=='''返回结构和说明'''==
Line 15: Line 21:
  
 
status:     ok
 
status:     ok
category:    aqi_latest_obs_city
+
category:    aqi_latest_obs_city_ranking
 
result: {
 
result: {
            0000A02880:                                                   ## 彩云全球雾霾站点编号(10位字符串)
+
        0:{
                      { area:         "成都市",                          ## 站点所在城市、城区、县级名称(中文或者英文)
+
              station_code: "0000A01496",
                          station_code: "2880A",                           ## 所在国家雾霾站点编号
+
              area: "乌鲁木齐市",
                          position_name:"大石西路",                        ## 站点地址(中文或者英文)
+
              time_point: "2019-01-15T12:00:00Z+08:00",
                          lon:         "104.0238889",
+
              lon: "87.6444",
                          lat:         "30.65638889",                      ## 经纬度
+
              lat: "43.962",
                          time_point: "2019-01-14T17:00:00Z+08:00",       ## 观测时间和时区信息
 
  
                          quality:      "轻度污染",                        ## 空气污染等级,自然语言描述(中文)
+
              primary_pollutant: "细颗粒物(PM2.5)",
                          primary_pollutant: "细颗粒物(PM2.5)",             ## 主要污染物(中文)
+
              quality: "严重污染",
  
                          pm25:         "91",                               ## 细颗粒污染[μg/m3],缺测为“null”
+
              pm25: "355",
                          pm10:         "134",                             ## 粗颗粒污染[μg/m3],缺测为“null”
+
              pm10: "389",
                          o3:         "null",                             ## 臭氧[μg/m3],缺测为“null”
+
              o3: "20",
                          no2:         "49"                               ## 二氧化氮[μg/m3],缺测为“null”
+
              no2: "88",
                          so2:         "8",                               ## 二氧化硫[μg/m3],缺测为“null”
+
              so2: "20",
                          co:         "1.1",                             ## 一氧化碳[mg/m3],缺测为“null”
+
              co: "4.8",
                          aqi:         "120"                               ## AQI(中国自然资源部,国标)
+
              aqi: "404"
                      },
+
            },
            0000A02317:{...},
+
        1: {...},
            ...
+
}
        }
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:API 产品]]
 
[[Category:API 产品]]

Revision as of 05:31, 15 January 2019

授权与认证

请先至彩云开放平台注册,注册后可以获得 token 。开发者token需要额外开通权限,请联系商务:api@caiyunapp.com

把您的 token 拼到 API 请求的 URL 中,如: http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN

其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人!

请求样例

http://api.caiyunapp.com/v1/aqi/ranking?token=TAkhjf8d1nlSlspN&field=pm25&type=desc&number=10
参数:

field 排名所用的变量:【'pm25', 'pm10', 'o3', 'no2', 'so2', 'co', 'aqi'】,默认pm25

type 排名所用的变量:【'asc', 'desc'】,默认asc(空气质量好的城市排名靠前)

number 排名返回的城市数量:<=200,默认100

返回结构和说明

status:	     ok
category:    aqi_latest_obs_city_ranking
result:	{
         0:{
               station_code:	"0000A01496",
               area:		"乌鲁木齐市",
               time_point:	"2019-01-15T12:00:00Z+08:00",
               lon:		"87.6444",
               lat:		"43.962",

               primary_pollutant:	"细颗粒物(PM2.5)",
               quality:			"严重污染",

               pm25:		"355",
               pm10:		"389",
               o3:		"20",
               no2:		"88",
               so2:		"20",
               co:		"4.8",
               aqi:		"404"
            },
         1: {...},
}