預收券款

提醒

下單前必須先登入及啟用憑證。
服務時間為交易日 8:00–14:30。

預收款項¶

Python其他語言

reserve_earmarking / earmarking_detail

api.reserve_earmarking?

Signature:
    api.reserve_earmarking(
        contract: sj.Stock,
        share: int,
        price: float,
        account: Optional[sj.Account] = None,
        timeout: Optional[int] = 5000,
        cb: Optional[Callable[[sj.EarmarkingOrderResp], None]] = None,
    ) -> sj.EarmarkingOrderResp

api.earmarking_detail?

Signature:
    api.earmarking_detail(
        account: Optional[sj.Account] = None,
        timeout: Optional[int] = 5000,
        cb: Optional[Callable[[sj.EarmarkStocksDetail], None]] = None,
    ) -> sj.EarmarkStocksDetail

Parameters

reserve_earmarking
    contract: 商品檔（由 api.Contracts.Stocks.* 取得）
    share:    預收股數
    price:    預收價格
    account:  證券帳號
    timeout:  逾時毫秒
    cb:       選填，callback 函式

earmarking_detail
    account:  證券帳號
    timeout:  逾時毫秒
    cb:       選填，callback 函式

reserve_earmarking / earmarking_detail

POST /api/v1/order/reserve_earmarking
Content-Type: application/json

{
  "contract": { "security_type": "STK", "exchange": <Exchange>, "code": <string> },
  "share": <integer>,
  "price": <number>,
  "account": { "broker_id": <string>, "account_id": <string> }
}

POST /api/v1/order/earmarking_detail
Content-Type: application/json

{
  "account": { "broker_id": <string>, "account_id": <string> }
}

Parameters

reserve_earmarking
    contract.exchange: 交易所 {TSE, OTC}
    contract.code:     商品代碼
    share:             預收股數
    price:             預收價格
    account:           證券帳號

earmarking_detail
    account:           證券帳號

申請預收款項¶

PythonHTTP

Order

# 商品檔
contract = api.Contracts.Stocks.TSE.TSE1217
# 預收款項內容
share = 1000
price = 9

In

# 申請預收款項
resp = api.reserve_earmarking(contract, share, price, account=api.stock_account)
resp

Out

EarmarkingOrderResp(
    contract=Contract(
        security_type='STK',
        exchange='TSE',
        code='1217',
        target_code=''
    ),
    account=StockAccount(
        person_id='YOUR_PERSON_ID',
        broker_id='YOUR_BROKER_ID',
        account_id='YOUR_ACCOUNT_ID',
        signed=true,
        username=''
    ),
    share=1000,
    price=9,
    status=true,
    info='OK'
)

In

curl -X POST http://localhost:8080/api/v1/order/reserve_earmarking \
  -H 'Content-Type: application/json' \
  -d '{
    "contract": {
      "security_type": "STK",
      "exchange": "TSE",
      "code": "1217"
    },
    "share": 1000,
    "price": 9,
    "account": {
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID"
    }
  }'

Out

{"contract":{"security_type":"STK","exchange":"TSE","code":"1217","target_code":""},"account":{"account_type":"S","person_id":"YOUR_PERSON_ID","broker_id":"YOUR_BROKER_ID","account_id":"YOUR_ACCOUNT_ID","signed":true,"username":""},"share":1000,"price":9.0,"status":true,"info":"OK"}

查詢預收款項¶

PythonHTTP

In

resp = api.earmarking_detail(account=api.stock_account)
resp

Out

EarmarkStocksDetail(
    stocks=[
        EarmarkStockDetail(
            contract=Contract(
                security_type='STK',
                exchange='TSE',
                code='1217',
                target_code=''
            ),
            share=1000,
            price=9,
            amount=9020,
            order_datetime='2026-05-20T15:16:28+08:00',
            status=true,
            info='成功'
        )
    ],
    account=StockAccount(
        person_id='YOUR_PERSON_ID',
        broker_id='YOUR_BROKER_ID',
        account_id='YOUR_ACCOUNT_ID',
        signed=true,
        username=''
    )
)

In

curl -X POST http://localhost:8080/api/v1/order/earmarking_detail \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID"
    }
  }'

Out

{"stocks":[{"contract":{"security_type":"STK","exchange":"TSE","code":"1217","target_code":""},"share":1000,"price":9.0,"amount":9020,"order_datetime":"2026-05-20T15:16:28+08:00","status":true,"info":"成功"}],"account":{"account_type":"S","person_id":"YOUR_PERSON_ID","broker_id":"YOUR_BROKER_ID","account_id":"YOUR_ACCOUNT_ID","signed":true,"username":""}}

預收股票¶

Python其他語言

reserve_stock / stock_reserve_summary / stock_reserve_detail

api.reserve_stock?

Signature:
    api.reserve_stock(
        contract: sj.Stock,
        share: int,
        account: Optional[sj.Account] = None,
        timeout: Optional[int] = 5000,
        cb: Optional[Callable[[sj.ReserveOrderResp], None]] = None,
    ) -> sj.ReserveOrderResp

api.stock_reserve_summary?

Signature:
    api.stock_reserve_summary(
        account: Optional[sj.Account] = None,
        timeout: Optional[int] = 5000,
        cb: Optional[Callable[[sj.ReserveStocksSummary], None]] = None,
    ) -> sj.ReserveStocksSummary

