Order Book

This call displays all the orders placed by the User in a single window.

🔍Query Parameters

Fields	Type	Required	Description	Example/Enum
offset	integer	no	Specifies the page number of the collection to be displayed	offset=1
limit	integer	no	Limits the number of items on the page	limit=20
orderstatus	string	no	Filters Order by Status: 1=pending , 2 = completed, -1 = All orders	order status = 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	no	API key provided by bearer	x-api-key

🟢Success Response - 200K

Fields	Type	Description	Example/Enum
status	string	Request status	Sucess
code	string	Response code	s-101
message	string	Message corresponding	Order fetched successfully
data	array	List of orders with detailed info	See below table
metadata	object	Metadata regarding total/completed/open orders	See below table

📑Order object fields (Each item in data)

Fields	Type	Description	Example/Enum
order_id	string	System-generated unique order number	ORD123456789
exchange	string	Exchange segments	BSE
scrip_token	integer	Token number of the scrip/instrument	101234
exchange_order_no	string	Exchange order number	EXORD123456789
status	string	Status of the order	Completed
error_reason	string	Error message if order is cancelle/ rejeted/not modified	Insufficient funds
transaction_type	string	Order type: Buy or Sell	BUY
product_type	string	Product type	DELIVERY
order_type	string	Order Types	LIMIT
total_quantity	integer	Original quantity of the order	100
pending_quantity	integer	Quantity still pending	0
traded_quantity	integer	Traded quantity	100
disclosed_quantity	integer	Display quantity in the market	0
order_price	number	Price at which order was placed	105.50
trigger_price	number	Trigger price	104.00
validity	string	Order Validity	DAY
validity_day	integer	Validity in days (for GTD orders)	5
symbol	string	Symbol code from exchange	RELIANCE
series	string	Series of the instrument	EQ
instruments	number	Instrument identifier	123456
expiry_date	string	Expiry date or contracts	2025-06-02
strike price	string	Strike price in paise	15000
option_type	string	CE (call) or PE(put)	CE
market_lot	integer	Lot size of the scrip	1
order_timestamp	string	Time when OMS registered the order	2025-06-01T10:20
exchange_timestamp	string	Time when exchange resgistered the order	2025-06-01T10:20
inititated_by	string	Application ID that placed the order	APP123
modified_by	string	Application ID that modified the order	APP456
is_amo_order	string	Whether it is AMO (After Market Order)	false
gateway_order_id	string	Internal gateway orderID	GW123456
order_identifier	string	Optional field for trackin the order	user001
bracket_details	objects	Present if order is BO	See below table

📑Bracket details object fields

Fields	Type	Description	Example/Enum
parent_order_ID	string	Order ID of main leg	ORD123
leg_indicator	string	Identifies leg type (main, stoploss, profit)	MAIN
stoploss_price	number	Stoploss price	95.00
stoploss_trigger_price	number	stoploss trigger price	94.00
profit_price	number	Target profit price	110.00
stoploss_jump_price	number	Stoploss trail jump price	0.50
ltp_jump_price	number	LTP trail jump price	0.25
bo_order_id	string	Bracket order ID	BO12345
bo_order_status	string	Status of Bracket Order	EXECUTED
bo_modify_flag	number	Legs allowed to be modified (0-7)0- Modification is not allowed 1- Main leg 2- Stop loss leg 4- Profit leg 6- Both stop loss & profit leg 7- All legs	6

📑Metadata Fields

Fields	Type	Description	Example/Enum
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/orders