warcord v2.0.0

WarCord

This is a package to simplify use of Wargaming API.

Initial Files:

const { WarCord } = require('warcord')
const warcord = new WarCord('your-app-id')

Useful Links

• Discord Server

Credits

• GardZock (Owner).

World of Tanks

• User
• Clan
• Tank

World of Tanks Blitz

• User
• Clan
• Tank
• Tournaments

World of WarShips

• User
• Clans
• Ships
• Encyclopedia

World of Tanks Console

• Clan
• Tankopedia

WOTCClan

Kind: global class

• WOTCClan
  • new WOTCClan(app_id, [realm])
  • .search(options) ⇒ Promise.<(Array.<WOTCClanSearch>|void)>
  • .get(clan_id, options) ⇒ Promise.<(WOTCClanGet|void)>

wotcClan.search(options) ⇒ Promise.<(Array.<WOTCClanSearch>|void)>

Method returns partial list of clans in alphabetical order by clan name or tag.

Kind: instance method of WOTCClan
Returns: Promise.<(Array.<WOTCClanSearch>|void)> - Array of clans.

Properties

wotcClan.get(clan_id, options) ⇒ Promise.<(WOTCClanGet|void)>

Method returns detailed clan information.

Kind: instance method of WOTCClan
Returns: Promise.<(WOTCClanGet|void)> - Clan data.

Properties

WOWSClans

Kind: global class

• WOWSClans
  • new WOWSClans(app_id, [realm])
  • .get(clanID) ⇒ Promise.<(WOWSClansResolve|null)>
  • .search(clanNameOrTag) ⇒ Promise.<(WOWSClansSearchResolve|null)>

wowsClans.get(clanID) ⇒ Promise.<(WOWSClansResolve|null)>

Get a clan in World of WarShips.

Kind: instance method of WOWSClans
Returns: Promise.<(WOWSClansResolve|null)> - Clan data.

wowsClans.search(clanNameOrTag) ⇒ Promise.<(WOWSClansSearchResolve|null)>

Get a array with clans data of respective name.

Kind: instance method of WOWSClans
Returns: Promise.<(WOWSClansSearchResolve|null)> - Array with clan data.

WOTBClan

Kind: global class

• WOTBClan
  • new WOTBClan(app_id, [realm])
  • .get(clanID) ⇒ Promise.<(WOTBClanResolve|null)>
  • .search(clanNameOrTag) ⇒ Promise.<(Array.<ClanSearchBlitz>|null)>

wotbClan.get(clanID) ⇒ Promise.<(WOTBClanResolve|null)>

Get a clan in World of Tanks Blitz.

Kind: instance method of WOTBClan
Returns: Promise.<(WOTBClanResolve|null)> - Clan data.

Example

...
const clan = await <Warcord>.blitz.clan.get('ID of Clan')

wotbClan.search(clanNameOrTag) ⇒ Promise.<(Array.<ClanSearchBlitz>|null)>

Get the ID's and Name of the putted name.

Kind: instance method of WOTBClan
Returns: Promise.<(Array.<ClanSearchBlitz>|null)> - The clan ID's and Name.

Example

...
const searchingClan = await <Warcord>.blitz.clan.search('Name or Tag of Clan')
//this returns an array of the clans found

const clan = await <Warcord>.blitz.clan.get(searchingClan[0].clan_id)
//this returns the first clan data.

WOTClan

Kind: global class

• WOTClan
  • new WOTClan(app_id, [realm])
  • .get(clanID, options) ⇒ Promise.<(WOTClanResolve|null)>
  • .search(clanNameOrTag, options) ⇒ Promise.<(Array.<WOTClanSearchResolve>|null)>
  • .rating(clanID, options) ⇒ Object
  • .member(memberID, options) ⇒ Promise.<(WOTMember|null)>

wotClan.get(clanID, options) ⇒ Promise.<(WOTClanResolve|null)>

Get a clan in World of Tanks.

Kind: instance method of WOTClan
Returns: Promise.<(WOTClanResolve|null)> - Clan data.

Properties

Example

...
const clan = await <Warcord>.wot.clan.get('ID of Clan')

wotClan.search(clanNameOrTag, options) ⇒ Promise.<(Array.<WOTClanSearchResolve>|null)>

Get a array with clans data of respective name.

Kind: instance method of WOTClan
Returns: Promise.<(Array.<WOTClanSearchResolve>|null)> - Array with clan data.

Properties

Example

...
const searchingClan = await <Warcord>.wot.clan.search('Name or Tag of Clan')
//this returns an array of the clans found.

const clan = await <Warcord>.wot.clan.get(searchingClan[0].clan_id)
//this returns the first clan data.

wotClan.rating(clanID, options) ⇒ Object

Get the rating of an Clan.

Kind: instance method of WOTClan
Returns: Object - Clan rating.

Properties

