Leaderboard API

Talo aims to work across many different game genres and as such our leaderboards are highly-customisable. Leaderboards can be sorted by descending or ascending order. You can also customise whether players can only have one or multiple entries in a single leaderboard.

Learn more about leaderboards here.

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

Key	Required	Description
x-talo-alias	❌ No	The ID of the player's alias

Route params

Key	Required	Description
internalName	✅ Yes	The internal name of the leaderboard

Query keys

Key	Required	Description
aliasId	❌ No	Only return entries for this alias ID
page	✅ Yes	The 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

Key	Required	Description
x-talo-alias	✅ Yes

Route params

Key	Required	Description
internalName	✅ Yes	The internal name of the leaderboard

Body keys

Key	Required	Description
props	❌ No
score	✅ Yes	A numeric score for the entry

Sample response

{ ... }

---