Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 2.8 KB

README.md

File metadata and controls

87 lines (61 loc) · 2.8 KB
Raw

BLIZZARD API

JSR Version

Start of what will cover the whole Blizzard Battle.net API when its done.

Available as:

  • ESM module: JSR
  • CommonJS module: NPM

WORK IN PROGRESS

Let me know if you want certain APIs to be prioritized. Currently only supports client credentials flow but the plan is to implement authorization code flow also.

APIs implemented

APIs Status Note
World of Warcraft: Game Data APIs ✅
World of Warcraft: Profile APIs ✅
World of Warcraft Classic: Game Data APIs
World of Warcraft Classic: Profile APIs
Diablo III: Community APIs ✅ Missing profile endpoints
Diablo III: Game Data APIs ✅
Hearthstone: Game Data APIs ✅
StarCraft II: Community APIs
StarCraft II: Game Data APIs ✅

⚡️ Quickstart

Installation

# Deno
deno add @pinta365/blizzard-api

# Bun
bunx jsr add @pinta365/blizzard-api

# Node.js
npx jsr add @pinta365/blizzard-api

# NPM (CommonJS)
npm install @pinta365/blizzard_api --save

Basic Usage (ESM)

import * as blizzardAPI from "@pinta365/blizzard-api";

const clientId = "<YOUR CLIENT ID>";
const clientSecret = "<YOUR SECRET>";

blizzardAPI.setup({
    clientId,
    clientSecret,
    region: "eu",
    locale: "en_GB",
});

const sword = await blizzardAPI.wow.item(33791);
console.log(sword);

Basic Usage (CommonJS)

const blizzardAPI = require("@pinta365/blizzard_api");

// Use blizzardAPI the same way as in the previous example.

Issues

Issues or questions concerning the library can be raised at the github repository page.

License

This project is licensed under the MIT License - see the LICENSE file for details.