Interface Balance

A single asset's balance within the workspace.

interface Balance {
    available: string;
    currency: string;
    locked: string;
}

Properties

available: string

Spendable balance as a decimal string, e.g. "125.50".

currency: string

Uppercase asset code this balance is denominated in, e.g. "USDT".

locked: string

Funds held/reserved (pending settlements, in-flight payouts) as a decimal string.