@somnia-chain/markets-sdk

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

Interface: ListLiquidationsOptions

Defined in: packages/sdk/src/perp/history.ts:608

Filters and pagination for client.listLiquidations.

Named rather than inline because this shape is declared twice - here and on the client member - and SDK-TYPE-005 exists so the two cannot drift as the API grows.

Properties

account?

optional account?: string

Defined in: packages/sdk/src/perp/history.ts:610

Liquidated account. Case-insensitive: lowercased before the query.

pool?

optional pool?: string

Defined in: packages/sdk/src/perp/history.ts:612

Perp pool address. Case-insensitive: lowercased before the query.

kind?

optional kind?: "AutoDeleveraged" | "CloseOutMarginSettled" | "BadDebtAbsorbed" | "PositionTransferred" | "AccountLiquidated" | "PositionLiquidated" | "PositionTakenOver" | "ResidualBadDebt" | "ResidualBackedByOpenPnl" | "AdlCapacityShortfall" | "AdlPriceCapacityExhausted" | "AdlSessionDiscarded" | "PositionSkipped" | "Throttled" | "KeeperReward" | "OrderPanicked" | "CoverageDeclined"

Defined in: packages/sdk/src/perp/history.ts:618

A single stage to return. Matched EXACTLY as given and NOT lowercased, unlike the addresses above - it is the schema's own discriminator, so "autodeleveraged" would match nothing. A union rather than a string precisely because that miss is silent: an empty page reads as "no ADLs happened", so the typo has to be a compile error instead.

limit?

optional limit?: number

Defined in: packages/sdk/src/perp/history.ts:620

Rows per page. Defaults to 50.

offset?

optional offset?: number

Defined in: packages/sdk/src/perp/history.ts:628

Rows to skip. Defaults to 0.

The query carries a TOTAL order (timestamp, then blockNumber, then the id primary key), so the sequence is STABLE between requests — two reads of an unchanged table agree, which timestamp alone did not guarantee for rows sharing a block. That fixes tie ordering; it does not make offset paging snapshot-consistent against a LIVE table. See the note on listLiquidations.