Ready to supercharge your AI agents?

Install any skill in seconds. Free to start, no credit card required.

Shioaji Trading API · nicepkg | DecimalAI

nicepkg/shioaji

SkillScore91Maintained

Shioaji Taiwan financial trading API guide. Use when trading stocks/futures/options on Taiwan markets, subscribing to real-time market data, querying account info, or building automated trading systems. Shioaji 台灣金融交易 API 指南。適用於：股票/期貨/選擇權交易、即時行情訂閱、帳務查詢、自動交易系統開發。

financeby nicepkg

Links this skill to your agents and keeps it current with the author’s updates.

Automatic

Coding pack

1 · One-time — install the CLI (docs ↗)

pip install decimalai

2 · Get the skill — writes .claude/skills/nicepkg-shioaji/SKILL.md

decimalai skills pull nicepkg-shioaji --out .claude/skills/

No CLI? Get the same file — curl · raw file

curl -fsSL --create-dirs -o .claude/skills/nicepkg-shioaji/SKILL.md https://app.decimal.ai/s/nicepkg-shioaji/SKILL.md

Raw file: /s/nicepkg-shioaji/SKILL.md ↗ · machine-readable summary at /s/nicepkg-shioaji.json ↗

In productionGlobal

how this skill behaves on real traffic · last 30 days

No production data for this skill yet — usage numbers appear here once agents start running it.

Anonymized aggregate across every org using this skill — proof from real production use, not a demo.

Does this skill help? · Benchmark: with vs. withoutsign in to run this on your agents

22 test cases from the publisher’s eval.yaml · each run twice on gemini-3.6-flash — with the skill injected, then without · last run 5d ago

Yes — +45% lift · at higher cost+68% tokens0% turns91% of whole cases pass with skill (20/22)

Test case	Without → With	Effect	Δ tokens	Δ turns
case-02	✗→✓	▲ Improved	92%	0%
case-07	✗→✓	▲ Improved	32%	0%
case-05	✗→✓	▲ Improved	93%	0%
case-06	✗→✓	▲ Improved	22%	0%
case-09	✗→✓	▲ Improved	49%	0%

Showing 5 of 22 cases

SkillSafety

✓ 3 of 3 passed

Code scan15 of 15 checks clean

0 critical · 0 warning · 0 info — scanner v4 — 8/3/2026

live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing

IntentSafe

LLM judge · does the skill do what it claims

ContentClean

LLM judge · policy & harmful-content review

Source

Imported

nicepkg / ai-workflow

workflows/stock-trader-workflow/.claude/skills/shioaji/SKILL.md

View on GitHub ↗

License MITImported 8/3/2026Version v1

Skill contents

SKILL.md

Shioaji Trading API

Shioaji is SinoPac's Python API for trading Taiwan financial markets (stocks, futures, options). Shioaji 是永豐金證券提供的 Python 交易 API，支援台灣股票、期貨、選擇權市場。

Official Docs 官方文檔: https://sinotrade.github.io/ LLM Reference: https://sinotrade.github.io/llms-full.txt

Navigation 功能導覽

| Topic 主題 | File 檔案 | Description 說明 | |------------|-----------|------------------| | Preparation 準備 | PREPARE.md | Account setup, API keys, testing 開戶/金鑰申請/測試 | | Contracts 合約 | CONTRACTS.md | Stocks, Futures, Options contracts 股票/期貨/選擇權合約 | | Orders 下單 | ORDERS.md | Place, modify, cancel, combo orders 下單/改單/刪單/組合單 | | Reserve 預收 | RESERVE.md | Reserve orders for disposition stocks 處置股預收券款 | | Streaming 行情 | STREAMING.md | Real-time tick & bidask data 即時 Tick/BidAsk 資料 | | Market Data 市場資料 | MARKET_DATA.md | Historical, snapshot, credit, scanners 歷史資料/快照/資券/掃描器 | | Accounting 帳務 | ACCOUNTING.md | Balance, margin, P&L, trading limits 餘額/保證金/損益/額度 | | Advanced 進階 | ADVANCED.md | Quote binding, non-blocking, stop orders 報價綁定/非阻塞/觸價 | | Troubleshooting 問題排解 | TROUBLESHOOTING.md | Common issues and solutions 常見問題與解決 |

Quick Start 快速入門

Installation 安裝

bash
# pip
pip install shioaji

# uv (recommended 推薦)
uv add shioaji

# with speed optimization 速度優化版
uv add shioaji --extra speed

# Docker
docker run -it sinotrade/shioaji:latest

Login & Activate CA 登入與憑證啟用

python
import shioaji as sj

api = sj.Shioaji()

