Shioaji

https://sinotrade.github.io
Admin
Shioaji is a pythonic cross-platform trading API for Taiwan and global financial markets, featuring...
Tokens:346,678
Snippets:1,510
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start frontend dev server with pnpm

Source: https://sinotrade.github.io/tutor/shioaji_apps

Starts the frontend dev server. The template already proxies `/api` to `http://localhost:8080`, so no extra setup is needed.

```bash
pnpm dev

```

--------------------------------

### Getting started prompt for new Shioaji users

Source: https://sinotrade.github.io/ai_assistant

A detailed prompt that guides AI to walk through the complete Shioaji setup and testing process, including account opening, API key application, simulation testing, CA certificate activation, and production mode switch.

```text
I'm new to Shioaji and want to start trading. Please guide me through the complete
setup process step by step:

1. How to open a Sinopac account
2. How to sign the API terms of service
3. How to apply for API Key and Secret Key
4. How to complete the simulation mode testing (login test, stock order test, futures order test)
5. How to verify my test passed (signed=True)
6. How to apply for and activate the CA certificate
7. How to switch to production mode

Please check my progress at each step and help me troubleshoot any issues.
```

--------------------------------

### Install shioaji with uv tool install

Source: https://sinotrade.github.io/env_setup/other

Recommended installation method for the shioaji command using uv. Run this command to install the shioaji CLI.

```bash
uv tool install shioaji

```

--------------------------------

### Install Shioaji CLI tool and show help

Source: https://sinotrade.github.io/

Install the Shioaji CLI tool via uv and display its help information.

```bash
uv tool install shioaji
shioaji --help
```

--------------------------------

### Start shioaji server

Source: https://sinotrade.github.io/tutor/shioaji_apps

Starts the shioaji server in simulation mode (recommended for development and testing).

```bash
shioaji server start

```

--------------------------------

### Configure .env and start shioaji server in simulation mode

Source: https://sinotrade.github.io/tutor/simulation

Set SJ_API_KEY, SJ_SEC_KEY, and SJ_PRODUCTION=false in a .env file in the working directory, then run `shioaji server start` to auto-read the file and log in. The server starts in simulation mode because SJ_PRODUCTION is false.

```bash
# .env (in the working directory) should contain:
SJ_API_KEY=YOUR_API_KEY                # change this
SJ_SEC_KEY=YOUR_SECRET_KEY             # change this
SJ_PRODUCTION=false                    # simulation mode

# Start the server (auto-reads .env and logs in)
shioaji server start

```

```bash
# .env (in the working directory) should contain:
SJ_API_KEY=YOUR_API_KEY                # change this
SJ_SEC_KEY=YOUR_SECRET_KEY             # change this
SJ_PRODUCTION=false                    # simulation mode

# Start the server in a terminal (auto-reads .env and logs in)
shioaji server start

```

--------------------------------

### Install uv on Windows

Source: https://sinotrade.github.io/env_setup/python

Run this command in PowerShell to install uv on Windows. It uses the official installation script.

```powershell
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

```

--------------------------------

### CLI example: shioaji portfolio trading-limits and output

Source: https://sinotrade.github.io/tutor/accounting/trading_limits

Example of running the CLI command with a specific account and the resulting output.

```bash
shioaji portfolio trading-limits --account YOUR_BROKER_ID-YOUR_ACCOUNT_ID
```

```bash
trading_limit: 1000000
trading_used: 0
trading_available: 1000000
margin_limit: 0
margin_used: 0
margin_available: 0
short_limit: 0
short_used: 0
short_available: 0
```

--------------------------------

### Python example: api.punish() and output

Source: https://sinotrade.github.io/tutor/market_data/disposition_attention

Python example: calling api.punish() and the resulting Punish object with sample data.

```python
api.punish()
```

```python
Punish[86](
    code=["1591", "1595", ...],
    start_date=["2026-05-21", "2026-05-11", ...],
    end_date=["2026-06-03", "2026-05-22", ...],
    updated_at=["2026-05-20T18:18:31", "2026-05-08T18:18:39", ...],
    interval=["25分鐘", "5分鐘", ...],
    unit_limit=[None, 10, ...],
    total_limit=[None, 30, ...],
    description=["...", "...", ...],
    announced_date=["2026-05-20", "2026-05-08", ...]
)
```

