GTD ORDER BOOK
This API returns the Good Till Date (GTD) order book records, including all pending and completed GTD orders.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example / Enum |
|---|
| offset | integer | No | Page number for pagination | 1 |
| limit | integer | No | Number of records per page | 20 |
| orderStatus | number | No | Order filter | 1 = Pending, 2 = Completed, -1 = All |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token | {{access_token}} |
| x-api-key | string | API key | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "GTD order book fetched successfully" |
| data | array | List of GTD orders | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example / Enum |
|---|
| order_id | string | Unique order ID | "ORD12345" |
| exchange | string | Exchange segment | "NSE_EQ" |
| scrip_token | integer | Scrip token | 12345 |
| exchange_order_no | string | Exchange order ID | "EX98765" |
| status | string | Order status | "OPEN", "COMPLETE", "CANCELLED" |
| error_reason | string | Error message | "Insufficient balance" |
| transaction_type | string | Buy/Sell | "BUY", "SELL" |
| product_type | string | Product type | "MIS", "CNC" |
| order_type | string | Order type | "LIMIT", "MARKET", "SL" |
| total_quantity | integer | Total quantity | 100 |
| pending_quantity | integer | Pending quantity | 40 |
| traded_quantity | integer | Executed quantity | 60 |
| disclosed_quantity | integer | Disclosed quantity | 50 |
| order_price | number | Order price | 250.75 |
| trigger_price | number | Trigger price | 245.50 |
| validity | string | Order validity | "GTD" |
| validity_days | integer | Validity duration in days | 5 |
| symbol | string | Symbol | "INFY" |
| series | string | Series | "EQ" |
| instrument | number | Instrument type | 1 |
| expiry_date | string | Expiry date | "2026-06-25" |
| strike_price | string | Strike price | "1500" |
| option_type | string | Option type | "CE", "PE" |
| market_lot | integer | Lot size | 1 |
| order_timestamp | string | Order placement time | "2026-05-27 10:00:00" |
| initiated_by | string | Order source | "WEB", "MOBILE", "DEALER" |
| modified_by | string | Modification source | "WEB" |
| gateway_order_id | string | Gateway order ID | "GW123456" |
| order_identifier | string | Custom identifier (≤10 chars) | "GTD001" |