Skip to main content

​
Endpoint

GET /leaderboard/team/contest/{raid}
Ranking of all teams which completed the official contest version of the raid during the contest period. This provides the complete contest mode leaderboard, not limited to the first 1000 completions.

​
Path Parameters

​
raid
string
required
The raid identifier (path name). Examples:
  • deepstone
  • vaultofglass
  • vowofthedisciple
  • kingsfail
  • rootofnightmares
  • crotasend
  • salvationsedge
Only raids that had a contest mode are available. Use the /manifest endpoint to check contestRaidIds.

​
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 teams containing that player. Pattern: ^\d+n?$

​
Response

​
type
string
Always "team" for this endpoint
​
format
string
Always "duration" - values represent completion time in seconds
​
page
integer
Current page number
​
count
integer
Number of entries returned
​
entries
array
Array of team leaderboard entries

​
Example Request

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

​
Example Response

{
  "minted": "2024-03-15T12:00:00.000Z",
  "success": true,
  "response": {
    "type": "team",
    "format": "duration",
    "page": 1,
    "count": 10,
    "entries": [
      {
        "position": 1,
        "rank": 1,
        "value": 18523,
        "instanceId": "12345678901234567",
        "players": [
          {
            "membershipId": "4611686018488107374",
            "membershipType": 3,
            "bungieGlobalDisplayName": "ContestWinner",
            "bungieGlobalDisplayNameCode": "1111",
            "iconPath": "/common/destiny2_content/icons/avatar.jpg",
            "displayName": "ContestWinner#1111",
            "lastSeen": "2024-03-15T08:30:00.000Z",
            "isPrivate": false,
            "cheatLevel": 0
          }
        ]
      }
    ]
  }
}

​
Notes

  • Contest mode typically lasts 24-48 hours after a raid’s launch
  • All teams that completed the raid during this period are ranked
  • The value represents time from contest start to completion
  • Only completions during the official contest window are included

​
Error Responses

​
RaidNotFoundError
404
The specified raid was not found or does not have a contest mode
{
  "minted": "2024-03-15T12:00:00.000Z",
  "success": false,
  "code": "RaidNotFoundError",
  "error": {
    "raid": "invalidraid"
  }
}
​
PlayerNotOnLeaderboardError
404
Returned when searching for a player who did not complete this raid during contest mode
​
PathValidationError
404
Invalid path parameters
​
QueryValidationError
400
Invalid query parameters

Build docs developers (and LLMs) love

Get started for freeTalk to us