Trade Book
The Trade Book API lets you fetch list of trades executed of current day by the user.
🔍Query Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| offset | integer | no | Specifies the page number of the collection to be displayed | 1 |
| limits | integer | no | Limits the numer of items on the page | 100 |
| order_id | string | no | Single order ID to filter trades (URL-encoded if special characters present) | NXWAO00001N3 |
🟢Success Response - 200 Ok
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| status | string | Indicates the result of API Call | "success" |
| code | string | Response code corresponding to the request | "s-101" |
| message | string | Descriptive message for the response | "Success Message" |
| data | array of objects | List of trader records | See below table |
📘 Data object fields
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| order_id | string | System-generated unique order number | XWAO0000N3 |
| exchange | string | Exchange segments | NSE_EQ |
| scrip_token | integer | Token number of the instrument | 12345 |
| trade_no | string | Exchange Trade number | TRD1234567890 |
| exchange_order_no | string | Exchange order number | EXORD1234567 |
| transaction_type | string | BUY or SELL | BUY |
| product_type | string | Product type | DELIVERY |
| order_type | string | Order Types | LIMIT |
| traded_quantity | integer | Traded quantity | 100 |
| trade_price | string | Price at which trade was executed | 865.5 |
| symbol | string | Sybmol code from excange scripmaster file | TCS |
| series | string | Series of the instrument | EQ |
| instrument | number | Instrument name or code | 101 |
| expiry_date | string | Expiry date of the contract | 2025-02-02 |
| strike_price | string | Strike price in paise | 89000 |
| option_type | string | Option type: CE call or PE put | CE |
| trade_timestamp | string | Time of trade execution | 2025-06-08T11:22Z |
| initiated_by | string | App ID or terminal ID that initiated the order | WEB_APP_01 |
| modified_by | string | App ID or terminal ID that modified the order | MOBILE_APP_002 |
| order_identifier | string | Optioal identifier to track | TRACK123 |
📘 Metadata
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| Total_records | string | Total count records | 12 |
🔴 Error Response - 400 Bad Request
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of the API call Default Error | "error" |
| code | string | Error code indicating the failure | "e-101" |
| message | string | Specific message explaining the reason for failed request. | "Error Message" |
get
/transactional/v1/trades