跳转至

商品檔

商品檔將在很多地方被使用，例如下單、訂閱行情...等。

商品檔每日於以下時間更新，請留意下載時機。

商品檔更新資訊

  • 07:50 期貨商品檔更新
  • 08:00 全市場商品檔更新
  • 14:45 期貨夜盤商品檔更新
  • 17:15 期貨夜盤商品檔更新

取得商品檔

下方提供兩種方法取得商品檔：

方法 1

登入成功後，將開始下載商品檔。但這個下載過程將不會影響其他的操作。若您想了解是否下載完成，可利用Contracts.status去得到下載狀態。contracts_timeout 設定為10000，它將等待10秒下載商品檔。

In

import shioaji as sj
api = sj.Shioaji()
api.login(
    api_key="YOUR_API_KEY",
    secret_key="YOUR_SECRET_KEY",
    contracts_timeout=10000,
)

方法 2

若不想在登入時下載商品檔，將fetch_contract 設定為False。利用 fetch_contracts 下載商品檔

In

import shioaji as sj
api = sj.Shioaji()
api.login(
    api_key="YOUR_API_KEY",
    secret_key="YOUR_SECRET_KEY",
    fetch_contract=False,
)
api.fetch_contracts(contract_download=True)

商品檔由 server 在 shioaji server start 啟動時自動完成載入（詳見登入頁面的 server 啟動 log），使用者無須額外操作。

商品檔資訊

目前我們所提供台股市場的商品包含：證券、期貨、選擇權以及指數。可從下列方法更詳細得到我們所提供的商品。

Contract

security_type (str): 商品類型 {STK, FUT, OPT, IND}
exchange (str): 交易所
code (str): 商品代碼
symbol (str): 符號
name (str): 商品名稱
category (str): 類別
currency (str): 計價幣別
delivery_month (str): 交割月份 (FUT/OPT)
delivery_date (str): 結算日 (FUT/OPT)
strike_price (float): 履約價 (OPT)
option_right (str): 買賣權別 (OPT)
underlying_kind (str): 標的類型 (FUT/OPT)
underlying_code (str): 標的商品代碼 (OPT)
unit (float): 單位
multiplier (int): 契約乘數 (FUT/OPT)
limit_up (float): 漲停價
limit_down (float): 跌停價
reference (float): 參考價
update_date (str): 更新日期
margin_trading_balance (int): 融資餘額 (STK)
short_selling_balance (int): 融券餘額 (STK)
day_trade (str): 可否當沖 {Yes, No, OnlyBuy} (STK)
target_code (str): 對應實際商品代碼，僅連續月（如 TXFR1/R2）才有值 (FUT)
  • 未使用的欄位為空字串或 0
  • Python 的 SDK 物件 repr 中，值為 0 的欄位會被省略

查詢所有商品檔

In

api.Contracts

Out

