你可以從左側導覽查看所有資料集文件,也可以先從 Quick Start 建立第一個 request。
若要讓 agent 或內部工具讀取文件,後續可透過 OpenAPI spec、llms.txt 或 MCP tools 作為入口。
TW Market Data 會以 OpenAPI 3.x 格式描述可公開使用的 API contract。
公開 machine-readable artifact:/openapi.json。
OpenAPI 內容會隨資料 coverage 與 productization rollout 逐步更新,詳細欄位仍以對應 docs endpoint 頁面為準。
- endpoint path
- request parameters
- response schema
- authentication header
- error status
- dataset availability status
- examples for query / screener
- 產生 TypeScript / Python client
- 匯入 Postman / Insomnia / Bruno
- 讓 agent 或 MCP tool 探索可用 endpoint
- validate request / response schema
- 將 docs 與 backend contract 對齊
- spec 只描述 available-now / preview API,不保證 skeleton / placeholder。
- controlled rollout 下,不同 API key 可能有不同 access。
- 以 backend read API contract 為準。
- 若 docs 與 spec 不一致,應回報並以 spec / backend contract 校正。