--- title: "Preview account rank" method: POST path: "/v1/leaderboard.previewAccountRank" tags: ["leaderboard"] --- # Preview account rank `POST /v1/leaderboard.previewAccountRank` ## Request body - V1LeaderboardPreviewAccountRankRequestBody - `$schema` string, uri — A URL to the JSON Schema for this object. - `id` IDSearch - `accountId` integer — Account ID to search for - `steamId64` string — SteamID64 to search for - `leaderboard` 'apps' | 'awards_given' | 'awards_received' | 'bans' | 'game_bans' | 'vac_bans' | 'donations' | 'foil_badges' | 'normal_badges' | 'badges' | 'playtime' | 'points_given' | 'points_received' | 'steam_sets' | 'xp', required — The leaderboard to get - `value` integer, nullable — What their leaderboard score would be, will use their current rank if not set - `vanity` VanitySearch - `type` 'steam' | 'internal', required — Which type of vanity to search for - `value` string, required — Vanity to search for ## Response `200` OK - V1LeaderboardPreviewAccountRankResponseBody - `$schema` string, uri — A URL to the JSON Schema for this object. - `ownAccount` PreviewAccount, nullable - `animatedAvatar` string, required — The animated avatar of the account - `apps` integer, required — The number of apps the account has - `avatar` string, required — The avatar hash of the account - `avatarFrame` string, required — The avatar frame of the account - `awardsGiven` integer, required — The number of awards the account has - `awardsReceived` integer, required — The number of awards the account has - `background` string, required — The background of the account - `badges` integer, required — The number of badges the account has - `bans` integer, required — The number of bans - `city` LeaderboardCity, nullable - `name` string, required — The name of the city - `country` LeaderboardCountry, nullable - `code` string — The code of the country - `name` string, required — The name of the country - `createdAt` string, date-time, required — The time the account was created - `differenceToUs` integer, required — The difference between the account's score and the user's score - `donated` integer, required — The total of donations the account has - `economyBan` string, required — The economy ban of the account - `foilBadges` integer, required — The number of foil badges the account has - `friends` integer, required — The number of friends the account has - `gameBans` integer, required — The number of game bans - `level` integer, required — The level of the account - `miniBackground` string, required — The mini background of the account - `name` string, required — The name of the account - `nameEffect` 'none' | 'rainbow' | 'glitch' | 'shadow' | 'neon' | 'retro' | 'stamped' | 'shatter' | 'typewriter' | 'vaporwave' | 'sunken', required — Donator name effect, none when unset or the account no longer holds an entitling role - `normalBadges` integer, required — The number of normal badges the account has - `playtime` integer, required — The playtime of the account - `pointsGiven` integer, required — The number of points the account has - `pointsReceived` integer, required — The number of points the account has - `privacy` 'public' | 'private' | 'friends_only', required — The privacy of the account - `rank` integer, required — The rank of the account - `region` LeaderboardRegion, nullable - `name` string, required — The name of the region - `roles` Role[], nullable, required — The roles of the account - `extras` object, nullable, required — Extra data associated with the role - `rating` integer, required — The higher the more presedence it has - `role` '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', required - `score` integer, required — The score of the account - `state` LeaderboardState, nullable - `name` string, required — The name of the state - `steamId` string, required — The steam id - `steamSetsScore` integer, required — The steam sets score - `steamSetsVanity` string, required — The vanity of the account - `steamVanity` string, required — The vanity of the account - `themeColor` string, nullable, required — Donator profile theme color as #RRGGBB (no alpha), null when unset or the account no longer holds an entitling role - `vacBans` integer, required — The number of vac bans - `xp` integer, required — The number of xp the account has - `rankedAbove` PreviewAccount, nullable - `animatedAvatar` string, required — The animated avatar of the account - `apps` integer, required — The number of apps the account has - `avatar` string, required — The avatar hash of the account - `avatarFrame` string, required — The avatar frame of the account - `awardsGiven` integer, required — The number of awards the account has - `awardsReceived` integer, required — The number of awards the account has - `background` string, required — The background of the account - `badges` integer, required — The number of badges the account has - `bans` integer, required — The number of bans - `city` LeaderboardCity, nullable - `name` string, required — The name of the city - `country` LeaderboardCountry, nullable - `code` string — The code of the country - `name` string, required — The name of the country - `createdAt` string, date-time, required — The time the account was created - `differenceToUs` integer, required — The difference between the account's score and the user's score - `donated` integer, required — The total of donations the account has - `economyBan` string, required — The economy ban of the account - `foilBadges` integer, required — The number of foil badges the account has - `friends` integer, required — The number of friends the account has - `gameBans` integer, required — The number of game bans - `level` integer, required — The level of the account - `miniBackground` string, required — The mini background of the account - `name` string, required — The name of the account - `nameEffect` 'none' | 'rainbow' | 'glitch' | 'shadow' | 'neon' | 'retro' | 'stamped' | 'shatter' | 'typewriter' | 'vaporwave' | 'sunken', required — Donator name effect, none when unset or the account no longer holds an entitling role - `normalBadges` integer, required — The number of normal badges the account has - `playtime` integer, required — The playtime of the account - `pointsGiven` integer, required — The number of points the account has - `pointsReceived` integer, required — The number of points the account has - `privacy` 'public' | 'private' | 'friends_only', required — The privacy of the account - `rank` integer, required — The rank of the account - `region` LeaderboardRegion, nullable - `name` string, required — The name of the region - `roles` Role[], nullable, required — The roles of the account - `extras` object, nullable, required — Extra data associated with the role - `rating` integer, required — The higher the more presedence it has - `role` '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', required - `score` integer, required — The score of the account - `state` LeaderboardState, nullable - `name` string, required — The name of the state - `steamId` string, required — The steam id - `steamSetsScore` integer, required — The steam sets score - `steamSetsVanity` string, required — The vanity of the account - `steamVanity` string, required — The vanity of the account - `themeColor` string, nullable, required — Donator profile theme color as #RRGGBB (no alpha), null when unset or the account no longer holds an entitling role - `vacBans` integer, required — The number of vac bans - `xp` integer, required — The number of xp the account has - `rankedBelow` PreviewAccount, nullable - `animatedAvatar` string, required — The animated avatar of the account - `apps` integer, required — The number of apps the account has - `avatar` string, required — The avatar hash of the account - `avatarFrame` string, required — The avatar frame of the account - `awardsGiven` integer, required — The number of awards the account has - `awardsReceived` integer, required — The number of awards the account has - `background` string, required — The background of the account - `badges` integer, required — The number of badges the account has - `bans` integer, required — The number of bans - `city` LeaderboardCity, nullable - `name` string, required — The name of the city - `country` LeaderboardCountry, nullable - `code` string — The code of the country - `name` string, required — The name of the country - `createdAt` string, date-time, required — The time the account was created - `differenceToUs` integer, required — The difference between the account's score and the user's score - `donated` integer, required — The total of donations the account has - `economyBan` string, required — The economy ban of the account - `foilBadges` integer, required — The number of foil badges the account has - `friends` integer, required — The number of friends the account has - `gameBans` integer, required — The number of game bans - `level` integer, required — The level of the account - `miniBackground` string, required — The mini background of the account - `name` string, required — The name of the account - `nameEffect` 'none' | 'rainbow' | 'glitch' | 'shadow' | 'neon' | 'retro' | 'stamped' | 'shatter' | 'typewriter' | 'vaporwave' | 'sunken', required — Donator name effect, none when unset or the account no longer holds an entitling role - `normalBadges` integer, required — The number of normal badges the account has - `playtime` integer, required — The playtime of the account - `pointsGiven` integer, required — The number of points the account has - `pointsReceived` integer, required — The number of points the account has - `privacy` 'public' | 'private' | 'friends_only', required — The privacy of the account - `rank` integer, required — The rank of the account - `region` LeaderboardRegion, nullable - `name` string, required — The name of the region - `roles` Role[], nullable, required — The roles of the account - `extras` object, nullable, required — Extra data associated with the role - `rating` integer, required — The higher the more presedence it has - `role` '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', required - `score` integer, required — The score of the account - `state` LeaderboardState, nullable - `name` string, required — The name of the state - `steamId` string, required — The steam id - `steamSetsScore` integer, required — The steam sets score - `steamSetsVanity` string, required — The vanity of the account - `steamVanity` string, required — The vanity of the account - `themeColor` string, nullable, required — Donator profile theme color as #RRGGBB (no alpha), null when unset or the account no longer holds an entitling role - `vacBans` integer, required — The number of vac bans - `xp` integer, required — The number of xp the account has - `rankedOutOf` integer — The number of accounts that are ranked in the leaderboard ## Other responses - `400` — Bad Request - `401` — Unauthorized - `422` — Unprocessable Entity - `500` — Internal Server Error --- [API](https://skmtc.net/steamsets/apis/steamsets-api.md) · [All operations](https://skmtc.net/steamsets/apis/steamsets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steamsets/steamsets-api/versions/f7c45c9ec36a/schema)