---
title: "Returns users leaderboard (at the top of the board are users, whose referrals have generated the most fees)"
method: POST
path: "/api/Users/referralProgramLeaderboard"
tags: ["Users"]
---

# Returns users leaderboard (at the top of the board are users, whose referrals have generated the most fees)

`POST /api/Users/referralProgramLeaderboard`

## Request body

- ReferralProgramLeaderboardRequestDTO — Referral program leaderboard request
  - `referralCode` integer, nullable — Referral code of a user to search for [hex of base58, optional]
  - `skip` integer, required — items to skip (pagination)
  - `take` integer, required — Number of items to return (pagination) max page size is 100

## Response `200`

OK

- ReferralProgramLeaderboardResponseDTO — Referral program leaderboard response
  - `users` ReferralProgramLeaderboardItemDTO[], nullable — Leaderboard items from requested page
    - `referralCode` integer — Referral code of the user
    - `referralProgramRank` integer — Rank of the inviter (i.e. a user, that invites other users) in the leaderboard Users are ranked by InvitedUsersTotalFeesGeneratedUsd descending
    - `referralsTotalVolumeUsd` number, double — Total give amount's USD equivalent of all user's orders that used the referral code
    - `referralsTotalFeesUsd` number, double — Total fees' USD equivalent of all user's orders that used the referral code
    - `referralsTotalExecutedOrders` integer — Total number of user's orders that used the referral code
  - `totalCount` integer — Total number of leaderboard items
  - `searchResult` ReferralProgramLeaderboardItemDTO
    - `referralCode` integer — Referral code of the user
    - `referralProgramRank` integer — Rank of the inviter (i.e. a user, that invites other users) in the leaderboard Users are ranked by InvitedUsersTotalFeesGeneratedUsd descending
    - `referralsTotalVolumeUsd` number, double — Total give amount's USD equivalent of all user's orders that used the referral code
    - `referralsTotalFeesUsd` number, double — Total fees' USD equivalent of all user's orders that used the referral code
    - `referralsTotalExecutedOrders` integer — Total number of user's orders that used the referral code

---

[API](https://skmtc.net/debridge/apis/debridge-liquidity-network-dln-api.md) · [All operations](https://skmtc.net/debridge/apis/debridge-liquidity-network-dln-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/debridge/debridge-liquidity-network-dln-api/revisions/ec461847e46f/schema)