Skip to main content
PUT
Modify a stop-loss order

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Path Parameters

orderId
string
required

System order identifier returned by the stop-order service.

Body

application/json

Stop-order replacement payload. orderId is supplied in the path.

Payload for replacing the fields of an existing stop order. The order id is supplied in the path.

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 modification response with data as the updated stop order.

Stop-order modification response with the updated stop order in data.

isSuccess
boolean
required

Whether the backend accepted and processed the modification.

detail
string
required

Success or error detail returned by service.orderapi.

data
object
required

Updated stop-order object.