curl --request POST \
--url https://api.steamsets.com/v1/leaderboard.getAccountLeaderboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leaderboard": "apps",
"app": {
"appId": 1
},
"badge": {
"id": 1,
"isFoil": true
},
"end": 1,
"goToLeaderboardRank": 1,
"location": [
{
"city": "<string>",
"country": "<string>",
"region": "<string>",
"state": "<string>"
}
],
"start": 1
}
'{
"accounts": [
{
"appCost": 1,
"appPlaytime": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"donated": 1,
"economyBan": "<string>",
"foilBadgeCost": 1,
"foilBadges": 1,
"friends": 1,
"gameBans": 1,
"level": 1,
"name": "<string>",
"normalBadgeCost": 1,
"normalBadges": 1,
"playtime": 1,
"pointsGiven": 1,
"pointsReceived": 1,
"privacy": "public",
"rank": 1,
"roles": [
{
"extras": {},
"rating": 123,
"role": "user"
}
],
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"badgeInfo": {
"completionTime": "2023-11-07T05:31:56Z",
"level": 1,
"xp": 1
},
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
}
],
"$schema": "<string>",
"app": {
"id": 1,
"image": "<string>",
"name": "<string>",
"type": "<string>"
},
"badgeInfo": {
"appId": 1,
"appImage": "<string>",
"appName": "<string>",
"image": "<string>",
"isFoil": true,
"level": 1,
"name": "<string>"
},
"hiddenRanks": [
1
],
"location": [
{
"cityName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"region": "<string>",
"stateName": "<string>"
}
],
"ownAccount": {
"appCost": 1,
"appPlaytime": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"donated": 1,
"economyBan": "<string>",
"foilBadgeCost": 1,
"foilBadges": 1,
"friends": 1,
"gameBans": 1,
"level": 1,
"name": "<string>",
"normalBadgeCost": 1,
"normalBadges": 1,
"playtime": 1,
"pointsGiven": 1,
"pointsReceived": 1,
"privacy": "public",
"rank": 1,
"roles": [
{
"extras": {},
"rating": 123,
"role": "user"
}
],
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"badgeInfo": {
"completionTime": "2023-11-07T05:31:56Z",
"level": 1,
"xp": 1
},
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedOutOf": 0
}Get account leaderboard
curl --request POST \
--url https://api.steamsets.com/v1/leaderboard.getAccountLeaderboard \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leaderboard": "apps",
"app": {
"appId": 1
},
"badge": {
"id": 1,
"isFoil": true
},
"end": 1,
"goToLeaderboardRank": 1,
"location": [
{
"city": "<string>",
"country": "<string>",
"region": "<string>",
"state": "<string>"
}
],
"start": 1
}
'{
"accounts": [
{
"appCost": 1,
"appPlaytime": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"donated": 1,
"economyBan": "<string>",
"foilBadgeCost": 1,
"foilBadges": 1,
"friends": 1,
"gameBans": 1,
"level": 1,
"name": "<string>",
"normalBadgeCost": 1,
"normalBadges": 1,
"playtime": 1,
"pointsGiven": 1,
"pointsReceived": 1,
"privacy": "public",
"rank": 1,
"roles": [
{
"extras": {},
"rating": 123,
"role": "user"
}
],
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"badgeInfo": {
"completionTime": "2023-11-07T05:31:56Z",
"level": 1,
"xp": 1
},
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
}
],
"$schema": "<string>",
"app": {
"id": 1,
"image": "<string>",
"name": "<string>",
"type": "<string>"
},
"badgeInfo": {
"appId": 1,
"appImage": "<string>",
"appName": "<string>",
"image": "<string>",
"isFoil": true,
"level": 1,
"name": "<string>"
},
"hiddenRanks": [
1
],
"location": [
{
"cityName": "<string>",
"countryCode": "<string>",
"countryName": "<string>",
"region": "<string>",
"stateName": "<string>"
}
],
"ownAccount": {
"appCost": 1,
"appPlaytime": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"donated": 1,
"economyBan": "<string>",
"foilBadgeCost": 1,
"foilBadges": 1,
"friends": 1,
"gameBans": 1,
"level": 1,
"name": "<string>",
"normalBadgeCost": 1,
"normalBadges": 1,
"playtime": 1,
"pointsGiven": 1,
"pointsReceived": 1,
"privacy": "public",
"rank": 1,
"roles": [
{
"extras": {},
"rating": 123,
"role": "user"
}
],
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"badgeInfo": {
"completionTime": "2023-11-07T05:31:56Z",
"level": 1,
"xp": 1
},
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedOutOf": 0
}API Access
This endpoint can be accessed using:- API Keys: For external applications and integrations
- User Sessions: For web application access
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The leaderboard to get
apps, app_playtime, app_valid_playtime, awards_given, awards_received, bans, game_bans, vac_bans, donations, foil_badges, normal_badges, badges, playtime, valid_playtime, points_given, points_received, steam_sets, xp, badge_completion_time, badge_highest_level The end index
x >= 0The rank to go to
x >= 0The location(s)to get the leaderboard for, otherwise global
Show child attributes
Show child attributes
The city to get the leaderboard for, otherwise global
The country to get the leaderboard for, otherwise global
The region to get the leaderboard for, otherwise global
The state to get the leaderboard for, otherwise global
The start index
x >= 0Response
OK
Show child attributes
Show child attributes
The cost of an app
x >= 0For the app playtime leaderboard
x >= 0The number of apps the account has
x >= 0The avatar hash of the account
The number of awards the account has
x >= 0The number of awards the account has
x >= 0The number of badges the account has
x >= 0The number of bans
x >= 0The time the account was created
The total of donations the account has
x >= 0The economy ban of the account
The cost of a foil badge
x >= 0The number of foil badges the account has
x >= 0The number of friends the account has
x >= 0The number of game bans
x >= 0The level of the account
x >= 0The name of the account
The cost of a normal badge
x >= 0The number of normal badges the account has
x >= 0The playtime of the account
x >= 0The number of points the account has
x >= 0The number of points the account has
x >= 0The privacy of the account
public, private, friends_only The rank of the account
x >= 0The roles of the account
Show child attributes
Show child attributes
The higher the more presedence it has
user, donator, staff, developer, partner, owner, amethyst, amber, emerald, sapphire, ruby, diamond, contributor, early_supporter, beta, translator, top_100, badge_scout, nitro_booster, astral, nebula The steam id
The steam sets score
x >= 0The vanity of the account
The vanity of the account
The number of vac bans
x >= 0The number of xp the account has
x >= 0The badge info of the account, incase of a badge leaderboard
A URL to the JSON Schema for this object.
Show child attributes
Show child attributes
The id of the app
x >= 0The image of the app
The name of the app
The image of the badge
Whether the badge is foil or not
The level of the badge
x >= 0The name of the badge
The ranks that are hidden in the leaderboard
x >= 0Show child attributes
Show child attributes
The city name of the location
The country code of the location
The country name of the location
The region of the location
The state name of the location
The account that is currently logged in, if its not already in the leaderboard
Show child attributes
Show child attributes
The cost of an app
x >= 0For the app playtime leaderboard
x >= 0The number of apps the account has
x >= 0The avatar hash of the account
The number of awards the account has
x >= 0The number of awards the account has
x >= 0The number of badges the account has
x >= 0The number of bans
x >= 0The time the account was created
The total of donations the account has
x >= 0The economy ban of the account
The cost of a foil badge
x >= 0The number of foil badges the account has
x >= 0The number of friends the account has
x >= 0The number of game bans
x >= 0The level of the account
x >= 0The name of the account
The cost of a normal badge
x >= 0The number of normal badges the account has
x >= 0The playtime of the account
x >= 0The number of points the account has
x >= 0The number of points the account has
x >= 0The privacy of the account
public, private, friends_only The rank of the account
x >= 0The roles of the account
Show child attributes
Show child attributes
The higher the more presedence it has
user, donator, staff, developer, partner, owner, amethyst, amber, emerald, sapphire, ruby, diamond, contributor, early_supporter, beta, translator, top_100, badge_scout, nitro_booster, astral, nebula The steam id
The steam sets score
x >= 0The vanity of the account
The vanity of the account
The number of vac bans
x >= 0The number of xp the account has
x >= 0The badge info of the account, incase of a badge leaderboard
The number of accounts that are ranked in the leaderboard
x >= 0