Skip to main content

Unofficial Python wrapper for the Brawl Stars API.

Project description

NovaBrawlStarsApi

A Python library to easily interact with the Brawl Stars API and fetch player information.

Features

  • Retrieve detailed player information
  • Supports multiple player tags
  • Easy Python integration
  • Secure API key management with .env

Installation

You can install NovaBrawlStarsApi via pip:

pip install novabrawlstars

Or clone the repo and installation dependencies manually:

git clone https://github.com/NovaFenice/NovaBrawlStarsApi.git
cd NovaBrawlStarsApi

Usage

How to get players info

from novabrawlstars.client import NovaBrawlStars
import os
import asyncio
from dotenv import load_dotenv

load_dotenv()

async def main():
    api_bs = os.getenv("api_bs") # Your Brawl Stars API token
    tag_p1 = os.getenv("tag_p1") # Brawl Stars Player tag (es. #12345678 or 12345678)
    nb = NovaBrawlStars(api_bs) # Initialize the Brawl Stars API client
    
    async with nb as client:
        player = await client.get_player(tag_p1)  # Get a Player object from the API

    await nb.close() # Close the HTTP client session

if __name__ == "__main__":
    asyncio.run(main()) # Run the main function

How to get battlelog info

from novabrawlstars.client import NovaBrawlStars
import os
import asyncio
from dotenv import load_dotenv

load_dotenv()

async def main():
    api_bs = os.getenv("api_bs") # Your Brawl Stars API token
    tag_p1 = os.getenv("tag_p1") # Brawl Stars Player tag (es. #12345678 or 12345678)
    nb = NovaBrawlStars(api_bs) # Initialize the Brawl Stars API client
    
    async with nb as client:
        player_battlelog = await client.get_battlelog(tag_p1)  # Get a BattleLogListType object from the API

    await nb.close() # Close the HTTP client session

if __name__ == "__main__":
    asyncio.run(main()) # Run the main function

How to get club info

from novabrawlstars.client import NovaBrawlStars
import os
import asyncio
from dotenv import load_dotenv

load_dotenv()

async def main():
    api_bs = os.getenv("api_bs") # Your Brawl Stars API token
    tag_p1 = os.getenv("tag_p1") # Brawl Stars Player tag (es. #12345678 or 12345678)
    nb = NovaBrawlStars(api_bs) # Initialize the Brawl Stars API client
    
    async with nb as client:
        player = await client.get_player(tag_p1)  # Get a BattleLogListType object from the API
        club = await client.get_player_club(player.club.tag) # Get a Club object passing the player 

    await nb.close() # Close the HTTP client session

if __name__ == "__main__":
    asyncio.run(main()) # Run the main function

Notes

  • Make sure to replace the player tags and API token.
  • Supports both numeric and #-prefixed tags.

Donate Me 💖

If you like this project and want to support its development, you can donate:

Every contribution helps me maintain and improve the library! Thank you for your support! 🙏

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

novabrawlstars-0.1.6.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

novabrawlstars-0.1.6-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file novabrawlstars-0.1.6.tar.gz.

File metadata

  • Download URL: novabrawlstars-0.1.6.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for novabrawlstars-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d3a151cea3415de71685ff3d60b2490fdd19d3b811dfe908fff8aa9b31b1f16c
MD5 3574e8e28fb7711c5bfb8ea36909ec01
BLAKE2b-256 ecd6acc4b2006bb2af4f9fffd52572b627e160f5318d6a85cf899314cda086b0

See more details on using hashes here.

File details

Details for the file novabrawlstars-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: novabrawlstars-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for novabrawlstars-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 449ce373348c62797ae58a77906006a80b6908d778be1a0775c9d1a4b9750a61
MD5 ce46ab5793fddc858a8379544c15d9e6
BLAKE2b-256 2ea9a56ccbcd294ac96074c128e879888096a8d076d4364256ba559e579fdb2e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page