api.stock_reserve_detail?

Signature:
    api.stock_reserve_detail(
        account: Optional[sj.Account] = None,
        timeout: Optional[int] = 5000,
        cb: Optional[Callable[[sj.ReserveStocksDetail], None]] = None,
    ) -> sj.ReserveStocksDetail

Parameters

reserve_stock
    contract: 商品檔（由 api.Contracts.Stocks.* 取得）
    share:    預收股數
    account:  證券帳號
    timeout:  逾時毫秒
    cb:       選填，callback 函式

stock_reserve_summary
    account:  證券帳號
    timeout:  逾時毫秒
    cb:       選填，callback 函式

stock_reserve_detail
    account:  證券帳號
    timeout:  逾時毫秒
    cb:       選填，callback 函式

reserve_stock / stock_reserve_summary / stock_reserve_detail

POST /api/v1/order/reserve_stock
Content-Type: application/json

{
  "contract": { "security_type": "STK", "exchange": <Exchange>, "code": <string> },
  "share": <integer>,
  "account": { "broker_id": <string>, "account_id": <string> }
}

POST /api/v1/order/stock_reserve_summary
Content-Type: application/json

{
  "account": { "broker_id": <string>, "account_id": <string> }
}

POST /api/v1/order/stock_reserve_detail
Content-Type: application/json

{
  "account": { "broker_id": <string>, "account_id": <string> }
}

Parameters

reserve_stock
    contract.exchange: 交易所 {TSE, OTC}
    contract.code:     商品代碼
    share:             預收股數
    account:           證券帳號

stock_reserve_summary
    account:           證券帳號

stock_reserve_detail
    account:           證券帳號

申請預收股票¶

PythonHTTP

Order

# 商品檔
contract = api.Contracts.Stocks.TSE.TSE1217
# 預收股數
share = 1000

In

# 申請預收股票
resp = api.reserve_stock(contract, share, account=api.stock_account)
resp

Out

ReserveOrderResp(
    contract=Contract(
        security_type='STK',
        exchange='TSE',
        code='1217',
        target_code=''
    ),
    account=StockAccount(
        person_id='YOUR_PERSON_ID',
        broker_id='YOUR_BROKER_ID',
        account_id='YOUR_ACCOUNT_ID',
        signed=true,
        username=''
    ),
    share=1000,
    status=true,
    info=''
)

In

curl -X POST http://localhost:8080/api/v1/order/reserve_stock \
  -H 'Content-Type: application/json' \
  -d '{
    "contract": {
      "security_type": "STK",
      "exchange": "TSE",
      "code": "1217"
    },
    "share": 1000,
    "account": {
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID"
    }
  }'

Out

{"contract":{"security_type":"STK","exchange":"TSE","code":"1217","target_code":""},"account":{"account_type":"S","person_id":"YOUR_PERSON_ID","broker_id":"YOUR_BROKER_ID","account_id":"YOUR_ACCOUNT_ID","signed":true,"username":""},"share":1000,"status":true,"info":""}

查詢預收股票狀態¶

PythonHTTP

In

resp = api.stock_reserve_summary(account=api.stock_account)
resp

Out

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=''
    )
)

In

curl -X POST http://localhost:8080/api/v1/order/stock_reserve_summary \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID"
    }
  }'

Out

{"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":""}}

查詢預收股票明細¶

PythonHTTP

In

resp = api.stock_reserve_detail(account=api.stock_account)
resp

Out

ReserveStocksDetail(
    stocks=[
        ReserveStockDetail(
            contract=Contract(
                security_type='STK',
                exchange='TSE',
                code='6153',
                target_code=''
            ),
            share=1000,
            order_datetime='2026-05-20T15:16:28+08:00',
            status=true,
            info='已完成'
        )
    ],
    account=StockAccount(
        person_id='YOUR_PERSON_ID',
        broker_id='YOUR_BROKER_ID',
        account_id='YOUR_ACCOUNT_ID',
        signed=true,
        username=''
    )
)

In

curl -X POST http://localhost:8080/api/v1/order/stock_reserve_detail \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "broker_id": "YOUR_BROKER_ID",
      "account_id": "YOUR_ACCOUNT_ID"
    }
  }'

Out

{"stocks":[{"contract":{"security_type":"STK","exchange":"TSE","code":"6153","target_code":""},"share":1000,"order_datetime":"2026-05-20T15:16:28+08:00","status":true,"info":"已完成"}],"account":{"account_type":"S","person_id":"YOUR_PERSON_ID","broker_id":"YOUR_BROKER_ID","account_id":"YOUR_ACCOUNT_ID","signed":true,"username":""}}

應用範例¶

查詢所有名下證券帳號的圈券狀態，將可圈額度全數申請預收股票。

In

import shioaji as sj

api = sj.Shioaji()
accounts = api.login(
    api_key="YOUR_API_KEY",
    secret_key="YOUR_SECRET_KEY",
)
api.activate_ca(
    ca_path="your/ca/path/Sinopac.pfx",
    ca_passwd="YOUR_CA_PASSWORD",
    person_id="YOUR_PERSON_ID",
)

for account in accounts:
    if account.account_type == sj.AccountType.Stock:
        summary = api.stock_reserve_summary(account=account)
        for s in summary.stocks:
            if s.available_share:
                api.reserve_stock(
                    s.contract,
                    s.available_share,
                    account=account,
                )