@pinta365/blizzard_api 0.6.0 → 0.6.2

package/README.md

@@ -189,6 +189,7 @@ const sword = await blizzardAPI.wow.item(33791);
 deno task test        # offline unit tests
 deno task smoke       # live smoke test of every endpoint (needs .env with BLIZZARD_CLIENT_ID / BLIZZARD_CLIENT_SECRET)
 deno task gen:api     # regenerate src/generated/ after adding or changing endpoints
+deno task user-token --save # log in with Battle.net and save a user token to .env (for the account endpoints)
 deno task check:types # check the response types against the responses saved by the smoke test (fixtures/)
 deno task check:fields # list fields the API returns that the response types don't declare
 ```

package/esm/src/diablo3/community/profile.d.ts

@@ -77,6 +77,8 @@ export interface D3HeroItem {
     typeName?: string;
     type?: D3ItemType;
     armor?: number;
+    /** Display text for shields, e.g. "+16.0% Chance to Block\n7-12 Block Amount". */
+    blockChance?: string;
     attacksPerSecond?: number;
     minDamage?: number;
     maxDamage?: number;
@@ -304,7 +306,8 @@ export interface D3Account {
         act4: boolean;
         act5: boolean;
     };
-    fallenHeroes: D3FallenHero[];
+    /** Absent when the account has no fallen hardcore heroes. */
+    fallenHeroes?: D3FallenHero[];
     seasonalProfiles: Record<string, D3SeasonalProfile>;
     blacksmith: D3Artisan;
     jeweler: D3Artisan;

package/esm/src/generated/wow_api.d.ts

@@ -69,6 +69,9 @@ export interface WowApi {
     accountCollectionsIndex(): Promise<AccountCollectionsIndex>;
     /**
      * Returns the housing decor collected by an account.
+     *
+     * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+     * characterCollectionDecor works.
      * Requires a user access token (client.forUser(token)).
      *
      * @returns A promise that resolves to an object representing the account's decor.
@@ -303,6 +306,10 @@ export interface WowApi {
     /**
      * Returns a summary of a house a character has built.
      *
+     * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+     * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+     * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+     *
      * @param realmSlug - The slug of the realm.
      * @param characterName - The lowercase name of the character.
      * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/esm/src/wow/profile/account_profile.d.ts

@@ -3,8 +3,18 @@
  * `wow.profile` scope, acquired via the authorization code flow: use `client.forUser(token).wow.*`.
  */
 import type { ApiContext } from "../../shared/index.js";
-import type { Href, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+import type { Href, KeyNameId, TypeName } from "../../shared/index.js";
 import type { CollectedHeirloom, CollectedPet, CollectedToy, DecorItem } from "./character_collections.js";
+/**
+ * The links at the top of account profile responses.
+ */
+export interface AccountLinks {
+    _links: {
+        self: Href;
+        user: Href;
+        profile: Href;
+    };
+}
 export interface AccountCharacter {
     character: Href;
     protected_character: Href;
@@ -19,15 +29,17 @@ export interface AccountCharacter {
     faction: TypeName;
     level: number;
 }
-export interface AccountProfileSummary extends LinkSelfHref {
+export interface AccountProfileSummary extends AccountLinks {
     id: number;
     wow_accounts: {
         id: number;
         characters: AccountCharacter[];
     }[];
     collections: Href;
+    /** Links to the account's houses (character house endpoints). Absent when the account has no house. */
+    houses?: Href[];
 }
-export interface ProtectedCharacterProfile extends LinkSelfHref {
+export interface ProtectedCharacterProfile extends AccountLinks {
     id: number;
     name: string;
     money: number;
@@ -78,34 +90,36 @@ export interface ProtectedCharacterProfile extends LinkSelfHref {
         facing: number;
     };
     wow_account: number;
+    /** Links to this character's houses. Absent when the character has no house. */
+    houses?: Href[];
 }
-export interface AccountCollectionsIndex extends LinkSelfHref {
+export interface AccountCollectionsIndex extends AccountLinks {
     pets: Href;
     mounts: Href;
     heirlooms: Href;
     toys: Href;
     transmogs: Href;
-    decor?: Href;
+    decors?: Href;
 }
 export interface AccountMount {
     mount: KeyNameId;
     is_favorite?: boolean;
     is_useable?: boolean;
 }
-export interface AccountMountsCollection extends LinkSelfHref {
+export interface AccountMountsCollection extends AccountLinks {
     mounts: AccountMount[];
 }
-export interface AccountPetsCollection extends LinkSelfHref {
+export interface AccountPetsCollection extends AccountLinks {
     pets: CollectedPet[];
     unlocked_battle_pet_slots: number;
 }
-export interface AccountToysCollection extends LinkSelfHref {
+export interface AccountToysCollection extends AccountLinks {
     toys: CollectedToy[];
 }
-export interface AccountHeirloomsCollection extends LinkSelfHref {
+export interface AccountHeirloomsCollection extends AccountLinks {
     heirlooms: CollectedHeirloom[];
 }
-export interface AccountTransmogsCollection extends LinkSelfHref {
+export interface AccountTransmogsCollection extends AccountLinks {
     appearance_sets: KeyNameId[];
     slots: {
         slot: TypeName;
@@ -115,7 +129,7 @@ export interface AccountTransmogsCollection extends LinkSelfHref {
         }[];
     }[];
 }
-export interface AccountDecorCollection extends LinkSelfHref {
+export interface AccountDecorCollection extends AccountLinks {
     decor_collected: DecorItem[];
 }
 /**
@@ -178,6 +192,9 @@ export declare function accountHeirloomsCollection(ctx: ApiContext): Promise<Acc
 export declare function accountTransmogsCollection(ctx: ApiContext): Promise<AccountTransmogsCollection>;
 /**
  * Returns the housing decor collected by an account.
+ *
+ * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+ * characterCollectionDecor works.
  * Requires a user access token (client.forUser(token)).
  *
  * @returns A promise that resolves to an object representing the account's decor.

package/esm/src/wow/profile/account_profile.js

@@ -118,6 +118,9 @@ export async function accountTransmogsCollection(ctx) {
 }
 /**
  * Returns the housing decor collected by an account.
+ *
+ * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+ * characterCollectionDecor works.
  * Requires a user access token (client.forUser(token)).
  *
  * @returns A promise that resolves to an object representing the account's decor.

package/esm/src/wow/profile/character_collections.d.ts

@@ -31,6 +31,9 @@ export interface CollectedPet {
     id: number;
     is_active?: boolean;
     active_slot?: number;
+    is_favorite?: boolean;
+    /** The custom name, if the player renamed the pet. */
+    name?: string;
 }
 export interface CharacterCollectionPets extends LinkSelfHref {
     pets: CollectedPet[];

package/esm/src/wow/profile/character_house.d.ts

@@ -9,6 +9,10 @@ export interface CharacterHouse extends LinkSelfHref {
 /**
  * Returns a summary of a house a character has built.
  *
+ * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+ * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+ * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+ *
  * @param realmSlug - The slug of the realm.
  * @param characterName - The lowercase name of the character.
  * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/esm/src/wow/profile/character_house.js

@@ -4,6 +4,10 @@
 /**
  * Returns a summary of a house a character has built.
  *
+ * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+ * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+ * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+ *
  * @param realmSlug - The slug of the realm.
  * @param characterName - The lowercase name of the character.
  * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/esm/src/wow/profile/character_profile.d.ts

@@ -1,13 +1,13 @@
 import type { ApiContext, Href, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+import type { CharacterActiveTitle } from "./character_titles.js";
 export interface CharacterRealm extends KeyNameId {
     slug: string;
 }
 export interface CharacterProfile extends LinkSelfHref {
     id: number;
     name: LocalizedString;
-    active_title?: {
-        name: string;
-    };
+    /** Absent when the character has no active title. */
+    active_title?: CharacterActiveTitle;
     gender: TypeName;
     faction: TypeName;
     race: KeyNameId;

package/esm/src/wow/profile/character_specializations.d.ts

@@ -10,7 +10,8 @@ export interface Detail {
         };
         description?: LocalizedString | null;
         cast_time?: LocalizedString;
-        power_cost?: LocalizedString;
+        /** null for abilities without a cost. */
+        power_cost?: LocalizedString | null;
         cooldown?: LocalizedString;
         range?: LocalizedString;
     };

package/esm/src/wow/profile/character_titles.d.ts

@@ -1,7 +1,18 @@
 import type { ApiContext } from "../../shared/index.js";
-import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+import type { Character, Href, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+/**
+ * A character's active title. `display_string` has a `{name}` placeholder for the character name.
+ */
+export interface CharacterActiveTitle {
+    key: Href;
+    name: string;
+    id: number;
+    display_string: string;
+}
 export interface CharacterTitles extends LinkSelfHref {
     character: Character;
+    /** Absent when the character has no active title. */
+    active_title?: CharacterActiveTitle;
     titles: KeyNameId[];
 }
 /**

package/esm/src/wow/types.d.ts

@@ -53,6 +53,6 @@ export type { CharacterReputations } from "./profile/character_reputations.js";
 export type { CharacterSoulbinds } from "./profile/character_soulbinds.js";
 export type { CharacterSpecializations, CharacterSpecializationTalent, ClassicSpecializationTalent, Detail, } from "./profile/character_specializations.js";
 export type { CharacterStatistics, StatRating, StatRatingBonus } from "./profile/character_statistics.js";
-export type { CharacterTitles } from "./profile/character_titles.js";
+export type { CharacterActiveTitle, CharacterTitles } from "./profile/character_titles.js";
 export type { CrestAsset, Critiera, Guild, GuildAchievements, GuildActivity, GuildCrestRgba, GuildReference, GuildRoster, GuildRosterMemberCharacter, } from "./profile/guild.js";
 export type { Search, SearchParameters } from "./search.js";

package/esm/src/wow_classic/profile_overrides.d.ts

@@ -18,7 +18,11 @@ import type { GuildAchievements } from "../wow/profile/guild.js";
 /** Makes the keys K of T optional. */
 type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 /** Character profile as returned for Classic: Retail-only links and fields are optional. */
-export interface ClassicCharacterProfile extends WithOptional<CharacterProfile, "active_spec" | "achievement_points" | "achievements" | "encounters" | "mythic_keystone_profile" | "collections" | "quests" | "achievements_statistics" | "professions" | "name_search" | "is_remix"> {
+export interface ClassicCharacterProfile extends Omit<WithOptional<CharacterProfile, "active_spec" | "achievement_points" | "achievements" | "encounters" | "mythic_keystone_profile" | "collections" | "quests" | "achievements_statistics" | "professions" | "name_search" | "is_remix">, "active_title"> {
+    /** Classic only returns the title name. Absent when the character has no active title. */
+    active_title?: {
+        name: string;
+    };
 }
 /** Character appearance as returned for Classic (no active specialization on Era). */
 export interface ClassicCharacterAppearanceSummary extends WithOptional<CharacterAppearanceSummary, "active_spec"> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinta365/blizzard_api",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "TS library to interact with the Blizzard Battle.net API. World of Warcraft, World of Warcraft Classic, StarCraft 2, Diablo 3, Hearthstone.",
   "keywords": [
     "blizzard",

package/script/src/diablo3/community/profile.d.ts

@@ -77,6 +77,8 @@ export interface D3HeroItem {
     typeName?: string;
     type?: D3ItemType;
     armor?: number;
+    /** Display text for shields, e.g. "+16.0% Chance to Block\n7-12 Block Amount". */
+    blockChance?: string;
     attacksPerSecond?: number;
     minDamage?: number;
     maxDamage?: number;
@@ -304,7 +306,8 @@ export interface D3Account {
         act4: boolean;
         act5: boolean;
     };
-    fallenHeroes: D3FallenHero[];
+    /** Absent when the account has no fallen hardcore heroes. */
+    fallenHeroes?: D3FallenHero[];
     seasonalProfiles: Record<string, D3SeasonalProfile>;
     blacksmith: D3Artisan;
     jeweler: D3Artisan;

package/script/src/generated/wow_api.d.ts

@@ -69,6 +69,9 @@ export interface WowApi {
     accountCollectionsIndex(): Promise<AccountCollectionsIndex>;
     /**
      * Returns the housing decor collected by an account.
+     *
+     * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+     * characterCollectionDecor works.
      * Requires a user access token (client.forUser(token)).
      *
      * @returns A promise that resolves to an object representing the account's decor.
@@ -303,6 +306,10 @@ export interface WowApi {
     /**
      * Returns a summary of a house a character has built.
      *
+     * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+     * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+     * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+     *
      * @param realmSlug - The slug of the realm.
      * @param characterName - The lowercase name of the character.
      * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/script/src/wow/profile/account_profile.d.ts

@@ -3,8 +3,18 @@
  * `wow.profile` scope, acquired via the authorization code flow: use `client.forUser(token).wow.*`.
  */
 import type { ApiContext } from "../../shared/index.js";
-import type { Href, KeyNameId, LinkSelfHref, TypeName } from "../../shared/index.js";
+import type { Href, KeyNameId, TypeName } from "../../shared/index.js";
 import type { CollectedHeirloom, CollectedPet, CollectedToy, DecorItem } from "./character_collections.js";
+/**
+ * The links at the top of account profile responses.
+ */
+export interface AccountLinks {
+    _links: {
+        self: Href;
+        user: Href;
+        profile: Href;
+    };
+}
 export interface AccountCharacter {
     character: Href;
     protected_character: Href;
@@ -19,15 +29,17 @@ export interface AccountCharacter {
     faction: TypeName;
     level: number;
 }
-export interface AccountProfileSummary extends LinkSelfHref {
+export interface AccountProfileSummary extends AccountLinks {
     id: number;
     wow_accounts: {
         id: number;
         characters: AccountCharacter[];
     }[];
     collections: Href;
+    /** Links to the account's houses (character house endpoints). Absent when the account has no house. */
+    houses?: Href[];
 }
-export interface ProtectedCharacterProfile extends LinkSelfHref {
+export interface ProtectedCharacterProfile extends AccountLinks {
     id: number;
     name: string;
     money: number;
@@ -78,34 +90,36 @@ export interface ProtectedCharacterProfile extends LinkSelfHref {
         facing: number;
     };
     wow_account: number;
+    /** Links to this character's houses. Absent when the character has no house. */
+    houses?: Href[];
 }
-export interface AccountCollectionsIndex extends LinkSelfHref {
+export interface AccountCollectionsIndex extends AccountLinks {
     pets: Href;
     mounts: Href;
     heirlooms: Href;
     toys: Href;
     transmogs: Href;
-    decor?: Href;
+    decors?: Href;
 }
 export interface AccountMount {
     mount: KeyNameId;
     is_favorite?: boolean;
     is_useable?: boolean;
 }
-export interface AccountMountsCollection extends LinkSelfHref {
+export interface AccountMountsCollection extends AccountLinks {
     mounts: AccountMount[];
 }
-export interface AccountPetsCollection extends LinkSelfHref {
+export interface AccountPetsCollection extends AccountLinks {
     pets: CollectedPet[];
     unlocked_battle_pet_slots: number;
 }
-export interface AccountToysCollection extends LinkSelfHref {
+export interface AccountToysCollection extends AccountLinks {
     toys: CollectedToy[];
 }
-export interface AccountHeirloomsCollection extends LinkSelfHref {
+export interface AccountHeirloomsCollection extends AccountLinks {
     heirlooms: CollectedHeirloom[];
 }
-export interface AccountTransmogsCollection extends LinkSelfHref {
+export interface AccountTransmogsCollection extends AccountLinks {
     appearance_sets: KeyNameId[];
     slots: {
         slot: TypeName;
@@ -115,7 +129,7 @@ export interface AccountTransmogsCollection extends LinkSelfHref {
         }[];
     }[];
 }
-export interface AccountDecorCollection extends LinkSelfHref {
+export interface AccountDecorCollection extends AccountLinks {
     decor_collected: DecorItem[];
 }
 /**
@@ -178,6 +192,9 @@ export declare function accountHeirloomsCollection(ctx: ApiContext): Promise<Acc
 export declare function accountTransmogsCollection(ctx: ApiContext): Promise<AccountTransmogsCollection>;
 /**
  * Returns the housing decor collected by an account.
+ *
+ * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+ * characterCollectionDecor works.
  * Requires a user access token (client.forUser(token)).
  *
  * @returns A promise that resolves to an object representing the account's decor.

package/script/src/wow/profile/account_profile.js

@@ -129,6 +129,9 @@ async function accountTransmogsCollection(ctx) {
 }
 /**
  * Returns the housing decor collected by an account.
+ *
+ * Note: as of 2026-10-01 this returns 404 even for accounts with decor, although the collections index links to it.
+ * characterCollectionDecor works.
  * Requires a user access token (client.forUser(token)).
  *
  * @returns A promise that resolves to an object representing the account's decor.

package/script/src/wow/profile/character_collections.d.ts

@@ -31,6 +31,9 @@ export interface CollectedPet {
     id: number;
     is_active?: boolean;
     active_slot?: number;
+    is_favorite?: boolean;
+    /** The custom name, if the player renamed the pet. */
+    name?: string;
 }
 export interface CharacterCollectionPets extends LinkSelfHref {
     pets: CollectedPet[];

package/script/src/wow/profile/character_house.d.ts

@@ -9,6 +9,10 @@ export interface CharacterHouse extends LinkSelfHref {
 /**
  * Returns a summary of a house a character has built.
  *
+ * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+ * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+ * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+ *
  * @param realmSlug - The slug of the realm.
  * @param characterName - The lowercase name of the character.
  * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/script/src/wow/profile/character_house.js

@@ -7,6 +7,10 @@ exports.characterHouse = characterHouse;
 /**
  * Returns a summary of a house a character has built.
  *
+ * Note: Blizzard disabled this endpoint in early 2026 over player privacy concerns, and it currently returns 404 even
+ * for characters that own a house. The function is kept for when it returns; the response type is unverified.
+ * See https://us.forums.blizzard.com/en/blizzard/t/new-housing-apis/56815
+ *
  * @param realmSlug - The slug of the realm.
  * @param characterName - The lowercase name of the character.
  * @param houseNumber - The number of the character's house (e.g. 1 for house-1).

package/script/src/wow/profile/character_profile.d.ts

@@ -1,13 +1,13 @@
 import type { ApiContext, Href, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+import type { CharacterActiveTitle } from "./character_titles.js";
 export interface CharacterRealm extends KeyNameId {
     slug: string;
 }
 export interface CharacterProfile extends LinkSelfHref {
     id: number;
     name: LocalizedString;
-    active_title?: {
-        name: string;
-    };
+    /** Absent when the character has no active title. */
+    active_title?: CharacterActiveTitle;
     gender: TypeName;
     faction: TypeName;
     race: KeyNameId;

package/script/src/wow/profile/character_specializations.d.ts

@@ -10,7 +10,8 @@ export interface Detail {
         };
         description?: LocalizedString | null;
         cast_time?: LocalizedString;
-        power_cost?: LocalizedString;
+        /** null for abilities without a cost. */
+        power_cost?: LocalizedString | null;
         cooldown?: LocalizedString;
         range?: LocalizedString;
     };

package/script/src/wow/profile/character_titles.d.ts

@@ -1,7 +1,18 @@
 import type { ApiContext } from "../../shared/index.js";
-import type { Character, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+import type { Character, Href, KeyNameId, LinkSelfHref } from "../../shared/index.js";
+/**
+ * A character's active title. `display_string` has a `{name}` placeholder for the character name.
+ */
+export interface CharacterActiveTitle {
+    key: Href;
+    name: string;
+    id: number;
+    display_string: string;
+}
 export interface CharacterTitles extends LinkSelfHref {
     character: Character;
+    /** Absent when the character has no active title. */
+    active_title?: CharacterActiveTitle;
     titles: KeyNameId[];
 }
 /**

package/script/src/wow/types.d.ts

@@ -53,6 +53,6 @@ export type { CharacterReputations } from "./profile/character_reputations.js";
 export type { CharacterSoulbinds } from "./profile/character_soulbinds.js";
 export type { CharacterSpecializations, CharacterSpecializationTalent, ClassicSpecializationTalent, Detail, } from "./profile/character_specializations.js";
 export type { CharacterStatistics, StatRating, StatRatingBonus } from "./profile/character_statistics.js";
-export type { CharacterTitles } from "./profile/character_titles.js";
+export type { CharacterActiveTitle, CharacterTitles } from "./profile/character_titles.js";
 export type { CrestAsset, Critiera, Guild, GuildAchievements, GuildActivity, GuildCrestRgba, GuildReference, GuildRoster, GuildRosterMemberCharacter, } from "./profile/guild.js";
 export type { Search, SearchParameters } from "./search.js";

package/script/src/wow_classic/profile_overrides.d.ts

@@ -18,7 +18,11 @@ import type { GuildAchievements } from "../wow/profile/guild.js";
 /** Makes the keys K of T optional. */
 type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 /** Character profile as returned for Classic: Retail-only links and fields are optional. */
-export interface ClassicCharacterProfile extends WithOptional<CharacterProfile, "active_spec" | "achievement_points" | "achievements" | "encounters" | "mythic_keystone_profile" | "collections" | "quests" | "achievements_statistics" | "professions" | "name_search" | "is_remix"> {
+export interface ClassicCharacterProfile extends Omit<WithOptional<CharacterProfile, "active_spec" | "achievement_points" | "achievements" | "encounters" | "mythic_keystone_profile" | "collections" | "quests" | "achievements_statistics" | "professions" | "name_search" | "is_remix">, "active_title"> {
+    /** Classic only returns the title name. Absent when the character has no active title. */
+    active_title?: {
+        name: string;
+    };
 }
 /** Character appearance as returned for Classic (no active specialization on Era). */
 export interface ClassicCharacterAppearanceSummary extends WithOptional<CharacterAppearanceSummary, "active_spec"> {