{s}omniamarkets

@somnia-chain/markets-sdk


@somnia-chain/markets-sdk / index / SpotStopOrder

Type Alias: SpotStopOrder

SpotStopOrder = object

Defined in: query.ts:1667

A pending/historical spot stop order (mirror of the indexer StopOrder entity).

Properties

id

id: string

Defined in: query.ts:1669

StopOrder id (${registry}_${orderId}).


registry

registry: string

Defined in: query.ts:1671

SpotStopOrderRegistry the order lives on (lowercased).


orderId

orderId: string

Defined in: query.ts:1673

uint128 pending-order id as a decimal string (pass to trader.cancelStopOrder).


isBid

isBid: boolean

Defined in: query.ts:1675

True = buy base (pay quote), false = sell base.


quantity

quantity: string

Defined in: query.ts:1677

Base quantity, raw units.


triggerPrice

triggerPrice: string

Defined in: query.ts:1679

Mark price that arms the trigger (raw quote per whole base).


triggerOperator

triggerOperator: number

Defined in: query.ts:1681

0 = GTE (trigger when mark ≥ trigger), 1 = LTE (mark ≤ trigger).


orderType

orderType: number

Defined in: query.ts:1683

0 = LIMIT, 1 = MARKET.


status

status: StopOrderStatus

Defined in: query.ts:1685

Lifecycle status — see StopOrderStatus.


spotOrderId

spotOrderId: string | null

Defined in: query.ts:1687

Resulting spot order id once successfully triggered, else null.


createdAt

createdAt: string

Defined in: query.ts:1689

Timestamp (unix seconds) the stop order was created.


market

market: SpotPortfolioMarket

Defined in: query.ts:1691

The spot market the stop order targets.