--------------------------------

### Install uv on Linux and MacOS

Source: https://sinotrade.github.io/env_setup/python

Run this command in a terminal to install uv on Linux or macOS. It downloads and executes the official installation script.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh

```

--------------------------------

### Start Shioaji server with .env

Source: https://sinotrade.github.io/tutor/login

Starts the Shioaji API server using environment variables from a .env file. The output shows the server reading the .env, performing login, fetching contracts, and starting the HTTP server on http://127.0.0.1:8080.

```bash
# .env (in the working directory) should contain:
SJ_API_KEY=YOUR_API_KEY                # edit it
SJ_SEC_KEY=YOUR_SECRET_KEY             # edit it
SJ_PRODUCTION=true                     # whether to enter production mode

# Start server (auto-reads .env and logs in)
shioaji server start
```

```text
# Reads API key and settings from .env
Loaded environment variables from .env file
INFO shioaji::cli::server: Starting Shioaji API Server...

# First login (no cached token)
INFO shioaji::api::api_v1::auth::token_login: No cached token available, performing new login
INFO shioaji::api::api_v1::auth::token_login: Stored new token in slot 1

# Contract fetch progress
INFO shioaji::api::api_v1::contracts::api: Fetched 127 IND contracts (1 pages)
INFO shioaji::api::api_v1::contracts::api: Fetched 41809 STK contracts (9 pages)
INFO shioaji::api::api_v1::contracts::api: Fetched 2503 FUT contracts (1 pages)
INFO shioaji::api::api_v1::contracts::api: Fetched 9031 OPT contracts (2 pages)
INFO shioaji::server: Loaded 53470 contracts

# CA certificate loaded
INFO shioaji::server: CA certificate activated successfully

# Authentication successful, login complete
INFO shioaji::cli::server: Successfully authenticated with Shioaji API

# HTTP server up, ready to accept requests
INFO shioaji::cli::server: 🚀 Shioaji API Server is running on http://127.0.0.1:8080
INFO salvo_core::server: listening [HTTP/1.1] on http://127.0.0.1:8080
```

--------------------------------

### Install Shioaji skill with multi-platform installers

Source: https://sinotrade.github.io/ai_assistant

Commands to install the Shioaji skill using skills.sh (18+ agents), skillkit (32+ agents), and openskills (universal).

```bash
npx skills add Sinotrade/Shioaji                # skills.sh - 18+ agents
npx skillkit install Sinotrade/Shioaji          # skillkit - 32+ agents
npx openskills install Sinotrade/Shioaji        # openskills - universal
```

--------------------------------

### Start Jupyter Lab

Source: https://sinotrade.github.io/env_setup/python

Starts Jupyter Lab with the jupyter package included via uv.

```bash
uv run --with jupyter jupyter lab

```

--------------------------------

### BidAsk callback output example

Source: https://sinotrade.github.io/upgrade

Example output of the bid/ask callback for stock 2330, showing the BidAsk object and a generic quote message.

```python
Exchange: Exchange.TSE, BidAsk: BidAsk(code='2330', datetime=datetime.datetime(2021, 7, 2, 13, 17, 29, 726428), bid_price=[Decimal('589'), Decimal('588'), Decimal('587'), Decimal('586'), Decimal('585')], bid_volume=[223, 761, 1003, 809, 1274], diff_bid_vol=[0, 0, 0, 0, 0], ask_price=[Decimal('590'), Decimal('591'), Decimal('592'), Decimal('593'), Decimal('594')], ask_volume=[304, 232, 183, 242, 131], diff_ask_vol=[1, 0, 0, 0, 0], suspend=0, simtrade=0, intraday_odd=0)

```

```python
Topic: QUT/idcdmzpcr01/TSE/2330, Quote: {'AskPrice': [590.0, 591.0, 592.0, 593.0, 594.0], 'AskVolume': [303, 232, 183, 242, 131], 'BidPrice': [589.0, 588.0, 587.0, 586.0, 585.0], 'BidVolume': [224, 762, 1003, 809, 1274], 'Date': '2021/07/02', 'Time': '13:17:26.391840'}

