Skip to main content

A Python wrapper for Blizzard API

Project description

blizzardapi2

GitHubPytestDependabotCodeQLCode style: black

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

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.5.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

blizzardapi2-0.1.5-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: blizzardapi2-0.1.5.tar.gz
  • Upload date:
  • Size: 12.7 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.5.tar.gz
Algorithm Hash digest
SHA256 e52767dfb83b662ad9c53052c1a68ba600897a423e305e44cd7fb6a15d87b879
MD5 926202e8976a8fce5a9ed6fdd44fadc3
BLAKE2b-256 8f5e9f1633b606b454cbbe52bf9d8541d0f4535f8845cd60da4e11536395a588

See more details on using hashes here.

File details

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

File metadata

  • Download URL: blizzardapi2-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 19.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 918f7224480a344fbd575eadfb34fc57a5b1b82d5beb2852f80581e6c0c24843
MD5 22a46942da6dab7edadad6543170a186
BLAKE2b-256 081418b399ea4ee1f12d5eddddd67fcbead019f330f45cff9cf1a029f7e2943b

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