blizzard_api

WoW Classic

WoW Classic progression (currently Mists of Pandaria Classic).

72 endpoints on client.wowClassic. Response types are documented on JSR: WowClassicApi.

Game data#

Achievement#

  • achievement(achievementId: number): Achievement
    Fetches and returns details of a specific achievement identified by its ID.
  • achievementCategories(): ClassicAchievementCategories
    Returns an index of achievement categories.
  • achievementCategory(achievementCategoryId: number): AchievementCategory
    Fetches and returns details of a specific achievement category identified by its ID.
  • achievementMedia(achievementId: number): AchievementMedia
    Fetches and returns media details for a specific achievement identified by its ID.
  • achievements(): Achievements
    Fetches and returns an index of achievements.

Auction house#

  • auctions(connectedRealmId: number): Auctions
    Returns all active auctions for a connected realm.
  • commodities(): ClassicCommodities
    Returns all active auctions for commodity items for the entire game region.

Connected realm#

  • connectedRealm(connectedRealmId: number): ClassicConnectedRealm
    Returns a connected realm by ID.
  • connectedRealms(): ConnectedRealms
    Returns the Connected Realms Index
  • searchConnectedRealm(searchParameters: SearchParameters): Search
    Performs a search of connected realms.

Creature#

  • creature(creatureId: number): Creature
    Returns details about a creature
  • creatureDisplayMedia(creatureDisplayId: number): CreatureDisplayMedia
    Returns media details about a specific Creature display
  • creatureFamilies(): CreatureFamilies
    Returns an index of creature families.
  • creatureFamily(creatureFamilyId: number): CreatureFamily
    Returns details about a creature family
  • creatureFamilyMedia(creatureFamilyId: number): CreatureFamilyMedia
    Returns media details about a specific Creature family
  • creatureType(creatureTypeId: number): CreatureType
    Returns details about a creature types
  • creatureTypes(): CreatureTypes
    Returns an index of creature types.
  • searchCreature(searchParameters: SearchParameters): Search
    Performs a search of creatures.

Guild crest#

  • guildCrestBorder(borderId: number): GuildCrestBorder
    Returns a Guild Crest Border Media
  • guildCrestEmblem(emblemId: number): GuildCrestEmblem
    Returns a Crest Emblem Media
  • guildCrests(): GuildCrests
    Returns the Guild Crest Components Index

Item#

  • item(itemId: number): Item
    Returns an item by ID.
  • itemClass(itemClassId: number): ItemClass
    Returns an item class by ID.
  • itemClasses(): ItemClasses
    Returns an index of item classes.
  • itemMedia(itemId: number): ItemMedia
    Returns media details about a specific item Id
  • itemSubclass(itemClassId: number, itemSubclassId: number): ItemSubclass
    Returns an item subclass by ID.
  • searchItem(searchParameters: SearchParameters): Search
    Performs a search of items.
  • searchMedia(searchParameters: SearchParameters): Search
    Performs a search of media.

Mythic keystone dungeon#

  • mythicKeystonePeriod(periodId: number): MythicKeystonePeriod
    Returns a Mythic Keystone period by ID.
  • mythicKeystonePeriods(): MythicKeystonePeriods
    Returns an index of Mythic Keystone periods.
  • mythicKeystoneSeason(seasonId: number): MythicKeystoneSeason
    Returns a Mythic Keystone season by ID.
  • mythicKeystoneSeasons(): MythicKeystoneSeasons
    Returns an index of Mythic Keystone seasons.

Mythic keystone leaderboard#

  • mythicKeystoneLeaderboard(connectedRealmId: number, dungeonId: number, period: number): MythicKeystoneLeaderboard
    Returns a weekly Mythic Keystone Leaderboard by period.
  • mythicKeystoneLeaderboards(connectedRealmId: number): MythicKeystoneLeaderboards
    Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.

Playable class#

  • playableClass(classId: number): PlayableClass
    Returns a playable class by ID.
  • playableClasses(): PlayableClasses
    Returns an index of playable classes.
  • playableClassMedia(playableClassId: number): PlayableClassMedia
    Returns media for a playable class by ID.

