Use Player Leaderboards

This how-to submits and retrieves scores on a Player Leaderboard, where each entry is tied to an individual player.

Prerequisites

• Unity, Unreal, or Godot SDK installed and configured in your project (not required for REST).
• An active Player session (see Authentication).
• A Player Leaderboard configured in the Web Console (see Configure Leaderboard in Web Console).

Submitting Score

Submit a score to a Player Leaderboard.

Unity

string leaderboardKey = "my_leaderboard";
int score = 1000;

LootLockerSDKManager.SubmitScore("", score, leaderboardKey, (response) =>
{
    if (!response.success) {
        Debug.Log("Could not submit score!");
        Debug.Log(response.errorData.ToString());
        return;
    }
    Debug.Log("Successfully submitted score!");

});

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Unreal

Blueprint example of submitting scores

You need to exchange the TriggerSubmitScore event for whatever event you want to use to trigger this flow. Replace the input variables with the data you want to submit to the Leaderboard.

We recommend branching the completed events on the success flag in the response — add error handling in case the request fails, plus whatever continued actions you want on success.

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Godot

var leaderboardKey : String = "my_leaderboard"
var score : int = 1000

var response = await LL_Leaderboards.SubmitScore.new(leaderboardKey, score).send()
if(!response.success) :
    # Request failed, handle errors
    pass
else:
    # Request succeeded, use response as applicable in your game logic
    pass

REST

curl -X POST "https://api.lootlocker.io/game/leaderboards/1/submit" \
-d "{\"score\": 1000}" \
-H "Content-Type: application/json"

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Get Leaderboard Entries

Retrieve the first 50 Player Leaderboard entries.

Unity

string leaderboardKey = "my_leaderboard";
int count = 50;

LootLockerSDKManager.GetScoreList(leaderboardKey, count, 0, (response) =>
{
    if (!response.success) {
        Debug.Log("Could not get score list!");
        Debug.Log(response.errorData.ToString());
        return;
    }
    Debug.Log("Successfully got score list!");
});

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Unreal

Blueprint example of getting top scores

You need to exchange the TriggerGetScores event for whatever event you want to use to trigger this flow. Replace the input variables with your Leaderboard key and how many items you want to get.

We recommend branching the completed events on the success flag in the response — add error handling in case the request fails, plus whatever continued actions you want on success. If you want to fetch more items on the score list, save the pagination information for later use.

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Godot

var leaderboardKey : String = "my_leaderboard"
var count : int = 50

var response = await LL_Leaderboards.GetScoreList.new(leaderboardKey, count).send()
if(!response.success) :
    # Request failed, handle errors
    pass
else:
    # Request succeeded, use response as applicable in your game logic
    pass

REST

curl -X GET "https://api.lootlocker.io/game/leaderboards/1/list?count=50"

Check out the Reference Documentation for a more in-depth understanding of the endpoint.

Get a Single Leaderboard Entry

Retrieve a single entry from a Player Leaderboard.

Unity

string leaderboardKey = "my_leaderboard";
string memberID = "50";

LootLockerSDKManager.GetMemberRank(leaderboardKey, memberID, (response) =>
{
    if (!response.success) {
        Debug.Log("Could not get the entry!");
        Debug.Log(response.errorData.ToString());
        return;
    }
    Debug.Log("Successfully got entry!");
});

Unreal

Blueprint example of getting score for a member

You need to exchange the TriggerGetScores event for whatever event you want to use to trigger this flow. Replace the input variables with your Leaderboard key and which member you want to fetch.

We recommend branching the completed events on the success flag in the response — add error handling in case the request fails, plus whatever continued actions you want on success.

Godot

var leaderboardKey : String = "my_leaderboard"
var memberId : String = "a_member_id"

var response = await LL_Leaderboards.GetMemberRank.new(leaderboardKey, memberId).send()
if(!response.success) :
    # Request failed, handle errors
    pass
else:
    # Request succeeded, use response as applicable in your game logic
    pass

REST

curl -X GET "https://api.lootlocker.io/game/leaderboards/1/member/1"

Conclusion

You've submitted and retrieved scores on a Player Leaderboard. Next, see Use Scheduled Reset with Rewards to reward top-ranked players automatically.