開發者文件

把年鑑資料接入
你的研究工作流程

透過穩定的 HTTP API 查詢長期指標、年鑑版本與完整二維表格,並保留統計口徑、資料版本和官方來源。

建立 API 金鑰查看 API 參考
快速開始

第一次請求,只需要三步

核心指標可匿名試用;完整資料可透過 shdata 瀏覽器授權,或在伺服器使用 Bearer API 金鑰。

01

先試用公開範圍

無需金鑰即可查詢六項核心指標和最近年鑑版本,回應會標記預覽範圍。

安裝 shdata CLI
02

選擇登入方式

本機執行 shdata login;伺服器則將專業版金鑰保存為 SHDATA_API_KEY。

03

傳送請求

向 API 基礎網址下的端點傳送請求,並檢查 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": "..."
  }
}