```

--------------------------------

### Example output of /api/v1/info

Source: https://sinotrade.github.io/env_setup/other

Example JSON response from the info endpoint showing server name, version, description, protocols, scheme, uds_plaintext, and simulation.

```json
{"name":"Shioaji API Server","version":"1.7.2","description":"SinoPac Shioaji Cross-Platform Trading API HTTP Adaptor","protocols":["HTTP/1.1"],"scheme":"http","uds_plaintext":true,"simulation":false}

```

--------------------------------

### Update Price Example Output

Source: https://sinotrade.github.io/tutor/order/FutureOption

Example output for updating a price, showing the order and status objects with the updated price and quantity.

```text
Out

```

```json
{
  "contract": {
    "security_type": "FUT",
    "exchange": "TAIFEX",
    "code": "TMFE6"
  },
  "order": {
    "id": "bf2ca5b0",
    "seqno": "243121",
    "ordno": "vE0FK",
    "action": "Buy",
    "price": 36216.0,
    "quantity": 1,
    "order_type": "ROD",
    "price_type": "LMT",
    "custom_field": "",
    "account": {
      "account_type": "F",
      "person_id": "YOUR_PERSON_ID",
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID",
      "signed": true,
      "username": ""
    },
    "ca": "YOUR_CA_BASE64",
    "octype": "New"
  },
  "status": {
    "id": "bf2ca5b0",
    "status": "Submitted",
    "status_code": "0000",
    "web_id": "Z",
    "order_ts": 1779187550.0,
    "msg": "",
    "modified_ts": 1779187550.0,
    "modified_price": 36216.0,
    "order_quantity": 1,
    "cancel_quantity": 1,
    "deal_quantity": 0,
    "deals": []
  }
}

```

--------------------------------

### Python example: api.trading_limits call and output

Source: https://sinotrade.github.io/tutor/accounting/trading_limits

Example of calling api.trading_limits with the default stock account and the resulting TradingLimits object.

```python
api.trading_limits(account=api.stock_account)
```

```python
TradingLimits(
    trading_limit=1000000,
    trading_used=0,
    trading_available=1000000,
    margin_limit=0,
    margin_used=0,
    margin_available=0,
    short_limit=0,
    short_used=0,
    short_available=0
)
```

--------------------------------

### Python Example: Get Short Stock Sources

Source: https://sinotrade.github.io/tutor/market_data/short_stock_source

Python example that retrieves short stock sources for contracts 2330 and 2317 using api.short_stock_sources and displays the result.

```python
contracts = [api.contracts.get("2330"), api.contracts.get("2317")]
short_stock_sources = api.short_stock_sources(contracts)
short_stock_sources

```

```python
[ShortStockSource(code='2330', short_stock_source=0, ts=1779099174000000000),
 ShortStockSource(code='2317', short_stock_source=1225, ts=1779099174000000000)]

```

--------------------------------

### CLI example: with specific account

Source: https://sinotrade.github.io/tutor/accounting/settlements

Shows the CLI command with the --account option to specify a broker ID and account ID.

```bash
shioaji portfolio settlements --account YOUR_BROKER_ID-YOUR_ACCOUNT_ID
```

--------------------------------

### CLI Example: short-stock-sources --codes 2330,2317

Source: https://sinotrade.github.io/tutor/market_data/short_stock_source

CLI command to get short stock sources for codes 2330 and 2317, with example output showing code, short_stock_source, and datetime.

```bash
shioaji data short-stock-sources --codes 2330,2317

```

```bash
[2]{code,short_stock_source,datetime}:
  "2330",0,2026-06-12T01:27:03
  "2317",1086,2026-06-12T01:27:03

```

--------------------------------

### CLI: shioaji order place --help

Source: https://sinotrade.github.io/tutor/order/Stock

Shows the CLI help for the place command, including usage and options.

```bash
$ shioaji order place --help

Place a stock or futures order

