Order Search

POST 
/order/search

This is used to search the order history. This can also be used to get a list of all the orders for a given period that match the given criteria.

Request

application/json

Body

accountNumber stringrequired

Security account number

orderId string
clientOrderId stringdeprecated
symbol string
exchange string
orderSide string

Possible values: [1 (Buy), 2 (Sell)]

orderStatus string

Find list of status here

sDate stringrequired

Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

start date

eDate stringrequired

Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

end date

pageNo stringrequired
pageWidth stringrequired

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode integer

Find error codes here)

isNextPageAvailable boolean
pageWidth integer
totalNoOfRecords integer
list object[]
Array [
clientOrderId stringdeprecated
originalClientOrderId stringdeprecated
orderId string
originalOrderId string
orderNumber string
orderQty number
orderType string
Possible values: [1, 2]
1 (Market order) | 2 (Limit order)
orderSide string
Possible values: [1, 2]
1 (Buy) | 2 (Sell)
orderStatus string
Find list of status here
orderValue number
The total value of an order, calculated as price * quantity. It updates dynamically based on the quantity executed, reflecting the current executed value of the order.
commission number
accountNumber string
Security account number
currency string
price number
symbol string
text string
tif integer
transactionTime string
Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])-(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$
orderRejectReason string
exchange string
createdDate string
averagePrice number
marketCode string
settleCurrency string
cumulativeQty number
filled quantity
cumulativeOrderValue number
filled order value
cumulativeOrderNetValue number
filled net value (order value + commission + vat + order fees + etc.)
cumulativeCommission number
filled order commission
cumulativeOrderNetSettle number
filled order net settle (net value * issue settle rate)
issue settle rate ; exchnage currency to cash account currency rate
lastUpdatedTime string
Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])-(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$
quantity number
status stringdeprecated
Find list of status here
filledQty numberdeprecated
filledOrderValue numberdeprecated
cumulativeVatAmount number
cumulativeStampDutyAmount number
]

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "isNextPageAvailable": true,
  "pageWidth": 0,
  "totalNoOfRecords": 0,
  "list": [
    {
      "orderId": "string",
      "originalOrderId": "string",
      "orderNumber": "string",
      "orderQty": 0,
      "orderType": "1",
      "orderSide": "1",
      "orderStatus": "string",
      "orderValue": 0,
      "commission": 0,
      "accountNumber": "string",
      "currency": "string",
      "price": 0,
      "symbol": "string",
      "text": "string",
      "tif": 0,
      "transactionTime": "string",
      "orderRejectReason": "string",
      "exchange": "string",
      "createdDate": "string",
      "averagePrice": 0,
      "marketCode": "string",
      "settleCurrency": "string",
      "cumulativeQty": 0,
      "cumulativeOrderValue": 0,
      "cumulativeOrderNetValue": 0,
      "cumulativeCommission": 0,
      "cumulativeOrderNetSettle": 0,
      "lastUpdatedTime": "string",
      "quantity": 0,
      "cumulativeVatAmount": 0,
      "cumulativeStampDutyAmount": 0
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": "order search success",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageWidth": 10,
  "totalNoOfRecords": 1,
  "list": [
    {
      "originalOrderId": "",
      "orderId": "23F251000073",
      "orderQty": 100,
      "orderType": "2",
      "orderSide": "1",
      "orderStatus": "2",
      "orderValue": 200,
      "commission": 7,
      "accountNumber": "XXXXX",
      "currency": "USD",
      "price": 2,
      "symbol": "AAPL",
      "text": "XXXXX",
      "tif": 0,
      "transactionTime": "2023/02/20-09:30:19",
      "orderRejectReason": "",
      "exchange": "NSDQ",
      "createdDate": "2023/02/20-09:32:19",
      "averagePrice": 2,
      "marketCode": "ALL",
      "settleCurrency": "USD",
      "cumulativeQty": 100,
      "cumulativeOrderValue": 200,
      "cumulativeOrderNetValue": 207,
      "cumulativeCommission": 7,
      "cumulativeOrderNetSettle": 207,
      "lastUpdatedTime": "2023/02/20-09:32:19",
      "quantity": 100,
      "status": "",
      "filledQty": 0,
      "filledOrderValue": 0
    }
  ]
}

Loading...