Welcome to BrawlhallaPy’s documentation!

This is the homepage for the documentation for BrawlhallaPy, an asynchronous Python wrapper for the Brawlhalla API.

Requirements

Quick Start

First, we have to create an asynchronous context to create requests with, the most common way is by using the asyncio event loop like so:

import asyncio

async def main():
    pass

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Then, we need to import the necessary classes with from brawlhalla import BrawlhallaClient. After that, we can initialize our client with client = new BrawlhallaClient("API_KEY_HERE"). Now we are ready to make requests.

Let’s get a player’s ranked stats with get_player_ranked_stats().

import asyncio
from brawlhalla import BrawlhallaClient

async def main():
    client = BrawlhallaClient("API_KEY_HERE")

    player = await client.get_player_ranked_stats(1297647)
    print(player.name)  # ߷w߷e߷e߷b߷u߷


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

All of the BrawlhallaClient‘s methods return a API.Response object, whose attributes directly corrospond to the response returned by the Brawlhalla API.

For more information, read the documentation on the BrawlhallaClient.