Contracts(Indexs=(OTC, TAIFEX, TSE), Stocks=(OES, OTC, TSE), Futures=(BRF, BTF, CAF, CBF, CCF, CDF, CEF, CFF, CGF, CHF, CJF, CKF, CLF, CMF, CNF, CQF, CRF, CSF, CUF, CWF, CXF, CYF, CZF, DAF, DBF, DCF, DE1, DEF, DFF, DGF, DHF, DIF, DJF, DKF, DLF, DNF, DOF, DPF, DQF, DSF, DVF, DWF, DXF, DYF, DZF, E4F, ECF, ECI, ECL, EEF, EGF, EHF, EKF, EMF, EOF, EPF, ESF, ESI, ESL, EXF, EYF, EZF, F1F, FBF, FCF, FEF, FFF, FGF, FKF, FNF, FQF, FRF, FSF, FTF, FVF, FWF, FXF, FYF, FZF, G2F, GAF, GCF, GDF, GHF, GIF, GJF, GKF, GLF, GMF, GNF, GOF, GRF, GTF, GUF, GVF, GWF, GXF, GYF, GZF, HA1, HAF, HBF, HCF, HH1, HHF, HIF, HL1, HLF, HOF, HQF, HSF, IAF, IHF, IIF, IJF, IMF, IOF, IPF, IQF, IR1, IRF, ITF, IX1, IXF, IYF, IZF, JBF, JFF, JMF, JNF, JPF, JSF, JW1, JWF, JXF, JZF, KAF, KBF, KCF, KDF, KEF, KFF, KGF, KIF, KKF, KLF, KOF, KPF, KSF, KUF, KWF, LBF, LCF, LEF, LIF, LMF, LOF, LQF, LRF, LTF, LUF, LVF, LWF, LXF, LYF, M1F, MBF, MJF, MKF, MQF, MVF, MX4, MXF, MYF, NAF, NBF, NCF, NDF, NEF, NGF, NIF, NJF, NKF, NKI, NKL, NLF, NMF, NOF, NQF, NSF, NUF, NVF, NWF, NYF, OAF, OBF, ODF, OEF, OHF, OJF, OKF, OLF, OMF, OOF, OPF, OQF, ORF, OSF, OTF, OUF, OVF, OWF, OXF, OYF, OZF, PAF, PBF, PCF, PDF, PEF, PFF, PGF, PHF, PIF, PJF, PKF, PL1, PLF, PMF, PNF, PPF, PQF, PRF, PSF, PTF, PUF, PVF, PWF, PXF, PYF, PZF, QAF, QBF, QCF, QDF, QEF, QFF, QGF, QHF, QIF, QJF, QKF, QLF, QMF, QNF, QOF, QPF, QQF, QRF, QSF, QTF, QUF, QV1, QVF, QWF, QXF, QYF, QZF, RAF, RBF, RCF, RDF, REF, RFF, RGF, RHF, RIF, RJF, RKF, RLF, RNF, ROF, RPF, RRF, RSF, RTF, RUF, RVF, RWF, RXF, RYF, RZF, SAF, SBF, SCF, SDF, SEF, SFF, SGF, SHF, SIF, SJF, SKF, SLF, SMF, SNF, SOF, SPF, SQF, SRF, SSF, SUF, SVF, SWF, SXF, SYF, SZF, TGF, TJF, TMF, TWN, TXF, UAF, UBF, UCF, UDF, UEF, UFF, UGF, UHF, UIF, UJF, UKF, ULF, UMF, UNF, UOF, UPF, UQF, URF, USF, UTF, UUF, UVF, UWF, UXF, UYF, UZF, VAF, VBF, VCF, VDF, VEF, VFF, VGF, VHF, VIF, VJF, VKF, XAF, XBF, XEF, XIF, XJF, YMF, YMI, YML, ZEF, ZFF), Options=(CAO, CBO, CCO, CDA, CDO, CEO, CFO, CGO, CHO, CKO, CMO, CNO, CSO, CZO, DFO, DGO, DHO, DJO, DKO, DQO, DSO, DVO, DXO, GIO, GXO, HCO, HSO, IJO, IRO, NYO, OAO, OBO, OJO, OKO, OOO, OZO, TEO, TFO, TGO, TX4, TXO, TXX, TXY), status=<FetchStatus.Fetched: 'Fetched'>)

請見下方各分類小節（證券 / 期貨 / 選擇權 / 指數）。

查詢單一商品檔

透過 api.Contracts 的分類存取單一商品檔，回傳對應的 SDK 物件（Stock / Future / Option / Index）。

證券

In

api.Contracts.Stocks["2330"]
# 或 api.Contracts.Stocks.TSE.TSE2330

Out

Stock(
    exchange=<Exchange.TSE: 'TSE'>,
    code='2330',
    symbol='TSE2330',
    name='台積電',
    category='24',
    unit=1000.0,
    limit_up=2440.0,
    limit_down=2000.0,
    reference=2220.0,
    update_date='2026/05/14',
    margin_trading_balance=167,
    day_trade=<DayTrade.Yes: 'Yes'>,
)

期貨

In

api.Contracts.Futures["TXFR1"]
# 或 api.Contracts.Futures.TXF.TXFR1

Out

