python-blizzardapi is a client library for Blizzard's APIs.
Project description
python-blizzardapi
python-blizzardapi is a client library for Blizzard's APIs.
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
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.6, 3.7, 3.8, 3.9)
Installing
pip install python-blizzardapi
Example
main.py
from blizzardapi 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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_blizzardapi-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6db19e231ce220cd8ec582797b2bdfcf538de2e366d5504c1604a9a70ff39d9 |
|
MD5 | 2534fe09f81ffe8c255b9212230410b6 |
|
BLAKE2b-256 | a6afccd6073f1e6b6cbcd5b3f5e906bfd95796857164faf2169f2768356a3c83 |