Skip to main content

Python wrapper for the Osu apiv2.

Project description

Losuapi

Python wrapper for the Osu apiV2

Important

Development in progress


Setup

  • Register an Oauth application on the osu account settings page.
    • Do not set an Application callback URL, the current version of this package does not need one.

creating client_id and client_secret variables example

CLIENT_ID = "registerd client id"
CLIENT_SECRET = "registered client secret"

Basic usage

example:

import losuapi

# instantiate OsuApi object
api: losuapi.OsuApi = losuapi.OsuApi(client_id=CLIENT_ID, cleint_secret=CLIENT_SECRET)

# lookup_beatmap method returns a losuapi.Beatmap object
beatmap: losuapi.Beatmap = api.lookup_beatmap(beatmap_id=1920615)

Working endpoints

from losuapi import OsuApi

OsuApi.lookup_beatmap(beatmap_id, checksum, filename)
OsuApi.user_beatmap_score(beatmap_id, user_id, mode, mods)
OsuApi.user_beatmap_scores(beatmap_id, user_id, mode)
OsuApi.beatmap_scores(beatmap_id, mode, mods, type)
OsuApi.beatmaps(beatmap_ids)
OsuApi.beatmap(beatmap_id)
OsuApi.beatmap_attributes(beatmap_id, mods ruleset, ruleset_id)
OsuApi.user_kudosu(user_id, limit, offset)
OsuApi.user_scores(user_id, type, include_fails, mode, limit, offset)
OsuApi.user(username, mode, key)
OsuApi.ranking(mode, type, filter, country, cursor, spotlight_id, variant)

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

losuapi-0.0.4.tar.gz (22.3 kB view details)

Uploaded Source

File details

Details for the file losuapi-0.0.4.tar.gz.

File metadata

  • Download URL: losuapi-0.0.4.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for losuapi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 bf2c9ea65357fca2bdad86ebbb83433bdf86e117927272fc4d8b47abe85f71a4
MD5 4c76159e5b1e07ec67071b1593813f0e
BLAKE2b-256 b1dd4f8782a52afc9865a79f28257f849da1a17a9385a72247030fa8d4f56620

See more details on using hashes here.

Supported by

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