# overwatch-api-wrapper

> A wrapper for the Overwatch API

Latest version **1.0.0** (published 2016-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install overwatch-api-wrapper
pnpm add overwatch-api-wrapper
yarn add overwatch-api-wrapper
bun add overwatch-api-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-06-27 |
| First published | 2016-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Bryan Mytko |
| Maintainers | bryanmytko |

## Links

- npm: https://www.npmjs.com/package/overwatch-api-wrapper
- Repository: https://github.com/bryanmytko/overwatch-api
- Homepage: https://github.com/bryanmytko/overwatch-api#readme
- Issues: https://github.com/bryanmytko/overwatch-api/issues
- npm.io page: https://npm.io/package/overwatch-api-wrapper

## Dependencies (2)

- [merge](https://npm.io/package/merge.md) ^1.2.0
- [unirest](https://npm.io/package/unirest.md) ^0.5.0

## Recent versions

- 1.0.0 (latest) — 2016-06-27

## README

# Overwatch API Wrapper

![logo](http://i.imgur.com/uHMulGP.jpg)

__NOTE:__ _This is currently just a placeholder and code skeleton since the Overwatch API has not yet been publicly exposed._

## Requirements

Get an Access Token from Blizzard [https://dev.battle.net/io-docs](https://dev.battle.net/io-docs)

## Usage

Setup:

    var access_token = 'xxxxxxxxxxxxxxxxxxxxx';
    var locale = 'enUS';

    var Overwatch = require('overwatch-api');
    client = new Overwatch(access_token, locale);


## Developers

Tests require an env-vars.js file in **/test** directory with access token field:

    module.exports = {
      'BLIZZARD_ACCESS_TOKEN': 'xxxxxxxxxxxxxxxxxxxxxxx'
    };

Run with `mocha` or `mocha debug test/ -R spec`

## Contributing

1. Fork it ( https://github.com/[my-github-username]/d3-leaderboard-node/fork )
1. Create your feature branch (git checkout -b my-new-feature)
1. Commit your changes (git commit -am 'Add some feature')
1. Push to the branch (git push origin my-new-feature)
1. Create a new Pull Request

---
_Source: https://npm.io/package/overwatch-api-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._