# Login with API Key 使用 API Key 登入
accounts = api.login(
    api_key="YOUR_API_KEY",
    secret_key="YOUR_SECRET_KEY"
)

# Activate CA certificate 啟用憑證 (required for placing orders 下單必須)
api.activate_ca(
    ca_path="/path/to/Sinopac.pfx",
    ca_passwd="YOUR_CA_PASSWORD",
)

Simulation Mode 模擬模式

Test API without real money. 使用模擬環境測試 API。

python
import shioaji as sj

api = sj.Shioaji(simulation=True)
api.login(api_key="YOUR_KEY", secret_key="YOUR_SECRET")

Available in simulation 模擬模式可用功能:

Quote: subscribe, unsubscribe, ticks, kbars, snapshots
Order: place_order, update_order, cancel_order, update_status, list_trades
Account: list_positions, list_profit_loss
Data: short_stock_sources, credit_enquires, scanners

Simple Order Example 簡單下單範例

python
# Get contract 取得合約
contract = api.Contracts.Stocks["2330"]  # TSMC 台積電

# Create order 建立訂單
order = api.Order(
    price=580,
    quantity=1,
    action=sj.constant.Action.Buy,
    price_type=sj.constant.StockPriceType.LMT,
    order_type=sj.constant.OrderType.ROD,
    account=api.stock_account,
)

# Place order 下單
trade = api.place_order(contract, order)

Common Constants 常用常數

Action 買賣方向

python
sj.constant.Action.Buy   # 買進
sj.constant.Action.Sell  # 賣出

Stock Price Type 股票價格類型

python
sj.constant.StockPriceType.LMT  # Limit 限價
sj.constant.StockPriceType.MKT  # Market 市價
sj.constant.StockPriceType.MKP  # Range Market 範圍市價

Futures Price Type 期貨價格類型

python
sj.constant.FuturesPriceType.LMT  # Limit 限價
sj.constant.FuturesPriceType.MKT  # Market 市價
sj.constant.FuturesPriceType.MKP  # Range Market 範圍市價

Order Type 委託條件

python
sj.constant.OrderType.ROD  # Rest of Day 當日有效
sj.constant.OrderType.IOC  # Immediate or Cancel 立即成交否則取消
sj.constant.OrderType.FOK  # Fill or Kill 全部成交否則取消

Stock Order Lot 股票交易單位

python
sj.constant.StockOrderLot.Common      # Regular 整股 (1000 shares)
sj.constant.StockOrderLot.Odd         # After-hours odd lot 盤後零股
sj.constant.StockOrderLot.IntradayOdd # Intraday odd lot 盤中零股
sj.constant.StockOrderLot.Fixing      # Fixing 定盤

Order Condition 信用交易條件

python
sj.constant.StockOrderCond.Cash          # Cash 現股
sj.constant.StockOrderCond.MarginTrading # Margin 融資
sj.constant.StockOrderCond.ShortSelling  # Short 融券

Quote Type 報價類型

python
sj.constant.QuoteType.Tick    # Tick data 逐筆成交
sj.constant.QuoteType.BidAsk  # Bid/Ask data 五檔報價

Account Objects 帳戶物件

python
# Stock account 股票帳戶
api.stock_account

# Futures account 期貨帳戶
api.futopt_account

# List all accounts 列出所有帳戶
api.list_accounts()

Rate Limits 流量限制

| Category 類別 | Limit 限制 | |---------------|------------| | Daily Traffic 每日流量 | 500MB - 10GB (based on trading volume 依交易量) | | Quote Query 行情查詢 | 50 requests / 5 sec | | Accounting Query 帳務查詢 | 25 requests / 5 sec | | Connections 連線數 | 5 per person ID | | Daily Logins 每日登入 | 1000 times |

Common Patterns 常用模式

Subscribe Market Data 訂閱行情

python
# Subscribe tick data 訂閱逐筆成交
api.quote.subscribe(
    api.Contracts.Stocks["2330"],
    quote_type=sj.constant.QuoteType.Tick
)

# Subscribe bidask 訂閱五檔
api.quote.subscribe(
    api.Contracts.Stocks["2330"],
    quote_type=sj.constant.QuoteType.BidAsk
)

# Set callback 設定回調
@api.quote.on_quote
def quote_callback(topic, quote):
    print(f"Topic: {topic}, Quote: {quote}")

Query Positions 查詢持倉

python
# Stock positions 股票持倉
positions = api.list_positions(api.stock_account)

# Futures positions 期貨持倉
positions = api.list_positions(api.futopt_account)

Cancel Order 刪單

python
api.cancel_order(trade)

Update Order 改單

python
# Change price 改價
api.update_order(trade=trade, price=590)

# Reduce quantity 減量 (can only reduce 只能減少)
api.update_order(trade=trade, qty=1)

