Interface User

Represents a User. Extends UserCompact with additional attributes. In addition, some optional attributes on UserCompact are included.

(trimmed long data attributes: monthly_playcounts, page.html, page.raw, rank_history.data, replays_watched_counts, user_achievements)

(removed deprecated keys: cover_url, rankHistory, ranked_and_approved_beatmapset_count, unranked_beatmapset_count)

{
    "avatar_url": "https://a.ppy.sh/9096716?1657853808.jpeg",
    "country_code": "US",
    "default_group": "default",
    "id": 9096716,
    "is_active": true,
    "is_bot": false,
    "is_deleted": false,
    "is_online": false,
    "is_supporter": true,
    "last_visit": null,
    "pm_friends_only": false,
    "profile_colour": null,
    "username": "Ooi",
    "discord": "LazyBoy#8455",
    "has_supported": true,
    "interests": null,
    "join_date": "2016-10-07T23:01:42+00:00",
    "kudosu": {
        "total": 0,
        "available": 0
    },
    "location": null,
    "max_blocks": 100,
    "max_friends": 500,
    "occupation": null,
    "playmode": "osu",
    "playstyle": [
        "keyboard",
        "tablet"
    ],
    "post_count": 0,
    "profile_order": [
        "me",
        "recent_activity",
        "top_ranks",
        "historical",
        "medals",
        "beatmaps",
        "kudosu"
    ],
    "title": null,
    "title_url": null,
    "twitter": "ImLazyBoy_",
    "website": "https://www.twitch.tv/ImLazyBoy",
    "country": {
        "code": "US",
        "name": "United States"
    },
    "cover": {
        "custom_url": "https://assets.ppy.sh/user-profile-covers/9096716/81232f717e3edbd0e804e203ba99e71fed85b7110e91e676287a6e08eb5f7899.png",
        "url": "https://assets.ppy.sh/user-profile-covers/9096716/81232f717e3edbd0e804e203ba99e71fed85b7110e91e676287a6e08eb5f7899.png",
        "id": null
    },
    "account_history": [],
    "active_tournament_banner": null,
    "badges": [],
    "beatmap_playcounts_count": 12295,
    "comments_count": 0,
    "favourite_beatmapset_count": 47,
    "follower_count": 472,
    "graveyard_beatmapset_count": 1,
    "groups": [],
    "guest_beatmapset_count": 0,
    "loved_beatmapset_count": 0,
    "mapping_follower_count": 4,
    "monthly_playcounts": [
        {
            "start_date": "2016-10-01",
            "count": 166
        },
        {
            "start_date": "2016-11-01",
            "count": 594
        },
        {
            "start_date": "2016-12-01",
            "count": 2146
        }
    ],
    "page": {
        "html": "<div class='bbcode bbcode--pro...",
        "raw": "[notice][centre][url=https://w..."
    },
    "pending_beatmapset_count": 0,
    "previous_usernames": [
        "yoB yzaL"
    ],
    "ranked_beatmapset_count": 0,
    "replays_watched_counts": [
        {
            "start_date": "2017-01-01",
            "count": 2
        },
        {
            "start_date": "2017-02-01",
            "count": 1
        },
        {
            "start_date": "2017-04-01",
            "count": 1
        }
    ],
    "scores_best_count": 100,
    "scores_first_count": 2,
    "scores_pinned_count": 8,
    "scores_recent_count": 12,
    "statistics": {
        "level": {
            "current": 102,
            "progress": 88
        },
        "global_rank": 1319,
        "pp": 10776,
        "ranked_score": 71934348389,
        "hit_accuracy": 98.9572,
        "play_count": 117034,
        "play_time": 6893600,
        "total_score": 315143525692,
        "total_hits": 29197994,
        "maximum_combo": 7757,
        "replays_watched_by_others": 2771,
        "is_ranked": true,
        "grade_counts": {
            "ss": 554,
            "ssh": 180,
            "s": 1810,
            "sh": 564,
            "a": 2856
        },
        "country_rank": 252,
        "rank": {
            "country": 252
        }
    },
    "support_level": 3,
    "user_achievements": [
        {
            "achieved_at": "2022-09-12T17:53:36+00:00",
            "achievement_id": 285
        },
        {
            "achieved_at": "2022-09-11T23:42:50+00:00",
            "achievement_id": 287
        },
        {
            "achieved_at": "2022-08-18T21:18:49+00:00",
            "achievement_id": 276
        }
    ],
    "rank_history": {
        "mode": "osu",
        "data": [
            1390,
            1391,
            1392
        ]
    }
}

(trimmed long data attributes: monthly_playcounts, page.html, page.raw, rank_history.data, replays_watched_counts, user_achievements)

(removed deprecated keys: cover_url, rankHistory, ranked_and_approved_beatmapset_count, unranked_beatmapset_count)

