Skip to main content

python-blizzardapi is a client library for Blizzard's APIs.

Project description

python-blizzardapi

Python package codecov

python-blizzardapi is a client library for Blizzard's APIs.

Current supported features include:

  • Battle.net User
  • WoW Profile
  • WoW Game Data
  • Diablo 3 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")

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

python-blizzardapi-1.0.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_blizzardapi-1.0.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file python-blizzardapi-1.0.0.tar.gz.

File metadata

  • Download URL: python-blizzardapi-1.0.0.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for python-blizzardapi-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b251d0219a3fc1d91db7a60a424d063aaab864c60833aceef57d643b3c9dc0d2
MD5 f83acf9fa003e06948463030a9df72eb
BLAKE2b-256 2c3812aec5ed218ff927ca2475559245f4623bb2aed5e5b6493cead41e6d5c8a

See more details on using hashes here.

File details

Details for the file python_blizzardapi-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: python_blizzardapi-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for python_blizzardapi-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de6bf77a6c463d1c823ed19c949cd063e238edef0fd30487c7af463df9015d6d
MD5 f646bf1228f745e04fc38a2e541a6df5
BLAKE2b-256 f62de43228f8d2960a8b7e6d602a1fefeb8268e80132b655b07a85585f4d6cf5

See more details on using hashes here.

Supported by

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