call-of-duty-nodejs v0.0.1

Call of Duty Stats API Node Wrapper

A simple wrapper to fetch public Call of Duty game stats data.

Note: This is far from perfect, and not all use-cases are covered. There seem to be gaps in the data on the Call of Duty side as well. This has been developed to fit a specific, narrow use-case for the time being.

Usage

Installation

yarn add call-of-duty-nodejs

import {
  getFullStats,
  getPlayerOnLeaderboards,
  Games,
  Platforms,
  WWIILeaderboardData,
  WWIIStatData,
  } from 'call-of-duty-nodejs';

getFullStats<WWIIStatData>(Games.BlackOps3, Platforms.XBL, 'usernameHere').then(results => {
  // results here will be of type ResponseData<WWIIStatData>
});

getPlayerOnLeaderboards<WWIILeaderboardData>(Games.BlackOps3, Platforms.XBL, 'usernameHere').then(results => {
  // results here will be of type LeaderboardResponse<WWIIStatData>
});

Each game has different data, so pass the corresponding data interface into the data fetching functions.

Please see lib/interfaces and lib/constants for more information regarding what can be passed in and expected back.

Contributions

There is a lot of room for improvement in this library currently. Please feel free to help out and submit a pull request.