Documentation / @blizzard-api/wow-forever / wowForever
Variable: wowForever
constwowForever:object
Defined in: wow-forever/src/index.ts:127
Type Declaration
accountCollectionsIndex
accountCollectionsIndex: (
token?) =>ProtectedResource<AccountCollectionsIndexResponse>
Get an index of collection types for the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountCollectionsIndexResponse>
The account collections index. See AccountCollectionsIndexResponse.
accountHeirloomsCollectionSummary
accountHeirloomsCollectionSummary: (
token?) =>ProtectedResource<AccountHeirloomsCollectionSummaryResponse>
Get the heirlooms collected by the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountHeirloomsCollectionSummaryResponse>
The account's heirlooms. See AccountHeirloomsCollectionSummaryResponse.
accountMountsCollectionSummary
accountMountsCollectionSummary: (
token?) =>ProtectedResource<AccountMountsCollectionSummaryResponse>
Get the mounts collected by the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountMountsCollectionSummaryResponse>
The account's mounts. See AccountMountsCollectionSummaryResponse.
accountPetsCollectionSummary
accountPetsCollectionSummary: (
token?) =>ProtectedResource<AccountPetsCollectionSummaryResponse>
Get the battle pets collected by the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountPetsCollectionSummaryResponse>
The account's battle pets. See AccountPetsCollectionSummaryResponse.
accountProfileSummary
accountProfileSummary: (
token?) =>ProtectedResource<AccountProfileSummaryResponse>
Get a profile summary for the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountProfileSummaryResponse>
The account profile summary. See AccountProfileSummaryResponse.
accountToysCollectionSummary
accountToysCollectionSummary: (
token?) =>ProtectedResource<AccountToysCollectionSummaryResponse>
Get the toys collected by the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountToysCollectionSummaryResponse>
The account's toys. See AccountToysCollectionSummaryResponse.
accountTransmogsCollectionSummary
accountTransmogsCollectionSummary: (
token?) =>ProtectedResource<AccountTransmogsCollectionSummaryResponse>
Get the transmog unlocks for the authenticated account. Requires a user access token with the wow.profile scope.
Parameters
token?
string
Optional user access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountTransmogsCollectionSummaryResponse>
The account's transmogs. See AccountTransmogsCollectionSummaryResponse.
achievement
achievement: (
achievementId) =>object
Get an achievement by ID.
Parameters
achievementId
number
The achievement ID.
Returns
The achievement. See AchievementResponse.
_responseType?
optional_responseType?:AchievementResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
achievementCategory
achievementCategory: (
achievementCategoryId) =>object
Get an achievement category by ID.
Parameters
achievementCategoryId
number
The achievement category ID.
Returns
The achievement category. See AchievementCategoryResponse.
_responseType?
optional_responseType?:AchievementCategoryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
achievementCategoryIndex
achievementCategoryIndex: () =>
object
Get an achievement category index.
Returns
The achievement category index. See AchievementCategoryIndexResponse.
_responseType?
optional_responseType?:AchievementCategoryIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
achievementIndex
achievementIndex: () =>
object
Get an achievement index.
Returns
The achievement index. See AchievementIndexResponse.
_responseType?
optional_responseType?:AchievementIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
achievementMedia
achievementMedia: (
achievementId) =>object
Get achievement media by ID.
Parameters
achievementId
number
The achievement ID.
Returns
The achievement media. See AchievementMediaResponse.
_responseType?
optional_responseType?:AchievementMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
auctionHouseIndex
auctionHouseIndex: (
rulesetId) =>object
Get the auction houses of a ruleset.
Parameters
rulesetId
number
The ruleset ID.
Returns
The auction house index. See AuctionHouseIndexResponse.
_responseType?
optional_responseType?:AuctionHouseIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
auctions
auctions: (
rulesetId,auctionHouseId) =>object
Get the auctions of an auction house.
Parameters
rulesetId
number
The ruleset ID.
auctionHouseId
number
The auction house ID.
Returns
The auction house data. See AuctionHouseResponse.
_responseType?
optional_responseType?:AuctionHouseResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterAchievementsSummary
characterAchievementsSummary: (
name,surname) =>object
Get a summary of the achievements a character has completed.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
A summary of the character's achievements. See CharacterAchievementsSummaryResponse.
_responseType?
optional_responseType?:CharacterAchievementsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterAchievementStatistics
characterAchievementStatistics: (
name,surname) =>object
Get a character's statistics as they pertain to achievements.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's achievement statistics. See CharacterAchievementStatisticsResponse.
_responseType?
optional_responseType?:CharacterAchievementStatisticsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterAppearanceSummary
characterAppearanceSummary: (
name,surname) =>object
Get a summary of a character's appearance settings.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
A summary of the character's appearance. See CharacterAppearanceResponse.
_responseType?
optional_responseType?:CharacterAppearanceResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterCollectionsIndex
characterCollectionsIndex: (
name,surname) =>object
Get an index of collection types for a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's collection index. See CharacterCollectionsIndexResponse.
_responseType?
optional_responseType?:CharacterCollectionsIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterCompletedQuests
characterCompletedQuests: (
name,surname) =>object
Get the quests a character has completed.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's completed quests. See CharacterCompletedQuestsResponse.
_responseType?
optional_responseType?:CharacterCompletedQuestsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterDungeons
characterDungeons: (
name,surname) =>object
Get a summary of a character's completed dungeons.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's completed dungeons. See CharacterDungeonsResponse.
_responseType?
optional_responseType?:CharacterDungeonsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterEncountersSummary
characterEncountersSummary: (
name,surname) =>object
Get a summary of a character's encounters.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's encounters. See CharacterEncountersSummaryResponse.
_responseType?
optional_responseType?:CharacterEncountersSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterEquipmentSummary
characterEquipmentSummary: (
name,surname) =>object
Get a summary of the items equipped by a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's equipped items. See CharacterEquipmentSummaryResponse.
_responseType?
optional_responseType?:CharacterEquipmentSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterHeirloomsCollectionSummary
characterHeirloomsCollectionSummary: (
name,surname) =>object
Get a summary of the heirlooms a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's heirlooms. See CharacterHeirloomsCollectionSummaryResponse.
_responseType?
optional_responseType?:CharacterHeirloomsCollectionSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterHunterPetsSummary
characterHunterPetsSummary: (
name,surname) =>object
Get a summary of the hunter pets of a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's hunter pets. See CharacterHunterPetsSummaryResponse.
_responseType?
optional_responseType?:CharacterHunterPetsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterMediaSummary
characterMediaSummary: (
name,surname) =>object
Get a summary of the media assets available for a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's media assets. See CharacterMediaSummaryResponse.
_responseType?
optional_responseType?:CharacterMediaSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterMountsCollectionSummary
characterMountsCollectionSummary: (
name,surname) =>object
Get a summary of the mounts a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's mounts. See CharacterMountsCollectionSummaryResponse.
_responseType?
optional_responseType?:CharacterMountsCollectionSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterMythicKeystoneProfileIndex
characterMythicKeystoneProfileIndex: (
name,surname) =>object
Get the Mythic Keystone profile index for a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's Mythic Keystone profile. See CharacterMythicKeystoneProfileIndexResponse.
_responseType?
optional_responseType?:CharacterMythicKeystoneProfileIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterPetsCollectionSummary
characterPetsCollectionSummary: (
name,surname) =>object
Get a summary of the battle pets a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's battle pets. See CharacterPetsCollectionSummaryResponse.
_responseType?
optional_responseType?:CharacterPetsCollectionSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterProfessionsSummary
characterProfessionsSummary: (
name,surname) =>object
Get a summary of the professions of a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's professions. See CharacterProfessionsSummaryResponse.
_responseType?
optional_responseType?:CharacterProfessionsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterProfileStatus
characterProfileStatus: (
name,surname) =>object
Get the profile status and unique ID of a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The status of the character profile. See CharacterProfileStatusResponse.
_responseType?
optional_responseType?:CharacterProfileStatusResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterProfileSummary
characterProfileSummary: (
name,surname) =>object
Get a summary of the character profile of a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
A summary of the character profile. See CharacterProfileSummaryResponse.
_responseType?
optional_responseType?:CharacterProfileSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterPvpSummary
characterPvpSummary: (
name,surname) =>object
Get a PvP summary for a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's PvP summary. See CharacterPvpSummaryResponse.
_responseType?
optional_responseType?:CharacterPvpSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterQuests
characterQuests: (
name,surname) =>object
Get a character's active quests and a link to the character's completed quests.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's quests. See CharacterQuestsResponse.
_responseType?
optional_responseType?:CharacterQuestsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterRaids
characterRaids: (
name,surname) =>object
Get a summary of a character's completed raids.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's completed raids. See CharacterRaidsResponse.
_responseType?
optional_responseType?:CharacterRaidsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterReputationsSummary
characterReputationsSummary: (
name,surname) =>object
Get a summary of a character's reputations.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's reputations. See CharacterReputationsSummaryResponse.
_responseType?
optional_responseType?:CharacterReputationsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterSpecializationsSummary
characterSpecializationsSummary: (
name,surname) =>object
Get a summary of a character's specializations.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's specializations. See CharacterSpecializationsSummaryResponse.
_responseType?
optional_responseType?:CharacterSpecializationsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterStatisticsSummary
characterStatisticsSummary: (
name,surname) =>object
Get a statistics summary for a character.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's statistics. See CharacterStatisticsSummaryResponse.
_responseType?
optional_responseType?:CharacterStatisticsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterTitlesSummary
characterTitlesSummary: (
name,surname) =>object
Get a summary of the titles a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's titles. See CharacterTitlesSummaryResponse.
_responseType?
optional_responseType?:CharacterTitlesSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterToysCollectionSummary
characterToysCollectionSummary: (
name,surname) =>object
Get a summary of the toys a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's toys. See CharacterToysCollectionSummaryResponse.
_responseType?
optional_responseType?:CharacterToysCollectionSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterTransmogCollectionSummary
characterTransmogCollectionSummary: (
name,surname) =>object
Get a summary of the transmog unlocks a character has obtained.
Parameters
name
string
The character's first name.
surname
string
The character's surname.
Returns
The character's transmogs. See CharacterTransmogCollectionSummaryResponse.
_responseType?
optional_responseType?:CharacterTransmogCollectionSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
commodities
commodities: (
rulesetId,auctionHouseId) =>object
Get the commodities of an auction house.
Parameters
rulesetId
number
The ruleset ID.
auctionHouseId
number
The auction house ID.
Returns
The auction house commodities. See AuctionHouseCommoditiesResponse.
_responseType?
optional_responseType?:AuctionHouseCommoditiesResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creature
creature: (
creatureId) =>object
Returns a creature by ID.
Parameters
creatureId
number
The creature ID.
Returns
The creature. See CreatureResponse.
_responseType?
optional_responseType?:CreatureResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureDisplayMedia
creatureDisplayMedia: (
creatureDisplayId) =>object
Returns media for a creature display by ID.
Parameters
creatureDisplayId
number
The creature display ID.
Returns
The creature display media. See CreatureDisplayMediaResponse.
_responseType?
optional_responseType?:CreatureDisplayMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureFamily
creatureFamily: (
creatureFamilyId) =>object
Returns a creature family by ID.
Parameters
creatureFamilyId
number
The creature family ID.
Returns
The creature family. See CreatureFamilyResponse.
_responseType?
optional_responseType?:CreatureFamilyResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureFamilyIndex
creatureFamilyIndex: () =>
object
Returns an index of creature families.
Returns
The creature family index. See CreatureFamilyIndexResponse.
_responseType?
optional_responseType?:CreatureFamilyIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureFamilyMedia
creatureFamilyMedia: (
creatureFamilyId) =>object
Returns media for a creature family by ID.
Parameters
creatureFamilyId
number
The creature family ID.
Returns
The creature family media. See CreatureFamilyMediaResponse.
_responseType?
optional_responseType?:CreatureFamilyMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureSearch
creatureSearch: (
options) =>object
Performs a search of creatures.
Parameters
options
The creature search parameters. See CreatureSearchParameters.
Returns
The creature search results. See CreatureSearchResponse.
_responseType?
optional_responseType?:CreatureSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<CreatureSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureType
creatureType: (
creatureTypeId) =>object
Returns a creature type by ID.
Parameters
creatureTypeId
number
The creature type ID.
Returns
The creature type. See CreatureTypeResponse.
_responseType?
optional_responseType?:CreatureTypeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
creatureTypeIndex
creatureTypeIndex: () =>
object
Returns an index of creature types.
Returns
The creature type index. See CreatureTypeIndexResponse.
_responseType?
optional_responseType?:CreatureTypeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guild
guild: (
nameSlug) =>object
Get a guild by its name slug.
Parameters
nameSlug
string
The slug of the guild's name.
Returns
The guild. See GuildResponse.
_responseType?
optional_responseType?:GuildResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildAchievements
guildAchievements: (
nameSlug) =>object
Get a guild's achievements by its name slug.
Parameters
nameSlug
string
The slug of the guild's name.
Returns
The guild's achievements. See GuildAchievementsResponse.
_responseType?
optional_responseType?:GuildAchievementsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildActivity
guildActivity: (
nameSlug) =>object
Get a guild's activity by its name slug.
Parameters
nameSlug
string
The slug of the guild's name.
Returns
The guild's activity. See GuildActivityResponse.
_responseType?
optional_responseType?:GuildActivityResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildCrestBorder
guildCrestBorder: (
borderId) =>object
Returns media for a guild crest border by ID.
Parameters
borderId
number
The guild crest border ID.
Returns
The guild crest border. See GuildCrestBorderEmblemResponse.
_responseType?
optional_responseType?:GuildCrestBorderEmblemResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildCrestComponentsIndex
guildCrestComponentsIndex: () =>
object
Returns an index of guild crest media.
Returns
The guild crest components index. See GuildCrestComponentsIndexResponse.
_responseType?
optional_responseType?:GuildCrestComponentsIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildCrestEmblem
guildCrestEmblem: (
emblemId) =>object
Returns media for a guild crest emblem by ID.
Parameters
emblemId
number
The guild crest emblem ID.
Returns
The guild crest emblem. See GuildCrestBorderEmblemResponse.
_responseType?
optional_responseType?:GuildCrestBorderEmblemResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guildRoster
guildRoster: (
nameSlug) =>object
Get a guild's roster by its name slug.
Parameters
nameSlug
string
The slug of the guild's name.
Returns
The guild's roster. See GuildRosterResponse.
_responseType?
optional_responseType?:GuildRosterResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
heirloom
heirloom: (
heirloomId) =>object
Get a heirloom by ID.
Parameters
heirloomId
number
The heirloom ID.
Returns
The heirloom. See HeirloomResponse.
_responseType?
optional_responseType?:HeirloomResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
heirloomIndex
heirloomIndex: () =>
object
Get the heirloom index.
Returns
The heirloom index. See HeirloomIndexResponse.
_responseType?
optional_responseType?:HeirloomIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
item
item: (
itemId) =>object
Get an item by ID.
Parameters
itemId
number
The item ID.
Returns
The item. See ItemResponse.
_responseType?
optional_responseType?:ItemResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearance
itemAppearance: (
appearanceId) =>object
Get an item appearance by ID.
Parameters
appearanceId
number
The item appearance ID.
Returns
The item appearance. See ItemAppearanceResponse.
_responseType?
optional_responseType?:ItemAppearanceResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearanceSearch
itemAppearanceSearch: (
options) =>object
Search for item appearances.
Parameters
options
ItemAppearanceSearchParameters
The search parameters. See ItemAppearanceSearchParameters.
Returns
The search results. See ItemAppearanceSearchResponse.
_responseType?
optional_responseType?:ItemAppearanceSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:ItemAppearanceSearchParameters
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearanceSet
itemAppearanceSet: (
appearanceSetId) =>object
Get an item appearance set by ID.
Parameters
appearanceSetId
number
The item appearance set ID.
Returns
The item appearance set. See ItemAppearanceSetResponse.
_responseType?
optional_responseType?:ItemAppearanceSetResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearanceSetIndex
itemAppearanceSetIndex: () =>
object
Get an item appearance set index.
Returns
The item appearance set index. See ItemAppearanceSetIndexResponse.
_responseType?
optional_responseType?:ItemAppearanceSetIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearanceSlot
itemAppearanceSlot: (
slotType) =>object
Get an item appearance slot by slot type.
Parameters
slotType
The item appearance slot type.
Returns
The item appearance slot. See ItemAppearanceSlotResponse.
_responseType?
optional_responseType?:ItemAppearanceSlotResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemAppearanceSlotIndex
itemAppearanceSlotIndex: () =>
object
Get an item appearance slot index.
Returns
The item appearance slot index. See ItemAppearanceSlotIndexResponse.
_responseType?
optional_responseType?:ItemAppearanceSlotIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemClass
itemClass: (
itemClassId) =>object
Get an item class by ID.
Parameters
itemClassId
number
The item class ID.
Returns
The item class. See ItemClassResponse.
_responseType?
optional_responseType?:ItemClassResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemClassIndex
itemClassIndex: () =>
object
Get an item class index.
Returns
The item class index. See ItemClassIndexResponse.
_responseType?
optional_responseType?:ItemClassIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemMedia
itemMedia: (
itemId) =>object
Get item media by ID.
Parameters
itemId
number
The item ID.
Returns
The item media. See ItemMediaResponse.
_responseType?
optional_responseType?:ItemMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemSearch
itemSearch: (
options) =>object
Search for items.
Parameters
options
The search parameters. See ItemSearchParameters.
Returns
The search results. See ItemSearchResponse.
_responseType?
optional_responseType?:ItemSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<ItemSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemSet
itemSet: (
itemSetId) =>object
Get an item set by ID.
Parameters
itemSetId
number
The item set ID.
Returns
The item set. See ItemSetResponse.
_responseType?
optional_responseType?:ItemSetResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemSetIndex
itemSetIndex: () =>
object
Get an item set index.
Returns
The item set index. See ItemSetIndexResponse.
_responseType?
optional_responseType?:ItemSetIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemSubclass
itemSubclass: (
itemClassId,itemSubclassId) =>object
Get an item subclass by ID.
Parameters
itemClassId
number
The item class ID.
itemSubclassId
number
The item subclass ID.
Returns
The item subclass. See ItemSubclassResponse.
_responseType?
optional_responseType?:ItemSubclassResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalEncounter
journalEncounter: (
journalEncounterId) =>object
Get a journal encounter by ID.
Parameters
journalEncounterId
number
The journal encounter ID.
Returns
The journal encounter. See JournalEncounterResponse.
_responseType?
optional_responseType?:JournalEncounterResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalEncounterIndex
journalEncounterIndex: () =>
object
Get the journal encounter index.
Returns
The journal encounter index. See JournalEncounterIndexResponse.
_responseType?
optional_responseType?:JournalEncounterIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalEncounterSearch
journalEncounterSearch: (
options) =>object
Search for journal encounters.
Parameters
options
JournalEncounterSearchParameters
The search parameters. See JournalEncounterSearchParameters.
Returns
The search results. See JournalEncounterSearchResponse.
_responseType?
optional_responseType?:JournalEncounterSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<JournalEncounterSearchParameters,"locale"|"instanceName">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalExpansion
journalExpansion: (
journalExpansionId) =>object
Get a journal expansion by ID.
Parameters
journalExpansionId
number
The journal expansion ID.
Returns
The journal expansion. See JournalExpansionResponse.
_responseType?
optional_responseType?:JournalExpansionResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalExpansionIndex
journalExpansionIndex: () =>
object
Get the journal expansion index.
Returns
The journal expansion index. See JournalExpansionIndexResponse.
_responseType?
optional_responseType?:JournalExpansionIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalInstance
journalInstance: (
journalInstanceId) =>object
Get a journal instance by ID.
Parameters
journalInstanceId
number
The journal instance ID.
Returns
The journal instance. See JournalInstanceResponse.
_responseType?
optional_responseType?:JournalInstanceResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalInstanceIndex
journalInstanceIndex: () =>
object
Get the journal instance index.
Returns
The journal instance index. See JournalInstanceIndexResponse.
_responseType?
optional_responseType?:JournalInstanceIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
journalInstanceMedia
journalInstanceMedia: (
journalInstanceId) =>object
Get journal instance media by ID.
Parameters
journalInstanceId
number
The journal instance ID.
Returns
The journal instance media. See JournalInstanceMediaResponse.
_responseType?
optional_responseType?:JournalInstanceMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
mediaSearch
mediaSearch: (
options) =>object
Search for media.
Parameters
options
The search parameters. See MediaSearchParameters.
Returns
The search results. See MediaSearchResponse.
_responseType?
optional_responseType?:MediaSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:MediaSearchParameters
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
mount
mount: (
mountId) =>object
Get a mount by ID.
Parameters
mountId
number
The mount ID.
Returns
The mount. See MountResponse.
_responseType?
optional_responseType?:MountResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
mountIndex
mountIndex: () =>
object
Get a mount index.
Returns
The mount index. See MountIndexResponse.
_responseType?
optional_responseType?:MountIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
mountSearch
mountSearch: (
options) =>object
Get a mount search.
Parameters
options
The search parameters. See MountSearchParameters.
Returns
The search results. See MountSearchResponse.
_responseType?
optional_responseType?:MountSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<MountSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pet
pet: (
petId) =>object
Get a pet by ID.
Parameters
petId
number
The pet ID.
Returns
The pet. See PetResponse.
_responseType?
optional_responseType?:PetResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
petAbility
petAbility: (
petAbilityId) =>object
Get a pet ability by ID.
Parameters
petAbilityId
number
The pet ability ID.
Returns
The pet ability. See PetAbilityResponse.
_responseType?
optional_responseType?:PetAbilityResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
petAbilityIndex
petAbilityIndex: () =>
object
Get a pet ability index.
Returns
The pet ability index. See PetAbilityIndexResponse.
_responseType?
optional_responseType?:PetAbilityIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
petAbilityMedia
petAbilityMedia: (
petAbilityId) =>object
Get pet ability media by ID.
Parameters
petAbilityId
number
The pet ability ID.
Returns
The pet ability media. See PetAbilityMediaResponse.
_responseType?
optional_responseType?:PetAbilityMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
petIndex
petIndex: () =>
object
Get a pet index.
Returns
The pet index. See PetIndexResponse.
_responseType?
optional_responseType?:PetIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
petMedia
petMedia: (
petId) =>object
Get pet media by ID.
Parameters
petId
number
The pet ID.
Returns
The pet media. See PetMediaResponse.
_responseType?
optional_responseType?:PetMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableClass
playableClass: (
playableClassId) =>object
Get a playable class by ID.
Parameters
playableClassId
number
The playable class ID.
Returns
The playable class. See PlayableClassResponse.
_responseType?
optional_responseType?:PlayableClassResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableClassIndex
playableClassIndex: () =>
object
Get a playable class index.
Returns
The playable class index. See PlayableClassIndexResponse.
_responseType?
optional_responseType?:PlayableClassIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableClassMedia
playableClassMedia: (
playableClassId) =>object
Get playable class media by ID.
Parameters
playableClassId
number
The playable class ID.
Returns
The playable class media. See PlayableClassMediaResponse.
_responseType?
optional_responseType?:PlayableClassMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableRace
playableRace: (
playableRaceId) =>object
Get a playable race by ID.
Parameters
playableRaceId
number
The playable race ID.
Returns
The playable race. See PlayableRaceResponse.
_responseType?
optional_responseType?:PlayableRaceResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableRaceIndex
playableRaceIndex: () =>
object
Get a playable race index.
Returns
The playable race index. See PlayableRaceIndexResponse.
_responseType?
optional_responseType?:PlayableRaceIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableSpecialization
playableSpecialization: (
specializationId) =>object
Get a playable specialization by ID.
Parameters
specializationId
number
The playable specialization ID.
Returns
The playable specialization. See PlayableSpecializationResponse.
_responseType?
optional_responseType?:PlayableSpecializationResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableSpecializationIndex
playableSpecializationIndex: () =>
object
Get a playable specialization index.
Returns
The playable specialization index. See PlayableSpecializationIndexResponse.
_responseType?
optional_responseType?:PlayableSpecializationIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
playableSpecializationMedia
playableSpecializationMedia: (
specializationId) =>object
Get playable specialization media by ID.
Parameters
specializationId
number
The playable specialization ID.
Returns
The playable specialization media. See PlayableSpecializationMediaResponse.
_responseType?
optional_responseType?:PlayableSpecializationMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
powerType
powerType: (
powerTypeId) =>object
Get a power type by ID.
Parameters
powerTypeId
number
The power type ID.
Returns
The power type. See PowerTypeResponse.
_responseType?
optional_responseType?:PowerTypeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
powerTypeIndex
powerTypeIndex: () =>
object
Get a power type index.
Returns
The power type index. See PowerTypeIndexResponse.
_responseType?
optional_responseType?:PowerTypeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
profession
profession: (
professionId) =>object
Get a profession by ID.
Parameters
professionId
number
The profession ID.
Returns
The profession. See ProfessionResponse.
_responseType?
optional_responseType?:ProfessionResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
professionIndex
professionIndex: () =>
object
Get a profession index.
Returns
The profession index. See ProfessionIndexResponse.
_responseType?
optional_responseType?:ProfessionIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
professionMedia
professionMedia: (
professionId) =>object
Get profession media by ID.
Parameters
professionId
number
The profession ID.
Returns
The profession media. See ProfessionMediaResponse.
_responseType?
optional_responseType?:ProfessionMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
professionSkillTier
professionSkillTier: (
professionId,skillTierId) =>object
Get a profession's skill tier by ID.
Parameters
professionId
number
The profession ID.
skillTierId
number
The skill tier ID.
Returns
The profession's skill tier. See ProfessionSkillTierResponse.
_responseType?
optional_responseType?:ProfessionSkillTierResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pvpTalent
pvpTalent: (
pvpTalentId) =>object
Get a PvP talent by ID.
Parameters
pvpTalentId
number
The PvP talent ID.
Returns
The PvP talent. See PvpTalentResponse.
_responseType?
optional_responseType?:PvpTalentResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pvpTalentIndex
pvpTalentIndex: () =>
object
Get a PvP talent index.
Returns
The PvP talent index. See PvpTalentIndexResponse.
_responseType?
optional_responseType?:PvpTalentIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pvpTalentSlots
pvpTalentSlots: (
playableClassId) =>object
Get a playable class's PvP talent slots by ID.
Parameters
playableClassId
number
The playable class ID.
Returns
The playable class's PvP talent slots. See PvpTalentSlotsResponse.
_responseType?
optional_responseType?:PvpTalentSlotsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
quest
quest: (
questId) =>object
Get a quest by ID.
Parameters
questId
number
The quest ID.
Returns
The quest. See QuestResponse.
_responseType?
optional_responseType?:QuestResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questArea
questArea: (
questAreaId) =>object
Get a quest area by ID.
Parameters
questAreaId
number
The quest area ID.
Returns
The quest area. See QuestAreaResponse.
_responseType?
optional_responseType?:QuestAreaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questAreaIndex
questAreaIndex: () =>
object
Get a quest area index.
Returns
The quest area index. See QuestAreaIndexResponse.
_responseType?
optional_responseType?:QuestAreaIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questCategory
questCategory: (
questCategoryId) =>object
Get a quest category by ID.
Parameters
questCategoryId
number
The quest category ID.
Returns
The quest category. See QuestCategoryResponse.
_responseType?
optional_responseType?:QuestCategoryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questCategoryIndex
questCategoryIndex: () =>
object
Get a quest category index.
Returns
The quest category index. See QuestCategoryIndexResponse.
_responseType?
optional_responseType?:QuestCategoryIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questIndex
questIndex: () =>
object
Get a quest index.
Returns
The quest index. See QuestIndexResponse.
_responseType?
optional_responseType?:QuestIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questType
questType: (
questTypeId) =>object
Get a quest type by ID.
Parameters
questTypeId
number
The quest type ID.
Returns
The quest type. See QuestTypeResponse.
_responseType?
optional_responseType?:QuestTypeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
questTypeIndex
questTypeIndex: () =>
object
Get a quest type index.
Returns
The quest type index. See QuestTypeIndexResponse.
_responseType?
optional_responseType?:QuestTypeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
recipe
recipe: (
recipeId) =>object
Get a recipe by ID.
Parameters
recipeId
number
The recipe ID.
Returns
The recipe. See RecipeResponse.
_responseType?
optional_responseType?:RecipeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
recipeMedia
recipeMedia: (
recipeId) =>object
Get recipe media by ID.
Parameters
recipeId
number
The recipe ID.
Returns
The recipe media. See RecipeMediaResponse.
_responseType?
optional_responseType?:RecipeMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
region
region: (
regionId) =>object
Get a region by ID.
Parameters
regionId
number
The region ID.
Returns
The region. See RegionResponse.
_responseType?
optional_responseType?:RegionResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
regionIndex
regionIndex: () =>
object
Get a region index.
Returns
The region index. See RegionIndexResponse.
_responseType?
optional_responseType?:RegionIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
reputationFaction
reputationFaction: (
reputationFactionId) =>object
Get a reputation faction by ID.
Parameters
reputationFactionId
number
The reputation faction ID.
Returns
The reputation faction. See ReputationFactionResponse.
_responseType?
optional_responseType?:ReputationFactionResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
reputationFactionIndex
reputationFactionIndex: () =>
object
Get a reputation faction index.
Returns
The reputation faction index. See ReputationFactionIndexResponse.
_responseType?
optional_responseType?:ReputationFactionIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
reputationTiers
reputationTiers: (
reputationTiersId) =>object
Get a reputation tier by ID.
Parameters
reputationTiersId
number
The reputation tier ID.
Returns
The reputation tier. See ReputationTiersResponse.
_responseType?
optional_responseType?:ReputationTiersResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
reputationTiersIndex
reputationTiersIndex: () =>
object
Get a reputation tier index.
Returns
The reputation tier index. See ReputationTiersIndexResponse.
_responseType?
optional_responseType?:ReputationTiersIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
ruleset
ruleset: (
rulesetId) =>object
Get a ruleset by ID.
Parameters
rulesetId
number
The ruleset ID.
Returns
The ruleset. See RulesetResponse.
_responseType?
optional_responseType?:RulesetResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
rulesetIndex
rulesetIndex: () =>
object
Get a ruleset index.
Returns
The ruleset index. See RulesetIndexResponse.
_responseType?
optional_responseType?:RulesetIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
spell
spell: (
spellId) =>object
Get a spell by ID.
Parameters
spellId
number
The spell ID.
Returns
The spell. See SpellResponse.
_responseType?
optional_responseType?:SpellResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
spellMedia
spellMedia: (
spellId) =>object
Get spell media by ID.
Parameters
spellId
number
The spell ID.
Returns
The spell media. See SpellMediaResponse.
_responseType?
optional_responseType?:SpellMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
spellSearch
spellSearch: (
options) =>object
Get a spell search.
Parameters
options
The spell search options. See SpellSearchParameters.
Returns
The spell search. See SpellSearchResponse.
_responseType?
optional_responseType?:SpellSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<SpellSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
talent
talent: (
talentId) =>object
Get a talent by ID.
Parameters
talentId
number
The talent ID.
Returns
The talent. See TalentResponse.
_responseType?
optional_responseType?:TalentResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
talentIndex
talentIndex: () =>
object
Get a talent index.
Returns
The talent index. See TalentIndexResponse.
_responseType?
optional_responseType?:TalentIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
talentTree
talentTree: (
talentTreeId,specId) =>object
Get a specialization talent tree by ID.
Parameters
talentTreeId
number
The talent tree ID.
specId
number
The playable specialization ID.
Returns
The specialization talent tree. See TalentTreeResponse.
_responseType?
optional_responseType?:TalentTreeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
talentTreeIndex
talentTreeIndex: () =>
object
Get a talent tree index.
Returns
The talent tree index. See TalentTreeIndexResponse.
_responseType?
optional_responseType?:TalentTreeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
talentTreeNodes
talentTreeNodes: (
talentTreeId) =>object
Get a class talent tree by ID.
Parameters
talentTreeId
number
The talent tree ID.
Returns
The class talent tree. See TalentTreeNodesResponse.
_responseType?
optional_responseType?:TalentTreeNodesResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
title
title: (
titleId) =>object
Get a title by ID.
Parameters
titleId
number
The title ID.
Returns
The title. See TitleResponse.
_responseType?
optional_responseType?:TitleResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
titleIndex
titleIndex: () =>
object
Get a title index.
Returns
The title index. See TitleIndexResponse.
_responseType?
optional_responseType?:TitleIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
toy
toy: (
toyId) =>object
Get a toy by ID.
Parameters
toyId
number
The toy ID.
Returns
The toy. See ToyResponse.
_responseType?
optional_responseType?:ToyResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
toyIndex
toyIndex: () =>
object
Get a toy index.
Returns
The toy index. See ToyIndexResponse.
_responseType?
optional_responseType?:ToyIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.