blizzard_api

World of Warcraft

World of Warcraft (Retail): game data and profile endpoints.

204 endpoints on client.wow, 9 of them needing a user token. Response types are documented on JSR: WowApi.

Game data#

Achievement#

  • achievement(achievementId: number): Achievement
    Fetches and returns details of a specific achievement identified by its ID.
  • achievementCategories(): AchievementCategories
    Fetches and 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(): Commodities
    Returns all active auctions for commodity items for the entire game region.

Azerite essence#

  • azeriteEssence(azeriteEssenceId: number): AzeriteEssenceDetails
    Returns details about a specific Azerite Essence Id
  • azeriteEssenceMedia(azeriteEssenceId: number): AzeritEessenceMedia
    Returns media details about a specific Azerite Essence Id
  • azeriteEssences(): AzeriteEssences
    Returns Azerite Essences Index
  • searchAzeriteEssence(searchParameters: SearchParameters): Search
    Performs a search of azerite essences.

Connected realm#

  • connectedRealm(connectedRealmId: number): ConnectedRealm
    Returns details about a Connected Realms Id
  • connectedRealms(): ConnectedRealms
    Returns the Connected Realms Index
  • searchConnectedRealm(searchParameters: SearchParameters): Search
    Performs a search of connected realms.

Covenant#

  • covenant(covenantId: number): Covenant
    Returns details about a Covenant
  • covenantConduit(conduitId: number): CovenantConduit
    Returns details about a Covenant Conduit
  • covenantConduits(): CovenantConduits
    Returns an index of Covenant Conduits.
  • covenants(): Covenants
    Returns an index of Covenants.
  • covenantSoulbind(soulbindId: number): CovenantSoulbind
    Returns details about a Covenant Soulbind
  • covenantSoulbinds(): CovenantSoulbinds
    Returns an index of Covenant Soulbinds.

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

Heirloom#

  • heirloom(heirloomId: number): Heirloom
    Returns a Heirloom
  • heirlooms(): Heirlooms
    Returns the Heirloom Index

Housing#

  • decor(decorId: number): Decor
    Returns a decor by ID.
  • decors(): Decors
    Returns an index of decor.
  • fixture(fixtureId: number): Fixture
    Returns a fixture by ID.
  • fixtureHook(fixtureHookId: number): FixtureHook
    Returns a fixture hook by ID.
  • fixtureHooks(): FixtureHooks
    Returns an index of fixture hooks.
  • fixtures(): Fixtures
    Returns an index of fixtures.
  • room(roomId: number): Room
    Returns a room by ID.
  • rooms(): Rooms
    Returns an index of rooms.
  • searchDecor(searchParameters: SearchParameters): Search
    Performs a search of decor.
  • searchFixture(searchParameters: SearchParameters): Search
    Performs a search of fixtures.
  • searchFixtureHook(searchParameters: SearchParameters): Search
    Performs a search of fixture hooks.
  • searchRoom(searchParameters: SearchParameters): Search
    Performs a search of rooms.

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
  • itemSet(itemSetId: number): ItemSet
    Returns an item set by ID.
  • itemSets(): ItemSets
    Returns an index of item sets.
  • itemSubclass(itemClassId: number, itemSubclassId: number): ItemSubclass
    Returns an item subclass by ID.
  • searchItem(searchParameters: SearchParameters): Search
    Performs a search of items.

Item appearance#

  • itemAppearance(appearanceId: number): ItemAppearance
    Returns an item appearance by ID.
  • itemAppearanceSet(appearanceSetId: number): ItemAppearanceSet
    Returns an item appearance set by ID.
  • itemAppearanceSets(): ItemAppearanceSets
    Returns a index of item appearance sets.
  • itemAppearanceSlot(slotType: string): ItemAppearanceSlot
    Returns an item appearance slot by slot type.
  • itemAppearanceSlots(): ItemAppearanceSlots
    Returns a index of item appearance slots.
  • searchItemAppearance(searchParameters: SearchParameters): ItemAppearanceSearch
    Performs a search of item appearances.