Usage: shioaji order place [OPTIONS] --code <CODE> --action <ACTION> --quantity <QUANTITY>

Options:
      --code <CODE>                    Security code
      --action <ACTION>                Buy or sell
      --price <PRICE>                  Order price (0 for market orders) [default: 0]
      --quantity <QUANTITY>            Order quantity
      --price-type <PRICE_TYPE>        Price type: lmt, mkt [default: lmt]
      --order-type <ORDER_TYPE>        Order type [default: rod]
      --order-lot <ORDER_LOT>          Stock order lot type
      --order-cond <ORDER_COND>        Stock order condition
      --account <ACCOUNT>              Account in BROKER_ID-ACCOUNT_ID format
      --security-type <SECURITY_TYPE>  Security type hint for contract lookup: STK, FUT, OPT, IND [default: STK]
      --no-wait                        Skip waiting for order events after placing
```

--------------------------------

### Get Reserve Stock Summary - HTTP Response

Source: https://sinotrade.github.io/tutor/order/Reserve

Example JSON response from the stock_reserve_summary endpoint.

```json
{"stocks":[{"contract":{"security_type":"STK","exchange":"TSE","code":"2890","target_code":""},"available_share":5000,"reserved_share":0}],"account":{"account_type":"S","person_id":"YOUR_PERSON_ID","broker_id":"YOUR_BROKER_ID","account_id":"YOUR_ACCOUNT_ID","signed":true,"username":""}}
```

--------------------------------

### Get Reserve Stock Summary - CLI Output

Source: https://sinotrade.github.io/tutor/order/Reserve

Example output of the CLI command, showing the stock summaries and account.

```yaml
stocks[1]:
  - contract:
      security_type: STK
      exchange: TSE
      code: "2890"
      target_code: ""
    available_share: 5000
    reserved_share: 0
account:
  account_type: S
  person_id: YOUR_PERSON_ID
  broker_id: YOUR_BROKER_ID
  account_id: "YOUR_ACCOUNT_ID"
  signed: true
  username: ""
```

--------------------------------

### Create project sj-trading with uv

Source: https://sinotrade.github.io/env_setup/python

Initializes a new project named sj-trading with package, app, and git support, then changes into the project directory.

```bash
uv init sj-trading --package --app --vcs git
cd sj-trading