Error Handling 錯誤處理

python
try:
    trade = api.place_order(contract, order)
except Exception as e:
    print(f"Order failed: {e}")

# Check order status 檢查訂單狀態
api.update_status(api.stock_account)
for trade in api.list_trades():
    print(trade.status)

Logout 登出

python
api.logout()

Want to see if nicepkg/shioaji would activate on your phrasing? Try it before you install — no LLM call, no signup.

Latest benchmark · publisher runVerified

8/24/2026, 12:49 UTC · 22 cases

Lift

+45%

91% vs 45%

Agent turns

1.0 vs 1.0

Tokens

+68%

2,972.59 vs 1,774.5

fail → pass · 11pass → pass · 9fail → fail · 1pass → fail · 1

Per-case results (22)

Case	Status	Duration (ms)			Turns			Tokens			Tool calls
Case	Status	Without	With	Δ	Without	With	Δ	Without	With	Δ	Without	With	Δ
case-01 I want to write a Python script using the SinoPac Shioaji library to test order placement without risking real funds. Could you provide a complete Python code snippet that initializes the API in sandbox mode, logs in, selects the contract for TSMC (ticker 2330), creates a standard limit buy order for 1 full lot with daily validity, and submits the order? Please include comments explaining each step of the order construction.	pass→pass	15,645	12,890	-18%	1	1	0%	2,884	4,267	+48%	0	0	—
case-02 Could you give me a code example using Shioaji to stream live tick data for Taiwan stocks? I need a script that connects to the session, subscribes to real-time tick-by-tick updates for stock symbol 2330, and registers a callback decorator or handler function to print out quote updates whenever new tick data arrives. Please format the output as a ready-to-run Python script with necessary imports.	fail→pass	10,000	9,495	-5%	1	1	0%	2,013	3,870	+92%	0	0	—
case-07 I want to enter a short position (融券) for a Taiwan equity trade. Which constant value should be assigned to the order condition parameter?	fail→pass	12,577	3,448	-73%	1	1	0%	1,953	2,575	+32%	0	0	—
case-03 I am setting up automated stock order execution for Taiwan securities in my SinoPac account script. After calling api.login with my API key and secret key, I try to submit an order but receive an authentication exception stating certificate not activated. How should I initialize the PKCS#12 certificate file (.pfx) in Python before placing live trades? Provide the code snippet.	pass→pass	9,572	6,179	-35%	1	1	0%	1,627	3,211	+97%	0	0	—
case-04 In my trading bot for Taiwan equities, I need to fetch the contract object for MediaTek (symbol 2454) to place a trade. Many general trading frameworks use contract searching methods like api.get_contract("2454") or api.search("2454"). What is the exact contract access syntax for looking up a stock by its ticker in Shioaji?	pass→pass	8,784	4,736	-46%	1	1	0%	1,486	2,829	+90%	0	0	—
case-05 I want to place an intraday odd lot order for 50 shares of TSMC (2330) using Shioaji. Standard trading usually defaults to regular 1000-share lots. Which constant field should I pass to specify intraday odd lot trading when constructing the Order object?	fail→pass	8,596	6,274	-27%	1	1	0%	1,629	3,138	+93%	0	0	—
case-06 I need to submit a Taiwan stock purchase order using financing/margin trading (融資) instead of cash settlement. How do I specify this credit trading condition when instantiating the Order object?	fail→pass	14,491	5,077	-65%	1	1	0%	2,390	2,906	+22%	0	0	—
case-08 When building an order for Taiwan Index Futures (TXF), I need to set the price type to limit price. Some traders mistakenly use StockPriceType.LMT for futures orders. What is the correct futures price type constant?	pass→pass	8,224	3,342	-59%	1	1	0%	1,414	2,631	+86%	0	0	—
case-09 I have an active trade object returned from placing an order that I need to cancel immediately due to changing market conditions. What API method should be called, and what argument does it take?	fail→pass	9,934	3,999	-60%	1	1	0%	1,772	2,635	+49%	0	0	—
case-10 My algorithm needs to adjust an open order's limit price to 600 TWD and lower its quantity to 1 unit. Can I increase the quantity with this update, and what method and parameters perform this modification?	pass→pass	12,822	6,769	-47%	1	1	0%	2,157	3,231	+50%	0	0	—
case-11 Instead of individual tick executions, I want to subscribe to real-time 5-level order book depth (bid/ask quotes) for stock symbol 2330. What parameter value should be passed to api.quote.subscribe?	pass→pass	6,111	4,242	-31%	1	1	0%	1,098	2,779	+153%	0	0	—
case-16 Which order type constant should be used for an order where any portion that can be filled immediately is executed, and any remaining unfilled portion is canceled right away (IOC)?	fail→pass	5,104	2,244	-56%	1	1	0%	778	2,429	+212%	0	0	—
case-12 I want to query current open stock positions for my SinoPac trading account and print them. How do I retrieve stock positions specifically, ensuring I pass the correct account object?	pass→pass	11,543	4,988	-57%	1	1	0%	1,999	2,950	+48%	0	0	—
case-13 How do I retrieve current open positions for Taiwan futures and options from my account object?	fail→pass	13,014	6,552	-50%	1	1	0%	2,123	3,136	+48%	0	0	—
case-14 After submitting several stock orders, my script needs to refresh order status from the exchange and iterate over all current trades to print their status. Which two methods should be called in sequence?	fail→pass	10,169	3,236	-68%	1	1	0%	1,638	2,573	+57%	0	0	—
case-15 I need to issue an urgent order for Taiwan stocks that must either be filled in its entirety immediately or completely cancelled (FOK). What order type constant should I assign?	fail→pass	10,330	4,465	-57%	1	1	0%	1,606	2,814	+75%	0	0	—
case-17 I am placing a market order with protection (range market price / 範圍市價) for a stock order to prevent execution at extreme slippage. What constant should be used for the price type?	fail→pass	10,778	3,210	-70%	1	1	0%	1,723	2,580	+50%	0	0	—
case-18 What is the standard method call to gracefully disconnect and log out from an active Shioaji API session at the end of a trading script?	pass→pass	3,668	2,775	-24%	1	1	0%	517	2,427	+369%	0	0	—
case-19 I am designing a high-frequency polling script for market data and account balance checks. What are the rate limits enforced by SinoPac Shioaji for Quote queries and Accounting queries over 5-second windows?	fail→pass	16,245	4,571	-72%	1	1	0%	2,649	2,739	+3%	0	0	—
case-20 I want to retrieve daily historical price candles (K-lines) for TSMC (symbol 2330) between two dates in Python for my Taiwan trading bot. Which Shioaji API method fetches this historical K-line data?	fail→fail	10,822	5,365	-50%	1	1	0%	2,010	3,005	+50%	0	0	—
case-21 In Taiwan stock trading, funds are settled on a T+2 basis. I need to query the upcoming settlement amounts for my stock trading account using Shioaji. What API method retrieves this settlement data?	pass→pass	8,812	6,998	-21%	1	1	0%	1,492	3,233	+117%	0	0	—
case-22 Before placing a margin purchase or short sale order using Shioaji, I want to programmatically check my remaining credit limit and available margin quota. What API method performs this credit enquiry?	pass→fail	11,653	7,684	-34%	1	1	0%	2,081	3,439	+65%	0	0	—

