Skip to main content

​
Endpoint

GET /leaderboard/individual/global/{category}
Individual leaderboards across all raids. This endpoint returns rankings for players based on their cumulative performance across all raid activities.

​
Path Parameters

​
category
string
required
The leaderboard category to retrieve. Must be one of:
  • clears - Total raid completions
  • full-clears - Total full (fresh) raid completions
  • sherpas - Total sherpa runs (helping first-time raiders)
  • speedrun - Fastest completion times (duration format)
  • world-first-rankings - World first race performance scores
  • in-raid-time - Total time spent in raids

​
Query Parameters

​
count
integer
default:"50"
Number of entries to return per page. Must be between 10 and 100.
​
page
integer
default:"1"
Page number of leaderboard data. Ignored if search is provided. Must be greater than 0.
​
search
string
Search for a specific player by membershipId. Returns results centered around that player’s position. Pattern: ^\d+n?$

​
Response

The response varies based on the category. Some categories return individual entries, while others return team entries.
​
type
string
Either "individual" or "team" depending on the category
​
format
string
Either "duration" or "numerical" indicating the value format
​
page
integer
Current page number
​
count
integer
Number of entries returned
​
entries
array
Array of leaderboard entries

​
Example Request

curl --request GET \
  --url 'https://api.raidhub.io/leaderboard/individual/global/clears?count=10&page=1' \
  --header 'X-API-KEY: your_api_key'

​
Example Response

{
  "minted": "2024-03-15T12:00:00.000Z",
  "success": true,
  "response": {
    "type": "individual",
    "format": "numerical",
    "page": 1,
    "count": 10,
    "entries": [
      {
        "position": 1,
        "rank": 1,
        "value": 1247,
        "playerInfo": {
          "membershipId": "4611686018488107374",
          "membershipType": 3,
          "bungieGlobalDisplayName": "TopRaider",
          "bungieGlobalDisplayNameCode": "1234",
          "iconPath": "/common/destiny2_content/icons/avatar.jpg",
          "displayName": "TopRaider#1234",
          "lastSeen": "2024-03-15T11:45:00.000Z",
          "isPrivate": false,
          "cheatLevel": 0
        }
      }
    ]
  }
}

​
Error Responses

​
PlayerNotOnLeaderboardError
404
Returned when searching for a player who is not on the leaderboard
{
  "minted": "2024-03-15T12:00:00.000Z",
  "success": false,
  "code": "PlayerNotOnLeaderboardError",
  "error": {
    "membershipId": "4611686018488107374"
  }
}
​
PathValidationError
404
Invalid category parameter
​
QueryValidationError
400
Invalid query parameters (count, page, or search)

Build docs developers (and LLMs) love

Get started for freeTalk to us