Skip to main content

Cancel Order

cancelOrder

Request Parameter

ParameterTypeMeaning
accountAccountAccount
orderResultorderResultThe intended order result object to be cancel
unblockbool? (default = false)unblock

Result Response

ParameterTypeMeaning
isSuccessboolInterface result
dataObjectModified content is returned
messagestring ? (optional)isSuccess = False error description is returned

OrderResult Parameter

Return type : Object

ParameterTypeMeaning
functionTypeintFunction Type : 0 New Order 、 10 New Order Executed 、 15 Change Price 、 20 Change Quantity 、 30 Cancel 、 90 Failed
datestringTransaction date
seqNostringOrder serial number
branchNostringBranch number
accountstringAccount
orderNostringOrder number
assetTypenumberAsset type : 0 Stock
marketstringMarket type : TAIEX Listed 、 TAISDAQ OTC 、 TAIEMG EMG
marketTypejs:string / ts:MarketTypeTrading session type : CommonFixingIntradayOddOddEmgEmgOdd
stockNostringSymbol
buySelljs:string / ts:BSActionBuy/Sell Type : BuySell
priceTypejs:string / ts:PriceTypeOriginal order price type : LimitLimitUpLimitDownMarketReference
pricenumberOrder Price
quantitynumberOriginal order quantity
timeInForcejs:string / ts:TimeInForceTime In Force RODFOKIOC
orderTypejs:string / ts:OrderTypeOrder Type : StockMarginShort Short sale 、 DayTradeSBL
isPreOrderboolReservation Flag
statusnumberOrder status : 0 Reservation 、 4 Sending to the system backend 、 9 Timeout 、 10 Active order 、 30 Canceled 、 40 Partially filled, others canceled 、 50 Fully filled 、 90 Failed
afterPriceTypejs:string / ts:PriceTypeValid order price type : LimitLimitUpLimitDownMarketReference
afterPricenumberValid order price
afterQtynumberValid Order Quantity (filled quantity included)
filledQtynumberFilled Quantity
filledMoneynumberFilled Value
beforeQtynumberBefore the Quantity Modification
beforePricenumberBefore the Price Modification
userDefstringCustom Fields
lastTimestringLast Modification Time
detailslistOrder Process (Return value when query orderResultDetail or orderHistory )
errorMessagestringError Message

Request Example

sdk.Stock.CancelOrder(account, cancel_order, true)

Response Example

{
isSuccess: true,
data:{
functionType: 30, // Function Type (number)
date: '2024/03/08', // Transaction Date (string)
seqNo: '00000308948', // Order Serial Number (string)
branchNo: '6460', // Branch Number (string)
account: '26', // Account (string)
orderNo: 'x0023', // Order Number (string)
assetType: 0, // Asset Type (number)
market: 'TAIEX', // Market Type (string)
marketType: 'Common', // Trading Session Type (string)
stockNo: '1101', // Symbol (string)
buySell: 'Sell', // Buy/Sell Type (string)
priceType: 'Limit', // Original Order Price Type (string)
price: 41.2, // Order Price (number)
quantity: 5000, // Original Order Quantity (number)
timeInForce: 'ROD', // Time In Force (string)
orderType: 'Stock', // Order Type (string)
isPreOrder: false, // Reservation Order Flag (bool)
status: 30, // Order Status (number)
afterPriceType: 'Limit', // Valid Order Price Type (string)
afterPrice: 41.2, // Valid Order Price (number)
unit: 1000, // Trading Unit (number)
afterQty: 0, // Valid Order Quantity (number)
filledQty: 0, // Filled Quantity (number)
filledMoney: 0, // Filled Value (number)
beforeQty: 5000, // Before the Quantity Modification (number)
beforePrice: 41.2, // Before the Price Modification (number)
userDef: '12345678', // Custom Fields (string)
lastTime: '12:53:57.536', // Last Modification Time (string)
}
}