Skip to main content

PLACE BRACKET ORDER

This API enables placement of Bracket Orders for authorized end users through a middleware-based integration.

A Bracket Order consists of a primary Buy/Sell order along with a Profit Booking order and a Stop Loss order. Once the primary order is executed, the profit and stop loss legs are managed as linked exit orders.

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📦Request Body Schema​

FieldsTypeRequiredDescriptionExample/Enum
scrip_infoobjectyesScrip information can be sent in 2 ways. either by sending exchange and scrip token or by sending scrip details i.e. exchange, symbol, series, expiry, strike price & option type.See table below
transaction_typestringyesWhether the Order is "Buy" or "Sell"BUY
main_legobjectyesMain order leg (entry order)See below table
stoploss_legobjectyesStop loss order legSee below table
profit_legobjectYesTarget profit order legSee below table
order_identifierstringnoOptional client reference (max 10 characters)BRKT1234
part_codestringnoCustodian participant code (if applicable)XYZ01
algo_idstringnoAlgo ID for strategy based orderALG5678
strategy_idstringnoStrategy group identifierSTRAT234
vender_codestringnoInternal vendor reference codeVNDR009
product_sourcestringNoSource of the order. Allowed values: WEBAPI, MOBILEAPI (case-insensitive). Any other value is ignored without an error."WEBAPI"

📑Scrip info object fields​

FieldsTypeRequiredDescriptionExample/ENUM
exchangestringyesExchange segmentsNSE_EQ
scrip tokenintegernoExchange token number1234
symbolstringnoTrading symbol (required if token not used)RELIANCE
seriesstringnoSeries (required for equity instruments )EQ
expiry_datestringnoExpiry date (for F&O), format yyyy-mm-dd2025-06-28
strike_pricenumbernoStrike price (in paise for options)220000
option_typestringno"CE" for Call, "PE" for Put (for options)CE

📑Main Leg Object Fields​

FieldsTypeRequiredDescriptionExample/ENUM
order_typestringyesOrder Types , Only RL or RL-MKT supportedRL
quantityintegeryesQuantity to trade100
pricenumberyesPrice for the main leg ( 0 for market)2500.0
trigger_pricenumberyesCurrently should always be set to 00

📑Stop Loss Leg Object Fields​

FieldsTypeRequiredDescriptionExample/Enum
LegsArray (object)YesList of stop loss leg ordersSee below table

📑Legs array of object fields​

FieldsTypeRequiredDescriptionExample/Enum
QuantityintegernoQuantity (ignored by system)100
pricenumberyesExecution price of stop loss order2450.0
trigger_pricenumberyesTrigger price of stop loss order2460.0

📑Trail objects fields​

FieldsTypeRequiredDescriptionExample/Enum
ltp_jump_pricenumbernoValue by which LTP should increase before SL trails2.0
stoploss_jump_pricenumbernoValue by which SL price should move when trailing1.0

📑Profit Leg Object Field​

FieldsTypeRequiredDescriptionExample/Enum
legsarray (object)YesDetails given belowSee below table

📑Profit Legs array of objects​

FieldsTypeRequiredDescriptionExample/Enum
QuantityintegernoQuantity (ignored currently)100
pricenumberyesTarget price at which profit is booked1560.00

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringOrder placement success message"Bracket order placed successfully"
dataobjectOrder response detailsRefer Data Object Fields

📦 Data Object Fields​

FieldTypeDescriptionExample
orderIdstringSystem-generated order identification number"25062900012345"