Place Bracket Order
Place a Bracket Order, which includes:
- A main Buy/Sell order
- An attached stop loss leg
- A Profit leg
- (Optional) Trailing stop loss
🔑Header Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Authorization | string | Yes | Bearer token for authentication | access_token |
| x-api-key | string | Yes | API key provided | x-api-key |
📦Request Body Schema
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| scrip_info | object | yes | Scrip 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_type | string | yes | Whether the Order is "Buy" or "Sell" | BUY |
| main_leg | object | yes | Main order leg (entry order) | See below table |
| stoploss_leg | object | yes | Stop loss order leg | See below tabe |
| trail | object | no | Trailing stop-loss settings (Optional) | See below table |
| profit_leg | object | Yes | Traget profit order leg | See below table |
| order identifier | string | no | Optional client reference (max 10 characters) | BRKT1234 |
| part_code | string | no | Custodian participant code (if applicable) | XYZ01 |
| Algo_id | string | no | Algo ID for strategy based order | ALG5678 |
| strategy_id | string | no | Strategy group identifier | STRAT234 |
| vendor code | string | no | Internal vendor reference code | VNDR009 |
📑Scrip info object fields
| Fields | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| exchange | string | yes | Exchange segments | NSE_EQ |
| scrip token | integer | no | Exchange token number | 1234 |
| symbol | string | no | Trading symbol (required if token not used) | RELIANCE |
| series | string | no | Series (required for equity instruments ) | EQ |
| expiry_date | string | no | Expiry date (for F&O), format yyyy-mm-dd | 2025-06-28 |
| strike_price | number | no | Strike price (in paise for options) | 220000 |
| option_type | string | no | "CE" for Call, "PE" for Put (for options) | CE |
📑Main Leg Object Fields
| Fields | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| order_type | string | yes | Order Types , Only RL or RL-MKT supported | RL |
| quantity | integer | yes | Quantity to trade | 100 |
| price | number | yes | Price for the main leg ( 0 for market) | 2500.0 |
| trigger_price | number | yes | Currently should always be set to 0 | 0 |
📑Stop Loss Leg Object Fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Legs | Array (object) | Yes | List of stop loss leg orders | See below table |
📑Legs array of object fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Quantity | integer | no | Quantity (ignored by system) | 100 |
| price | number | yes | Execution price of stop loss order | 2450.0 |
| trigger_price | number | yes | Trigger price of stop loss order | 2460.0 |
📑Trail objects fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| ltp_jump_price | number | no | Value by which LTP should increase before SL trails | 2.0 |
| stoploss_jump_price | number | no | Value by which SL price should move when trailing | 1.0 |
📑Profit Leg Object Field
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| legs | array (object) | Yes | Details given below | See below table |
📑Profit Legs array of objects
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Quantity | integer | no | Quantity (ignored currently) | 100 |
| price | price | yes | Target price at which profit is booked | 1560.00 |
🟢Success Response - 200 Ok
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| Status | string | Status of API Call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success Message | "Order Entry Sent to OMS" |
| data | object | Contains additional info (like order ID) | See below table |
📘Data object Field
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| orderId | string | Order ID generated by system | "BRKTORD7789" |
post
/transactional/v1/orders/bracket