# mw-api-wrapper

> API Wrapper for Modern Warfare (2019)

Latest version **0.0.5** (published 2020-03-15) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-03-15 |
| First published | 2020-03-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| Author | Saenai |
| Maintainers | saenai |
| Keywords | ModernWarfare, CallOfDuty, COD, MW, API, Wrapper |

## Links

- npm: https://www.npmjs.com/package/mw-api-wrapper
- npm.io page: https://npm.io/package/mw-api-wrapper

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.19.2
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.3
- [request](https://npm.io/package/request.md) ^2.88.2
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.5

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2020-03-15
- 0.0.4 — 2020-03-15
- 0.0.3 — 2020-03-15
- 0.0.2 — 2020-03-15
- 0.0.1 — 2020-03-15

## README

#Modern Warfare API Wrapper

##Features
- Profile Data
- Mode-Specific Data
- Global Leaderboards (Top 100)

##Install

```npm install --save mw-api-wrapper```

##Example

```javascript
const mw = require("mw-api-wrapper");

mw.profile.get("Saenai#2426", "battle").then((output) => {
    console.log(output);
});
```

##Profile Data
###mw.profile.view(username, platform)          // Entire Profile
###mw.profile.get(username, platform)           // Compact Profile Lifetime Stats
###mw.profile.getFull(username, platform)       // Full Profile Lifetime Stats
###mw.profile.getMode(username, platform, mode) // Get Stats for Mode
`username` - Username, including if applicable.

`platform` - `battle`, `psn` or `xbl`.

`mode` - `dom`, `war`, `hq`, `hc_dom`, `hc_conf`, `koth`, `conf`, `hc_hq`, `br_dmz`, `br`, `sd`, `cyber`, `hc_war`, `br_all`, `hc_sd` or `hc_cyber`.

##Global Leaderboards (Top 100) // Only Kills as of 0.0.5
###mw.leaderboard.`<platform>`()
`platform` - `pc`, `psn`, `xbl`.

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