Sign in
player

Get player profile

<Note> This endpoint is cached for <Badge intent="success" minimal>2 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>PLAYER</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits). </Note> <Warning> Player stats are subject to [Access Rules](/privacy), which can hide some of the stats. Check the `restrictions` object to see which access rules affected the response. </Warning> <Info> It is recommended to request players by UUID. Username lookups can return `300 MultipleObjectsReturned` with a multi-selector response when more than one player matches the query. </Info> `previousRanking` is stored daily based on player activity. Subtracting `previousRanking` from the current ranking gives the player's leaderboard progression. <Info> Use `fullResult` to include full character data. The `characters` object uses the same structure as [GET /player/{username}/characters/{uuid}](api:GET/player/{username}/characters/{uuid}). </Info>
get/player/{username}

Path parameters

usernamestring required

Username or UUID accepted by the player route.

Query parameters

fullResult''

Presence-based flag that expands responses. Send it without a value as ?fullResult. Using ?fullResult=true or ?fullResult=false is not accepted.

Response

Player profile.

usernamestring required
onlineboolean required
serverstring nullable required
activeCharacterstring uuid nullable required
nicknamestring nullable required
uuidstring uuid required
rankstring required
rankBadgestring required
shortenedRankstring required
supportRankstring nullable required
veteranboolean required
lastJoinstring date-time required
rankingRankMap required

Map of leaderboard type/name to rank position. See GET /leaderboards/types for possible types.

previousRankingRankMap required

Map of leaderboard type/name to rank position. See GET /leaderboards/types for possible types.

firstJoinstring date-time required
playtimenumber double required
wallpaperstring required
avatarstring required
restrictionsobject required
charactersobject
<Info> Only present when `fullResult` is enabled. </Info>

Changes

No recorded changes to this endpoint across all 1 revision of this API.