Class: WOWAPI

WOWAPI

WOWAPI is a javascript wrapper around the World of Warcraft public API (http://blizzard.github.io/api-wow-docs/). The Blizzard Community Platform API provides a number of resources for developers and Wow enthusiasts to gather data about their characters, guilds and arena teams. This class leverages the usage of that API to the JS developers by wrapping all API calls in simple JS methods.

new WOWAPI(region, locale)

Instantiate a WOWAPI object that can be used to call underlying API methods. The data available through the API is limited to the region that it is in. Hence, US APIs accessed through us.battle.net will only contain data within US battlegroups and realms.
Parameters:
Name Type Argument Default Description
region string <optional>
"eu" region Specifies the region that will be used for the API calls. May be ["us", "eu", "kr", "tw", "ch"].
locale string <optional>
First value from selected region locale Specifies the locale to be used with the request. Support for locales is limited to those supported on the World of Warcraft community sites. Possible values are based on the region: { "us": ["en_US", "es_MX", "pt_BR"], "eu": ["en_GB", "es_ES", "fr_FR", "ru_RU", "de_DE", "pt_PT", "it_IT"], "kr": ["ko_KR"], "tw": ["zh_TW"], "ch": ["zh_CN"] }
Author:
  • eduardm (https://github.com/eduardm/wowjsapi)
License:
  • Creative Commons Zero (CC0)
Source:
Example
 var wowApiInstance = new WOWAPI("eu", "en_GB");

Requires

  • module:JQuery