Sinotrade/Shioaji

"owner": {     "name": "Sinotrade",     "url": "https://github.com/Sinotrade"

"name": "Sinotrade",     "url": "https://github.com/Sinotrade"   },

"url": "https://github.com/Sinotrade"

"author": {     "name": "Sinotrade",     "url": "https://github.com/Sinotrade"

"name": "Sinotrade",     "url": "https://github.com/Sinotrade"   },

"url": "https://github.com/Sinotrade"

},   "homepage": "https://sinotrade.github.io/",   "repository": "https://github.com/Sinotrade/Shioaji",

"homepage": "https://sinotrade.github.io/",

"repository": "https://github.com/Sinotrade/Shioaji",

- Before the user answers the first onboarding question, do not run commands, inspect files, mention Python versions, mention existing projects, or discuss local environments. The first step is not "check the folder"; it is "check whether t

- The first substantive response must check the basic gates before any technical setup: SinoPac securities/futures account, desired market access (stock / futures-options / both), API key/secret, direct API agreement signing, simulation log

- Onboarding order matters: after account opening, confirm/create API Key and Secret Key at `https://www.sinotrade.com.tw/newweb/PythonAPIKey/`; signing pages do not issue API keys. After signing, do not jump straight to CA; confirm API cre

- When presenting onboarding steps as a table/list, write the explicit correct URL for each web step. Never use the generic SinoPac home page as the account-opening URL. Open account uses `https://www.sinotrade.com.tw/openact?strProd=0254&s

- Do **not** move into installation, project setup, `.env`, `.venv`, `uv sync`, code examples, local file inspection, or order examples until the user confirms the relevant onboarding gates are done or explicitly asks for that technical ste

- For signing, give the direct product page, not the generic signing center: stock <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/>; futures/options <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/>.

Source 來源：[Shioaji 使用限制](https://sinotrade.github.io/zh/tutor/limit/)

- [TWSE 集中市場交易制度介紹](https://www.twse.com.tw/zh/products/system/trading.html)

- [TPEx 盤中全面逐筆交易專區](https://www.tpex.org.tw/zh-tw/mainboard/trading/rules/continuous.html)

- [TAIFEX 委託單種介紹](https://www.taifex.com.tw/cht/4/oamIntroduction)

[Credential-related source omitted]

curl -X POST http://localhost:8080/api/v1/portfolio/account_balance \

curl -X POST http://localhost:8080/api/v1/portfolio/margin \

# Common positions 整股持倉 curl -X POST http://localhost:8080/api/v1/portfolio/position_unit \

curl -X POST http://localhost:8080/api/v1/portfolio/position_unit \

# Odd lot positions 零股持倉 curl -X POST http://localhost:8080/api/v1/portfolio/position_unit \

curl -X POST http://localhost:8080/api/v1/portfolio/position_unit \

curl -X POST http://localhost:8080/api/v1/portfolio/position_detail \

curl -X POST http://localhost:8080/api/v1/portfolio/profit_loss \

curl -X POST http://localhost:8080/api/v1/portfolio/profit_loss_detail \

curl -X POST http://localhost:8080/api/v1/portfolio/profitloss_sum \

# Legacy format (single object) 舊格式（單一物件） curl -X POST http://localhost:8080/api/v1/portfolio/settlement \

curl -X POST http://localhost:8080/api/v1/portfolio/settlement \

# New format (list) 新格式（列表） curl -X POST http://localhost:8080/api/v1/portfolio/settlements \

curl -X POST http://localhost:8080/api/v1/portfolio/settlements \

curl -X POST http://localhost:8080/api/v1/portfolio/trading_limits \

[Credential-related source omitted]

[Credential-related source omitted]

# Subscribe first 先訂閱 curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# Listen to SSE stream 監聽 SSE 串流 curl -N http://localhost:8080/api/v1/stream/data/tick_stk

curl -N http://localhost:8080/api/v1/stream/data/tick_stk

## Disabled by default. Confirm simulation/production mode, account, ## payload, response status, and order-event handling in ORDERS.md before enabling. # curl -X POST http://localhost:8080/api/v1/order/place_order \

## payload, response status, and order-event handling in ORDERS.md before enabling. # curl -X POST http://localhost:8080/api/v1/order/place_order \ #   -H "Content-Type: application/json" \

# curl -X POST http://localhost:8080/api/v1/order/place_order \

// JavaScript example — consume SSE stream // JavaScript 範例 — 消費 SSE 串流 const es = new EventSource("http://localhost:8080/api/v1/stream/data");

// JavaScript 範例 — 消費 SSE 串流 const es = new EventSource("http://localhost:8080/api/v1/stream/data"); es.addEventListener("tick_stk", (event) => {

const es = new EventSource("http://localhost:8080/api/v1/stream/data");

| --- | --- | --- | | macOS/Linux Unix socket | `SJ_AGENT_HARNESS_BROKER_SOCKET` | Broker verifies the CLI executable and its process ancestry | | Windows desktop localhost HTTP | `SJ_AGENT_HARNESS_BROKER_URL=http://127.0.0.1:<random>/v1/ex

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

| `SJ_TIMEOUT` | Solace request-reply timeout in milliseconds (default: 60000) | | `SJ_AGENT_HARNESS_BROKER_SOCKET` | Trusted Unix approval broker socket; preferred when both broker transports are present | | `SJ_AGENT_HARNESS_BROKER_URL` |

| `SJ_AGENT_HARNESS_BROKER_SOCKET` | Trusted Unix approval broker socket; preferred when both broker transports are present | | `SJ_AGENT_HARNESS_BROKER_URL` | Trusted loopback HTTP broker URL; must be exactly `http://localhost-or-loopback/

| `SJ_AGENT_HARNESS_BROKER_URL` | Trusted loopback HTTP broker URL; must be exactly `http://localhost-or-loopback/v1/exchange` |

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

# Managed form (recommended). The server validates the exchange strategy and # derives per-leg actions from order.action. Buy time spread = sell near, buy far. curl -X POST http://localhost:8080/api/v1/order/place_comboorder \

# derives per-leg actions from order.action. Buy time spread = sell near, buy far. curl -X POST http://localhost:8080/api/v1/order/place_comboorder \   -H "Content-Type: application/json" \

curl -X POST http://localhost:8080/api/v1/order/place_comboorder \

# Legacy directed form; retained for compatibility. curl -X POST http://localhost:8080/api/v1/order/place_comboorder \

