defiant/lolapi

PHP wrapper for the League of Legends API.

Lolapi

League of Legends Api Wrapper

This library allows you to calls to the RIOT API with a proper API Key. Simply replace API_KEY_HERE with your API key from Riot Games. If you don't have a key you can get one from here., _(*1)

This is still a work in progress., _(*2)

Installation

Use composer!, _(*3)

Usage

Initialize the Api, _(*4)

$api = new Lolapi('API_KEY_HERE');, _(*5)

Set the Api you want to use. Valid Choices:, _(*6)

• Champion
• Game
• History
• League
• Match
• StaticData
• Stats
• Status
• Summoner
• Team

For example to get the Summoner details you can do something like this., _(*7)

    $api->Summoner()->byName('remataklan'));
// or
    $summoner = new Summoner;
    $remataklan = $summoner->byName('remataklan')

You should get an array containing the summoner details., _(*8)

APIs

Champion

Get the Champion data from the api. This returns current champion info., _(*9)

Get all the champions:, _(*10)

$api->Champion()->all(), _(*11)

Get a champion by its id:, _(*12)

$api->Champion()->byId($id), _(*13)

Game

Get recent games for a player by that players id. (Max 10 Games returned by Riot), _(*14)

$api->Game()->recent(), _(*15)

History

Retrieve match history by summoner ID. You can query multiple summoners., _(*16)

Simple call: You can send a single id to query a single Summoner., _(*17)

$api->History()->get($id), _(*18)

Parameters are sent as an array, Array key and values are listed below:, _(*19)

• championIds (ids of champions to filter)
• rankedQueues (valid options: RANKED_SOLO_5x5, RANKED_TEAM_3x3, RANKED_TEAM_5x5)
• beginIndex: The begin index to use for fetching games.
• endIndex: The begin index to use for fetching games.

$params = ['championIds' => 1, 'rankedQueues' => 'RANKED_SOLO_5x5'];
$api->History()->get($id, $params);

League

Get various league information., _(*20)

Get leagues mapped by summoner ID for a given list of summoner IDs., _(*21)

By Summoner or Team

$ids: a single Summoner or Team id or an array of integers for multiple ids:, _(*22)

$this->League()->bySummoner($ids);, _(*23)

$this->League()->byTeam($ids);, _(*24)

By Summoner or Team Entry

Get leagues mapped by team ID for a given list of team IDs or Summoner IDs., _(*25)

$this->League()->entryBySummoner($ids);, _(*26)

$this->League()->entryByTeam($ids);, _(*27)

Match

Get match details for a given match., _(*28)

$this->match()->detail($id);, _(*29)

or you can supply a second parameter (bool) to ask for timeline. Not all matches have timeline info., _(*30)

$this->match()->detail($id, true);, _(*31)

StaticData

All static data from riot are queried using this method. This method's api calls does not count toward your rate limit., _(*32)

Champion

Get static data about a champion. The following will get all champions with default parameter., _(*33)

$api->StaticData()->champion();, _(*34)

To get a specific champion with default parameters:, _(*35)

// Note that you must supply an empty array for default 
// parameters when requesting a specific champion

$api->StaticData()->champion([], $id);

Valid $params, You can pass them as array key/value pairs, _(*36)

• locale
• version
• dataById (TRUE or FALSE - Only for all champs)
• champData ['allytips', 'altimages', 'blurb', 'enemytips', 'image', 'info', 'lore', 'partype', 'passive', 'recommended', 'skins', 'spells', 'stats', 'tags']

// Note that if you want more than one champData param
// you can pass it as a comma separated string

$api->StaticData()->champion(['champData' => 'allytips, lore'])

Item

Get static data about an item. The following will get all items with default parameter., _(*37)

$api->StaticData()->item();, _(*38)

To get a specific item with default parameters:, _(*39)

// Note that you must supply an empty array for default 
// parameters when requesting a specific item

$api->StaticData()->item([], $id);

Valid $params, You can pass them as array key/value pairs, _(*40)

• locale
• version
• itemListData ['all', 'colloq', 'consumeOnFull', 'consumed', 'depth', 'from', 'gold', 'groups', 'hideFromAll', 'image', 'inStore', 'into', 'maps', 'requiredChampion', 'sanitizedDescription', 'specialRecipe', 'stacks', 'stats', 'tags', 'tree']

// Note that if you want more than one itemlistData param
// you can pass it as a comma separated string

