Share Reservation Application

reserveStock

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
stockNo	string	Stock symbol
quantity	number	Number of shares to reserve. Unit: shares (1 lot = 1,000 shares); must be greater than 0

Result

Field	Type	Description
isSuccess	bool	Whether the request succeeded
data	ReserveStockRecord	Share reservation application details
message	string ? (optional)	Error message when isSuccess is false

Share reservation record: ReserveStockRecord fields

Return type : Object

Field	Type	Description
seqNo	string	Sequence number
stockNo	string	Stock symbol
reservedShare	number	Reserved shares

Request example

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

Response example

{
  isSuccess: true,
  data: {
        stockNo: "2330",                  // Stock symbol (string)
        market: Taiex,                    // Market (Market)
        reservedShare: 1000,              // Reserved shares (int)
        seqNo: "417106",                  // Sequence number (string)
  }
}