文件 /

API 參考

完整 REST 約定:認證、限額、資料新鮮度欄位、endpoint 同錯誤。

認證同限額

資料 endpoint 可以匿名試用:每個 IP 每分鐘 12 次、每小時 100 次。加 key 之後用帳戶每月額度。

bash · header
Authorization: Bearer YOUR_KEY
X-RateLimit-Remaining: 9999
X-RateLimit-Reset: 1788220800

解釋資料新鮮度嘅欄位

`source` 係來源類別,`market_session` 係市場狀態,`data_updated_at` 係數值寫入時間。三個都應該保存。

Endpoints

GET /v1/latest[/{BASE}]現時匯率,可以全部返回或者用 symbols 篩選。
GET /v1/{YYYY-MM-DD}[/{BASE}]指定日期同基準貨幣嘅歷史快照。
GET /v1/convert/{FROM}/{TO}[/{AMOUNT}] · POST /v1/convert金額換算,支援單次 GET 同批量 POST。
GET /v1/rate/{slug}用 slug 返回單一貨幣對。
GET /v1/range每日時間序列,支援分頁同下載。
GET /v1/currencies支援貨幣清單,唔接受參數。
GET /v1/account帳戶、方案、現有 key 同今月用量。

錯誤

錯誤統一用 `{ result: "error", code, message }`。429 會加 `Retry-After`;資料來源失敗時唔會偷偷轉用假數。

json · error
{
  "result": "error",
  "code": "missing_parameter",
  "message": "missing required parameter: symbols"
}

English complete field-by-field reference →