Future(
    code='TXFR1',
    symbol='TXFR1',
    name='臺股期貨近月',
    category='TXF',
    delivery_month='202605',
    delivery_date='2026/05/20',
    underlying_kind='I',
    unit=1.0,
    limit_up=45799.0,
    limit_down=37473.0,
    reference=41636.0,
    update_date='2026/05/15',
    target_code='TXFE6',
)

選擇權

In

api.Contracts.Options["TXO20260532400C"]

Out

Option(
    code='TXO32400E6',
    symbol='TXO20260532400C',
    name='臺指選擇權F505月 32400C',
    category='TXO',
    delivery_month='202605',
    delivery_date='2026/05/20',
    strike_price=32400.0,
    option_right=<OptionRight.Call: 'C'>,
    underlying_kind='I',
    unit=1.0,
    limit_up=13400.0,
    limit_down=5060.0,
    reference=9230.0,
    update_date='2026/05/15',
)

指數

In

api.Contracts.Indexs.TSE["001"]
# 或 api.Contracts.Indexs.TSE.TSE001

Out

Index(
    exchange=<Exchange.TSE: 'TSE'>,
    code='001',
    symbol='TSE001',
    name='加權指數',
)

shioaji CLI 沒有查詢商品檔的命令，請使用 Python 或 HTTP API。

使用 curl 對 server 發送 GET 請求，取得單一商品檔。

  • URL 格式：/api/v1/data/contracts/{code}?security_type=<TYPE>
  • {code}：商品代碼
  • security_type：商品類型（STK / FUT / OPT / IND）

證券

In

curl "http://localhost:8080/api/v1/data/contracts/2330?security_type=STK"

Out

{"security_type":"STK","exchange":"TSE","code":"2330","symbol":"TSE2330","name":"台積電","category":"24","currency":"TWD","delivery_month":"","delivery_date":"","strike_price":0.0,"option_right":"","underlying_kind":"","underlying_code":"","unit":1000.0,"multiplier":0,"limit_up":2440.0,"limit_down":2000.0,"reference":2220.0,"update_date":"2026/05/14","margin_trading_balance":167,"short_selling_balance":0,"day_trade":"Yes","target_code":""}

期貨

In

curl "http://localhost:8080/api/v1/data/contracts/TXFR1?security_type=FUT"

Out

{"security_type":"FUT","exchange":"TAIFEX","code":"TXFR1","symbol":"TXFR1","name":"臺股期貨近月","category":"TXF","currency":"TWD","delivery_month":"202605","delivery_date":"2026/05/20","strike_price":0.0,"option_right":"","underlying_kind":"I","underlying_code":"","unit":1.0,"multiplier":0,"limit_up":45799.0,"limit_down":37473.0,"reference":41636.0,"update_date":"2026/05/15","margin_trading_balance":0,"short_selling_balance":0,"day_trade":"","target_code":"TXFE6"}

選擇權

In

curl "http://localhost:8080/api/v1/data/contracts/TXO20260532400C?security_type=OPT"

Out

{"security_type":"OPT","exchange":"TAIFEX","code":"TXO32400E6","symbol":"TXO20260532400C","name":"臺指選擇權F505月 32400C","category":"TXO","currency":"TWD","delivery_month":"202605","delivery_date":"2026/05/20","strike_price":32400.0,"option_right":"C","underlying_kind":"I","underlying_code":"","unit":1.0,"multiplier":0,"limit_up":13400.0,"limit_down":5060.0,"reference":9230.0,"update_date":"2026/05/15","margin_trading_balance":0,"short_selling_balance":0,"day_trade":"","target_code":""}

指數

In

curl "http://localhost:8080/api/v1/data/contracts/001?security_type=IND"

Out

{"security_type":"IND","exchange":"TSE","code":"001","symbol":"TSE001","name":"加權指數","category":"","currency":"TWD","delivery_month":"","delivery_date":"","strike_price":0.0,"option_right":"","underlying_kind":"","underlying_code":"","unit":0.0,"multiplier":0,"limit_up":0.0,"limit_down":0.0,"reference":0.0,"update_date":"","margin_trading_balance":0,"short_selling_balance":0,"day_trade":"","target_code":""}