Interface Plus

Obtainable From

API.getBeatmapset / API.lookupBeatmapset

interface Plus {
    artist: string;
    artist_unicode: string;
    availability: {
        download_disabled: boolean;
        more_information: null | string;
    };
    beatmaps: WithFailtimes[];
    bpm: number;
    can_be_hyped: boolean;
    converts: WithFailtimes[];
    covers: {
        card: string;
        card@2x: string;
        cover: string;
        cover@2x: string;
        list: string;
        list@2x: string;
        slimcover: string;
        slimcover@2x: string;
    };
    creator: string;
    current_nominations: {
        beatmapset_id: number;
        reset: boolean;
        rulesets: null | Ruleset[];
        user_id: number;
    }[];
    deleted_at: null | Date;
    description: {
        description: string;
    };
    discussion_locked: boolean;
    favourite_count: number;
    genre: {
        id: Genre;
        name:
            | "Any"
            | "Unspecified"
            | "Video Game"
            | "Anime"
            | "Rock"
            | "Pop"
            | "Other"
            | "Novelty"
            | "Hip Hop"
            | "Electronic"
            | "Metal"
            | "Classical"
            | "Folk"
            | "Jazz";
    };
    has_favourited?: boolean;
    hype: null | {
        current: number;
        required: number;
    };
    id: number;
    is_scoreable: boolean;
    language: {
        id: Language;
        name:
            | "Any"
            | "Unspecified"
            | "Other"
            | "English"
            | "Japanese"
            | "Chinese"
            | "Instrumental"
            | "Korean"
            | "French"
            | "German"
            | "Swedish"
            | "Spanish"
            | "Italian"
            | "Russian"
            | "Polish";
    };
    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;
    pack_tags: string[];
    play_count: number;
    preview_url: string;
    ranked: RankStatus;
    ranked_date: null | Date;
    ratings: number[];
    recent_favourites: User[];
    related_users: User[];
    source: string;
    spotlight: boolean;
    status: string;
    storyboard: boolean;
    submitted_date: null | Date;
    tags: string;
    title: string;
    title_unicode: string;
    track_id: null | number;
    user: User;
    user_id: number;
    video: boolean;
}

Hierarchy (view full)

Properties

artist artist_unicode availability beatmaps bpm can_be_hyped converts covers creator current_nominations deleted_at description discussion_locked favourite_count genre has_favourited? hype id is_scoreable language last_updated legacy_thread_url nominations_summary nsfw offset pack_tags play_count preview_url ranked ranked_date ratings recent_favourites related_users source spotlight status storyboard submitted_date tags title title_unicode track_id user 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: WithFailtimes[]

The different beatmaps/difficulties this beatmapset has

bpm

bpm: number

can_be_hyped

can_be_hyped: boolean

converts

converts: WithFailtimes[]

The different beatmaps made for osu!, but converted to the other Rulesets

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

current_nominations

current_nominations: {
    beatmapset_id: number;
    reset: boolean;
    rulesets: null | Ruleset[];
    user_id: number;
}[]

deleted_at

deleted_at: null | Date

description

description: {
    description: string;
}

Type declaration

  • description: string

    In HTML

discussion_locked

discussion_locked: boolean

favourite_count

favourite_count: number

genre

genre: {
    id: Genre;
    name:
        | "Any"
        | "Unspecified"
        | "Video Game"
        | "Anime"
        | "Rock"
        | "Pop"
        | "Other"
        | "Novelty"
        | "Hip Hop"
        | "Electronic"
        | "Metal"
        | "Classical"
        | "Folk"
        | "Jazz";
}

Optionalhas_favourited

has_favourited?: boolean

Only exists if authorized user

hype

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

id

id: number

is_scoreable

is_scoreable: boolean

language

language: {
    id: Language;
    name:
        | "Any"
        | "Unspecified"
        | "Other"
        | "English"
        | "Japanese"
        | "Chinese"
        | "Instrumental"
        | "Korean"
        | "French"
        | "German"
        | "Swedish"
        | "Spanish"
        | "Italian"
        | "Russian"
        | "Polish";
}

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

    • main_ruleset: number
    • non_main_ruleset: number

nsfw

nsfw: boolean

offset

offset: number

pack_tags

pack_tags: string[]

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

ratings

ratings: number[]

recent_favourites

recent_favourites: User[]

related_users

related_users: User[]

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

user: User

user_id

user_id: number

video

video: boolean

Settings

Member Visibility

On This Page

Properties