开发者文档

把年鉴数据接入
你的研究工作流

通过稳定的 HTTP API 查询长期指标、年鉴版本与完整二维表格,并保留统计口径、数据版本和官方来源。

创建 API 密钥查看 API 参考
快速开始

第一次请求,只需要三步

核心指标可匿名试用;完整数据可通过 shdata 浏览器授权,或在服务器使用 Bearer API 密钥。

01

先试用公开范围

无需密钥即可查询六项核心指标和最近年鉴版本,响应会标记预览范围。

安装 shdata CLI
02

选择登录方式

本机运行 shdata login;服务器则将专业版密钥保存为 SHDATA_API_KEY

03

发送请求

https://shdata.watch/api/v1/data 下的接口发送请求,并检查 meta.truncated

第一个请求

读取地区生产总值时间序列

下面三种写法会得到相同的指标定义、2015—2024 年数值、统计口径和逐年来源。

export SHDATA_API_KEY="sdo_请替换为你的密钥"


curl --request GET \
  --url "https://shdata.watch/api/v1/data/metrics/gdp?fromYear=2015&toYear=2024" \
  --header "Authorization: Bearer $SHDATA_API_KEY"
响应结构200 OK
{
  "data": {
    "metric": {
      "id": "gdp",
      "label": "地区生产总值",
      "topic": "经济总量",
      "unit": "亿元",
      "firstYear": 1978,
      "lastYear": 2024,
      "observationCount": 47
    },
    "series": [
      {
        "year": 2024,
        "value": 53926.71,
        "editionYear": 2025,
        "sourcePageId": "C0301-51a44e58",
        "sourceUrl": "https://tjj.sh.gov.cn/..."
      }
    ]
  },
  "meta": {
    "sourceVersion": "catalog-v1-...",
    "generatedAt": "..."
  }
}