Skip to main content

Endpoint

GET /leaderboard/individual/raid/{raid}/{category}
Individual leaderboards for a specific raid. Returns rankings for players based on their performance in a particular raid activity.

Path Parameters

raid
string
required
The raid identifier (path name). Examples:
  • vaultofglass
  • deepstone
  • kingsfail
  • rootofnightmares
  • salvationsedge
  • crotasend
Use the /manifest endpoint to get all available raid paths.
category
string
required
The leaderboard category to retrieve. Must be one of:
  • clears - Total completions of this raid
  • freshClears - Total fresh (full) completions
  • sherpas - Total sherpa runs for this raid

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 for a specific player by membershipId. Returns results centered around that player’s position. Pattern: ^\d+n?$

Response

type
string
Always "individual" for this endpoint
format
string
Always "numerical" for raid-specific leaderboards
page
integer
Current page number
count
integer
Number of entries returned
entries
array
Array of individual leaderboard entries

Example Request

curl --request GET \
  --url 'https://api.raidhub.io/leaderboard/individual/raid/salvationsedge/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": 156,
        "playerInfo": {
          "membershipId": "4611686018488107374",
          "membershipType": 3,
          "bungieGlobalDisplayName": "RaidMaster",
          "bungieGlobalDisplayNameCode": "5678",
          "iconPath": "/common/destiny2_content/icons/avatar.jpg",
          "displayName": "RaidMaster#5678",
          "lastSeen": "2024-03-15T11:30:00.000Z",
          "isPrivate": false,
          "cheatLevel": 0
        }
      }
    ]
  }
}

Error Responses

RaidNotFoundError
404
The specified raid was not found
{
  "minted": "2024-03-15T12:00:00.000Z",
  "success": false,
  "code": "RaidNotFoundError",
  "error": {
    "raid": "invalidraid"
  }
}
PlayerNotOnLeaderboardError
404
Returned when searching for a player who is not on this raid’s leaderboard
PathValidationError
404
Invalid path parameters
QueryValidationError
400
Invalid query parameters

Build docs developers (and LLMs) love