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.8.0b1.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

rlapi-0.8.0b1-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

Details for the file rlapi-0.8.0b1.tar.gz.

File metadata

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

File hashes

Hashes for rlapi-0.8.0b1.tar.gz
Algorithm Hash digest
SHA256 deb228a291fa44624a326525f10ebfa18fcff0e3618d4760281732aa17a47188
MD5 b00d0aae19f42a3e215615a0f93b024c
BLAKE2b-256 98998a78811865694c45acf6a0ac5213cfdd34f93ff36392d359a6d315a86303

See more details on using hashes here.

File details

Details for the file rlapi-0.8.0b1-py3-none-any.whl.

File metadata

  • Download URL: rlapi-0.8.0b1-py3-none-any.whl
  • Upload date:
  • Size: 36.1 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.8.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 2293049d5da2b8400ee3f2c37637a33b68f0e15a7a27f6fb719ba64ccfb22e1a
MD5 74b205961f86a871176b8601eb5094cc
BLAKE2b-256 0670e16f9a59204b2f0d9ef5900d6276aa4ab52026c8a7e7169a252f167c1e33

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