Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.16 KB
Raw

@blizzard-api/*

The @blizzard-api collection aims to help you connect to the Blizzard Battle.net API as easily and painlessly as possible. The packages are split up by game, and will contain all the endpoints, parameters, and responses you need to get started.

Installation

If you already have a way of authenticating your application with battle.net, you only need to install the relevant game package you want, e.g.:

npm i @blizzard-api/wow

If your package manager doesn't automatically install peer dependencies, you should also install @blizzard-api/core:

npm i @blizzard-api/core

Currently available game-specific packages are:

  • @blizzard-api/classic-wow
  • @blizzard-api/d3
  • @blizzard-api/hs
  • @blizzard-api/sc2
  • @blizzard-api/wow

The core package gives you access to helper functions such as getBlizzardApi which will quickly get you the hostname and locales for a specific region.

The game package will let you access paths, namespaces, parameters and more for each endpoint. This can imported like so:

import { achievement, wow } from "@blizzard-api/wow"

const achievement = wow.achievement(123);
        ^ { path: string, namespace: string }
//OR LIKE SO
const achievement = achievement(123);
        ^ { path: string, namespace: string }

If you additionally want to have a axios client with built in helpers, you can install @blizzard-api/client which will let you easily connect to the API and begin consuming it.

npm i @blizzard-api/client
import { createBlizzardApiClient } from '@blizzard-api/client';
import { wow } from '@blizzard-api/wow';

const client = await createBlizzardApiClient({
  key: 'environment.blizzardClientId',
  secret: 'environment.blizzardClientSecret',
  origin: 'eu',
});

//Response will automatically be typed with the appropriate values
const response = await client.sendRequest(wow.commodities());

console.log(response.data);
                      ^ typeof AuctionHouseCommoditiesResponse

Authentication

Please refer to the battle.net documentation for guides on how to obtain Blizzard API credentials.