Skip to main content
GET
Get balances

Authorizations

Authorization
string
header
required

Scoped API key (ttk_...), created in the Totalis app or by a wallet-session user through the API keys routes with a fresh wallet signature; those routes never accept a key. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires. Send no Origin.

Scopes

account:read

Response

Your Totalis balance, broken into its parts, with any pending or unknown amount marked. HyperCore balances are not included; read them from Hyperliquid.

The account's spendable Totalis balance in atomic USDC (6 decimals, "1000000" = 1 USDC): embedded wallet USDC plus free vault cash. HyperCore balances are read from Hyperliquid directly or through GET /v1/hypercore/portfolio.

amount
string<uint128-decimal> | null
required

Spendable total in atomic USDC; null unless state is CURRENT. It is wallet USDC plus free vault cash minus the withdrawals and stake fundings in pending.wallet_reserved, floored at zero. A wallet deposit that has not committed stays in it.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
state
enum<string>
required

The components' state: both come from one chain read, so both are CURRENT or both UNKNOWN. STALE is no longer returned.

Available options:
CURRENT,
UNKNOWN,
STALE
components
object[]
required

The two parts of the balance: WALLET_USDC then VAULT_FREE.

Required array length: 2 elements
pending
object
required

In-flight amounts behind the balance, in atomic USDC (6 decimals).

checkpoint
object
required

The chain projection the pending operations come from. Wallet and vault amounts come from a latest read at or after this block, independent of projection_state.

run_off
object[]
required

The account's cash in vaults running off, one item per vault holding any or with a claim in flight, outside amount: it is owned but never spendable here. A Totalis embedded wallet's moves to its HyperCore spot balance automatically. Any other wallet claims it to its own wallet, part of Cash, with one Exit signed for that vault and sent with Create run-off claim; a sponsored claim must move at least 1 USDC (1000000), so offer it only when state is CURRENT, vault_free is at least that and claim is null. Smaller amounts stay in the vault. Empty when no vault is running off.