Documentation / @blizzard-api/classic-wow / classicWow
Variable: classicWow
constclassicWow:object
Defined in: classic-wow/src/index.ts:70
Type Declaration
achievement
achievement: (
namespace,achievementId) =>object
Get an achievement by ID.
Supported by all Classic namespaces: classic1x, classicann, and classic.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,achievementCategoryId) =>object
Get an achievement category by ID.
Supported by all Classic namespaces: classic1x, classicann, and classic.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get the achievement category index.
Supported by all Classic namespaces: classic1x, classicann, and classic. classic1x responses omit guild_categories.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get the achievement index.
Supported by all Classic namespaces: classic1x, classicann, and classic.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,achievementId) =>object
Get achievement media by ID.
Supported by all Classic namespaces: classic1x, classicann, and classic.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
achievementId
number
The achievement ID.
Returns
The achievement media. See AchievementMediaResponse.
_responseType?
optional_responseType?:AchievementMediaResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
auctionHouseIndex
auctionHouseIndex: (
namespace,connectedRealmId) =>object
Returns an index of auction houses for a connected realm.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
connectedRealmId
number
The ID of the connected realm.
Returns
The auction house index. See AuctionHouseIndexResponse.
_responseType?
optional_responseType?:AuctionHouseIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
auctions
auctions: (
namespace,connectedRealmId,auctionHouseId) =>object
Returns all active auctions for a specific auction house on a connected realm.
Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
connectedRealmId
number
The ID of the connected realm.
auctionHouseId
number
The ID of the auction house.
Returns
The auction house data. See AuctionsResponse.
_responseType?
optional_responseType?:AuctionsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterAchievementsSummary
characterAchievementsSummary: (
namespace,realmSlug,characterName) =>object
Parameters
namespace
"profile-classic"
The namespace to use. See BlizzardNamespaces. Note: This API is not supported for classic era or anniversary realms.
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: (
namespace,realmSlug,characterName) =>object
Parameters
namespace
"profile-classic"
The namespace to use. See BlizzardNamespaces. Note: This API is not supported for classic era or anniversary realms.
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.
characterEquipmentSummary
characterEquipmentSummary: (
namespace,realmSlug,characterName) =>object
Returns a summary of the items equipped by a character.
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
realmSlug
string
The realm slug.
characterName
string
The character name.
Returns
The character equipment summary.
_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.
characterHunterPetsSummary
characterHunterPetsSummary: (
namespace,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
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: (
namespace,realmSlug,characterName) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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.
characterProfileStatus
characterProfileStatus: (
namespace,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
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: (
namespace,realmSlug,characterName) =>object
Returns a summary of the character profile for a character.
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: (
namespace,realmSlug,characterName,pvpBracket) =>object
Get a character's PvP bracket statistics.
Only available for the classic (progression) namespace.
Parameters
namespace
"profile-classic"
The namespace to use. See ProfileClassicNamespaces.
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
pvpBracket
string
The PvP bracket (for example 2v2, 3v3, or rbg).
Returns
The character's PvP bracket statistics. See CharacterPvpBracketStatisticsResponse.
_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.
characterReputationsSummary
characterReputationsSummary: (
namespace,realmSlug,characterName) =>object
Get a summary of a character's reputations.
Currently supported in the profile-classicann namespace. The classic1x and classic namespaces return 404 for valid character profiles.
Parameters
namespace
"profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
realmSlug
string
The slug of the realm.
characterName
string
The lowercase name of the character.
Returns
The character's reputations summary. See CharacterReputationsSummaryResponse.
_responseType?
optional_responseType?:CharacterReputationsSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterSpecializationsSummary
characterSpecializationsSummary: (
namespace,realmSlug,characterName) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: (
namespace,realmSlug,characterName) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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.
connectedRealm
connectedRealm: (
namespace,connectedRealmId) =>object
Returns a connected realm by ID.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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.
connectedRealmAuctions
connectedRealmAuctions: (
namespace,connectedRealmId) =>object
Returns all active auctions for a connected realm.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
connectedRealmId
number
The connected realm ID.
Returns
The connected realm auctions. See ConnectedRealmAuctionsResponse.
_responseType?
optional_responseType?:ConnectedRealmAuctionsResponse
Internal
The response type of 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: (
namespace) =>object
Returns an index of connected realms.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace,options) =>object
Performs a search of connected realms.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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.
creature
creature: (
namespace,creatureId) =>object
Returns a creature by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,creatureDisplayId) =>object
Returns media for a creature display by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,creatureFamilyId) =>object
Returns a creature family by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Returns an index of creature families.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,creatureFamilyId) =>object
Returns media for a creature family by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,options) =>object
Performs a search of creatures.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,creatureTypeId) =>object
Returns a creature type by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Returns an index of creature types.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
Returns
The creature type index. See CreatureTypeIndexResponse.
_responseType?
optional_responseType?:CreatureTypeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
guild
guild: (
namespace,realmSlug,nameSlug) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: <
T>(namespace,realmSlug,nameSlug) =>object
Type Parameters
T
T extends "profile-classic1x" | "profile-classic" | "profile-classicann"
Parameters
namespace
T
The namespace to use. See ProfileClassicNamespaces.
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?:Textends"profile-classic1x"|"profile-classicann"?GuildAchievementsClassicEraResponse: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: (
namespace,realmSlug,nameSlug) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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: (
namespace,borderId) =>object
Returns media for a guild crest border by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Returns an index of guild crest media.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,emblemId) =>object
Returns media for a guild crest emblem by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,realmSlug,nameSlug) =>object
Parameters
namespace
"profile-classic1x" | "profile-classic" | "profile-classicann"
The namespace to use. See ProfileClassicNamespaces.
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.
item
item: (
namespace,itemId) =>object
Get an item by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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.
itemClass
itemClass: (
namespace,itemClassId) =>object
Get an item class by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get an item class index.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,itemId) =>object
Get item media by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,options) =>object
Search for items.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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.
itemSubclass
itemSubclass: (
namespace,itemClassId,itemSubclassId) =>object
Get an item subclass by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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.
mediaSearch
mediaSearch: (
namespace,options) =>object
Search for media.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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.
mythicKeystoneLeaderboard
mythicKeystoneLeaderboard: (
namespace,connectedRealmId,dungeonId,period) =>object
Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace,connectedRealmId) =>object
Get a Mythic Keystone leaderboard index by connected realm ID.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace,mythicKeystonePeriodId) =>object
Get a Mythic Keystone period by ID.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace) =>object
Get the Mythic Keystone period index.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace,mythicKeystoneSeasonId) =>object
Get a Mythic Keystone season by ID.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace) =>object
Get the Mythic Keystone season index.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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.
playableClass
playableClass: (
namespace,playableClassId) =>object
Get a playable class by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get a playable class index.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,playableClassId) =>object
Get playable class media by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,playableRaceId) =>object
Get a playable race by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get a playable race index.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,specializationId) =>object
Get a playable specialization by ID.
Only available for the classic (progression) namespace.
Parameters
namespace
"static-classic"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get the playable specialization index.
Only available for the classic (progression) namespace.
Parameters
namespace
"static-classic"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,specializationId) =>object
Get playable specialization media by ID.
Only available for the classic (progression) namespace.
Parameters
namespace
"static-classic"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace,powerTypeId) =>object
Get a power type by ID.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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: (
namespace) =>object
Get a power type index.
Parameters
namespace
"static-classic1x" | "static-classic" | "static-classicann"
The namespace to use. See StaticClassicNamespaces.
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.
pvpLeaderboard
pvpLeaderboard: (
namespace,pvpRegionId,pvpSeasonId,pvpBracket) =>object
Get a PvP leaderboard by PvP season ID and bracket.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
pvpRegionId
number
The PvP region ID.
pvpSeasonId
number
The PvP season ID.
pvpBracket
string
The PvP bracket.
Returns
The PvP leaderboard.
_responseType?
optional_responseType?:unknown
Internal
The response type of 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: (
namespace,pvpRegionId,pvpSeasonId) =>object
Returns an index of PvP leaderboards for a PvP season in a given PvP region.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
pvpRegionId
number
The PvP region ID.
pvpSeasonId
number
The PvP season ID.
Returns
The PvP leaderboard index.
_responseType?
optional_responseType?:unknown
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pvpRegionalSeason
pvpRegionalSeason: (
namespace,pvpRegionId,pvpSeasonId) =>object
Returns a PvP season by region ID and season ID.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
pvpRegionId
number
The PvP region ID.
pvpSeasonId
number
The PvP season ID.
Returns
The PvP season.
_responseType?
optional_responseType?:unknown
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
pvpRegionalSeasonIndex
pvpRegionalSeasonIndex: (
namespace,pvpRegionId) =>object
Returns an index of PvP Seasons in a PvP region.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
pvpRegionId
number
The PvP region ID.
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.
pvpRegionIndex
pvpRegionIndex: (
namespace) =>object
Returns an index of PvP Regions.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
Returns
The PvP region index.
_responseType?
optional_responseType?:unknown
Internal
The response type of 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: (
namespace,pvpRegionId,pvpSeasonId) =>object
Returns an index of PvP rewards for a PvP season in a given PvP region.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
pvpRegionId
number
The PvP region ID.
pvpSeasonId
number
The PvP season ID.
Returns
The PvP reward index.
_responseType?
optional_responseType?:unknown
Internal
The response type of 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: (
namespace,pvpSeasonId) =>object
Get a PvP season by ID.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace) =>object
Get a PvP season index.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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.
pvpSeasonLeaderboard
pvpSeasonLeaderboard: (
namespace,pvpSeasonId,pvpBracket) =>object
Get a PvP season leaderboard by PvP season ID and bracket.
Only available for the classic (progression) namespace. Classic responses omit entries when the bracket is empty.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
pvpSeasonId
number
The PvP season ID.
pvpBracket
string
The PvP bracket (for example 2v2, 3v3, or rbg).
Returns
The PvP season 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.
pvpSeasonLeaderboards
pvpSeasonLeaderboards: (
namespace,pvpSeasonId) =>object
Returns an index of PvP leaderboards for a PvP season.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
pvpSeasonId
number
The PvP season ID.
Returns
The PvP season 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.
pvpSeasonRewards
pvpSeasonRewards: (
namespace,pvpSeasonId) =>object
Returns an index of PvP rewards for a PvP season.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
pvpSeasonId
number
The PvP season ID.
Returns
The PvP season rewards 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.
realm
realm: (
namespace,realmSlug) =>object
Get a realm by slug.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace) =>object
Get a realm index.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace,options) =>object
Search for realms.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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.
region
region: (
namespace,regionId) =>object
Get a region by ID.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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: (
namespace) =>object
Get a region index.
Parameters
namespace
"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"
The namespace to use. See DynamicClassicNamespaces.
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.
wowToken
wowToken: (
namespace) =>object
Get the current WoW token price.
Only available for the classic (progression) namespace.
Parameters
namespace
"dynamic-classic"
The namespace to use. See DynamicClassicNamespaces.
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.