Score Object

Example Score

{
  "scoreID": "f6d129e0-13cf-4b87-b5bc-f839be90de12",
  "rank": 1611,
  "ordinal": "th",
  "formattedRank": "1,611th",
  "formattedScore": "78,563,114",
  "score": 78563114,
  "country": "GB",
  "date": "2025-11-06T05:30:14.6738343Z",
  "updates": 0,
  "countryRank": 477,
  "countryOrdinal": "th",
  "formattedCountryRank": "477th",
  "player": { ... },
  "teamID": "dc65bdc3-a157-4366-a6a0-f3a00b308151",
  "teamName": "Red Team",
  "scoreHistory": { ... },
  "tier": {
    "id": "gold-players",
    "name": "Gold Players"
  },
  "optionalValue1": 543,
  "optionalValue2": null,
  "optionalValue3": null
}

Object Properties

scoreID guid: A unique ID for this score.
rank int32?: The global rank of this score
ordinal string: The ordinal for the global rank of this score.
formattedRank string: The global rank of this score rendered using the requested locale, formatted to the specified requested culture.
formattedScore string: The score formatted under the score format specifications for this leaderboard, rendered using the requested locale, formatted to the specified requested culture.
score int64: The scores value.
country string: The ISO 3166-1 alpha-2 country code of the IP address that originally posted the score. Will return as NULL if the country could not be ascertained.
date datetime: The date this score was originally posted.
updates int16: How many times this score has been adjusted.
countryRank int32?: The country rank of this score. This property will not be shown if country scores are disabled in the leaderboard settings.
countryOrdinal string: The ordinal for the global country rank of this score. This property will not be shown if country scores are disabled in the leaderboard settings.
formattedCountryRank string: The global country rank of this score rendered using the requested locale. This property will not be shown if country scores are disabled in the leaderboard settings, formatted to the specified requested culture.
player Player: The player this score belongs to.
teamID guid?: The unique ID of the team this player belongs to if they have been assigned to a team.
teamName string: The name of the team this player belongs to if they have been assigned to a team. This property will not show if they are not assigned on a team.
scoreHistory ScoreHistory: If your get score request supports rank comparison and the compareRanks parameter is specified, a score history object for this score is returned. If there is no relevant history record for the specified time period, this property will not exist for this specific score in the response.
tier Tier: If tiers are setup on your leaderboard, the tier this score belongs to will be shown here.
optionalValue1 int16?: Optional values stored with the score record. They can be used to track information about a score, for example in a racing game you may wish to store how many secret coins they managed to collect.
optionalValue2 int16?: A second slot for an optional value.
optionalValue3 int16?: A third slot for an optional value.