Skip to main content
GET
Get stop-loss order by ID

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.

Response

Stop-order details.

Stored stop order state returned by the order service.

orderId
string

System stop order id. JSON serialization may also return OrderId depending on backend settings.

symbol
string

Trading symbol.

side
enum<string>

B for buy, S for sell.

Available options:
B,
S
stopPrice
number

Trigger price.

stopCondition
enum<string>

Trigger condition comparing current market price against stopPrice.

Available options:
>=,
<=
orderType
string

Child order type sent when the trigger fires.

price
number | null

Limit price for LO orders; null or ignored for market-style orders.

quantity
integer

Requested quantity.

account
string

Trading account.

createdTime
string<date-time>

Creation time.

status
string

Stop order status, for example PENDING, COMPLETE, CANCELLED, or MODIFIED.

bracketOrderId
string | null

Parent bracket order id when the stop order is a bracket leg; null for standalone stop orders.

specialOrderType
string | null

Special leg type such as ENTRY, TAKE_PROFIT, or STOP_LOSS; null for standalone stop orders.

remainingQty
integer

Remaining quantity for sliced execution.

lastCheckTime
string<date-time> | null

Last trigger check time.

lastSliceTime
string<date-time> | null

Last time a child slice order was sent.

minSliceIntervalMs
integer<int64>

Minimum interval between child slices in milliseconds.

childOrderIds
string[]

System order ids of child broker orders.

filledQty
number

Filled quantity.

filledAvgPrice
number

Average filled price.