blizzard

KO | EN

gitlite — search

#hacktoberfest #go #machine-learning #deep-learning #macos #nodejs #awesome #cli #vue #security #mcp #ios #openai #open-source

(★ 65)

Go client library for Blizzard API data

blizzard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# blizzard

[![Go Reference](https://pkg.go.dev/badge/github.com/FuzzyStatic/blizzard/v3.svg)](https://pkg.go.dev/github.com/FuzzyStatic/blizzard/v3) [![Go Report Card](https://goreportcard.com/badge/github.com/FuzzyStatic/blizzard)](https://goreportcard.com/report/github.com/FuzzyStatic/blizzard)

> This is a Go client library for gathering [Blizzard API reference](https://develop.battle.net/documentation) data

## Table of Contents

- [blizzard](#blizzard)
  - [Table of Contents](#table-of-contents)
  - [Getting Started](#getting-started)
    - [Fetching Diablo 3 Data](#fetching-diablo-3-data)
    - [Fetching Hearthstone Data](#fetching-hearthstone-data)
    - [Fetching Overwatch League Data](#fetching-overwatch-league-data)
    - [Fetching StarCraft 2 Data](#fetching-starcraft-2-data)
    - [Fetching World of Warcraft Data](#fetching-world-of-warcraft-data)
    - [Fetching World of Warcraft Classic Data](#fetching-world-of-warcraft-classic-data)
  - [Authorization for User Data](#authorization-for-user-data)
    - [Fetching OAuth Data](#fetching-oauth-data)
    - [Streaming Provider Service (Playable Titles)](#streaming-provider-service-playable-titles)
  - [Header Information](#header-information)
  - [Documentation](#documentation)
  - [Special Thanks](#special-thanks)

## Getting Started

First, download the Blizzard library:

```shell
go get github.com/FuzzyStatic/blizzard/v3
```

Start using the library by initiating a new Blizzard config structure for your desired region and locale (client_id and client_secret can be acquired through your developer account at [https://develop.battle.net/](https://develop.battle.net/)) and requesting an access token:

```go
usBlizzClient, err := blizzard.NewClient(blizzard.Config{
  ClientID:     "my_client_id",
  ClientSecret: "my_client_secret",
  HTTPClient:   http.DefaultClient,
  Region:       blizzard.US,
  Locale:       blizzard.EnUS,
})

err = usBlizzClient.AccessTokenRequest(ctx)
if err != nil {
  fmt.Println(err)
}

euBlizzClient, err := blizzard.NewClient(blizzard.Config{
  ClientID:     "my_client_id",
  ClientSecret: "my_client_secret",
  HTTPClient:   http.DefaultClient,
  Region:       blizzard.EU,
  Locale:       blizzard.EnGB,
})

err = euBlizzClient.AccessTokenRequest(ctx)
if err != nil {
  fmt.Println(err)
}
```

### Fetching Diablo 3 Data

You can use the functions prefixed with "D3" to acquire Diablo 3 information. For example, you can get information about the current D3 hardcore necromancer leaderboards:

```go
dat, _, err := usBlizzClient.D3SeasonLeaderboardHardcoreNecromancer(ctx, 15)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Fetching Hearthstone Data

You can use the functions prefixed with "HS" to acquire Hearthstone information. For example, you can get information about all the Hearthstone cards:

```go
dat, _, err := usBlizzClient.HSCardsAll(ctx)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Fetching Overwatch League Data

You can use the functions prefixed with "OWL" to acquire Overwatch League information. For example, you can get information about the Overwatch League:

```go
dat, _, err := usBlizzClient.OWLSummaryData(ctx)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Fetching StarCraft 2 Data

You can use the functions prefixed with "SC2" to acquire StarCraft 2 information. For example, you can get information about the current SC2 grandmaster ladder:

```go
dat, _, err := usBlizzClient.SC2LadderGrandmaster(ctx, blizzard.EU)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Fetching World of Warcraft Data

You can use the functions prefixed with "WoW" to acquire World of Warcraft information. For example, you can get information about your WoW character profile:

```go
dat, _, err := usBlizzClient.WoWCharacterProfileSummary(ctx, "illidan", "wildz")
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

or get information about specific spells:

```go
dat, _, err := usBlizzClient.WoWSpell(ctx, 17086)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

or the PvP leaderboards:

```go
dat, _, err := usBlizzClient.WoWCharacterPvPBracketStatistics(ctx, wowp.Bracket3v3)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Fetching World of Warcraft Classic Data

You can use the functions prefixed with "ClassicWoW" to acquire World of Warcraft Classic information. Blizzard provides data for three Classic versions: Era (the original Classic experience), Anniversary (the enhanced Classic edition), and Progression (the current Classic progression).

For example, you can get information about WoW Classic Era creature data:

```go
dat, _, err := usBlizzClient.ClassicWoWEraCreature(ctx, 30)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

Or get information about WoW Classic Anniversary creature data:

```go
dat, _, err := usBlizzClient.ClassicWoWAnniversaryCreature(ctx, 30)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

Or get information about WoW Classic Progression creature data:

```go
dat, _, err := usBlizzClient.ClassicWoWCreature(ctx, 30)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

## Authorization for User Data

To use the `UserInfoHeader` or `WoWUserCharacters` functions to acquire data about other users (and not your own), you must use the OAuth2 redirect method to get an authorized token. This is useful for building websites that display more personal or individualized data. The following code snippet is an example on how to acquire authorized tokens for other users. A working example can be found in the [examples/authCodeFlow](https://github.com/FuzzyStatic/blizzard/tree/master/examples/authCodeFlow) directory. Before the redirect URI will work, you will have to add it to your client settings at <https://develop.battle.net/access>:

```go
package main

import (
  "context"
  "encoding/json"
  "fmt"
  "log"
  "net/http"

"github.com/FuzzyStatic/blizzard/v3"
  "github.com/FuzzyStatic/blizzard/v3/oauth"
  "golang.org/x/oauth2"
)

var (
  cfg           oauth2.Config
  usBlizzClient *blizzard.Client
)

// Homepage
func HomePage(w http.ResponseWriter, r *http.Request) {
  fmt.Println("Homepage Hit!")
  u := cfg.AuthCodeURL("my_random_state")
  http.Redirect(w, r, u, http.StatusFound)
}

// Authorize
func Authorize(w http.ResponseWriter, r *http.Request) {
  err := r.ParseForm()
  if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
    return
  }

state := r.Form.Get("state")
  if state != "my_random_state" {
    http.Error(w, "State invalid", http.StatusBadRequest)
    return
  }

code := r.Form.Get("code")
  if code == "" {
    http.Error(w, "Code not found", http.StatusBadRequest)
    return
  }

token, err := cfg.Exchange(context.Background(), code)
  if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
    return
  }

e := json.NewEncoder(w)
  e.SetIndent("", "  ")
  err = e.Encode(*token)
  if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
    return
  }

dat1, _, err := usBlizzClient.UserInfoHeader(token)
  if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
    return
  }

fmt.Printf("%+v\n", dat1)

dat2, _, err := usBlizzClient.WoWUserCharacters(token)
  if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
    return
  }

fmt.Printf("%+v\n", dat2)
}

func main() {
  blizz = blizzard.NewClient("client_id", "client_secret", blizzard.US, blizzard.EnUS)
  cfg = usBlizzClient.AuthorizeConfig("http://<mydomain>:9094/oauth2", oauth.ProfileD3, oauth.ProfileSC2, oauth.ProfileWoW)

http.HandleFunc("/", HomePage)
  http.HandleFunc("/oauth2", Authorize)

// We start up our Client on port 9094
  log.Println("Client is running at 9094 port.")
  log.Fatal(http.ListenAndServe(":9094", nil))
}
```

### Fetching OAuth Data

Now you can validate those tokens with the OAuth API:

```go
dat, _, err := usBlizzClient.TokenValidation(ctx, token)
if err != nil {
  fmt.Println(err)
}

fmt.Printf("%+v\n", dat)
```

### Streaming Provider Service (Playable Titles)

Cloud‑gaming partners can ask Blizzard which titles a given user is allowed to launch.  To do this, request the `streaming.titles` and `openid` scopes when building the authorization URL.  After the user completes the OAuth flow you will have an access token suitable for SPS.

Use the new `SPSPlayableTitles` helper to call the service:

```go
pts, hdr, err := usBlizzClient.SPSPlayableTitles(ctx, token)
if err != nil {
    fmt.Println(err)
}

for _, t := range pts.Titles {
    fmt.Printf("%d: %s\n", t.ID, t.Name)
}
```

The response contains every eligible title or sub‑title available to the
account.

For a complete runnable example, see [examples/sps](./examples/sps).

## Header Information

Each API call will return HTTP response header information, if any. Use the second return variable to get a structure containing the response header information.

```go
dat, header, err := usBlizzClient.WoWAuctions(context.Background(), 1138)
if err != nil {
  fmt.Println(err)
}

fmt.Println(header.BattlenetNamespace)
fmt.Println(header.LastModified)
...
```

## Documentation

See the [Blizzard API reference](https://develop.battle.net/documentation/guides) and the [Go reference](https://pkg.go.dev/github.com/FuzzyStatic/blizzard/v3) for all the different datasets that can be acquired. For questions and discussion about the blizzard API go to the [Blizzard API Forum](https://us.forums.blizzard.com/en/blizzard/c/api-discussion/18).

## Special Thanks

Thanks to [JSON-to-Go](https://mholt.github.io/json-to-go/) for making JSON to Go structure creation simple.

Thanks to all who contribute to keep this package current.

blizzard

blizzard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

blizzard

blizzard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README