/bs-api

An NPM Package bsapi.js

Primary LanguageJavaScriptApache License 2.0Apache-2.0

BS-API

An npm package that can interact with bs-api easily.

Install

npm install bsapi.js

Updates

Version v2.0.5 ( Major Update )

  • Bug Fixes
  • Added CLI
  • Added New Response Type ( clublog )

Types

Request Types Description
get Uses Get Method To Request Data
post Uses Post Method To Request Data
ws Uses WebSocket To Receive Data ( player type )
Response Type Description
player Get A Player's Game Stats
clubs Get A Club's Stats
rankings/players Top Rankings ( Player )
rankings/clubs Top Rankings ( Club )
brawlers List Of Every Brawlers
events Events Rotation
You can find the list of every response types at here

Usage

const bs = require('bsapi.js')

bs.<Request_Type>('<Type>','<TAG>').then(res => {

  // Handle Datas

}).catch(err => // Handle Errors )

  • Example Usage

    Get A Player's In-Game Profile Information

    bs.get('player','82PGQVJ2L').then(res => {
console.log(res)
}).catch(err => console.log(err))

    Get Current Event Rotation ( Async / Await )

    (async () => {
console.log(await bs.get('events'));
})();

    WebSocket To Get Battlelogs

    bs.ws({
type: 'battlelog',
tag: '82PGQVJ2L'
}, (err, data) => {
 console.log(err, data)
})

Tag Validator

This function allows you to validate a Brawl Stars Tag

const { validator } = require('bsapi.js')
// ... ( async )
await validator('<Type>', '<#TAG>')

supported types : club, player, brawler

CLI

Interact with bs-api through cli.

npm install -g bsapi.js

to use cli, you'll have to install this package globally

  • Usage

    For CLI options, use the help command or -h (or --help) argument :

    $ bs help

License

Apache-2.0