Multileg Order Book
This API represents multileg order book records
🔍Query Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| offset | integer | no | Page number of the collection to be displayed | offset=1 |
| limit | integer | no | Limits number of items per page | limit=20 |
| orderType | string | Yes | Only multileg and spread allowed | ordertype=multileg |
| orderStatus | string | no | 1=Pending, 2=Completed, -1=All orders | orderstatus=1 |
🔑Header Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Authorization | string | yes | Bearer token for authentication | access_token |
| Content_type | string | yes | MIME Type | application/JSON |
| x-api-key | string | yes | API key provided by bearer | x-api-key |
🟢Success Response - 200 OK
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| Status | String | Response of the API status | success |
| Code | string | Response code to the user request | "s-101" |
| Message | string | Human readable message | "Order fetched successfully" |
| Data | array of objects | List of multi leg order objects | See below table |
| metadata | object | Metadata regarding total/completed/open orders | See below table |
📑Data object fields
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| order_id | string | System-generated unique code | ORD13456 |
| client_order_no | string | Client order number | CL1232456 |
| gateway_order_no | string | Internal gateaway order number | GTW123456 |
| segment_id | integer | Exchange segment ID | 2 |
| exchange | string | Exchange segments | NSE |
| book_type | integer | Book type | 1 |
| leg_indicator | string | Type of multileg order | spread |
| status | string | Order Status | Pending |
| order_timestamp | string | Order resgistration timestamp | 2023-10-01T10:45:00 |
| order_modified_timestamp | string | Last modified timestamp | 2023-10-01T10:48:00 |
| settlement_days | integer | Days to settlement | 2 |
| spread_symbol | string | Spread scrip symbol | BANKNIFY23JUNFUT |
| error_reason | string | Reason for cancellation or error | Insufficient Margin |
| validity | string | Order Validity | DAY |
| spread_token | integer | Token number for spread scrip | 34567 |
| ordertime | integer | Order time (timestamp format) | 16996153500 |
| leg_no_1 | object | Details of leg no 1 | See table below |
| leg_no_2 | object | Details of leg no 2 | See table below |
| leg_no_3 | object | Details of leg no 3 | See table below |
🧾Leg_no_1 object fields
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| transaction_type | string | buy or sell | BUY |
| instrument | number | instrument name | RELIANCE |
| symbol | string | scrip symbol | "BANKNIFTY" |
| expiry_date | string | Contract expiry date | 2025-06-22 |
| strike_price | string | Strike price (usually in paise) | 15000 |
| option_type | string | CE (Call) or PE (put) | CE |
| total_quantity | integer | total order quantity | 10 |
| traded_quantity | integer | traded quantity | 10 |
| pending_quantity | integer | pending quantity | 12 |
| order_price | number | price at which order was placed | 150.25 |
| scrip_token | integer | Token number of the instrument | 123 |
| exchange_order_no | string | Exchange order number | EXORD123456789 |
| product_type | string | Product type | "DELIVERY" |
| price_tick | integer | Minimum price tick size | 5 |
| decimal_loc | number | decimal locator | 2 |
| market_lot | integer | market lot size | 25 |
🧾Leg_no_2 object fields
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| transaction_type | string | buy or sell | BUY |
| instrument | number | instrument name | RELIANCE |
| symbol | string | scrip symbol | "BANKNIFTY" |
| expiry_date | string | Contract expiry date | 2025-06-22 |
| strike_price | string | Strike price (usually in paise) | 15000 |
| option_type | string | CE (Call) or PE (put) | CE |
| total_quantity | integer | total order quantity | 10 |
| traded_quantity | integer | traded quantity | 10 |
| pending_quantity | integer | pending quantity | 12 |
| order_price | number | price at which order was placed | 150 |
| scrip_token | integer | Token number of the instrument | 123 |
| exchange_order_no | string | Exchange order number | EXORD123456789 |
| product_type | string | Product type | "DELIVERY" |
| price_tick | integer | price tick size | 5 |
| decimal_loc | number | decimal locator | 2 |
| market_lot | integer | market lot size | 25 |
🧾Leg_no_3 object details
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| transaction_type | string | buy or sell | BUY |
| instrument | number | instrument name | RELIANCE |
| symbol | string | scrip symbol | "BANKNIFTY" |
| expiry_date | string | Contract expiry date | 2025-06-22 |
| strike_price | string | Strike price (usually in paise) | 15000 |
| option_type | string | CE (Call) or PE (put) | CE |
| total_quantity | integer | total order quantity | 10 |
| traded_quantity | integer | traded quantity | 10 |
| pending_quantity | integer | pending quantity | 12 |
| order_price | number | price at which order was placed | 200 |
| scrip_token | integer | Token number of the instrument | 1234 |
| exchange_order_no | string | Exchange order number | EXORD123456789 |
| product_type | string | Product type | "DELIVERY" |
| price_tick | integer | price tick size | 5 |
| decimal_loc | number | decimal locator | 2 |
| market_lot | integer | market lot size | 30 |
🧾Metadata object fields
| Fields | Type | Description | Example/ |
|---|---|---|---|
| total_records | number | Total order count | 55 |
| all_records | number | All order count | 55 |
| completed_records | number | Total completed orders | 26 |
| open_records | number | Total open/pending orders | 10 |
get
/transactional/v1/multilegOrders