1.0.0 • Published 6 years ago
async-riot-wrapper v1.0.0
Lightweight ES6 Riot API Wrapper
This is a lightweight Riot API wrapper using async/await. The wrapper does not handle any rate limits, and is simply a tool to help you get data from the API.
How to use:
const api = require('async-riot-wrapper');
const riot = api('API-KEY');
async function howToUse() {
const allChampions = await riot.getAllChampions('euw', true); // If true is not included, freeToPlay is automatically set to false.
}
howToUse();
CHAMPION-MASTERY-V3
/lol/champion-mastery/v3/champion-masteries/by-summoner/{summonerId} : getMasteryBySummonerID(SERVER, SUMMONER_ID);
/lol/champion-mastery/v3/champion-masteries/by-summoner/{summonerId}/by-champion/{championId} : getMasteryBuSummonerChampID(SERVER, SUMMONER_ID, CHAMPION_ID);
/lol/champion-mastery/v3/scores/by-summoner/{summonerId} : getMasteryScoresBySummonerID(SERVER, SUMMONER_ID);
CHAMPION-V3
/lol/platform/v3/champions : getAllChampions(SERVER, FREETOPLAY); // FREETOPLAY optional, default: false
/lol/platform/v3/champions/{id} : getChampionByID(SERVER, ID);
LEAGUE-V3
/lol/league/v3/challengerleagues/by-queue/{queue} : getChallengersByQueue(SERVER, QUEUE);
/lol/league/v3/leagues/{leagueId} : getLeaguesByID(SERVER, ID);
/lol/league/v3/masterleagues/by-queue/{queue} : getMasterLeaguesByQueue(SERVER, QUEUE);
/lol/league/v3/positions/by-summoner/{summonerId} : getLeaguePositionsByID(SERVER, ID);
LOL-STATIC-DATA-V3
All params
are optional URL params that are to be passed with it, to get specific data. Pass as a string. Eg. "?locale=en_US&tags=all"
.
/lol/static-data/v3/champions : getStaticChampions(SERVER, PARAMS);
/lol/static-data/v3/champions/{id} : getStaticChampionsByID(SERVER, ID, PARAMS);
/lol/static-data/v3/items : getStaticItems(SERVER, PARAMS);
/lol/static-data/v3/items/{id} : getStaticItemsByID(SERVER, ID, PARAMS);
/lol/static-data/v3/language-strings : getStaticLanguageStrings(SERVER, PARAMS);
/lol/static-data/v3/languages : getStaticLanguages(SERVER);
/lol/static-data/v3/maps : getStaticMaps(SERVER, PARAMS);
/lol/static-data/v3/masteries : getStaticMasteries(SERVER, PARAMS);
/lol/static-data/v3/masteries/{id} : getStaticMasteriesByID(SERVER, ID, PARAMS);
/lol/static-data/v3/profile-icons : getStaticProfileIcons(SERVER, PARAMS);
/lol/static-data/v3/realms : getStaticRealms(SERVER);
/lol/static-data/v3/reforged-rune-paths : getStaticReforgedRunePaths(SERVER, PARAMS);
/lol/static-data/v3/reforged-rune-paths/{id} : getStaticReforgedRunePathsByID(SERVER, ID, PARAMS);
/lol/static-data/v3/reforged-runes : getStaticReforgedRunes(SERVER, PARAMS);
/lol/static-data/v3/reforged-runes/{id} : getStaticReforgedRunesByID(SERVER, ID, PARAMS);
/lol/static-data/v3/runes : getStaticRunes(SERVER, PARAMS);
/lol/static-data/v3/runes/{id} : getStaticRunesByID(SERVER, ID, PARAMS);
/lol/static-data/v3/summoner-spells : getStaticSummonerSpells(SERVER, PARAMS);
/lol/static-data/v3/summoner-spells/{id} : getStaticSummonerSpellsByID(SERVER, ID, PARAMS);
/lol/static-data/v3/tarball-links : getStaticTarball(SERVER, PARAMS);
/lol/static-data/v3/versions : getStaticVersions(SERVER, PARAMS);
LOL-STATUS-V3
/lol/status/v3/shard-data : getShardData(SERVER);
MATCH-V3
/lol/match/v3/matches/{matchId} : getMatchByID(SERVER, MATCH_ID);
/lol/match/v3/matchlists/by-account/{accountId} : getMatchListByAccount( SERVER, ACCOUNT_ID, PARAMS);
/lol/match/v3/timelines/by-match/{matchId} : getMatchTimelineByID(SERVER, MATCH_ID);
/lol/match/v3/matches/by-tournament-code/{tournamentCode}/ids : getMatchIDsByTournament(SERVER, TOURNAMENT_CODE);
/lol/match/v3/matches/{matchId}/by-tournament-code/{tournamentCode} : getMatchInfoByTournament(SERVER, MATCH_ID, TOURNAMENT_CODE);
SPECTATOR-V3
/lol/spectator/v3/active-games/by-summoner/{summonerId} : getActiveGame(SERVER, SUMMONERID);
/lol/spectator/v3/featured-games : getFeaturedGames(SERVER);
SUMMONER-V3
/lol/summoner/v3/summoners/by-account/{accountId} : getSummonerByAccountID(SERVER, ACCOUNT_ID);
/lol/summoner/v3/summoners/by-name/{summonerName} : getSummonerByName(SERVER, NAME);
/lol/summoner/v3/summoners/{summonerId} : getSummonerBySummonerID(SERVER, SUMMONER_ID);
THIRD-PARTY-CODE-V3
/lol/platform/v3/third-party-code/by-summoner/{summonerId} : getThirdPartyCode(SERVER, SUMMONER_ID);
1.0.0
6 years ago