Get Order Details

GET 
/order/details

This is used to get the details of an individual order. This will give all the details about the order as well as the list of executions that took place on that order.

Request

Query Parameters

orderId stringrequired

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason string
rejectCode integer

Find error codes here)

executionList object[]
Array [
executionId string
lastPrice number
filledQty number
this is cumulative qty.
commission number
orderStatus string
updatedDateTime 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]$
]
orderNumber string
orderId string
originalOrderId string
exchange string
symbol string
accountNumber string

Security account number

orderSide string

Possible values: [1, 2]

1 (Buy) | 2 (Sell)

orderType string

Possible values: [1, 2]

1 (Market order) | 2 (Limit order)

orderStatus string

Find list of status here

averagePrice number
orderQty number
filledQty numberdeprecated
orderValue number
filledOrderValue numberdeprecated
commission number
vat number
date 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]$

rejectReason string
executionIds string
lastPrice number
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

cumulativeVatAmount number
cumulativeStampDutyAmount number

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "rejectCode": 0,
  "executionList": [
    {
      "executionId": "string",
      "lastPrice": 0,
      "filledQty": 0,
      "commission": 0,
      "orderStatus": "string",
      "updatedDateTime": "string"
    }
  ],
  "orderNumber": "string",
  "orderId": "string",
  "originalOrderId": "string",
  "exchange": "string",
  "symbol": "string",
  "accountNumber": "string",
  "orderSide": "1",
  "orderType": "1",
  "orderStatus": "string",
  "averagePrice": 0,
  "orderQty": 0,
  "orderValue": 0,
  "commission": 0,
  "vat": 0,
  "date": "string",
  "rejectReason": "string",
  "executionIds": "string",
  "lastPrice": 0,
  "cumulativeQty": 0,
  "cumulativeOrderValue": 0,
  "cumulativeOrderNetValue": 0,
  "cumulativeCommission": 0,
  "cumulativeOrderNetSettle": 0,
  "cumulativeVatAmount": 0,
  "cumulativeStampDutyAmount": 0
}

example

{
  "status": "SUCCESS",
  "reason": "getting order details success",
  "rejectCode": 0,
  "executionList": [
    {
      "executionId": "1675396159732",
      "lastPrice": 2,
      "filledQty": 10,
      "commission": 1310.575,
      "orderStatus": "2",
      "updatedDateTime": "2023/02/03-03:49:37"
    }
  ],
  "orderId": "23G032000009",
  "exchange": "NSDQ",
  "symbol": "AAPL",
  "accountNumber": "P000132169",
  "orderSide": "1",
  "orderType": "2",
  "averagePrice": 2,
  "orderQty": 10,
  "filledQty": 10,
  "orderValue": 20,
  "filledOrderValue": 1330.57502,
  "commission": 1310.57502,
  "vat": 0,
  "date": "2023/02/03-03:49:17",
  "rejectReason": "",
  "executionIds": "[1675396159732]",
  "lastPrice": 2,
  "orderStatus": "2",
  "cumulativeQty": 10,
  "cumulativeOrderValue": 20,
  "cumulativeOrderNetValue": 0,
  "cumulativeCommission": 1310.57502,
  "cumulativeOrderNetSettle": 6.65301,
  "cumulativeVatAmount": 1.11,
  "cumulativeStampDutyAmount": 0.01
}

Loading...