Retrieve a leaderboard

Overview

This endpoint allows you to retrieve a leaderboard from a community. The page and limit query parameters are required.

By default, the endpoint returns the all time leaderboard. You can retrieve a sprint leaderboard by specifying the sprintId in the query parameters.

To get the ID of a sprint, head to:

pageList sprints

The leaderboard record object

---

userId - String

Zealy ID of the user

---

name - String

Zealy username of the user

---

connectedWallet - String

This field holds the address of the wallet the user connected to Zealy

---

address - String

Wallet address of the user on the blockchain the community is on. Users add those addresses themselves to their profiles, thus we can't confirm these belong to them.

---

xp - Number

XP of the user in the leaderboard

---

avatar - String

URL of the user's avatar

---

twitterId - String

Twitter ID of the user

---

twitterUsername - String

Twitter username of the user

---

discordHandle - String

Discord handle of the user

---

discordId - String

Discord ID of the user

---

email - String

Email of the user

---

API Reference

Get leaderboard for a community

GEThttps://api-v2.zealy.io/public/communities/{subdomain}/leaderboard

Path parameters

subdomain*string

Query parameters

Header parameters

Response

200400401403404409429500

200

Body

application/json

data*array of object

totalPages*number

page*number

totalRecords*number

statusenum

computedresyncingoutdated

Request

JavaScriptCurl

const response = await fetch('https://api-v2.zealy.io/public/communities/{subdomain}/leaderboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "xp": 0,
      "name": "text",
      "avatar": "https://example.com",
      "address": "text",
      "twitterId": "text",
      "twitterUsername": "text",
      "discordHandle": "text",
      "discordId": "text",
      "connectedWallet": "text",
      "numberOfQuests": 0,
      "email": "text"
    }
  ],
  "totalPages": 0,
  "page": 0,
  "totalRecords": 0,
  "status": "computed"
}