curl -X POST http://localhost:8080/api/v1/order/place_comboorder \

- [TAIFEX order types and combo definitions](https://www.taifex.com.tw/cht/4/oamIntroduction)

- [TAIFEX TCP/IP TMP specification](https://www.taifex.com.tw/cht/8/techDocsDetails?idx=4), v2.18.8 dated 2026-07-06, especially sections 3.5.2–3.5.4 for option combo examples, futures time-spread encoding, BS1/BS2, and product/compound-pro

shioaji CLI ─┐ curl / SDK ──┤──HTTP/localhost──→  daemon (one trading core)  ──→ SinoPac backend

curl / SDK ──┤──HTTP/localhost──→  daemon (one trading core)  ──→ SinoPac backend

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

# Exact code; security_type is optional and can narrow ambiguous codes. curl "http://localhost:8080/api/v1/data/contracts/2330?region=TW&security_type=STK"

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

# Flat typed info; security_type is the OpenAPI discriminator. curl "http://localhost:8080/api/v1/data/contracts/2330/info?region=TW&security_type=STK"

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

# All STK bases, or a one-based page for a large UI. curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW"

curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW"

curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW&page=1&page_size=500"

# Shard-aware queries. curl "http://localhost:8080/api/v1/data/contracts/futures?root=TXF&region=TW"

curl "http://localhost:8080/api/v1/data/contracts/futures?root=TXF&region=TW"

curl "http://localhost:8080/api/v1/data/contracts/options?root=TXO&region=TW"

curl "http://localhost:8080/api/v1/data/contracts/warrants?underlying_code=2330&region=TW"

curl -N "http://localhost:8080/api/v1/stream/data/contract_event?region=TW&security_type=STK"

[Credential-related source omitted]

find_package(CURL REQUIRED)

/// Construct client for local server (no auth needed).     /// 建立本地伺服器用戶端（不需認證）。     explicit ShioajiClient(const std::string& base_url = "http://localhost:8080");

explicit ShioajiClient(const std::string& base_url = "http://localhost:8080");

[Credential-related source omitted]

// Disable copy (CURL handle is not copyable)

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

// GET /api/v1/auth/accounts auto client = shioaji::ShioajiClient("http://localhost:8080");

auto client = shioaji::ShioajiClient("http://localhost:8080");

CURL* curl = curl_easy_init();

if (!curl) { std::cerr << "curl init failed\n"; return 1; }

[Credential-related source omitted]

const std::string base = "http://localhost:8080";

[Credential-related source omitted]

auto client = shioaji::ShioajiClient(     "https://your-server.com",

"https://your-server.com",

[Credential-related source omitted]

# Download the spec curl -s http://localhost:8080/openapi.json -o openapi.json

curl -s http://localhost:8080/openapi.json -o openapi.json

# Generate C client with openapi-generator openapi-generator generate \   -i http://localhost:8080/openapi.json \

openapi-generator generate    -i http://localhost:8080/openapi.json

-i http://localhost:8080/openapi.json \

# Or use the C++ generator (experimental) openapi-generator generate \   -i http://localhost:8080/openapi.json \

openapi-generator generate    -i http://localhost:8080/openapi.json

-i http://localhost:8080/openapi.json \

# See the place_order request schema curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.requestBody.content["application/json"].schema'

curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.requestBody.content["application/json"].schema'

# List all schema definitions curl -s http://localhost:8080/openapi.json | jq '.components.schemas | keys[]'

curl -s http://localhost:8080/openapi.json | jq '.components.schemas | keys[]'

[Credential-related source omitted]

/// 建立本地伺服器用戶端（不需認證）。     /// </summary>     public ShioajiClient(string baseUrl = "http://localhost:8080")

/// </summary>     public ShioajiClient(string baseUrl = "http://localhost:8080")     {

public ShioajiClient(string baseUrl = "http://localhost:8080")

[Credential-related source omitted]

# Generate client (server must be running) / 產生用戶端（伺服器須執行中） nswag openapi2csclient \   /input:http://localhost:8080/openapi.json \

nswag openapi2csclient    /input:http://localhost:8080/openapi.json

/input:http://localhost:8080/openapi.json \

var apiClient = new ShioajiApiClient("http://localhost:8080", new HttpClient());

var baseUrl = "http://localhost:8080";

[Credential-related source omitted]

[Credential-related source omitted]

using var client = new ShioajiClient(     "https://your-server.com",

"https://your-server.com",

[Credential-related source omitted]

> 錯誤訊息文字可能隨伺服器版本微調，比對時抓關鍵字即可，不要求逐字相同。 > 第 2.2–2.5 節與第 3 節的訊息由後端或交易所回傳，不在 SDK 原始碼中；其中的交易所規則（如集合競價時段、STATUS 49）見 [SKILL.md](../SKILL.md) 交易規則來源。 > 處理方法分三類：**自行處理**（修正後即可重試）、**等待重試**（稍後再試，勿密集輪詢）、**聯絡永豐**（重試無效，請附完整錯誤訊息至客服群組詢問：[Telegram](https:/

> 處理方法分三類：**自行處理**（修正後即可重試）、**等待重試**（稍後再試，勿密集輪詢）、**聯絡永豐**（重試無效，請附完整錯誤訊息至客服群組詢問：[Telegram](https://t.me/joinchat/973EyAQlrfthZTk1) 或 [Discord](https://discord.gg/5nzmWCTnG7)）。

[Credential-related source omitted]

| Exception | 訊息 | 處理方法 | |---|---|---| | `CaExpiredError` | `Ca has expired!` | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）重新申請並下載憑證，再重新啟用，見 [PREPARE.md](PREPARE.md) |

|---|---|---| | `CaExpiredError` | `Ca has expired!` | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）重新申請並下載憑證，再重新啟用，見 [PREPARE.md](PREPARE.md) | | `CaPasswordError` | `Ca Password Incorrect` | 自行處理：確認 CA 密碼（預設為身分證字

| `CaExpiredError` | `Ca has expired!` | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）重新申請並下載憑證，再重新啟用，見 [PREPARE.md](PREPARE.md) |

| 401 | `Token is expired` | Token 已逾期（登入超過 24 小時），或觸發使用限制被踢退 | 自行處理：重新登入即可；若是超限被踢退，等 1 分鐘後再重登 | | 401 | `Could not validate credentials` | Token 無效（格式錯誤或環境不符） | 自行處理：重新登入；確認模擬／正式環境一致 | | 401 | `Token doesn't have permission` | API Key 權限未開

| 401 | `Could not validate credentials` | Token 無效（格式錯誤或環境不符） | 自行處理：重新登入；確認模擬／正式環境一致 | | 401 | `Token doesn't have permission` | API Key 權限未開放該功能 | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）確認並調整 API Key 的權限設定

| 401 | `Token doesn't have permission` | API Key 權限未開放該功能 | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）確認並調整 API Key 的權限設定 |

| 400 | `key: {key_id} not exist.` | API Key 不存在（打錯或已刪除） | 自行處理：核對 API Key；必要時至 API 管理頁重新申請 | | 400 | `key: {key_id} not match signature.` | Secret Key 錯誤（與 API Key 不成對） | 自行處理：核對金鑰；必要時至 API 管理頁重新產生 | | 400 | `{key_id} is expired.` | API Ke

| 400 | `key: {key_id} not match signature.` | Secret Key 錯誤（與 API Key 不成對） | 自行處理：核對金鑰；必要時至 API 管理頁重新產生 | | 400 | `{key_id} is expired.` | API Key 已過期 | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）重新申請 API Key | 

| 400 | `{key_id} is expired.` | API Key 已過期 | 自行處理：至新理財網 API 管理頁（<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>）重新申請 API Key |

| 400 | `Token doesn't have production permission.` | API Key 沒有正式環境權限 | 自行處理：至 API 管理頁確認權限；或先用模擬環境 | | 451 | `Too Many Connections.` | 同一 person_id 最多 5 條連線，每次 `api.login()` 都算一條；常見原因是程式結束前沒 `logout()` 或程式沒真正關掉 | 自行處理：每次用完呼叫 `api.logout()`

| 451 | `Too Many Connections.` | 同一 person_id 最多 5 條連線，每次 `api.login()` 都算一條；常見原因是程式結束前沒 `logout()` 或程式沒真正關掉 | 自行處理：每次用完呼叫 `api.logout()`；若都有登出仍發生，關閉殘留程式或重開機後再登入；見 [CONCEPTS.md](CONCEPTS.md) | | 400 | `Sign data is timeout.`（登入時出現） | 本機時間與

| 400 | `Sign data is timeout.`（登入時出現） | 本機時間與伺服器相差超過 receive_window（預設 30 秒） | 自行處理：先校準系統時間，見 [TROUBLESHOOTING.md](TROUBLESHOOTING.md) 登入簽章逾時與 <https://sinotrade.github.io/zh/tutor/login/#_1> |

[Credential-related source omitted]

2. **自行處理類**（參數錯、Token 過期、未帶 CA、未更新狀態、金鑰／權限設定）：修正後即可重試；金鑰與權限問題到新理財網 API 管理頁自行調整。 3. **等待重試類**（維護、忙線、`操作異常`）：等待後再試，不要密集輪詢——可能觸發封鎖。 4. **聯絡永豐類**（下單中台異常、風控、額度、簽署、被封鎖）：重試無效，請使用者附上完整錯誤訊息至客服群組（[Telegram](https://t.me/joinchat/973EyAQlrfthZTk1) 或 

4. **聯絡永豐類**（下單中台異常、風控、額度、簽署、被封鎖）：重試無效，請使用者附上完整錯誤訊息至客服群組（[Telegram](https://t.me/joinchat/973EyAQlrfthZTk1) 或 [Discord](https://discord.gg/5nzmWCTnG7)）詢問；額度與風控類也可洽所屬營業員。

[Credential-related source omitted]

伺服器預設在 `http://localhost:8080` 啟動。

The server starts at `http://localhost:8080` by default.

[Credential-related source omitted]

type Client struct { 	BaseURL    string 	HTTPClient *http.Client

BaseURL    string 	HTTPClient *http.Client 	apiKey     string

HTTPClient *http.Client

return &Client{ 		BaseURL:    baseURL, 		HTTPClient: &http.Client{},

[Credential-related source omitted]

HTTPClient: &http.Client{},

client := shioaji.NewClient("http://localhost:8080", "", "")

resp, err := http.Get("http://localhost:8080/api/v1/auth/accounts")

}) resp, _ := http.Post(     "http://localhost:8080/api/v1/data/snapshots",

resp, _ := http.Post(     "http://localhost:8080/api/v1/data/snapshots",     "application/json",

"http://localhost:8080/api/v1/data/snapshots",

resp, err := http.Get("http://localhost:8080/api/v1/stream/data/tick_stk")

# 產生 Go 客戶端 | Generate Go client oapi-codegen -package shioaji http://localhost:8080/openapi.json > pkg/shioaji/generated.go

oapi-codegen -package shioaji http://localhost:8080/openapi.json > pkg/shioaji/generated.go

# 只產生型別 | Types only oapi-codegen -generate types -package shioaji \   http://localhost:8080/openapi.json > pkg/shioaji/types_gen.go

oapi-codegen -generate types -package shioaji    http://localhost:8080/openapi.json > pkg/shioaji/types_gen.go

http://localhost:8080/openapi.json > pkg/shioaji/types_gen.go

# 只產生客戶端 | Client only oapi-codegen -generate client -package shioaji \   http://localhost:8080/openapi.json > pkg/shioaji/client_gen.go

oapi-codegen -generate client -package shioaji    http://localhost:8080/openapi.json > pkg/shioaji/client_gen.go

http://localhost:8080/openapi.json > pkg/shioaji/client_gen.go

// 初始化 | Initialize 	// ================================================================ 	client := shioaji.NewClient("http://localhost:8080", "", "")

client := shioaji.NewClient("http://localhost:8080", "", "")

**Base URL**: `http://127.0.0.1:8080` (default)

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

# Localhost -- no auth needed curl http://127.0.0.1:8080/api/v1/auth/accounts

curl http://127.0.0.1:8080/api/v1/auth/accounts

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

http://192.168.1.100:8080/api/v1/auth/accounts

[Credential-related source omitted]

The default plaintext listener serves HTTP/1.1. HTTP/2 is enabled on the TLS listener and negotiated through ALPN; browsers do not use HTTP/2 over the default plaintext `http://` URL. Configure either static TLS or ACME, then use

listener and negotiated through ALPN; browsers do not use HTTP/2 over the default plaintext `http://` URL. Configure either static TLS or ACME, then use an `https://` URL. Do not configure static TLS and ACME together.

default plaintext `http://` URL. Configure either static TLS or ACME, then use

an `https://` URL. Do not configure static TLS and ACME together.

預設明文 listener 使用 HTTP/1.1。HTTP/2 由 TLS listener 透過 ALPN 協商； 瀏覽器不會在預設 `http://` URL 上直接使用 HTTP/2。要讓 Web App 直接走

瀏覽器不會在預設 `http://` URL 上直接使用 HTTP/2。要讓 Web App 直接走

`https://`。Static TLS 與 ACME 不可同時設定。

[Credential-related source omitted]

Use `https://localhost:8080` from the browser so the certificate hostname matches. REST and the aggregate SSE stream can share the same HTTP/2 connection; subscription changes remain ordinary REST requests.

curl --http2 -sS -o /dev/null \

https://localhost:8080/api/v1/health

curl -sS https://localhost:8080/openapi.json | jq '.openapi'

curl -N https://localhost:8080/api/v1/stream/data

HTTP/1.1 on TCP and adds QUIC on the same numeric UDP port. HTTPS responses advertise HTTP/3 through `Alt-Svc`; capable browsers normally upgrade automatically, so application URLs remain `https://...`.

automatically, so application URLs remain `https://...`.

# Requires a curl build with HTTP/3 support.

curl --http3-only -sS -o /dev/null \

https://localhost:8080/api/v1/health

# Confirm discovery from the TCP HTTPS endpoint. curl --http2 -sSI https://localhost:8080/api/v1/health | grep -i '^alt-svc:'

curl --http2 -sSI https://localhost:8080/api/v1/health | grep -i '^alt-svc:'

export SJ_HTTP_ACME_CACHE="$HOME/.shioaji/acme" export SJ_HTTP_ACME_DIRECTORY_NAME=lets_encrypt_staging export SJ_HTTP_ACME_DIRECTORY_URL=https://acme-staging-v02.api.letsencrypt.org/directory

export SJ_HTTP_ACME_DIRECTORY_NAME=lets_encrypt_staging export SJ_HTTP_ACME_DIRECTORY_URL=https://acme-staging-v02.api.letsencrypt.org/directory export SJ_HTTP3=true

export SJ_HTTP_ACME_DIRECTORY_URL=https://acme-staging-v02.api.letsencrypt.org/directory

# All Base records for one type curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW"

curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW"

# One-based pagination for a large UI curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW&page=1&page_size=500"

curl "http://localhost:8080/api/v1/data/contracts?security_type=STK&region=TW&page=1&page_size=500"

curl "http://localhost:8080/api/v1/data/contracts/IX0001?region=TW&security_type=IND"

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

curl "http://localhost:8080/api/v1/data/contracts/futures?root=TXF&region=TW"

curl "http://localhost:8080/api/v1/data/contracts/options?root=TXO&option_right=C&region=TW"

curl "http://localhost:8080/api/v1/data/contracts/warrants?underlying_code=2330&region=TW"

curl -X POST http://localhost:8080/api/v1/data/contracts/combo \

curl "http://localhost:8080/api/v1/data/contracts/combo/futures?root=TXF&region=TW"

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -N http://localhost:8080/api/v1/stream/data/bidask_fop

curl -N "http://localhost:8080/api/v1/stream/data/contract_event?region=TW&security_type=STK"

curl -N "http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK"

curl -X POST http://127.0.0.1:8080/api/v1/apps/my-dashboard \

Open `http://localhost:8080/docs` in a browser. The Scalar UI lets you:

# Download the full OpenAPI spec curl -s http://localhost:8080/openapi.json | jq .

curl -s http://localhost:8080/openapi.json | jq .

# List all available endpoints curl -s http://localhost:8080/openapi.json | jq '.paths | keys[]'

curl -s http://localhost:8080/openapi.json | jq '.paths | keys[]'

# Get the request schema for a specific endpoint (e.g., place_order) curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.requestBody.content["application/json"].schema'

curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.requestBody.content["application/json"].schema'

# Get the response schema curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.responses["200"].content["application/json"].schema'

curl -s http://localhost:8080/openapi.json | jq '.paths["/api/v1/order/place_order"].post.responses["200"].content["application/json"].schema'

# List all schema definitions (reusable types) curl -s http://localhost:8080/openapi.json | jq '.components.schemas | keys[]'

curl -s http://localhost:8080/openapi.json | jq '.components.schemas | keys[]'

# Get a specific schema (e.g., StockOrder fields) curl -s http://localhost:8080/openapi.json | jq '.components.schemas["StockOrder"]'

curl -s http://localhost:8080/openapi.json | jq '.components.schemas["StockOrder"]'

# Find all required fields for a request curl -s http://localhost:8080/openapi.json | jq '.components.schemas["PlaceOrderRequest"].required'

curl -s http://localhost:8080/openapi.json | jq '.components.schemas["PlaceOrderRequest"].required'

# Get enum values for a field (e.g., Action) curl -s http://localhost:8080/openapi.json | jq '.components.schemas["Action"]'

curl -s http://localhost:8080/openapi.json | jq '.components.schemas["Action"]'

[Credential-related source omitted]

1. **Upload** via `POST /api/v1/apps/{name}` with multipart form data 2. **Access** at `http://host:port/apps/{name}/index.html`

2. **Access** at `http://host:port/apps/{name}/index.html`

[Credential-related source omitted]

The server runs at `http://localhost:8080` with all endpoints under `/api/v1/`.

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0"

<project xmlns="http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0

http://maven.apache.org/xsd/maven-4.0.0.xsd">

public ShioajiClient() {         this("http://localhost:8080");

this("http://localhost:8080");

class ShioajiClient(private val baseUrl: String = "http://localhost:8080") {

fun tickStkFlow(baseUrl: String = "http://localhost:8080"): Flow<TickData> = callbackFlow {

# Make sure the server is running first openapi-generator generate \   -i http://localhost:8080/openapi.json \

openapi-generator generate    -i http://localhost:8080/openapi.json

-i http://localhost:8080/openapi.json \

# Or for Kotlin: openapi-generator generate \   -i http://localhost:8080/openapi.json \

openapi-generator generate    -i http://localhost:8080/openapi.json

-i http://localhost:8080/openapi.json \

[Credential-related source omitted]

伺服器預設在 `http://localhost:8080` 啟動。

The server starts at `http://localhost:8080` by default.

For a browser client to negotiate HTTP/2 directly, configure a trusted TLS certificate on the Shioaji server and use `https://localhost:8080`; browsers do

certificate on the Shioaji server and use `https://localhost:8080`; browsers do

not use HTTP/2 on the default plaintext URL. Local development can use mkcert. With `SJ_HTTP3=true`, capable browsers discover QUIC through `Alt-Svc` and keep the same `https://` application URL. See [HTTP_API.md](HTTP_API.md) for the

With `SJ_HTTP3=true`, capable browsers discover QUIC through `Alt-Svc` and keep the same `https://` application URL. See [HTTP_API.md](HTTP_API.md) for the static-TLS, mkcert, ACME, UDP-port, and protocol-verification procedures.

the same `https://` application URL. See [HTTP_API.md](HTTP_API.md) for the

瀏覽器要直接協商 HTTP/2，必須先替 Shioaji server 設定受信任 TLS 憑證， 並使用 `https://localhost:8080`；預設明文 URL 不會使用 HTTP/2。本機開發可用

並使用 `https://localhost:8080`；預設明文 URL 不會使用 HTTP/2。本機開發可用

應用程式仍使用相同的 `https://` URL。

[Credential-related source omitted]

/**    * @param baseUrl - API 伺服器位址 | API server URL (default: http://localhost:8080)

* @param baseUrl - API 伺服器位址 | API server URL (default: http://localhost:8080)

[Credential-related source omitted]

*/   constructor(     baseUrl: string = "http://localhost:8080",

constructor(     baseUrl: string = "http://localhost:8080",     apiKey?: string,

baseUrl: string = "http://localhost:8080",

): Promise<T> {     const url = `${this.baseUrl}/api/v1${path}`;     const res = await fetch(url, {

const url = `${this.baseUrl}/api/v1${path}`;     const res = await fetch(url, {       method,

const res = await fetch(url, {

const resp = await fetch("http://localhost:8080/api/v1/auth/accounts");

const resp = await fetch("http://localhost:8080/api/v1/data/snapshots", {

// on this same connection are unaffected. const es = new EventSource(   "http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK"

const es = new EventSource(   "http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK" );

"http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK"

When local TLS is enabled, change the URL above to `https://localhost:8080/api/v1/stream/data?...`. The browser negotiates

`https://localhost:8080/api/v1/stream/data?...`. The browser negotiates

// 非 localhost 帶認證 | With auth for non-localhost const url = "http://localhost:8080/api/v1/stream/data?region=TW";

const url = "http://localhost:8080/api/v1/stream/data?region=TW";

// 使用 | Usage const cleanup = createReconnectingStream(   "http://localhost:8080/api/v1/stream/data?region=TW",

const cleanup = createReconnectingStream(   "http://localhost:8080/api/v1/stream/data?region=TW",   "tick_stk",

"http://localhost:8080/api/v1/stream/data?region=TW",

# 產生 TypeScript 型別 | Generate TypeScript types npx openapi-typescript http://localhost:8080/openapi.json -o src/shioaji.d.ts

npx openapi-typescript http://localhost:8080/openapi.json -o src/shioaji.d.ts

const client = createClient<paths>({   baseUrl: "http://localhost:8080/api/v1",

baseUrl: "http://localhost:8080/api/v1",

// 初始化 | Initialize   // ================================================================   const client = new ShioajiClient("http://localhost:8080");

const client = new ShioajiClient("http://localhost:8080");

// ================================================================   const es = new EventSource(     "http://localhost:8080/api/v1/stream/data?region=TW"

const es = new EventSource(     "http://localhost:8080/api/v1/stream/data?region=TW"   );

"http://localhost:8080/api/v1/stream/data?region=TW"

[Credential-related source omitted]

# POST /api/v1/data/snapshots curl -X POST http://localhost:8080/api/v1/data/snapshots \

curl -X POST http://localhost:8080/api/v1/data/snapshots \

# POST /api/v1/data/ticks curl -X POST http://localhost:8080/api/v1/data/ticks \

curl -X POST http://localhost:8080/api/v1/data/ticks \

# With time range 附時間區間 curl -X POST http://localhost:8080/api/v1/data/ticks \

curl -X POST http://localhost:8080/api/v1/data/ticks \

# Last N ticks 最後 N 筆 curl -X POST http://localhost:8080/api/v1/data/ticks \

curl -X POST http://localhost:8080/api/v1/data/ticks \

# POST /api/v1/data/kbars curl -X POST http://localhost:8080/api/v1/data/kbars \

curl -X POST http://localhost:8080/api/v1/data/kbars \

# POST /api/v1/data/daily_quotes curl -X POST http://localhost:8080/api/v1/data/daily_quotes \

curl -X POST http://localhost:8080/api/v1/data/daily_quotes \

# POST /api/v1/data/credit_enquire curl -X POST http://localhost:8080/api/v1/data/credit_enquire \

curl -X POST http://localhost:8080/api/v1/data/credit_enquire \

# POST /api/v1/data/short_stock_sources curl -X POST http://localhost:8080/api/v1/data/short_stock_sources \

curl -X POST http://localhost:8080/api/v1/data/short_stock_sources \

# POST /api/v1/data/scanner curl -X POST http://localhost:8080/api/v1/data/scanner \

curl -X POST http://localhost:8080/api/v1/data/scanner \

# GET /api/v1/data/regulatory_punish curl http://localhost:8080/api/v1/data/regulatory_punish

curl http://localhost:8080/api/v1/data/regulatory_punish

# GET /api/v1/data/regulatory_notice curl http://localhost:8080/api/v1/data/regulatory_notice

curl http://localhost:8080/api/v1/data/regulatory_notice

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

curl --fail --get "$SHIOAJI_SERVER_URL/api/v1/monitor/metrics" \

[Credential-related source omitted]

# POST /api/v1/order/place_order curl -X POST http://localhost:8080/api/v1/order/place_order \

curl -X POST http://localhost:8080/api/v1/order/place_order \

# POST /api/v1/order/place_order curl -X POST http://localhost:8080/api/v1/order/place_order \

curl -X POST http://localhost:8080/api/v1/order/place_order \

# First refresh/list trades and copy the target trade.order.id. curl -X POST http://localhost:8080/api/v1/order/trades \

curl -X POST http://localhost:8080/api/v1/order/trades \

# POST /api/v1/order/update_price curl -X POST http://localhost:8080/api/v1/order/update_price \

curl -X POST http://localhost:8080/api/v1/order/update_price \

# First refresh/list trades and copy the target trade.order.id. curl -X POST http://localhost:8080/api/v1/order/trades \

curl -X POST http://localhost:8080/api/v1/order/trades \

# POST /api/v1/order/update_qty curl -X POST http://localhost:8080/api/v1/order/update_qty \

curl -X POST http://localhost:8080/api/v1/order/update_qty \

# First refresh/list trades and copy the target trade.order.id. curl -X POST http://localhost:8080/api/v1/order/trades \

curl -X POST http://localhost:8080/api/v1/order/trades \

# POST /api/v1/order/cancel_order curl -X POST http://localhost:8080/api/v1/order/cancel_order \

curl -X POST http://localhost:8080/api/v1/order/cancel_order \

# POST /api/v1/order/trade_cache_health (1.7.6+) curl -X POST http://localhost:8080/api/v1/order/trade_cache_health \

curl -X POST http://localhost:8080/api/v1/order/trade_cache_health \

# Cache-only: no upstream update_status request. curl -X POST http://localhost:8080/api/v1/order/trades \

curl -X POST http://localhost:8080/api/v1/order/trades \

# Authoritative reconciliation; omitting refresh has the same behavior. curl -X POST http://localhost:8080/api/v1/order/trades \

curl -X POST http://localhost:8080/api/v1/order/trades \

# POST /api/v1/order/order_deal_records curl -X POST http://localhost:8080/api/v1/order/order_deal_records \

curl -X POST http://localhost:8080/api/v1/order/order_deal_records \

[Credential-related source omitted]

# Subscribe — required before opening /stream/data/order_event curl -X POST http://localhost:8080/api/v1/auth/subscribe_trade \

curl -X POST http://localhost:8080/api/v1/auth/subscribe_trade \

# Unsubscribe curl -X POST http://localhost:8080/api/v1/auth/unsubscribe_trade \

curl -X POST http://localhost:8080/api/v1/auth/unsubscribe_trade \

Onboarding step order is strict. If the user says "I opened the account", the next gate is API Key / Secret Key creation at <https://www.sinotrade.com.tw/newweb/PythonAPIKey/>, not signing. If the user says "I signed", do not assume they re

開通步驟順序要嚴格。使用者說「開好戶」後,下一關是到 <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> 建立 API Key / Secret Key,不是簽署。使用者說「簽署好了」時,不要假設已取得 API Key / Secret Key;簽署頁不會發 API 憑證。簽署後先確認 API 憑證並進入模擬登入/下單測試。除非使用者明確要求正式就緒或前面關卡都完成,不要直接跳 CA。CA 下載在 API 管理頁(<http

For account opening, use the official Shioaji campaign open-account URL: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>. Do not replace it with the generic SinoPac home page (`https://www.sinotra

開戶請使用 Shioaji 指定開戶連結: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>。不要改成永豐首頁(`https://www.sinotrade.com.tw/`)或泛稱「永豐金證券」連結。

| User says 使用者說 | Next response 下一步 | |---|---| | "I do not have an account yet" / 「還沒開戶」 | "第一步先開立永豐帳戶。請使用這個開戶頁: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>。完成後回來告訴我「開好戶了」,我再帶你做 API Key。" |

|---|---| | "I do not have an account yet" / 「還沒開戶」 | "第一步先開立永豐帳戶。請使用這個開戶頁: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>。完成後回來告訴我「開好戶了」,我再帶你做 API Key。" | | "I opened the account" / 「開好戶了」 | "很好

| "I do not have an account yet" / 「還沒開戶」 | "第一步先開立永豐帳戶。請使用這個開戶頁: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>。完成後回來告訴我「開好戶了」,我再帶你做 API Key。" |

| "I opened the account" / 「開好戶了」 | "很好,下一步是建立 API Key / Secret Key。請到 API 管理頁 <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> 新增 API KEY。這一步不是去證券/期貨簽署頁。完成後請確認你已經在本機安全保存 Secret Key;不要貼到對話。" |

| "I created API Key" / 「金鑰建好了」 | "下一步是簽署對應商品的 API 約定書。證券: <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/>;期貨/選擇權: <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/>。完成後告訴我你簽了哪些商品。" |

| "I signed" / 「簽署好了」 | "很好。請先確認你已經有 API Key / Secret Key 並已安全保存。接下來是模擬登入/下單測試,不是 CA。你要建立新的入門專案,還是只在目前資料夾跑一次性測試?" | | "Simulation test passed" / 「模擬測試通過」 | "下一步才是正式環境就緒: 需要正式權限、CA 憑證與 production login 檢查。若你只想先練習模擬,可以先停在這裡。" | | "I need prod

| "I need production readiness" / 「我要正式環境就緒」 | "請到 API 管理頁 <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> 下載 CA 憑證,或用 eleader;不要用簽署頁下載 CA。" |

| Step 步驟 | URL | |---|---| | SinoPac account opening 開立永豐帳戶 | <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji> |

|---|---| | SinoPac account opening 開立永豐帳戶 | <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji> | | API Key / Secret Key creation 建立金鑰 | <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> |

| SinoPac account opening 開立永豐帳戶 | <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji> |

| API Key / Secret Key creation 建立金鑰 | <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> |

| Stock API signing 證券 API 簽署 | <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> | | Futures/options API signing 期貨/選擇權 API 簽署 | <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/> | | CA certificate download CA 憑證下載 | <h

| Futures/options API signing 期貨/選擇權 API 簽署 | <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/> |

| CA certificate download CA 憑證下載 | <https://www.sinotrade.com.tw/newweb/PythonAPIKey/> |

[Credential-related source omitted]

3. Check whether credentials + CA exist in `.env` / secret store — **do not ask the user to paste secrets**. If credentials are ready but no local config exists, create a placeholder `.env` for local editing. 檢查 `.env`/secret store 是否已有金鑰與憑

4. If credentials are missing, guide the user through official key creation + CA download (Steps 2 & 4). 缺金鑰就引導 Step 2、4。 5. If signing is incomplete, send the user to the direct signing page for the needed product: stock API signing <https

5. If signing is incomplete, send the user to the direct signing page for the needed product: stock API signing <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> or futures/options API signing <https://www.sinotrade.com.tw/newweb/

Tutorial 教學: <https://sinotrade.github.io/tutor/prepare/open_account/> · Open account 開戶: <https://www.sinotrade.com.tw/openact?strProd=0254&strWeb=0684&s=013299&utm_source=shioaji>

Tutorial 教學: <https://sinotrade.github.io/tutor/prepare/token/> · Portal 入口: <https://www.sinotrade.com.tw/newweb/PythonAPIKey/>

[Credential-related source omitted]

Tutorial 教學: <https://sinotrade.github.io/tutor/prepare/terms/>

1. **Sign the API documents** on the direct page for the product you will trade — stock API signing: <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/>; futures/options API signing: <https://www.sinotrade.com.tw/newweb/signCenter/F

2. **Run the required simulation tests** (`simulation=True`): a **login test** plus a **`place_order` test** for each signed product (stock test uses 2890; futures uses a near-month TXF contract). The first test order also prints a one-time

4. **Verify** on the same direct signing page (stock <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> · futures/options <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/>), or log in to production and read the `signed` f

[Credential-related source omitted]

Tutorial 教學: <https://sinotrade.github.io/tutor/prepare/token/>

- **Method 1 — New SinoTrade web (recommended, cross-platform 跨平台,推薦):** on the **API 管理頁面** (<https://www.sinotrade.com.tw/newweb/PythonAPIKey/>), click **下載憑證 ("Download Certificate")**, then move the downloaded `Sinopac.pfx` to the path 

- **Method 2 — eleader (Windows only 僅 Windows):** download **eleader** from <https://www.sinotrade.com.tw/CSCenter/CSCenter_13_3>, log in, go to **帳戶資料 → (3303) 帳號資料設定**, click **步驟說明**, and follow **CA 操作步驟說明**. 下載 eleader 登入後,帳戶資料 →（3303

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

- Prerequisites 前置: Chrome or Edge; the **Claude in Chrome** extension **≥ 1.0.36**; Claude Code **≥ 2.0.73**; a direct Anthropic plan (Pro/Max/Team/Enterprise). Not supported on Brave/Arc/WSL, nor via Bedrock/Vertex/Foundry. (Web Store: <h

agent-browser open "https://www.sinotrade.com.tw/newweb/PythonAPIKey/"

1. Open account page (if no SinoPac account). 無帳戶先開戶頁。 2. Open the direct API signing page for the needed product: stock <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> or futures/options <https://www.sinotrade.com.tw/newweb/sig

2. Open the direct API signing page for the needed product: stock <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> or futures/options <https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/>. 開對應商品的 API 簽署頁。

|---|---|---| | SinoPac account 帳戶 | Login works; account list is non-empty 登入成功且帳戶列表非空 | Open account page; guide opening 開戶頁引導 | | API documents signed 已簽署 | Required accounts show `signed=True` after login 所需帳戶 `signed=True` | Open the d

| SinoPac account 帳戶 | Login works; account list is non-empty 登入成功且帳戶列表非空 | Open account page; guide opening 開戶頁引導 | | API documents signed 已簽署 | Required accounts show `signed=True` after login 所需帳戶 `signed=True` | Open the direct product 

| API documents signed 已簽署 | Required accounts show `signed=True` after login 所需帳戶 `signed=True` | Open the direct product signing page: stock <https://www.sinotrade.com.tw/newweb/signCenter/S_openAPI/> or futures/options <https://www.sinot

[Credential-related source omitted]

Shioaji prepare status: - Done: installation, simulation login, stock simulation order test - Needs user action: sign futures API document at https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/

- Done: installation, simulation login, stock simulation order test - Needs user action: sign futures API document at https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/ - Blocked: production readiness — API Key lacks 正式環境 permission

- Needs user action: sign futures API document at https://www.sinotrade.com.tw/newweb/signCenter/F_openApi/

- Releases: <https://github.com/Sinotrade/Shioaji/releases>

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

This example uses [uvloop](https://pypi.org/project/uvloop/) (`pip install uvloop`), the recommended event loop for `ShioajiAsync` under high-throughput streaming. `uvloop.run(...)` is the preferred entry point since uvloop 0.18 (older vers

本範例使用 [uvloop](https://pypi.org/project/uvloop/)（`pip install uvloop`），這是 `ShioajiAsync` 在高吞吐串流時建議的 event loop。自 uvloop 0.18 起建議使用 `uvloop.run(...)`（舊版則在 `asyncio.run(main())` 之前呼叫一次 `uvloop.install()`）。若是 Windows 使用者，uvloop 不支援（僅 Linux/mac

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

curl -X POST http://localhost:8080/api/v1/order/stock_reserve_summary \

curl -X POST http://localhost:8080/api/v1/order/stock_reserve_detail \

curl -X POST http://localhost:8080/api/v1/order/reserve_stock \

curl -X POST http://localhost:8080/api/v1/order/earmarking_detail \

curl -X POST http://localhost:8080/api/v1/order/reserve_earmarking \

[Credential-related source omitted]

The server runs at `http://localhost:8080` with all endpoints under `/api/v1/`.

const BASE_URL: &str = "http://localhost:8080";

const BASE_URL: &str = "http://localhost:8080";

# Make sure the server is running first openapi-generator generate \   -i http://localhost:8080/openapi.json \

openapi-generator generate    -i http://localhost:8080/openapi.json

-i http://localhost:8080/openapi.json \

[Credential-related source omitted]

# POST /api/v1/stream/subscribe curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# POST /api/v1/stream/unsubscribe curl -X POST http://localhost:8080/api/v1/stream/unsubscribe \

curl -X POST http://localhost:8080/api/v1/stream/unsubscribe \

[Credential-related source omitted]

# Market data: subscribe per contract before opening tick/bidask/quote streams curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# Index: use the exchange/master code. Tick/BidAsk/Quote all map to QUO/v1/IND. curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# require target_code from contract lookup. Regular futures codes do not. # Step 1: look up TXFR1 and read the returned target_code, for example TXFF6. curl "http://localhost:8080/api/v1/data/contracts/TXFR1?security_type=FUT"

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

# Step 2: subscribe with both code=TXFR1 and the returned target_code. # For TXFR1/TXFR2, missing target_code can return 200 but only emit SSE heartbeats. curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# For TXFR1/TXFR2, missing target_code can return 200 but only emit SSE heartbeats. curl -X POST http://localhost:8080/api/v1/stream/subscribe \   -H "Content-Type: application/json" \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# REQUIRED for /stream/data/order_event in production and simulation — without it the SSE # stream only emits heartbeats. Mirrors api.subscribe_trade(account) in Python. curl -X POST http://localhost:8080/api/v1/auth/subscribe_trade \

# stream only emits heartbeats. Mirrors api.subscribe_trade(account) in Python. curl -X POST http://localhost:8080/api/v1/auth/subscribe_trade \   -H "Content-Type: application/json" \

curl -X POST http://localhost:8080/api/v1/auth/subscribe_trade \

# Connect to SSE (all channels). These filters affect contract_event only. curl -N "http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK"

curl -N "http://localhost:8080/api/v1/stream/data?region=TW&security_type=STK"

# Or connect to a specific channel 或連接特定頻道 curl -N http://localhost:8080/api/v1/stream/data/tick_stk

curl -N http://localhost:8080/api/v1/stream/data/tick_stk

curl -N http://localhost:8080/api/v1/stream/data/quote_idx

curl -N http://localhost:8080/api/v1/stream/data/order_event

# GET /api/v1/stream/status curl http://localhost:8080/api/v1/stream/status

curl http://localhost:8080/api/v1/stream/status

const es = new EventSource("http://localhost:8080/api/v1/stream/data?region=TW");

curl -X POST localhost:8080/api/v1/stream/subscribe/index_components \

-H 'Content-Type: application/json' \   -d '{"index":{"security_type":"IND","exchange":"TSE","code":"IX0001","target_code":null},"projection":{"kind":"ranking","target":"group","metric":"contribution","order":"abs_desc","limit":10}}' curl -

curl -N localhost:8080/api/v1/stream/data/index_components

# preset rule 規則類 curl -X POST localhost:8080/api/v1/stream/subscribe/scanner -H 'Content-Type: application/json' \

curl -X POST localhost:8080/api/v1/stream/subscribe/scanner -H 'Content-Type: application/json' \

-d '{"scanner":{"kind":"preset_rule","id":"trade_price_drop"},"region":"TW","security_type":"STK","exchange":"TSE"}' # status filter 狀態過濾（plain string 字串形式） curl -X POST localhost:8080/api/v1/stream/subscribe/scanner -H 'Content-Type: appli

# status filter 狀態過濾（plain string 字串形式） curl -X POST localhost:8080/api/v1/stream/subscribe/scanner -H 'Content-Type: application/json' \   -d '{"scanner":"simtrade","region":"TW","security_type":"STK","exchange":"TSE"}'

curl -X POST localhost:8080/api/v1/stream/subscribe/scanner -H 'Content-Type: application/json' \

curl -N localhost:8080/api/v1/stream/data/scanner

# HTTP: check usage from the running server # HTTP：從執行中的 server 檢查用量 curl http://localhost:8080/api/v1/auth/usage

curl http://localhost:8080/api/v1/auth/usage

# Check contract first 先確認合約 curl "http://localhost:8080/api/v1/data/contracts/2330?security_type=STK"

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

# Then query a known trading day 再查一個已知交易日 curl -X POST http://localhost:8080/api/v1/data/ticks \

curl -X POST http://localhost:8080/api/v1/data/ticks \

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

[Credential-related source omitted]

http://your-server:8080/api/v1/auth/accounts

[Credential-related source omitted]

[Credential-related source omitted]

- The default plaintext `http://` listener is HTTP/1.1. Configure

`SJ_HTTP_TLS_CERT` and `SJ_HTTP_TLS_KEY`, then use the matching `https://`

do not use ACME for localhost. - Verify outside the app with   `curl --http2 -sS -o /dev/null -w 'HTTP %{http_version}\n' https://localhost:8080/api/v1/health`.

`curl --http2 -sS -o /dev/null -w 'HTTP %{http_version}\n' https://localhost:8080/api/v1/health`.

- Generate the certificate for every hostname/IP the client actually uses,   and open the URL with a matching name. A certificate for `localhost` does   not validate `https://192.168.x.x`.

and open the URL with a matching name. A certificate for `localhost` does   not validate `https://192.168.x.x`. - Run `mkcert -install` in the same OS/browser trust environment. Container,

not validate `https://192.168.x.x`.

QUIC uses the same numeric UDP port. - First verify the TCP HTTPS response contains `Alt-Svc`, then test with a curl   build that supports `--http3-only`. Browser upgrade is automatic and may

- First verify the TCP HTTPS response contains `Alt-Svc`, then test with a curl   build that supports `--http3-only`. Browser upgrade is automatic and may   occur after the first HTTPS response.

rm /path/to/shioaji.sock

- Ensure you subscribe to at least one contract before connecting to the SSE endpoint, and branch on `success` in `SubscriptionResponse`   確保在連接 SSE 端點前至少訂閱一個合約，並檢查 `SubscriptionResponse.success` - Use `curl -N` (no buffering) to see events

確保在連接 SSE 端點前至少訂閱一個合約，並檢查 `SubscriptionResponse.success` - Use `curl -N` (no buffering) to see events in real time   使用 `curl -N`（無緩衝）即時查看事件

- Use `curl -N` (no buffering) to see events in real time

使用 `curl -N`（無緩衝）即時查看事件

# 1. Subscribe first 先訂閱 curl -X POST http://localhost:8080/api/v1/stream/subscribe \

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

# 2. Then connect to SSE 再連接 SSE curl -N http://localhost:8080/api/v1/stream/data

curl -N http://localhost:8080/api/v1/stream/data

# Continuous futures alias example 連續月範例 curl "http://localhost:8080/api/v1/data/contracts/TXFR1?security_type=FUT"

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

curl -X POST http://localhost:8080/api/v1/stream/subscribe \

[Credential-related source omitted]

curl -X GET http://localhost:8080/api/v1/watchlist

curl -X GET http://localhost:8080/api/v1/watchlist/{id}

curl -X POST http://localhost:8080/api/v1/watchlist \

curl -X DELETE http://localhost:8080/api/v1/watchlist/{id}

curl -X PUT http://localhost:8080/api/v1/watchlist/{id} \

curl -X POST http://localhost:8080/api/v1/watchlist/{id}/contracts \

curl -X DELETE http://localhost:8080/api/v1/watchlist/{id}/contracts \