Git Product home page Git Product logo

rgac's Introduction

RGAC

This Riot Games API Client is written in TypeScript and offers fluent interfaces, full typing, data classes.

Example usage with top level await:

import {RiotApiClient, Servers} from 'rgac';
const client = new RiotApiClient({
    apiKey: process.env.RIOT_API_KEY,
    server: Servers.EUW1
});
const summoner = await client.leagueOfLegends.summoner.byName('GindenEU');
const {data: [match], getNextPage} = await summoner.getMatches();
const timeline = await match.timeline();
const {data: [anotherMatch]} = await getNextPage();

Features

  • Support for following APIs:
    • champion-mastery-v4
    • champion-v3
    • league-exp-v4
    • league-v4
    • lol-status-v3
    • match-v4
    • spectator-v4
    • summoner-v4
    • third-party-code-v4
  • Rich objects:
    • Summoner and Match classes
  • Joi schemas for all API interfaces
  • TypeScript interfaces for API data

Known limitations

  • Limited rate limiting - currently, you can specify only maxRequests and perMilliseconds and it's less flexible than system provided by Riot Games.
  • Need to manually check if has next page.

Roadmap

  • TFT API support
  • Tournament API support
  • Legends of Runeterra support
  • Intelligent caching of responses
  • AsyncIterables for pagination

Contributing

See CONTRIBUTING.MD;

Disclaimer

RGAC isn’t endorsed by Riot Games and doesn’t 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.

rgac's People

Contributors

ginden avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.