Skip to main content
POST
/
api
/
Users
/
referralProgramLeaderboard
Returns users leaderboard (at the top of the board are users, whose referrals have generated the most fees)
curl --request POST \
  --url https://dln-api.debridge.finance/api/Users/referralProgramLeaderboard \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "skip": 123,
  "take": 123,
  "referralCode": 123
}
'
{
  "users": [
    {
      "referralCode": 123,
      "referralProgramRank": 123,
      "referralsTotalVolumeUsd": 123,
      "referralsTotalFeesUsd": 123,
      "referralsTotalExecutedOrders": 123
    }
  ],
  "totalCount": 123,
  "searchResult": {
    "referralCode": 123,
    "referralProgramRank": 123,
    "referralsTotalVolumeUsd": 123,
    "referralsTotalFeesUsd": 123,
    "referralsTotalExecutedOrders": 123
  }
}

Body

Referral program leaderboard request

​
skip
integer<int32>
required

items to skip (pagination)

​
take
integer<int32>
required

Number of items to return (pagination) max page size is 100

​
referralCode
integer<int32> | null

Referral code of a user to search for [hex of base58, optional]

Response

OK

Referral program leaderboard response

​
users
object[] | null

Leaderboard items from requested page

​
totalCount
integer<int32>

Total number of leaderboard items

​
searchResult
object