Multileg Order Book

This API retrieves the Multileg/Spread Order Book for authorized end users through a middleware-based integration.

The API provides details of all Multileg and Spread Orders, including order status, leg-wise information, execution details, and pagination metadata.

Fields	Type	Required	Description	Example
Authorization	string	Yes	Bearer token for authentication	`access_token`
x-api-key	string	Yes	API key provided	`x-api-key`

Fields	Type	Required	Description	Example
userId	string	Yes	User ID (UCC)	`{{user_id}}`
offset	integer	No	Specifies the page number of the collection to be displayed	`1`
limit	integer	No	Limits the number of items returned per page	`20`
orderStatus	number	No	Filter orders by status	`-1`
orderType	string	No	Filter by order type	`multileg`

Fields	Type	Description	Example
status	string	Response status	`"success"`
code	string	Response code	`"s-101"`
message	string	Success message	`"Multileg Order Book fetched successfully"`
data	array(object)	List of Multileg/Spread Orders	See below table

Fields	Type	Description	Example
order_id	string	System-generated order number	`"ML25070001"`
client_order_no	string	Client order number	`"CL123456"`
gateway_order_no	string	Internal gateway order number	`"AAAEE00005"`
segment_id	integer	Exchange segment ID	`2`
exchange	string	Exchange segment	`"NSE_FO"`
book_type	integer	Book type	`1`
leg_indicator	string	Type of multileg order	`"SPREAD"`
status	string	Order status	`"OPEN"`
order_timestamp	string	Order creation timestamp	`"2026-07-02 10:15:30"`
order_modified_timestamp	string	Last modification timestamp	`"2026-07-02 10:20:10"`
settlement_days	integer	Settlement days	`1`
spread_symbol	string	Spread scrip symbol	`"NIFTY JUL FUT-AUG FUT"`
error_reason	string	Error message if order was rejected/cancelled	`"Insufficient Margin"`
validity	string	Order validity	`"IOC"`
spread_token	integer	Spread scrip token	`87654`
ordertime	integer	Order time	`1751434530`

Fields	Type	Description	Example
transaction_type	string	Buy or Sell transaction	`"BUY"`
instrument	number	Instrument type/name	`1`
symbol	string	Trading symbol	`"NIFTY"`
expiry_date	string	Contract expiry date	`"2026-07-30"`
strike_price	string	Strike price	`"2500000"`
option_type	string	Option type	`"CE"`
total_quantity	integer	Original quantity of the leg	`50`
traded_quantity	integer	Executed quantity	`25`
pending_quantity	integer	Pending quantity	`25`
order_price	number	Order price	`150.50`
scrip_token	integer	Exchange token number	`56838`
exchange_order_no	string	Exchange order number	`"120000000123456"`
product_type	string	Product type	`"M"`
price_tick	integer	Tick size of the scrip	`5`
decimal_loc	number	Decimal Locator	`2`
market_lot	integer	Market lot size	`50`

Fields	Type	Description	Example
total_records	number	Total records returned in current response	`20`
all_records	number	Total order count	`150`
completed_records	number	Total completed orders count	`90`
open_records	number	Total open orders count	`60`

MULTILEG ORDER BOOK​