Documentation

GetLeaderboardAroundCharacter

Retrieves a list of ranked characters for the given statistic, centered on the requested user

Request Details

GetLeaderboardAroundCharacterRequest
Request Properties
CharacterId (required) String

Unique PlayFab assigned ID for a specific character owned by a user

CharacterType String

Optional character type on which to filter the leaderboard entries.

MaxResultsCount (required) int32

Maximum number of entries to retrieve.

PlayFabId (required) String

Unique PlayFab assigned ID of the user on whom the operation will be performed.

StatisticName (required) String

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

POST https://{{TitleID}}.playfabapi.com/Server/GetLeaderboardAroundCharacter
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "StatisticName": "Kills",
  "PlayFabId": "10931252888739651331",
  "CharacterId": "987343220",
  "MaxResultsCount": 20
}
        

Response Details

Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.

GetLeaderboardAroundCharacterResult
Result Properties
Leaderboard List<CharacterLeaderboardEntry>

Ordered list of leaderboard entries.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Leaderboard": [
      {
        "PlayFabId": "10931252888739651331",
        "CharacterId": "987343220",
        "CharacterName": "FighterDude",
        "DisplayName": "username",
        "CharacterType": "blue_warrior",
        "StatValue": 12,
        "Position": 0
      }
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001