Documentation

​
​

Development

User Acquisition

Monetization

Industry

Leaderboards

Unity SDK

Admin API

Client API

Open Unity Dashboard

Leaderboards

LiveOps
​
​
Leaderboards
  • Overview
  • Get started
  • Concepts
  • Tutorials
    • Configuration
    • Unity SDK tutorial
      • Add a new score
      • Get the player's score
      • Get scores
      • Get a range of scores centered around the player
      • Get scores for other players
      • Get scores for a certain tier
      • Get a list of available leaderboard versions
      • Get the player's score from a leaderboard version
      • Get scores from a leaderboard version
      • Get a range of scores centered around the player from a leaderboard version
      • Get scores for other players from a leaderboard version
      • Get scores for a certain tier from a leaderboard version
    • Unity SDK sample
    • Cloud Code samples
  • Reference
  • Privacy and consent
  1. Leaderboards
  3. Unity SDK tutorial

Get scores from a leaderboard version

Retrieve a list of scores from a specific leaderboard.
Read time 1 minute
Last updated 9 months ago
Players can get scores from a specified leaderboard version with the 
GetVersionScoresAsync
method. By default the method fetches the top 10 scores:
public async void GetVersionScores(string leaderboardId, string versionId){    var scoresResponse = await LeaderboardsService.Instance        .GetVersionScoresAsync(leaderboardId, versionId);    Debug.Log(JsonConvert.SerializeObject(scoresResponse));}
Paginated access to all scores in the leaderboard is available by specifying the optional 
GetVersionScoresOptions
object with the optional 
Offset
and 
Limit
pagination arguments.
Offset
is the number of entries to skip when retrieving the leaderboard scores and defaults to 0.
Limit
is the number of leaderboard scores to return and defaults to 10.
public async void GetPaginatedVersionScores(string leaderboardId, string versionId){    var scoresResponse = await LeaderboardsService.Instance.GetVersionScoresAsync(        leaderboardId,        versionId,        new GetVersionScoresOptions{ Offset = 25, Limit = 50 }    );    Debug.Log(JsonConvert.SerializeObject(scoresResponse));}
Note
Metadata is not retrieved by default.
To get the score with any associated metadata, use the 
IncludeMetadata
option in the 
GetVersionScoresOptions
configuration object:
public async void GetVersionScoresWithMetadata(string leaderboardId, string versionId){    var scoresResponse = await LeaderboardsService.Instance.GetVersionScoresAsync(        leaderboardId,        versionId,        new GetVersionScoresOptions { IncludeMetadata = true }    );    Debug.Log(JsonConvert.SerializeObject(scoresResponse));}
For details on how to get available leaderboard version IDs, see Get available leaderboard version.
Note
For methods that retrieve scores: if your player has not submitted a score and the leaderboard is bucketed, the player is not assigned a bucket. A failed score retrieval returns an error that has its 
Reason
field set to 
ScoreSubmissionRequired
.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

    Report a problem with this page