View as Markdown

Leaderboards

Read more about the Leaderboards system in Hiro here .

The methods below require Hiro 1.33 or later. If you are on an earlier version, see Hiro 1.32 and earlier .

Get all leaderboards #

List all available leaderboards.

1
2
3
4

var request = Hiro.LeaderboardListRequest.new()

var leaderboard_list = await hiro.leaderboardList(session, request)
print(leaderboard_list)

Filter by category:

1
2
3
4
5

var request = Hiro.LeaderboardListRequest.new()
request.categories = ["Tournament"]

var leaderboard_list = await hiro.leaderboardList(session, request)
print(leaderboard_list)

Get a leaderboard #

Get a specified leaderboard by ID.

1
2
3
4
5

var request = Hiro.LeaderboardGet.new()
request.id = "GalacticChampions"

var leaderboard = await hiro.leaderboardGet(session, request)
print(leaderboard)

Submit a score #

Submit a score to a leaderboard.

1
2
3
4
5
6
7

var request = Hiro.LeaderboardUpdate.new()
request.id = "GalacticChampions"
request.score = 1500
request.subscore = 0

var leaderboard_score = await hiro.leaderboardUpdate(session, request)
print(leaderboard_score)

List scores #

List scores on a leaderboard. Pass owner_ids to retrieve scores for specific owners.

1
2
3
4
5
6
7

var request = Hiro.LeaderboardScoresListRequest.new()
request.id = "GalacticChampions"
request.owner_ids = ["userId1", "userId2"]
request.limit = 100

var score_list = await hiro.leaderboardScoresList(session, request)
print(score_list)

Filter by region:

1
2
3
4
5
6
7

var request = Hiro.LeaderboardScoresListRequest.new()
request.id = "GalacticChampions"
request.region = "EU"
request.limit = 100

var score_list = await hiro.leaderboardScoresList(session, request)
print(score_list)

List scores around owner #

List scores centred around a specific owner.

1
2
3
4
5
6
7

var request = Hiro.LeaderboardScoresListAroundOwnerRequest.new()
request.id = "GalacticChampions"
request.owner_id = session.user_id
request.limit = 10

var score_list = await hiro.leaderboardScoresListAroundOwner(session, request)
print(score_list)

Hiro 1.32 and earlier #

Prior to Hiro 1.33, leaderboardsConfigGet was the only way to retrieve available leaderboards, returning a LeaderboardConfigList with basic configuration data. This method is deprecated in Hiro 1.33 and later. Use leaderboardList instead.

1
2

var leaderboard_config_list = await hiro.leaderboardsConfigGet(session)
print(leaderboard_config_list)