Journal#

  • journalEncounter(journalEncounterId: number): JournalEncounter
    Returns a journal encounter by ID.
  • journalEncounters(): JournalEncounters
    Returns an index of journal encounters.
  • journalExpansion(journalExpansionId: number): JournalExpansion
    Returns a journal expansion by ID.
  • journalExpansions(): JournalExpansions
    Returns an index of journal expansions.
  • journalInstance(journalInstanceId: number): JournalInstance
    Returns a journal instances by ID.
  • journalInstanceMedia(journalInstanceId: number): JournalInstanceMedia
    Returns media for a journal instance by ID.
  • journalInstances(): JournalInstances
    Returns an index of journal instances.
  • searchJournalEncounter(searchParameters: SearchParameters): Search
    Performs a search of journal encounters.

Keystone affix#

  • keystoneAffix(keystoneAffixId: number): KeystoneAffix
    Returns a mythic keystone affix by ID.
  • keystoneAffixes(): KeystoneAffixes
    Returns an index of mythic keystone affixes.
  • keystoneAffixMedia(keystoneAffixId: number): KeystoneAffixMedia
    Returns media for a mythic keystone affix by ID.
  • searchMedia(searchParameters: SearchParameters): Search
    Performs a search of media.

Modified crafting#

  • modifiedCraftingCategories(): ModifiedCraftingCategories
    Returns the index of Modified Crafting categories.
  • modifiedCraftingCategory(categoryId: number): ModifiedCraftingCategory
    Returns a Modified Crafting category by ID.
  • modifiedCraftingParents(): ModifiedCraftingParents
    Returns the parent index for Modified Crafting.
  • modifiedCraftingSlotType(slotTypeId: number): ModifiedCraftingSlotType
    Returns a Modified Crafting reagent slot type by ID.
  • modifiedCraftingSlotTypes(): ModifiedCraftingSlotTypes
    Returns the index of Modified Crafting reagent slot types.

Mount#

  • mount(mountId: number): Mount
    Returns a mount by ID.
  • mounts(): Mounts
    Returns a index of mounts.
  • searchMount(searchParameters: SearchParameters): Search
    Performs a search of mounts.

Mythic keystone dungeon#

  • mythicKeystoneDungeon(dungeonId: number): MythicKeystoneDungeon
    Returns a Mythic Keystone dungeon by ID.
  • mythicKeystoneDungeons(): MythicKeystoneDungeons
    Returns an index of Mythic Keystone dungeons.
  • mythicKeystoneIndex(): MythicKeystoneIndex
    Returns an index of links to other documents related to Mythic Keystone dungeons.
  • 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.

Mythic raid leaderboard#

  • mythicRaidLeaderboard(raid: string, faction: "alliance" | "horde"): MythicRaidLeaderboard
    Returns the leaderboard for a given raid and faction.

Neighborhood#

  • neighborhood(neighborhoodMapId: number, neighborhoodId: number): Neighborhood
    Returns a neighborhood by ID within a neighborhood map.
  • neighborhoodMap(neighborhoodMapId: number): NeighborhoodMap
    Returns a neighborhood map by ID.
  • neighborhoodMaps(): NeighborhoodMaps
    Returns an index of neighborhood maps.

Pet#

  • pet(petId: number): Pet
    Returns a battle pet by ID.
  • petAbilities(): PetAbilities
    Returns an index of pet abilities.
  • petAbility(petAbilityId: number): PetAbility
    Returns a pet ability by ID.
  • petAbilityMedia(petAbilityId: number): PetAbilityMedia
    Returns media for a battle pet by ID.
  • petMedia(petId: number): PetMedia
    Returns media for a battle pet by ID.
  • pets(): Pets
    Returns an index of battle pets.

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.
  • playableClassPvpTalentSlots(classId: number): PlayableClassPvpTalentSlots
    Returns the PvP talent slots 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.

