Interface BalanceUpdate

A WebSocket balance update message.

Received when balances change for a subscribed account.

interface BalanceUpdate {
    action: string;
    balance: {
        asset_id: AssetId;
        identity: Identity;
        order_books: Record<string, OrderBookBalance>;
        total_locked: bigint;
        total_unlocked: bigint;
        trading_account_balance: bigint;
    }[];
    onchain_timestamp?: string;
    seen_timestamp?: string;
}

Properties

action balance onchain_timestamp? seen_timestamp?

Properties

action

action: string

The subscription action type.

balance

balance: {
    asset_id: AssetId;
    identity: Identity;
    order_books: Record<string, OrderBookBalance>;
    total_locked: bigint;
    total_unlocked: bigint;
    trading_account_balance: bigint;
}[]

Updated balance entries (one per affected asset).

Type declaration

  • asset_id: AssetId

    The asset identifier.

  • identity: Identity

    The account identity.

  • order_books: Record<string, OrderBookBalance>

    Per-order-book balance breakdown.

  • total_locked: bigint

    Total locked across all order books (chain integer).

  • total_unlocked: bigint

    Total unlocked across all order books (chain integer).

  • trading_account_balance: bigint

    Total balance in the trading account (chain integer).

Optionalonchain_timestamp

onchain_timestamp?: string

On-chain timestamp.

Optionalseen_timestamp

seen_timestamp?: string

Server-observed timestamp.

Settings

Member Visibility

On This Page

Properties