Share Reservation Application

reserve_stock

Version

Available in v2.2.9 and later.

Usage limits

• Applications are accepted on trading days from 08:00 to 14:30. Requests outside this window are rejected by the backend.
• An application cannot be cancelled through the API after it is submitted.
• For the complete workflow, see Reservations and Transfers.

Parameters

Field	Type	Description
account	Account	Account
stock_no	string	Stock symbol
quantity	int	Number of shares to reserve. Unit: shares (1 lot = 1,000 shares); must be greater than 0

Result

Field	Type	Description
is_success	bool	Whether the request succeeded
data	ReserveStockRecord	Share reservation application details
message	string	Error message when is_success is false

Share reservation record: ReserveStockRecord fields

Return type : Object

Field	Type	Description
seq_no	string	Sequence number
stock_no	string	Stock symbol
reserved_share	int	Reserved shares

Request example

sdk.stock.reserve_stock(account, "2330", 1000)

Response example

Result {
    is_success: True,
    message: None,
    data : ReserveStockRecord {
        stock_no: "2330",       # Stock symbol (string)
        market: Taiex,          # Market (Market)
        reserved_share: 1000,   # Reserved shares (int)
        seq_no: "417106",       # Sequence number (string)
}}