Use the API's createAsync instead of the default constructor if you don't have at least an access_token!
createAsync should always be your way of creating API instances!!
Optional client: { Optional token_type: stringOptional expires: DateOptional access_token: stringOptional scopes: Scope[]Optional refresh_token: stringOptional user: numberOptional refresh_Valid for an unknown amount of time, allows you to get a new token without going through the Authorization Code Grant! +
Optional client: { Optional token_type: stringOptional expires: DateOptional access_token: stringOptional scopes: Scope[]Optional refresh_token: stringOptional user: numberOptional refresh_Valid for an unknown amount of time, allows you to get a new token without going through the Authorization Code Grant!
Use the API's refreshToken function to do that
(default https://osu.ppy.sh) The base url of the server where the requests should land
(default https://osu.ppy.sh) The base url of the server where the requests should land
For tokens, requests will be sent to the oauth/token route, other requests will be sent to the api/v2 route
Should always be "Bearer"
-Optional userThe osu! user id of the user who went through the Authorization Code Grant
-(default none) Which events should be logged
Get extensive beatmap data about whichever beatmap you want!
+Should always be "Bearer"
+Optional userThe osu! user id of the user who went through the Authorization Code Grant
+(default none) Which events should be logged
Get extensive beatmap data about whichever beatmap you want!
An object with the id of the beatmap you're trying to get
-Get various data about the difficulty of a beatmap!
The Beatmap in question
Optional mods: number | string[] | Mod[]Defaults to No Mod, can be a bitset of mods, an array of mod acronyms ("DT" for DoubleTime), or an array of Mods
Optional ruleset: RulesetsDefaults to the Ruleset the Beatmap was made for, useful to specify if you want a convert
@@ -58,65 +59,93 @@Will ignore the customization of your mods
await api.getBeatmapDifficultyAttributes({id: 811925}, ["HR", "HD"])
Get data about a BeatmapPack using its tag!
An object with the tag of the beatmappack you're trying to get
Currently in https://osu.ppy.sh/beatmaps/packs, when hovering a pack, its link with its tag should show up on your browser's bottom left
-Get the score on a beatmap made by a specific user (with specific mods and on a specific ruleset if needed)
+Get the score on a beatmap made by a specific user (with specific mods and on a specific ruleset if needed)
The Beatmap the score was made on
The User who made the score
Optional mods: string[]The Mods used to make the score, defaults to any, you can use ["NM"] to filter out scores with mods
Optional ruleset: RulesetsThe Ruleset used to make the score, useful if it was made on a convert
An Object with the position of the score according to the specified Mods and Ruleset, and with the score itself
-Get the score on a beatmap made by a specific user (with the possibility to specify if the scores are on a convert)
+Get extensive beatmap data for up to 50 beatmaps at once!
+Get extensive beatmap data for up to 50 beatmaps at once!
Optional ids: number[]An array composed of the ids of the beatmaps you want
-Get extensive beatmapset data about whichever beatmapset you want!
-Optional options: { Optional build_Optional from?: stringOptional to?: stringGet user data of each friend of the authorized user
+Get extensive beatmapset data about whichever beatmapset you want!
+An object with the id of the beatmapset you're trying to get
+Get details about the version/update/build of something related to osu!
+The name of the thing related to osu!, like lazer, web, cuttingedge, beta40, stable40
The name of the version! Usually something like 2023.1026.0 for lazer, or 20230326 for stable
Get up to 21 versions/updates/builds!
+Optional versions: { Get builds that were released before/after (and including) those versions (use the name of the versions, e.g. 2023.1109.0)
Optional from?: stringOptional to?: stringOptional max_id: numberFilter out builds that have an id higher than this (this takes priority over versions.to)
Optional stream: stringOnly get builds from a specific stream
+Each element of changelog_entries will have a message property if markdown, message_html if html, defaults to both
An effective way to get all available streams, as well as their latest version!
+const names_of_streams = (await api.getChangelogStreams()).map(s => s.name)
+Get the scores on a specific item of a room
-public
-(2023-11-05) Is currently broken on osu!'s side, gotta love the API not being stable!
-Optional options: { Optional country?: numberOptional spotlight?: Spotlight | { Optional variant?: "4k" | "7k"Get extensive user data about the authorized user
+Get the scores on a specific item of a room, for a maximum of 50!
+(2023-11-10) Items are broken for multiplayer (real-time) rooms, not for playlists (like spotlights), that's an osu! bug +https://github.com/ppy/osu-web/issues/10725
+Get the top players of the game, with some filters!
+Self-explanatory, is also known as "Gamemode"
+charts is essentially for older spotlights, the rest should be obvious enough
(defaults to 1) Imagine Rankings as a page, it can only have a maximum of 50 players, while 50 others may be on the next one
What kind of players do you want to see? Defaults to all, friends has no effect if no authorized user
Optional country: stringOnly get players from a specific country, using its ISO 3166-1 alpha-2 country code! (France would be FR, United States US)
Optional spotlight: Spotlight | { If type is charts, you can specify the id of a spotlight! Defaults to the latest spotlight
Optional variant: "4k" | "7k"If type is performance and ruleset is mania, choose between 4k and 7k!
public (only if there's an authorized user) (the friends.read scope isn't needed to use the friends filter)
Get extensive user data about the authorized user
Optional ruleset: RulesetsDefaults to the user's default/favourite Ruleset
identify
-Get extensive user data about whoever you want!
+Get rooms that are active, that have ended, that the user participated in, that the user made, or just simply any room!
+Self-explanatory enough, defaults to active
public
+Get ALL legacy spotlights! (2009-2020, somewhat known as charts/ranking charts, available @ https://osu.ppy.sh/rankings/osu/charts)
+The data for newer spotlights (2020-, somewhat known as seasons) can be obtained through getRoom()
+but you can't really get their id without going through the website's URLs (https://osu.ppy.sh/seasons/latest) as far as I know :(
Get extensive user data about whoever you want!
Get data about the activity of a user kudosu-wise!
+Get data about the activity of a user kudosu-wise!
The user in question
Optional limit: numberThe maximum amount of activities in the returned array, defaults to 5
Optional offset: numberHow many elements that would be at the top of the returned array get skipped (while still filling the array up to the limit)
-Get "notable" scores from a user
+Get "notable" scores from a user
The user who set the scores
Do you want scores: in the user's top 100, that are top 1 on a beatmap, that have been recently set?
Optional limit: numberThe maximum amount of scores to be returned
Optional ruleset: RulesetsThe Ruleset the scores were made in, defaults to the user's default/favourite Ruleset
Do you want scores where the user didn't survive or quit the map? Defaults to false
Optional offset: numberHow many elements that would be at the top of the returned array get skipped (while still filling the array up to the limit)
-Get user data for up to 50 users at once!
+Private logPrivate logPrivate obtainPrivate requestPrivate obtainPrivate requestWhat comes in the URL after api/
Optional parameters: { The things to specify in the request, such as the beatmap_id when looking for a beatmap
How many attempts there's been to get the data
A Promise with either the API's response or false upon failing
Static createThe normal way to create an API instance! Make sure to await it
Static createThe normal way to create an API instance! Make sure to await it
The ID and the secret of your client, can be found on https://osu.ppy.sh/home/account/edit#new-oauth-application
Optional user: { If the instance is supposed to represent a user, use their Authorization Code and the Application Callback URL of your application!
A promise with an API instance
-Generated using TypeDoc
Generated using TypeDoc
You can create an API instance using its
-createAsyncfunction!