Skip to main content

Batch Cancel Order

batchCancelOrder

Request Parameter

ParameterTypeMeaning
accountAccountAccount
orderResultFutOptOrderResult(list of object)The intended order result object to be cancel

Result Response

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

FutOptOrderResult Parameter

Return type : Object

ParameterTypeMeaning
functionTypenumberFunction Type : 0 New 、 10 Execute New、15 Amend Price 、 20 Amend Lot 、 30 Cancel、90Failed
datestringTransaction date
seqNostringOrder serial number
branchNostringBranch number
accountstringAccount
orderNostringOrder number
assetTypenumberAsset type : 1 Future 、2 Option
marketstringMarket type : TAIMEX Future、Option
marketTypejs:string / ts:FutOptMarketTypeTrading session type : FutureOptionFutureNight After-Hour Future 、 OptionNight After-Hour Option
unitnumberTrading Unit
currencystringTrading Currency
symbolstringSymbol
expiryDatestringExpiry Date
strikePricenumberStrike Price
callPutjs:string / ts:CallPutCall / Put Type : Call Call 、Put Put
buySelljs:string / ts:BSActionBuy/Sell Type : BuySell
symbolLeg2stringSymbol - Spread Order
expiryDateLeg2stringExpiry Date - Spread Order
strikePriceLeg2numberStrike Price - Spread Order
callPutLeg2js:string / ts:CallPutCall / Put Type : Call Call 、Put Put
buySellLeg2js:string / ts:BSActionBuy/Sell Type : BuySell
priceTypejs:string / ts:FutOptPriceTypeOriginal order price type : LimitMarketRangeMarket Market with Protection Orders 、 Reference
pricenumberOrder Price
lotnumberOriginal order lot
timeInForcejs:string / ts:TimeInForceTime In Force RODFOKIOC
orderTypejs:string / ts:FutOptOrderTypeOrder Type : NewCloseAutoFdayTrade
isPreOrderboolReservation Flag
statusnumberOrder Status : 0 Reservation 、 4 In queue 、 8 Processing by system backend 、 9 TimeOut 、 10 Active Order 、 30 Cancel Order 、 50 Fully Filled 、 90 Order Failed
afterPriceTypejs:string / ts:FutOptPriceTypeValid order price type : LimitMarketRangeMarket Market with Protection Orders 、 Reference
afterPricenumberValid order price
afterLotnumberValid Order Lot
filledLotnumberFilled Lot
filledMoneynumberFilled Value
beforeLotnumberBefore the Lot Modification
beforePricenumberBefore the Price Modification
userDefstringCustom Fields
lastTimestringLast Modification Time
detailslistOrder Process (Return value when query orderResultDetail or orderHistory )
errorMessagestringError Message

Request Example

// Batch cancel(  using the content returned by batch detail)
cancel_object = [
batch_results_detail.data[0],
batch_results_detail.data[1],
]
sdk.futopt.batchCancelOrder(account, cancel_object)

// Batch cancel( Using different individual orders)
cancel_object = [
orders[37],
orders[35],
]

sdk.futopt.batchCancelOrder(account, cancel_object)

Response Example

{
isSuccess: true,
data:{
functionType: 30, // Function Type (number)
date: "2024/03/25", // Transaction Date (string)
seqNo: "00110212608", // Order Sequence Number (string)
branchNo: "15901", // Branch Number (string)
account: "1234567", // Account (string)
orderNo: "C0001", // Order Number (string)
assetType: 1, // Asset Type (number)
market: "TAIMEX", // Market Type (string)
marketType: Future, // Trading Session Type (FutOptMarketType)
unit: 1, // Unit (number)
currency: "TWD", // Currency (string)
symbol: "FITF", // Symbol (string)
expiryDate: 202404, // Expiry Date (string)
buySell: Buy, // Buy or Sell (BSAction)
priceType: Limit, // Original Order Price Type (FutOptPriceType)
price: 1822.6, // Price (number)
lot: 2, // Original Order Lot (number)
timeInForce: ROD, // Time In Force (TimeInforce)
orderType: Auto, // Order Type (FutOptOrderType)
isPreOrder: false, // Is Pre-Order (bool)
status: 30, // Order Status (number)
afterPrice: 1822.6, // Valid Order Price (number)
afterLot: 0, // Valid Order Lot (number)
filledLot: 0, // Filled Lot (number)
filledMoney: 0, // Filled Amount (number)
lastTime: "13:21:34", // Last Modification Time (string)
},
{
functionType: 30, // Function Type (number)
date: "2024/03/25", // Transaction Date (string)
seqNo: "00110212608", // Order Sequence Number (string)
branchNo: "15901", // Branch Number (string)
account: "1234567", // Account (string)
orderNo: "C0001", // Order Number (string)
assetType: 1, // Asset Type (number)
market: "TAIMEX", // Market Type (string)
marketType: Future, // Trading Session Type (FutOptMarketType)
unit: 1, // Unit (number)
currency: "TWD", // Currency (string)
symbol: "FITF", // Symbol (string)
expiryDate: 202404, // Expiry Date (string)
buySell: Buy, // Buy or Sell (BSAction)
priceType: Limit, // Original Order Price Type (FutOptPriceType)
price: 1822.6, // Price (number)
lot: 2, // Original Order Lot (number)
timeInForce: ROD, // Time In Force (TimeInforce)
orderType: Auto, // Order Type (FutOptOrderType)
isPreOrder: false, // Is Pre-Order (bool)
status: 30, // Order Status (number)
...
}
}