Skip to main content

An easy-to-use wrapper for the unofficial Brawl Stars API

Project description

Brawl Stats

Brawl Stats

PyPi Travis-CI build Supported Versions MIT License
  • This library is a sync and async wrapper for https://api.starlist.pro (BrawlAPI) and the official Brawl Stars API.

  • Python 3.5.3 or later is required.

Features

  • Covers all of the endpoints of both APIs.

  • Use the same client for sync and async usage.

  • Choose which API you want to use!

  • Access game constants such as maps, brawlers, and images.

  • Easy to use with an object oriented design.

Installation

Install the latest stable build:

pip install brawlstats

Install the development build:

pip install git+https://github.com/SharpBit/brawlstats

Documentation

Documentation is being hosted on Read the Docs.

Examples

Examples are in the examples folder. Within each folder, you will find:

  • sync.py shows you basic sync usage

  • async.py shows you basic async usage

  • discord_cog.py shows an example Discord Bot cog using discord.py

Misc

  • If you are currently using this wrapper, please star this repository :)

  • If you come across an issue in the wrapper, please create an issue. Do not PM me on Discord for help.

  • If you need an API Key for BrawlAPI, create one using the dashboard. If you need one for the official API, visit https://developer.brawlstars.com

  • To receive help for using the BrawlAPI, I recommend you join BrawlAPI’s discord server.

Contributing

Special thanks to this project’s contributors ❤️

If you want to contribute, whether it be a bug fix or new feature, make sure to follow the contributing guidelines.

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

brawlstats-3.0.2.tar.gz (327.3 kB view details)

Uploaded Source

File details

Details for the file brawlstats-3.0.2.tar.gz.

File metadata

  • Download URL: brawlstats-3.0.2.tar.gz
  • Upload date:
  • Size: 327.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for brawlstats-3.0.2.tar.gz
Algorithm Hash digest
SHA256 c92ef332de1e763eb4c768856a651f938fc6fc60983818c94cd2a62b100cd4c5
MD5 5a9fb4cafd61557c9f22d4280f231371
BLAKE2b-256 7aa0d2c92093d1074b8f0c0111d53f2b413d73f0dbaa90b62b3e5cb8e9c06fd7

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