Skip to main content
POST
Place a stop-loss order

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Body

application/json

Stop-order creation payload. All required fields are validated by service.orderapi.

Payload for creating a stop order.

symbol
string
required

Symbol to trade.

Example:

"FPT"

side
enum<string>
required

B for buy, S for sell.

Available options:
B,
S
stopPrice
number
required

Trigger price.

stopCondition
enum<string>
required

Trigger condition comparing market price to stopPrice.

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

Order type sent when the trigger fires. Frontend currently uses LO or MTL.

Available options:
LO,
MTL,
MOK,
MAK,
ATC,
ATO,
BEST,
OPPOSITE,
LAST
price
number
required

Limit price for LO orders; ignored or optional for market-style order types.

quantity
integer
required

Order quantity sent after the trigger.

account
string
required

Trading account used for the order.

Response

Stop-order creation result.

Stop-order creation response.

isSuccess
boolean
required

Whether the stop order was validated, persisted, and published as a NEW stop-order event.

detail
string
required

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

data
string
required

System stop-order id generated by service.orderapi. Use this id to get, modify, or cancel the stop order and to correlate stop-order execution reports. The full stop-order object is returned by the get stop-order API.

Pattern: ^STOP-
Example:

"STOP-V1StGXR8_Z5jdHi6B-myT"