Documentation / @blizzard-api/d3 / d3
Variable: d3
constd3:object
Defined in: d3/src/index.ts:10
Type Declaration
account
account: (
battleTag) =>object
Returns the account information for the specified battle tag.
Parameters
battleTag
string
The battle tag of the account.
Returns
The account resource. See AccountResponse.
_responseType?
optional_responseType?:AccountResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
accountHero
accountHero: (
battleTag,heroId) =>object
Returns the hero information for the specified battle tag and hero ID.
Parameters
battleTag
string
The battle tag of the account.
heroId
number
The ID of the hero.
Returns
The hero resource. See AccountHeroResponse.
_responseType?
optional_responseType?:AccountHeroResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
accountHeroFollowerItems
accountHeroFollowerItems: (
battleTag,heroId) =>object
Returns the follower items for the specified battle tag and hero ID.
Parameters
battleTag
string
The battle tag of the account.
heroId
number
The ID of the hero.
Returns
The follower items resource. See AccountHeroFollowerItemsResponse.
_responseType?
optional_responseType?:AccountHeroFollowerItemsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
accountHeroItems
accountHeroItems: (
battleTag,heroId) =>object
Returns the items for the specified battle tag and hero ID.
Parameters
battleTag
string
The battle tag of the account.
heroId
number
The ID of the hero.
Returns
The hero items resource. See AccountHeroItemsResponse.
_responseType?
optional_responseType?:AccountHeroItemsResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
act
act: (
actId) =>object
Returns the act information for the specified act ID.
Parameters
actId
number
The ID of the act.
Returns
The act resource. See ActResponse.
_responseType?
optional_responseType?:ActResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
actIndex
actIndex: () =>
object
Returns the index of acts.
Returns
The act index resource. See ActIndexResponse.
_responseType?
optional_responseType?:ActIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
artisan
artisan: (
artisanSlug) =>object
Returns the artisan information for the specified artisan slug.
Parameters
artisanSlug
The slug of the artisan.
Returns
The artisan resource. See ArtisanResponse.
_responseType?
optional_responseType?:ArtisanResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
characterClass
characterClass: (
characterClassSlug) =>object
Returns the character class information for the specified character class slug.
Parameters
characterClassSlug
The slug of the character class.
Returns
The character class resource. See CharacterClassResponse.
_responseType?
optional_responseType?:CharacterClassResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
era
era: (
id) =>object
Returns the era information for the specified era ID.
Parameters
id
number
The ID of the era.
Returns
The era resource. See EraResponse.
_responseType?
optional_responseType?:EraResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
eraIndex
eraIndex: () =>
object
Returns the era index.
Returns
The era index resource. See EraIndexResponse.
_responseType?
optional_responseType?:EraIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
eraLeaderboard
eraLeaderboard: (
id,leaderboard) =>object
Returns the era leaderboard for the specified era ID and leaderboard.
Parameters
id
number
The ID of the era.
leaderboard
string
The name of the leaderboard.
Returns
The era leaderboard resource. See EraLeaderboardResponse.
_responseType?
optional_responseType?:EraLeaderboardResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
follower
follower: (
followerSlug) =>object
Returns the follower information for the specified follower slug.
Parameters
followerSlug
The slug of the follower.
Returns
The follower resource. See FollowerResponse.
_responseType?
optional_responseType?:FollowerResponse
Internal
The response type of 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: (
itemSlugAndId) =>object
Returns the item information for the specified item slug and ID.
Parameters
itemSlugAndId
string
The slug and ID of the item, example: "corrupted-ashbringer-Unique_Sword_2H_104_x1".
Returns
The item resource. 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.
itemType
itemType: (
itemTypeSlug) =>object
Returns the item type information for the specified item type slug.
Parameters
itemTypeSlug
string
The slug of the item type, example: "sword2h"
Returns
The item type resource. See ItemTypeResponse.
_responseType?
optional_responseType?:ItemTypeResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
itemTypeIndex
itemTypeIndex: () =>
object
Returns the item type index.
Returns
The item type index resource. See ItemTypeIndexResponse.
_responseType?
optional_responseType?:ItemTypeIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
recipe
recipe: (
artisanSlug,recipeSlug) =>object
Returns the recipe information for the specified artisan and recipe slugs.
Parameters
artisanSlug
The slug of the artisan.
recipeSlug
string
The slug of the recipe.
Returns
The recipe resource. 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.
season
season: (
id) =>object
Returns the season information for the specified season ID.
Parameters
id
number
The ID of the season.
Returns
The season resource. See SeasonResponse.
_responseType?
optional_responseType?:SeasonResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
seasonIndex
seasonIndex: () =>
object
Returns the season index.
Returns
The season index resource. See SeasonIndexResponse.
_responseType?
optional_responseType?:SeasonIndexResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
seasonLeaderboard
seasonLeaderboard: (
id,leaderboard) =>object
Returns the season leaderboard for the specified season ID and leaderboard.
Parameters
id
number
The ID of the season.
leaderboard
string
The name of the leaderboard.
Returns
The season leaderboard resource. See SeasonLeaderboardResponse.
_responseType?
optional_responseType?:SeasonLeaderboardResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.
skill
skill: (
characterClassSlug,skillSlug) =>object
Returns the skill information for the specified character class and skill slugs.
Parameters
characterClassSlug
The slug of the character class.
skillSlug
string
The slug of the skill.
Returns
The skill resource. See SkillResponse.
_responseType?
optional_responseType?:SkillResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.