https://github.com/nickoehler/brawlhalla_api
An unofficial brawlhalla api implementation
https://github.com/nickoehler/brawlhalla_api
api api-wrapper async brawlhalla brawlhalla-api httpx python python3
Last synced: 3 months ago
JSON representation
An unofficial brawlhalla api implementation
- Host: GitHub
- URL: https://github.com/nickoehler/brawlhalla_api
- Owner: NicKoehler
- License: mit
- Created: 2023-03-17T18:50:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T20:56:35.000Z (about 2 years ago)
- Last Synced: 2023-04-13T22:51:38.035Z (about 2 years ago)
- Topics: api, api-wrapper, async, brawlhalla, brawlhalla-api, httpx, python, python3
- Language: Python
- Homepage:
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
· Brawlhalla API
_An unofficial brawlhalla api implementation_
## Table of contents
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Authentication](#authentication)
- [Examples](#examples)
- [License](#license)
- [Contributions](#contributions)
## Introduction
This library provides an easy-to-use interface to interact with the Brawlhalla API. Users can retrieve information such as player rankings, player statistics, and more. The library also supports asynchronous requests, making it efficient to handle multiple requests simultaneously.
## Installation
To install the Brawlhalla API library, use pip:
```bash
pip install git+https://github.com/nickoehler/brawlhalla_api
```
## Usage
### Authentication
To use the Brawlhalla API, you need to provide an API key.
Send an email to [email protected] with a detailed description of how you intend to use the service.
### Examples
```python
import asyncio
from brawlhalla_api import Brawlhalla
API_KEY = "..." # use your api key
async def main():
brawl = Brawlhalla(API_KEY)
players = await brawl.get_rankings()
# printing every player
for player in players:
print(player.name)
# get stats of the first player
stats = await players[0].get_stats()
ranked = await players[0].get_ranked()
asyncio.run(main())
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Contributions
Contributions to this project are welcome. To contribute, follow these steps:
1. Fork the repository
2. Create a new branch for your changes
3. Make your changes and commit them with clear commit messages
4. Push your changes to your forked repository
5. Submit a pull request
> Before making any significant changes, please open an issue to discuss the changes you plan to make.