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. </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>

Path parameters

usernamestringRequired
Username or UUID accepted by the player route.

Query parameters

fullResultenumOptional

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

Allowed values:

Response

Player profile.
usernamestring
onlineboolean
serverstring or null
activeCharacterstring or nullformat: "uuid"
nicknamestring or null
uuidstringformat: "uuid"
rankstring
rankBadgestring
legacyRankColourobject
shortenedRankstring
supportRankstring or null
veteranboolean
lastJoindatetime
guildobject or null
rankingmap from strings to integers

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

previousRankingmap from strings to integers

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

firstJoindatetime
playtimedouble
globalDataobject
featuredStatsstring or integer
wallpaperstring
avatarstring
restrictionsmap from strings to booleans
charactersmap from strings to objects

Only present when fullResult is enabled.

Errors

404
Not Found Error
500
Internal Server Error