Documentation / @blizzard-api/wow / wow
Variable: wow
constwow:object
Defined in: wow/src/index.ts:193
The Blizzard API for World of Warcraft.
Type Declaration
accountCollectionsIndex
accountCollectionsIndex: (
token?) =>ProtectedResource<AccountCollectionsIndexResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountCollectionsIndexResponse>
an index of collection types for an account.
accountDecorCollection
accountDecorCollection: (
token?) =>ProtectedResource<AccountDecorCollectionResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountDecorCollectionResponse>
the housing decor an account has collected.
accountHeirloomsCollectionSummary
accountHeirloomsCollectionSummary: (
token?) =>ProtectedResource<AccountHeirloomsCollectionSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountHeirloomsCollectionSummaryResponse>
a summary of the heirlooms an account has obtained.
accountMountsCollectionSummary
accountMountsCollectionSummary: (
token?) =>ProtectedResource<AccountMountsCollectionSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountMountsCollectionSummaryResponse>
a summary of the mounts an account has obtained.
accountPetsCollectionSummary
accountPetsCollectionSummary: (
token?) =>ProtectedResource<AccountPetsCollectionSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountPetsCollectionSummaryResponse>
a summary of the battle pets an account has obtained.
accountProfileSummary
accountProfileSummary: (
token?) =>ProtectedResource<AccountProfileSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountProfileSummaryResponse>
a profile summary for an account.
accountToysCollectionSummary
accountToysCollectionSummary: (
token?) =>ProtectedResource<AccountToysCollectionSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountToysCollectionSummaryResponse>
a summary of the toys an account has obtained.
accountTransmogsCollectionSummary
accountTransmogsCollectionSummary: (
token?) =>ProtectedResource<AccountTransmogsCollectionSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
token?
string
Optional OAuth 2.0 access token; alternatively, scope the client with withUserToken.
Returns
ProtectedResource<AccountTransmogsCollectionSummaryResponse>
a summary of the transmog unlocks an account has obtained.
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.
auctions
auctions: (
connectedRealmId) =>object
Get auction house data for a connected realm.
Parameters
connectedRealmId
number
The ID of the connected realm.
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.
azeriteEssence
azeriteEssence: (
azeriteEssenceId) =>object
Get an azerite essence by ID.
Parameters
azeriteEssenceId
number
The azerite essence ID.
Returns
The azerite essence. See AzeriteEssenceResponse.
_responseType?
optional_responseType?:AzeriteEssenceResponse
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.
azeriteEssenceIndex
azeriteEssenceIndex: () =>
object
Get an azerite essence index.
Returns
The azerite essence index. See AzeriteEssenceIndexResponse.
_responseType?
optional_responseType?:AzeriteEssenceIndexResponse
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.
azeriteEssenceMedia
azeriteEssenceMedia: (
azeriteEssenceId) =>object
Get azerite essence media by ID.
Parameters
azeriteEssenceId
number
The azerite essence ID.
Returns
The azerite essence media. See AzeriteEssenceMediaResponse.
_responseType?
optional_responseType?:AzeriteEssenceMediaResponse
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.
azeriteEssenceSearch
azeriteEssenceSearch: (
options) =>object
Search for azerite essences.
Parameters
options
AzeriteEssenceSearchParameters
The search parameters. See AzeriteEssenceSearchParameters.
Returns
The search results. See AzeriteEssenceSearchResponse.
_responseType?
optional_responseType?:AzeriteEssenceSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:AzeriteEssenceSearchParameters
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterAchievementsSummary
characterAchievementsSummary: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the achievements a character has completed.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a character's statistics as they pertain to achievements.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's appearance settings.
_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.
characterCollectionDecor
characterCollectionDecor: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the housing decor a character has collected.
_responseType?
optional_responseType?:CharacterCollectionDecorResponse
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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
an index of collection types for a character.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a list of quests that a character has completed.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's completed dungeons.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's encounters.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the items equipped by a character.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the heirlooms a character has obtained.
_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.
characterHouse
characterHouse: (
realmSlug,characterName,houseNumber) =>object
Get a summary of a house a character has built.
Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even for characters that own a house. The helper is kept for when it returns; the response type is unverified.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
houseNumber
number
The number of the character's house (e.g. 1 for house-1).
Returns
The character's house. See CharacterHouseResponse.
_responseType?
optional_responseType?:CharacterHouseResponse
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.
See
https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
characterHunterPetsSummary
characterHunterPetsSummary: (
realmSlug,characterName) =>object
If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the character's hunter pets.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the media assets available for a character (such as an avatar render).
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the mounts a character has obtained.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
Returns the Mythic Keystone season details for a character. Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
_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.
characterMythicKeystoneSeasonDetails
characterMythicKeystoneSeasonDetails: (
realmSlug,characterName,seasonId) =>object
Returns the Mythic Keystone season details for a character. Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
seasonId
number
The ID of the season.
Returns
the Mythic Keystone season details for a character.
_responseType?
optional_responseType?:CharacterMythicKeystoneSeasonDetailsResponse
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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the battle pets a character has obtained.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the professions for a character.
_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: (
realmSlug,characterName) =>object
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:
- an HTTP 404 Not Found error is returned
- the is_valid value is false
- the returned character ID doesn't match the previously recorded value for the character
The following example illustrates how to use this endpoint:
- A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
- After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
- If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
- If the character is valid and the character IDs match, the client retains the data for another 30 days.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
the status of the character profile for a character.
_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: (
realmSlug,characterName) =>object
Returns a summary of the character profile for a character.
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the character profile for a character.
_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.
characterPvpBracketStatistics
characterPvpBracketStatistics: (
realmSlug,characterName,bracketId) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
bracketId
"3v3" | "2v2" | `shuffle-${string}-${string}` | "rbg"
The ID of the PvP bracket.
Returns
a PvP bracket statistics for a character.
_responseType?
optional_responseType?:CharacterPvpBracketStatisticsResponse
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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a PvP summary for a character.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a character's active quests as well as a link to the character's completed quests.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's completed raids.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's reputations.
_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.
characterSoulbinds
characterSoulbinds: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a character's soulbinds.
_responseType?
optional_responseType?:CharacterSoulbindsResponse
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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of a character's specializations.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a statistics summary for a character.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of titles a character has obtained.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the toys a character has obtained.
_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: (
realmSlug,characterName) =>object
Parameters
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
a summary of the transmog unlocks a character has obtained.
_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: () =>
object
Get auction house data for all connected realms.
Returns
The auction house data. See AuctionHouseResponse.
_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.
conduit
conduit: (
conduitId) =>object
Get a conduit by ID.
Parameters
conduitId
number
The conduit ID.
Returns
The conduit. See ConduitResponse.
_responseType?
optional_responseType?:ConduitResponse
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.
conduitIndex
conduitIndex: () =>
object
Get a conduit index.
Returns
The conduit index. See ConduitIndexResponse.
_responseType?
optional_responseType?:ConduitIndexResponse
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.
connectedRealm
connectedRealm: (
connectedRealmId) =>object
Get a connected realm by ID.
Parameters
connectedRealmId
number
The connected realm ID.
Returns
The connected realm. See ConnectedRealmResponse.
_responseType?
optional_responseType?:ConnectedRealmResponse
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.
connectedRealmIndex
connectedRealmIndex: () =>
object
Get a connected realm index.
Returns
The connected realm index. See ConnectedRealmIndexResponse.
_responseType?
optional_responseType?:ConnectedRealmIndexResponse
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.
connectedRealmSearch
connectedRealmSearch: (
options) =>object
Search for connected realms.
Parameters
options
ConnectedRealmSearchParameters
The search parameters. See ConnectedRealmSearchParameters.
Returns
The search results. See ConnectedRealmSearchResponse.
_responseType?
optional_responseType?:ConnectedRealmSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:ConnectedRealmSearchParameters
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
covenant
covenant: (
covenantId) =>object
Get a covenant by ID.
Parameters
covenantId
number
The covenant ID.
Returns
The covenant. See CovenantResponse.
_responseType?
optional_responseType?:CovenantResponse
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.
covenantIndex
covenantIndex: () =>
object
Get a covenant index.
Returns
The covenant index. See CovenantIndexResponse.
_responseType?
optional_responseType?:CovenantIndexResponse
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.
covenantMedia
covenantMedia: (
covenantId) =>object
Get covenant media by ID.
Parameters
covenantId
number
The covenant ID.
Returns
The covenant media. See CovenantMediaResponse.
_responseType?
optional_responseType?:CovenantMediaResponse
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
Get 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
Get creature display media 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
Get 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
Get a creature family index.
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
Get creature family media 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
Search for 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
Get 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
Get a creature type index.
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.
decor
decor: (
decorId) =>object
Returns a decor by ID.
Parameters
decorId
number
The decor ID.
Returns
A decor. See DecorResponse.
_responseType?
optional_responseType?:DecorResponse
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.
decorIndex
decorIndex: () =>
object
Returns an index of decor.
Returns
An index of decor. See DecorIndexResponse.
_responseType?
optional_responseType?:DecorIndexResponse
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.
decorSearch
decorSearch: (
options) =>object
Searches for decor.
Parameters
options
The search parameters. See GenericDecorSearchParameters.
Returns
A decor. See DecorSearchResponse.
_responseType?
optional_responseType?:DecorSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<GenericDecorSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
fixture
fixture: (
fixtureId) =>object
Returns a fixture by ID.
Parameters
fixtureId
number
The fixture ID.
Returns
A fixture. See FixtureResponse.
_responseType?
optional_responseType?:FixtureResponse
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.
fixtureHook
fixtureHook: (
fixtureHookId) =>object
Returns a fixture hook by ID.
Parameters
fixtureHookId
number
The fixture hook ID.
Returns
A fixture hook. See FixtureHookResponse.
_responseType?
optional_responseType?:FixtureHookResponse
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.
fixtureHookIndex
fixtureHookIndex: () =>
object
Returns an index of fixture hooks.
Returns
An index of fixture hooks. See FixtureHookIndexResponse.
_responseType?
optional_responseType?:FixtureHookIndexResponse
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.
fixtureHookSearch
fixtureHookSearch: (
options) =>object
Searches for fixture hooks.
Parameters
options
The search parameters. See GenericDecorSearchParameters.
Returns
A fixture hook. See FixtureSearchResponse.
_responseType?
optional_responseType?:FixtureHookSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<GenericDecorSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
fixtureIndex
fixtureIndex: () =>
object
Returns an index of fixtures.
Returns
An index of fixtures. See FixtureIndexResponse.
_responseType?
optional_responseType?:FixtureIndexResponse
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.
fixtureSearch
fixtureSearch: (
options) =>object
Searches for fixtures.
Parameters
options
The search parameters. See GenericDecorSearchParameters.
Returns
A fixture. See FixtureSearchResponse.
_responseType?
optional_responseType?:FixtureSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<GenericDecorSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guild
guild: (
realmSlug,nameSlug) =>object
Parameters
realmSlug
string
The slug of the realm.
nameSlug
string
The lowercase name of the guild.
Returns
a single guild by its name and realm.
_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: (
realmSlug,nameSlug) =>object
Parameters
realmSlug
string
The slug of the realm.
nameSlug
string
The lowercase name of the guild.
Returns
a single guild's achievements by name and realm.
_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: (
realmSlug,nameSlug) =>object
Parameters
realmSlug
string
The slug of the realm.
nameSlug
string
The lowercase name of the guild.
Returns
a single guild's activity by name and realm.
_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
Get 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
Get the guild crest components index.
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
Get 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: (
realmSlug,nameSlug) =>object
Parameters
realmSlug
string
The slug of the realm.
nameSlug
string
The lowercase name of the guild.
Returns
a single guild's roster by its name and realm.
_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.
modifiedCraftingCategory
modifiedCraftingCategory: (
modifiedCraftingCategoryId) =>object
Get a modified crafting category by ID.
Parameters
modifiedCraftingCategoryId
number
The modified crafting category ID.
Returns
The modified crafting category. See ModifiedCraftingCategoryResponse.
_responseType?
optional_responseType?:ModifiedCraftingCategoryResponse
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.
modifiedCraftingCategoryIndex
modifiedCraftingCategoryIndex: () =>
object
Get a modified crafting category index.
Returns
The modified crafting category index. See ModifiedCraftingCategoryIndexResponse.
_responseType?
optional_responseType?:ModifiedCraftingCategoryIndexResponse
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.
modifiedCraftingIndex
modifiedCraftingIndex: () =>
object
Get a modified crafting index.
Returns
The modified crafting index. See ModifiedCraftingIndexResponse.
_responseType?
optional_responseType?:ModifiedCraftingIndexResponse
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.
modifiedCraftingReagentSlotType
modifiedCraftingReagentSlotType: (
modifiedCraftingReagentSlotTypeId) =>object
Get a modified crafting reagent slot type by ID.
Parameters
modifiedCraftingReagentSlotTypeId
number
The modified crafting reagent slot type ID.
Returns
The modified crafting reagent slot type. See ModifiedCraftingReagentSlotTypeResponse.
_responseType?
optional_responseType?:ModifiedCraftingReagentSlotTypeResponse
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.
modifiedCraftingReagentSlotTypeIndex
modifiedCraftingReagentSlotTypeIndex: () =>
object
Get a modified crafting reagent slot type index.
Returns
The modified crafting reagent slot type index. See ModifiedCraftingReagentSlotTypeIndexResponse.
_responseType?
optional_responseType?:ModifiedCraftingReagentSlotTypeIndexResponse
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.
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.
mythicKeystoneAffix
mythicKeystoneAffix: (
mythicKeystoneAffixId) =>object
Get a list of all Mythic Keystone affixes.
Parameters
mythicKeystoneAffixId
number
The ID of the Mythic Keystone affix.
Returns
A list of all Mythic Keystone affixes. See MythicKeystoneAffixIndexResponse
_responseType?
optional_responseType?:MythicKeystoneAffixResponse
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.
mythicKeystoneAffixIndex
mythicKeystoneAffixIndex: () =>
object
Get a list of all Mythic Keystone affixes.
Returns
A list of all Mythic Keystone affixes. See MythicKeystoneAffixIndexResponse
_responseType?
optional_responseType?:MythicKeystoneAffixIndexResponse
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.
mythicKeystoneAffixMedia
mythicKeystoneAffixMedia: (
mythicKeystoneAffixId) =>object
Get a list of all Mythic Keystone affix media.
Parameters
mythicKeystoneAffixId
number
The ID of the Mythic Keystone affix.
Returns
A list of all Mythic Keystone affix media. See MythicKeystoneAffixMediaResponse
_responseType?
optional_responseType?:MythicKeystoneAffixMediaResponse
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.
mythicKeystoneDungeon
mythicKeystoneDungeon: (
mythicKeystoneDungeonId) =>object
Get a Mythic Keystone dungeon by ID.
Parameters
mythicKeystoneDungeonId
number
The Mythic Keystone dungeon ID.
Returns
The Mythic Keystone dungeon. See MythicKeystoneDungeonResponse.
_responseType?
optional_responseType?:MythicKeystoneDungeonResponse
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.
mythicKeystoneDungeonIndex
mythicKeystoneDungeonIndex: () =>
object
Get a Mythic Keystone dungeon index.
Returns
The Mythic Keystone dungeon index. See MythicKeystoneDungeonIndexResponse.
_responseType?
optional_responseType?:MythicKeystoneDungeonIndexResponse
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.
mythicKeystoneIndex
mythicKeystoneIndex: () =>
object
Get a Mythic Keystone index.
Returns
The Mythic Keystone index. See MythicKeystoneIndexResponse.
_responseType?
optional_responseType?:MythicKeystoneIndexResponse
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.
mythicKeystoneLeaderboard
mythicKeystoneLeaderboard: (
connectedRealmId,dungeonId,period) =>object
Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
Parameters
connectedRealmId
number
The connected realm ID.
dungeonId
number
The dungeon ID.
period
number
The period ID.
Returns
The Mythic Keystone leaderboard. See MythicKeystoneLeaderboardResponse.
_responseType?
optional_responseType?:MythicKeystoneLeaderboardResponse
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.
mythicKeystoneLeaderboardIndex
mythicKeystoneLeaderboardIndex: (
connectedRealmId) =>object
Get a Mythic Keystone leaderboard index by connected realm ID.
Parameters
connectedRealmId
number
The connected realm ID.
Returns
The Mythic Keystone leaderboard index. See MythicKeystoneLeaderboardIndexResponse.
_responseType?
optional_responseType?:MythicKeystoneLeaderboardIndexResponse
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.
mythicKeystonePeriod
mythicKeystonePeriod: (
mythicKeystonePeriodId) =>object
Get a Mythic Keystone period by ID.
Parameters
mythicKeystonePeriodId
number
The Mythic Keystone period ID.
Returns
The Mythic Keystone period. See MythicKeystonePeriodResponse.
_responseType?
optional_responseType?:MythicKeystonePeriodResponse
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.
mythicKeystonePeriodIndex
mythicKeystonePeriodIndex: () =>
object
Get a Mythic Keystone period index.
Returns
The Mythic Keystone period index. See MythicKeystonePeriodIndexResponse.
_responseType?
optional_responseType?:MythicKeystonePeriodIndexResponse
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.
mythicKeystoneSeason
mythicKeystoneSeason: (
mythicKeystoneSeasonId) =>object
Get a Mythic Keystone season by ID.
Parameters
mythicKeystoneSeasonId
number
The Mythic Keystone season ID.
Returns
The Mythic Keystone season. See MythicKeystoneSeasonResponse.
_responseType?
optional_responseType?:MythicKeystoneSeasonResponse
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.
mythicKeystoneSeasonIndex
mythicKeystoneSeasonIndex: () =>
object
Get a Mythic Keystone season index.
Returns
The Mythic Keystone season index. See MythicKeystoneSeasonIndexResponse.
_responseType?
optional_responseType?:MythicKeystoneSeasonIndexResponse
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.
mythicRaidLeaderboard
mythicRaidLeaderboard: (
raid,faction) =>object
Get a Mythic Raid leaderboard by raid and faction.
Parameters
raid
The slug of the raid.
faction
"alliance" | "horde"
The faction. Either 'alliance' or 'horde'.
Returns
The Mythic Raid leaderboard. See MythicRaidLeaderboardResponse.
_responseType?
optional_responseType?:MythicRaidLeaderboardResponse
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.
neighborhood
neighborhood: (
neighborhoodMapId,neighborhoodId) =>object
Get a neighborhood within a neighborhood map by ID.
Parameters
neighborhoodMapId
number
The neighborhood map ID.
neighborhoodId
number
The neighborhood ID.
Returns
The neighborhood. See NeighborhoodResponse.
_responseType?
optional_responseType?:NeighborhoodResponse
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.
neighborhoodMap
neighborhoodMap: (
neighborhoodMapId) =>object
Get a neighborhood map by ID.
Parameters
neighborhoodMapId
number
The neighborhood map ID.
Returns
The neighborhood map. See NeighborhoodMapResponse.
_responseType?
optional_responseType?:NeighborhoodMapResponse
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.
neighborhoodMaps
neighborhoodMaps: () =>
object
Get an index of neighborhood maps.
Returns
The neighborhood map index. See NeighborhoodMapIndexResponse.
_responseType?
optional_responseType?:NeighborhoodMapIndexResponse
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.
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 a 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 a 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 a 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.
protectedCharacterProfileSummary
protectedCharacterProfileSummary: (
realmId,characterId,token) =>ProtectedResource<ProtectedCharacterProfileSummaryResponse>
Because this endpoint provides data about the current logged-in user's World of Warcraft account, it requires an access token with the wow.profile scope acquired via the Authorization Code Flow. See https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
Parameters
realmId
number
The realm ID.
characterId
number
The character ID.
token
string
The OAuth 2.0 access token to use for authentication.
Returns
ProtectedResource<ProtectedCharacterProfileSummaryResponse>
a protected profile summary for a character.
pvpLeaderboard
pvpLeaderboard: (
pvpSeasonId,bracket) =>object
Get a PvP leaderboard by PvP season ID and bracket.
Parameters
pvpSeasonId
number
The PvP season ID.
bracket
string
The PvP bracket.
Returns
The PvP leaderboard. See PvpLeaderboardResponse.
_responseType?
optional_responseType?:PvpLeaderboardResponse
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.
pvpLeaderboardIndex
pvpLeaderboardIndex: (
pvpSeasonId) =>object
Get a PvP leaderboard index by PvP season ID.
Parameters
pvpSeasonId
number
The PvP season ID.
Returns
The PvP leaderboard index. See PvpLeaderboardIndexResponse.
_responseType?
optional_responseType?:PvpLeaderboardIndexResponse
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.
pvpRewardsIndex
pvpRewardsIndex: (
pvpSeasonId) =>object
Get a PvP reward index by PvP season ID.
Parameters
pvpSeasonId
number
The PvP season ID.
Returns
The PvP reward index. See PvpRewardsIndexResponse.
_responseType?
optional_responseType?:PvpRewardsIndexResponse
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.
pvpSeason
pvpSeason: (
pvpSeasonId) =>object
Get a PvP season by ID.
Parameters
pvpSeasonId
number
The PvP season ID.
Returns
The PvP season. See PvpSeasonResponse.
_responseType?
optional_responseType?:PvpSeasonResponse
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.
pvpSeasonIndex
pvpSeasonIndex: () =>
object
Get a PvP season index.
Returns
The PvP season index. See PvpSeasonIndexResponse.
_responseType?
optional_responseType?:PvpSeasonIndexResponse
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.
pvpTier
pvpTier: (
pvpTierId) =>object
Get a PvP tier by ID.
Parameters
pvpTierId
number
The PvP tier ID.
Returns
The PvP tier. See PvpTierResponse.
_responseType?
optional_responseType?:PvpTierResponse
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.
pvpTierIndex
pvpTierIndex: () =>
object
Get a PvP tier index.
Returns
The PvP tier index. See PvpTierIndexResponse.
_responseType?
optional_responseType?:PvpTierIndexResponse
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.
pvpTierMedia
pvpTierMedia: (
pvpTierId) =>object
Get PvP tier media by ID.
Parameters
pvpTierId
number
The PvP tier ID.
Returns
The PvP tier media. See PvpTierMediaResponse.
_responseType?
optional_responseType?:PvpTierMediaResponse
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.
realm
realm: (
realmSlug) =>object
Get a realm by slug.
Parameters
realmSlug
string
The realm slug.
Returns
The realm. See RealmResponse.
_responseType?
optional_responseType?:RealmResponse
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.
realmIndex
realmIndex: () =>
object
Get a realm index.
Returns
The realm index. See RealmIndexResponse.
_responseType?
optional_responseType?:RealmIndexResponse
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.
realmSearch
realmSearch: (
options) =>object
Search for realms.
Parameters
options
The search parameters. See RealmSearchParameters.
Returns
The search results. See RealmSearchResponse.
_responseType?
optional_responseType?:RealmSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:RealmSearchParameters
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.
room
room: (
roomId) =>object
Returns a room by ID.
Parameters
roomId
number
The room ID.
Returns
A room. See RoomResponse.
_responseType?
optional_responseType?:RoomResponse
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.
roomIndex
roomIndex: () =>
object
Returns an index of rooms.
Returns
An index of rooms. See RoomIndexReponse.
_responseType?
optional_responseType?:RoomIndexReponse
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.
roomSearch
roomSearch: (
options) =>object
Searches for rooms.
Parameters
options
The search parameters. See GenericDecorSearchParameters.
Returns
A room. See RoomSearchResponse.
_responseType?
optional_responseType?:RoomSearchResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Omit<GenericDecorSearchParameters,"name"|"locale">
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
soulbind
soulbind: (
soulbindId) =>object
Get a soulbind by ID.
Parameters
soulbindId
number
The soulbind ID.
Returns
The soulbind. See SoulbindResponse.
_responseType?
optional_responseType?:SoulbindResponse
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.
soulbindIndex
soulbindIndex: () =>
object
Get a soulbind index.
Returns
The soulbind index. See SoulbindIndexResponse.
_responseType?
optional_responseType?:SoulbindIndexResponse
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 talent tree by ID.
Parameters
talentTreeId
number
The talent tree ID.
specId
number
The playable specialization ID.
Returns
The 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 talent tree nodes by talent tree ID.
Parameters
talentTreeId
number
The talent tree ID.
Returns
The talent tree nodes. 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.
techTalent
techTalent: (
techTalentId) =>object
Get a tech talent by ID.
Parameters
techTalentId
number
The tech talent ID.
Returns
The tech talent. See TechTalentResponse.
_responseType?
optional_responseType?:TechTalentResponse
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.
techTalentIndex
techTalentIndex: () =>
object
Get a tech talent index.
Returns
The tech talent index. See TechTalentIndexResponse.
_responseType?
optional_responseType?:TechTalentIndexResponse
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.
techTalentMedia
techTalentMedia: (
techTalentId) =>object
Get tech talent media by ID.
Parameters
techTalentId
number
The tech talent ID.
Returns
The tech talent media. See TechTalentMediaResponse.
_responseType?
optional_responseType?:TechTalentMediaResponse
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.
techTalentTree
techTalentTree: (
techTalentTreeId) =>object
Get a tech talent tree by ID.
Parameters
techTalentTreeId
number
The tech talent tree ID.
Returns
The tech talent tree. See TechTalentTreeResponse.
_responseType?
optional_responseType?:TechTalentTreeResponse
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.
techTalentTreeIndex
techTalentTreeIndex: () =>
object
Get a tech talent tree index.
Returns
The tech talent tree index. See TechTalentTreeIndexResponse.
_responseType?
optional_responseType?:TechTalentTreeIndexResponse
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.
wowToken
wowToken: () =>
object
Get the current WoW token price.
Returns
The WoW token price. See WowTokenResponse.
_responseType?
optional_responseType?:WowTokenResponse
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.