Get app leaderboard

GET /v1/client/leaderboard
Header api token & Header user Query api token & Query user Header bearer token

Get Leaderboard returns the leaderboard of the app.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • next_reset_at string(date-time)
      • rewards array[object] Required
        Hide rewards attributes Show rewards attributes object
        • rank integer Required
        • reward_raw number Required
        • reward_currency number Required
      • top_users array[object] Required
        Hide top_users attributes Show top_users attributes object
        • rank integer Required
        • name string Required
        • earnings_raw number Required
        • earnings_currency number Required
        • claimable_rewards array[object]
          Hide claimable_rewards attributes Show claimable_rewards attributes object
          • id integer(int64) Required

            The id of the claimable reward.

          • reward_type string

            The type of the claimable reward.

            Values are DAILY or WEEKLY.

          • date string(date-time) Required

            The timestamp when the reward was created at

          • reward_amount number(float) Required

            The amount of currency the user is rewarded upon reward claim.

      • own_user object
        Hide own_user attributes Show own_user attributes object
        • rank integer Required
        • name string Required
        • earnings_raw number Required
        • earnings_currency number Required
        • claimable_rewards array[object]
          Hide claimable_rewards attributes Show claimable_rewards attributes object
          • id integer(int64) Required

            The id of the claimable reward.

          • reward_type string

            The type of the claimable reward.

            Values are DAILY or WEEKLY.

          • date string(date-time) Required

            The timestamp when the reward was created at

          • reward_amount number(float) Required

            The amount of currency the user is rewarded upon reward claim.
  • 404

    Not found if leaderboard is disabled

GET /v1/client/leaderboard 
curl \
 --request GET 'https://api.bitlabs.ai/v1/client/leaderboard' \
 --header "X-Api-Token: $API_KEY" \
 --header "X-User-Id: $API_KEY"
Response examples (200) 
{
  "data": {
    "next_reset_at": "2022-01-01T12:00:00Z",
    "rewards": [
      {
        "rank": 42,
        "reward_raw": 42.0,
        "reward_currency": 42.0
      }
    ],
    "top_users": [
      {
        "rank": 42,
        "name": "string",
        "earnings_raw": 42.0,
        "earnings_currency": 42.0,
        "claimable_rewards": [
          {
            "id": 65,
            "reward_type": "DAILY",
            "date": "2025-07-21T00:00:00.000Z",
            "reward_amount": 33.3
          }
        ]
      }
    ],
    "own_user": {
      "rank": 42,
      "name": "string",
      "earnings_raw": 42.0,
      "earnings_currency": 42.0,
      "claimable_rewards": [
        {
          "id": 65,
          "reward_type": "DAILY",
          "date": "2025-07-21T00:00:00.000Z",
          "reward_amount": 33.3
        }
      ]
    }
  }
}