Documentation / @blizzard-api/d3
@blizzard-api/d3
This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for Diablo 3.
Installation
npm i @blizzard-api/core @blizzard-api/d3Usage
You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the d3 export.
import { d3 } from "@blizzard-api/d3"
//or
import d3 from "@blizzard-api/d3"
const act = d3.act(1);
^ { path: string, namespace?: string, parameters?: Record<string, never> }If you don't want to use the exported d3 object, you can also access the functions directly:
import { act } from "@blizzard-api/d3"
const achi = act(1);
^ { path: string, namespace?: string, parameters?: Record<string, never> }Types
If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:
import type { ActResponse } from '@blizzard-api/d3';If you simply want to use the existing object, you can use the helper, ExtractResourceType, from @blizzard-api/core like so:
import { d3 } from "@blizzard-api/d3"
const act = d3.act(1);
^ { path: string, namespace?: string, parameters?: Record<string, never> }
type ActResponse = ExtractResourceType<typeof act>;Notes on Types
The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely to be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.
Client
While this package is made to function on it's own, it performs even better when combined with @blizzard-api/client where you can easily request data combining the two libraries.
import { createBlizzardApiClient } from '@blizzard-api/client';
import { d3 } from '@blizzard-api/d3';
const client = await createBlizzardApiClient({
key: process.env.BLIZZARD_CLIENT_ID!,
secret: process.env.BLIZZARD_CLIENT_SECRET!,
origin: 'eu',
});
//Response will automatically be typed with the appropriate values
const response = await client.sendRequest(d3.act(1));
console.log(response);
^ typeof ActResponse | undefinedModules
Interfaces
- AccountHeroFollowerItemsResponse
- AccountHeroItemsResponse
- AccountHeroResponse
- AccountResponse
- ActIndexResponse
- ActResponse
- ArtisanResponse
- Attributes
- CharacterClassResponse
- EraIndexResponse
- EraLeaderboardResponse
- EraResponse
- FollowerResponse
- Item
- ItemResponse
- Primary
- RandomAffix
- RecipeResponse
- SeasonIndexResponse
- SeasonLeaderboardResponse
- SeasonResponse
- SkillResponse
- Type
Type Aliases
Variables
Functions
- account
- accountHero
- accountHeroFollowerItems
- accountHeroItems
- act
- actIndex
- artisan
- characterClass
- era
- eraIndex
- eraLeaderboard
- follower
- item
- itemType
- itemTypeIndex
- recipe
- season
- seasonIndex
- seasonLeaderboard
- skill
References
default
Renames and re-exports d3