TRADE BOOK
This API retrieves the Trade Book for authorized end users through a middleware-based integration.
The Trade Book contains details of executed trades, including trade prices, quantities, exchange trade numbers, and associated order information.
| Fields | Type | Required | Description | Example |
|---|
| Authorization | string | Yes | Bearer token for authentication | access_token |
| x-api-key | string | Yes | API key provided | x-api-key |
🔍 Query Parameters
| Fields | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | {{user_id}} |
| offset | integer | No | Specifies the page number of the collection to be displayed | 1 |
| limit | integer | No | Limits the number of items returned per page | 100 |
| order_ids | string | No | Comma-separated Order IDs to fetch trades for multiple orders | NXVZO00105K1,NXVZO00104K1 |
🟢 Success Response - 200 OK
| Fields | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "Trade Book fetched successfully" |
| data | array(object) | List of trade records | See below table |
📘 Trade Object Fields
| Fields | Type | Description | Example |
|---|
| order_id | string | System-generated unique order number | "NXVZO00105K1" |
| exchange | string | Exchange segment | "NSE_EQ" |
| scrip_token | integer | Exchange token number of the scrip | 1594 |
| trade_no | string | Exchange Trade Number | "123456789" |
| exchange_order_no | string | Exchange order number | "120000000123456" |
| transaction_type | string | Buy or Sell transaction | "BUY" |
| product_type | string | Product type | "D" |
| order_type | string | Order type | "RL" |
| traded_quantity | integer | Executed trade quantity | 100 |
| trade_price | string | Price at which trade was executed | "2500.50" |
| symbol | string | Trading symbol | "INFY" |
| series | string | Series | "EQ" |
| instrument | number | Instrument type/name | 1 |
| expiry_date | string | Contract expiry date | "2026-07-30" |
| strike_price | string | Strike price | "2500000" |
| option_type | string | Option type | "CE" |
| trade_timestamp | string | Timestamp at which trade was registered by the OMS | "2026-07-02 10:15:31" |
| initiated_by | string | Application identifier from which the order was placed | "MOBAPP" |
| modified_by | string | Application identifier from which the order was modified | "WEBAPP" |
| order_identifier | string | User-defined order reference | "ORD001" |
| Fields | Type | Description | Example |
|---|
| total_records | number | Total number of trade records available | 250 |