---
title: "Get app leaderboard"
method: GET
path: "/v1/client/leaderboard"
tags: ["Internal"]
---

# Get app leaderboard

`GET /v1/client/leaderboard`

Get Leaderboard returns the leaderboard of the app.

## Response `200`

OK

- object
  - `data` Leaderboard
    - `next_reset_at` string, date-time
    - `rewards` LeaderboardReward[], required
      - `rank` integer, required
      - `reward_raw` number, required
      - `reward_currency` number, required
    - `top_users` LeaderboardUser[], required
      - `rank` integer, required
      - `name` string, required
      - `earnings_raw` number, required
      - `earnings_currency` number, required
      - `claimable_rewards` ClaimableReward[]
        - `id` integer, required — The id of the claimable reward.
        - `reward_type` 'DAILY' | 'WEEKLY' — The type of the claimable reward.
        - `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` LeaderboardUser
      - `rank` integer, required
      - `name` string, required
      - `earnings_raw` number, required
      - `earnings_currency` number, required
      - `claimable_rewards` ClaimableReward[]
        - `id` integer, required — The id of the claimable reward.
        - `reward_type` 'DAILY' | 'WEEKLY' — The type of the claimable reward.
        - `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.

## Other responses

- `404` — Not found if leaderboard is disabled

---

[API](https://skmtc.net/bitlabs/apis/bitlabs-client-api.md) · [All operations](https://skmtc.net/bitlabs/apis/bitlabs-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitlabs/bitlabs-client-api/versions/99209a6285bf/schema)
