Skip to content

Knightplayzz/brawl-stars-node

Repository files navigation

Brawl Stars Logo

A lightweight Node.js wrapper for the Brawl Stars API, designed to make interaction simple and efficient.

Build Status NPM Version NPM Downloads Install Size TypeScript


🚀 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-node

If 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 📧 philippesmeets@icloud.com

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors