Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mthomason12/battlenet-api-browser

Battle.NET API Browser
https://github.com/mthomason12/battlenet-api-browser

angular api battle-dot-net json spa world-of-warcraft

Last synced: 3 days ago
JSON representation

Battle.NET API Browser

Host: GitHub
URL: https://github.com/mthomason12/battlenet-api-browser
Owner: mthomason12
License: bsd-2-clause
Created: 2025-02-04T21:46:24.000Z (16 days ago)
Default Branch: public
Last Pushed: 2025-02-11T23:19:12.000Z (9 days ago)
Last Synced: 2025-02-12T00:24:01.177Z (9 days ago)
Topics: angular, api, battle-dot-net, json, spa, world-of-warcraft
Language: TypeScript
Homepage:
Size: 1.44 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # Battle.NET API Browser

[SPA](https://en.wikipedia.org/wiki/Single-page_application) client for the [Battle.net API](https://develop.battle.net/), written in [Angular](https://angular.dev).

This is a work in progress, many parts of the API are not implemented yet and only have a placeholder folder icon.  

View the [changelog](CHANGELOG.md) for details on new releases

![screenshot of the Covenants API viewing the Kyrian covenant](doc/images/screenshot-kyrian.png)

## Requirements

### Development and Build

- Node v22.12.0, not tested on earlier versions.  

### Runtime

Tested on Chrome (132.0.6834.110), Firefox (113.0.3), and Edge (132.0.2957.127) running from a local webserver.

Precomplied releases can be found at https://github.com/mthomason12/battlenet-api-browser/releases

Builds are triggered by going to the **battlenet-api-browser** directory and running:

```npm run build``` for the self-hosted version (which will be output to the **dist** folder), you'll need to put this onto a webserver to run it.

```npm run electron-build``` for the Electron version (which will be output to the **out** folder)- this should automatically pick the Electron binary for the platform you're running on.  You can then run this as a local application. No installer is generated.

```npm run electron-make-deb``` on a compatible Linux system will build a .deb package for the Electron version in the **out** folder.

```npm run electron-make-win``` on a compatible Windows system will build a Windows setup.exe for the Electron version in the **out** folder.

Or if you want to work on the live codebase:

```ng serve``` to serve the Angular application, rebuilding live on file edits.

## Usage

The vast majority of data is left as-is from the Battle.net API.  

However, some things are tweaked for usability, and some are combined. For example, exporting "achievements" as JSON will give you an object with both "items" and "details" arrays, with "items" containing the data from getAchievementIndex and "details" containing the individual items from getAchievement.  get....Media calls are automatically run after the applicable query, with the results being appended to a mediaData property on the original item.  The focus is on making it easier for end users, not on matching the API layout 1:1 - if you want that, you can just call the API directly yourself ;) 

Where these additional fields are added to the API result, these are prefixed with $

### Battle.net Client Registration

You will need to provide your own Battle.net API Key and secret. 

You can get this from the [Battle.net Developer Portal](https://develop.battle.net/access/clients)

When registering your client, you'll need to provide a redirect URL.  If running locally under the defaults, this will be http://localhost:4200/auth-callback

Check "I do not have a service URL for this client"

One item on the [roadmap](#roadmap) is to provide a public API proxy for use by this app.

## Known Issues

There is currently very little in the way of error checking and handling.  

Any problem with an API call tends to just fail silently other than an error message in the browser console.  The Electron build is only checked intermittently and may be broken at any time.

Currently everything is hard-coded to the US region.

## Roadmap

- Finish adding viewers for each data type

- Add a custom browse component for every type of data

- Query builder for search APIs

- JSON import (allowing backup/restore with JSON files)

- "Search everything" 

- Connect to a public API server without needing an API key