battlenet-api-wrapper
v1.0.6
Published
A promised-based Node.js wrapper for the Battle.net Community and Data APIs (supports WoW, WoW Classic, SC2, D3, and Hearthstone).
Readme
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 IDandClient Secretneeded 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.Diablo3CommunityUsage Documentationbnw.Diablo3GameDataUsage Documentationbnw.HearthstoneGameDataUsage Documentationbnw.Starcraft2CommunityUsage Documentationbnw.Starcraft2GameDataUsage Documentationbnw.WowCommunityUsage Documentationbnw.WowGameDataUsage Documentationbnw.WowProfileDataUsage Documentationbnw.WowClassicGameDataUsage 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.
