API reference
API reference
Select your platform
No SDKs available
No versions available

LeaderboardEntry Interface

A leaderboard entry object contains information about the User who made the entry, their score, and other relevant details in the leaderboard. It provides a way for a game to keep track of players and their scores in relation to other. A single leaderboard entry can be written by Leaderboards.writeEntry. A block of leaderboard entries can be retrieved using Leaderboards.getEntries. Visit our website for more information about the leaderboard entry.

Signature

interface LeaderboardEntry

Properties

displayScore : String?
[Get]
The formatted score that will be displayed in the leaderboard of this entry. You can select a score type to determine how scores are displayed on Leaderboard. See here for examples of different score type.
Signature 
abstract val displayScore: String?
extraData : ByteArray?
[Get]
A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer. It will be used by two entry methods: Leaderboards.writeEntry and Leaderboards.writeEntryWithSupplementaryMetric
Signature 
abstract val extraData: ByteArray?
id : String?
[Get]
This is a unique identifier for the leaderboard entry. It is of type id and is optional.
Signature 
abstract val id: String?
rank : Int
[Get]
The rank of this leaderboard entry in the leaderboard. It is of type int. It can be used in Leaderboards.getEntriesAfterRank to retrieve leaderboard entries starting from a specified rank.
Signature 
abstract val rank: Int
score : Long
[Get]
The raw underlying value of the score achieved by the user in the leaderboard. It's of type long_as_string and it's used to determine the user's rank in the leaderboard.
Signature 
abstract val score: Long
supplementaryMetric : SupplementaryMetric?
[Get]
SupplementaryMetric is a supplemental piece of data that can be used for tiebreakers by Leaderboards.writeEntryWithSupplementaryMetric.
Signature 
abstract val supplementaryMetric: SupplementaryMetric?
timestamp : LocalDateTime
[Get]
The timestamp of this entry being created in the leaderboard.
Signature 
abstract val timestamp: LocalDateTime
user : User
[Get]
User of this leaderboard entry. It is of type User. You can request a block of leaderboard entries for the specified user ID(s) by Leaderboards.getEntriesByIds.
Signature 
abstract val user: User
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta