General weather interface/v2.5

Version of this article: v2.5，current stable version: v2.5，historical veriosns: v2.4

Authentication

After signing up at the dahsboard, you will get your access token. In below sections, we will use a temporary token for demo purpose: S45Fnpxcwyq0QT4b. In production or development, you should use your own.

API call by examples

Scenarios of weather apps

• New York: Weather forecast for New York including real time condition, 2h minutely precipitation forecast, 48h hourly general forecast, 5d daily general forecast, in English and Imperial and US customary measurement systems.
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial
• Tokyo: Weather forecast for Tokyo including real time condition, 2h minutely precipitation forecast, 48h hourly general forecast, 5d daily general forecast, in Japanese and Metric measurement system.
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/139.7690,35.6804/weather.json?lang=ja

Scenarios of planning software

• Short term: 24 hour hourly forecast
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-74.0060,40.7128/weather.json?lang=en_US&unit=imperial&granu=hourly&hourlysteps=24
• Long term: 10 days daily forecast
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/139.7690,35.6804/weather.json?lang=ja&granu=daily&dailysteps=10

Scenarios of scientific instrument

• Assume an instrument on an ocean drilling ship need to get hourly data for next 12 hour
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/172.0060,33.7128/weather.json?lang=en_US&unit=SI&granu=hourly&hourlysteps=12

Scenarios of real-time cases

• Assume a drone control system need the current realtime weather data, but the data should be in SI unit system for convenience of control calculation.
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-157.8583,21.3069/weather.json?lang=en_US&unit=SI&granu=realtime

Scenarios of webapps

• with jsonp callback check_weather
  • https://api.caiyunapp.com/v2.5/S45Fnpxcwyq0QT4b/-157.8583,21.3069/weather.jsonp?lang=en_US&callback=check_weather

Parameters

• lang: optional, the language, default value is zh_CN, you can set any one of zh_CN, zh_TW, en_US, en_GB, ja
• unit: optional, the unit system, default value is metric, you can set any one of metric, imperial, SI
• granu: optional, the temporal granularity, default value is realtime,minutely,hourly,daily, you can set any one or combinations of realtime, minutely, hourly, daily
• hourlysteps: optional, how many hours will be present in hourly forecast, default value is 48 hours and maximal value is 360 hours
• dailysteps: optional, how many days will be present in daily forecast, default value is 5 days and maximal value is 15 days

Other links

• Supported languages in ColorfulClouds Weather API
• Supported measurement systems in ColorfulClouds Weather API
• Datetime calculation in ColorfulClouds Weather API