Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

leagueapiwrapper

Package Overview
Dependencies
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

leagueapiwrapper

League API Wrapper. Easy to use wrapper for the League Of Legends API

  • 2.1.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
42
decreased by-75.29%
Maintainers
1
Weekly downloads
 
Created
Source

LeagueAPIWrapper (Node.JS)

Simple Wrapper for all League Of Legends API methods

https://www.npmjs.com/package/leagueapiwrapper

Example get accountInfo object to be used in other methods:

let LeagueAPI = require('leagueapiwrapper');
LeagueAPI = new LeagueAPI(leagueAPIKey, Region.NA);

LeagueAPI.getSummonerByName('LeagueOfSausage')
    .then(function(accountInfo) {
        // do something with accountInfo
	console.log(accountInfo);
    })
    .catch(console.error);

Get featured games, populated with DDRagon data

LeagueAPI.initialize()
    .then(function(){ return LeagueAPI.getFeaturedGames() })
    .then(function(data) {
        console.log(data);
    })
    .catch(console.error);

Methods

initialize

// Objects will now contain full objects, instead of id's. 
// E.G from 'mapId: 12' to 'mapObject: { id: 12 name: howlingAbyss ... }'
LeagueAPI.initialize()
    .then() {
    	// LeagueAPI returned objects will now have details from DDRagon API.
    })
    .catch(console.error);

setFullyLoadClasses(boolean)

// Setting initialize() sets to true.
// Must call initialize if setting this to true
LeagueAPI.setFullyLoadClasses(false);

changeRegion(Region)

// Changed Region for API calls
LeagueAPI.changeRegion(Region.NA);

getThirdPartyCode(AccountObject)

// Returns thirdPartyCode. Note: will 'Forbidden' if no thirdPartyCode is available for the accountInfo/accountId
// Note: I don't have an accountId example that works here
LeagueAPI.getThirdPartyCode(accountId)
	.then(function(data) {
		console.log(data);
	})
	.catch(console.error);

getStatus()

// Returns the status of the LeagueAPI endpoints 
LeagueAPI.getStatus()
	.then(console.log)
	.catch(console.error);

getFeaturedGames()

// Returns the current featured games on League
LeagueAPI.getFeaturedGames()
	.then(console.log)
	.catch(console.error);

getMatch(matchId)

// matchId taken from a getMatchList call
// Gets the Match object for the ID passed
LeagueAPI.getMatch(2970107953)
	.then(console.log)
	.catch(console.error);

getMatchByTournament(matchId, tournamentCode)

// Gets the Match object for the ID passed with tournamentCode. Note: I don't have an example tournament code
LeagueAPI.getMatchByTournament(2970107953, tournamentCode)
	.then(console.log)
	.catch(console.error);

getMatchIdsByTournament(tournamentCode)

// Gets the Match ids for the tournamentCode. Note: I don't have an example tournament code
LeagueAPI.getMatchIdsByTournament(tournamentCode)
	.then(console.log)
	.catch(console.error);

getClash(accountObj)

LeagueAPI.getClash(accountObj)
	.then(console.log)
	.catch(console.error);

getClashTournament()

LeagueAPI.getClashTournament()
	.then(console.log)
	.catch(console.error);

getLeagueRanking(accountObject)

LeagueAPI.getSummonerByName('LeagueOfDrMundo').then(function(accountObject) {
	LeagueAPI.getLeagueRanking(accountObject)
		.then(console.log)
		.catch(console.error);
});

getSummonerByName(summonerName)

// Returns an accountObject which can be used in other methods, or view account information on
LeagueAPI.getSummonerByName('LeagueOfDrMundo')
	.then(function(accountObject) {
		console.log(accountObject);
	})
	.catch(console.error);

getActiveGames(accountObject)

LeagueAPI.getSummonerByName('LeagueOfDrMundo')
	.then(function(accountObject) {
		// Gets active games. Will return 404 if not currently in an active game
		return LeagueAPI.getActiveGames(accountObject);
	})
	.then(function(activeGames) { 
		console.log(activeGames);
	})
	.catch(console.error);

getMatchList(accountObject)

LeagueAPI.getSummonerByName('LeagueOfDrMundo')
	.then(function(accountObject) {
		// Gets match list for the account
		return LeagueAPI.getMatchList(accountObject);
	})
	.then(function(activeGames) { 
		console.log(activeGames);
	})
	.catch(console.error);

getMatchTimeline(matchId)

// Returns a timeline of the match
LeagueAPI.getMatchTimeline(3026936146)
	.then(console.log)
	.catch(console.error);

getChampionMasteryTotal(accountObject)

LeagueAPI.getSummonerByName('LeagueOfSausage')
	.then(function(accountObj) {
		// Returns the total champion master (sum of all champion mastery for all champions)
		return LeagueAPI.getChampionMasteryTotal(accountObj);
	})
	.then(function(championMasteryTotal)
	{
		console.log(championMasteryTotal);
	})
	.catch(console.error);

getChampionMastery(accountObject)

LeagueAPI.getSummonerByName('LeagueOfDrMundo')
	.then(function(accountObj) {
		// Returns a list of every single champion played by the account, along with mastery details
		return LeagueAPI.getChampionMastery(accountObj);
	})
	.then(function(championMasteryList)
	{
		console.log(championMasteryList);
	})
	.catch(console.error);

getChampionMasteryByChampion(accountObject, championObj)

const drMundoChampId = 36;
const leagueOfDrMundoSummonerId = 'IE2WdICfZnhEWYPIBfHio7jxCeo1IFynclJAPquqENRrpeYK';

// Returns the championMastery details for the given account/accountId and champion/championId
LeagueAPI.getChampionMasteryByChampion(leagueOfDrMundoSummonerId, drMundoChampId)
	.then(console.log)
	.catch(console.error);

getFreeChampionRotation()


// Returns details for the current champion rotation. Initialize first for details on each champion
LeagueAPI.getFreeChampionRotation()
	.then(console.log)
	.catch(console.error);

Disclaimer

MundoScript is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.

Feel free to make suggestions on features/etc.

Keywords

FAQs

Package last updated on 04 Jan 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc