Batch Cancel Order
batchCancelOrder
Request Parameter
Parameter | Type | Meaning |
---|---|---|
account | Account | Account |
orderResult | FutOptOrderResult(list of object) | The intended order result object to be cancel |
Result Response
Parameter | Type | Meaning |
---|---|---|
isSuccess | bool | Interface result |
data | Object | Modified content is returned |
message | string ? (optional) | isSuccess = False error description is returned |
FutOptOrderResult Parameter
Return type : Object
Parameter | Type | Meaning |
---|---|---|
functionType | number | Function Type : 0 New 、 10 Execute New、15 Amend Price 、 20 Amend Lot 、 30 Cancel、90 Failed |
date | string | Transaction date |
seqNo | string | Order serial number |
branchNo | string | Branch number |
account | string | Account |
orderNo | string | Order number |
assetType | number | Asset type : 1 Future 、2 Option |
market | string | Market type : TAIMEX Future、Option |
marketType | js:string / ts:FutOptMarketType | Trading session type : Future 、 Option 、 FutureNight After-Hour Future 、 OptionNight After-Hour Option |
unit | number | Trading Unit |
currency | string | Trading Currency |
symbol | string | Symbol |
expiryDate | string | Expiry Date |
strikePrice | number | Strike Price |
callPut | js:string / ts:CallPut | Call / Put Type : Call Call 、Put Put |
buySell | js:string / ts:BSAction | Buy/Sell Type : Buy 、 Sell |
symbolLeg2 | string | Symbol - Spread Order |
expiryDateLeg2 | string | Expiry Date - Spread Order |
strikePriceLeg2 | number | Strike Price - Spread Order |
callPutLeg2 | js:string / ts:CallPut | Call / Put Type : Call Call 、Put Put |
buySellLeg2 | js:string / ts:BSAction | Buy/Sell Type : Buy 、 Sell |
priceType | js:string / ts:FutOptPriceType | Original order price type : Limit 、 Market 、 RangeMarket Market with Protection Orders 、 Reference |
price | number | Order Price |
lot | number | Original order lot |
timeInForce | js:string / ts:TimeInForce | Time In Force ROD 、 FOK 、 IOC |
orderType | js:string / ts:FutOptOrderType | Order Type : New 、 Close 、 Auto 、 FdayTrade |
isPreOrder | bool | Reservation Flag |
status | number | Order 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 |
afterPriceType | js:string / ts:FutOptPriceType | Valid order price type : Limit 、 Market 、 RangeMarket Market with Protection Orders 、 Reference |
afterPrice | number | Valid order price |
afterLot | number | Valid Order Lot |
filledLot | number | Filled Lot |
filledMoney | number | Filled Value |
beforeLot | number | Before the Lot Modification |
beforePrice | number | Before the Price Modification |
userDef | string | Custom Fields |
lastTime | string | Last Modification Time |
details | list | Order Process (Return value when query orderResultDetail or orderHistory ) |
errorMessage | string | Error 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)
...
}
}