Get Historical Order
orderHistory
Request Parameter
Parameter | Type | Meaning |
---|---|---|
account | Account | Account |
startDate | string | Query Start Date |
endDate | string? (null or empty will equals startDate) | Query End Date |
info
Since v2.1.1, this supports longer term historical data inquiry. The day range is limited maximum 30 days per request. For older SDK versions (until v2.1.0), it supports historical data for the past two days.
Result Response
Parameter | Type | Meaning |
---|---|---|
isSuccess | bool | Interface result |
data | Object | OrderResult list is returned |
message | string ? (optional) | isSuccess = False error description is returned |
OrderResult Parameter
Return type : Object
Parameter | Type | Meaning |
---|---|---|
functionType | int ? (optional) | Function Type : 0 New Order 、 10 New Order Executed 、 15 Change Price 、 20 Change Quantity 、 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 : 0 Stock |
market | string | Market type : TAIEX Listed 、 TAISDAQ OTC 、 TAIEMG EMG |
marketType | js:string / ts:MarketType | Trading session type : Common 、 Fixing 、 IntradayOdd 、 Odd 、 Emg 、 EmgOdd |
stockNo | string | Symbol |
buySell | js:string / ts:BSAction | Buy/Sell Type : Buy 、 Sell |
priceType | js:string / ts:PriceType | Original order price type : Limit 、 LimitUp 、 LimitDown 、 Market 、 Reference |
price | number | Order Price |
quantity | number | Original order quantity |
timeInForce | js:string / ts:TimeInForce | Time In Force ROD 、 FOK 、 IOC |
orderType | js:string / ts:OrderType | Order Type : Stock 、 Margin 、 Short Short sale 、 DayTrade 、 SBL |
isPreOrder | bool | Reservation Flag |
status | number | Order 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 |
afterPriceType | js:string / ts:PriceType | Valid order price type : Limit 、 LimitUp 、 LimitDown 、 Market 、 Reference |
afterPrice | number | Valid order price |
unit | number | Trading Unit |
afterQty | number | Valid Order Quantity (filled quantity included) |
filledQty | number | Filled Quantity |
filledMoney | number | Filled Value |
beforeQty | number | Before the Quantity Modification |
beforePrice | number | Before the Price Modification |
userDef | string | Custom Fields |
lastTime | string | Last Modification Time |
errorMessage | string | Error Message |
details | list | Order Process |
>> functionType | number | Function Type : 0 New Order 、 10 New Order Executed 、 15 Change Price 、 20 Change Quantity 、 30 Cancel 、 50 Fully Filled 、 90 Failed |
>> modifiedTime | string | Order Modified Time |
>> beforeQty | number | Original Order Quantity |
>> afterQty | number | Valid Order Quantity (filled quantity included) |
>> beforePrice | number | Original Order Price |
>> afterPrice | number | Valid Order Price |
>> filledMoney | number | Filled Value |
>> status | number | Order Status |
>> errMsg | string | Error Message |
Request Example
const orderHistory = sdk.stock.orderHistory(account,"20230921","20231020");
console.log(orderHistory);
Response Example
{
isSuccess: true,
data:[
{
date: '2023/10/11', // Trading Date (string)
seqNo: '00005000001', // Order serial number (string)
branchNo: '6460', // Branch number (string)
account: '26', // Account (string)
orderNo: 'bA586', // Order number (string)
assetType: 0, // Asset Category (number)
market: 'TAIEX', // Market Category (string)
marketType: 'Common', // Trading session type (string)
stockNo: '2888', // Symbol (string)
buySell: 'Buy', // Transaction direction (string)
priceType: 'Limit', // Order price type (string)
price: 8.9, // Order Price (number)
quantity: 2000, // Order quantity (number)
timeInForce: 'ROD', // Time in force (string)
orderType: 'Stock', // Order Type (string)
isPreOrder: false, // Reservation flag (bool)
status: 10, // Order Status (number)
afterPrice: 8.51, // Valid order price (number)
unit: 1000, // Share Unit (number)
afterQty: 2000, // Valid order quantity (number)
filledQty: 0, // Filled quantity (number)
filledMoney: 0, // Filled Value (number)
userDef: 'From Js', // Custom fields (string)
lastTime: '11:25:08.761' // Last modification time (string)
details: [
{
functionType: 10, // Function Type (number)
modifiedTime: '11:25:08.761' // Order Modified Time (string)
beforeQty: 0, // Original Order Quantity (number)
afterQty: 2000, // Valid Order Quantity (number)
beforePrice: 8.51, // Original Order Price (number)
afterPrice: 8.51 // Valid Order Price (number)
}
]
},
...
]
}