https://github.com/teambrawley/bs-api

An NPM Package bsapi.js
https://github.com/teambrawley/bs-api

brawl brawley brawlstars bs-api discord discordapp jet-brawley nodejs npm npmjs

Last synced: 4 months ago
JSON representation

An NPM Package bsapi.js

• Host: GitHub
• URL: https://github.com/teambrawley/bs-api
• Owner: teambrawley
• License: apache-2.0
• Created: 2021-03-14T14:00:56.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-28T15:01:30.000Z (almost 3 years ago)
• Last Synced: 2024-04-26T08:04:29.998Z (9 months ago)
• Topics: brawl, brawley, brawlstars, bs-api, discord, discordapp, jet-brawley, nodejs, npm, npmjs
• Language: JavaScript
• Homepage: https://npmjs.com/bsapi.js
• Size: 147 KB
• Stars: 23
• Watchers: 5
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## BS-API 

An npm package that can interact with [bs-api](https://cr.is-a.dev) easily.

### Install 

```

npm install bsapi.js

```

### Updates

 Version v2.0.6

> 

- Bug Fixes 

- Fixed Tag Validator `Regexp`

### Types 

| Request Types | Description |

| --------------|----------------|

| `get` | Uses Get Method To Request Data |

| `post` | Uses Post Method To Request Data |

| `ws` | Uses WebSocket To Receive Data |

______________________________________

| 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](https://github.com/brawlie/BrawlStars-Stats) |

### Usage 

```js

const bs = require('bsapi.js')

bs.('','').then(res => {

  // Handle Datas

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

```

- #### Example Usage

  

  `Get` A Player's In-Game Profile Information

  

   ```js

   bs.get('player','82PGQVJ2L').then(res => {

   console.log(res)

   }).catch(err => console.log(err))

  ```

  

  `Get` Current Event Rotation ( Async / Await )

 

   ```js

   (async () => {

   console.log(await bs.get('events'));

   })();

   ```

  `WebSocket` To Get Battlelogs

 

   ```js

   bs.ws({

   type: 'battlelog',

   tag: '82PGQVJ2L'

   }, (err, data) => {

    console.log(err, data)

   })

   ```

   

### Tag Validator 

This function allows you to validate a Brawl Stars Tag

```js

const { validator } = require('bsapi.js')

// ... ( async )

await validator('', '<#TAG>')

```

*supported types : `club`, `player`, `brawlers`*

Or Use Regexp ( Only Validates Tag Pattern, Doesn't Tell If Its Exist )

```js

const { regexp } = require('bsapi.js');

// Returns Boolean ( true / false )

regexp('<#TAG>')

```

*supported types : `club`, `player`, `map`*

### CLI

Interact with bs-api through cli.

```

npm install -g bsapi.js

```

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

- ### Usage

  ---

  **To learn more about CLI options/commands, run the help command or `-h` (or `--help`) argument :**

  

  ```

  $ bs help

  ```

### License 

```Apache-2.0```

- ### Links

  - [Docs](https://bsapi.is-a.dev)

  - [Repository](https://github.com/brawlie/bs-api)

  

- ### Contributors

  - [@joeleeofficial](https://github.com/joeleeofficial)

  - [@teambrawley](https://github.com/brawlie)

  - [@w3cy](https://github.com/w3cy)

- ### Disclaimer

  - See [Supercell's Fan Content Policy](https://supercell.com/en/fan-content-policy/)