Get Leaderboard Around Character
Retrieves a list of ranked characters for the given statistic, centered on the requested user
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| ProductDisabledForTitle | 1609 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"StatisticName": "Kills",
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"MaxResultsCount": 20
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter"
payload = {
"StatisticName": "Kills",
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"MaxResultsCount": 20
}
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
StatisticName: 'Kills',
PlayFabId: '10931252888739651331',
CharacterId: '987343220',
MaxResultsCount: 20
})
};
fetch('https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'StatisticName' => 'Kills',
'PlayFabId' => '10931252888739651331',
'CharacterId' => '987343220',
'MaxResultsCount' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter"
payload := strings.NewReader("{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Leaderboard": [
{
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"CharacterName": "FighterDude",
"DisplayName": "username",
"CharacterType": "blue_warrior",
"StatValue": 12
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Unique PlayFab assigned ID for a specific character owned by a user
Maximum number of entries to retrieve.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Unique identifier for the title-specific statistic for the leaderboard.
Response
Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Note: When calling 'GetLeaderboardAround...' APIs, the position of the character defaults to 0 when the character does not have the corresponding statistic.
Show child attributes
Show child attributes
{ "Leaderboard": [ { "PlayFabId": "10931252888739651331", "CharacterId": "987343220", "CharacterName": "FighterDude", "DisplayName": "username", "CharacterType": "blue_warrior", "StatValue": 12 } ] }
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"StatisticName": "Kills",
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"MaxResultsCount": 20
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter"
payload = {
"StatisticName": "Kills",
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"MaxResultsCount": 20
}
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
StatisticName: 'Kills',
PlayFabId: '10931252888739651331',
CharacterId: '987343220',
MaxResultsCount: 20
})
};
fetch('https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'StatisticName' => 'Kills',
'PlayFabId' => '10931252888739651331',
'CharacterId' => '987343220',
'MaxResultsCount' => 20
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter"
payload := strings.NewReader("{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/GetLeaderboardAroundCharacter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"10931252888739651331\",\n \"CharacterId\": \"987343220\",\n \"MaxResultsCount\": 20\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Leaderboard": [
{
"PlayFabId": "10931252888739651331",
"CharacterId": "987343220",
"CharacterName": "FighterDude",
"DisplayName": "username",
"CharacterType": "blue_warrior",
"StatValue": 12
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}