blizzardapi2 5.0.0

A Python wrapper for Blizzard API

Blizzard API 2

blizzardapi2 is a client library for Blizzard's APIs. It's a fork of the original library.

Current supported features include:

• Battle.net User
• WoW Profile
• WoW Game Data
• WoW Classic Game Data
• Diablo 3 Community
• Diablo 3 Game Data
• Hearthstone Game Data
• Starcraft 2 Community
• Starcraft 2 Game Data

Modern features:

• Full type hints support
• Automatic token management with intelligent refresh
• Enum-based region and locale validation
• Clean, maintainable codebase
• Comprehensive error handling

To gain access to Blizzard's API please register here to obtain a client id and client secret.

For more information on Blizzard's API visit:

Official Documentation
Official API Forum

Requirements

Python (3.11+)

Installing

pip install blizzardapi2

Examples

Basic Usage

from blizzardapi2 import BlizzardApi, Region, Locale

api_client = BlizzardApi("client_id", "client_secret")

# Public API endpoint (uses automatic client credentials token)
categories_index = api_client.wow.game_data.get_achievement_categories_index(
    region=Region.US,
    locale=Locale.EN_US,
)

# Protected API endpoint (requires user OAuth token)
summary = api_client.wow.profile.get_account_profile_summary(
    "user_access_token",  # OAuth token from authorization code flow
    region=Region.US,
    locale=Locale.EN_US,
)

# WoW Classic endpoint
connected_realms_index = api_client.wow.game_data.get_connected_realms_index(
    region=Region.US,
    locale=Locale.EN_US,
    is_classic=True,
)

Token Management

The library automatically manages client credentials tokens for public endpoints:

from blizzardapi2 import BlizzardApi, Region, Locale

api_client = BlizzardApi("client_id", "client_secret")

# First call: library automatically fetches and caches a client credentials token
realms = api_client.wow.game_data.get_realms_index(
    region=Region.US,
    locale=Locale.EN_US,
)

# Subsequent calls: library reuses the cached token
achievements = api_client.wow.game_data.get_achievements_index(
    region=Region.US,
    locale=Locale.EN_US,
)

# When token expires: library automatically refreshes it
# You don't need to manage tokens manually!

Access token vs Client ID/Client Secret

You can pass in a client_id and client_secret and use almost any endpoint except for a few that require an access_token obtained via OAuth authorization code flow. You can find more information at https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow.

Important: The library handles all tokens securely by passing them in Authorization headers, never in URLs. When you provide a user OAuth token to methods like get_account_profile_summary(), the library automatically:

1. Extracts the token from parameters
2. Sends it via Authorization: Bearer <token> header
3. Keeps tokens out of URL query strings

Here is the list of endpoints, and related API methods, that require an OAuth authorization code token:

Resource path	API call
/userinfo	.battlenet.oauth.get_user_info(access_token)
/profile/user/wow	.wow.profile.get_account_profile_summary(access_token)
/profile/user/wow/protected-character/{realm-id}-{character-id}	.wow.profile.get_protected_character_profile_summary(access_token, realm_id, character_id)
/profile/user/wow/collections	.wow.profile.get_account_collections_index(access_token)
/profile/user/wow/collections/heirlooms	.wow.profile.get_account_heirlooms_collection_summary(access_token)
/profile/user/wow/collections/mounts	.wow.profile.get_account_mounts_collection_summary(access_token)
/profile/user/wow/collections/pets	.wow.profile.get_account_pets_collection_summary(access_token)
/profile/user/wow/collections/toys	.wow.profile.get_account_toys_collection_summary(access_token)
/profile/user/wow/collections/transmogs	.wow.profile.get_account_transmog_collection_summary(access_token)

Note: For these protected endpoints, you must implement the OAuth authorization code flow in your application to obtain a user access token. The library does not handle the OAuth flow itself - it only accepts and uses the token you provide.

Documentation

For detailed documentation on each game's API, see the following README files:

• WoW API Documentation
• Diablo 3 API Documentation
• Hearthstone API Documentation
• Starcraft 2 API Documentation