A python wrapper for the osu! api. Includes api v2 support.
Project description
ossapi
ossapi is a python wrapper for the osu! api. ossapi supports both api v2 and api v1. See API v2 Usage for api v2 documentation, or API v1 Usage for api v1 documentation.
To install ossapi for api v2, which is currently in beta:
pip install --pre ossapi
To upgrade ossapi for api v2:
pip install --pre -U ossapi
To install ossapi for api v1:
pip install ossapi
API v2 Usage
Note that api v2 requires python 3.8+.
Authenticating
The osu api provides two ways to authenticate, authorization code and client credentials. Authorization code grants full access to the api, but requires user interaction to authenticate the first time. Client credentials grants guest user access only, but authenticates automatically.
In either case you will need to create on oauth client on your settings page. Give it whatever name you want. However, your callback url *must* be a port on localhost. So http://localhost:3914/, http://localhost:727/, etc are all acceptable values. Make sure you're not taking a commonly used port.
Authorization Code
With the authorization code flow we will use the oauth client's id, secret, and redirect_uri (aka callback url) to authenticate. Copy these values from the oauth application you just created.
from ossapi import *
api = OssapiV2(client_id, client_secret, redirect_uri)
The first time you run this code, a page will open in your browser asking you to authenticate with osu! for your client. Once you do so, we cache the response, so you can use ossapi in the future without needing to re-authenticate.
As stated above, this flow grants full access to the api through your user.
Client Credentials
With the client credentials flow we will use the oauth client's id and secret to authenticate. Copy these values from the oauth application you just created.
from ossapi import *
api = OssapiV2(client_id, client_secret)
Unlike the authorization code flow, this authentication happens automatically and silently, and does not require user intervention. This is ideal for scripts which need to run without user interaction. As stated above however, this flow grants only guest user access to the api. This means you will not be able to use certain endpoints, like downloading replays.
Supported Endpoints
Here is a complete list of endpoints we currently have implemented. You can track our progress towards implementing all documented api v2 endpoints here: https://github.com/circleguard/ossapi/issues/14.
print(api.beatmapset_discussion_posts().discussions[0].message_type)
print(api.user_recent_activity(10690090)[0].created_at)
print(api.spotlights()[0].name)
print(api.user_beatmaps(user_id=12092800, type_="most_played")[0].count)
print(api.user_kudosu(user_id=3178418)[0].action)
print(api.beatmap_scores(beatmap_id=1981090).scores[0].id)
print(api.beatmap(beatmap_id=1981090).max_combo)
print(api.ranking("osu", RankingType.PERFORMANCE, country="US").ranking[0].user.username)
print(api.user_scores(12092800, "best")[0].accuracy)
print(api.beatmap(beatmap_id=221777).last_updated)
print(api.beatmap_user_score(beatmap_id=221777, user_id=2757689).score.mods)
print(api.search(query="peppy").user.data[0].profile_colour)
print(api.comment(comment_id=1).comments[0].message)
print(api.download_score(mode="osu", score_id=2797309065))
print(api.search_beatmaps(query="the big black").beatmapsets[0].title)
print(api.beatmapsets_events(types=[BeatmapsetEventType.ISSUE_REOPEN]).events[0].type)
print(api.user(12092800).playstyle)
print(api.wiki_page("en", "Welcome").available_locales)
print(api.changelog_build("stable40", "20210520.2").users)
print(api.changelog_listing().builds[0].display_version)
print(api.changelog_lookup("lazer").changelog_entries[0].github_pull_request_id)
print(api.forum_topic(141240).posts[0].forum_id)
print(api.beatmapset_discussion_votes().votes[0].score)
Note that although this code just prints a single attribute for each endpoint, you can obviously do more complicated things like iterate over arrays:
response = api.ranking("osu", RankingType.PERFORMANCE, country="US")
for ranking in response.ranking:
print(f"global #{ranking.global_rank}: {ranking.user.username}")
Pagination
Some endpoints are paginated, and so you may need a way to access the 3rd, 5th, or 25th page of the results. The way to do this is with the Cursor class.
For example, the /rankings/ endpoint is paginated. If we wanted to get the top 1-50 players, we don't need a cursor at all, since paginated endpoints return the first page by default:
r = api.ranking("osu", RankingType.PERFORMANCE)
print(r.ranking[-1].global_rank) # 50
Accessing the subsequent page of results immediately afterwards is such a common use case that all paginated endpoints return a cursor attribute which is already pre-prepared to retrive the next page. Just pass it to a new api call:
r = api.ranking("osu", RankingType.PERFORMANCE)
cursor = r.cursor
print(r.ranking[-1].global_rank) # 50
r = api.ranking("osu", RankingType.PERFORMANCE, cursor=cursor)
print(r.ranking[-1].global_rank) # 100
However, this doesn't work so well if you want to skip a bunch of pages and go straight to eg the 20th page. To do so, construct your own Cursor object and use that:
cursor = Cursor(page=20)
r = api.ranking("osu", RankingType.PERFORMANCE, cursor=cursor)
print(r.ranking[-1].global_rank) # 1000
If there are no more pages, the cursor object of the response will be None:
cursor = Cursor(page=199)
r = api.ranking("osu", RankingType.PERFORMANCE, cursor=cursor)
print(r.cursor) # Cursor(page=200)
cursor = Cursor(page=200) # there are only 200 rankings pages
r = api.ranking("osu", RankingType.PERFORMANCE, cursor=cursor)
print(r.cursor) # None
API v1 Usage
from ossapi import Ossapi
api = Ossapi("API_KEY")
json = api.get_replay({"m": "0", "b": "1776628", "u": "3256299"})
# either strings or ints will work. Returns something like
# `{"content":"XQAAIA....3fISw=","encoding":"base64"}`
Release history Release notifications | RSS feed
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
File details
Details for the file ossapi-2.0.0b10.tar.gz.
File metadata
- Download URL: ossapi-2.0.0b10.tar.gz
- Upload date:
- Size: 34.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 64cb5820e1fe0d0ea6c8f052cd0a1cd160b86863575afd5ddb728f29bed1fadb |
|
| MD5 | add7c3ffccd6380449d3d85ce3b82818 |
|
| BLAKE2b-256 | 92d59752b2a68bc5b3cd75db223e8133e8290454cb093e4c93612a23a20f5e45 |
File details
Details for the file ossapi-2.0.0b10-py3-none-any.whl.
File metadata
- Download URL: ossapi-2.0.0b10-py3-none-any.whl
- Upload date:
- Size: 35.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b520c27c05b8f307b65e60b5e40c87d86f5202d92d12a34634485115e4b4848 |
|
| MD5 | fec0227145fb3d485c9fc7266187c8d9 |
|
| BLAKE2b-256 | 9a105a596e88418284fd875937ca1be31deb9b53f044b07b475896e323d0e43a |
