ossapi (documentation) 
ossapi is the definitive python wrapper for the osu! api. ossapi has complete coverage of api v2 and api v1, and provides both sync (Ossapi) and async (OssapiAsync) versions for api v2.
If you need support or would like to contribute, feel free to ask in the #ossapi channel of the circleguard discord.
Installation
To install:
pip install ossapi
# or, if you want to use OssapiAsync:
pip install ossapi[async]
To upgrade:
pip install -U ossapi
To get started, read the docs: https://liam-devoe.github.io/ossapi/.
Quickstart
The docs have an in depth quickstart, but here's a super short version for api v2:
from ossapi import Ossapi
# create a new client at https://osu.ppy.sh/home/account/edit#oauth
api = Ossapi(client_id, client_secret)
# see docs for full list of endpoints
print(api.user("tybug").username)
print(api.user(12092800, mode="osu").username)
print(api.beatmap(221777).id)
Async
ossapi provides an async variant, OssapiAsync, which has an identical interface to Ossapi:
import asyncio
from ossapi import OssapiAsync
api = OssapiAsync(client_id, client_secret)
async def main():
await api.user("tybug")
asyncio.run(main())
Read more about OssapiAsync on the docs.
Other domains
You can use ossapi to interact with the api of other deployments of the osu website, such as https://dev.ppy.sh.
from ossapi import Ossapi
api = Ossapi(client_id, client_secret, domain="dev")
# get the dev server pp leaderboards
ranking = api.ranking("osu", "performance").ranking
# pearline06, as of 2023
print(ranking[0].user.username)
Read more about domains on the docs.
Endpoints
All endpoints for api v2.
- Beatmap Packs
- Beatmaps
- Beatmapsets
- Changelog
- Chat
- Comments
- Events
- Forums
- Friends
- Home
- Matches
- Me
- News
- OAuth
- Rankings
- Rooms
- Scores
- Seasonal Backgrounds
- Spotlights
- Users
- Wiki
API v1 Usage
You can get your api v1 key at https://osu.ppy.sh/home/account/edit#legacy-api.
Basic usage:
from ossapi import OssapiV1
api = OssapiV1("key")
print(api.get_beatmaps(user=53378)[0].submit_date)
print(api.get_match(69063884).games[0].game_id)
print(api.get_scores(221777)[0].username)
print(len(api.get_replay(beatmap_id=221777, user=6974470)))
print(api.get_user(12092800).playcount)
print(api.get_user_best(12092800)[0].pp)
print(api.get_user_recent(12092800)[0].beatmap_id)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ossapi-5.3.6.tar.gz.
File metadata
- Download URL: ossapi-5.3.6.tar.gz
- Upload date:
- Size: 99.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45b649b30eb7b8b251cd0ac49c32e0677304b5299dd639462765003c09ed3972
|
|
| MD5 |
1cb2629728ee5abd9f4ebe2ef63ad0aa
|
|
| BLAKE2b-256 |
f6766ffc98a742882d402deaa1fb2fed14fa6827435d570c47f8e34bf838dd13
|
File details
Details for the file ossapi-5.3.6-py3-none-any.whl.
File metadata
- Download URL: ossapi-5.3.6-py3-none-any.whl
- Upload date:
- Size: 96.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
69fbadacf0c857e87e3da54cfdf1d837ab3793eca8a4c12d407d2af020516369
|
|
| MD5 |
c3b776b5af433c52660969cedfc87cb9
|
|
| BLAKE2b-256 |
7e9cd36da0e359c1cc62a5416fb5db543ebd45e9da308aa914664e4c78dcfad8
|
