Skip to main content

Complete python wrapper for osu! api v2 and v1.

Project description

ossapi (documentation) PyPI version

ossapi is a python wrapper for the osu! api which has complete coverage of both api v2 and api v1. ossapi 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://circleguard.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("tybug2").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 Ossapi

api = Ossapi(client_id, client_secret)

async def main():
    await api.user("tybug2")

asyncio.run(main())

Read more about OssapiAsync on the docs.

Endpoints

All endpoints for api v2.

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ossapi-3.1.6.tar.gz (86.9 kB view details)

Uploaded Source

Built Distribution

ossapi-3.1.6-py3-none-any.whl (83.2 kB view details)

Uploaded Python 3

File details

Details for the file ossapi-3.1.6.tar.gz.

File metadata

  • Download URL: ossapi-3.1.6.tar.gz
  • Upload date:
  • Size: 86.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.10

File hashes

Hashes for ossapi-3.1.6.tar.gz
Algorithm Hash digest
SHA256 c32ce887b0fd08c231b3243e44ba440caf4182d5a9ff48f4a3d932c0747fae51
MD5 64447364965b48bf42718deb61ffd0da
BLAKE2b-256 63c9f0f625d546a9acbdb618bbd412620794f74e864c8903c532505b8515d190

See more details on using hashes here.

File details

Details for the file ossapi-3.1.6-py3-none-any.whl.

File metadata

  • Download URL: ossapi-3.1.6-py3-none-any.whl
  • Upload date:
  • Size: 83.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.10

File hashes

Hashes for ossapi-3.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2777ce57dbe3cd8f6628d7e4b4c69e434b1ffbaf4867e8bdddf2f2de929aacd4
MD5 cfec66f9c30d4973da3675883ffb41fa
BLAKE2b-256 3227f045097c823f171283c72fadb3d28275b45e6e1c43fa38b9154e526a26c6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page