Difference between revisions of "通用预报接口/v2.5"

From Caiyun Wiki
Jump to: navigation, search
(Created page with "{{彩云天气 API 版本状态}} =='''授权与认证'''== 请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册]，注册后可以获得 token...")
 
(→‎预警信息)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{导览}}
 +
 
{{彩云天气 API 版本状态}}
 
{{彩云天气 API 版本状态}}
  
−
=='''授权与认证'''==
+
== 授权与认证 ==
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册]，注册后可以获得 token 。
 
请先至彩云开放平台[https://dashboard.caiyunapp.com/user/sign_up/ 注册]，注册后可以获得 token 。
  
 
把您的 token 拼到 API 请求的 URL 中，如
 
把您的 token 拼到 API 请求的 URL 中，如
  
−
<code>
+
<code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</code>
−
<nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</nowiki>
 
−
</code>
 
  
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人！
 
其中 TAkhjf8d1nlSlspN 就是一个共用测试 token 。不要把私有token 告诉任何人！
  
−
=='''请求样例'''==
+
== API 请求 ==
 +
 
 +
=== 示例 ===
 +
 
 +
这里是测试 token ，即 <code>TAkhjf8d1nlSlspN</code>
 +
 
 +
* <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</code>
 +
* <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.jsonp?callback=MYCALLBACK</code>
 +
 
 +
=== 请求参数 ===
 +
 
 +
* 经纬度：必须，无缺省值，经度在前，纬度在后，中间用半角逗号隔开，如 <code>118.266637,26.150279</code>
 +
* 返回格式：必须，无缺省值，可选项目包括json 或者 jsonp，jsonp 需提供回调函数名
 +
* 语言选项 lang: 可选，缺省值是 <code>zh_CN</code>，可选项目包括简体中文（zh_CN，默认）、繁体中文（zh_TW）、美式英语（en_US）、英式英语（en_GB）、日语（ja）
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/-74.0060,40.7128/weather.json?lang=en_US</code>
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/139.7690,35.6804/weather.json?lang=ja</code>
 +
* 单位制选项 unit: 可选，缺省值是 <code>metric</code>，可选项目包括公制<code>metric</code>，英制<code>imperial</code>，和科学单位制 <code>SI</code>
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial</code>
 +
* 小时步长选项 hourlysteps: 可选，缺省值是 <code>48</code>，选择范围 <code> 1 ~ 360 </code>
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?hourlysteps=12</code>
 +
* 天步长选项 dailysteps: 可选，缺省值是 <code>5</code>，选择范围 <code> 1 ~ 15 </code>
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?dailysteps=3</code>
 +
* 预警信息 alert：可选，缺省值是 <code>false</code>，选择范围 <code> true </code> 或者 <code> false </code>
 +
** <code>https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/118.266637,26.150279/weather.json?alert=true</code>
 +
 
 +
== API 返回值 ==
 +
 
 +
=== 返回结构说明 ===
 +
 
 +
通用预报接口可以认为是如下几个不同时间颗粒度接口的合并
 +
 
 +
* [[实况天气接口/v2.5|实况天气接口]]
 +
* [[分钟级降雨预报接口/v2.5|分钟级降雨预报接口]]
 +
* [[小时级预报接口/v2.5|小时级预报接口]]
 +
* [[天级预报接口/v2.5|天级预报接口]]
 +
 
 +
所以，返回结构的细节可以在上述几个接口的文档中查看。
 +
 
 +
<syntaxhighlight lang="yaml">
 +
 
 +
status: ok
 +
api_version: v2.5
 +
api_status: active
 +
lang: zh_CN
 +
unit: metric
 +
tzshift: 28800
 +
timezone: Asia/Shanghai
 +
server_time: 1585894300
 +
location:
 +
location:
 +
  - 26.150279
 +
  - 118.266637
 +
result:
 +
  alert:
 +
    status: ok
 +
    content:
 +
      request_status: "ok",
 +
      alertId: "35040041600001_20200421123203",
 +
      latlon: [26.263406,117.638678]
 +
      pubtimestamp: 1587443583
 +
      status: "预警中"
 +
      regionId: "unknown"
 +
      adcode: "350400"
 +
      location: "福建省三明市"
 +
      province: "福建省"
 +
      city: "三明市"
 +
      county: "无"
 +
      code: "0902"
 +
      source: "国家预警信息发布中心",
 +
      title: "三明市气象台发布雷电黄色预警[Ⅲ级/较重]",
 +
      description: "三明市气象台2020年04月21日12时19分继续发布雷电黄色预警信号：预计未来6小时我市有雷电活动，局地伴有短时强降水、6-8级雷雨大风等强对流天气。请注意防范！"
 +
  realtime:
 +
    status: ok
 +
    temperature: 46.92
 +
    humidity: 0.6
 +
    cloudrate: 0.99
 +
    skycon: LIGHT_RAIN
 +
    visibility: 14.99
 +
    dswrf: 0
 +
    wind:
 +
      speed: 20.04
 +
      direction: 327.03
 +
    pressure: 100027.48
 +
    apparent_temperature: 52.9
 +
    precipitation:
 +
      local:
 +
        status: ok
 +
        datasource: radar
 +
        intensity: 0.245
 +
      nearest:
 +
        status: ok
 +
        distance: 0
 +
        intensity: 6
 +
    air_quality:
 +
      pm25: 0
 +
      pm10: 0
 +
      o3: 0
 +
      so2: 0
 +
      no2: 0
 +
      co: 0
 +
      aqi:
 +
        chn: 0
 +
        usa: 0
 +
      description:
 +
        usa: ''
 +
        chn: missing
 +
    life_index:
 +
      ultraviolet:
 +
        index: 0
 +
        desc: None
 +
      comfort:
 +
        index: 2
 +
        desc: Very hot
 +
  minutely:
 +
    status: ok
 +
    datasource: radar
 +
    precipitation_2h:
 +
    - 0.245
 +
    precipitation:
 +
    - 0.245
 +
    probability:
 +
    - 0.9703164364
 +
    description: "您西北9公里正在下小雨哦"
 +
  hourly:
 +
    status: ok
 +
    description: 阴，今天傍晚20点钟后转小雨，其后阴
 +
    precipitation:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 0.021
 +
    temperature:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 46.92
 +
    wind:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      speed: 20.04
 +
      direction: 327.03
 +
    humidity:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 0.6
 +
    skycon:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: LIGHT_RAIN
 +
    pressure:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 100027.4809084723
 +
    visibility:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 14.99
 +
    dswrf:
 +
    - datetime: 2020-04-03T02:00-04:00
 +
      value: 0
 +
    air_quality:
 +
      aqi:
 +
      - datetime: 2020-04-03T02:00-04:00
 +
        value:
 +
          chn: 0
 +
          usa: 0
 +
      pm25:
 +
      - datetime: 2020-04-03T02:00-04:00
 +
        value: 0
 +
  daily:
 +
    status: ok
 +
    astro:
 +
    - date: 2020-04-03T00:00-04:00
 +
      sunrise:
 +
        time: '06:34'
 +
      sunset:
 +
        time: '19:23'
 +
    precipitation:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 0.028
 +
      min: 0
 +
      avg: 0.0075
 +
    temperature:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 51.35
 +
      min: 46.92
 +
      avg: 49.74
 +
    wind:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max:
 +
        speed: 20.04
 +
        direction: 327.03
 +
      min:
 +
        speed: 13.17
 +
        direction: 12.79
 +
      avg:
 +
        speed: 16.85
 +
        direction: 347.62
 +
    humidity:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 0.76
 +
      min: 0.57
 +
      avg: 0.71
 +
    cloudrate:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 1
 +
      min: 0.95
 +
      avg: 1
 +
    pressure:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 100814.14
 +
      min: 99934.41
 +
      avg: 100305.84
 +
    visibility:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 14.99
 +
      min: 9.67
 +
      avg: 12.62
 +
    dswrf:
 +
    - date: 2020-04-03T00:00-04:00
 +
      max: 138.9
 +
      min: 0
 +
      avg: 41.4
 +
    air_quality:
 +
      aqi:
 +
      - date: 2020-04-03T00:00-04:00
 +
        max:
 +
          chn: 0
 +
          usa: 0
 +
        avg:
 +
          chn: 0
 +
          usa: 0
 +
        min:
 +
          chn: 0
 +
          usa: 0
 +
      pm25:
 +
      - date: 2020-04-03T00:00-04:00
 +
        max: 0
 +
        avg: 0
 +
        min: 0
 +
    skycon:
 +
    - date: 2020-04-03T00:00-04:00
 +
      value: LIGHT_RAIN
 +
    life_index:
 +
      ultraviolet:
 +
      - date: 2020-04-03T00:00-04:00
 +
        index: '1'
 +
        desc: 最弱
 +
      carWashing:
 +
      - date: 2020-04-03T00:00-04:00
 +
        index: '3'
 +
        desc: 较不适宜
 +
      dressing:
 +
      - date: 2020-04-03T00:00-04:00
 +
        index: '4'
 +
        desc: 温暖
 +
      comfort:
 +
      - date: 2020-04-03T00:00-04:00
 +
        index: '4'
 +
        desc: 温暖
 +
      coldRisk:
 +
      - date: 2020-04-03T00:00-04:00
 +
        index: '4'
 +
        desc: 极易发
 +
  forecast_keypoint: "您西北9公里正在下小雨哦"
 +
 
 +
</syntaxhighlight>
 +
 
 +
=== 返回错误 ===
 +
 
 +
=== 天气变量 ===
  
−
=== '''示例1如下''' ===
+
====实况级部分的天气变量====
−
<blockquote><code><nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json</nowiki></code>
 
  
−
</blockquote><blockquote><nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.jsonp?callback=MYCALLBACK</nowiki></blockquote><blockquote>'''token：'''这里是测试 token ，即 <code>TAkhjf8d1nlSlspN</code></blockquote><blockquote>'''经纬度：'''经度在前，纬度在后，中间用半角逗号隔开，这里是 <code>121.6544,25.1552</code></blockquote><blockquote>'''返回格式：'''json 或者 jsonp，jsonp 需提供回调函数名</blockquote>
+
{{:实况天气接口/v2.5/天气变量}}
  
−
=== '''示例2如下''' ===
+
====分钟级部分的天气变量====
−
<blockquote><code><nowiki>https://api.caiyunapp.com/v2/TAkhjf8d1nlSlspN/121.6544,25.1552/weather?lang=en_US</nowiki></code></blockquote><blockquote>'''语言选项 lang：'''默认为简体中文（zh_CN）、繁体中文（zh_TW）、美式英语（en_US）、英式英语（en_GB）</blockquote><blockquote>'''单位制选项 unit：'''默认为公制（metric）、科学单位体系（SI） 、英制（imperial）</blockquote><blockquote>'''时区偏移秒数 tzshift：'''用户提供所需时区偏移秒，考虑欧美夏令时，默认东八（tzshift=28800）；例如，用户希望取得印度（东5.5区）习惯定义下的逐日天气，加参数&tzshift=19800（=3600*5.5），然后daily的计算都会做相应处理。</blockquote><blockquote>'''定制返回的起始时间戳 begin'''：默认为当前utc时间戳，可以用来返回两日内的历史数据</blockquote><blockquote>'''定制返回逐小时预报总小时数 hourlysteps'''：默认为48小时（包括当前时刻）</blockquote><blockquote>'''定制返回逐日预报总天数 dailysteps'''：默认为5天（包括今天）</blockquote><blockquote>'''返回周围预警: alert='''true (注意小写)</blockquote>
 
  
−
=='''返回结构和说明'''==
+
{{:分钟级降雨预报接口/v2.5/天气变量}}
−
<blockquote>'''realtime'''分字段含义，请移步：[http://open.caiyunapp.com/%E5%AE%9E%E5%86%B5%E5%A4%A9%E6%B0%94%E6%8E%A5%E5%8F%A3/v2.2 实况接口/v2.2]</blockquote><blockquote>'''minutely'''分字段含义，请移步：[http://open.caiyunapp.com/%E7%9F%AD%E4%B8%B4%E9%99%8D%E6%B0%B4%E9%A2%84%E6%8A%A5%E6%8E%A5%E5%8F%A3/v2.2 逐分钟降水短临预报接口/v2.2]</blockquote><blockquote>'''hourly'''分字段含义，请移步：[[逐小时预报接口/v2.2]]</blockquote><blockquote>'''daily'''分字段含义，请移步：[[逐日预报接口/v2.2]]</blockquote><blockquote>'''alert'''分字段含义，如下：</blockquote><syntaxhighlight lang="javascript">
 
  
−
{  status:ok,
+
====小时级部分的天气变量====
−
    api_version:v2.2,
 
−
    api_status:active,
 
−
    unit:metric,
 
−
    lang:en_US,
 
−
    result:{
 
−
        forecast_keypoint:cloudy, clear weather after 23 this midnight,
 
−
        primary:0,
 
−
        realtime:{status:ok,                                                                                                ###请参考：实况接口/v2.2
 
−
                    temperature:-1.21,
 
−
                    pres:56320.24,
 
−
                    humidity:0.09,
 
−
                    wind:{direction:284.91,speed:30.12}},
 
−
                    precipitation:{local:{status:ok,intensity:0.0,datasource:gfs}},
 
−
                    cloudrate:0.3,
 
−
                    dswrf:677.9,
 
−
                    visibility:24.1,
 
−
                   
 
−
                    skycon:PARTLY_CLOUDY_DAY,
 
−
                    ultraviolet:{index:5.0,desc:Moderat},
 
−
                    comfort:{index:11,desc:Icy wind cold},
 
−
                   
 
−
                    pm25:3,
 
−
                    pm10:10.0,
 
−
                    o3:97.0,
 
−
                    no2:2.0,
 
−
                    so2:7.0,
 
−
                    co:0.4,
 
−
                    aqi:10
 
−
          },
 
−
        minutely:{status:ok,                                                                                                  ###请参考：逐分钟降水短临预报接口/v2.2
 
−
                    precipitation_2h:[0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0],
 
−
                    precipitation:[0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,
 
−
                    0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0],
 
−
                    datasource:gfs,
 
−
                    description:No snow in the next hour
 
−
        },
 
−
        hourly:{status:ok,                                                                                                      ###请参考：逐小时预报接口/v2.2
 
−
                    description:cloudy, clear weather after 23 this midnight,
 
−
                    temperature:[{value:-1.21,datetime:2018-11-20 16:00},{value:-0.51,datetime:2018-11-20 17:00}]},
 
−
                    pres:[{value:56320.2411405722,datetime:2018-11-20 16:00},{value:56309.4272949293,datetime:2018-11-20 17:00}],
 
−
                    humidity:[{value:0.09,datetime:2018-11-20 16:00},{value:0.11,datetime:2018-11-20 17:00}],
 
−
                    wind:[{direction:284.91,speed:30.12,datetime:2018-11-20 16:00},{direction:288.24,speed:32.91,datetime:2018-11-20 17:00}],
 
−
                    precipitation:[{value:0.0,datetime:2018-11-20 16:00},{value:0.0,datetime:2018-11-20 17:00}],
 
−
                    cloudrate:[{value:0.3,datetime:2018-11-20 16:00},{value:0.3,datetime:2018-11-20 17:00}],
 
−
                    dswrf:[{value:677.9121814107,datetime:2018-11-20 16:00},{value:596.25984,datetime:2018-11-20 17:00}],
 
−
                    visibility:[{value:24.1,datetime:2018-11-20 16:00},{value:24.1,datetime:2018-11-20 17:00}],
 
  
−
                    skycon:[{value:PARTLY_CLOUDY_DAY,datetime:2018-11-20 16:00},{value:WIND,datetime:2018-11-20 17:00}],
+
{{:小时级预报接口/v2.5/天气变量}}
−
                    pm25:[{value:3,datetime:2018-11-20 16:00},{value:0,datetime:2018-11-20 17:00}],
 
−
                    aqi:[{value:10,datetime:2018-11-20 16:00},{value:0,datetime:2018-11-20 17:00}],
 
−
            },
 
−
        daily:{status:ok,                                                                                                      ###请参考：逐日预报接口/v2.2
 
−
                temperature:[{date:2018-11-20,max:1.19,avg:-4.35,min:-16.0},{date:2018-11-21,max:2.0,avg:-7.32,min:-18.0}],
 
−
                pres:[{date:2018-11-20,max:56600.24,avg:56422.06,min:56309.43},{date:2018-11-21,max:56833.63,avg:56653.05,min:56553.63}],
 
−
                humidity:[{date:2018-11-20,max:0.23,avg:0.14,min:0.09},{date:2018-11-21,max:0.15,avg:0.11,min:0.06}],
 
−
                wind:[{date:2018-11-20,max:{direction:290.25,speed:35.9},avg:{direction:278.27,speed:19.65},min:{direction:230.17,speed:4.77}},
 
−
                      {date:2018-11-21,max:{direction:276.13,speed:43.0},avg:{direction:262.47,speed:24.54},min:{direction:216.1,speed:12.48}}],
 
−
                precipitation:[{date:2018-11-20,max:0.0,avg:0.0,min:0.0},{date:2018-11-21,max:0.0,avg:0.0,min:0.0}],
 
−
               
 
−
                dswrf:[{date:2018-11-20,max:743.7,avg:321.5,min:0.0},{date:2018-11-21,max:748.3,avg:202.3,min:0.0}],
 
−
                cloudrate:[{date:2018-11-20,max:0.76,avg:0.49,min:0.0},{date:2018-11-21,max:0.15,avg:0.02,min:0.0}],
 
−
                visibility:[{date:2018-11-20,max:24.1,avg:24.1,min:24.1},{date:2018-11-21,max:24.1,avg:24.1,min:24.1}],
 
−
               
 
−
                skycon:[{date:2018-11-20,value:PARTLY_CLOUDY_DAY},{date:2018-11-21,value:CLEAR_DAY}],
 
−
                skycon_08h_20h:[{date:2018-11-20,value:CLEAR_DAY},{date:2018-11-21,value:CLEAR_DAY}]},
 
−
                skycon_20h_32h:[{date:2018-11-20,value:PARTLY_CLOUDY_NIGHT},{date:2018-11-21,value:CLEAR_NIGHT}],
 
−
                ultraviolet:[{index:5,desc:Very high,datetime:2018-11-20},{index:5,desc:Very high,datetime:2018-11-21}],
 
−
                comfort:[{index:13,desc:Dry cold,datetime:2018-11-20},{index:13,desc:Dry cold,datetime:2018-11-21}],
 
−
                carWashing:[{index:1,desc:Suitable,datetime:2018-11-20},{index:1,desc:Suitable,datetime:2018-11-21}],
 
−
                coldRisk:[{index:4,desc:Extremely prone,datetime:2018-11-20},{index:4,desc:Extremely prone,datetime:2018-11-21}],
 
−
                dressing:[{index:8,desc:Extremely cold,datetime:2018-11-20},{index:8,desc:Extremely cold,datetime:2018-11-21}],
 
−
               
 
−
                pm25:[{date:2018-11-20,max:3,avg:1.12,min:0},{date:2018-11-21,max:1,avg:0.58,min:0}],
 
−
                aqi:[{date:2018-11-20,max:10,avg:1.25,min:0},{date:2018-11-21,max:0,avg:0.0,min:0}],
 
  
−
                astro:[{date:2018-11-20,sunset:{time:19:07},sunrise:{time:08:40}},{date:2018-11-21,sunset:{time:19:07},sunrise:{time:08:41}}],
+
====天级部分的天气变量====
−
        },
 
−
      alert:{alert:{status:"ok"
 
−
              content:{
 
−
                    0:{ request_status: "ok",
 
−
                        source: "国家预警信息发布中心",
 
  
−
                        county: "无",
+
{{:天级预报接口/v2.5/天气变量}}
−
                        province: "江苏省",
 
−
                        regionId: "unknown"
 
−
                        city: "南京市",
 
−
                        code: "1303",                                                      ##预警类型code
 
−
                        adcode: "320100",
 
  
−
                        alertId: "32010041600000_20181130104521",
+
=== 预警信息 ===
−
                        status: "预警中",
 
−
                        title: "南京市气象台发布霾橙色预警[Ⅱ级/严重]",
 
−
                        description: "南京市气象台2018年11月30日10时41分升级霾黄色预警信号为霾橙色预警信号。目前我市已经出现中度霾，预计未来24小时内霾将持续，请注意防范。"
 
  
−
                        location: "江苏省南京市",
+
{{:天气预警信息}}
−
                        latlon: {
 
−
                            0: 32.060255,
 
−
                            1: 118.796877
 
−
                            }
 
−
                        pubtimestamp: 1543545921,
 
−
                        }
 
−
                    }
 
−
              }
 
−
      },
 
−
    location:[31.658613,
 
−
                87.815109]
 
−
    server_time:1542702509,
 
−
    tzshift:28800,
 
−
}
 
  
−
</syntaxhighlight>{{预警类型}}{{天气现象}}
+
=== 自然语言描述 ===
  
