brawldata.js

API Wrapper for BrawlAPI.

Getting Started

1. To install this package, in your console run: npm install brawldata.js
2. You have now installed the package!

Example

const brawldata = require("brawldata.js")

const client = new brawldata.Client()

;(async() => {
  const events = await client.getEvents()
  const brawlers = await client.getBrawlers()
  console.log(brawlers)
  //...
})()

Methods

Events Endpoint:

const events = client.getEvents()

AVAILABLE METHODS

• getActiveMapBySlot(slot)
• getUpcomingMapBySlot(slot)

Brawler Endpoint:

const brawlers = client.getBrawlers()

AVAILABLE METHODS

• getBrawlerByName(name)
• getBrawlerById(id)
• getBrawlersNames()
• getBrawlersStarPowers()
• getBrawlersGadgets()
• getBrawlersVideos()

Map Endpoint:

const maps = client.getMaps()

AVAILABLE METHODS

• getMapByName(name)
• getMapById(id)
• getMapNames()

Modes Endpoint:

const modes = client.getModes()

AVAILABLE METHODS

• getModesById(slot)

Icons Endpoint:

const icons = client.getIcons()

AVAILABLE METHODS

• getPlayerIconById(id)
• getClubIconById(id)

Errors

Code	Message
200	OK - Response was successfully fetched.
403	Forbidden - Resource not found, check URL parameters.
5XX	Cloudflare errors.

Additional Information

• In addition to the methods, you can also access specific properties, which can be found here
• Official documentation of BrawlAPI can be found at: https://brawlapi.com/#/
• Usage: https://brawlapi.com/#/Authentication
• Error Handling: https://brawlapi.com/#/Errors

Some endpoints contain very CPU-intensive data, such as solo or team statistics. Due to the nature of how expensive and time-intensive the collection and maintenance of this data is, Brawlify asks you to credit the source of the data and not create the impression that your application collects this data. Endpoints include, but are not limited to:

1. Events
2. Maps
3. Records

This package uses data collected by Brawlify.