Order Search
GET/v1.1/orders/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.
If a symbol contains a backslash ( \ ) character, it needs to be replaced by %5C. (Ex.BOND\23H18\87.0 is replaced by BOND%5C23H18%5C87.0 ).
If a symbol contains a backtick (
`
) character, it needs to be replaced by %60. (Ex.510`TB is replaced by 510%60TB ).
Request
Query Parameters
Find list of status here
Default value: 1
Default value: 100
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Equity
- Fixed Income
- Option
Schema
- Array [
- ]
Find error code here
Default value: 100
list object[]
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.
appears only in rejected orders
Possible values: Value must match regular expression yyyy/MM/dd-HH:mm:ss
Possible values: Value must match regular expression yyyy/MM/dd-HH:mm:ss
Possible values: Value must match regular expression yyyy/MM/dd-HH:mm:ss
This is only for fixed income orders
Default value: 1
{
"status": "string",
"reason": "string",
"rejectCode": 0,
"isNextPageAvailable": true,
"pageWidth": 100,
"totalNoOfRecords": 0,
"list": [
{
"orderNumber": "string",
"orderId": "string",
"originalOrderId": "string",
"orderReferenceId": "string",
"orderQty": 0,
"orderType": "string",
"orderSide": "string",
"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,
"cumulativeVatAmount": 0,
"cumulativeStampDutyAmount": 0,
"lastUpdatedTime": "string",
"amount": 0
}
],
"pageNo": 1
}
{
"status": "SUCCESS",
"reason": "order search success",
"rejectCode": 0,
"isNextPageAvailable": true,
"pageNo": 1,
"pageWidth": 5,
"totalNoOfRecords": 8,
"list": [
{
"orderNumber": "24F222000002",
"orderId": "24F222000003",
"originalOrderId": "24F222000002",
"orderReferenceId": "Efb44f83319e4",
"orderQty": 250,
"orderType": "2",
"orderSide": "1",
"orderStatus": "2",
"orderValue": 2500,
"commission": 1.01,
"accountNumber": "P000284400",
"currency": "USD",
"price": 10,
"symbol": "AAPL",
"text": null,
"tif": 0,
"transactionTime": "2024/01/22-08:46:33",
"orderRejectReason": null,
"rejectReason": null,
"exchange": "NSDQ",
"createdDate": "2024/01/22-08:44:11",
"averagePrice": 10,
"marketCode": "ALL",
"settleCurrency": "USD",
"cumulativeQty": 250,
"cumulativeOrderValue": 2500,
"cumulativeOrderNetValue": 2876.01,
"cumulativeCommission": 1.01,
"cumulativeOrderNetSettle": 2876.01,
"lastUpdatedTime": "2024/01/22-08:46:33",
"status": "2",
"cumulativeVatAmount": 0,
"cumulativeStampDutyAmount": 0
}
]
}
{
"status": "SUCCESS",
"reason": "order search success",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 0,
"pageWidth": 0,
"totalNoOfRecords": 4,
"list": [
{
"orderNumber": "CB240215-2-00001",
"orderId": "CB240215-2-00001",
"orderReferenceId": "CB8e920b36e422",
"orderQty": 2,
"orderType": "1",
"orderSide": "1",
"orderStatus": "M",
"amount": 700,
"commission": 0.07,
"accountNumber": "P000284369",
"currency": "USD",
"price": 35,
"symbol": "ANF 07/15/25 8.75",
"tif": 0,
"exchange": "GTNFI",
"createdDate": "2024/02/15-04:06:37",
"averagePrice": 0,
"cumulativeQty": 0,
"cumulativeOrderValue": 0,
"cumulativeOrderNetValue": 0,
"cumulativeCommission": 0,
"cumulativeOrderNetSettle": 0,
"lastUpdatedTime": "2024/02/15-12:11:09",
"cumulativeVatAmount": 0,
"cumulativeStampDutyAmount": 0,
"securityType": "BND",
"principal": 700,
"accruedInterest": 0
}
]
}
{
"status": "SUCCESS",
"reason": "order search success",
"rejectCode": 0,
"isNextPageAvailable": false,
"pageNo": 1,
"pageWidth": 100,
"totalNoOfRecords": 11,
"list": [
{
"clientOrderId": "O24G06200001",
"orderNumber": "O24G06200001",
"orderId": "O24G06200001",
"orderReferenceId": "O327b61c48ec1",
"orderQty": 50,
"orderType": "2",
"orderSide": "1",
"orderStatus": "M",
"orderValue": 50000,
"commission": 1010,
"accountNumber": "P000284400",
"currency": "USD",
"price": 10,
"symbol": "AAPL\\\\24D19\\\\105.0",
"tif": 0,
"exchange": "OPRA",
"createdDate": "2024/02/06-04:59:12",
"averagePrice": 0,
"marketCode": "ALL",
"settleCurrency": "USD",
"cumulativeQty": 0,
"cumulativeOrderValue": 0,
"cumulativeOrderNetValue": 0,
"cumulativeCommission": 0,
"cumulativeOrderNetSettle": 0,
"lastUpdatedTime": "2024/02/06-04:59:12",
"status": "M",
"cumulativeVatAmount": 0,
"cumulativeStampDutyAmount": 0
},
{
"clientOrderId": "O24G02200004",
"orderNumber": "O24G02200004",
"orderId": "O24G02200004",
"orderQty": 50,
"orderType": "1",
"orderSide": "1",
"orderStatus": "M",
"orderValue": 454000,
"commission": 9090,
"accountNumber": "P000284400",
"currency": "USD",
"price": 0,
"symbol": "AAPL\\\\24D19\\\\105.0",
"tif": 6,
"exchange": "OPRA",
"createdDate": "2024/02/02-08:54:16",
"averagePrice": 0,
"marketCode": "ALL",
"settleCurrency": "USD",
"cumulativeQty": 0,
"cumulativeOrderValue": 0,
"cumulativeOrderNetValue": 0,
"cumulativeCommission": 0,
"cumulativeOrderNetSettle": 0,
"lastUpdatedTime": "2024/02/02-08:54:19",
"status": "M",
"cumulativeVatAmount": 0,
"cumulativeStampDutyAmount": 0
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Invalid Token
- Expired Token
Schema
{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string",
"rejectCode": "string"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Invalid Token",
"path": "/api/v1.1/orders/search",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.1/orders/search",
"rejectCode": "1007"
}