開發者文件
認證
金晰數據僅支援 Authorization Bearer(RFC 6750)認證,與 Stripe、OpenAI 使用的格式相同。不使用 OAuth 或 session。
Bearer Token
每個請求都必須在 HTTP header 帶上 Authorization: Bearer {YOUR_KEY}。
bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.clarifindata.com/v1/data/TaiwanStockPrice?stock_id=2330&limit=5"python
import requests
headers = {"Authorization": "Bearer YOUR_API_KEY"}
resp = requests.get(
"https://api.clarifindata.com/v1/data/TaiwanStockPrice",
headers=headers,
params={"stock_id": "2330", "limit": 5},
)
print(resp.json())ℹ
未提供 Authorization header,或金鑰格式不正確時,API 會回傳 401。金鑰有效但 tier 不足時,例如以 Free key 查詢 Lite 資料集,API 會回傳 403。
每個回應都會包含以下 rate-limit header,可用於讀取目前配額狀態:
| Header | 說明 |
|---|---|
| X-RateLimit-Limit | 此 tier 每小時的呼叫上限 |
| X-RateLimit-Remaining | 目前視窗的剩餘呼叫次數 |
| X-RateLimit-Window | 視窗長度(秒),永遠是 3600 |
| X-RateLimit-Tier | 此 key 的 tier(free/lite/plus) |
Key 等級
每把 key 都會綁定一個 tier。Tier 決定可查詢的資料集與每小時呼叫上限。
| Tier | 資料集 | 每小時上限 | 方案 |
|---|---|---|---|
| free | 49 個 Free 資料集 | 600 | 免費,無需信用卡 |
| lite | 80 個(Free + Lite) | 3,000 | NT$149/月 |
| plus | 82 個資料集(含 AI) | 10,000 | NT$299/月 |
如需確認目前 key 的 tier 與剩餘配額,請呼叫 GET /v1/key/info。
bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://api.clarifindata.com/v1/key/info"json
{
"tier": "free",
"rate_limit_per_hour": 600,
"remaining_this_hour": 597,
"window_resets_in_seconds": 2341
}