跳至主要内容

目錄與日曆

目錄告訴你什麼存在、什麼時候交易。本頁說明流程；參數與回應欄位在 API 文件。

每個目錄回應都帶 catalog_version、ETag 與 Cache-Control: private, max-age=300。把 ETag 當成 If-None-Match 傳回； 目錄沒變時回 304。

目錄端點只需要有效金鑰，不需要資料權限，所以是檢查金鑰最便宜的方法。

交易所與市場​

從 GET /v2/catalog/venues 開始。每個交易所有代碼、名稱、MIC、時區、國家與 它服務的市場。目前服務的市場整理在資料範圍。

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/venues" \
  | jq '.venues[] | {code, timezone, markets}'

商品​

商品是可交易的分類，例如 SHFE.rb，帶乘數與最小跳動。用 GET /v2/catalog/products 列出，可限定交易所。

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/products?venue=SHFE" \
  | jq '.products[] | {code, name, multiplier, tick_size}'

Instrument​

Instrument 是一個可交易的東西：有到期月的期貨、選擇權、股票、ETF、基金或 指數。用 GET /v2/catalog/instruments 搜尋與分頁，或 GET /v2/catalog/instruments/{symbol} 查單一商品。

# 所有上市中的螺紋鋼期貨
curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/instruments?product=SHFE.rb&kind=future&status=active"

# 單一商品，含它有的資料集
curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/instruments/SHFE.rb2701"

單一商品回應有 instrument、datasets，沒有資料時另有 availability。 datasets: [] 且 availability.status: reference_only 代表商品在目錄中但還沒 有已發布資料，不是錯誤。

每個 instrument 有：

  • instrument_id：穩定、永不重用；自己的表要用這個鍵；
  • symbol：查詢當時有效的公開代號；
  • kind、venue、product、currency、multiplier、tick_size；
  • 已知時有 listed_day、last_trading_day、expiry；
  • 股票與基金有 board（main、star、chinext、bse、fund）與 risk_warning（none、st、*st）；risk_warning_since 是 veinmesh 第一次觀察到目前狀態的日期（已知時）；
  • 基金有 fund_type（etf、lof、reit、other）與 tracking_board （main、star、chinext、bse、none）：tracking_board 是漲跌幅規則 適用的板別；none 表示沒有 A 股板別（債券、商品、QDII、貨幣或 REIT 基金）； 未知時不提供；
  • 選擇權有 underlying、strike、right、exercise_style；
  • combo 有 legs；
  • aliases 與其有效期間，容納交易所的特殊寫法。

risk_warning 取自交易所公布的簡稱；它變更時 catalog version 會跟著變。 股票與基金的 listed_day 來自經審閱的公開交易所快照；快照之後新上市的 商品在快照更新前會保持 listed_day: null。基金一律使用 fund 板別，包含 STAR 與創業板追蹤基金；漲跌幅規則請讀 tracking_board。深市基金以交易所 公布的 20% 漲跌幅基金名單為準：名單內是 star 或 chinext，其餘是 main（股票型，10%）或 none（債券、商品、QDII、貨幣或 REIT，10%）。

代號依日期解析。同一天一個拼法對到兩個 instrument 時回 ambiguous_symbol （409）；請用完整代號或 instrument_id。見代號。

連續合約​

GET /v2/catalog/continuous 列出每個期貨商品在指定交易日的現行 .main 合約；GET /v2/catalog/continuous/{symbol} 解析單一 SHFE.rb.main 或 .cN。回應帶連續 symbol、product、實際 contract 與該合約的 instrument_id。虛擬連續代號不會列在 GET /v2/catalog/instruments 的 instrument 清單裡。

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/continuous?product=SHFE.rb"

分頁​

Instrument 清單分頁。把回應的 next_cursor 當成 cursor 傳回；null 代表 結束。cursor 只屬於產生它的篩選條件。

資料集與已準備的交易日​

GET /v2/catalog/datasets 列出每個資料集的解析度、盤口檔數、快照間隔，以及 該交易所已準備的交易日。

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/datasets?venue=SHFE" \
  | jq '.datasets[] | {dataset, first_day, last_day, depth, resolution}'

first_day 與 last_day 是已發布範圍，不是資料源最早日期。範圍外的交易日 仍可能在查詢時被抓取；見資料範圍。

日曆​

GET /v2/catalog/calendar 回傳區間內每個交易日與其 UTC 時段。要給交易所， 通常也要給商品：同一交易所的不同商品可能有不同時段樣板。

curl -s -H "Authorization: Bearer $VEINMESH_API_KEY" \
  "https://data.cyberun.cloud/v2/catalog/calendar?venue=SHFE&product=SHFE.rb&from_day=2026-10-19&to_day=2026-10-23" \
  | jq '.days[] | {trading_day, sessions}'

時段標籤是交易所的。night 時段從前一個日曆日開始，屬於回應中的交易日。不要 假設標籤或固定集合；見核心概念。

日曆請求有區間上限，見限制；更長的區間請分次查。