Profession#

  • profession(professionId: number): Profession
    Returns a profession by ID.
  • professionMedia(professionId: number): ProfessionMedia
    Returns media for a profession by ID.
  • professionRecipie(recipeId: number): ProfessionRecipie
    Returns a recipe by ID.
  • professionRecipieMedia(recipeId: number): professionRecipieMedia
    Returns media for a recipe by ID.
  • professions(): Professions
    Returns an index of professions.
  • professionSkillTier(professionId: number, skillTierId: number): ProfessionSkillTier
    Returns a skill tier for a profession by ID.

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.

PvP tier#

  • pvpTier(pvpTierId: number): PvpTier
    Returns a PvP tier by ID.
  • pvpTierMedia(pvpTierId: number): PvpTierMedia
    Returns media for a PvP tier by ID.
  • pvpTiers(): PvpTiers
    Returns an index of PvP tiers.

Quest#

  • quest(questId: number): Quest
    Returns a quest by ID.
  • questArea(questAreaId: number): QuestArea
    Returns a quest area by ID.
  • questAreas(): QuestAreas
    Returns an index of quest areas.
  • questCategories(): QuestCategories
    Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
  • questCategory(questCategoryId: number): QuestCategory
    Returns a quest category by ID.
  • quests(): Quests
    Returns the parent index for quests.
  • questType(questTypeId: number): QuestType
    Returns a quest type by ID.
  • questTypes(): QuestTypes
    Returns an index of quest types (such as PvP quests, raid quests, or account quests).

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.

Reputations#

  • reputationFaction(reputationFactionId: string): ReputationFaction
    Returns a single reputation faction by ID.
  • reputationFactions(): ReputationFactions
    Returns an index of reputation factions.
  • reputationTier(reputationTiersId: string): ReputationTier
    Returns a single set of reputation tiers by ID.
  • reputationTiers(): ReputationTiers
    Returns an index of reputation tiers.

Spell#

  • searchSpell(searchParameters: SearchParameters): Search
    Performs a search of spells.
  • spell(spellId: number): Spell
    Returns a spell by ID.
  • spellMedia(spellId: number): SpellMedia
    Returns media for a spell by ID.

Talent#

  • pvpTalent(pvpTalentId: number): PvpTalent
    Returns a PvP talent by ID.
  • pvpTalents(): PvpTalents
    Returns an index of PvP talents.
  • talent(talentId: number): Talent
    Returns a talent by ID.
  • talents(): Talents
    Returns an index of talents.
  • talentTree(talentTreeId: number, specId: number): TalentTree
    Returns a talent tree by specialization ID.
  • talentTreeNodes(talentTreeId: number): TalentTreeNodes
    Returns all talent tree nodes as well as links to associated playable specializations given a talent tree id. This is useful to generate loadout export codes.
  • talentTrees(): TalentTrees
    Returns an index of talent trees.

Tech talent#

  • techTalent(techTalentId: number): TechTalent
    Returns a tech talent by ID.
  • techTalentMedia(techTalentId: number): TechTalentMedia
    Returns media for a tech talent by ID.
  • techTalents(): TechTalents
    Returns an index of tech talents.
  • techTalentTree(techTalentTreeId: number): TechTalentTree
    Returns a tech talent tree by ID.
  • techTalentTrees(): TechTalentTrees
    Returns an index of tech talent trees.

Title#

  • title(titleId: number): Title
    Returns a title by ID.
  • titles(): Titles
    Returns an index of titles.

Token#

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

Toy#

  • toy(toyId: number): Toy
    Returns a toy by id.
  • toys(): Toys
    Returns an index of toys.

Profile#