−
=='''生活指数'''==
+
== 变量详细说明 ==
−
{{生活指数}}
 
  
−
=='''支持的单位制'''==
+
===支持的单位制===
  
 
{{Template:彩云天气 API/支持的单位制}}
 
{{Template:彩云天气 API/支持的单位制}}
 +
 +
===雷达降水强度===
 +
 +
{{:雷达降水强度}}
 +
 +
== 常量详细说明 ==
 +
 +
===天气现象代码===
 +
 +
{{:天气现象代码表}}
 +
 +
===生活指数等级===
 +
 +
{{:生活指数等级}}
  
 
[[Category:API 产品]]
 
[[Category:API 产品]]
 +
 +
[[en:General weather interface/v2.5]]

Latest revision as of 10:31, 21 April 2020

快速通道：天气业务 | 天气开发者 | 小译开发者

本文版本：通用预报接口/v2.5，当前稳定版本版本：v2.5，历史版本：v2.2，v2.3，和 v2.4。

授权与认证

请先至彩云开放平台注册，注册后可以获得 token 。

把您的 token 拼到 API 请求的 URL 中，如

https://api.caiyunapp.com/v2.5/TAkhjf8d1nlSlspN/121.6544,25.1552/weather.json

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

API 请求

示例

这里是测试 token ，即 TAkhjf8d1nlSlspN

