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
-Private getGet various data about the difficulty of a beatmap!
+Get various data about the difficulty of a beatmap!
Will ignore the customization of your mods
-Get various data about the difficulty of a beatmap!
+Optional mods: number | string[] | Mod[](defaults to No Mod) (will ignore mod settings) Can be a bitset of mods, an array of mod acronyms ("DT" for DoubleTime), or an array of Mods
+Optional ruleset: Rulesets(defaults to the ruleset the beatmap was intended for) Useful to specify if the beatmap is a convert
+You may want to use getBeatmapDifficultyAttributesOsu (or Taiko or whatever) instead for better type safety
+Get various data about the difficulty of a ctb beatmap!
Will ignore the customization of your mods
-Get various data about the difficulty of a beatmap!
+Optional mods: number | string[] | Mod[](defaults to No Mod) (will ignore mod settings) Can be a bitset of mods, an array of mod acronyms ("DT" for DoubleTime), or an array of Mods
+Get various data about the difficulty of a mania beatmap!
Will ignore the customization of your mods
-Get various data about the difficulty of a beatmap!
+Optional mods: number | string[] | Mod[](defaults to No Mod) (will ignore mod settings) Can be a bitset of mods, an array of mod acronyms ("DT" for DoubleTime), or an array of Mods
+Get various data about the difficulty of an osu! beatmap!
Will ignore the customization of your mods
-Get data about a BeatmapPack using its tag!
+Optional mods: number | string[] | Mod[](defaults to No Mod) (will ignore mod settings) Can be a bitset of mods, an array of mod acronyms ("DT" for DoubleTime), or an array of Mods
+Get various data about the difficulty of a taiko beatmap!
+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 an Array of up to 100 BeatmapPacks of a specific type!
-The type of the BeatmapPacks, defaults to "standard"
-Get the top scores of a beatmap!
+Get an Array of up to 100 BeatmapPacks of a specific type!
+The type of the BeatmapPacks, defaults to "standard"
+Get the top scores of a beatmap!
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!
+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!
+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!
+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!
+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 top countries of a specific ruleset!
+Get the top countries of a specific ruleset!
On which Ruleset should the countries be compared?
(defaults to 1) Imagine Rankings as a page, it can only have a maximum of 50 countries, while 50 others may be on the next one
Get user data of each friend of the authorized user
+Get user data of each friend of the authorized user
friends.read
-Get the top 50 players who have the most total kudosu!
-Get data of a multiplayer lobby from the stable (non-lazer) client that have URLs with community/matches or mp
Get the top 50 players who have the most total kudosu!
+Get the scores on a specific item of a room!
+Get the scores on a specific item of a room!
An object with the id of the item in question, as well as the id of the room
How many scores maximum? Defaults to 50, the maximum the API will return
Sort by scores, ascending or descending? Defaults to descending
Optional cursor_string: stringUse a MultiplayerScores' params and cursor_string to get the next page (scores 51 to 100 for example)
(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!
+Get the top players of the game, with some filters!
Self-explanatory, is also known as "Gamemode"
Rank players by their performance points or by their ranked score?
(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 variant: "4k" | "7k"If type is performance and ruleset is mania, choose between 4k and 7k!
Get extensive user data about the authorized user
+Get extensive user data about the authorized user
Optional ruleset: RulesetsDefaults to the user's default/favourite Ruleset
identify
-Get data about a lazer multiplayer room (realtime or playlists)!
+Get the room stats of all the users of that room!
+Get rooms that are active, that have ended, that the user participated in, that the user made, or just simply any room!
+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 the rankings of a spotlight from 2009 to 2020 on a specific ruleset!
+Get the rankings of a spotlight from 2009 to 2020 on a specific ruleset!
Get ALL legacy spotlights! (2009-2020, somewhat known as charts/ranking charts, available @ https://osu.ppy.sh/rankings/osu/charts)
+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 extensive user data about whoever you want!
Get data about the activity of a user kudosu-wise!
+Get beatmaps favourited or made by a user!
+The user in question
+The relation between the user and the beatmaps
+(defaults to 5) The maximum amount of elements returned in the array
+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 data about the activity of a user kudosu-wise!
+The user in question
+Optional limit: number(defaults to 5) The maximum amount of activities in the returned array
+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 the beatmaps most played by a user!
+The user who played the beatmaps
+(defaults to 5) The maximum amount of elements returned in the array
+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 an array of Events of different types that relate to a user's activity during the last 31 days! (or 100 activities, whatever comes first)
The user in question
-Optional limit: numberThe maximum amount of activities in the returned array, defaults to 5
+(defaults to 5) The maximum amount of elements returned in the array
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
+(defaults to false) Do you want scores where the user didn't survive or quit the map?
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!
+Get user data for up to 50 users at once!
An array composed of the ids of the users you want
-Private logGet a wiki page!
+What's in the page's URL after https://osu.ppy.sh/wiki/ (so the title, after the subtitle if there is a subtitle)
+(An example for https://osu.ppy.sh/wiki/en/Game_mode/osu! would be Game_mode/osu!)
(defaults to "en") The BCP 47 language (sub)tag, lowercase (for example, for the article in french, use "fr")
+Private 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
Look for a user like you would on the website!
+What you would put in the searchbar
+(defaults to 1) You normally get the first 20 results, but if page is 2, you'd get results 21 to 40 instead for example!
+Look for a wiki page like you would on the website!
+What you would put in the searchbar
+(defaults to 1) You normally get the first 50 results, but if page is 2, you'd get results 51 to 100 instead for example!
+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!