The big change in this release is to account for the migration from old score ids (https://osu.ppy.sh/scores/osu/3772000814) to new score ids (https://osu.ppy.sh/scores/1312718771). The former requires the gamemode while the latter does not. Endpoints which previously took both a gamemode and a score id have been changed to take just a score id (new format), while the previous endpoint behavior was kept under a different method name.
Breaking changes
- rename
api.score
toapi.score_mode
- add a new
api.score
method which takes the new score id format - rename
api.download_score
toapi.download_score_mode
- rename
BeatmapScores.userScore
toBeatmapScores.user_score
- add a new
api.download_score
method which takes the new score id format - rename
before
andafter
parameters ofapi.match
tobefore_id
andafter_id
, to better reflect that the api filters by id and not something like time - remove
Domain.LAZER
- lazer.ppy.sh was decommissioned in the past few months, so this parameter has no effect and in fact causes errors. Lazer data is now live on the main site and you do not need to pass a
Domain
to access it
- lazer.ppy.sh was decommissioned in the past few months, so this parameter has no effect and in fact causes errors. Lazer data is now live on the main site and you do not need to pass a
Migration guide
- change any
api.score
calls toapi.score_mode
(and consider migrating to the newapi.score
, to use the new score ids without gamemodes) - change any
api.download_score
calls toapi.download_score_mode
(and consider migrating to the newapi.download_score
, for the same reason) - rename any
api.match(before=..., after=...)
calls toapi.match(before_id=..., after_id=...)
Non-breaking changes
- add
legacy_only
parameter to applicable endpoints - make
Statistics
counts optional - correctly type
cursor_string
as optional