These cases were also screened by the skill’s intent / safety pass.See the Trust review ↗Reproduce this benchmark in Colab ↗

How this skill was measured

DecimalAI ran this skill against gemini-3.6-flash twice over the same eval suite — once with the skill loaded and once without — and compared the two runs case by case. 22 cases were attempted. The headline lift of +45 percentage points is the difference between those two pass rates over the 22 comparable cases. 1 case got worse with the skill loaded, and it is included in that figure.

Model measured: gemini-3.6-flash
Graded by: gemini-3.6-flash
Grading method: judged
Verification: verified
Pass rate without the skill: 45.5%
Pass rate with the skill: 90.9%
Cases attempted: 22
Cases counted toward lift: 22
Cases that regressed: 1
Skill version measured: v1
Run completed: 8/24/2026, 12:49 UTC

Measured example — same prompt, with vs. without the skill · from the benchmark run · case case-02

Prompt

Could you give me a code example using Shioaji to stream live tick data for Taiwan stocks? I need a script that connects to the session, subscribes to real-time tick-by-tick updates for stock symbol 2330, and registers a callback decorator or handler function to print out quote updates whenever new tick data arrives. Please format the output as a ready-to-run Python script with necessary imports.

Without the skill loaded, the model failed this case. With it loaded, the same prompt on the same model passed. This is one improved case from the latest verified run; every case, including any that regressed, is in the table above.

Show both answers

SkillScore blends 4 signals1 of 4 complete

BenchmarkPass rate WITH skill on a verified run91

Live evalNeeds ≥20 evaluated traces in 30 days

AI ratingNeeds ≥10 rated traces

AdoptionNeeds ≥10 serves across ≥2 orgs in 30 days

Efficiency · separate axis (at equal correctness)+0% turns+88% tokens

Shown for transparency; not credited unless a verified run shows no correctness regression.

Backed by 1 of 4 signals — each added signal makes the score more robust.

Verified on gemini-3.6-flash · re-tested 4 days ago

Other measured skills in the registry, with their headline benchmark lift.