```

--------------------------------

### Get Reserve Stock Summary - Python Response

Source: https://sinotrade.github.io/tutor/order/Reserve

Example output of the ReserveStocksSummaryResponse, showing a list of stock summaries and the account.

```python
ReserveStocksSummaryResponse(
    response=ReserveStocksSummary(
        stocks=[
            ReserveStockSummary(
                contract=Contract(
                    security_type='STK',
                    exchange='TSE',
                    code='2890',
                    target_code=''
                ),
                available_share=5000,
                reserved_share=0
            )
        ],
        account=StockAccount(
            person_id='YOUR_PERSON_ID',
            broker_id='YOUR_BROKER_ID',
            account_id='YOUR_ACCOUNT_ID',
            signed=true,
            username=''
        )
    ),
    error=None
)
```

--------------------------------

### BidAsk subscription output (sample)

Source: https://sinotrade.github.io/tutor/market_data/streaming/stocks

Sample output observed after subscribing to bid/ask quotes for contract 2890. Shows the subscription confirmation and the full bid/ask payload with five-level price and volume lists (as Decimal) plus diff volumes, suspend, simtrade, and intraday_odd flags.

```text
Response Code: 200 | Event Code: 16 | Info: QUO/v1/STK/*/TSE/2890 | Event: Subscribe or Unsubscribe ok
exchange=Exchange.TSE
code=2890
date=(2026, 5, 21)
time=(9, 57, 57, 278770)
datetime=(2026, 5, 21, 9, 57, 57, 278770)
bid_price=[Decimal('29.75'), Decimal('29.7'), Decimal('29.65'), Decimal('29.6'), Decimal('29.55')]
bid_volume=[337, 1423, 374, 644, 203]
diff_bid_vol=[1, 0, 0, 0, 0]
ask_price=[Decimal('29.8'), Decimal('29.85'), Decimal('29.9'), Decimal('29.95'), Decimal('30')]
ask_volume=[37, 92, 70, 163, 731]
diff_ask_vol=[0, 0, 0, 0, 0]
suspend=False
simtrade=False
intraday_odd=False

```

--------------------------------

### Python SDK: Subscribe to BidAsk Quotes

Source: https://sinotrade.github.io/tutor/market_data/streaming/futures

Subscribe to bid/ask quotes for a futures contract using the Shioaji Python SDK. The example shows how to get a contract and subscribe with quote_type=sj.QuoteType.BidAsk, and how to unsubscribe.

```APIDOC
## Python SDK: Subscribe to BidAsk Quotes

### Description
Subscribe to bid/ask quotes for a futures contract using the Shioaji Python SDK. The example shows how to get a contract and subscribe with quote_type=sj.QuoteType.BidAsk, and how to unsubscribe.

### Method
subscribe

### Endpoint
api.subscribe(contract, quote_type=sj.QuoteType.BidAsk)

### Parameters
- **contract** (Contract) - Required - The contract object obtained from api.contracts.get().
- **quote_type** (QuoteType) - Required - Set to sj.QuoteType.BidAsk to subscribe to bid/ask quotes.

### Request Example
```python
contract = api.contracts.get("TXFR1")
api.subscribe(
    contract,
    quote_type=sj.QuoteType.BidAsk,
)
```

### Response
#### Success Response (200)
- **Response Code** (int) - 200
- **Event Code** (int) - 16
- **Info** (str) - Subscription confirmation message, e.g., "QUO/v1/FOP/*/TFE/TXFF6 | Event: Subscribe or Unsubscribe ok"
- **BidAskFOPv1** (object) - The bid/ask data object with fields: code, date, time, bid_price, ask_price, bid_volume, ask_volume.

#### Response Example
```json
{
  "code": "TXFF6",
  "date": "2026-05-20",
  "time": "19:23:01",
  "bid_price": [40605, 40603, 40602, 40601, 40600],
  "ask_price": [40607, 40608, 40610, 40611, 40612],
  "bid_volume": [1, 4, 2, 5, 5],
  "ask_volume": [1, 1, 5, 2, 2]
}
```

### Unsubscribe Example
```python
api.unsubscribe(
    contract,
    quote_type=sj.QuoteType.BidAsk,
)
```
```

--------------------------------

### REST API: List futures combos via GET /api/v1/data/contracts/combo/futures

Source: https://sinotrade.github.io/tutor/contract

Shows the endpoint for listing futures combos and a curl command to fetch them for root=TXF. The response is a JSON array of combo objects; the example shows the first two entries and an ellipsis for the rest.

```http
GET /api/v1/data/contracts/combo/futures?root=<string>
```

```bash
curl 'http://localhost:8080/api/v1/data/contracts/combo/futures?root=TXF'
```

```json
[{"code":"TXFH6/I6","legs":[{"security_type":"FUT","region":"TW","exchange":"TAIFEX","code":"TXFH6","target_code":null},{"security_type":"FUT","region":"TW","exchange":"TAIFEX","code":"TXFI6","target_code":null}],"region":"TW","exchange":"TAIFEX","combo_type":"TimeSpread","managed":true},{"code":"TXFH6/J6","legs":[...],"region":"TW","exchange":"TAIFEX","combo_type":"TimeSpread","managed":true},...]
```

--------------------------------

### Project structure after uv init

Source: https://sinotrade.github.io/env_setup/python

Shows the directory layout created by the uv init command for the sj-trading project.

```text
sj-trading
├── README.md
├── pyproject.toml
└── src
    └── sj_trading
        └── __init__.py

```

--------------------------------

### Install Shioaji standalone installer on Linux/macOS

Source: https://sinotrade.github.io/

Install the Shioaji standalone installer on Linux or macOS. Use the stable channel by default, or set CHANNEL=prerelease for prerelease builds.

```bash
# Stable
curl -fsSL https://github.com/Sinotrade/Shioaji/releases/latest/download/install.sh | sh

