Interface WithBeatmap

Obtainable From

API.getUserBeatmaps

interface WithBeatmap {
    artist: string;
    artist_unicode: string;
    availability: {
        download_disabled: boolean;
        more_information: null | string;
    };
    beatmaps: Beatmap.Extended[];
    bpm: number;
    can_be_hyped: boolean;
    covers: {
        card: string;
        "card@2x": string;
        cover: string;
        "cover@2x": string;
        list: string;
        "list@2x": string;
        slimcover: string;
        "slimcover@2x": string;
    };
    creator: string;
    deleted_at: null
    | Date;
    discussion_locked: boolean;
    favourite_count: number;
    hype: null | { current: number; required: number };
    id: number;
    is_scoreable: boolean;
    last_updated: Date;
    legacy_thread_url: string;
    nominations_summary: {
        current: number;
        eligible_main_rulesets: null | ["osu" | "taiko" | "fruits" | "mania"];
        required_meta: { main_ruleset: number; non_main_ruleset: number };
    };
    nsfw: boolean;
    offset: number;
    play_count: number;
    preview_url: string;
    ranked: RankStatus;
    ranked_date: null
    | Date;
    source: string;
    spotlight: boolean;
    status: string;
    storyboard: boolean;
    submitted_date: null | Date;
    tags: string;
    title: string;
    title_unicode: string;
    track_id: null | number;
    user_id: number;
    video: boolean;
}

Hierarchy (View Summary)

Properties

artist artist_unicode availability beatmaps bpm can_be_hyped covers creator deleted_at discussion_locked favourite_count hype id is_scoreable last_updated legacy_thread_url nominations_summary nsfw offset play_count preview_url ranked ranked_date source spotlight status storyboard submitted_date tags title title_unicode track_id user_id video

Properties

artist

artist: string

artist_unicode

artist_unicode: string

availability

availability: { download_disabled: boolean; more_information: null | string }

Type declaration

  • download_disabled: boolean

    So it's false if you can download it

  • more_information: null | string

beatmaps

beatmaps: Beatmap.Extended[]

bpm

bpm: number

can_be_hyped

can_be_hyped: boolean

covers

covers: {
    card: string;
    "card@2x": string;
    cover: string;
    "cover@2x": string;
    list: string;
    "list@2x": string;
    slimcover: string;
    "slimcover@2x": string;
}

creator

creator: string

deleted_at

deleted_at: null | Date

discussion_locked

discussion_locked: boolean

favourite_count

favourite_count: number

hype

hype: null | { current: number; required: number }

id

id: number

is_scoreable

is_scoreable: boolean

last_updated

last_updated: Date

legacy_thread_url

legacy_thread_url: string

nominations_summary

nominations_summary: {
    current: number;
    eligible_main_rulesets: null | ["osu" | "taiko" | "fruits" | "mania"];
    required_meta: { main_ruleset: number; non_main_ruleset: number };
}

Type declaration

  • current: number
  • eligible_main_rulesets: null | ["osu" | "taiko" | "fruits" | "mania"]
  • required_meta: { main_ruleset: number; non_main_ruleset: number }

    Required nominations

nsfw

nsfw: boolean

offset

offset: number

play_count

play_count: number

preview_url

preview_url: string

A string like that where id is the id of the beatmapset: //b.ppy.sh/preview/58951.mp3

ranked

ranked: RankStatus

ranked_date

ranked_date: null | Date

source

source: string

spotlight

spotlight: boolean

status

status: string

Is it ranked, is it graveyarded, etc

storyboard

storyboard: boolean

submitted_date

submitted_date: null | Date

tags

tags: string

title

title: string

A title readable by any english-speaking person, so it'd be in romaji if the song's title is in Japanese

title_unicode

title_unicode: string

Basically the title is the original language, so with hiragana, katakana and kanji if Japanese

track_id

track_id: null | number

If the song exists on a featured artist's page, then it has a track_id

Remarks

https://osu.ppy.sh/beatmaps/artists/tracks/<track_id> redirects to the page of said featured artist

user_id

user_id: number

video

video: boolean

Settings

Member Visibility

On This Page

Properties