kevinbrill / battlenet-api-wrapper

A promised-based Node.js + Typescript wrapper for the Battle.net Community and Data APIs (supports WoW, WoW Classic, SC2, D3, and Hearthstone).

Battle.net API Wrapper

A promised-based Node.js wrapper for the Battle.net Community and Data APIs (supports WoW, WoW Classic, SC2, D3, and Hearthstone).

Installation

$ npm install --save battlenet-api-wrapper

Prerequisites / General Information

• To get your Client ID and Client Secret needed for this library, please refer to the steps in the Battle.net API Getting Started documentation.
• Battle.net API Documentation Reference: https://develop.battle.net/documentation

Usage

The basic implementation of this library is as follows:

const battleNetWrapper = require('battlenet-api-wrapper');  
  
const clientId = 'YOUR_CLIENT_ID';  
const clientSecret = 'YOUR_CLIENT_SECRET';  
  
(async function() {  
   const bnw = new battleNetWrapper();  
   await bnw.init(clientId, clientSecret);
}());  

Once you have the battleNetWrapper class object instantiated, you then have access to all of the classes that exist under that umbrella. For each of the classes below, you will see a link to the full abstraction documentation. Each of functions are available on the respective class objects.

• bnw.Diablo3Community Usage Documentation
• bnw.Diablo3GameData Usage Documentation
• bnw.HearthstoneGameData Usage Documentation
• bnw.Starcraft2Community Usage Documentation
• bnw.Starcraft2GameData Usage Documentation
• bnw.WowCommunity Usage Documentation
• bnw.WowGameData Usage Documentation
• bnw.WowProfileData Usage Documentation
• bnw.WowClassicGameData Usage Documentation

Having issues or have questions?

Post an issue and it will be responded to ASAP!

Want to contribute?

Feel free! Create a Pull Request and I'll review it ASAP!

Todos

• Add in test coverage.

License

Battle.net API Wrapper is released under the MIT License.