Orbit (API)

Overview

Orbit API is designed to make accessing osu! stats easy, with support for both versions of the API (v1 and v2)

Getting Started

Want to give this a try? Check out the getting started guide

API Contents

OAuth

• OAuth session requests (autorization_code, refresh_token and client_credential)

User

• Identifying user info (/me)
• Identifying user's friend list
• User info & mode stats (by name or id)
• User kudosu
• User recent activity (modding, kudosu, scores, failed plays)
• User highest scores
• User's beatmaps (filtered by ranked status)

Leaderboards

• Spotlights listing (+ leaderboards)
• Common Leaderboards (Country, Score, Performance, Spotlights)

Beatmaps & Beatmapsets

• Beatmapset search
• Beatmapset modding events
• Beatmap lookup (by id, filename, md5)
• Beatmap info
• Beatmap scores

Info

• Changelogs
• News
• Comments

Legacy (API v1)

• User Info (by name or id)
• Beatmap(set) info
• User's highscores and recent plays (+ failed ones)
• Multiplayer lobby scores and participants

Testing

Because the osu!api requires keys, these are likely to be run locally by reviewers. You can refer to the test project and its structure for how tests are performed. Basic rules are:

1. Tests are filed under the major category (the first folder in the main project)
2. Access to the client can be gained through inheriting OrbitApiTest
3. The test allows for multiple cases to be defined, and tests all possibilities
4. Just because there are lots of tests, doesn't mean they all need to be run. Exercise proper judgement as to not unnecessarily overload the osu! infrastructure.