Skip to main content

A Python wrapper for Blizzard API

Project description

python-blizzardapi2

GitHub

python-blizzardapi2 is a client library for Blizzard's APIs. It's a fork of the original library and I'm trying to update it and keep its packages managed.

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

Installing

pip install python-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

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

blizzardapi2-0.1.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

blizzardapi2-0.1.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file blizzardapi2-0.1.0.tar.gz.

File metadata

  • Download URL: blizzardapi2-0.1.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.3 Windows/10

File hashes

Hashes for blizzardapi2-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ccedc57b0a99be978be91c2f778cd3438c2b04dbd5815fcb00654281fbc91452
MD5 fc0268c01367dbe395f64972a9b36e35
BLAKE2b-256 4d3994a212c04beebd06cbf011cedd049be625ed6c33d301dc93590fafbaa729

See more details on using hashes here.

File details

Details for the file blizzardapi2-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: blizzardapi2-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.3 Windows/10

File hashes

Hashes for blizzardapi2-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0cc745bbf37bfd7890f8453d2d9de495921be4337b8922ef1beff91da9bb904
MD5 5e75bb0d6c401c8c6316cbd2a4447e5f
BLAKE2b-256 752056b2d974c3151eb2a05503e03a6e27d4df48600e0264e6daf1551e7c943d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page