website·Indexed 30 days ago
https://brawlstatsjs.netlify.appAn advanced and lightweight JavaScript wrapper around the Brawl Stars API. The library provides managers for players, clubs, battle logs, rotations, and leaderboards, featuring built-in caching and support for fetching multiple entities simultaneously.
interface Battlelog {
battle: Battle;
battleTime: string;
event: Event;
}EventEmitter class and utilizing an internal Map to store cached data. To ensure data freshness, the library uses timers to automatically delete cached keys after a specific duration. By default, the cache expires after 10 minutes unless a specific Time-To-Live (TTL) is provided. This prevents the library from returning stale stats after a user has played new games.Client class is the main entry point for interacting with the Brawl Stars API. It requires an API token, which can be passed explicitly in the configuration object or provided via the BRAWLSTARS_TOKEN environment variable.import { Client } from 'brawlstats';
const client = new Client({
/**
* Your Brawl Stars API key.
* @defaults to the environment variable `BRAWLSTARS_TOKEN`
*/
token: 'your-api-key'
});
// Fetch a player by tag
const player = await client.players.fetch('#22QJ0JPVJ');
// Fetch a club by tag
const club = await client.clubs.fetch('#XYZ');
// Get the current events rotation
const events = await client.rotation.get();
// Access all brawlers available in the game
const brawlers = client.brawlers;client.players.fetchMany() method to retrieve information for multiple players in a single request. Pass the player tags as a comma-separated list of arguments. Like the single fetch method, tags can be provided as raw strings, prefixed with #, or URL-encoded as %23.client.players
.fetchMany('player-tag-1', 'player-tag-2', 'player-tag-3')
.then((players) => {
console.log(players);
})
.catch((error) => {
console.error(error);
});getBrawlers, getRotation, getPlayer, and getClub have been removed and replaced by a manager system. This system implements internal caching to reduce data call times and provides more specialized fetch methods.// v2 (Removed)
await client.getBrawlers()
await client.getRotation()
await client.getPlayer()
await client.getClub()
// v3 (Replacement)
client.brawlers // Now synchronous
await client.rotation.get()
await client.players.fetch()
await client.clubs.fetch()client.leaderboards.fetch method. You must provide a mode (either 'players' or 'clubs') and a region (e.g., 'global' or a two-letter country code).client.leaderboards
.fetch({ mode: 'players', region: 'global' }) // Use 'clubs' for club leaderboards
.then((leaderboard) => {
console.log(leaderboard);
})
.catch((error) => {
console.error(error);
});Player class is used to construct player entries. It extends the Structure class. To create a new instance, use the Player constructor with an options object based on the IPlayer interface (excluding 3vs3Victories).const player = new Player(options);RotationManager is initialized by passing an API token as a string. This token is stored privately within the instance to authenticate requests to the API.const rotationManager = new RotationManager('YOUR_API_TOKEN');PlayerManager class is used to manage and retrieve player data from the API. It requires an API token during instantiation.const playerManager = new PlayerManager('YOUR_API_TOKEN');brawlstats package using npm, yarn, or pnpm.npm install brawlstatsClubManager class is used to interact with club data from the API. It requires an API token upon instantiation.const clubManager = new ClubManager('YOUR_API_TOKEN');client.clubs.fetchMany() method to retrieve data for multiple clubs simultaneously. Pass the club tags as a comma-separated list of arguments. Similar to single club fetching, tags can be provided as plain strings, prefixed with #, or as %23 encoded strings.client.clubs
.fetchMany('club-tag-1', 'club-tag-2', 'club-tag-3')
.then((clubs) => {
console.log(clubs);
})
.catch((error) => {
console.error(error);
});