> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve the business referral leaderboard > Ranks referrers by business referral earnings — all-time by default, or over the current day, month, or year — and includes the caller's own standing. ## OpenAPI ````yaml /openapi/api-v1-native.yml get /referrals/businesses/leaderboard openapi: 3.1.0 info: title: Whop API description: >- Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema at build time. version: v1 servers: - url: https://{defaultHost} variables: defaultHost: default: api.whop.com/api/v1 security: [] paths: /referrals/businesses/leaderboard: parameters: - $ref: '#/components/parameters/ApiVersionDate' get: tags: - Referrals summary: Retrieve the business referral leaderboard description: >- Ranks referrers by business referral earnings — all-time by default, or over the current day, month, or year — and includes the caller's own standing. operationId: retrieveBusinessReferralLeaderboard parameters: - name: period in: query required: false schema: type: string enum: - day - month - year - all_time default: all_time description: >- Time window for the rankings. `day`, `month`, and `year` count earnings since the start of the current calendar day, month, or year; `all_time` ranks lifetime earnings. responses: '200': description: caller has no referral earnings content: application/json: schema: type: object properties: leaders: type: array items: type: object properties: rank: type: integer description: 1-based leaderboard position. total_earnings_usd: type: string description: >- The referrer's pending + completed earnings across all referred businesses, in USD. total_volume_usd: type: string description: >- Credited GMV across all the referrer's referred businesses, in USD. first_referral_started_at: type: string format: date-time description: >- When the referrer's earliest business referral became active. user: type: - object - 'null' description: The ranked referrer. properties: id: type: string description: User ID, prefixed `user_`. name: type: - string - 'null' description: The user's display name. username: type: string description: The user's unique username. profile_picture: type: object properties: url: type: string description: The user's profile picture URL. required: - url description: The user's profile picture. country: type: - string - 'null' description: >- The country where the user is located, derived from their IP address. Null if location sharing is disabled. city: type: - string - 'null' description: >- The city where the user is located, derived from their IP address. Null if location sharing is disabled. required: - id - name - username - profile_picture - country - city required: - rank - total_earnings_usd - total_volume_usd - first_referral_started_at - user maxItems: 10 description: The top referrers by total earnings, best first. me: type: - object - 'null' properties: rank: type: integer description: 1-based leaderboard position. total_earnings_usd: type: string description: >- The referrer's pending + completed earnings across all referred businesses, in USD. total_volume_usd: type: string description: >- Credited GMV across all the referrer's referred businesses, in USD. first_referral_started_at: type: string format: date-time description: >- When the referrer's earliest business referral became active. user: type: - object - 'null' description: The ranked referrer. properties: id: type: string description: User ID, prefixed `user_`. name: type: - string - 'null' description: The user's display name. username: type: string description: The user's unique username. profile_picture: type: object properties: url: type: string description: The user's profile picture URL. required: - url description: The user's profile picture. country: type: - string - 'null' description: >- The country where the user is located, derived from their IP address. Null if location sharing is disabled. city: type: - string - 'null' description: >- The city where the user is located, derived from their IP address. Null if location sharing is disabled. required: - id - name - username - profile_picture - country - city required: - rank - total_earnings_usd - total_volume_usd - first_referral_started_at - user description: >- The caller's own standing; null when the caller has no referral earnings. required: - leaders - me '400': $ref: '#/components/responses/InvalidParameters' description: invalid period '401': $ref: '#/components/responses/Unauthorized' description: missing or invalid authentication '403': $ref: '#/components/responses/Forbidden' description: credential lacks the referral-read scope security: - bearerAuth: - referral:basic:read components: parameters: ApiVersionDate: name: Api-Version-Date in: header required: false schema: type: string format: date example: '2026-07-01' description: Pins the request to a dated API version. responses: InvalidParameters: description: Invalid Parameters content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' schemas: V1ErrorResponse: type: object properties: error: type: object properties: type: type: string description: Machine-readable error code. message: type: string description: Human-readable error message. required: - type - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: auth-scheme description: >- An account API key, account scoped JWT, app API key, or user OAuth token. ````