Skip to main content

PLACE MULTILEG / SPREAD ORDER API

This API allows you to place multileg or spread orders, where multiple legs (2-leg, 3-leg, or spread) can be executed together as a single strategy.

It is typically used for advanced trading strategies like spreads, arbitrage, and hedging.

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the requestapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample / Enum
typestringYesType of multileg order"SPREAD", "2L", "3L"
order_typestringNoOrder type (RL / RL-MKT only)"RL"
order_identifierstringNoCustom tracking ID (≤10 chars)"ML123"
validitystringNoOrder validity"IOC"
leg_detailsarrayYesIndividual leg detailsRefer below

📦 Leg Details Object

FieldTypeRequiredDescriptionExample
leg_nointegerYesLeg number1
scrip_infoobjectYesInstrument detailsRefer below
transaction_typestringNoBUY or SELL"BUY"
quantitynumberNoQuantity per leg10
pricestringNoPrice per leg"100.5"
othersobjectNoAdditional instrument infoRefer below

📘 Scrip Info Object Fields

FieldTypeRequiredDescriptionExample / Enum
exchangestringYesExchange segment"NSE_FO"
scrip_tokenintegerNoExchange token12345
symbolstringNoSymbol"NIFTY"
seriesstringNoSeries (equity)"EQ"
expiry_datestringNoExpiry date (YYYY-MM-DD)"2026-06-25"
strike_pricenumberNoStrike price (options)18000
option_typestringNoOption type"CE"

🔧 Others Object Fields

FieldTypeDescriptionExample
market_lotintegerLot size of the scrip50
price_ticknumberPrice tick size0.05
decimal_locnumberDecimal locator2

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"Multileg order placed successfully"
dataobjectOrder response payloadRefer to Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
orderIdstringSystem-generated order identifier"ORD789123"
gateway_order_nostringGateway order reference number"GW12345678"