深色模式

參考

HTTP API

不使用 SDK 的整合方可直接呼叫以下端點；除授權與健康檢查外，都要帶 Authorization: Bearer <token>。測試環境位址為 https://sdk-api.lapidinsight.com。

取得目前版本
curl https://sdk-api.lapidinsight.com/v1/release/current \
  -H "Authorization: Bearer <token>" \
  -H "Accept-Encoding: gzip"
方法與路徑
用途
快取
POST /v1/auth/challenge
取得 60 秒有效的 challenge
no-store
POST /v1/auth/register
首次註冊裝置（含平台驗證），換取 token
no-store
POST /v1/auth/renew
以裝置簽章續期 token
no-store
GET /.well-known/jwks.json
驗章公鑰
public, max-age=600
GET /v1/release/current
目前版本與近 7 天撤回清單
max-age=30 加 ETag
GET /v1/release/{release}/symbols
證券清單
永久（immutable）
GET /v1/release/{release}/sec/{securityId}
證券 manifest
no-cache 加 ETag
GET /v1/release/{release}/market
市場級資料集清單
no-cache 加 ETag
GET /v1/release/{release}/market/{dataset}
市場級 manifest（key：TAIEX、TPEX）
no-cache 加 ETag
GET /v1/obj/{dataset}/{key}/{kind}.{hash}
分塊內容（Envelope）
永久（immutable）
GET /v1/presentation/{dataset}
欄位呈現描述
max-age=3600 加 ETag

取一檔證券日 K 的步驟

  1. GET /v1/release/current 取得 release。
  2. GET /v1/release/{release}/symbols 以代號查出 securityId。
  3. GET /v1/release/{release}/sec/{securityId}，取 datasets["price.daily"].chunks。
  4. 依序 GET /v1/obj/price.daily/{securityId}/{kind}.{hash}，依 from 排序後串接各欄。

規則

  • 回應為 application/json，請求帶 Accept-Encoding: gzip 時回傳壓縮內容。
  • 帶 If-None-Match 可取得 304；304 仍計入每日請求次數。例外：/v1/release/current 帶目前的 ETag（不含 *）而回 304 時不計入每日次數，仍計入每秒限流。
  • {release} 格式為 YYYY-MM-DD.N；{securityId} 為 sec_ 加 26 字元；{kind} 為 hist、ytd、mtd、snap 或 fyYYYY。
  • 分塊路徑不含版本，版本撤回不影響分塊；以版本為路徑的端點對已撤回的版回 410。
  • token 有效 30 分鐘，每 24 小時需重新通過平台驗證（改走 register）。token 的 ent 決定可存取的資料集。
  • 每個回應帶 X-Request-Id，回報問題時請附上。
待確認：正式環境的授權服務與網址；測試環境的簽發器只接受開發用驗證。

錯誤格式見 錯誤碼；限流見 授權與限流。