Skip to Content
Symmio Trading-SDK — the SDK surface for builders on Arbitrum
CoreSYMMIO ContractisPartyALiquidated

isPartyALiquidated

Read whether a partyA is in liquidation right now. Use it to hide or lock an account’s positions while a liquidation runs — every action on them would revert.

import { isPartyALiquidated } from "@symmio/trading-core"; const inLiquidation = await isPartyALiquidated(config, { partyA: virtualAccount });

What the flag means

The flag is a liquidation-in-progress marker, not a history of past liquidations:

  • It turns true when a liquidator starts the partyA’s liquidation — the account was proven insolvent.
  • It goes back to false once that liquidation is settled and finalized.

While it is true the account is frozen: solvers cannot fill or open against it and most partyA actions revert. Its quotes still show up in getPartyAOpenPositions, typically with status LIQUIDATED_PENDING.

Reading many accounts? Pass includeLiquidationStatus: true to getPartyAOpenPositionsBatch instead — it reads the flag for every account inside the same multicall.

Parameters

partyAAddressrequired

The partyA to check — a Virtual Account (lowcap) or the sub-account itself (cross-margin).

chainIdnumberoptional

Optional chain override.

Returns

boolean
true while the partyA’s liquidation is in progress.

Query options

The query is disabled until partyA is set.

import { isPartyALiquidatedQueryOptions } from "@symmio/trading-core"; import { useQuery } from "@tanstack/react-query"; useQuery(isPartyALiquidatedQueryOptions(config, { partyA }));
Last updated on