Get beatmap attributes

The beatmaps.getBeatmapAttributes method on a Client instance makes a POST request to the beatmaps/{beatmap}/attributes endpoint and returns a beatmap’s attributes.

Example

const scores = await api.beatmaps.getBeatmapAttributes(1816113, 'fruits');

Parameters

ParameterTypeOptionalDescription
beatmapnumberID of the beatmap to get its attributes
gamemodeGamemodeGamemode attributes to get
optionsGetBeatmapAttributesOptions

options.body

ParameterTypeOptionalDescription
modsnumberMod[]Mods to apply (can be either the bitwise representation or an array of acronyms)

Returns

If gamemode is set to osu:

Promise<OsuBeatmapDifficultyAttributes>;

Types

If gamemode is set to taiko:

Promise<TaikoBeatmapDifficultyAttributes>;

Types

If gamemode is set to fruits:

Promise<FruitsBeatmapDifficultyAttributes>;

Types

If gamemode is set to mania:

Promise<ManiaBeatmapDifficultyAttributes>;

Types

Possible Exceptions

See the error handling documentation for more information.

  • invalid_json_syntax
  • network_error
  • unexpected_response

Notice that something is missing? Found a typo? Think something's incomplete? Or think that something can be explained better? Feel free to open a pull request or submit an issue on the library's Github repository .