lor-api-wrapper

Node.js Riot Legends of Runeterra API Wrapper

Features

• HTTPS REST API
• Easy access to API responses
• Supports all LoR API endpoints
• No external dependences required
• Only uses Node:HTTPS

Installation

Install lifx-api-wrapper with npm:

  npm install lor-api-wrapper

To run this project, you will need a RIOT API key. Get your key here: https://developer.riotgames.com/

Usage

Getting started

import Lor from "lor-api-wrapper";

//create instance with our Riot API Token
var lor = new Lor(lorKey);

//Now lor will always use your key

Specify what region to pull from

There are three regions available to pull data from:

• Americas
• Europe
• SEA

Specify the region you want to pull from when calling your request.

//GET USER PUUID BY NAME AND TAG
var puuid = await lor.getUserByName('Otzo', 'Otzo', 'Americas')

API Reference

The wrapper is designed to use selectors that match RIOT API documentation to simplify use.

For more information visit api.riotgames.com.

lor.getUserByPuuid(puuid, region)

Parameter	Type	Example	Description
puuid	string	'K-1NczBPzqHG1Ab...'	Required
region	string	'Americas'	Required

lor.getUserByName(userName, tagLine, region)

Parameter	Type	Example	Description
userName	string	'Otzo'	Required
tagLine	string	'NA'	Required
region	string	'Americas'	Required

Note: Returns the same information as lor.getUserByPuuid(). The main difference is how you call the user. Most likely you'll use their userName and tagLine to get their puuid for later use.

Example response:

{puuid: 'HfYckhbhJnSBzZZmcIvAJHy4Zpg9rEBeuom5gAIe60boHI7Vtb6D7pFqjIfpMdafWKEhZ0oFNUZCzA', 
gameName: 'Otzo', 
tagLine: 'NA'}

lor.getUserMatchHistory(puuid, region)

Return matchId's for the last 20 games played by selected user.

Parameter	Type	Example	Description
puuid	string	'K-1NczBPzqHG1Ab...'	Required
region	string	'Americas'	Required

Example response:

[
'bcdb95bc-beab-4e59-907d-2eff75aabd98', 
...
'7f10f485-3217-4a3b-bf22-4f63e19fb689', 
'cf36602d-215c-4a00-b0db-309f16695fed', 
'312174dd-2a52-4979-ae04-31aeed0ad7e4'
]

lor.getMatchDetails(matchId, region)

Return match info, including: players, who won, decks played, and more.

Parameter	Type	Example	Description
matchId	string	'bcdb95bc-beab-4...'	Required
region	string	'Americas'	Required

lor.getLeaderboard(region)

Return top players in that region, including: lp, name, and rank.

Parameter	Type	Example	Description
region	string	'Americas'	Required

lor.getLorStatus(region)

Return current server status for that region.

Parameter	Type	Example	Description
region	string	'Americas'	Required

Examples

Grab list of top players in the Americas

var leaderboard = await lor.getLeaderboard('Americas')
    .then((data) => {
        var json = JSON.parse(data.body)

        return json
    }) //catch errors
    .catch((err) => console.log(err));

// do stuff with data
console.log(leaderboard['players'])

Find user's PUUID by userName and tagLine

var puuid = await lor.getUserByName('Otzo', 'Otzo', 'Americas')
    .then((data) => {
        var json = JSON.parse(data.body)

        return json.puuid
    }) //catch errors
    .catch((err) => console.log(err));

//do stuff with data
console.log(puuid);

Grab list of top 20 most recently played games by user PUUID

var matches = await lor.getUserMatchHistory(puuid, 'Americas')
    .then((data) => {
        var json = JSON.parse(data.body)

        return json
    }) //catch errors
    .catch((err) => console.log(err));

//do stuff with data
console.log(matches);

Feedback

I wrote this wrapper to use in my own personal project for tracking Legends of Runeterra Seasonal Tournaments, which does not have a native way of doing so. I was able to quickly create this wrapper by reusing code from my LIFX-Node-Wrapper.

One issue I ran into was deciding how I wanted to handle errors when the API failed (which is alot unfortunately), either due to rate-limiting or random 504 errors. I wasn't sure if the wrapper should catch and handle errors by itself, or if it should just pass them off.

This issue became apparent when implementing the wrapper into my project. I quickly realized not all errors are created equal and am already working on updating the wrapper to handle them better.

Any and all feedback is appreciated.

🔗 Links