blizzardapi2 1.0.0

A Python wrapper for Blizzard API

blizzardapi2

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

Type hints have been added as well.

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.9, 3.10, 3.11)

Installing

pip install blizzardapi2

Example

main.py

from blizzardapi2 import BlizzardApi

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

# Unprotected API endpoint
categories_index = api_client.wow.game_data.get_achievement_categories_index("us", "en_US")

# Protected API endpoint
summary = api_client.wow.profile.get_account_profile_summary("us", "en_US", "access_token")

# Wow Classic endpoint
connected_realms_index = api_client.wow.game_data.get_connected_realms_index("us", "en_US", is_classic=True)

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.

Here is the list of endpoints, specified by Blizzard, that require an OAuth token.

GET /oauth/userinfo
GET /profile/user/wow
GET /profile/user/wow/protected-character/{realm-id}-{character-id}
GET /profile/user/wow/collections
GET /profile/user/wow/collections/pets
GET /profile/user/wow/collections/mounts