Skip to main content

Place Bracket Order

Place a Bracket Order, which includes:

  1. A main Buy/Sell order
  2. An attached stop loss leg
  3. A Profit leg
  4. (Optional) Trailing stop loss

🔑Header Parameters

FieldsTypeRequiredDescriptionExample/Enum
AuthorizationstringYesBearer token for authenticationaccess_token
x-api-keystringYesAPI key providedx-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
transactional_typestringyesWhether the Order is "Buy" or "Sell"BUY
main_legobjectyesMain order leg (entry order)See below table
stoploss_legobjectyesStop loss order legSee below tabe
trailobjectnoTrailing stop-loss settings (Optional)See below table
profit_legobjectYesTraget 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
vendor codestringnoInternal vendor reference codeVNDR009

📑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
pricepriceyesTarget price at which profit is booked1560.00

🟢Success Response - 200 Ok

FieldsTypeDescriptionExample/Enum
StatusstringStatus of API Call"success"
codestringResponse code"s-101"
messagestringSuccess Message"Order Entry Sent to OMS"
dataobjectContains additional info (like order ID)See below table

📘Data object Field

FieldsTypeDescriptionExample/Enum
orderIdstringOrder ID generated by system"BRKTORD7789"
post/transactional/v1/orders/bracket