$api->StaticData()->item(['itemListData' => 'image, inStore'])

Mastery

Get static data about an item. The following will get all masteries with default parameter., _(*41)

$api->StaticData()->mastery();, _(*42)

To get a specific item with default parameters:, _(*43)

// Note that you must supply an empty array for default 
// parameters when requesting a specific mastery

$api->StaticData()->mastery([], $id);

Valid $params, You can pass them as array key/value pairs, _(*44)

• locale
• version
• masteryListData ['all', 'image', 'prereq', 'ranks', 'sanitizedDescription', 'tree']

// Note that if you want more than one masterylistData param
// you can pass it as a comma separated string

$api->StaticData()->mastery(['maseryListData' => 'image, ranks'])

Realm

Retrieve realm data., _(*45)

$api->StaticData()->realm();, _(*46)

Summoner Spells

Get static data about a summoner spell. The following will get all spells with default parameter., _(*47)

$api->StaticData()->summonerSpell();, _(*48)

To get a specific spell with default parameters:, _(*49)

// Note that you must supply an empty array for default 
// parameters when requesting a specific spell

$api->StaticData()->summonerSpell([], $id);

Valid $params, You can pass them as array key/value pairs, _(*50)

• locale
• version
• dataById (TRUE or FALSE - Only for all champs)
• spellData ['all', 'cooldown', 'cooldownBurn', 'cost', 'costBurn', 'costType', 'effect', 'effectBurn', 'image', 'key', 'leveltip', 'maxrank', 'modes', 'range', 'rangeBurn', 'resource', 'sanitizedDescription', 'sanitizedTooltip', 'tooltip', 'vars']

// Note that if you want more than one spellData param
// you can pass it as a comma separated string

$api->StaticData()->summonerSpell(['spellData' => 'cooldown, tooltip'])

Runes

Get static data about a rune. The following will get all runes with default parameter., _(*51)

$api->StaticData()->rune();, _(*52)

To get a specific rune with default parameters:, _(*53)

// Note that you must supply an empty array for default 
// parameters when requesting a specific mastery

$api->StaticData()->rune([], $id);

Valid $params, You can pass them as array key/value pairs, _(*54)

• locale
• version
• runeListData ['all', 'basic', 'colloq', 'consumeOnFull', 'consumed', 'depth', 'from', 'gold', 'hideFromAll', 'image', 'inStore', 'into', 'maps', 'requiredChampion', 'sanitizedDescription', 'specialRecipe', 'stacks', 'stats', 'tags']

// Note that if you want more than one masterylistData param
// you can pass it as a comma separated string

$api->StaticData()->mastery(['maseryListData' => 'image, ranks'])

Versions

Retrieve version data., _(*55)

$api->StaticData()->versions();, _(*56)

Stats

Get Summoner stats. You can omit $season to get the latest season., _(*57)

Get ranked stats by summoner ID., _(*58)

$api->Stats()->ranked($id, $season);, _(*59)

Get player stats summaries by summoner ID., _(*60)

$api->Stats()->summary($id, $seson);, _(*61)

Status

Get shard list:, _(*62)

$api->Status()->shards();, _(*63)

Get shard status. Returns the data available on the status.leagueoflegends.com website for the given region., _(*64)

$api->Status()->shards('na');, _(*65)

Summoner

Get info about a summoner., _(*66)

$api->Summoner()->get($id);, _(*67)

Above method call will get info about a summoner. You can pass an array as parameter. This array can contain both names (strings) and ids (integers), _(*68)

For example:, _(*69)

This query will get both user named remataklan and user with id 343443:, _(*70)

$api->Summoner()->get(['remataklan', 343443]);, _(*71)

runes

Get runes pages by summoners IDs. A single integer or an array of integers as parameters:, _(*72)

$api->Summoner()->runes($ids), _(*73)

masteries

Get runes pages by masteries IDs. A single integer or an array of integers as parameters:, _(*74)

$api->Summoner()->masteries($ids), _(*75)

name

Get summoner names mapped by summoner ID for a given list of summoner IDs. A single integer or an array of integers as parameters:, _(*76)

$api->Summoner()->name($ids), _(*77)

Team

Get teams mapped by summoner ID for a given list of summoner IDs., _(*78)

$api->Team()->bySummoner($ids), _(*79)

Get teams mapped by team ID for a given list of team IDs., _(*80)

$api->Team()->teams($teamIds);, _(*81)

A single integer or an array of integers as parameters for both methods., _(*82)