quick-riotgames-api
v2.0.9
Published
A simnple RiotGames api handeler
Downloads
18
Readme
Riot Games API Client
This is a TypeScript library for interacting with the Riot Games API, specifically designed for League of Legends data retrieval. It includes utility functions, services for retrieving data about champions, regions, and various game-related information.
Installation
npm install quick-riotgames-api@latest
API DOC @API
Usage
Riot Developer
go to https://developer.riotgames.com/
get your API_KEY
And Enjoy
DdragonService
A service for interacting with the Data Dragon API to retrieve information about champions.
RegionsService
A service for working with regions and their specific configurations.
RiotGamesAPI
The main class for interacting with the Riot Games API. It provides various methods for retrieving data related to accounts, champion mastery, clash, leagues, and more.
Examples
import {
Ddragon,
GlobalRegions,
RegionService,
Regions,
RiotGamesAPI,
InterCache,
} from "quick-riotgames-api";
const cache = new InterCache(36_000_000);
const main = async () => {
// With DdragonService
const api = RiotGamesAPI.create(
"YOUR_API_KEY",
new RegionService(GlobalRegions.EUROPE, Regions.EUN1),
cache,
await Ddragon.Service.create(cache)
);
const w1 = await api.account().byRiotID("Name#Tag").Ok();
// Without DragonService
const api2 = RiotGamesAPI.create(
"YOUR_API_KEY",
new RegionService(GlobalRegions.EUROPE, Regions.EUN1),
cache
);
const w2 = await api2.account().byRiotID("Name#Tag").Ok();
};
Please remember to replace 'YOUR_API_KEY'
with the actual API key. This file contains basic information and examples for your project.
Contribution
Feel free to contribute by opening issues or submitting pull requests.
License
This project is licensed under the MIT License.