Get Leaderboard • Lurkr Docs

Returns the leaderboard for a guild. This endpoint is paginated and returns up to 100 results per call.

GET/levels/{entry}

Path Parameters

entryRequiredstring

Query Parameters

pageRequiredinteger

Minimum: 1

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

guildRequiredobject

isManagerRequiredboolean

levelsRequiredarray<object>

multipliersRequiredarray<object>

roleRewardsRequiredarray<object>

vanityRequiredstring | null | null

curl -X GET "https://api.lurkr.gg/v2/levels/stringstringstrin?page=1"

{
  "guild": {
    "id": "stringstringstrin",
    "name": "string",
    "icon": "string"
  },
  "isManager": true,
  "levels": [
    {
      "level": 0,
      "messageCount": 0,
      "nextLevelXp": 0,
      "progress": 100,
      "rank": 1,
      "user": {
        "accentColour": "string",
        "avatar": "stringstringstringstringstringst",
        "discriminator": "string",
        "globalName": "string",
        "username": "string"
      },
      "userId": "stringstringstrin",
      "xp": 0
    }
  ],
  "multipliers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "multiplier": 5,
      "targets": [
        {
          "id": "stringstringstrin",
          "name": "string",
          "color": 0,
          "position": 0
        }
      ],
      "type": "Channel"
    }
  ],
  "roleRewards": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "level": 0,
      "roles": [
        {
          "id": "stringstringstrin",
          "name": "string",
          "color": 0,
          "position": 0
        }
      ]
    }
  ],
  "vanity": "string"
}