| name | league-sdk |
| description | Build League of Legends apps using league-sdk TypeScript library. Use when working with Riot API, summoner/player lookups, match history, champion mastery, ranked stats, live game spectator, or building LoL Discord bots, websites, or apps. |
League SDK
Typed TypeScript SDK for Riot LoL API. Handles routing, PUUID conversions, rate limiting.
LoL API Concepts
Scope: This SDK covers League of Legends only. TFT, Valorant, Wild Rift have separate APIs.
PUUID: Universal ID across Riot games. Preferred over SummonerId/AccountId (deprecated).
Platform: Use player's server (kr for Korean, euw1 for EU West). Wrong platform = 404.
Queue IDs: 420 Solo/Duo, 440 Flex, 450 ARAM, 400 Normal Draft, 430 Blind
Timestamps: Unix epoch milliseconds → new Date(match.gameCreation)
Match history: Riot retains ~2 years. Older matches may be unavailable.
Patterns
import { LolClient, NotFoundError, RateLimitError } from 'league-sdk';
const client = new LolClient({
apiKey: process.env.RIOT_API_KEY!,
platform: 'na1'
});
const player = await client.players.getByRiotId('Name', 'Tag');
const soloQ = await player.getSoloQueueStats();
const matches = await player.getMatches({ count: 10, queue: 420 });
for (const match of matches) {
const p = match.getParticipant(player.puuid)!;
console.log(`${p.championName} ${p.kills}/${p.deaths}/${p.assists} - ${p.win ? 'W' : 'L'}`);
}
const p = match.getParticipant(player.puuid)!;
p.kills; p.deaths; p.assists; p.kda;
p.championName; p.win;
p.items;
p.totalCs; p.csPerMinute;
p.damage.toChampions; p.damage.taken;
p.goldEarned; p.visionScore;
match.gameDurationFormatted;
match.queueName;
match.blueTeam; match.redTeam;
match.getWinner(); match.didPlayerWin(player.puuid);
const { blueTeam, redTeam } = match;
console.log(`Blue: ${blueTeam.totalKills}K, ${blueTeam.totalGold}g`);
const game = await player.getLiveGame();
const top = await player.getTopMastery(3);
const champs = await client.dataDragon.getChampions();
const items = await client.dataDragon.getItems();
await client.dataDragon.getChampionIconUrl('Ahri');
await client.dataDragon.getItemIconUrl(3157);
Asset Downloads
npx league-sdk-assets --output ./assets --all
Programmatic: import { downloadAllAssets } from 'league-sdk/scripts'
Platforms
na1 euw1 eun1 kr jp1 br1 la1 la2 oc1 tr1 ru sg2 ph2 th2 tw2 vn2
Troubleshooting
- 401: API key expired (dev keys last 24h)
- 404: Wrong platform or player doesn't exist
- 429: Rate limited (SDK handles automatically)
- NotFoundError: Player/match doesn't exist
- RateLimitError: Has
retryAfter property (seconds)
- AuthenticationError: Invalid API key