Beatmapsets#

beatmapset(self, beatmapset_id=None, *, beatmap_id=None)#

Get a beatmapset from a beatmapset id or a beatmap id.

Parameters:
Return type:

Beatmapset

Notes

Combines the Get Beatmapset and Beatmapset Lookup endpoints.

beatmapset_discussion_posts(self, beatmapset_discussion_id=None, *, limit=None, page=None, sort=None, user_id=None, with_deleted=None)#

Get the posts of a beatmapset discussion.

Parameters:

  • beatmapset_discussion_id (int | None) – The beatmapset discussion to get the posts of.

  • limit (int | None) – Maximum number of posts to return.

  • page (int | None) – Pagination for results.

  • sort (BeatmapDiscussionPostSort | str | None) – How to sort the posts.

  • user_id (int | UserCompact | None) –

  • with_deleted (bool | None) – Whether to include deleted posts. Currently has no effect even if you are a gmt/admin.

Return type:

BeatmapsetDiscussionPosts

Notes

Implements the Get Beatmapset Discussion Posts endpoint.

beatmapset_discussion_votes(self, *, beatmapset_discussion_id=None, limit=None, page=None, receiver_id=None, vote=None, sort=None, user_id=None, with_deleted=None)#

Get beatmapset discussion votes.

Parameters:

  • beatmapset_discussion_id (int | None) – Filter by a beatmapset discussion.

  • limit (int | None) – Maximum number of votes to return.

  • page (int | None) – Pagination for results.

  • receiver_id (int | None) – Filter by the user receiving the votes.

  • vote (BeatmapsetDiscussionVote | int | None) – Specify to return either only upvotes or only downvotes.

  • sort (BeatmapsetDiscussionVoteSort | str | None) – How to sort the votes.

  • user_id (int | UserCompact | None) – Filter by the user giving the votes.

  • with_deleted (bool | None) – Whether to include deleted posts. Currently has no effect even if you are a gmt/admin.

Return type:

BeatmapsetDiscussionVotes

Notes

Implements the Get Beatmapset Discussion Posts endpoint.

beatmapset_discussions(self, *, beatmapset_id=None, beatmap_id=None, beatmapset_status=None, limit=None, message_types=None, only_unresolved=None, page=None, sort=None, user_id=None, with_deleted=None)#

Get beatmapset discussions.

Parameters:

  • beatmapset_id (int | BeatmapCompact | BeatmapsetCompact | None) – Filter by a beatmapset.

  • beatmap_id (int | BeatmapCompact | None) – Filter by a beatmap.

  • beatmapset_status (BeatmapsetStatus | str | None) – Filter by a category of beatmapsets.

  • limit (int | None) – Maximum number of discussions to return.

  • message_types (List[MessageType | str] | None) – Filter by a discussion message type.

  • only_unresolved (bool | None) – True to only show unresolved issues. Defaults to False.

  • page (int | None) – Pagination for results.

  • sort (BeatmapDiscussionPostSort | str | None) – How to sort the discussions.

  • user – Filter by poster id.

  • with_deleted (bool | None) – Whether to include deleted posts. Currently has no effect even if you are a gmt/admin.

  • user_id (int | UserCompact | None) –

Return type:

BeatmapsetDiscussions

Notes

Implements the Get Beatmapset Discussion Posts endpoint.

beatmapset_events(self, *, limit=None, page=None, user_id=None, types=None, min_date=None, max_date=None)#

Get beatmapset events. Equivalent to the events search page on the website (https://osu.ppy.sh/beatmapsets/events).

Parameters:

  • limit (int | None) – Maximum number of events to return.

  • page (int | None) – Pagination for events.

  • user_id (int | UserCompact | None) – Filter by event author.

  • types (List[BeatmapsetEventType | str] | None) – Filter by event type.

  • min_date (datetime | None) – Filter by event date.

  • max_date (datetime | None) – Filter by event date.

Return type:

ModdingHistoryEventsBundle

Notes

Implements the Beatmapset Events endpoint.

search_beatmapsets(self, query=None, *, mode=BeatmapsetSearchMode.ANY, category=BeatmapsetSearchCategory.HAS_LEADERBOARD, explicit_content=BeatmapsetSearchExplicitContent.HIDE, genre=BeatmapsetSearchGenre.ANY, language=BeatmapsetSearchLanguage.ANY, force_video=False, force_storyboard=False, force_recommended_difficulty=False, include_converts=False, force_followed_mappers=False, force_spotlights=False, force_featured_artists=False, cursor=None, sort=None)#

Search beatmapsets. Equivalent to the beatmapset search page on the website (https://osu.ppy.sh/beatmapsets).

Parameters:

  • query (str | None) – The search query. Can include filters like ranked<2019.

  • mode (BeatmapsetSearchMode | int) – Filter by mode.

  • category (BeatmapsetSearchCategory | str) – Filter by category.

  • explicit_content (BeatmapsetSearchExplicitContent | str) – Whether to include beatmaps with explicit content.

  • genre (BeatmapsetSearchGenre | int) – Filter by genre.

  • language (BeatmapsetSearchLanguage | str) – Filter by language.

  • force_video (bool) – True to only return beatmapsets with videos.

  • force_storyboard (bool) – True to only return beatmapsets with storyboards.

  • force_recommended_difficulty (bool) – True to filter by recommended difficulty.

  • include_converts (bool) – True to include converted beatmapsets.

  • force_followed_mappers (bool) – True to only return beatmapsets by mappers you follow.

  • force_spotlights (bool) – True to only return beatmapsets which have been in a spotlight.

  • force_featured_artists (bool) – True to only return beatmapsets by a featured artist.

  • cursor (Cursor | None) – Cursor for pagination.

  • sort (BeatmapsetSearchSort | str | None) – How to sort the beatmapsets.

Return type:

BeatmapsetSearchResult

Notes

Implements the Search Beatmapsets endpoint.