blizzapi 1.0.5

Python package to connect to the blizzard API.

Python BlizzAPI

This Python package is a user-friendly interface for the Blizzard API. It simplifies the process of retrieving data from Blizzard's API, allowing developers and enthusiasts to seamlessly access and interact with game-related information.

Table of Contents

• Features
• Install
• Usage
• Development
• Contributing
• License

Features

Comprehensive API Coverage

Access a wide range of game data, including player profiles, achievements, character information and guild information as documented in the official Blizzard API Documenation.

Oauth2 Integration

Authenticate using Blizzard's OAuth2 system to ensure reliable access to private and public data.

Ease of Use

With clean and intuitive methods, developers can fetch data without deep diving into Blizzard's API documentation.

Data Format

Conveniently structured JSON responses make it easy to integrate with applications.

Supported APIs

API	Status
World Of Warcraft (Retail)	Supported (Game Data/Profile APIs)
World Of Warcraft (Classic)	Supported (Game Data/Profile APIs)
World of Warcraft (Classic Era)	Supported (Game Data/Profile APIs)
Hearthstone	Unplanned
StarCraft 2	Unplanned
Diablo 3	Unplanned
Diablo 4	Unsupported (No Blizzard API)
Overwatch 2	Unsupported (No Blizzard API)

Install

# PyPI
pip install blizzapi

or

uv add blizzapi

Blizzard API Client ID/Secret

You must request API access from blizzard in order to use this module.

Request API Access

Dependencies

Python 3.10 or greater

Usage

WoW Classic Era

from blizzapi import ClassicEraClient
client = ClassicEraClient(client_id=XXX, client_secret=YYY)

result = client.connected_realm_search(fields={"status.type": "UP"})
result = client.character_profile(realmSlug="doomhowl", characterName="thetusk")

WoW Retail

from blizzapi import RetailClient
client = RetailClient(client_id=XXX, client_secret=YYY)

result = client.wow_token_index()

Development

Virtual Environment Setup

Helpful notes on how to set up a virtual enviroment for developing python applications using VS Code.

Show Instructions

1. Ensure python and uv are installed on PC. uv Instructions

2. Open "Folder" in VS Code

3. Change the Default Terminal in VS Code

   1. Press CTRL + SHIFT + P (on Windows) or CMD + SHIFT + P (on macOS)
   2. Select 'Terminal: Select Default Profile'
   3. Choose 'Command Prompt' on Windows or 'bash' on macOS

4. Create Virtual Environment

   1. Press CTRL + SHIFT + ` to open a Terminal
   2. Enter 'uv venv'
   3. Enter 'source .venv/bin/activate'
   4. Verify the prompt begins with '(.venv)'

5. Select Python Interpreter

   1. Press CTRL + SHIFT + P (on Windows) or CMD + SHIFT + P (on macOS)
   2. Select 'Python: Select Interpreter'
   3. Choose the .venv python binary

6. Install the dependenies

   1. Enter 'uv sync'

Contributing

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Bug Reports and Feature Requests

Please use the issue tracker to report any bugs or request new features.

Contributors

License

MIT © Nick Stuer