@somnia-chain/markets-sdk / index / SpotStopOrder
Type Alias: SpotStopOrder
SpotStopOrder =
object
Defined in: packages/sdk/src/spot/stops.ts:15
A pending/historical spot stop order (mirror of the indexer StopOrder entity).
Properties
id
id:
string
Defined in: packages/sdk/src/spot/stops.ts:17
StopOrder id (${registry}_${orderId}).
registry
registry:
string
Defined in: packages/sdk/src/spot/stops.ts:19
SpotStopOrderRegistry the order lives on (lowercased).
orderId
orderId:
string
Defined in: packages/sdk/src/spot/stops.ts:21
uint128 pending-order id as a decimal string (pass to trader.cancelStopOrder).
isBid
isBid:
boolean
Defined in: packages/sdk/src/spot/stops.ts:23
True = buy base (pay quote), false = sell base.
quantity
quantity:
string
Defined in: packages/sdk/src/spot/stops.ts:25
Base quantity, raw units.
triggerPrice
triggerPrice:
string
Defined in: packages/sdk/src/spot/stops.ts:27
Mark price that arms the trigger (raw quote per whole base).
triggerOperator
triggerOperator:
number
Defined in: packages/sdk/src/spot/stops.ts:29
0 = GTE (trigger when mark ≥ trigger), 1 = LTE (mark ≤ trigger).
orderType
orderType:
number
Defined in: packages/sdk/src/spot/stops.ts:31
0 = LIMIT, 1 = MARKET.
status
status:
StopOrderStatus
Defined in: packages/sdk/src/spot/stops.ts:33
Lifecycle status — see StopOrderStatus.
placedOrderId
placedOrderId:
string|null
Defined in: packages/sdk/src/spot/stops.ts:35
Resulting spot order id once successfully triggered, else null.
createdAt
createdAt:
string
Defined in: packages/sdk/src/spot/stops.ts:37
Timestamp (unix seconds) the stop order was created.
market
market:
SpotPortfolioMarket
Defined in: packages/sdk/src/spot/stops.ts:39
The spot market the stop order targets.