ORDER BOOK

This API returns the complete list of orders from the All Orders tab, including pending, completed, and all orders based on filters.

🔍 Query Parameters

Parameter	Type	Required	Description	Example
client_id	string	No	Client ID to fetch orders for a specific user	client_id=VISHAL1
offset	integer	No	Page number for pagination	offset=1
limit	integer	No	Number of records per page	limit=20
orderStatus	number	No	Filter orders (1 = Pending, 2 = Completed, -1 = All)	orderStatus=-1

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request	application/json
Authorization	string	Access token for authenticated requests	{{access_token}}
x-api-key	string	API key used to authorize the request	{{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 to user request	"s-101"
message	string	Success message	"Order book fetched successfully"
data	array	List of orders	Refer to Data Object Fields
metadata	object	Summary of order records	Refer to Metadata Fields

📦 Data Object Fields

Field	Type	Description	Example / Enum
order_id	string	Unique system-generated order ID	"NWSDJ00015H3"
exchange	string	Exchange segment	"NSE_EQ"
scrip_token	integer	Exchange token of instrument	12345
exchange_order_no	string	Exchange order number	"110000000001234"
status	string	Current order status	"OPEN", "COMPLETE", "CANCELLED", "REJECTED"
error_reason	string	Error/rejection/cancellation reason	"Insufficient margin"
transaction_type	string	Transaction type	"BUY", "SELL"
product_type	string	Product type	"MIS", "CNC", "NRML"
order_type	string	Order type	"MARKET", "LIMIT", "SL", "SL-M"
total_quantity	integer	Original order quantity	100
pending_quantity	integer	Pending quantity	40
traded_quantity	integer	Executed quantity	60
disclosed_quantity	integer	Quantity disclosed to market	50
order_price	number	Order price	2500.50
trigger_price	number	Trigger price	2490.00
validity	string	Order validity	"DAY", "IOC", "GTD"
validity_days	integer	GTD validity in days	5
symbol	string	Trading symbol	"RELIANCE"
series	string	Series	"EQ"
instrument	number	Instrument type	1
expiry_date	string	Expiry date	"2026-06-25"
strike_price	string	Strike price	"2500"
option_type	string	Option type	"CE", "PE"
market_lot	integer	Lot size	50
order_timestamp	string	OMS order timestamp	"2026-06-08 10:15:00"
exchange_timestamp	string	Exchange timestamp	"2026-06-08 10:15:02"
initiated_by	string	Source application for order placement	"WEB", "MOBILE", "DEALER"
modified_by	string	Source application for order modification	"WEB"
is_amo_order	string	Indicates AMO order	"true", "false"
gateway_order_id	string	Internal gateway order ID	"GW12345678"
order_identifier	string	Custom order identifier (max 10 chars)	"ORD001"
bracket_details	object	Bracket order details	Refer Bracket Details Fields

📘 Bracket Details Fields

Field	Type	Description	Example / Enum
parent_order_id	string	Main leg order ID	"ORD123456"
leg_indicator	string	Bracket order leg type	"MAIN", "SL", "TARGET"
stoploss_price	number	Stop-loss order price	2450.00
stoploss_trigger_price	number	Stop-loss trigger price	2455.00
profit_price	number	Profit booking price	2550.00
stoploss_jump_price	number	Trailing SL increment value	1.00
ltp_jump_price	number	LTP movement increment	2.00
bo_order_id	string	Bracket order ID	"BO12345"
bo_order_status	string	Bracket order status	"NOT_INITIATED", "COMPLETED", "STOPPED", "CONVERTED"
bo_modify_flag	number	Modifiable bracket legs	0, 1, 2, 4, 6, 7

📌 BO Modify Flag Values

Value	Meaning
0	Modification not allowed
1	Main leg editable
2	Stop-loss leg editable
4	Profit leg editable
6	Stop-loss & Profit legs editable
7	All legs editable

📊 Metadata Fields

Field	Type	Description
total_records	number	Total orders count
all_records	number	All orders count
completed_records	number	Completed orders count
open_records	number	Open orders count