Leaderboard

To display the distribution of a particular token, we implemented the /leaderboard endpoint. A leaderboard is typically an information page on a platform page that shows how you rank among others. Distributing tokens in a competition and then displaying ownership is thus an interesting way to enrich the user experience.

Since tokens are on a public blockchain, we can aggregate all transactions and balances from the public blockchain to display the leaderboard. Thanks to p2p paymail integration, updating the leaderboard happens in real time.

Get token ownership details

Returns all user data who have this particular token.

get

/v1/leaderboard

Authorizations

authTokenserviceID

Query parameters

nextPageTokennumber

Header parameters

tokenIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.relysia.com/v1/leaderboard' \
  --header 'authToken: YOUR_API_KEY' \
  --header 'tokenId: text'

200

400

200

{
  "statusCode": 200,
  "data": {
    "status": "success",
    "msg": "Leaderboard fetched successfully.",
    "leaderboard": [
      {
        "paymail": "[e-mail]",
        "totalAmount": 100,
        "uid": "5f7b1b1b1b1b1b1b1b1b1b1b",
        "rank": 1,
        "displayName": "John Doe"
      },
      {
        "paymail": "[e-mail]",
        "totalAmount": 50,
        "uid": "5f7b1b1b1b1b1b1b1b1b1b1b",
        "rank": 2
      },
      {
        "totalAmount": 25,
        "uid": "5f7b1b1b1b1b1b1b1b1b1b1b",
        "rank": 3
      }
    ],
    "nextPageToken": 2
  }
}

Successful response