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

From Caiyun Wiki
Jump to: navigation, search
m (→‎API 请求)
(→‎天气变量)
Line 243: Line 243:
 
=== 天气变量 ===
 
=== 天气变量 ===
  
 +
====实况级部分的天气变量====
 +
 +
{{:实况天气接口/v2.5/天气变量}}
 +
 +
====分钟级部分的天气变量====
 +
 +
{{:分钟级降雨预报接口/v2.5/天气变量}}
 +
 +
====小时级部分的天气变量====
 +
 +
{{:小时级预报接口/v2.5/天气变量}}
 +
 +
====天级部分的天气变量====
 +
 +
{{:天级预报接口/v2.5/天气变量}}
  
 
== 变量详细说明 ==
 
== 变量详细说明 ==

Revision as of 04:33, 15 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: en_US
unit: imperial
tzshift: -14400
timezone: America/New_York
server_time: 1585894300
location:
- 40.7128
- -74.006
result:
  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: " rain easing off in one hour"
  hourly:
    status: ok
    description: drizzle, expect rain to stop after 9 o'clock this morning, followed
      by overcast, then drizzle
    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: Weak
      carWashing:
      - date: 2020-04-03T00:00-04:00
        index: '3'
        desc: Less appropriate
      dressing:
      - date: 2020-04-03T00:00-04:00
        index: '2'
        desc: Very hot
      comfort:
      - date: 2020-04-03T00:00-04:00
        index: '0'
        desc: Sticky hot
      coldRisk:
      - date: 2020-04-03T00:00-04:00
        index: '3'
        desc: Prone
  forecast_keypoint: " rain easing off in one hour"


返回错误

天气变量

实况级部分的天气变量

名称 健值路径（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不作用在这个变量)

变量详细说明

支持的单位制

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）来判断，研发中...
Retrieved from "https://open.caiyunapp.com/index.php?title=通用预报接口/v2.5&oldid=6100"