BitLabs API

Get app's leaderboard, if enabled

GET /v1/client/leaderboard

Header api token & Header user Query api token & Query user Header bearer token

Responses

• 200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes
  
  next_reset_at string(date-time) Required
  
  rewards array[object] Required
  
  Hide rewards attributes Show rewards attributes object
  
  rank integer Required
  
  reward_raw 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
  
  own_user object
  
  Hide own_user attributes Show own_user attributes
  
  rank integer Required
  
  name string Required
  
  earnings_raw number Required
• 404

Not found if leaderboard is disabled

GET /v1/client/leaderboard

curl \
 -X GET https://api.bitlabs.ai/v1/client/leaderboard \
 -H "X-Api-Token: $API_KEY" \
 -H "X-User-Id: $API_KEY"

Response examples (200)

{
  "data": {
    "next_reset_at": "2022-01-01T12:00:00Z",
    "rewards": [
      {
        "rank": 42,
        "reward_raw": 42.0
      }
    ],
    "top_users": [
      {
        "rank": 42,
        "name": "string",
        "earnings_raw": 42.0
      }
    ],
    "own_user": {
      "rank": 42,
      "name": "string",
      "earnings_raw": 42.0
    }
  }
}