{
    "avatar_url": "https://a.ppy.sh/9096716?1657853808.jpeg",
    "country_code": "US",
    "default_group": "default",
    "id": 9096716,
    "is_active": true,
    "is_bot": false,
    "is_deleted": false,
    "is_online": false,
    "is_supporter": true,
    "last_visit": null,
    "pm_friends_only": false,
    "profile_colour": null,
    "username": "Ooi",
    "discord": "LazyBoy#8455",
    "has_supported": true,
    "interests": null,
    "join_date": "2016-10-07T23:01:42+00:00",
    "kudosu": {
        "total": 0,
        "available": 0
    },
    "location": null,
    "max_blocks": 100,
    "max_friends": 500,
    "occupation": null,
    "playmode": "osu",
    "playstyle": [
        "keyboard",
        "tablet"
    ],
    "post_count": 0,
    "profile_order": [
        "me",
        "recent_activity",
        "top_ranks",
        "historical",
        "medals",
        "beatmaps",
        "kudosu"
    ],
    "title": null,
    "title_url": null,
    "twitter": "ImLazyBoy_",
    "website": "https://www.twitch.tv/ImLazyBoy",
    "country": {
        "code": "US",
        "name": "United States"
    },
    "cover": {
        "custom_url": "https://assets.ppy.sh/user-profile-covers/9096716/81232f717e3edbd0e804e203ba99e71fed85b7110e91e676287a6e08eb5f7899.png",
        "url": "https://assets.ppy.sh/user-profile-covers/9096716/81232f717e3edbd0e804e203ba99e71fed85b7110e91e676287a6e08eb5f7899.png",
        "id": null
    },
    "account_history": [],
    "active_tournament_banner": null,
    "badges": [],
    "beatmap_playcounts_count": 12295,
    "comments_count": 0,
    "favourite_beatmapset_count": 47,
    "follower_count": 472,
    "graveyard_beatmapset_count": 1,
    "groups": [],
    "guest_beatmapset_count": 0,
    "loved_beatmapset_count": 0,
    "mapping_follower_count": 4,
    "monthly_playcounts": [
        {
            "start_date": "2016-10-01",
            "count": 166
        },
        {
            "start_date": "2016-11-01",
            "count": 594
        },
        {
            "start_date": "2016-12-01",
            "count": 2146
        }
    ],
    "page": {
        "html": "<div class='bbcode bbcode--pro...",
        "raw": "[notice][centre][url=https://w..."
    },
    "pending_beatmapset_count": 0,
    "previous_usernames": [
        "yoB yzaL"
    ],
    "ranked_beatmapset_count": 0,
    "replays_watched_counts": [
        {
            "start_date": "2017-01-01",
            "count": 2
        },
        {
            "start_date": "2017-02-01",
            "count": 1
        },
        {
            "start_date": "2017-04-01",
            "count": 1
        }
    ],
    "scores_best_count": 100,
    "scores_first_count": 2,
    "scores_pinned_count": 8,
    "scores_recent_count": 12,
    "statistics": {
        "level": {
            "current": 102,
            "progress": 88
        },
        "global_rank": 1319,
        "pp": 10776,
        "ranked_score": 71934348389,
        "hit_accuracy": 98.9572,
        "play_count": 117034,
        "play_time": 6893600,
        "total_score": 315143525692,
        "total_hits": 29197994,
        "maximum_combo": 7757,
        "replays_watched_by_others": 2771,
        "is_ranked": true,
        "grade_counts": {
            "ss": 554,
            "ssh": 180,
            "s": 1810,
            "sh": 564,
            "a": 2856
        },
        "country_rank": 252,
        "rank": {
            "country": 252
        }
    },
    "support_level": 3,
    "user_achievements": [
        {
            "achieved_at": "2022-09-12T17:53:36+00:00",
            "achievement_id": 285
        },
        {
            "achieved_at": "2022-09-11T23:42:50+00:00",
            "achievement_id": 287
        },
        {
            "achieved_at": "2022-08-18T21:18:49+00:00",
            "achievement_id": 276
        }
    ],
    "rank_history": {
        "mode": "osu",
        "data": [
            1390,
            1391,
            1392
        ]
    }
}

(Source)

Hierarchy-Diagram

UML class diagram of User
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property

Hierarchy

Properties

account_history? active_tournament_banner? avatar_url badges? beatmap_playcounts_count? blocks? comments_count? country country_code cover default_group discord? favourite_beatmapset_count? follower_count? friends? graveyard_beatmapset_count? groups? guest_beatmapset_count? has_supported id interests? is_active is_bot is_deleted is_online is_restricted? is_supporter join_date kudosu last_visit? location? loved_beatmapset_count? mapping_follower_count? max_blocks max_friends monthly_playcounts? occupation? page? pending_beatmapset_count? playmode playstyle pm_friends_only post_count previous_usernames? profile_colour? profile_order rank_history? ranked_beatmapset_count? replays_watched_counts? scores_best_count? scores_first_count? scores_pinned_count? scores_recent_count? statistics? statistics_rulesets support_level? title? title_url? twitter? unread_pm_count? user_achievements? user_preferences? username variants? website?