Playable race#

  • playableRace(playableRaceId: number): PlayableRace
    Returns a playable race by ID.
  • playableRaces(): PlayableRaces
    Returns an index of playable races.

Playable specialization#

  • playableSpecialization(specId: number): PlayableSpecialization
    Returns a playable specialization by ID.
  • playableSpecializationMedia(specId: number): PlayableSpecializationMedia
    Returns media for a playable specialization by ID.
  • playableSpecializations(): PlayableSpecializations
    Returns an index of playable specializations.

Power type#

  • powerType(powerTypeId: number): PowerType
    Returns a power type by ID.
  • powerTypes(): PowerTypes
    Returns an index of power types.

PvP season#

  • pvpSeason(pvpSeasonId: number): PvpSeason
    Returns a PvP season by ID.
  • pvpSeasonLeaderboard(pvpSeasonId: number, pvpBracket: string): PvpSeasonLeaderboard
    Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
  • pvpSeasonLeaderboards(pvpSeasonId: number): PvpSeasonLeaderboards
    Returns an index of PvP leaderboards for a PvP season.
  • pvpSeasonRewards(pvpSeasonId: number): PvpSeasonRewards
    Returns an index of PvP rewards for a PvP season.
  • pvpSeasons(): PvpSeasons
    Returns an index of PvP seasons.

Realm#

  • realm(realmSlugOrId: string | number): Realm
    Returns a single realm by slug or ID.
  • realms(): Realms
    Returns an index of realms.
  • searchRealm(searchParameters: SearchParameters): Search
    Performs a search of realms.

Region#

  • region(regionId: number): Region
    Returns a region by ID.
  • regions(): Regions
    Returns an index of regions.

Token#

  • token(): WowToken
    Fetches and returns last known price and last updated timestamp for a wow token.

Profile#

Character achievements#

  • characterAchievementStatistics(realmSlug: string, characterName: string): CharacterAchievementStatistics
    Returns a character's statistics as they pertain to achievements.
  • characterAchievementSummary(realmSlug: string, characterName: string): ClassicCharacterAchievementSummary
    Returns a summary of the achievements a character has completed.

Character appearance#

  • characterAppearanceSummary(realmSlug: string, characterName: string): ClassicCharacterAppearanceSummary
    Returns a summary of a character's appearance settings.

Character equipment#

  • characterEquipments(realmSlug: string, characterName: string): characterEquipments
    Returns a summary of the items equipped by a character.

Character hunter pets#

  • characterHunterPets(realmSlug: string, characterName: string): CharacterHunterPets
    If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.

Character media#

  • characterMedia(realmSlug: string, characterName: string): CharacterMedia
    Returns a summary of the media assets available for a character (such as an avatar render).

Character profile#

  • characterProfile(realmSlug: string, characterName: string): ClassicCharacterProfile
    Returns a profile summary for a character.
  • characterProfileStatus(realmSlug: string, characterName: string): CharacterProfileStatus
    Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:

Character PvP#

  • characterPvpBracketStatistics(realmSlug: string, characterName: string, pvpBracket: string): CharacterPvpBracketStatistics
    Returns the PvP bracket statistics for a character.
  • characterPvpSummary(realmSlug: string, characterName: string): ClassicCharacterPvpSummary
    Returns a PvP summary for a character.

Character reputations#

  • characterReputations(realmSlug: string, characterName: string): CharacterReputations
    Returns a summary of a character's reputations.

Character specializations#

  • characterSpecializations(realmSlug: string, characterName: string): ClassicCharacterSpecializations
    Returns a summary of a character's specializations.

Character statistics#

  • characterStatistics(realmSlug: string, characterName: string): ClassicCharacterStatistics
    Returns a statistics summary for a character.

Guild#

  • guild(realmSlug: string, nameSlug: string): Guild
    Returns a single guild by its name and realm.
  • guildAchievements(realmSlug: string, nameSlug: string): ClassicGuildAchievements
    Returns a single guild's achievements by name.
  • guildActivity(realmSlug: string, nameSlug: string): GuildActivity
    Returns a single guild's activity by name and realm.
  • guildRoster(realmSlug: string, nameSlug: string): GuildRoster
    Returns a single guild's roster by its name and realm.