Skip to main content
GET
Get account value

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 account's value and its parts. When state is UNKNOWN every amount is null; read again later. No caching.

What the account holds at Totalis at one HyperEVM block, in atomic USDC (6 decimals, "1000000" = 1 USDC): wallet USDC, its cash in the vault and in vaults running off, what it paid for its open positions, and the profit it can still claim, net of the fee. Every amount is read from the chain at block_number. HyperCore balances are not included; read them from Hyperliquid.

account
string
required

The account's wallet, lowercase.

Pattern: ^0x[0-9a-f]{40}$
state
enum<string>
required

CURRENT when every amount was read at block_number; UNKNOWN when the chain could not be read, or the projection did not reach that block in time, and every amount is null. Read again later.

Available options:
CURRENT,
UNKNOWN
amount
string<uint128-decimal> | null
required

The account's value: wallet_usdc + vault_cash + run_off_cash + open_cost + claimable_profit. Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
block_number
string<uint64-decimal> | null
required

The HyperEVM block every amount was read at. Null unless state is CURRENT.

Maximum string length: 20
Pattern: ^(0|[1-9][0-9]{0,18}|1[0-7][0-9]{18}|18[0-3][0-9]{17}|184[0-3][0-9]{16}|1844[0-5][0-9]{15}|18446[0-6][0-9]{14}|184467[0-3][0-9]{13}|1844674[0-3][0-9]{12}|184467440[0-6][0-9]{10}|1844674407[0-2][0-9]{9}|18446744073[0-6][0-9]{8}|1844674407370[0-8][0-9]{6}|18446744073709[0-4][0-9]{5}|184467440737095[0-4][0-9]{4}|18446744073709550[0-9]{3}|18446744073709551[0-5][0-9]{2}|1844674407370955160[0-9]|1844674407370955161[0-5])$
wallet_usdc
string<uint128-decimal> | null
required

USDC in the account's wallet on HyperEVM, including any already committed to a Totalis withdrawal or stake that has not landed. Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
vault_cash
string<uint128-decimal> | null
required

All the account's cash in the vault, including any held for an operation that has not landed, so it can exceed GET /v1/me/balances' free vault cash. Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
run_off_cash
string<uint128-decimal> | null
required

The account's cash in vaults running off, all together; GET /v1/me/balances lists it per vault. Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
open_positions
integer | null
required

How many positions the account holds that have not settled: OPEN and AWAITING_SETTLEMENT in GET /v1/me/positions. Null unless state is CURRENT.

Required range: x >= 0
open_cost
string<uint128-decimal> | null
required

What the account paid for those positions: the sum of their acquisition_cost. Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
claimable_profit
string<uint128-decimal> | null
required

What claiming every SETTLED_UNCLAIMED position would pay the account: each one's unclaimed_profit minus floor(unclaimed_profit * fee_bps / 10000). Null unless state is CURRENT.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
checkpoint
object
required

The vault projection the read used to find the account's positions. When state is CURRENT it has reached block_number.