Properties

Optional account_history

account_history?: UserAccountHistory[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional active_tournament_banner

active_tournament_banner?: null | UserProfileBanner

May be additionally included in the response. Relevant endpoints should list them if applicable.

null if the user has no active tournament banner.

This is included in a UserEndpointGet object.

avatar_url

avatar_url: string

Url of user's avatar.

Optional badges

badges?: UserBadge[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional beatmap_playcounts_count

beatmap_playcounts_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointMe object.

Optional blocks

blocks?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional comments_count

comments_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

country

country: UserCompactCountry

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object.

country_code

country_code: string

Two-letter code representing user's country.

cover

cover: UserCompactCover

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object.

default_group

default_group: string

Identifier of the default group the user belongs to.

Optional discord

discord?: null | string

Discord name. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional favourite_beatmapset_count

favourite_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional follower_count

follower_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional friends

friends?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional graveyard_beatmapset_count

graveyard_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional groups

groups?: UserGroup[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional guest_beatmapset_count

guest_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

has_supported

has_supported: boolean

Whether or not ever being a supporter in the past.

id

id: number

Unique identifier for user.

Optional interests

interests?: null | string

Interests string. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

is_active

is_active: boolean

Has this account been active in the last x months?

is_bot

is_bot: boolean

Is this a bot account?

is_deleted

is_deleted: boolean

Account was deleted.

is_online

is_online: boolean

Is the user currently online? (either on lazer or the new website).

Optional is_restricted

is_restricted?: boolean

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a User object if this is the currently authenticated user.

This is included in a UserEndpointMe object.

is_supporter

is_supporter: boolean

Does this user have supporter?

join_date

join_date: string

Date since when the user account exists.

kudosu

kudosu: UserCompactKusodo

https://osu.ppy.sh/wiki/en/Modding/Kudosu

Optional last_visit

last_visit?: null | string

Last access time. null if the user hides online presence.

This is included in a UserEndpointGet/UserEndpointSearchUser object.

Optional location

location?: null | string

Location string. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional loved_beatmapset_count

loved_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional mapping_follower_count

mapping_follower_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

max_blocks

max_blocks: number

Maximum number of users allowed to be blocked.

max_friends

max_friends: number

Maximum number of friends allowed to be added.

Optional monthly_playcounts

monthly_playcounts?: UserMonthlyPlaycount[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional occupation

occupation?: null | string

Occupation string. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional page

page?: UserCompactPage

May be additionally included in the response. Relevant endpoints should list them if applicable.

If the user has never edited their page (never supported osu!) this key will not be undefined.

This is included in a UserEndpointGet object.

Optional pending_beatmapset_count

pending_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

playmode

playmode: GameMode

The default game mode the user is playing.

playstyle

playstyle: null | Playstyle[]

Device choices of the user. null if the user has it not set in the settings.

pm_friends_only

pm_friends_only: boolean

Whether or not the user allows PM from other than friends.

post_count

post_count: number

Number of forum posts.

Integer

Optional previous_usernames

previous_usernames?: string[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional profile_colour

profile_colour?: null | string

Colour of username/profile highlight.

This is included in a UserEndpointGet/UserEndpointSearchUser object.

profile_order

profile_order: ProfilePage[]

Ordered array of sections in user profile page.

Optional rank_history

rank_history?: UserRankHistory

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional ranked_beatmapset_count

ranked_beatmapset_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional replays_watched_counts

replays_watched_counts?: UserReplaysWatchedCount[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_best_count

scores_best_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_first_count

scores_first_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_pinned_count

scores_pinned_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional scores_recent_count

scores_recent_count?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional statistics

statistics?: UserStatistics

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

statistics_rulesets

statistics_rulesets: UserStatisticsRulesets

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointMe object.

Optional support_level

support_level?: number

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional title

title?: null | string

User-specific title. null if the user has no title.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional title_url

title_url?: null | string

User-specific title URL. null if the user has no title URL.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional twitter

twitter?: null | string

Twitter name. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional unread_pm_count

unread_pm_count?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

Optional user_achievements

user_achievements?: UserAchievement[]

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Optional user_preferences

user_preferences?: unknown

May be additionally included in the response. Relevant endpoints should list them if applicable.

username

username: string

User's display name.

Optional variants

variants?: UserGameModeVariant[]

Exists for profiles that have mania as their default game mode.

Optional website

website?: null | string

Website string. null if the user has it not set in the settings.

May be additionally included in the response. Relevant endpoints should list them if applicable.

This is included in a UserEndpointGet object.

Settings

Member Visibility

Theme

Generated using TypeDoc