Skip to main content

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

FieldTypeDescription
accountAccountAccount
stockNostringStock symbol
quantityintNumber of shares to reserve. Unit: shares (1 lot = 1,000 shares); must be greater than 0

Result

FieldTypeDescription
isSuccessboolWhether the request succeeded
dataReserveStockRecordShare reservation application details
messagestringError message when isSuccess is false

Share reservation record: ReserveStockRecord fields

Return type : Object

FieldTypeDescription
seqNostringSequence number
stockNostringStock symbol
reservedShareintReserved shares

Request example

sdk.Stock.ReserveStock(account, "2330", 1000)

Response example

{
isSuccess = True,
message = ,
data = ReserveStockRecord{
stockNo = 2330, // Stock symbol (string)
market = Taiex, // Market (Market)
reservedShare = 1000, // Reserved shares (int)
seqNo = 417106, // Sequence number (string)
}
}