# blizzard_api

> TypeScript client for the Blizzard Battle.net APIs: World of Warcraft (Retail, Classic, Forever), Hearthstone, StarCraft II and Diablo III.

These docs describe the latest release of `@pinta365/blizzard-api` (JSR) / `@pinta365/blizzard_api` (npm). Create a client with `createClient({ region, clientId, clientSecret })`; every game is a property of it (`client.wow`, `client.wowForever`, ...). The WoW: Forever API is undocumented by Blizzard; the Forever notes describe what has been found by testing.

## Pages

- [blizzard_api](https://blizzard.pinta.land/index.md): TypeScript client for the Blizzard Battle.net APIs, with types for every response.

## Guide

- [Guide](https://blizzard.pinta.land/guide/index.md): Set up a client, pick a region, use the response types, user tokens, errors and retries, and upgrade between versions.
- [Clients and regions](https://blizzard.pinta.land/guide/clients/index.md): Create a client, pick a region and locale, and use the game properties.
- [Types and links](https://blizzard.pinta.land/guide/types-and-links/index.md): Import response types, and follow the links in responses.
- [User tokens](https://blizzard.pinta.land/guide/user-tokens/index.md): Use the account profile endpoints, which need a user's permission.
- [Errors and retries](https://blizzard.pinta.land/guide/errors/index.md): What failed requests throw, and which ones are retried.
- [Upgrading](https://blizzard.pinta.land/guide/upgrading/index.md): Changes that may need code changes, per version.

## WoW: Forever notes

- [WoW: Forever notes](https://blizzard.pinta.land/forever/index.md): What the undocumented WoW: Forever API does, as far as we've found out.
- [Basics](https://blizzard.pinta.land/forever/basics/index.md): Forever namespaces, regions and rulesets.
- [Characters and guilds](https://blizzard.pinta.land/forever/characters-and-guilds/index.md): Realmless character names, when characters appear in the API, media, and guilds.
- [Auctions](https://blizzard.pinta.land/forever/auctions/index.md): Auction houses, auctions, commodities and missing item data.
- [Character statistics](https://blizzard.pinta.land/forever/character-statistics/index.md): What base and effective mean, and why effective can be lower than base.
- [Open questions](https://blizzard.pinta.land/forever/open-questions/index.md): What doesn't work yet, or isn't known.

## Reference

- [Reference](https://blizzard.pinta.land/reference/index.md): Every endpoint function of blizzard_api, per game: World of Warcraft, Classic, Classic Era, WoW: Forever, Hearthstone, StarCraft II and Diablo III.
- [World of Warcraft](https://blizzard.pinta.land/reference/wow/index.md): Every World of Warcraft endpoint of blizzard_api, on client.wow.
- [WoW Classic](https://blizzard.pinta.land/reference/wow-classic/index.md): Every WoW Classic endpoint of blizzard_api, on client.wowClassic.
- [WoW Classic Era](https://blizzard.pinta.land/reference/wow-classic-era/index.md): Every WoW Classic Era endpoint of blizzard_api, on client.wowClassicEra.
- [WoW: Forever](https://blizzard.pinta.land/reference/wow-forever/index.md): Every WoW: Forever endpoint of blizzard_api, on client.wowForever.
- [Hearthstone](https://blizzard.pinta.land/reference/hearthstone/index.md): Every Hearthstone endpoint of blizzard_api, on client.hearthstone.
- [StarCraft II](https://blizzard.pinta.land/reference/sc2/index.md): Every StarCraft II endpoint of blizzard_api, on client.sc2.
- [Diablo III](https://blizzard.pinta.land/reference/diablo3/index.md): Every Diablo III endpoint of blizzard_api, on client.diablo3.