Skip to main content
POST
Place a bracket order

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Body

application/json

Bracket-order creation payload. takeProfitPrice and stopLossPrice are optional but at least one should be supplied for a useful bracket order.

Payload for creating a bracket order with optional take-profit and stop-loss legs.

symbol
string
required

Symbol to trade.

Example:

"FPT"

side
enum<string>
required

B for buy, S for sell.

Available options:
B,
S
conditionPrice
number
required

Entry trigger price.

conditionType
enum<string>
required

Entry trigger condition comparing market price to conditionPrice.

Available options:
>=,
<=
orderType
enum<string>
required

Entry order type sent after the trigger.

Available options:
LO,
MTL
quantity
integer
required

Entry order quantity.

account
string
required

Trading account used for the bracket order.

takeProfitPrice
number

Optional take-profit target price.

stopLossPrice
number

Optional stop-loss price.

Response

Bracket-order creation result.

Bracket-order creation response.

isSuccess
boolean
required

Whether the bracket order was validated, persisted, created with its entry stop order, and published as a NEW event.

detail
string
required

Result message. On success this is usually "Bracket order placed successfully".

data
string
required

System bracket order id generated by service.orderapi. Use this id to get or cancel the bracket order. Child ids such as entryStopOrderId, takeProfitOrderId, and stopLossOrderId are available on the BracketOrder object returned by the get bracket order API.

Pattern: ^BRACKET-
Example:

"BRACKET-V1StGXR8_Z5jdHi6B-myT"