Skip to content

Jackenmen/rlapi

Repository files navigation

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 [email protected] 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