Account profile#

  • accountCollectionsIndex(): AccountCollectionsIndex
    Returns an index of collection types for an account. User token.
  • accountDecorCollection(): AccountDecorCollection
    Returns the housing decor collected by an account. User token.
  • accountHeirloomsCollection(): AccountHeirloomsCollection
    Returns the heirlooms collected by an account. User token.
  • accountMountsCollection(): AccountMountsCollection
    Returns the mounts collected by an account. User token.
  • accountPetsCollection(): AccountPetsCollection
    Returns the battle pets collected by an account. User token.
  • accountProfileSummary(): AccountProfileSummary
    Returns a profile summary for an account, including its WoW accounts and characters. User token.
  • accountToysCollection(): AccountToysCollection
    Returns the toys collected by an account. User token.
  • accountTransmogsCollection(): AccountTransmogsCollection
    Returns the transmog appearances and sets collected by an account. User token.
  • protectedCharacterProfile(realmId: number, characterId: number): ProtectedCharacterProfile
    Returns a protected profile summary for a character (money, deaths, position, ...). User token.

Character achievements#

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

Character appearance#

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

Character collections#

  • characterCollectionDecor(realmSlug: string, characterName: string): CharacterCollectionDecor
    Returns a summary of the housing decor collection a character has obtained.
  • characterCollectionHeirlooms(realmSlug: string, characterName: string): CharacterCollectionHeirlooms
    Returns a summary of the heirlooms a character has obtained.
  • characterCollectionMounts(realmSlug: string, characterName: string): CharacterCollectionMounts
    Returns a summary of the mounts a character has obtained.
  • characterCollectionPets(realmSlug: string, characterName: string): CharacterCollectionPets
    Returns a summary of the pets a character has obtained.
  • characterCollectionToys(realmSlug: string, characterName: string): CharacterCollectionToys
    Returns a summary of the toys a character has obtained.
  • characterCollectionTransmogs(realmSlug: string, characterName: string): CharacterCollectionTransmogs
    Returns a summary of the transmog appearances a character has obtained.
  • characterCollectionTypes(realmSlug: string, characterName: string): CharacterCollectionTypes
    Returns an index of collection types for a character.

Character encounters#

  • characterEncounterDungeons(realmSlug: string, characterName: string): CharacterEncounterDungeons
    Returns a summary of a character's completed dungeons.
  • characterEncounterRaids(realmSlug: string, characterName: string): CharacterEncounterRaids
    Returns a summary of a character's completed raids.
  • characterEncounters(realmSlug: string, characterName: string): CharacterEncounters
    Returns a summary of a character's encounters.

Character equipment#

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

Character house#

  • characterHouse(realmSlug: string, characterName: string, houseNumber: number): CharacterHouse
    Returns a summary of a house a character has built.

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 mythic keystone profile#

  • characterMythicKeystoneProfile(realmSlug: string, characterName: string): CharacterMythicKeystoneProfile
    Returns the Mythic Keystone profile index for a character.
  • characterMythicKeystoneSeasonDetails(realmSlug: string, characterName: string, seasonId: number): CharacterMythicKeystoneSeasonDetails
    Returns the Mythic Keystone season details for a character.

Character professions#

  • characterProfessions(realmSlug: string, characterName: string): CharacterProfessions
    Returns a summary of professions for a character.

Character profile#

  • characterProfile(realmSlug: string, characterName: string): CharacterProfile
    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): CharacterPvpSummary
    Returns a PvP summary for a character.

Character quests#

  • characterCompletedQuests(realmSlug: string, characterName: string): CharacterCompletedQuests
    Returns a list of quests that a character has completed.
  • characterQuests(realmSlug: string, characterName: string): CharacterQuests
    Returns a character's active quests as well as a link to the character's completed quests.

Character reputations#

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

Character soulbinds#

  • characterSoulbinds(realmSlug: string, characterName: string): CharacterSoulbinds
    Returns a character's soulbinds.

Character specializations#

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

Character statistics#

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

Character titles#

  • characterTitles(realmSlug: string, characterName: string): CharacterTitles
    Returns a summary of titles a character has obtained.

Guild#

  • guild(realmSlug: string, nameSlug: string): Guild
    Returns a single guild by its name and realm.
  • guildAchievements(realmSlug: string, nameSlug: string): GuildAchievements
    Returns a single guild's achievements by name and realm.
  • 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.