-
-
Notifications
You must be signed in to change notification settings - Fork 29
World of Warcraft (Retail)
In addition to all parameters documented here, all API methods can accept key, secret, token, origin, locale, for cases where you need to use different values to the default instance.
All methods accept a second headers argument allowing an object of { [key: string]: string } to be added to the request headers. For example, some requests can potentially return large response bodies and you might want to avoid this if the resource has not been updated between the previously observed state with a If-Modified-Since header. If a method does not accept an argument, or it's first argument is optional, pass null | undefined followed by a headers object, e.g. token(null, { 'X-Header-Key': 'X-Header-Value' })
Method parameters are encoded with encodeURIComponent for URL safety.
Methods with optional parameters will fallback to API endpoints that best match the provided parameters. e.g. pvpSeason with the signature ({ id?: number; resource?: 'leaderboard' | 'reward'; bracket?: string }) will fetch a season index if id is undefined regardless of whether resource and bracket are defined.
wow.accountProfile()
wow.accountCharacterProfile({ realm: number; character: number })
wow.accountCollections({ resource?: 'mounts' | 'pets' })
wow.characterAchievements({ realm: string; name: string; stats?: boolean })
wow.characterAppearance({ realm: string; name: string })
wow.characterCollections({ realm: string; name: string; resource?: 'mounts' | 'pets' })
wow.characterEncounters({ realm: string; name: string; resource?: 'dungeons' | 'raids' })
wow.characterEquipment({ realm: string; name: string })
wow.characterHunterPets({ realm: string; name: string })
wow.characterMedia({ realm: string; name: string })
wow.characterMythicKeystone({ realm: string; name: string; season?: number })
wow.characterProfessions({ realm: string; name: string })
wow.characterProfile({ realm: string; name: string; status?: boolean })
wow.characterPVP({ realm: string; name: string; bracket?: string })
wow.characterQuests({ realm: string; name: string; completed?: boolean })
wow.characterReputations({ realm: string; name: string })
wow.characterSoulbinds({ realm: string; name: string })
wow.characterSpecializations({ realm: string; name: string })
wow.characterStatistics({ realm: string; name: string })
wow.characterTitles({ realm: string; name: string })
wow.guild({ realm: string; name: string; resource?: 'activity' | 'achievements' | 'roster' })
wow.achievement({ id?: number; media?: boolean })
wow.achievementCategory({ id?: number })
wow.auctionHouse({ id: number })
wow.azeriteEssence({ id?: number; media?: boolean })
wow.azeriteEssenceSearch({ id: number; orderby?: string | string[]; page?: number })
wow.connectedRealm({ id?: number })
wow.connectedRealmSearch({ status: 'UP' | 'DOWN'; timezone?: string; orderby?: string | string[]; page?: number })
wow.covenant({ id: number; media?: boolean })
wow.soulbind({ id?: number })
wow.conduit({ id?: number })
wow.creature({ id: number; media?: boolean })
wow.creatureFamily({ id?: number; media?: boolean })
wow.creatureType({ id?: number })
wow.creatureSearch({ name: string; locale: Locales, orderby?: string | string[]; page?: number })
wow.guildCrest({ resource: 'border' | 'emblem'; id: number })
wow.item({ resource?: 'class' | 'set'; id?: number; sub?: number; media?: boolean })
wow.itemSearch({ name: string; locale: Locales, orderby?: string | string[]; page?: number })
wow.journal({ resource: 'instance' | 'encounter' | 'expansion'; id?: number; media?: boolean })
wow.mediaSearch({ tag: string; orderby?: string | string[]; page?: number })
wow.modifiedCrafting({ resource?: 'category' | 'reagent'; id?: number })
wow.mount({ id?: number })
wow.mountSearch({ name: string; locale: Locales, orderby?: string | string[]; page?: number })
wow.mythicKeystone({ resource?: 'dungeon' | 'period' | 'season'; id?: number })
wow.mythicKeystoneAffix({ id?: number; media?: boolean })
wow.mythicKeystoneLeaderboard({ realm: number; dungeon?: number; period?: number })
wow.mythicRaidLeaderboard({ raid: string; faction: 'alliance' | 'horde' })
wow.pet({ id?: number; resource?: 'ability'; media?: boolean })
wow.playableClass({ id?: number; media?: boolean; pvpTalents?: boolean })
wow.playableRace({ id?: number })
wow.playableSpecialization({ id?: number; media?: boolean })
wow.powerType({ id?: number })
wow.profession({ id?: number; media?: boolean; skillTier?: number })
wow.recipe({ id: number; media?: boolean })
wow.pvpSeason({ id?: number; resource?: 'leaderboard' | 'reward'; bracket?: string })
wow.pvpTier({ id?: number; media?: boolean })
wow.quest({ id?: number; resource?: 'category' | 'area' | 'type' })
wow.realm({ slug?: string })
wow.realmSearch({ timezone?: string; orderby?: string | string[]; page?: number })
wow.region({ id?: number })
wow.reputation({ resource: 'faction' | 'tier'; id?: number })
wow.spell({ id: number; media?: boolean })
wow.spellSearch({ name: string; locale: Locales, orderby?: string | string[]; page?: number })
wow.talent({ id?: number; pvp?: boolean })
wow.techTalent({ id?: number; tree?: boolean; media?: boolean })
wow.title({ id?: number })
wow.token()