Get Leaderboard

This document contains information about getting the leaderboard for a particular tournament in a casino.

Request (GET)

/gateway/tournaments/{version}/{brand_id}/leaderboard

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino.
tournament_id query string true The ID of the tournament.
player_id query string false The ID of the player. Automatically derived from x-auth-token when that header is present.
status query string false Tournament status filter:
1=Active, currenty running tournament
3=Completed, ended tournaments

Postman sample:

curl --location 'http://www.my_site_backend.com/tournaments/1/1501/leaderboard?tournament_id=b3c9408a-8077-4c24-8939-3baa65e1eb44' \
--header 'x-auth-token: place your token here'

Response

The API returns ALL leaderboard entries for the tournament in a single response (no pagination).

Name Type Description
leaderboards array Array of tournament leaderboard objects.
tournament_id string The ID of the tournament.
tournament_name string The Name of the tournament defined by operator.
player_data array List of ALL players with their positions and points in the tournament.
position integer The player’s position in the leaderboard (1 for first place, 2 for second, etc.).
player_id string The unique identifier of the player. Masked as “***” + last 3 digits (e.g., “***024”) for privacy in leaderboard.
points string The total points accumulated by the player in the tournament.
prize_value number The prize value for this position.
start_date datetime Date and time of the tournament start.
end_date datetime Date and time of the tournament end.
games object List of games, participating in tournament, grouped by operator key.
total_participants integer Total number of players participating in the tournament.
rules object See rules structure
prizes object See prizes structure
current_player_entry object Information about the current player’s leaderboard entry (if player_id provided). Player ID is NOT masked in this field.

Status 200

{
  "status": "Success",
  "data": {
    "leaderboards": [
      {
        "tournament_id": "540855c7-7343-49d4-89a6-0b0b2e8e06bc",
        "tournament_name": "Tour erfrfrff",
        "player_data": [
          {
            "position": 1,
            "player_id": "***704",
            "points": "400",
            "prize_value": 200
          },
          {
            "position": 2,
            "player_id": "***024",
            "points": "342",
            "prize_value": 100
          },
          {
            "position": 3,
            "player_id": "***705",
            "points": "200",
            "prize_value": 50
          },
          {
            "position": 4,
            "player_id": "***888",
            "points": "200",
            "prize_value": 0
          },
          {
            "position": 5,
            "player_id": "***706",
            "points": "144",
            "prize_value": 0
          }
        ],
        "start_date": "2025-10-20 18:00:00",
        "end_date": "2025-11-17 18:00:00",
        "games": {
          "Groove_BetSoft": {
            "provider_name": "Betsoft",
            "games": [
              {
                "game_id": "82687",
                "game_name": "House of Fun"
              }
            ]
          }
        },
        "total_participants": 60,
        "rules": {
          "BetToPointsConversion": [
            {
              "points_to_add": 1,
              "required_wager": 5
            }
          ],
          "MinimumBetAmount": [
            {
              "required_wager": 10
            }
          ],
          "MinimumBetsOrRoundsRequired": [
            {
              "required_bets": 10,
              "required_rounds": 1
            }
          ]
        },
        "prizes": {
          "SpecificPositionPrize": [
            {
              "position": 1,
              "prize": 200
            },
            {
              "position": 2,
              "prize": 100
            },
            {
              "position": 3,
              "prize": 50
            }
          ]
        }
      }
    ],
    "current_player_entry": {
      "position": 11,
      "player_id": "224336",
      "points": "50",
      "prize_value": 0
    }
  }
}

Status 400 (Missing authentication header)

{
  "status" : "Error",
  "data" : {
    "errMsg" : "invalid input - invalid token"
  },
  "message" : "authentication failed",
  "userFriendlyMessage" : "Authentication failed"
}

Status 404 (Tournament not found)

{
  "status" : "Error",
  "data" : {
    "errMsg" : "tournament not found"
  },
  "message" : "Tournament with the specified ID does not exist",
  "userFriendlyMessage" : "Tournament not found"
}