请求参数

API 返回值

返回结构说明

通用预报接口可以认为是如下几个不同时间颗粒度接口的合并

所以，返回结构的细节可以在上述几个接口的文档中查看。 

status: ok
api_version: v2.5
api_status: active
lang: zh_CN
unit: metric
tzshift: 28800
timezone: Asia/Shanghai
server_time: 1585894300
location:
location:
  - 26.150279
  - 118.266637
result:
  alert:
    status: ok
    content:
      request_status: "ok",
      alertId: "35040041600001_20200421123203",
      latlon: [26.263406,117.638678]
      pubtimestamp: 1587443583
      status: "预警中"
      regionId: "unknown"
      adcode: "350400"
      location: "福建省三明市"
      province: "福建省"
      city: "三明市"
      county: "无"
      code: "0902"
      source: "国家预警信息发布中心",
      title: "三明市气象台发布雷电黄色预警[Ⅲ级/较重]",
      description: "三明市气象台2020年04月21日12时19分继续发布雷电黄色预警信号：预计未来6小时我市有雷电活动，局地伴有短时强降水、6-8级雷雨大风等强对流天气。请注意防范！"
  realtime:
    status: ok
    temperature: 46.92
    humidity: 0.6
    cloudrate: 0.99
    skycon: LIGHT_RAIN
    visibility: 14.99
    dswrf: 0
    wind:
      speed: 20.04
      direction: 327.03
    pressure: 100027.48
    apparent_temperature: 52.9
    precipitation:
      local:
        status: ok
        datasource: radar
        intensity: 0.245
      nearest:
        status: ok
        distance: 0
        intensity: 6
    air_quality:
      pm25: 0
      pm10: 0
      o3: 0
      so2: 0
      no2: 0
      co: 0
      aqi:
        chn: 0
        usa: 0
      description:
        usa: ''
        chn: missing
    life_index:
      ultraviolet:
        index: 0
        desc: None
      comfort:
        index: 2
        desc: Very hot
  minutely:
    status: ok
    datasource: radar
    precipitation_2h:
    - 0.245
    precipitation:
    - 0.245
    probability:
    - 0.9703164364
    description: "您西北9公里正在下小雨哦"
  hourly:
    status: ok
    description: 阴，今天傍晚20点钟后转小雨，其后阴
    precipitation:
    - datetime: 2020-04-03T02:00-04:00
      value: 0.021
    temperature:
    - datetime: 2020-04-03T02:00-04:00
      value: 46.92
    wind:
    - datetime: 2020-04-03T02:00-04:00
      speed: 20.04
      direction: 327.03
    humidity:
    - datetime: 2020-04-03T02:00-04:00
      value: 0.6
    skycon:
    - datetime: 2020-04-03T02:00-04:00
      value: LIGHT_RAIN
    pressure:
    - datetime: 2020-04-03T02:00-04:00
      value: 100027.4809084723
    visibility:
    - datetime: 2020-04-03T02:00-04:00
      value: 14.99
    dswrf:
    - datetime: 2020-04-03T02:00-04:00
      value: 0
    air_quality:
      aqi:
      - datetime: 2020-04-03T02:00-04:00
        value:
          chn: 0
          usa: 0
      pm25:
      - datetime: 2020-04-03T02:00-04:00
        value: 0
  daily:
    status: ok
    astro:
    - date: 2020-04-03T00:00-04:00
      sunrise:
        time: '06:34'
      sunset:
        time: '19:23'
    precipitation:
    - date: 2020-04-03T00:00-04:00
      max: 0.028
      min: 0
      avg: 0.0075
    temperature:
    - date: 2020-04-03T00:00-04:00
      max: 51.35
      min: 46.92
      avg: 49.74
    wind:
    - date: 2020-04-03T00:00-04:00
      max:
        speed: 20.04
        direction: 327.03
      min:
        speed: 13.17
        direction: 12.79
      avg:
        speed: 16.85
        direction: 347.62
    humidity:
    - date: 2020-04-03T00:00-04:00
      max: 0.76
      min: 0.57
      avg: 0.71
    cloudrate:
    - date: 2020-04-03T00:00-04:00
      max: 1
      min: 0.95
      avg: 1
    pressure:
    - date: 2020-04-03T00:00-04:00
      max: 100814.14
      min: 99934.41
      avg: 100305.84
    visibility:
    - date: 2020-04-03T00:00-04:00
      max: 14.99
      min: 9.67
      avg: 12.62
    dswrf:
    - date: 2020-04-03T00:00-04:00
      max: 138.9
      min: 0
      avg: 41.4
    air_quality:
      aqi:
      - date: 2020-04-03T00:00-04:00
        max:
          chn: 0
          usa: 0
        avg:
          chn: 0
          usa: 0
        min:
          chn: 0
          usa: 0
      pm25:
      - date: 2020-04-03T00:00-04:00
        max: 0
        avg: 0
        min: 0
    skycon:
    - date: 2020-04-03T00:00-04:00
      value: LIGHT_RAIN
    life_index:
      ultraviolet:
      - date: 2020-04-03T00:00-04:00
        index: '1'
        desc: 最弱
      carWashing:
      - date: 2020-04-03T00:00-04:00
        index: '3'
        desc: 较不适宜
      dressing:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 温暖
      comfort:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 温暖
      coldRisk:
      - date: 2020-04-03T00:00-04:00
        index: '4'
        desc: 极易发
  forecast_keypoint: "您西北9公里正在下小雨哦"