# Prerelease
curl -fsSL https://github.com/Sinotrade/Shioaji/releases/latest/download/install.sh | CHANNEL=prerelease sh
```

--------------------------------

### Install Shioaji standalone installer on Windows

Source: https://sinotrade.github.io/

Install the Shioaji standalone installer on Windows via PowerShell. Use the stable channel by default, or set the CHANNEL environment variable to prerelease for prerelease builds.

```powershell
# Stable
irm https://github.com/Sinotrade/Shioaji/releases/latest/download/install.ps1 | iex

# Prerelease
$env:CHANNEL="prerelease"; irm https://github.com/Sinotrade/Shioaji/releases/latest/download/install.ps1 | iex
```

--------------------------------

### Place order example (Python)

Source: https://sinotrade.github.io/tutor/order/FutureOption

Python example of placing a futures order. It creates a contract and FuturesOrder, calls api.place_order, and shows the returned Trade object with status PendingSubmit.

```python
# contract
contract = api.contracts.get("TMFR1")
# order
order = sj.FuturesOrder(
    action=sj.Action.Buy,
    price=36216,
    quantity=2,
    price_type=sj.FuturesPriceType.LMT,
    order_type=sj.OrderType.ROD,
    octype=sj.FuturesOCType.Auto,
    account=api.futopt_account,
)
```

```python
# place order
trade = api.place_order(contract, order)
trade
```

```python
Trade(
    contract=Contract(
        security_type='FUT',
        exchange='TAIFEX',
        code='TMFE6',
        target_code='TMFE6'
    ),
    order=Order(
        id='e0ae2459',
        action=<Action.Buy: 'Buy'>,
        price=36216,
        quantity=2,
        seqno='242472',
        order_type=<OrderType.ROD: 'ROD'>,
        price_type=<PriceType.LMT: 'LMT'>,
        account=FutureAccount(
            person_id='YOUR_PERSON_ID',
            broker_id='YOUR_BROKER_ID',
            account_id='YOUR_ACCOUNT_ID',
            signed=true,
            username='YOUR_USERNAME'
        ),
        octype=<FuturesOCType.Auto: 'Auto'>
    ),
    status=OrderStatus(
        id='e0ae2459',
        status=<OrderStatus.PendingSubmit: 'PendingSubmit'>,
        status_code='    ',
        order_datetime=datetime.datetime(2026, 5, 19, 18, 3, 7, tzinfo=datetime.timezone(datetime.timedelta(hours=8)))
    )
)
```

--------------------------------

### Python: Example of trade_cache_health with output

Source: https://sinotrade.github.io/tutor/order/UpdateStatus

Shows a Python example of calling `api.trade_cache_health(api.stock_account)` and the resulting output. The example illustrates an order placed but not yet filled, where the deal report is still `NoBaseline`.

```python
health = api.trade_cache_health(api.stock_account)
health.state, [(r.event_type, r.reason) for r in health.reasons]

```

```python
(<TradeCacheHealthState.Unknown: 'Unknown'>,
 [(<OrderState.StockDeal: 'SDEAL'>,
   <TradeCacheHealthReasonCode.NoBaseline: 'NoBaseline'>)])

```

--------------------------------

### Python example: cancel_comboorder

Source: https://sinotrade.github.io/tutor/order/Combo

Example call to `api.cancel_comboorder(trade)` to cancel a combo trade.

```python
api.cancel_comboorder(trade)
```

--------------------------------

### List all option products (Python)

Source: https://sinotrade.github.io/tutor/contract

Use api.contracts.option_roots() to list every option product code and name. The output is a list of tuples.

```python
api.contracts.option_roots()
```

```python
[
    ('CAA', '南亞選擇權'),
    ('CAO', '南亞選擇權'),
    ('CBO', '中鋼選擇權'),
    ('CCA', '聯電選擇權'),
    ('CCO', '聯電選擇權'),
    ...
]
```

--------------------------------

### Example output of /api/v1/stream/status

Source: https://sinotrade.github.io/env_setup/other

Example JSON response showing active_connections, timestamp, and status.

```json
{"active_connections":0,"timestamp":"2026-06-12T05:53:13.517649+00:00","status":"healthy"}

