README.md

RiotAPI PHP wrapper for League of Legends

Version v2.0.0

Table of Contents

1. Introduction
2. Downloading
3. League of Legends API
   1. Resource versions
   2. Initializing the library
   3. Usage example
   4. Cache providers
   5. Rate limiting
   6. Call caching
   7. Asynchronous requests
   8. StaticData endpoints
   9. StaticData linking
   10. Extensions
   11. Callback functions
   12. CLI support
4. Other Riot APIs

Introduction

Welcome to the League of Legends PHP library repo! The goal of this library is to create easy-to-use library for anyone who might need one. This is a fully object oriented API wrapper for League of Legends API.

Here are some handy features:

• Rate limit caching and limit exceeding prevention - fully automatic.
• Call caching - enables the library to re-use already fetched data within given timespan - saves time and key's rate limit.
• StaticData endpoints - you can work with StaticData endpoints as if they were never deprecated.
• StaticData linking - library can automatically link related StaticData right into the returned object.
• Custom callbacks - you can set custom function which will be called before or after the request is processed.
• Object extensions - you can implement your own methods to the fetched API objects and enable yourself to use them later to ease of your work.
• CLI supported - usage of this library in console is extremely easy.
• Interim mode support - you are going to be able to use the library the same way whether your key is in interim mode or not (meaning you won't need to change anything when you jump to production).
• Objects everywhere - API calls return data in special objects, this allows modern IDEs to hint existing properties and methods.

Please, refer mainly to the wiki pages. This file contains only general introduction to library features.

Downloading

The easiest way to download and use this library is via Composer. If you are not using Composer yet, you should start right now!

While having Composer installed on your machine it takes only composer require "dolejska-daniel/riot-api-league:^1" command to get the library ready to roll!

For additional information about downloading and initial setup, please see the wiki pages.

League of Legends API

Resource versions

Below you can find table of implemented API resources and the version in which these are currently implemented. Please refer to wiki pages for additional information about endpoints and resources.

Resource	Status
Champion
Champion Mastery
Challenges
Clash
League
League Exp
Masteries
Match
Runes
Spectator
Static Data
Stats
Status
Summoner
Third Party Code
Tournament
Tournament Stub

Initializing the library

How to begin?

//  Include all required files (installation via Composer is required)
require_once __DIR__  . "/vendor/autoload.php";

use RiotAPI\LeagueAPI\LeagueAPI;
use RiotAPI\Base\Definitions\Region;

//  Initialize the library
$api = new LeagueAPI([
	//  Your API key, you can get one at https://developer.riotgames.com/
	LeagueAPI::SET_KEY    => 'YOUR_RIOT_API_KEY',
	//  Target region (you can change it during lifetime of the library instance)
	LeagueAPI::SET_REGION => Region::EUROPE_EAST,
]);

//  And now you are ready to rock!
$summoner = $api->getSummonerByName("I am TheKronnY");
$matchlist = $api->getMatchlistByAccount($summoner->accountId);
foreach ($matchlist as $match) {
	//  ...
}

And there is a lot more settings that you can set when initializing the library - mainly to enable special features or to amend default behaviour of the library. Please see the wiki pages for complete list of library's settings.

Usage example

Working with LeagueAPI can not be easier, just take a look at how to fetch summoner information based on summoner's name:

//  ...initialization...

//  this fetches the summoner data and returns SummonerDto object
$summoner = $api->getSummonerByName('I am TheKronnY');

echo $summoner->id;             //  KnNZNuEVZ5rZry3I...
echo $summoner->puuid;          //  rNmb6Rq8CQUqOHzM...
echo $summoner->name;           //  I am TheKronnY
echo $summoner->summonerLevel;  //  69

print_r($summoner->getData());  //  Or array of all the data
/* Array
 * (
 *     [id] => KnNZNuEVZ5rZry3IyWwYSVuikRe0y3qTWSkr1wxcmV5CLJ8
 *     [accountId] => tGSPHbasiCOgRM_MuovMKfXw7oh6pfXmGiPDnXcxJDohrQ
 *     [puuid] => rNmb6Rq8CQUqOHzMsFihMCUy4Pd201vDaRW9djAoJ9se7myXrDprvng9neCanq7yGNmz7B3Wri4Elw
 *     [name] => I am TheKronnY
 *     [profileIconId] => 3180
 *     [revisionDate] => 1543438015000
 *     [summonerLevel] => 69
 * )
 */

More usage examples for LeagueAPI can be found here.

Cache providers

Cache providers are responsible for keeping data of rate limiting, call caching and static data within instances of the library for easy re-use. This feature is automatically enabled, when any of previously mentioned features is used.

When using this feature, you can set LeagueAPI::SET_CACHE_PROVIDER to any class, thought it has to be compatible with PSR-6 standard, eg. implement Psr\Cache\CacheItemPoolInterface interface. By using LeagueAPI::SET_CACHE_PROVIDER_PARAMS or LeagueAPI::SET_DD_CACHE_PROVIDER_PARAMS option, you can pass any data to the cache provider class.

For additional information about cache providers, please see the wiki pages.

Rate limiting

This clever feature will easily prevent exceeding your per key call limits & method limits. In order to enable this feature, you have to set LeagueAPI::SET_CACHE_RATELIMIT to true. Everything else is completly automatic, so all you need to do is to enable this feature.

For additional information about rate limiting, please see the wiki pages.

Call caching

This feature can prevent unnecessary calls to API within short timespan by temporarily saving fetched data from API and using them as the result data. In order to enable this feature, you have to set LeagueAPI::SET_CACHE_CALLS to true. You should also provide LeagueAPI::SET_CACHE_CALLS_LENGTH option to specify cached data lifetime or else default time interval of 60 seconds will be used.

For additional information about API call caching, please see the wiki pages.

Asynchronous requests

This feature allows request grouping and their asynchronous sending using Guzzle. After request is sent and its response received, user provided callbacks are invoked with received data.

For additional information about asynchronous requests, please see the wiki pages.

StaticData endpoints

These endpoints provide you with easy way to transform StaticData into object instances and easily work with them. They are also supported in numerous DataDragonAPI functions (displaying images).

For additional information about StaticData endpoints, please see the wiki pages.

StaticData linking

This feature allows you to automatically link static data related to your request, any data are managed through DataDragonAPI. All the static data will be locally cached, which makes this operation very fast after its initial requests. Also, any requests made by DataDragonAPI do not count towards your rate limit.

For additional information about StaticData linking, please see the wiki pages.

Extensions

Using extensions for ApiObjects is extremely useful tool, allowing implementation of your own methods and logic into the ApiObjects themselves. Extensions are enabled by using settings option LeagueAPI::SET_EXTENSIONS when initializing the library.

For additional information about API object extensions, please see the wiki pages.

Callback functions

Allows you to provide custom functions to be called before and after the actual API request is sent.

Before callbacks have ability to cancel upcomming request - when false is returned by any callback function, exception Exceptions\RequestException is raised and request is cancelled.

For additional information about callback functions, please see the wiki pages.

Other Riot APIs

Library Description	Latest Version	Stable Version
All APIs (metapackage)
DataDragon API
Teamfight Tactics API
Legends of Runeterra API
Valorant API