Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-09-1"

Path Parameters

id
string
required

User ID (prefixed user_), username, or me for the authenticated user.

Query Parameters

include_trading
boolean
default:false

Also return the trading account under trading: its address and its Hyperliquid WebSocket subscriptions. Only honored on the self view (me) with crypto_wallet:trade:read, crypto_wallet:trade, or crypto_wallet:manage permission and an Ethereum wallet.

account_id
string

When set, returns the user's account-specific profile overrides for this account.

include_balance
boolean

Compute live wallet and owned-account balances on the self view (default true). Set false for identity-only reads. Ignored when the id is not me or the caller lacks balance-read scope.

include_balance_history
boolean

Also compute your balance history (opt-in; runs a heavier query). Only applies when the id is me; ignored for callers without balance-read scope.

from
string

Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with include_balance_history.

to
string

Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with include_balance_history.

interval
enum<string>

Balance-history point granularity. Defaults to day. Only used with include_balance_history.

Available options:
hour,
day,
week,
month
time_zone
string

IANA time zone the balance-history points are bucketed in. Defaults to UTC. Only used with include_balance_history.

Response

user retrieved

balance
object | null
required

The user's balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on the self view (retrieved with the reserved id me) for callers with balance-read scope; null otherwise, or when include_balance=false.

balance_history
object | null
required

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 when retrieving yourself with the reserved id me; populated only for callers with balance-read scope and null otherwise. A user with no wallet activity returns an empty series.

banner
object | null
required

The user's profile banner wrapper. null when the user has no banner.

bio
string | null
required

The user's biography

Example:

"Ceramic coating specialist. Detailing cars in Austin since 2016."

cards
object | null
required

Where the user's personal card application stands. Populated only on the self view (retrieved with the reserved id me) for callers with balance-read scope; null otherwise, or when the user has never applied for a card.

created_at
string
required

When the user was created, as an ISO 8601 timestamp

Example:

"2026-01-01T12:00:00.000Z"

earnings_usd
object | null
required

The user's gross USD income over time, including a Partner commission breakdown. Populated only on single-user self reads for callers with balance-read scope; null otherwise.

email
string | null
required

The user's email address. Populated only on the self view (retrieved with the reserved id me) for callers with email-read scope; null otherwise, or while the account has no confirmed email yet.

Example:

"marcus@shinetime.example"

id
string
required

User ID, prefixed user_.

Example:

"user_xxxxxxxxxxxxxx"

name
string | null
required

The user's display name

Example:

"Marcus Webb"

profile_picture
object
required

Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

staff
object | null
required

Whop staff access flags. Populated only on the self view (retrieved with the reserved id me) for callers with staff-read scope; null there for every user who is not Whop staff, and always null elsewhere.

trading
object | null
required

The trading account address and its WebSocket subscriptions. Opt in with include_trading=true when retrieving me. null otherwise, without trading permission, or without an Ethereum wallet.

username
string
required

The user's unique username

Example:

"marcuswebb"

verification
object
required

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.

Example:
whop_partner_enabled_at
string | null
required

When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. null if never enrolled.

Example:

"2026-01-01T12:00:00.000Z"

whop_partner_onboarded_accounts_count
integer | null
required

Number of accounts the user referred to Whop as a Whop Partner that have processed more than $1 in volume attributed to the user. Populated only when retrieving a single user who is a Verified Whop Partner; null otherwise.

Example:

1

whop_partner_verified_at
string | null
required

When the user became a Verified Whop Partner, as an ISO 8601 timestamp. null for users who are not Verified Whop Partners, including partners who left the program and suspended users.

Example:

"2026-01-01T12:00:00.000Z"