Skip to content
A simple node.js wrapper around Blizzard's REST API for World of Warcraft.
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
tests
.gitignore
LICENSE.md
Makefile
README.md
index.js
package.json

README.md

node-armory

A simple node.js wrapper around Blizzard's REST API for World of Warcraft.

Installation

npm install armory

Documentation

Methods

realmStatus

  • realms (optional): String or array containing realm(s). All realms returned if empty.
  • region (optional): Two-letter region code. Defaults to defaultRegion.
  • callback(error, response)

character, guild

  • options: String in the form 'Name_Realm' or object with the following properties:
    • names: String or array containing name(s).
    • fields (optional): Array of optional fields to request.
    • realm (optional): Realm name. Overridden if provided in name string.
    • region (optional): Two-letter region code. Defaults to defaultRegion.
    • locale (optional): Locale string in the form xx_XX.
  • callback(error, response): Called once for each character/guild requested.

arena

  • options: String in the form 'Name_Size_Realm', 'Name_Size', or 'Name_Realm', or object with the following properties:
    • names: String or array containing name(s).
    • size (optional): One of '2v2', '3v3', or '5v5'. Overridden if provided in name string.
    • fields (optional): Array of optional fields to request.
    • realm (optional): Realm name. Overridden if provided in name string.
    • region (optional): Two-letter region code. Defaults to defaultRegion.
    • locale (optional): Locale string in the form xx_XX.
  • callback(error, response): Called once for each team requested.

item

  • id: String, integer, or array containing item ID(s).
  • region (optional): Two-letter region code. Defaults to defaultRegion.
  • locale (optional): Locale string in the form xx_XX.
  • callback(error, response): Called once for each item requested.

perks, rewards, classes, races

  • region (optional): Two-letter region code. Defaults to defaultRegion.
  • locale (optional): Locale string in the form xx_XX.
  • callback(error, response)

Properties

defaultRegion: Default battle.net sub-domain to request. Defaults to 'us'.

publicKey: Public key for authentication.

privateKey: Private key for authentication.

Usage

var armory = require('armory');

armory.publicKey = 'publickey';
armory.privateKey = 'privatekey';

// Single character
armory.character('Dargonaut_Shadowmoon', function(err, character) {

});

// Multiple characters
armory.character({
  names: ['Dargonaut', 'Dewbaca', 'Therago_Nazgrel'],
  fields: ['items','talents'],
  realm: 'Shadowmoon'
}, function(err, character) {

});

// Multiple realms
armory.realmStatus(['Shadowmoon', 'Nazgrel'], function(err, res) {

});

// Multiple items
armory.item([28275, 27903, 28041], function(err, item) {

});
Something went wrong with that request. Please try again.