API reference
LeaderboardEntry
Updated: Oct 30, 2025
LeaderboardEntry
interface LeaderboardEntry
A leaderboard entry object contains information about the horizon.platform.users.models.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 horizon.platform.leaderboards.Leaderboards.writeEntry. A block of leaderboard entries can be retrieved using horizon.platform.leaderboards.Leaderboards.getEntries. Visit our website for more information about the leaderboard entry.
Properties
| Name | Summary |
|---|---|
displayScore | abstract val displayScore: String? 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. |
extraData | abstract val extraData: ByteArray? 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: horizon.platform.leaderboards.Leaderboards.writeEntry and horizon.platform.leaderboards.Leaderboards.writeEntryWithSupplementaryMetric |
id | abstract val id: String? This is a unique identifier for the leaderboard entry. It is of type id and is optional. |
json | open val json: String |
rank | abstract val rank: Int The rank of this leaderboard entry in the leaderboard. It is of type int. It can be used in horizon.platform.leaderboards.Leaderboards.getEntriesAfterRank to retrieve leaderboard entries starting from a specified rank. |
score | abstract val score: Long 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. |
supplementaryMetric | abstract val supplementaryMetric: SupplementaryMetric? horizon.platform.leaderboards.models.SupplementaryMetric is a supplemental piece of data that can be used for tiebreakers by horizon.platform.leaderboards.Leaderboards.writeEntryWithSupplementaryMetric. |
timestamp | abstract val timestamp: LocalDateTime The timestamp of this entry being created in the leaderboard. |
user | abstract val user: User User of this leaderboard entry. It is of type horizon.platform.users.models.User. You can request a block of leaderboard entries for the specified user ID(s) by horizon.platform.leaderboards.Leaderboards.getEntriesByIds. |
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta