@somnia-chain/markets-sdk / index / SpotStopOrder
Type Alias: SpotStopOrder
SpotStopOrder =
object
Defined in: packages/sdk/src/spot/stops.ts:27
A pending/historical spot stop order (mirror of the indexer StopOrder entity).
There is no limit price on this row: a spot LIMIT stop's limit price can't be read back after placement. Show it as unknown, never as zero. If you need to display it, keep the value you submitted.
Properties
id
id:
string
Defined in: packages/sdk/src/spot/stops.ts:29
StopOrder id (${registry}_${orderId}).
registry
registry:
string
Defined in: packages/sdk/src/spot/stops.ts:31
SpotStopOrderRegistry the order lives on (lowercased).
orderId
orderId:
string
Defined in: packages/sdk/src/spot/stops.ts:33
uint128 pending-order id as a decimal string (pass to trader.cancelStopOrder).
isBid
isBid:
boolean
Defined in: packages/sdk/src/spot/stops.ts:35
True = buy base (pay quote), false = sell base.
quantity
quantity:
string
Defined in: packages/sdk/src/spot/stops.ts:37
Base quantity, raw units.
triggerPrice
triggerPrice:
string
Defined in: packages/sdk/src/spot/stops.ts:39
Mark price that arms the trigger (raw quote per whole base).
triggerOperator
triggerOperator:
number
Defined in: packages/sdk/src/spot/stops.ts:41
0 = GTE (trigger when mark ≥ trigger), 1 = LTE (mark ≤ trigger).
orderType
orderType:
number
Defined in: packages/sdk/src/spot/stops.ts:43
0 = LIMIT, 1 = MARKET.
status
status:
StopOrderStatus
Defined in: packages/sdk/src/spot/stops.ts:45
Lifecycle status — see StopOrderStatus.
placedOrderId
placedOrderId:
string|null
Defined in: packages/sdk/src/spot/stops.ts:47
Resulting spot order id once successfully triggered, else null.
createdAt
createdAt:
string
Defined in: packages/sdk/src/spot/stops.ts:49
Timestamp (unix seconds) the stop order was created.
market
market:
SpotPortfolioMarket
Defined in: packages/sdk/src/spot/stops.ts:51
The spot market the stop order targets.