Skip to main content
POST
Get Leaderboard Around User

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json
MaxResultsCount
number
required

Maximum number of entries to retrieve.

PlayFabId
string
required

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

StatisticName
string
required

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

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ProfileConstraints
object

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.

UseSpecificVersion
boolean

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

Version
number

The version of the leaderboard to get.

Response

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

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

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

Example:
Last modified on October 1, 2026