brawl-stars-node
v2.0.0
Published
API wrapper for the official Brawl Stars API.
Maintainers
Readme
🚀 Introduction
brawl-stars-node provides an easy and efficient way to interact with the official Brawl Stars API.
It simplifies authentication, handles rate limits, and caches responses — so you can focus on building features, not managing requests.
⚠️ Not affiliated with or endorsed by Supercell.
Author: Philippe Smeets
📦 Installation
npm install brawl-stars-nodeIf you’re using TypeScript:
npm install --save-dev typescript📚 Documentation & Links
💡 Example Usage
import { BrawlStarsClient } from 'brawl-stars-node';
const client = new BrawlStarsClient('YOUR-TOKEN-HERE');
async function main() {
const player = await client.players.get('PLAYER-TAG-HERE');
console.log(`${player.name} (${player.tag})`);
}
main();⚙️ Features
- ✅ Simple authentication
- ✅ Fully written in TypeScript
- ✅ Built-in caching system
- ✅ Automatic rate limiting (5 requests/sec)
- ✅ Structured response types
- ✅ Easy-to-use endpoint access (Players, Clubs, Rankings, Events, etc.)
- ✅ Tested with Jest + integrated CI/CD
🧩 API Overview
| Category | Method | Description |
| ------------ | -------------------------------------------- | ----------------------------------- |
| Players | get(tag) | Fetch player data |
| Players | getBattlelog(tag) | Fetch player’s recent battles |
| Clubs | get(tag) | Fetch club information |
| Clubs | getMembers(tag) | Fetch club member list |
| Rankings | getPlayerRankings(countryCode) | Get player leaderboard |
| Rankings | getClubRankings(countryCode) | Get club leaderboard |
| Rankings | getBrawlerRankings(countryCode, brawlerId) | Get rankings for a specific brawler |
| Brawlers | getAll() | Get all brawlers |
| Brawlers | getById(brawlerId) | Get specific brawler info |
| Events | getRotation() | Get current and upcoming events |
⚠️ Disclaimer
This project is not affiliated with, endorsed, sponsored, or specifically approved by Supercell. Supercell is not responsible for it. For more information, please refer to Supercell’s Fan Content Policy.
© 2025 – Philippe Smeets 📧 [email protected]
