Skip to main content
GET
Get balances

Authorizations

Authorization
string
header
required

Scoped API key from the Totalis app settings. 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.

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 pending.wallet_reserved, floored at zero.

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

Combined state of the components: STALE if any is stale, else UNKNOWN if any could not be read, else CURRENT.

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

Chain projection the figures reflect; wallet USDC is read at this same block.