This API is currently just a wrapper around the official THE FINALS leaderboard API from Embark.
There is a single endpoint, /v1/leaderboard/:leaderboardVersion/:platform?
, which returns a JSON object. The standard is the following:
{
"meta": {
"leaderboardVersion": "s3",
"leaderboardPlatform": "crossplay",
"...chosen parameters"
},
"count": "amount of entries in 'data'",
"data": [
{
"rank": 1,
"...rest of player data"
}
]
}
To know which properties each leaderboard returns, just try it and see. The data returned is also explicitly defined in the folder /src/transformers.
leaderboardVersion
: The leaderboard version. One ofcb1
,cb2
,ob
,s1
,s2
,s3
, ors3worldtour
. Always required. Note: There is also alive
parameter, but this was a bad idea, so thelive
parameter will continue pointing at Season 2.platform
: The platform. Only required for versionsob
,s1
,s2
, ands3
Needs to be one ofcrossplay
,steam
,xbox
, orpsn
. However,s3
ands3worldtour
only supportcrossplay
.
count
: If set totrue
, the API will only return the number of entries in the leaderboard after filters have been applied. Defaults tofalse
name
: If set, the API will only return entries whose name matches the given string. Performs a case-insensitive against all the user's names.
https://api.the-finals-leaderboard.com/v1/leaderboard/cb1?name=fish
https://api.the-finals-leaderboard.com/v1/leaderboard/ob/steam?count=true&name=ttv
https://api.the-finals-leaderboard.com/v1/leaderboard/s1/crossplay
https://api.the-finals-leaderboard.com/v1/leaderboard/s2/xbox
https://api.the-finals-leaderboard.com/v1/leaderboard/s3/crossplay
https://api.the-finals-leaderboard.com/v1/leaderboard/s4/crossplay