返回错误

天气变量

实况级部分的天气变量

名称 健值路径（jsonpath） 量 时间粒度 地理范围 注释
温度 $.result.realtime.temperature 温度 实况 全球 地表2米气温
体感温度 $.result.realtime.apparent_temperature 温度 实况 全球
气压 $.result.realtime.pressure 气压(Pa) 实况 全球 地面气压
相对湿度 $.result.realtime.humidity 相对湿度(%) 实况 全球 地表2米湿度
风向 $.result.realtime.wind.direction 风向 实况 全球 地表10米风向
风速 $.result.realtime.wind.speed 风速 实况 全球 地表10米风速
最近降水距离 $.result.realtime.precipitation.nearest.distance 距离 实况 全球 最近降水带与本地的距离
最近降水强度 $.result.realtime.precipitation.nearest.intensity 降水强度 实况 全球 最近降水处的降水强度
本地降水强度 $.result.realtime.precipitation.local.intensity 雷达降水强度 实况 全球 最近降水处的降水强度
云量 $.result.realtime.cloudrate 云量(0.0-1.0) 实况 全球 全天总云量
短波辐射 $.result.realtime.dswrf 向下短波辐射通量(W/M2) 实况 全球 地表向下短波辐射通量
能见度 $.result.realtime.visibility 能见度 实况 全球 地表水平能见度
天气状况 $.result.realtime.skycon 天气状况 实况 全球 参见#天气现象代码
舒适度指数 $.result.realtime.life_index.comfort.index 舒适度指数自然语言 实况 全球 参见#生活指数等级
紫外线指数 $.result.realtime.life_index.ultraviolet.index 紫外线指数自然语言 实况 全球 参见#生活指数等级
PM25浓度 $.result.realtime.air_quality.pm25 PM25浓度(μg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 PM25浓度
PM10浓度 $.result.realtime.air_quality.pm10 PM10浓度(μg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 PM10浓度
臭氧浓度 $.result.realtime.air_quality.o3 臭氧浓度(μg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 臭氧浓度
二氧化氮浓度 $.result.realtime.air_quality.no2 二氧化氮浓度(μg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 二氧化氮浓度
二氧化硫浓度 $.result.realtime.air_quality.so2 二氧化硫浓度(μg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 二氧化硫浓度
一氧化碳浓度 $.result.realtime.air_quality.co 一氧化碳浓度(mg/m3) 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 一氧化碳浓度
AQI $.result.realtime.air_quality.aqi 国标AQI 实况 大陆、港澳台、印度、日本，美国、阿拉斯加、夏威夷、加拿大 国标AQI

分钟级部分的天气变量

名称 健值路径（jsonpath） 量 取值范围 时间粒度 更新频次 地理范围 注释
降水概率 $.result.minutely.probability 降水概率 0.0~1.0 未来两小时 实时更新 数据覆盖范围 本地未来1小时逐分钟短临降水强度预报
一小时降水强度 $.result.minutely.precipitation 雷达降水强度 0.0~1.0 未来一小时 实时更新 数据覆盖范围 本地未来1小时逐分钟短临降水强度预报
两小时降水强度 $.result.minutely.precipitation_2h 雷达降水强度 0.0~1.0 未来两小时 实时更新 数据覆盖范围 本地未来2小时逐分钟短临降水强度预报

小时级部分的天气变量

逐小时预报，没有生活指数变量

名称 健值路径（jsonpath） 量 时间粒度 地理范围 注释
温度 $.result.hourly.temperature.value 温度 逐小时预报 全球 地表2米气温
气压 $.result.hourly.pressure.value 气压(Pa) 逐小时预报 全球 地面气压
相对湿度 $.result.hourly.humidity.value 相对湿度(%) 逐小时预报 全球 地表2米湿度
风向 $.result.hourly.wind.direction.value 风向 逐小时预报 全球 地表10米风向
风速 $.result.hourly.wind.speed.value 风速 逐小时预报 全球 地表10米风速
本地降水强度 $.result.hourly.precipitation.value 降水量(mm/h) 逐小时预报 全球 本地降水量
云量 $.result.hourly.cloudrate.value 云量(0.0-1.0) 逐小时预报 全球 全天总云量
短波辐射 $.result.hourly.dswrf.value 向下短波辐射通量(W/M2) 逐小时预报 全球 地表向下短波辐射通量
能见度 $.result.hourly.visibility.value 能见度 逐小时预报 全球 地表水平能见度
主要天气现象 $.result.hourly.skycon.value 天气状况 逐小时预报 全球 参见#天气现象代码
逐小时预报自然语言描述 $.result.hourly.description 自然语言描述 逐小时预报 全球 逐小时预报自然语言描述
综合预报自然语言描述 $.result.hourly.forecast_keypoint 自然语言描述 逐小时预报 全球 逐小时或逐分钟天气预报，综合自然语言描述
PM25浓度 $.result.hourly.pm25.value PM25浓度(μg/m3) 逐小时预报 大陆、港澳台、暂无印度 PM25浓度
AQI $.result.hourly.aqi.value 国标AQI 逐小时预报 大陆、港澳台、暂无印度 国标AQI

天级部分的天气变量

逐日预报，没有逐日预报的自然语言描述字段

名称 健值路径（jsonpath） 量 时间粒度 地理范围 注释
温度 $.result.daily.temperature[max,min,avg] 温度 逐日预报 全球 地表2米气温
气压 $.result.daily.pressure[max,min,avg] 气压(Pa) 逐日预报 全球 地面气压
相对湿度 $.result.daily.humidity[max,min,avg] 相对湿度(%) 逐日预报 全球 地表2米湿度
风速 $.result.daily.wind.speed[max,min,avg] 风速 逐日预报 全球 地表10米风速
本地降水强度 $.result.daily.precipitation[max,min,avg] 降水量(mm/h) 逐日预报 全球 本地降水量
云量 $.result.daily.cloudrate[max,min,avg] 云量(0.0-1.0) 逐日预报 全球 全天总云量
短波辐射 $.result.daily.dswrf[max,min,avg] 向下短波辐射通量(W/M2) 逐日预报 全球 地表向下短波辐射通量
能见度 $.result.daily.visibility[max,min,avg] 能见度 逐日预报 全球 地表水平能见度
全天主要天气现象 $.result.daily.skycon.value 天气状况 逐日预报 全球 全天主要天气现象，参见#天气现象代码
白天主要天气现象 $.result.daily.skycon_08h_20h.value 天气状况 逐日预报 全球 白天主要天气现象，参见#天气现象代码
夜晚主要天气现象 $.result.daily.skycon_20h_32h.value 天气状况 逐日预报 全球 夜晚主要天气现象，参见#天气现象代码
紫外线指数 $.result.daily.ultraviolet.desc 紫外线指数自然语言 逐日预报 全球 紫外线指数及其描述
舒适度指数 $.result.daily.comfort.desc 舒适度指数自然语言 逐日预报 全球 舒适度指数及其描述
洗车指数 $.result.daily.carWashing.desc 洗车指数自然语言 逐日预报 全球 洗车指数及其描述
感冒指数 $.result.daily.coldRisk.desc 感冒指数自然语言 逐日预报 全球 感冒指数及其描述
穿衣指数 $.result.daily.dressing.desc 冷热指数自然语言 逐日预报 全球 穿衣指数（dressing），不建议继续使用，请使用舒适度
PM25浓度 $.result.daily.pm25[max,min,avg] PM25浓度(μg/m3) 逐日预报 大陆、港澳台、暂无印度 PM25浓度
AQI $.result.daily.aqi[max,min,avg] 国标AQI 逐日预报 大陆、港澳台、暂无印度 国标AQI
日出日落 $.result.daily.astro[sunrise,sunset] 时间 逐日预报 大陆、港澳台、暂无印度 日出日落(当地时区的时刻，tzshift不作用在这个变量)

预警信息

获取天气预警信息，需要在API接口后增加参数：alert=true。

预警信息的字段

  • pubtimestamp: 发布时间，单位是 Unix 时间戳，如 1587443583
  • alertId: 预警ID，如 "35040041600001_20200421123203"
  • status: 预警信息的状态，如"预警中"
  • adcode: 区域代码，如 "350400"
  • location: 位置，如"福建省三明市"
  • province: 省，如"福建省"
  • city: 市，如"三明市"
  • county: 县，如"无"
  • code: 预警代码，如"0902"
  • source: 发布单位，如"国家预警信息发布中心",
  • title: 标题，如"三明市气象台发布雷电黄色预警[Ⅲ级/较重]",
  • description: 描述，如"三明市气象台2020年04月21日12时19分继续发布雷电黄色预警信号：预计未来6小时我市有雷电活动，局地伴有短时强降水、6-8级雷雨大风等强对流天气。请注意防范！"

预警代码的编码规则

预警代码取自 code 字段，预警代码的前两位是预警信息类型，预警代码的后两位是预警级别。举例："code": "0901”，可以分解出结构：预警类型编码＋预警级别编码，于是我们得到雷电蓝色预警。

预警类型编码对照表

预警级别 级别编码
台风 01
暴雨 02
暴雪 03
寒潮 04
大风 05
沙尘暴 06
高温 07
干旱 08
雷电 09
冰雹 10
霜冻 11
大雾 12
霾 13
道路结冰 14
森林火灾 15
雷雨大风 16

预警级别编码对照表

预警级别 级别编码
蓝色 01
黄色 02
橙色 03
红色 04

区域代码 adcode

自然语言描述

变量详细说明

支持的单位制

1.目前支持的单位制包括：科学单位体系（SI，大写）、英制（imperial）、公制（不带参数&unit默认公制，公制还包括: metric:v1和metric:v2）:

单位制
要素
 SI（科学单位体系） imperial（英制） metric:v1（公制v1） metric:v2（公制v2） default metric(默认公制)
实况降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度（0~1） 毫米/小时(mm/hr) 雷达降水强度（0~1）
逐分钟降水短临预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度（0~1） 毫米/小时(mm/hr) 雷达降水强度（0~1）
逐小时预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度（0~1） 毫米/小时(mm/hr) 毫米/小时(mm/hr)
逐日预报降水量 米/秒(meter/sec) 英寸/小时(in/hr) 雷达降水强度（0~1） 毫米/小时(mm/hr) 毫米/小时(mm/hr)
距离 米(m) 英里(mi) 公里(km) 公里(km) 公里(km)
温度 开尔文(K) 华氏度(℉) 摄氏度(℃) 摄氏度(℃) 摄氏度(℃)
气压 帕(Pa) 帕(Pa) 帕(Pa) 帕(Pa) 帕(Pa)
相对湿度 0~1 0~1 0~1 0~1 0~1
风向 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°) 从北顺时针(0~360°)
风速 米/秒（m/s） 英里/小时（mi/hr） 公里/小时（km/hr） 公里/小时（km/hr） 公里/小时（km/hr）
云量 0~1 0~1 0~1 0~1 0~1
能见度 米(m) 英里(mi) 公里(km) 公里(km) 公里(km)

unit=metric:v1时，所有类型中precipitation的单位都是：雷达降水强度（0~1）

unit=metric:v2时，所有类型中precipitation的单位都是：毫米/小时(mm/hr)

2.判断降水等级:

  • 带参数&unit=metric:v1，请求实况、分钟级、逐小时和逐日降水强度，单位都为雷达降水强度（0 ~ 1）；
  • 雷达降水强度（0 ~ 1）判断降水等级：0.03~0.25 小雨(雪)， 0.25~0.35 中雨(雪)， 0.35~0.48大雨(雪)， >0.48 暴雨(雪)；
  • v2.4版本中，本地存在降水时，可以根据skycon（存在于realtime、hourly、daily字段），和skycon_08h_20h和skycon_20h_32h（存在于daily字段），中的：LIGHT_RAIN, MODERATE_RAIN, HEAVY_RAIN, STORM_RAIN(LIGHT_SNOW, MODERATE_SNOW, HEAVY_SNOW，STORM_SNOW)直接获取降水等级
  • 大暴雨(雪)和特大暴雨(雪)，需要根据24小时累计公制降水量（mm/24hr）来判断，研发中...

雷达降水强度

雷达降水强度是在雷达回波反照率基础上由彩云科技定义的一个度量值，它可以简单的描述降雨的相对强弱。

雷达降水强度 降水量 mm／h 天气现象
<0.031 <0.08 无雨／雪
0.031～0.25 0.08~3.44 小雨／雪
0.25～0.35 3.44~11.33 中雨／雪
0.35～0.48 11.33~51.30 大雨／雪
>=0.48 >=51.30 暴雨／雪

常量详细说明

天气现象代码

天气现象 代码 备注
晴（白天） CLEAR_DAY cloudrate < 0.2
晴（夜间） CLEAR_NIGHT cloudrate < 0.2
多云（白天） PARTLY_CLOUDY_DAY 0.8 >= cloudrate > 0.2
多云（夜间） PARTLY_CLOUDY_NIGHT 0.8 >= cloudrate > 0.2
阴 CLOUDY cloudrate > 0.8
轻度雾霾 LIGHT_HAZE PM2.5 100~150
中度雾霾 MODERATE_HAZE PM2.5 150~200
重度雾霾 HEAVY_HAZE PM2.5 > 200
小雨 LIGHT_RAIN
中雨 MODERATE_RAIN
大雨 HEAVY_RAIN
暴雨 STORM_RAIN
雾 FOG 能见度低，湿度高，风速低，温度低
小雪 LIGHT_SNOW
中雪 MODERATE_SNOW
大雪 HEAVY_SNOW
暴雪 STORM_SNOW
浮尘 DUST aqi > 150，pm10 > 150，湿度 < 30%，风速 < 6 m/s
沙尘 SAND aqi > 150，pm10 > 150，湿度 < 30%，风速 > 6 m/s
大风 WIND
  • 主要天气现象的优先级：降雪 > 降雨 > 雾 > 沙尘 > 浮尘 > 雾霾 > 大风 > 阴 > 多云 > 晴

生活指数等级

生活指数名称 等级 等级描述
紫外线（实况级别） ultraviolet0 无
ultraviolet1 很弱
ultraviolet2 很弱
ultraviolet3 弱
ultraviolet4 弱
ultraviolet5 中等
ultraviolet6 中等
ultraviolet7 强
ultraviolet8 强
ultraviolet9 很强
ultraviolet10 很强
ultraviolet11 极强
紫外线（天级别） ultraviolet1 最弱
ultraviolet2 弱
ultraviolet3 中等
ultraviolet4 强
ultraviolet5 很强
穿衣 dressing0 极热
dressing1 极热
dressing2 很热
dressing3 热
dressing4 温暖
dressing5 凉爽
dressing6 冷
dressing7 寒冷
dressing8 极冷
感冒 coldRisk1 少发
coldRisk2 较易发
coldRisk3 易发
coldRisk4: 极易发
Retrieved from "https://open.caiyunapp.com/index.php?title=通用预报接口/v2.5&oldid=6205"