Documentation

GetLeaderboard

Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard

Request Details

GetLeaderboardRequest
Request Properties
MaxResultsCount (required) int32

Maximum number of entries to retrieve.

ProfileConstraints PlayerProfileViewConstraints

If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager "Client Profile Options" tab in the "Settings" section.

StartPosition (required) int32

First entry in the leaderboard to be retrieved.

StatisticName (required) String

Unique identifier for the title-specific statistic for the leaderboard.

UseSpecificVersion (Governs: Version) Boolean

If set to false, Version is considered null. If true, uses the specified Version

Version int32

The version of the leaderboard to get.

POST https://{{TitleID}}.playfabapi.com/Server/GetLeaderboard
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StatisticName": "Kills",
  "StartPosition": 0,
  "MaxResultsCount": 20
}
        

Response Details

Note that the Position of the user in the results is for the overall leaderboard.

GetLeaderboardResult
Result Properties
Leaderboard List<PlayerLeaderboardEntry>

Ordered listing of users and their positions in the requested leaderboard.

NextReset DateTime

The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule.

Version (required) int32

The version of the leaderboard returned.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Leaderboard": [
      {
        "PlayFabId": "10931252888739651331",
        "DisplayName": "username",
        "StatValue": 12,
        "Position": 0,
        "Profile": {
          "AvatarUrl": "https://example.org/profile.jpg",
          "Statistics": [
            {
              "Name": "Points",
              "Version": 2,
              "Value": 15
            },
            {
              "Name": "XP",
              "Version": 1,
              "Value": 10
            }
          ]
        }
      }
    ],
    "Version": 0
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
LeaderboardVersionNotAvailable 1277