curl --request POST \
--url https://api.steamsets.com/v1/leaderboard.previewAccountRank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leaderboard": "apps",
"id": {
"accountId": 1,
"steamId64": "<string>"
},
"value": 1,
"vanity": {
"type": "steam",
"value": "<string>"
}
}
'{
"$schema": "<string>",
"ownAccount": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedAbove": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedBelow": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedOutOf": 0
}Preview Account Rank
Preview what an account’s rank would be on a leaderboard with a hypothetical score, showing surrounding ranks.
curl --request POST \
--url https://api.steamsets.com/v1/leaderboard.previewAccountRank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"leaderboard": "apps",
"id": {
"accountId": 1,
"steamId64": "<string>"
},
"value": 1,
"vanity": {
"type": "steam",
"value": "<string>"
}
}
'{
"$schema": "<string>",
"ownAccount": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedAbove": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 1,
"xp": 1,
"city": {
"name": "<string>"
},
"country": {
"name": "<string>",
"code": "<string>"
},
"region": {
"name": "<string>"
},
"state": {
"name": "<string>"
}
},
"rankedBelow": {
"appCost": 1,
"apps": 1,
"avatar": "<string>",
"awardsGiven": 1,
"awardsReceived": 1,
"badges": 1,
"bans": 1,
"createdAt": "2023-11-07T05:31:56Z",
"differenceToUs": 1,
"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"
}
],
"score": 1,
"steamId": "<string>",
"steamSetsScore": 1,
"steamSetsVanity": "<string>",
"steamVanity": "<string>",
"vacBans": 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, awards_given, awards_received, bans, game_bans, vac_bans, donations, foil_badges, normal_badges, badges, playtime, points_given, points_received, steam_sets, xp What their leaderboard score would be, will use their current rank if not set
x >= 0Response
OK
A URL to the JSON Schema for this object.
Either the logged in user or the requested steamId, otherwise just contains the rank and score
Show child attributes
Show child attributes
The cost of an app
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 difference between the account's score and the user's score
x >= 0The 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 score of the account
x >= 0The 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 account ranked above the account (rank-1)
Show child attributes
Show child attributes
The cost of an app
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 difference between the account's score and the user's score
x >= 0The 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 score of the account
x >= 0The 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 account ranked below the account (rank+1)
Show child attributes
Show child attributes
The cost of an app
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 difference between the account's score and the user's score
x >= 0The 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 score of the account
x >= 0The 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 number of accounts that are ranked in the leaderboard
x >= 0