Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

Metadata

Release files for rlapi 0.8.0b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rlapi 0.8.0b1
File Size Uploaded
rlapi-0.8.0b1.tar.gz 30.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rlapi 0.8.0b1
File Interpreter ABI Platform
rlapi-0.8.0b1-py3-none-any.whl Python 3 none any Details

Total release size: 66.8 kB

Release files / rlapi-0.8.0b1.tar.gz

Download URL rlapi-0.8.0b1.tar.gz
Size 30.8 kB
Tags Source
SHA-256 checksum
How to use checksums
deb228a291fa44624a326525f10ebfa18fcff0e3618d4760281732aa17a47188
BLAKE2b-256 checksum
How to use checksums
98998a78811865694c45acf6a0ac5213cfdd34f93ff36392d359a6d315a86303
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.18

Release files / rlapi-0.8.0b1-py3-none-any.whl

Download URL rlapi-0.8.0b1-py3-none-any.whl
Size 36.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2293049d5da2b8400ee3f2c37637a33b68f0e15a7a27f6fb719ba64ccfb22e1a
BLAKE2b-256 checksum
How to use checksums
0670e16f9a59204b2f0d9ef5900d6276aa4ab52026c8a7e7169a252f167c1e33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page