-
Notifications
You must be signed in to change notification settings - Fork 2
API Reference
kekda.py edited this page Jan 24, 2022
·
8 revisions
The following section outlines the API of brawlpy.
brawlpy.__version__
A string representation of the version.
class brawlpy.Client(token : str)
| Methods | What they do |
|---|---|
| async get_player | Get information about a single player by player tag. |
| async get_battle_log | Get list of recent battle results for a player. |
| async get_club | Get information about a single club by club tag. |
| async get_club_members | Get a list of club members. |
| async brawlers | Get list of available brawlers. |
| async get_brawler_byID | Get information about a brawler by giving its ID. |
| async get_brawler_byName | Get information about a brawler by giving its Name. |
| async events | Get event rotation for ongoing events. |
| async get_players_rankings | Get player rankings for a country or global rankings. |
| async get_brawlers_rankings | Get brawler rankings for a country or global rankings. |
| async get_club_rankings | Get club rankings for a country or global rankings. |
Represents a client connection that connects to the Brawl Stars API.
Parameters:
- token (str) - The API Key that you from https://developer.brawlstars.com
Get information about a single player by player tag. Player tags can be found either in game or by from clan member list.
Raises:
- TagNotFoundError - Raised if you entered a invalid tag.
Parameters:
- tag (str) - The tag of the player, that you wanna get the information off
Returns:
The Information about the player of the tag u entered
Return Type:
Player