brawlperk.js

Powerful JavaScript library for interacting with the BrawlStars API

Client

Represents BrawlStars API

• Client

• new Client(option)

• client.player(playerTag) ⇒ Promise.<Object>

• client.battlelog(playerTag) ⇒ Promise.<Object>

• client.club(clubTag) ⇒ Promise.<Object>

• client.members(clubTag) ⇒ Promise.<Object>

• client.clubRanks(countryCode, option) ⇒ Promise.<Object>

• client.playerRanks(countryCode, option) ⇒ Promise.<Object>

• client.brawlerRanks(countryCode, brawlerId, option) ⇒ Promise.<Object>

• client.brawlers(option) ⇒ Promise.<Object>

• client.brawlerId(brawlerId) ⇒ Promise.<Object>

• ClientOption : Object

• ClubSearchOption : Object

• SearchOption : Object

new Client(option)

| Param | Type | Description |

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

| option | ClientOption | API Options |

Example

const { Client } =  require('brawlperk.js');



const  client  =  new  Client({ token: '', timeout: 5000 });

client.player(playerTag) ⇒ Promise.<Object>

Search players

| Param | Type | Description |

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

| playerTag | string | Search player by playerTag. |

Example

client.player('#2QCCLG', { limit: 10 });

client.battlelog(playerTag) ⇒ Promise.<Object>

Get player battlelog information

| Param | Type | Description |

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

| playerTag | string | Tag of player. |

Example

client.battlelog('#8QU8J9LP');

client.club(clubTag) ⇒ Promise.<Object>

Get club information.

| Param | Type | Description |

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

| clubTag | string | Tag of the club. |

Example

client.club('#8QU8J9LP');

client.members(clubTag, option) ⇒ Promise.<Object>

Retrieve clubs members

| Param | Type | Description |

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

| clubTag | string | Tag of the club. |

| option | SearchOption | Optional options |

Example

client.members('#8QU8J9LP', { limit: 10 });

client.clubRanks(countryCode, option) ⇒ Promise.<Object>

Get club rankings for a specific location

| Param | Type | Description |

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

| countryCode | string | Country Code |

| option | SearchOption | Optional options |

Example

client.clubRanks('global');

client.playerRanks(countryCode, option) ⇒ Promise.<Object>

Get player rankings for a specific location

| Param | Type | Description |

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

| countryCode | string | Country Code |

| option | SearchOption | Optional options |

Example

client.playerRanks('global');

client.brawlerRanks(countryCode, brawlerId, option) ⇒ Promise.<Object>

Brawler rankings for a country or global rankings.

| Param | Type | Description |

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

| countryCode | string | Country Code |

| brawlerId | number | Brawler ID |

| option | SearchOption | Optional options |

Example

client.brawlerRanks('global', 16000000);

client.brawlers(option) ⇒ Promise.<Object>

Get list of available brawlers.

| Param | Type | Description |

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

| option | SearchOption | Optional options |

Example

client.brawlers();

client.brawlerId(brawlerId) ⇒ Promise.<Object>

Get Brawler Data based on ID

| Param | Type | Description |

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

| brawlerId | number | Brawler ID |

Example

client.brawlerId(16000000);

---

ClientOption : Object

| Param | Type | Description |

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

| token | string | BrawlStars API Token |

| timeout | number | Request timeout in millisecond |

SearchOption : Object

| Param | Type | Description |

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

| limit | number | Limit the number of items returned in the response. |

| after | string | Return only items that occur after this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. |

| before | string | Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. |