Example

...
const ratingOfClan = await <Warcord>.wot.clan.rating('ID of Clan')

wotClan.member(memberID, options) ⇒ Promise.<(WOTMember|null)>

Get the clan member data.

Kind: instance method of WOTClan
Returns: Promise.<(WOTMember|null)> - Clan Member data.

Properties

Example

const memberOfClan = await <Warcord>.wot.clan.member('ID of Member')

WOWSEncyclopedia

Kind: global class

• WOWSEncyclopedia
  • new WOWSEncyclopedia(app_id, [realm])
  • .get()
  • .find(ops) ⇒ Promise.<(Array.<WOWSLongPediaResolve>|Array.<WOWSPediaResolve>|null)>
  • .shipParams(ship_id, options) ⇒ Promise.<(WOWSShipParams|null)>

wowsEncyclopedia.get()

Deprecated

Kind: instance method of WOWSEncyclopedia

wowsEncyclopedia.find(ops) ⇒ Promise.<(Array.<WOWSLongPediaResolve>|Array.<WOWSPediaResolve>|null)>

Get a ship based on params.

Kind: instance method of WOWSEncyclopedia

Properties

Example

...
const getShip = await <WarCord>.wows.ship.find({ nation: 'japan', options: { lang: 'pt-br', limit: 100 } })

wowsEncyclopedia.shipParams(ship_id, options) ⇒ Promise.<(WOWSShipParams|null)>

Get the parameters of a ship

Kind: instance method of WOWSEncyclopedia
Returns: Promise.<(WOWSShipParams|null)> - Parameters of ships in all existing configurations.

Properties

WOWSShip

Kind: global class

• WOWSShip
  • new WOWSShip(app_id, [realm])
  • .get(userID) ⇒ Promise.<(Array.<WOWSShipResolve>|null)>
  • .find(ops) ⇒ Promise.<(Array.<WOWSLongShipResolve>|Array.<WOWSShipResolve>|null)>

wowsShip.get(userID) ⇒ Promise.<(Array.<WOWSShipResolve>|null)>

Get the ships status of an user.

Kind: instance method of WOWSShip

wowsShip.find(ops) ⇒ Promise.<(Array.<WOWSLongShipResolve>|Array.<WOWSShipResolve>|null)>

Get a ship based on params.

Kind: instance method of WOWSShip

Properties

WOTBTank

Kind: global class

• WOTBTank
  • new WOTBTank(app_id, [realm])
  • .get(tankID) ⇒ Promise.<(WOTBTankResolve|null)>

wotbTank.get(tankID) ⇒ Promise.<(WOTBTankResolve|null)>

Get the tank by ID.

Kind: instance method of WOTBTank

WOTTank

Kind: global class

• WOTTank
  • new WOTTank(app_id, [realm])
  • .find(type, nation, tier, options) ⇒ Promise.<(WOTTanksResolve|null)>
  • .get(tankID) ⇒ Promise.<(WOTTanksResolve|null)>

wotTank.find(type, nation, tier, options) ⇒ Promise.<(WOTTanksResolve|null)>

Get all tanks of parameters.

Kind: instance method of WOTTank
Returns: Promise.<(WOTTanksResolve|null)> - Returns all tanks finded.
Exemple: ...

const getTank = await .wot.tank.find('heavyTank')

Properties

wotTank.get(tankID) ⇒ Promise.<(WOTTanksResolve|null)>

Get a tank by ID.

Kind: instance method of WOTTank
Returns: Promise.<(WOTTanksResolve|null)> - Object with Tank Data.

Example

...
const tank = await .blitz.tank.get('ID of Tank')

WOTCTankopedia

Kind: global class

• WOTCTankopedia
  • new WOTCTankopedia(app_id, [realm])
  • .search(options) ⇒ Promise.<(Array.<WOTCTank>|void)>

wotcTankopedia.search(options) ⇒ Promise.<(Array.<WOTCTank>|void)>

Method returns list of available vehicles.

Kind: instance method of WOTCTankopedia
Returns: Promise.<(Array.<WOTCTank>|void)> - An array with search data.

Properties

WOTBTournaments

Kind: global class

• WOTBTournaments
  • new WOTBTournaments(app_id, [realm])
  • .find(options) ⇒ Promise.<(Array.<WOTBTournamentsSearch>|null)>
  • .get(tourID, options) ⇒ Promise.<(WOTBTournamentsGet|null)>
  • .getResult(tourID, options) ⇒ Promise.<(WOTBTourResult|null)>

wotbTournaments.find(options) ⇒ Promise.<(Array.<WOTBTournamentsSearch>|null)>

Search tournaments in API.

Kind: instance method of WOTBTournaments
Returns: Promise.<(Array.<WOTBTournamentsSearch>|null)> - The search data.

Properties

wotbTournaments.get(tourID, options) ⇒ Promise.<(WOTBTournamentsGet|null)>

