Endpoints
Attributes
User ID, prefixed
user_.The user’s balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on
GET /users/me self-view for callers with balance-read scope; null otherwise.Properties
Properties
Account balances for accounts the user owns, highest balance first. Excludes accounts with no balance.
Combined USD balance across every account the user owns.
Per-currency fiat cash balances.
Properties
Properties
Available balance in the native currency.
Available balance converted to USD.
Lowercase ISO currency code, such as
usd or eur.Pending balance converted to USD.
Reserved balance converted to USD.
Withdrawable amount in the native currency.
Fiat cash in USD, including pending and reserve.
Per-token crypto holdings in the ledger’s own wallet.
Properties
Properties
Amount held in native token units, as a decimal string.
Token icon URL.
The token’s display name.
USD price per token, or
null when unknown.Token display symbol, such as
USDT, XAUT, or cbBTC.Holding USD value.
Crypto holdings in USD.
Pending funds in USD: fiat pending + in-flight treasury deposits.
The user’s personal balance in USD: cash (available + pending + reserve) +
crypto + in-flight treasury deposits. Excludes account balances (see
businesses_total_usd).
Balance-to-wallet USDT0 withdrawals still in flight, in USD.
The user’s cumulative wallet balance over time (USD
\{ t, v } points plus last/min/max), for the balance chart. Opt in with include_balance_history=true on GET /users/me; populated only for callers with balance-read scope and null otherwise. A user with no wallet activity returns an empty series.Properties
Properties
Value of the most recent point, in USD.
Maximum value across the window, in USD.
Minimum value across the window, in USD.
The user’s biography
When the user was created, as an ISO 8601 timestamp
The user’s gross USD income over time. Populated only on single-user self reads for callers with balance-read scope;
null otherwise.Properties
Properties
The first time the user earned gross income, as an ISO 8601 timestamp.
Gross income from accounts the user owns or is owner-authorized on.
Gross income from the user’s personal wallet.
Gross income from the user’s personal wallet plus accounts they own or are owner-authorized on.
The user’s display name
The user’s profile picture, an object with a url
The user’s unique username
Identity verification status for the user’s
individual (KYC) and business
(KYB) profiles. Each is null until created, otherwise a status of
not_started, pending, approved, or rejected.When the user became an enrolled Whop Partner, as an ISO 8601 timestamp.
null if never enrolled.User

