gnar

gnar

A wrapper for the official League of Legends API.

Getting Started

1. obtain an API key from https://developer.riotgames.com by logging in with your League of Legends Account

2. install gnar as npm module (use --save to persist this to your package.json)

npm install gnar

1. require gnar in your app

var gnar = require('gnar')('<your-api-key>', '<your region>');
// you can change api-key and region later with
//   gnar.configuration.setKey('<new-key>') and
//   gnar.configuration.setRegion('<new-region>')

1. use gnar as you would expect

gnar.summoners.by_name('refridgerator').pipe(process.stdout)
// all stream-based! pipe to what you need

1. as API requests are limited (to 10 per 10s, 500 per 10min by default) you may want to cache your results like

var cache = require('stream-cache'), fs = require('fs');
// easiest way to cache (not fastest!): write to file system
gnar.lol_static_data.champion.all().pipe(fs.createWriteStream('cache/champion.json'));
// then retrieve it again
var champion = fs.createReadStream('cache/champion.json');

API documentation

As this is a pure wrapper for the League of Legends API, please refer the full documentation for details on the API endpoints.

Method parameters (like id, summonerId) are parsed to strings (automatically by JavaScript) and inserted into the request url. Where the League of Legends API allows multiple entries (where the parameter is in plural, like summonerIds, teamIds) you can either pass a string (which is directly inserted into the url) or an array (that will be joined with ,s).

champion

• gnar.champion.all() maps to /api/lol/{region}/v1.2/champion
• gnar.champion.by_id(id) maps to /api/lol/{region}/v1.2/champion/{id}

game

• gnar.game.by_summoner(summonerId) maps to /api/lol/{region}/v1.3/game/by-summoner/{summonerId}/recent

league

• gnar.league.by_summoner(summonerIds) maps to /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}
• gnar.league.entries.by_summoner(summonerIds) maps to /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry
• gnar.league.by_team(teamIds) maps to /api/lol/{region}/v2.5/league/by-team/{teamIds}
• gnar.league.entries.by_team(teamIds) maps to /api/lol/{region}/v2.5/league/by-team/{teamIds}/entry
• gnar.league.challenger() maps to /api/lol/{region}/v2.5/league/challenger

lol_static_data

• gnar.lol_static_data.champion.all() maps to /api/lol/static-data/{region}/v1.2/champion
• gnar.lol_static_data.champion.by_id(id) maps to /api/lol/static-data/{region}/v1.2/champion/{id}
• gnar.lol_static_data.item.all() maps to /api/lol/static-data/{region}/v1.2/item
• gnar.lol_static_data.item.by_id(id) maps to /api/lol/static-data/{region}/v1.2/item/{id}
• gnar.lol_static_data.mastery.all() maps to /api/lol/static-data/{region}/v1.2/mastery
• gnar.lol_static_data.mastery.by_id(id) maps to /api/lol/static-data/{region}/v1.2/mastery/{id}
• gnar.lol_static_data.realm() maps to /api/lol/static-data/{region}/v1.2/realm
• gnar.lol_static_data.rune.all() maps to /api/lol/static-data/{region}/v1.2/rune
• gnar.lol_static_data.rune.by_id(id) maps to /api/lol/static-data/{region}/v1.2/rune/{id}
• gnar.lol_static_data.summoner_spell.all() maps to /api/lol/static-data/{region}/v1.2/summoner-spell
• gnar.lol_static_data.summoner_spell.by_id(id) maps to /api/lol/static-data/{region}/v1.2/summoner-spell/{id}
• gnar.lol_static_data.versions() maps to /api/lol/static-data/{region}/v1.2/versions

match

• gnar.match(matchId) maps to /api/lol/{region}/v2.2/match/{matchId}

matchhistory

• gnar.matchhistory(summonerId) maps to /api/lol/{region}/v2.2/matchhistory/{summonerId}

stats

• gnar.stats.ranked(summonerId) maps to /api/lol/{region}/v1.3/stats/by-summoner/{summonerId}/ranked
• gnar.stats.summary(summonerId) maps to /api/lol/{region}/v1.3/stats/by-summoner/{summonerId}/summary

summoner

• gnar.summoner.by_name(summonerNames) maps to /api/lol/{region}/v1.4/summoner/by-name/{summonerNames}
• gnar.summoner.by_id(summonerIds) maps to /api/lol/{region}/v1.4/summoner/{summonerIds}
• gnar.summoner.masteries(summonerIds) maps to /api/lol/{region}/v1.4/summoner/{summonerIds}/masteries
• gnar.summoner.name(summonerIds) maps to /api/lol/{region}/v1.4/summoner/{summonerIds}/name
• gnar.summoner.runes(summonerIds) maps to /api/lol/{region}/v1.4/summoner/{summonerIds}/runes

team

• gnar.team.by_summoner(summonerIds) maps to /api/lol/{region}/v2.4/team/by-summoner/{summonerIds}
• gnar.team.by_team(teamIds) maps to /api/lol/{region}/v2.4/team/{teamIds}

License

The MIT License (MIT)

Copyright (c) 2014 Dominik Schreiber

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.