Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

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.

Scopes

partner:basic:read

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de consulta

period
enum<string>
predeterminado:all_time

Time window for the rankings. day, month, and year count earnings since the start of the current calendar day, month, or year; last_30_days counts earnings over the trailing 30 days; all_time ranks lifetime earnings.

Opciones disponibles:
day,
month,
year,
last_30_days,
all_time

Respuesta

caller has no referral earnings

leaders
object[]
requerido

The top 10 referrers by total earnings, best first.

me
object | null
requerido

The caller's own standing; null when the caller has no referral earnings.

nearby
object[]
requerido

The referrers ranked within five places of the caller, including the caller, best first. Empty when the caller has no referral earnings or is anonymous.

Maximum array length: 11