Get Order Book
API to retrieve the list of a orders placed for the current day. Orders initiated by the user remain active for a single day and are automatically cleared at the conclusion of the trading session. The reply indicates the most current status of the order. For a comprehensive list of all possible order statuses, please refer to the appendix on order status.
Header Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | true | string | Requires the format Bearer access_token where access_token is obtained from the Token API. |
| Accept | true | string | Defines the content format the client expects, which should be set to application/json. |
Responses
- 200
Response Body
[
{
"exchange": "BSE",
"product": "D",
"price": 0.8,
"quantity": 1,
"status": "complete",
"guid": null,
"tag": null,
"instrument_token": "BSE_EQ|INE220J01025",
"placed_by": "*****",
"trading_symbol": "FCONSUMER",
"tradingsymbol": "FCONSUMER",
"order_type": "LIMIT",
"validity": "DAY",
"trigger_price": 0,
"disclosed_quantity": 0,
"transaction_type": "BUY",
"average_price": 0.8,
"filled_quantity": 1,
"pending_quantity": 0,
"status_message": null,
"status_message_raw": null,
"exchange_order_id": "1697686200000169148",
"parent_order_id": null,
"order_id": "231019025057849",
"variety": "SIMPLE",
"order_timestamp": "2023-10-19 09:23:23",
"exchange_timestamp": "2023-10-19 09:23:23",
"is_amo": false,
"order_request_id": "2",
"order_ref_id": "57744821658411"
},
{
"exchange": "NFO",
"product": "I",
"price": 0,
"quantity": 1500,
"status": "rejected",
"guid": null,
"tag": null,
"instrument_token": "NSE_FO|52567",
"placed_by": "******",
"trading_symbol": "SBIN23OCTFUT",
"tradingsymbol": "SBIN23OCTFUT",
"order_type": "SL-M",
"validity": "DAY",
"trigger_price": 570,
"disclosed_quantity": 0,
"transaction_type": "SELL",
"average_price": 0,
"filled_quantity": 0,
"pending_quantity": 0,
"status_message": "You need to add Rs. 138385.27 in your account to place this trade.",
"status_message_raw": "RMS:Margin Exceeds,Required:153892.45, Available:15507.18 for entity account-****** across exchange across segment across product ",
"exchange_order_id": "",
"parent_order_id": null,
"order_id": "231019025000398",
"variety": "SIMPLE",
"order_timestamp": "2023-10-19 09:15:00",
"exchange_timestamp": null,
"is_amo": false,
"order_request_id": "1",
"order_ref_id": "33832759664502"
},
{
"exchange": "BFO",
"product": "D",
"price": 0.05,
"quantity": 10,
"status": "cancelled",
"guid": null,
"tag": null,
"instrument_token": "BSE_FO|822663",
"placed_by": "******",
"trading_symbol": "SENSEX23O2066000PE",
"tradingsymbol": "SENSEX23O2066000PE",
"order_type": "LIMIT",
"validity": "DAY",
"trigger_price": 0,
"disclosed_quantity": 0,
"transaction_type": "BUY",
"average_price": 0,
"filled_quantity": 0,
"pending_quantity": 10,
"status_message": null,
"status_message_raw": null,
"exchange_order_id": "1697687100012002451",
"parent_order_id": null,
"order_id": "231019025000428",
"variety": "SIMPLE",
"order_timestamp": "2023-10-19 09:30:53",
"exchange_timestamp": "2023-10-19 09:30:53",
"is_amo": false,
"order_request_id": "1",
"order_ref_id": "1168356875930923"
}
]
| Name | Type | Description | |
|---|---|---|---|
| status | string | A string indicating the outcome of the request. Typically success for successful operations. | |
| data | object | Response data for order Book | |
| data[].exchange | string | Exchange to which the order is associated. Valid exchanges can be found in the Exchange Appendix | |
| data[].product | string | Signifies if the order was either Intraday, Delivery or CO. Possible values: I, D, CO, MTF. | |
| data[].price | float | Price at which the order was placed | |
| data[].quantity | int32 | Quantity with which the order was placed | |
| data[].status | string | Indicates the current status of the order. Valid order statuses can be found in the Order Status Appendix | |
| data[].tag | string | Tag to uniquely identify an order | |
| data[].instrument_token | string | Key of the instrument. For the regex pattern applicable to this field, see the Field Pattern Appendix. | |
| data[].placed_by | string | Uniquely identifies the user (commonly referred as UCC) | |
| data[].trading_symbol | string | Shows the trading symbol of the instrument | |
| data[].order_type | string | Type of order. It can be one of the following MARKET refers to market order LIMIT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market. Possible values: MARKET, LIMIT, SL, SL-M. | |
| data[].validity | string | It can be one of the following - DAY(default), IOC. Possible values: DAY, IOC. | |
| data[].trigger_price | float | If the order was a stop loss order then the trigger price set is mentioned here | |
| data[].disclosed_quantity | int32 | The quantity that should be disclosed in the market depth | |
| data[].transaction_type | string | Indicates whether its a buy or sell order. Possible values: BUY, SELL. | |
| data[].average_price | float | Average price at which the qty got traded | |
| data[].filled_quantity | int32 | The total quantity traded from this particular order | |
| data[].pending_quantity | int32 | Pending quantity to be filled | |
| data[].status_message | string | Indicates the reason when any order is rejected, not modified or cancelled | |
| data[].status_message_raw | string | Description of the order's status as received from RMS | |
| data[].exchange_order_id | string | Unique order ID assigned by the exchange for the order placed | |
| data[].parent_order_id | string | In case the order is part of the second of a CO, the parent order ID is indicated here | |
| data[].order_id | string | Unique order ID assigned internally for the order placed | |
| data[].variety | string | Order complexity | |
| data[].order_timestamp | string | User readable timestamp at which the order was placed | |
| data[].exchange_timestamp | string | User readable time at which the order was placed or updated | |
| data[].is_amo | boolean | Signifies if the order is an After Market Order | |
| data[].order_request_id | string | Apart from 1st order it shows the count of how many requests were sent | |
| data[].order_ref_id | string | Uniquely identifies an order for internal usage. |
Notice of Deprecation
The lowercase field (tradingsymbol) is deprecated and will be removed in future versions. Use the snake_case versions for consistency.
Examples
A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.
Loading...