Get a tournamente by ID.

Kind: instance method of WOTBTournaments
Returns: Promise.<(WOTBTournamentsGet|null)> - The tournament data.

Properties

wotbTournaments.getResult(tourID, options) ⇒ Promise.<(WOTBTourResult|null)>

Used to get the tournament result.

Kind: instance method of WOTBTournaments
Returns: Promise.<(WOTBTourResult|null)> - Tournament Result.

Properties

WOWSUser

Kind: global class

• WOWSUser
  • new WOWSUser(app_id, [realm])
  • .search(userName) ⇒ Promise.<(Array.<UserSearchResolve>|null)>
  • .get(userID) ⇒ Promise.<(WOWSUserResolve|null)>
  • .achievements(account_id, options) ⇒ Promise.<({battle: any, progress: any}|null)>
  • .shipStats(account_id) ⇒ Promise.<(Array.<WOWSPediaResolve>|null)>

wowsUser.search(userName) ⇒ Promise.<(Array.<UserSearchResolve>|null)>

Search users with respective name.

Kind: instance method of WOWSUser
Returns: Promise.<(Array.<UserSearchResolve>|null)> - Object Array with users data.

wowsUser.get(userID) ⇒ Promise.<(WOWSUserResolve|null)>

Get an user by ID.

Kind: instance method of WOWSUser
Returns: Promise.<(WOWSUserResolve|null)> - Object of user data.

wowsUser.achievements(account_id, options) ⇒ Promise.<({battle: any, progress: any}|null)>

Get all achievements of an user.

Kind: instance method of WOWSUser
Returns: Promise.<({battle: any, progress: any}|null)> - The achievements of user.

Properties

wowsUser.shipStats(account_id) ⇒ Promise.<(Array.<WOWSPediaResolve>|null)>

Get the ships status of an user.

Kind: instance method of WOWSUser

Example

...
const ships = await <Warcord>.wows.user.shipStats('ID of User')

WOTBUser

Kind: global class

• WOTBUser
  • new WOTBUser(app_id, [realm])
  • .get(userID) ⇒ Promise.<(WOTBUserResolve|null)>
  • .search(userName) ⇒ Promise.<(UserSearchResolve|null)>
  • .topTanks(userID) ⇒ Promise.<(WOTBTankTop|null)>

wotbUser.get(userID) ⇒ Promise.<(WOTBUserResolve|null)>

Get the user data by ID.

Kind: instance method of WOTBUser

Example

...
const user = await <Warcord>.blitz.user.get('Wargaming ID of User')

wotbUser.search(userName) ⇒ Promise.<(UserSearchResolve|null)>

Get all users with the putted name.

Kind: instance method of WOTBUser

Example

...
const searchingUser = await <Warcord>.blitz.user.search('Wargaming NickName of User')
//this returns an array of the users found.

const user = await <Warcord>.blitz.user.get(searchingUser[0].id)
//this returns the first user data.

wotbUser.topTanks(userID) ⇒ Promise.<(WOTBTankTop|null)>

Get the best 5 tanks of an user.

Kind: instance method of WOTBUser

Example

...
const tank = await <Warcord>.blitz.user.topTanks('Wargaming ID of User')

WOTUser

Kind: global class

• WOTUser
  • new WOTUser(app_id, [realm])
  • .search(userName, options) ⇒ Promise.<(Array.<UserSearchResolve>|null)>
  • .get(userID, options) ⇒ Promise.<(WOTUserResolve|null)>
  • .topTanks(userID, options) ⇒ Promise.<(Array.<WOTTopTanksResolve>|null)>

wotUser.search(userName, options) ⇒ Promise.<(Array.<UserSearchResolve>|null)>

Search users with respective name.

Kind: instance method of WOTUser
Returns: Promise.<(Array.<UserSearchResolve>|null)> - Object Array with users data.

Properties

Example

...
const searchingUser = await <Warcord>.wot.user.search('Wargaming NickName of User')
//this returns an array of the users found.

const user = await <Warcord>.wot.user.get(searchingUser[0].id)
//this returns the first user data.

wotUser.get(userID, options) ⇒ Promise.<(WOTUserResolve|null)>

Get an user by ID.

Kind: instance method of WOTUser
Returns: Promise.<(WOTUserResolve|null)> - Object of user data.

Properties

Example

...
const user = await <Warcord>.wot.user.get('Wargaming ID of User')

wotUser.topTanks(userID, options) ⇒ Promise.<(Array.<WOTTopTanksResolve>|null)>

Get the 5 best tanks of user.

Kind: instance method of WOTUser
Returns: Promise.<(Array.<WOTTopTanksResolve>|null)> - Object Array with tanks data.

Properties

Example

...
const topTanks = await <Warcord>.wot.user.topTanks('Wargaming ID of User')