```

--------------------------------

### HTTP GET /api/v1/data/regulatory_punish

Source: https://sinotrade.github.io/tutor/market_data/disposition_attention

HTTP GET endpoint for retrieving regulatory punish data.

```http
GET /api/v1/data/regulatory_punish
```

--------------------------------

### Run hello command

Source: https://sinotrade.github.io/env_setup/python

Executes the hello command defined in the project scripts. The expected output is 'Hello from sj-trading!'.

```bash
uv run hello

```

--------------------------------

### Python: Enter simulation mode with Shioaji API

Source: https://sinotrade.github.io/tutor/simulation

Creates a Shioaji API instance with simulation=True and logs in using placeholder API and secret keys. Replace YOUR_API_KEY and YOUR_SECRET_KEY with real credentials before running.

```python
api = sj.Shioaji(simulation=True)  # simulation mode
accounts = api.login(
    api_key="YOUR_API_KEY",     # change this
    secret_key="YOUR_SECRET_KEY"  # change this
)
```

--------------------------------

### Stop daemon with shioaji server stop

Source: https://sinotrade.github.io/tutor/login

Stops the daemon started by `shioaji server start`.

```bash
shioaji server stop

```

--------------------------------

### Run main command with uv

Source: https://sinotrade.github.io/tutor/prepare/token

Executes the `main` command. If successful, it prints `login and activate ca success`.

```bash
uv run main

```

--------------------------------

### Query usage with api.usage()

Source: https://sinotrade.github.io/tutor/limit

Python example showing how to call api.usage() and the resulting UsageOut object.

```python
api.usage()
```

```text
UsageOut(connections=2, bytes=43883999, limit_bytes=2147483648, remaining_bytes=2103599649)
```

--------------------------------

### Python example: update_combostatus and list_combotrades with output

Source: https://sinotrade.github.io/tutor/order/Combo

Shows a Python example that calls update_combostatus with the futures account and then list_combotrades, followed by the returned ComboTrade object. The output includes contract legs, order details, and status.

```python
api.update_combostatus(api.futopt_account)
api.list_combotrades()

```

```python
[
    ComboTrade(
        contract=ComboContract(
            legs=[
                ComboBase(
                    action=<Action.Sell: 'Sell'>,
                    security_type=<SecurityType.Future: 'FUT'>,
                    exchange=<Exchange.TAIFEX: 'TAIFEX'>,
                    code='TXFH6',
                    symbol='TXFH6',
                    category='TXF',
                    delivery_month='202608'
                ),
                ComboBase(
                    action=<Action.Buy: 'Buy'>,
                    security_type=<SecurityType.Future: 'FUT'>,
                    exchange=<Exchange.TAIFEX: 'TAIFEX'>,
                    code='TXFI6',
                    symbol='TXFI6',
                    category='TXF',
                    delivery_month='202609'
                )
            ]
        ),
        order=Order(
            id='46989de8',
            action=<Action.Buy: 'Buy'>,
            price=50.0,
            quantity=1,
            seqno='743595',
            ordno='000000',
            order_type=<OrderType.ROD: 'ROD'>,
            price_type=<PriceType.LMT: 'LMT'>,
            account=FutureAccount(
                person_id='YOUR_PERSON_ID',
                broker_id='YOUR_BROKER_ID',
                account_id='YOUR_ACCOUNT_ID',
                signed=true,
                username=''
            ),
            octype=<FuturesOCType.Auto: 'Auto'>
        ),
        status=ComboStatus(
            id='46989de8',
            status=<OrderStatus.Submitted: 'Submitted'>,
            status_code='0000',
            order_datetime=datetime.datetime(2026, 8, 12, 11, 35, 0, tzinfo=datetime.timezone(datetime.timedelta(hours=8))),
            modified_time=datetime.datetime(2026, 8, 12, 11, 35, 0, tzinfo=datetime.timezone(datetime.timedelta(hours=8))),
            modified_price=50.0,
            order_quantity=1,
            deals={}
        )
    )
]

```
Tokens:
Raw