{s}omniamarkets

@somnia-chain/markets-sdk


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

Type Alias: SpotStopOrder

SpotStopOrder = object

Defined in: query.ts:1324

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

Properties

id

id: string

Defined in: query.ts:1326

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


registry

registry: string

Defined in: query.ts:1328

SpotStopOrderRegistry the order lives on (lowercased).


orderId

orderId: string

Defined in: query.ts:1330

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


isBid

isBid: boolean

Defined in: query.ts:1332

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


quantity

quantity: string

Defined in: query.ts:1334

Base quantity, raw units.


triggerPrice

triggerPrice: string

Defined in: query.ts:1336

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


triggerOperator

triggerOperator: number

Defined in: query.ts:1338

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


orderType

orderType: number

Defined in: query.ts:1340

0 = LIMIT, 1 = MARKET.


status

status: StopOrderStatus

Defined in: query.ts:1341


spotOrderId

spotOrderId: string | null

Defined in: query.ts:1343

Resulting spot order id once successfully triggered, else null.


createdAt

createdAt: string

Defined in: query.ts:1344


market

market: SpotPortfolioMarket

Defined in: query.ts:1345