Wow-armory.js NPM

WoW-Armory.js

WoW-Armory.js is a simple Node.js library for fetching data from the World of Warcraft Community Platform API. This library works with the new Blizzard Battle.net Developer Portal and the OAuth authentication that Blizzard has decided to employ.

Given that I myself am not a big fan of Passport (it is bloated for the basic need of requesting data from an API), I created this library to just make a simple Axios request per function call with a unique access token per call.

Installation

Install wow-armory.js and save to your package.json dependencies in one easy step:

$ npm install wow-armory.js --save

Usage

In wherever you are setting your environment variables, you will need to add 3 new ones that should get passed into the constructor you see in the below code sample:

BNET_ID -- Will come from your developer account profile on the Battle.net Developer Portal BNET_SECRET -- Will come from your developer account profile on the Battle.net Developer Portal BNET_REGION -- What region your Battle.net resides.

Code sample:

const Armory = require('wow-armory.js');
const armoryClass = new Armory('bnet_id', 'bnet_secret', 'bnet_region');

armoryClass.getCharacter('region', 'server', 'character', 'optional_query_params')
    .then((characterInfo) => {
        console.log(characterInfo);
    });

Todos

Write Jest Tests
Add support for more character endpoints -- Challenge Modes, Appearances, etc.
Add support for other APIs -- Guild Profile, Challenge Mode, Auction API, Boss API, etc.