Sign in
Leaderboard

Get a Player's Leaderboard Rank

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

Request

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

Path parameters

leaderboardstring required
playerUuidstring required
profileUuidstring required

Query parameters

includeUpcomingboolean nullable
upcominginteger nullable
previousinteger nullable
atRankinteger nullable
atAmountnumber double nullable
intervalstring nullable
modestring nullable
removed0 | 1 | 2

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 EliteAPIFeaturesLeaderboardsEndpointsGetPlayerRankGetPlayerRankEndpoint2 removed and replaced with GetPlayerRank2

    • info

      added the new optional query request parameter previous

    • info

      added the optional property to the response with the status