Sign in
Leaderboard

Get a Player's Leaderboard Rank

Changed on
get/leaderboard/rank/{leaderboard}/{playerUuid}/{profileUuid}

Request

  • Base URL: https://api.eliteskyblock.com
  • URL: https://api.eliteskyblock.com/leaderboard/rank/{leaderboard}/{playerUuid}/{profileUuid}
  • Auth: none declared

Path parameters

leaderboardstring required

Id of leaderboard

playerUuidstring required
profileUuidstring required

Query parameters

includeUpcomingboolean nullable

Include upcoming players

upcominginteger nullable

Amount of upcoming players to include (max 100). Only works with new leaderboard backend

previousinteger nullable

Amount of passed players to include (max 3).

atRankinteger nullable

Start at a specified rank for upcoming players. Use AtAmount instead for better lookups.

atAmountnumber double nullable

Start at a specified score threshold for upcoming players. Pass your locally tracked score to get upcoming players without needing to calculate the correct rank.

intervalstring nullable

Time interval key of a monthly leaderboard. Format: yyyy-MM

modestring nullable

Game mode to filter leaderboard by. Leave empty to get all modes. Options: "ironman", "island", "classic"

removed0 | 1 | 2

Removed filter to get leaderboard entries that have been removed from the leaderboard. Default is profiles that have not been removed/wiped. 0 = Not Removed 1 = Removed 2 = All

Response

Success

rankinteger required

Current rank of the player (-1 if not on leaderboard)

amountnumber double required

Current score of the player (0 if not on leaderboard)

initialAmountnumber double required

The starting amount of the leaderboard entry for interval based leaderboards

minAmountnumber double required

The minimum amount required to be on the leaderboard. If this is a time based leaderboard, this score is instead required on the normal leaderboard before the player can be on the time based leaderboard

upcomingRankinteger required

The starting rank of the returned upcoming players list

disabledboolean nullable

True if endpoint was disabled for this request

Changes

  • 07bdf24d7483Revision changes
    • info

      added the new optional query request parameter atAmount

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status

  • 3a3ecc53d0ecRevision changes
    • warning

      deleted the query request parameter new

    • info

      api operation id EliteAPIFeaturesLeaderboardsEndpointsGetPlayerRankGetPlayerRankEndpoint1 removed and replaced with GetPlayerRank1

    • info

      added the new optional query request parameter previous

    • info

      added the optional property to the response with the status