ossapi 3.0.0

A python wrapper for the osu! api. Includes api v2 support.

ossapi (documentation)

ossapi is a python wrapper for the osu! api. ossapi supports both api v2 and api v1 and has every endpoint in both versions implemented.

To install:

pip install ossapi

To upgrade:

pip install -U ossapi

To get started, read the docs: https://circleguard.github.io/ossapi/.

If you need support or would like to contribute, feel free to join the circleguard discord: https://discord.gg/e84qxkQ.

Quickstart

The docs have an in depth quickstart, but here's a super short version:

from ossapi import Ossapi
# create a new client at https://osu.ppy.sh/home/account/edit#oauth
client_id = None
client_secret = None
callback_url = None # choose a port on localhost, eg http://localhost:727/

# client credentials authentication...
api = Ossapi(client_id, client_secret)

# ...or authorization grant authentication
api = Ossapi(client_id, client_secret, callback_url)

# go wild with endpoint calls! See docs for all endpoints
print(api.user("tybug2"))

API v1 Usage

You can get your api v1 key at https://osu.ppy.sh/p/api/. Note that due to a redirection bug, you may need to log in and wait 30 seconds before being able to access the api page through the above link.

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)