Skip to main content

Async ready API wrapper for Rocket League API

Project description

rlapi

Async ready API wrapper for Rocket League API written in Python.

Sponsor on GitHub Documentation Status Code style: black License: Apache-2.0 PRs Welcome

Rocket League API is currently in closed beta and Psyonix doesn't give out access to it easily.

To request API access, you should contact Psyonix by email RLPublicAPI@psyonix.com and hope for positive response.

Installation

Python 3.8 or higher is required

To install the library, you can just run the following command:

# Linux/OS X
python3.8 -m pip install -U rlapi

# Windows
py -3.8 -m pip install -U rlapi

To install the development version, replace rlapi with git+https://github.com/Jackenmen/rlapi

Usage example

You can easily create a client using the class Client. Here's simple example showing how you can get player stats with this library:

import asyncio

import rlapi


async def main():
    client = rlapi.Client(client_id="client id", client_secret="client secret")
    players = await client.get_player("kuxir97", None)


asyncio.run(main())

Documentation

Read rlapi's documentation.

Contributing

Please take a look at our contributing guidelines if you're interested in helping!

License

Distributed under the Apache License 2.0. See LICENSE for more information.

This project bundles lxml-stubs which are distributed on Apache License 2.0

Contributing guidelines and issue templates are taken from discord.py project


Jakub Kuczys  ·  GitHub @Jackenmen

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

rlapi-0.7.0a1.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

rlapi-0.7.0a1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file rlapi-0.7.0a1.tar.gz.

File metadata

  • Download URL: rlapi-0.7.0a1.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for rlapi-0.7.0a1.tar.gz
Algorithm Hash digest
SHA256 f187e3148e50d07faa39954873b456c30dd3ed97aa99edbaaa3276416e901ff2
MD5 8f96a597d0d6ad1da33ac42717c4e7d8
BLAKE2b-256 45313a9c9d77753db802436f66439806736e3398456f827b3a59833bb6ee1a55

See more details on using hashes here.

File details

Details for the file rlapi-0.7.0a1-py3-none-any.whl.

File metadata

  • Download URL: rlapi-0.7.0a1-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for rlapi-0.7.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 44b46e383e6e5a3a35e9f1069e6b56e818137a3250872e7492e6bf094b86a614
MD5 f5f2d4c598eb84625e7a97c755f8dc2f
BLAKE2b-256 5f9e7c8da0fb8f0f5ad4757573466e752833a8750b022d7719bcbc3b0e376651

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