Skip to main content

Leaderboard API

Endpoints


Get a leaderboard's entries

GET https://api.trytalo.com/v1/leaderboards/:internalName/entries

50 results are returned per page, in the sort order defined by the leaderboard

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

KeyRequiredDescription
internalName YesThe internal name of the leaderboard

Query keys

KeyRequiredDescription
aliasId NoOnly return entries for this alias ID
page YesThe current pagination index (starting at 0)

Sample response

{ ... }

Create or update a leaderboard's entry

POST https://api.trytalo.com/v1/leaderboards/:internalName/entries

If an entry exists for the player and the leaderboard mode is set to unique, that entry will be updated with the new score (and the updated key will return true)

Headers

KeyRequiredDescription
x-talo-alias Yes

Route params

KeyRequiredDescription
internalName YesThe internal name of the leaderboard

Body keys

KeyRequiredDescription
props No
score YesA numeric score for the entry

Sample response

{ ... }