MULTILEG ORDER BOOK

This API returns the multileg / spread order book records, including all legs and associated execution details.

🔍 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
orderType	string	No	Type of multileg orders	"multileg", "spread"

🔑 Header Parameters

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	"200"
message	string	Success message	"Multileg order book fetched successfully"
data	array	List of multileg orders	Refer Data Object Fields
metadata	object	Summary information	Refer Metadata Fields

📦 Data Object Fields

Field	Type	Description	Example / Enum
order_id	string	Unique order ID	"ORD12345"
client_order_no	string	Client order number	"CLORD001"
gateway_order_no	string	Gateway order number	"GW000123"
segment_id	integer	Exchange segment ID	1
exchange	string	Exchange segment	"NSE_FO"
book_type	integer	Book type	1
leg_indicator	string	Multileg type	"SPREAD", "2L", "3L"
status	string	Order status	"OPEN", "COMPLETE", "CANCELLED"
order_timestamp	string	Order placed time	"2026-05-27 10:00:00"
order_modified_timestamp	string	Last modified time	"2026-05-27 10:05:00"
settlement_days	integer	Settlement days	2
spread_symbol	string	Spread symbol	"NIFTY-SPREAD"
error_reason	string	Error message	"Rejected due to margin"
validity	string	Order validity	"IOC", "DAY"
spread_token	integer	Spread token	56789
ordertime	integer	Order time	1716796800
order_identifier	string	Custom identifier	"ML123"

📘 Leg 1 Object Fields

Field	Type	Description	Example / Enum
transaction_type	string	BUY or SELL	"BUY"
instrument	number	Instrument type	1
symbol	string	Symbol	"NIFTY"
expiry_date	string	Expiry date	"2026-06-25"
strike_price	string	Strike price	"18000"
option_type	string	Option type	"CE", "PE"
total_quantity	integer	Total quantity	50
traded_quantity	integer	Executed quantity	25
pending_quantity	integer	Pending quantity	25
order_price	number	Order price	100.5
scrip_token	integer	Token	12345
exchange_order_no	string	Exchange order ID	"EX12345"
product_type	string	Product type	"MIS", "NRML"
price_tick	integer	Tick size	5
decimal_loc	number	Decimal precision	2
market_lot	integer	Lot size	50

📘 Leg 2 Object Fields

(Same structure as Leg 1)

📘 Leg 3 Object Fields

(Same structure as Leg 1)

📊 Metadata Fields

Field	Type	Description	Example
total_records	number	Total orders count	100
all_records	number	All orders count	100
completed_records	number	Completed orders count	60
open_records	number	Open orders count	40