battlenet

README

BattleNet

A Golang library for retrieving data from Blizzard's Battle.net API.

Requires Go 1.12 or higher.

Install

$ go get github.com/munsy/battlenet

Example

package main

import (
        "flag"
        "fmt"
        "net/http"
        "time"

        "github.com/munsy/battlenet"
)

var tokenFlag = flag.String("t", "", "Battle.net API token (required).")

func main() {
        flag.Parse()

        if *tokenFlag == "" {
                fmt.Println("No token provided.")
                return
        }

        // Create settings for the client. This is not required, but
        // is necessary for non-default settings.
        settings := &battlenet.Settings{
                Client: &http.Client{Timeout: (10 * time.Second)},
                Locale: battlenet.Locale.AmericanEnglish,
                Region: battlenet.Regions.US,
        }

        // Create a new client for accessing the Battle.net Account API.
        // There are also clients for Diablo III, Starcraft II, and WoW.
        client, err := battlenet.AccountClient(settings, *tokenFlag)

        if nil != err {
                panic(err)
        }

        // Make a request. Each method corresponds to a Battle.net endpoint.
        response, err := client.BattleID()

        if nil != err {
                panic(err)
        }

        // Get the underlying data. You can also see the endpoint that was called,
        // as well as your quota usage.
        bid := response.Data

        fmt.Printf("ID: %d\n", bid.ID)
        fmt.Printf("BattleTag: %s\n", bid.BattleTag)
}

$ go build -o account.exe
$ ./account.exe -t $YOUR_API_TOKEN_HERE
ID: 12345654321
BattleTag: Munsy#78910

Additional examples for Diablo III, Starcraft II, and World of Warcraft can be found in the examples package.

Bug Reporting/Fixing

Please submit all bug reports as issues. This section will be updated in the future with a more comprehensive guide to submitting helpful bug reports and/or bug fixes.

Contributing

• Testing is mostly what is needed right now
• Submit contributions as pull requests

Licensing

GoBattleNet is licensed under the MIT License. See LICENSE for the full license text.

Documentation

Overview

Package battlenet provides clients for accessing Blizzard Entertainment's various Battle.net API endpoints, including ones for Diablo III, Starcraft II, Overwatch, and World of Warcraft.

Official Battle.net API documentation can be found at: https://dev.battle.net/io-docs

Index

• Variables
• func AccountClient(s *Settings, token string) (*account.Client, error)
• func D3Client(s *Settings, key string) (*d3.Client, error)
• func SC2Client(s *Settings, key string) (*sc2.Client, error)
• func WoWClient(s *Settings, key string) (*wow.Client, error)
• type Client
• type Quota
• type Settings

Variables

var Endpoint = func(r regions.Region) oauth2.Endpoint {
	return oauth2.Endpoint{
		AuthURL:  r.AuthURL(),
		TokenURL: r.TokenURL(),
	}
}

Endpoint is Battle.net's OAuth 2.0 endpoint. Defaults to US if Region is not otherwise defined.

For more information see: https://dev.battle.net/docs/read/oauth

var Locale = struct {
	AmericanEnglish     locale.Locale
	BrazilianPortuguese locale.Locale
	BritishEnglish      locale.Locale
	CastilianSpanish    locale.Locale
	EuropeanPortuguese  locale.Locale
	MexicanSpanish      locale.Locale
	SimplifiedChinese   locale.Locale
	StandardFrench      locale.Locale
	StandardGerman      locale.Locale
	StandardItalian     locale.Locale
	StandardKorean      locale.Locale
	StandardRussian     locale.Locale
	TraditionalChinese  locale.Locale
}{
	locale.AmericanEnglish,
	locale.BrazilianPortuguese,
	locale.BritishEnglish,
	locale.CastilianSpanish,
	locale.EuropeanPortuguese,
	locale.MexicanSpanish,
	locale.SimplifiedChinese,
	locale.StandardFrench,
	locale.StandardGerman,
	locale.StandardItalian,
	locale.StandardKorean,
	locale.StandardRussian,
	locale.TraditionalChinese,
}

Locale holds all of the possible Battle.net locale definitions.

var Regions = struct {
	US  regions.Region
	EU  regions.Region
	KR  regions.Region
	TW  regions.Region
	SEA regions.Region
	CN  regions.Region
}{
	US:  regions.US,
	EU:  regions.EU,
	KR:  regions.KR,
	TW:  regions.TW,
	SEA: regions.SEA,
	CN:  regions.CN,
}

Regions holds all of the possible Battle.net regions.

Functions

func AccountClient

func AccountClient(s *Settings, token string) (*account.Client, error)

AccountClient returns a new client for accessing the Battle.net Account API.

func D3Client

func D3Client(s *Settings, key string) (*d3.Client, error)

D3Client returns a new client for accessing the Diablo III API.

func SC2Client

func SC2Client(s *Settings, key string) (*sc2.Client, error)

SC2Client returns a new client for accessing the Starcraft II API.

func WoWClient

func WoWClient(s *Settings, key string) (*wow.Client, error)

WoWClient returns a new client for accessing the World of Warcraft API.

Types

type Client

type Client interface {
	// Region returns the client's current region as a string.
	Region() string

	// Locale returns the client's current locale as a string.
	Locale() string

	// UserAgent returns the client User-Agent header used in API requests.
	UserAgent() string
}

Client defines the Battle.net API client interface.

type Quota

type Quota interface {
	// QPSAllotted returns the allotted QPS.
	QPSAllotted() int

	// QPSCurrent returns the current QPS.
	QPSCurrent() int

	// QuotaAlloted returns the alloted quota.
	QuotaAlloted() int

	// QuotaCurrent returns the current quota.
	QuotaCurrent() int

	// QuotaReset returns the time the quota will reset.
	QuotaReset() time.Time
}

Quota defines the battlenet.Quota interface.

type Settings

type Settings struct {
	Client *http.Client
	Locale locale.Locale
	Region regions.Region
}

Settings defines settings for a Client.