irelia

Node.js League of Legends API Wrapper

npm install irelia
1 downloads in the last week
32 downloads in the last month

Irelia

Travis Status

Irelia is a Node.js Wrapper that will allow you to start coding easily with the League of Legends Oficial API.

Get your API Key at http://developer.riotgames.com

There are API limits right now, so use the API with caching with Redis, Memcache, etc.

Installation

npm install irelia

Usage

var Irelia = require('irelia');
var irelia = new Irelia({
    secure: true,
    host: 'prod.api.pvp.net',
    path: '/api/lol/'
    key: 'your_key_goes_here',
    debug: true
});
irelia.getSummonerByName('euw', 'NSZombie', function (err, res){
    console.log(err, res);
});

Errors

var Irelia = require('irelia');
var irelia = new Irelia({
    secure: true,
    host: 'prod.api.pvp.net',
    path: '/api/lol/'
    key: 'your_key_goes_here',
    debug: true
});
irelia.getSummonerByName('euw', 'NSZombie', function (err, summoner){
    if(err){
        if(err.status){
            if(err.status.code == 429){
                console.log(err.status.message);
            } else if(err.status.code == 404){
                console.log(err.status.message);
            } else if(err.status.code == 500){
                console.log(err.status.message);
            } else {
                console.log('Unknown error code');
            }
        } else {
            console.log(err); // Non http error
        }
    } else {
        console.log(summoner);
    }
});

Constants

  • lol.regions['euw'] -> 'Europe West'
  • lol.queues[2] -> 'Normal 5v5 Blind Pick'
  • lol.gametypes['CUSTOM_GAME'] -> 'Custom game'
  • lol.gamemode['CLASSIC'] -> 'Summoner's Rift/Twisted Treeline game'

Methods

Callbacks - Response is given asyncronly using callbacks.

irelia.getChampions('euw', true, function (err, champions){
    console.log(err, champions);
});
  • irelia.getChampions(region, freeToPlay[optional], callback);
  • irelia.getRecentGamesBySummonerId(region, summonerId, callback);
  • irelia.getLeagueBySummonerId(region, summonerId, callback);
  • irelia.getLeagueEntryBySummonerId(region, summonerId, callback);
  • irelia.getChallengerLeagueByGametype(region, type[example'RANKED_SOLO_5X5'])
  • irelia.getSummaryStatsBySummonerId(region, summonerId, season [optional], callback);
  • irelia.getRankedStatsBySummonerId(region, summonerId, season [optional], callback);
  • irelia.getMasteriesBySummonerId(region, summonerId, callback);
  • irelia.getRunesBySummonerId(region, summonerId, callback);
  • irelia.getSummonerByName(region, name, callback);
  • irelia.getSummonerBySummonerId(region, summonerId, callback);
  • irelia.getSummonersBySummonerIds(region, summonerIds[Array list], callback);
  • irelia.getTeamsBySummonerId(region, summonerId, callback);

Stats

  • irelia.getRealms(region, callback);
  • irelia.getRunes(version, locale, callback);
  • irelia.getMasteries(version, locale, callback);
  • irelia.getItems(version, locale, callback);
  • irelia.getChampionsData(version, locale, callback);
  • irelia.getSummonerSpells(version, locale, callback);
  • irelia.getLanguage(version, locale, callback);
npm loves you