Skip to content
This repository has been archived by the owner on Jan 8, 2022. It is now read-only.

theblitzapp/championgg-api-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node.js Client for the Champion.GG API

NPM

Build Status via Travis CI

The official Champion.GG API Node.js Client.

installation

npm i @solomid/node-gg

If you really need an ES5 version:

npm i @solomid/[email protected]

usage

First, instantiate the wrapper with your api key

const GG = require('node-gg');
const gg = GG.init('YOUR_KEY');

Then you gain access to all current endpoints of the API! All but initialization require a callback function and some also require either role or champion_id, along with an optional object with ...options. These options are passed as query string params and are page, limit, elo, sort and champData. For more details on these parameters, please refer to the Champion.GG API documentation.

The methods are:

Method Parameters
.init api_key
.statistics.overall options, cb
.statistics.general options, cb
.champions.all options, callback
.champions.specific champId, options, callback
.champions.specificRole champId, role, options, callback
.champions.specificMatchup champ1Id, champ2Id, role, options, callback

tests

npm test

contributing

Feel free to contribute, let's just try to keep it readable :)