# 全国天气预报信息 API 接口


全国天气预报信息 API 接口

精确到行政区的7日天气预报。

![gugudata_api_cover](https://static.gugudata.com/cover_weather_v3.png)

# 1. 产品功能

- 支持通过地理坐标、区域编码两种形式查询对应地区的天气信息；
- 全国天气预报每隔 6 小时更新数据；
- 精确到行政区级别的天气预报数据；
- 提供最长 7 天的天气预报数据；
- 提供每日小时级别的天气预报数据；
- 提供本地日出日落、当日历史温度等附加数据；
- 提供紫外线、穿衣、洗车、空气污染等额外指导数据；
- 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
- 全面兼容 Apple ATS；
- 全国多节点 CDN 部署；
- 接口极速响应，多台服务器构建 API 接口负载均衡。

# 2. API 文档

**API 详情地址:** [https://www.gugudata.com/api/details/weatherinfo](https://www.gugudata.com/api/details/weatherinfo)

**接口请求地址:** [https://api.gugudata.com/weather/weatherinfo](https://api.gugudata.com/weather/weatherinfo)

**返回格式:** application/json; charset=utf-8

**请求方式:** GET

**请求协议:** HTTPS

**请求示例:** [https://api.gugudata.com/weather/weatherinfo?appkey=YOUR_APPKEY&code=YOUR_VALUE&days=1](https://api.gugudata.com/weather/weatherinfo?appkey=YOUR_APPKEY&code=YOUR_VALUE&days=1)

**接口测试:** [https://api.gugudata.com/weather/weatherinfo/demo](https://api.gugudata.com/weather/weatherinfo/demo)

## 前置接口

**前置接口说明:** 查询地区编码，根据市或区的关键字进行查询，如北京、苏州、海淀、吴中等

**前置接口地址:** [https://api.gugudata.com/weather/weatherinfo/region?appkey=APPKEY&keyword=查询编码的市或区关键字，如北京、海淀](https://api.gugudata.com/weather/weatherinfo/region?appkey=APPKEY&keyword=查询编码的市或区关键字，如北京、海淀)

**前置接口参数说明:** appkey=YOUR_APPKEY&keyword=查询编码的市或区关键字，如北京、海淀

**前置接口返回格式:** application/json; charset=utf-8

**前置接口返回说明:** 包含地区编码以及省、市、区相关信息

**前置接口请求方式:** GET

**前置接口请求协议:** HTTPS

# 3. 请求参数

| 参数名 | 参数类型 | 是否必须 |   默认值    |                             备注                             |
| :----: | :------: | :------: | :---------: | :----------------------------------------------------------: |
| appkey |  string  |    是    | YOUR_APPKEY |                     付费后获取的 APPKEY                      |
|  code  |  string  |    是    | YOUR_VALUE  | 地理坐标或地区编码。当传递地理坐标时，格式为: [经度,纬度]，如:[120.730724,31.31592]；如果传递地区编码，那么可通过前置接口查询获得地区编码。 |
|  days  |   int    |    否    |      1      |    获取天气预报的天数，默认为1，即为当天数据。最大值为7。    |

# 4. 返回参数

|                  参数名                  | 参数类型 |                             备注                             |
| :--------------------------------------: | :------: | :----------------------------------------------------------: |
|          DataStatus.StatusCode           |   int    |                        接口返回状态码                        |
|       DataStatus.StatusDescription       |  string  |                       接口返回状态说明                       |
|       DataStatus.ResponseDateTime        |  string  |                       接口数据返回时间                       |
|        DataStatus.DataTotalCount         |   int    |                      此条件下的总数据量                      |
|                Data.Code                 |  string  |                           地区编码                           |
|             Data.CodeAddress             |  string  | 如果传递的查询参数为地理坐标，那么该字段将返回地理坐标反解析之后的行政区划信息，格式为: 省份,市,区,街道/镇,POI地址,详细地址，如: 江苏省,苏州市,吴中区,斜塘街道,东湖·春之韵,会心街99号(金塔桥以西,鸿禧桥以北)；如果传递的查询参数是地区编码，那么此字段值为 null，具体值可通过 Data.WeatherRegion 获取。 |
|             Data.WeatherDate             |  string  |                        天气预报的日期                        |
|            Data.WeatherRegion            |  object  | 当前天气预报的详细地区信息，数据格式与查询地区编码接口返回数据格式一致。 |
|       Data.WeatherRegion.ReginType       |  string  |          位置信息类型，2为市级别数据，3为区级别数据          |
|         Data.WeatherRegion.Code          |  string  |                         地区完整编码                         |
|     Data.WeatherRegion.ProvinceCode      |  string  |                            省编码                            |
|     Data.WeatherRegion.ProvinceName      |  string  |                            省名称                            |
|       Data.WeatherRegion.CityCode        |  string  |                            市编码                            |
|       Data.WeatherRegion.CityName        |  string  |                            市名称                            |
|      Data.WeatherRegion.RegionCode       |  string  |                            区编码                            |
|      Data.WeatherRegion.RegionName       |  string  |                            区名称                            |
|       Data.WeatherRegion.TownCode        |  string  |                            镇编码                            |
|       Data.WeatherRegion.TownName        |  string  |                            镇名称                            |
|             Data.WeatherInfo             |  string  |                           天气情况                           |
|           Data.TemperatureHigh           |   int    |                           最高温度                           |
|           Data.TemperatureLow            |   int    |                           最低温度                           |
|   Data.TodayHistoryHighestTemperature    |   int    |                       当日历史最高温度                       |
|    Data.TodayHistoryLowestTemperature    |   int    |                       当日历史最低温度                       |
|        Data.WeatherWindCondition1        |  string  |                            风向1                             |
|        Data.WeatherWindCondition2        |  string  |                            风向2                             |
|          Data.WeatherWindLevel           |  string  |                             风级                             |
|             Data.SunRiseTime             |  string  |                           日出时间                           |
|             Data.SunSetTime              |  string  |                           日落时间                           |
|           Data.WeatherPerHour            |  array   |                当日小时级别的天气预报数据数组                |
|     Data.WeatherPerHour.WeatherTime      |  string  |                   预报的小时时间，24小时制                   |
|     Data.WeatherPerHour.WeatherInfo      |  string  |                           天气情况                           |
|     Data.WeatherPerHour.Temperature      |  string  |                             温度                             |
| Data.WeatherPerHour.WeatherWindCondition |  string  |                             风向                             |
|   Data.WeatherPerHour.WeatherWindLevel   |  string  |                             风级                             |
|            Data.LifeHelperUV             |  object  |                            UV指数                            |
|           Data.LifeHelperWear            |  object  |                           穿衣指数                           |
|          Data.LifeHelperWashCar          |  object  |                           洗车指数                           |
|            Data.LifeHelperAir            |  object  |                           空气指数                           |
|        Data.LifeHelper.HelperName        |  string  |                           指数名称                           |
|       Data.LifeHelper.HelperStatus       |  string  |                           指数状态                           |
|       Data.LifeHelper.HelperValue        |  string  |      指数值。总分：紫外线5分，穿衣7分，洗车4分，空气5分      |
|      Data.LifeHelper.HelperContent       |  string  |                           指数内容                           |
|     Data.WeatherDataGenerateDateTime     |  string  |                   天气预报内容数据生成时间                   |