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.

Subscribe on Patreon Build Status 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 keys easily.

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

Installation

Python 3.7 or higher is required

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

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

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

To install the development version, replace rlapi with git+https://github.com/jack1142/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


loop = asyncio.get_event_loop()

client = rlapi.Client("token")
players = loop.run_until_complete(client.get_player("kuxir97", None))

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 @jack1142

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rlapi, version 0.4.1a1
Filename, size File type Python version Upload date Hashes
Filename, size rlapi-0.4.1a1-py3-none-any.whl (22.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size rlapi-0.4.1a1.tar.gz (16.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page