Skip to main content
GET
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

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.

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

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

Sorgu Parametreleri

include_trading
boolean
varsayılan:false

Also return the trading account under trading: its address, a snapshot of its margin and open positions, 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.

Mevcut seçenekler:
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.

Yanıt

user retrieved

balance
object | null
gerekli

The user's balance: personal cash + other holdings + deposits still in flight, 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
gerekli

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.

balances
object[]
gerekli
banner
object | null
gerekli

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

bio
string | null
gerekli

The user's biography

Örnek:

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

cards
object | null
gerekli

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.

city
string | null
gerekli

The user's city, derived from their IP address. null when unknown or the user turned off location sharing.

Örnek:

"Austin"

country
string | null
gerekli

The user's country as an ISO 3166-1 alpha-2 code, derived from their IP address. null when unknown or the user turned off location sharing.

Örnek:

"US"

created_at
string
gerekli

When the user was created, as an ISO 8601 timestamp

Örnek:

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

date_of_birth
string | null
gerekli

The user's date of birth as an ISO 8601 date, like 1998-04-23. Populated only on the self view (retrieved with the reserved id me) for callers with email-read scope; null otherwise, or when the user has not set one.

Örnek:

null

earnings_usd
object | null
gerekli

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
gerekli

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.

Örnek:

"marcus@shinetime.example"

followers_count
integer
gerekli

The number of users who follow this user.

Örnek:

0

id
string
gerekli

User ID, prefixed user_.

Örnek:

"user_xxxxxxxxxxxxxx"

level
object | null
gerekli

The user's Whop Level, counted across every account they own. current is public. The points and spend fields are populated only when you retrieve yourself with the reserved id me and have balance-read scope. null on lists, and when none of their accounts are in Whop Levels.

name
string | null
gerekli

The user's display name

Örnek:

"Marcus Webb"

profile_picture
object
gerekli

Avatar wrapper. Its url is always present, and is a generated placeholder when the user set no picture.

state
string | null
gerekli

The user's state or region, derived from their IP address. null when unknown or the user turned off location sharing.

Örnek:

"Texas"

total_usd
string | null
gerekli

Total USD value of the user's personal holdings in balances, across those with known exchange rates. Computed only on the self view (retrieved with the reserved id me) for callers with balance-read scope; null otherwise, when include_balance=false, or when the balance source is unavailable.

Örnek:

"6320.75"

trading
object | null
gerekli

The trading account address, a snapshot of its margin and open positions, 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
gerekli

The user's unique username

Örnek:

"marcuswebb"

verification
object
gerekli

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.

Örnek:
verified_at
string | null
gerekli

When the user received a verified badge, as an ISO 8601 timestamp. null when the user is not verified.

Örnek:

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

whop_partner_enabled_at
string | null
gerekli

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

Örnek:

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

whop_partner_onboarded_accounts_count
integer | null
gerekli

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.

Örnek:

1

whop_partner_verified_at
string | null
gerekli

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.

Örnek:

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