net.boreeas.riotapi.rest

Class ThrottledApiHandler

java.lang.Object

net.boreeas.riotapi.rest.ThrottledApiHandler

All Implemented Interfaces:

AutoCloseable, LoLRestApi

public class ThrottledApiHandler
extends Object
implements AutoCloseable, LoLRestApi

Created on 4/23/2014.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ThrottledApiHandler.AsyncCurrentGameHandler
class	ThrottledApiHandler.AsyncFeaturedGamesHandler
static class	ThrottledApiHandler.Limit

Field Summary

Fields

Modifier and Type	Field and Description
ThrottledApiHandler.AsyncCurrentGameHandler	currentGameHandler
ThrottledApiHandler.AsyncFeaturedGamesHandler	featuredGamesHandler
static int	PERIOD

Constructor Summary

Constructors

Constructor and Description
ThrottledApiHandler(Shard shard, String token, ThrottledApiHandler.Limit... lim)

Method Summary

Modifier and Type	Method and Description
void	close() Stops the threads handling pending requests.
static ThrottledApiHandler	developmentDefault(Shard shard, String token) Returns a throttled api handler with the current development request limits, which is 10 requests per 10 seconds and 500 requests per 10 minutes
Future<List<BasicChampData>>	getBasicChampData() Get basic champion data (id, freeToPlay) for all champions
Future<BasicChampData>	getBasicChampData(int id) Get basic champion data for the selected champion
Future<LeagueList>	getChallenger(QueueType queue) Get the region's challenger league
Future<Champion>	getChampion(int id) Get information about the specified champion This method does not count towards the rate limit and is not affected by the throttle
Future<Champion>	getChampion(int id, ChampData champData) Get information about the specified champion This method does not count towards the rate limit and is not affected by the throttle
Future<Champion>	getChampion(int id, ChampData champData, String version, String locale) Get information about the specified champion This method does not count towards the rate limit and is not affected by the throttle
Future<ChampionList>	getChampionListDto() Get champion information for all champions
Future<ChampionList>	getChampionListDto(ChampData champData) Get champion information for all champions.
Future<ChampionList>	getChampionListDto(String locale, String version, boolean dataById, ChampData champData) Get champion information for all champions This method does not count towards the rate limit
Future<Collection<Champion>>	getChampions() All champions in the game.
Future<Collection<Champion>>	getChampions(ChampData champData) All champions in the game.
Future<Collection<Champion>>	getChampions(ChampData champData, String version, String locale, boolean dataById) All champions in the game.
Future<List<BasicChampData>>	getFreeToPlayChampions() Get basic champion data for all free-to-play champions
Future<Item>	getItem(int id) Retrieve a specific item This method does not count towards the rate limit and is not affected by the throttle
Future<Item>	getItem(int id, ItemData data) Retrieve a specific item This method does not count towards the rate limit and is not affected by the throttle
Future<Item>	getItem(int id, ItemData data, String version, String locale) Retrieve a specific item This method does not count towards the rate limit and is not affected by the throttle
Future<ItemList>	getItemList() Get a listing of items in the game This method does not count towards the rate limit and is not affected by the throttle
Future<ItemList>	getItemList(ItemData data) Get a listing of items in the game This method does not count towards the rate limit and is not affected by the throttle
Future<ItemList>	getItemList(ItemData data, String version, String locale) Get a listing of items in the game This method does not count towards the rate limit and is not affected by the throttle
Future<Map<Long,List<LeagueItem>>>	getLeagueEntries(long... summoners) Get a listing of all league entries in the summoners' leagues
Future<List<LeagueItem>>	getLeagueEntries(long summoner) Get a listing of all league entries in the summoner's leagues
Future<Map<String,List<LeagueItem>>>	getLeagueEntries(String... teamIds) Get a listing of all league entries in the teams' leagues
Future<List<LeagueItem>>	getLeagueEntries(String teamId) Get a listing of all league entries in the team's leagues
Future<Map<Long,List<LeagueList>>>	getLeagues(long... summoners) Get a listing of leagues for the specified summoners
Future<List<LeagueList>>	getLeagues(long summoner) Get a listing of leagues for the the summoner
Future<Map<String,List<LeagueList>>>	getLeagues(String... teamIds) Get a listing of leagues for the specified teams
Future<List<LeagueList>>	getLeagues(String teamId) Get a listing of leagues for the specified team
Future<List<String>>	getLocales() Retrieve supported locales for the specified region This method does not count towards your rate limit
Future<LocalizedMessages>	getLocalizedMessages() Retrieve localized strings for the english locale This method does not count towards your rate limit
Future<LocalizedMessages>	getLocalizedMessages(String version, String locale) Retrieve localized strings for the english locale This method does not count towards your rate limit
Future<MapDataOverview>	getMaps() Retrieve map information This method does not count towards the rate limit
Future<MapDataOverview>	getMaps(String version, String locale) Retrieve map information This method does not count towards the rate limit
Future<MasteryList>	getMasteries() Get a listing of all masteries This method does not count towards the rate limit and is not affected by the throttle
Future<MasteryList>	getMasteries(MasteryData data) Get a listing of all masteries This method does not count towards the rate limit and is not affected by the throttle
Future<MasteryList>	getMasteries(MasteryData data, String version, String locale) Get a listing of all masteries This method does not count towards the rate limit and is not affected by the throttle
Future<Mastery>	getMastery(int id) Get a specific mastery This method does not count towards the rate limit and is not affected by the throttle
Future<Mastery>	getMastery(int id, MasteryData data) Get a specific mastery This method does not count towards the rate limit and is not affected by the throttle
Future<Mastery>	getMastery(int id, MasteryData data, String version, String locale) Get a specific mastery This method does not count towards the rate limit and is not affected by the throttle
Future<Set<MasteryPage>>	getMasteryPages(int id) Retrieve the mastery pages of a user
Future<Map<Integer,Set<MasteryPage>>>	getMasteryPagesMultipleUsers(Integer... ids) Retrieve mastery pages for multiple users
Future<MatchDetail>	getMatch(long matchId) Retrieves the specified match, including timeline.
Future<MatchDetail>	getMatch(long matchId, boolean includeTimeline) Retrieves the specified match.
Future<List<MatchSummary>>	getMatchHistory(long playerId) Retrieve a player's match history.
Future<List<MatchSummary>>	getMatchHistory(long playerId, String... championIds) Retrieve a player's match history.
Future<List<MatchSummary>>	getMatchHistory(long playerId, String[] championIds, QueueType... queueTypes) Retrieve a player's match history, filtering out all games not in the specified queues.
Future<List<MatchSummary>>	getMatchHistory(long playerId, String[] championIds, QueueType[] queueTypes, int beginIndex, int endIndex) Retrieve a player's match history, filtering out all games not in the specified queues.
Future<RankedStats>	getRankedStats(long summoner) Get ranked stats for a player
Future<RankedStats>	getRankedStats(long summoner, Season season) Get ranked stats for a player in a specific season
Future<Realm>	getRealm() Get realm information for this region This method does not count towards the rate limit and is not affected by the throttle
Future<List<Game>>	getRecentGames(long summoner) Get a listing of recent games for the summoner
Future<Item>	getRune(int id) Retrieve a specific runes This method does not count towards the rate limit and is not affected by the throttle
Future<Item>	getRune(int id, ItemData data) Retrieve a specific runes This method does not count towards the rate limit and is not affected by the throttle
Future<Item>	getRune(int id, ItemData data, String version, String locale) Retrieve a specific runes This method does not count towards the rate limit and is not affected by the throttle
Future<RuneList>	getRuneList() Get a list of all runes This method does not count towards the rate limit and is not affected by the throttle
Future<RuneList>	getRuneList(ItemData data) Get a list of all runes This method does not count towards the rate limit and is not affected by the throttle
Future<RuneList>	getRuneList(ItemData data, String version, String locale) Get a list of all runes This method does not count towards the rate limit and is not affected by the throttle
Future<Set<RunePage>>	getRunePages(int id) Retrieve the runes pages of a user
Future<Map<Integer,Set<RunePage>>>	getRunePagesMultipleUsers(int... ids) Retrieve runes pages for multiple users
Future<List<ShardData>>	getShards() Retrieves general information about each shard.
Future<ShardStatus>	getShardSatatus(Shard shard) Deprecated. Use #getShardStatus instead.
Future<ShardStatus>	getShardStatus(Shard shard) Retrieves detailed information about the specified shard.
Future<List<PlayerStats>>	getStatsSummary(long summoner) Get player stats for the player
Future<List<PlayerStats>>	getStatsSummary(long summoner, Season season) Get player stats for the player
Future<Summoner>	getSummoner(int id) Get summoner information for the summoner with the specified id
Future<Summoner>	getSummoner(String name) Get summoner information for the specified summoner
Future<Long>	getSummonerId(String name) Retrieve the summoner id for the specified user
Future<List<Long>>	getSummonerIds(String... names) Retrieve summoner ids for the specified names
Future<String>	getSummonerName(int id) Retrieve the summoner name of the specified user
Future<Map<Integer,String>>	getSummonerNames(Integer... ids) Retrieve summoner names for the specified ids
Future<Map<Integer,Summoner>>	getSummoners(Integer... ids) Get summoner information for the summoners with the specified ids
Future<Map<String,Summoner>>	getSummoners(String... names) Get summoner information for the summoners with the specified names
Future<SummonerSpell>	getSummonerSpell(int id) Retrieve a specific summoner spell This method does not count towards the rate limit and is not affected by the throttle
Future<SummonerSpell>	getSummonerSpell(int id, SpellData data) Retrieve a specific summoner spell This method does not count towards the rate limit and is not affected by the throttle
Future<SummonerSpell>	getSummonerSpell(int id, SpellData data, String version, String locale) Retrieve a specific summoner spell This method does not count towards the rate limit and is not affected by the throttle
Future<SummonerSpellList>	getSummonerSpellListDro(SpellData data, String version, String locale, boolean dataById) Get a list of all summoner spells as returned by the API This method does not count towards the rate limit and is not affected by the throttle
Future<SummonerSpellList>	getSummonerSpellListDto() Get a list of all summoner spells as returned by the API This method does not count towards the rate limit and is not affected by the throttle
Future<SummonerSpellList>	getSummonerSpellListDto(SpellData data) Get a list of all summoner spells as returned by the API This method does not count towards the rate limit and is not affected by the throttle
Future<Collection<SummonerSpell>>	getSummonerSpells() Get a list of all summoner spells as Java Collection This method does not count towards the rate limit and is not affected by the throttle
Future<Collection<SummonerSpell>>	getSummonerSpells(SpellData data) Get a list of all summoner spells as Java Collection This method does not count towards the rate limit and is not affected by the throttle
Future<Collection<SummonerSpell>>	getSummonerSpells(SpellData data, String version, String locale, boolean dataById) Get a list of all summoner spells as Java Collection This method does not count towards the rate limit and is not affected by the throttle
Future<RankedTeam>	getTeam(String teamId) Retrieve information for the specified ranked team
Future<Map<Long,List<RankedTeam>>>	getTeams(long... ids) Retrieve the ranked teams of the specified users
Future<List<RankedTeam>>	getTeams(long id) Retrieve the ranked teams of a user
Future<Map<String,RankedTeam>>	getTeams(String... teamIds) Retrieve information for the specified ranked teams
Future<List<String>>	getVersions() Retrieve currently supported game versions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.boreeas.riotapi.rest.api.LoLRestApi

getCurrentGameHandler, getFeaturedGamesHandler

Field Detail

PERIOD

public static final int PERIOD

See Also:

Constant Field Values

currentGameHandler

public final ThrottledApiHandler.AsyncCurrentGameHandler currentGameHandler

featuredGamesHandler

public final ThrottledApiHandler.AsyncFeaturedGamesHandler featuredGamesHandler

Constructor Detail

ThrottledApiHandler

public ThrottledApiHandler(Shard shard,
                           String token,
                           ThrottledApiHandler.Limit... lim)

Method Detail

getBasicChampData

public Future<List<BasicChampData>> getBasicChampData()

Get basic champion data (id, freeToPlay) for all champions

Returns:

Basic champion data

See Also:

Official API documentation

getBasicChampData

public Future<BasicChampData> getBasicChampData(int id)

Get basic champion data for the selected champion

Parameters:

id - The id of the champion

Returns:

Basic champion data

See Also:

Official API documentation

getFreeToPlayChampions

public Future<List<BasicChampData>> getFreeToPlayChampions()

Get basic champion data for all free-to-play champions

Returns:

Basic champion data

See Also:

Official API documentation

getRecentGames

public Future<List<Game>> getRecentGames(long summoner)

Get a listing of recent games for the summoner

Parameters:

summoner - The id of the summoner

Returns:

A list of recently played games

See Also:

Official API documentation

getLeagues

public Future<List<LeagueList>> getLeagues(long summoner)

Get a listing of leagues for the the summoner

Parameters:

summoner - The id of the summoner

Returns:

A list of leagues

See Also:

Official API documentation

getLeagues

public Future<Map<Long,List<LeagueList>>> getLeagues(long... summoners)

Get a listing of leagues for the specified summoners

Parameters:

summoners - The ids of the summoners

Returns:

A list of leagues

See Also:

Official API documentation

getLeagueEntries

public Future<List<LeagueItem>> getLeagueEntries(long summoner)

Get a listing of all league entries in the summoner's leagues

Parameters:

summoner - The id of the summoner

Returns:

A list of league entries

See Also:

Official API documentation

getLeagueEntries

public Future<Map<Long,List<LeagueItem>>> getLeagueEntries(long... summoners)

Get a listing of all league entries in the summoners' leagues

Parameters:

summoners - The ids of the summoners

Returns:

A map, mapping summoner ids to lists of league entries for that summoner

See Also:

Official API documentation

getLeagues

public Future<List<LeagueList>> getLeagues(String teamId)

Get a listing of leagues for the specified team

Parameters:

teamId - The id of the team

Returns:

A list of leagues

See Also:

Official API documentation

getLeagues

public Future<Map<String,List<LeagueList>>> getLeagues(String... teamIds)

Get a listing of leagues for the specified teams

Parameters:

teamIds - The ids of the team

Returns:

A mapping of team ids to lists of leagues

See Also:

Official API documentation

getLeagueEntries

public Future<List<LeagueItem>> getLeagueEntries(String teamId)

Get a listing of all league entries in the team's leagues

Parameters:

teamId - The id of the team

Returns:

A list of league entries

See Also:

Official API documentation

getLeagueEntries

public Future<Map<String,List<LeagueItem>>> getLeagueEntries(String... teamIds)

Get a listing of all league entries in the teams' leagues

Parameters:

teamIds - The ids of the teams

Returns:

A mapping of teamIds to lists of league entries

See Also:

Official API documentation

getChallenger

public Future<LeagueList> getChallenger(QueueType queue)

Get the region's challenger league

Parameters:

queue - The queue type for which to retrieve the league information

Returns:

The queue's challenger league

See Also:

Official API documentation

getChampionListDto

public Future<ChampionList> getChampionListDto()

Get champion information for all champions

Returns:

Champion information for all champions

See Also:

Official API documentation

getChampionListDto

public Future<ChampionList> getChampionListDto(ChampData champData)

Get champion information for all champions.

This method does not count towards the rate limit

Parameters:

champData - Additional information to retrieve

Returns:

The information for all champions

See Also:

Official API documentation

getChampionListDto

public Future<ChampionList> getChampionListDto(String locale,
                                               String version,
                                               boolean dataById,
                                               ChampData champData)

Get champion information for all champions

This method does not count towards the rate limit

Parameters:

locale - Locale code for returned data

version - Data dragon version for returned data

dataById - If specified as true, the returned data map will use the champions' IDs as the keys.

champData - Additional information to retrieve

Returns:

The information for all champions

See Also:

Official API documentation

getChampions

public Future<Collection<Champion>> getChampions()

All champions in the game.

This method does not count towards the rate limit and is not affected by the throttle

Returns:

All champions in the game

getChampions

public Future<Collection<Champion>> getChampions(ChampData champData)

All champions in the game.

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

champData - Additional information to retrieve

Returns:

All champions in the game

getChampions

public Future<Collection<Champion>> getChampions(ChampData champData,
                                                 String version,
                                                 String locale,
                                                 boolean dataById)

All champions in the game.

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

locale - Locale code for returned data

version - Data dragon version for returned data

dataById - If specified as true, the returned data map will use the champions' IDs as the keys.

champData - Additional information to retrieve

Returns:

All champions in the game

getChampion

public Future<Champion> getChampion(int id)

Get information about the specified champion

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the champion

Returns:

The champion

See Also:

Official API documentation

getChampion

public Future<Champion> getChampion(int id,
                                    ChampData champData)

Get information about the specified champion

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the champion

champData - Additional information to retrieve

Returns:

The champion

See Also:

Official API documentation

getChampion

public Future<Champion> getChampion(int id,
                                    ChampData champData,
                                    String version,
                                    String locale)

Get information about the specified champion

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

locale - Locale code for returned data

version - Data dragon version for returned data

id - The id of the champion

champData - Additional information to retrieve

Returns:

The champion

See Also:

Official API documentation

getItemList

public Future<ItemList> getItemList()

Get a listing of items in the game

This method does not count towards the rate limit and is not affected by the throttle

Returns:

The list of items

See Also:

Official API documentation

getItemList

public Future<ItemList> getItemList(ItemData data)

Get a listing of items in the game

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

Returns:

The list of items

See Also:

Official API documentation

getItemList

public Future<ItemList> getItemList(ItemData data,
                                    String version,
                                    String locale)

Get a listing of items in the game

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

version - Data dragon version for returned data

locale - Locale code for returned data

data - Additional information to retrieve

Returns:

The list of items

See Also:

Official API documentation

getItem

public Future<Item> getItem(int id)

Retrieve a specific item

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the item

Returns:

The item

See Also:

Official API documentation

getItem

public Future<Item> getItem(int id,
                            ItemData data)

Retrieve a specific item

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the item

data - Additional information to retrieve

Returns:

The item

See Also:

Official API documentation

getItem

public Future<Item> getItem(int id,
                            ItemData data,
                            String version,
                            String locale)

Retrieve a specific item

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the item

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

The item

See Also:

Official API documentation

getMasteries

public Future<MasteryList> getMasteries()

Get a listing of all masteries

This method does not count towards the rate limit and is not affected by the throttle

Returns:

The masteries

See Also:

Official API documentation

getMasteries

public Future<MasteryList> getMasteries(MasteryData data)

Get a listing of all masteries

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

Returns:

The masteries

See Also:

Official API documentation

getMasteries

public Future<MasteryList> getMasteries(MasteryData data,
                                        String version,
                                        String locale)

Get a listing of all masteries

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

The masteries

See Also:

Official API documentation

getMastery

public Future<Mastery> getMastery(int id)

Get a specific mastery

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the mastery

Returns:

The mastery

See Also:

Official API documentation

getMastery

public Future<Mastery> getMastery(int id,
                                  MasteryData data)

Get a specific mastery

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the mastery

data - Additional information to retrieve

Returns:

The mastery

See Also:

Official API documentation

getMastery

public Future<Mastery> getMastery(int id,
                                  MasteryData data,
                                  String version,
                                  String locale)

Get a specific mastery

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the mastery

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

The mastery

See Also:

Official API documentation

getRealm

public Future<Realm> getRealm()

Get realm information for this region

This method does not count towards the rate limit and is not affected by the throttle

Returns:

Realm information

See Also:

Official API documentation

getRuneList

public Future<RuneList> getRuneList()

Get a list of all runes

This method does not count towards the rate limit and is not affected by the throttle

Returns:

All runes

See Also:

Official API documentation

getRuneList

public Future<RuneList> getRuneList(ItemData data)

Get a list of all runes

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

Returns:

All runes

See Also:

Official API documentation

getRuneList

public Future<RuneList> getRuneList(ItemData data,
                                    String version,
                                    String locale)

Get a list of all runes

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

All runes

See Also:

Official API documentation

getRune

public Future<Item> getRune(int id)

Retrieve a specific runes

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the runes

Returns:

The runes

See Also:

Official API documentation

getRune

public Future<Item> getRune(int id,
                            ItemData data)

Retrieve a specific runes

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the runes

data - Additional information to retrieve

Returns:

The runes

See Also:

Official API documentation

getRune

public Future<Item> getRune(int id,
                            ItemData data,
                            String version,
                            String locale)

Retrieve a specific runes

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the runes

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

The runes

See Also:

Official API documentation

getSummonerSpellListDto

public Future<SummonerSpellList> getSummonerSpellListDto()

Get a list of all summoner spells as returned by the API

This method does not count towards the rate limit and is not affected by the throttle

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpellListDto

public Future<SummonerSpellList> getSummonerSpellListDto(SpellData data)

Get a list of all summoner spells as returned by the API

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpellListDro

public Future<SummonerSpellList> getSummonerSpellListDro(SpellData data,
                                                         String version,
                                                         String locale,
                                                         boolean dataById)

Get a list of all summoner spells as returned by the API

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

dataById - If specified as true, the returned data map will use the spells' IDs as the keys.

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpells

public Future<Collection<SummonerSpell>> getSummonerSpells()

Get a list of all summoner spells as Java Collection

This method does not count towards the rate limit and is not affected by the throttle

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpells

public Future<Collection<SummonerSpell>> getSummonerSpells(SpellData data)

Get a list of all summoner spells as Java Collection

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpells

public Future<Collection<SummonerSpell>> getSummonerSpells(SpellData data,
                                                           String version,
                                                           String locale,
                                                           boolean dataById)

Get a list of all summoner spells as Java Collection

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

dataById - If specified as true, the returned data map will use the spells' IDs as the keys.

Returns:

The summoner spells

See Also:

Official API documentation

getSummonerSpell

public Future<SummonerSpell> getSummonerSpell(int id)

Retrieve a specific summoner spell

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the spell

Returns:

The spell

See Also:

Official API documentation

getSummonerSpell

public Future<SummonerSpell> getSummonerSpell(int id,
                                              SpellData data)

Retrieve a specific summoner spell

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the spell

data - Additional information to retrieve

Returns:

The spell

See Also:

Official API documentation

getSummonerSpell

public Future<SummonerSpell> getSummonerSpell(int id,
                                              SpellData data,
                                              String version,
                                              String locale)

Retrieve a specific summoner spell

This method does not count towards the rate limit and is not affected by the throttle

Parameters:

id - The id of the spell

data - Additional information to retrieve

version - Data dragon version for returned data

locale - Locale code for returned data

Returns:

The spell

See Also:

Official API documentation

getVersions

public Future<List<String>> getVersions()

Retrieve currently supported game versions.

This method does not count towards the rate limit

Returns:

A list of supported game versions

See Also:

Official API documentation

getMaps

public Future<MapDataOverview> getMaps()

Retrieve map information

This method does not count towards the rate limit

Returns:

The list of all available map.

See Also:

The official api documentation

getMaps

public Future<MapDataOverview> getMaps(String version,
                                       String locale)

Retrieve map information

This method does not count towards the rate limit

Parameters:

version - The data dragon version.

locale - The locale information.

Returns:

The list of all available maps.

See Also:

The official api documentation

getLocales

public Future<List<String>> getLocales()

Retrieve supported locales for the specified region

This method does not count towards your rate limit

Returns:

A list of locales

See Also:

The official api documentation

getLocalizedMessages

public Future<LocalizedMessages> getLocalizedMessages()

Retrieve localized strings for the english locale

This method does not count towards your rate limit

Returns:

A list of localized message

See Also:

The official api documentation

getLocalizedMessages

public Future<LocalizedMessages> getLocalizedMessages(String version,
                                                      String locale)

Retrieve localized strings for the english locale

This method does not count towards your rate limit

Parameters:

version - The data dragon version of the data

locale - The locale to lookup.

Returns:

A list of localized message

See Also:

The official api documentation

getShards

public Future<List<ShardData>> getShards()

Retrieves general information about each shard.

This method does not count towards your rate limit.

Returns:

A list of shard infomation.

See Also:

Official API Documentation

getShardSatatus

@Deprecated
public Future<ShardStatus> getShardSatatus(Shard shard)

Deprecated. Use #getShardStatus instead.

Retrieves detailed information about the specified shard.

This method does not count towards your rate limit.

Parameters:

shard - The target region

Returns:

A list of shard infomation.

See Also:

Official API Documentation

getShardStatus

public Future<ShardStatus> getShardStatus(Shard shard)

Retrieves detailed information about the specified shard.

This method does not count towards your rate limit.

Parameters:

shard - The target region

Returns:

A list of shard infomation.

See Also:

Official API Documentation

getMatch

public Future<MatchDetail> getMatch(long matchId)

Retrieves the specified match, including timeline. Equivalent to getMatch(matchId, true);

Parameters:

matchId - The id of the match.

Returns:

The match details.

See Also:

Official API Documentation

getMatch

public Future<MatchDetail> getMatch(long matchId,
                                    boolean includeTimeline)

Retrieves the specified match.

Parameters:

matchId - The id of the match.

includeTimeline - Whether or not the event timeline should be retrieved.

Returns:

The match details.

See Also:

Official API Documentation

getMatchHistory

public Future<List<MatchSummary>> getMatchHistory(long playerId)

Retrieve a player's match history.

Parameters:

playerId - The id of the player.

Returns:

The match history of the player.

See Also:

Official API Documentation

getMatchHistory

public Future<List<MatchSummary>> getMatchHistory(long playerId,
                                                  String... championIds)

Retrieve a player's match history.

Parameters:

playerId - The id of the player.

championIds - The championIds to use for retrieval.

Returns:

The match history of the player.

See Also:

Official API Documentation

getMatchHistory

public Future<List<MatchSummary>> getMatchHistory(long playerId,
                                                  String[] championIds,
                                                  QueueType... queueTypes)

Retrieve a player's match history, filtering out all games not in the specified queues.

Parameters:

playerId - The id of the player.

championIds - The championIds to use for retrieval.

queueTypes - The queue types to retrieve (must be one of RANKED_SOLO_5x5, RANKED_TEAM_3x3 or RANKED_TEAM_5x5).

Returns:

The match history of the player.

See Also:

Official API Documentation

getMatchHistory

public Future<List<MatchSummary>> getMatchHistory(long playerId,
                                                  String[] championIds,
                                                  QueueType[] queueTypes,
                                                  int beginIndex,
                                                  int endIndex)

Retrieve a player's match history, filtering out all games not in the specified queues. This method only returns games starting with beginIndex and ending at endIndex.

Parameters:

playerId - The id of the player.

championIds - The championIds to use for retrieval.

queueTypes - The queue types to retrieve (must be one of RANKED_SOLO_5x5, RANKED_TEAM_3x3 or RANKED_TEAM_5x5).

beginIndex - The index of the first game that should be retrieved.

endIndex - The index of the last game the should be retrieved.

Returns:

The match history of the player.

See Also:

Official API Documentation

getRankedStats

public Future<RankedStats> getRankedStats(long summoner)

Get ranked stats for a player

Parameters:

summoner - The id of the summoner

Returns:

Ranked stats

See Also:

Official API documentation

getRankedStats

public Future<RankedStats> getRankedStats(long summoner,
                                          Season season)

Get ranked stats for a player in a specific season

Parameters:

summoner - The id of the summoner

season - The season

Returns:

Ranked stats

See Also:

Official API documentation

getStatsSummary

public Future<List<PlayerStats>> getStatsSummary(long summoner)

Get player stats for the player

Parameters:

summoner - The id of the summoner

Returns:

The player's stats

See Also:

Official API documentation

getStatsSummary

public Future<List<PlayerStats>> getStatsSummary(long summoner,
                                                 Season season)

Get player stats for the player

Parameters:

summoner - The id of the summoner

season - The season

Returns:

The player's stats

See Also:

Official API documentation

getSummoners

public Future<Map<String,Summoner>> getSummoners(String... names)

Get summoner information for the summoners with the specified names

Parameters:

names - The names of the players

Returns:

A map, mapping standardized player names to summoner information

See Also:

Official API documentation, Util.standardizeSummonerName(java.lang.String)

getSummoner

public Future<Summoner> getSummoner(String name)

Get summoner information for the specified summoner

Parameters:

name - The name of the summoner

Returns:

Summoner information

See Also:

Official API documentation

getSummoners

public Future<Map<Integer,Summoner>> getSummoners(Integer... ids)

Get summoner information for the summoners with the specified ids

Parameters:

ids - The ids of the summoners

Returns:

A map, mapping player ids to summoner information

See Also:

Official API documentation

getSummoner

public Future<Summoner> getSummoner(int id)

Get summoner information for the summoner with the specified id

Parameters:

id - The id of the summoner

Returns:

Summoner information

See Also:

Official API documentation

getMasteryPagesMultipleUsers

public Future<Map<Integer,Set<MasteryPage>>> getMasteryPagesMultipleUsers(Integer... ids)

Retrieve mastery pages for multiple users

Parameters:

ids - The ids of the users

Returns:

A map, mapping player ids to their respective mastery pages

See Also:

Official API documentation

getMasteryPages

public Future<Set<MasteryPage>> getMasteryPages(int id)

Retrieve the mastery pages of a user

Parameters:

id - The user's id

Returns:

The user's mastery pages

See Also:

Official API documentation

getSummonerNames

public Future<Map<Integer,String>> getSummonerNames(Integer... ids)

Retrieve summoner names for the specified ids

Parameters:

ids - The ids to lookup

Returns:

A map, mapping user ids to summoner names

See Also:

Official API documentation

getSummonerName

public Future<String> getSummonerName(int id)

Retrieve the summoner name of the specified user

Parameters:

id - The id of the user

Returns:

The summoner name of the user

See Also:

Official API documentation

getRunePagesMultipleUsers

public Future<Map<Integer,Set<RunePage>>> getRunePagesMultipleUsers(int... ids)

Retrieve runes pages for multiple users

Parameters:

ids - The ids of the users

Returns:

A map, mapping user ids to their respective runes pages

See Also:

Official API documentation

getRunePages

public Future<Set<RunePage>> getRunePages(int id)

Retrieve the runes pages of a user

Parameters:

id - The user's id

Returns:

The user's runes page

See Also:

Official API documentation

getTeams

public Future<List<RankedTeam>> getTeams(long id)

Retrieve the ranked teams of a user

Parameters:

id - The user's id

Returns:

The ranked teams of the user

See Also:

Official API documentation

getTeams

public Future<Map<Long,List<RankedTeam>>> getTeams(long... ids)

Retrieve the ranked teams of the specified users

Parameters:

ids - The users' ids

Returns:

The ranked teams of the users

See Also:

Official API documentation

getTeam

public Future<RankedTeam> getTeam(String teamId)

Retrieve information for the specified ranked team

Parameters:

teamId - The team to retrieve

Returns:

Information about the specified team

See Also:

Official API documentation

getTeams

public Future<Map<String,RankedTeam>> getTeams(String... teamIds)

Retrieve information for the specified ranked teams

Parameters:

teamIds - The ids of the teams

Returns:

A map, mapping team ids to team information

See Also:

Official API documentation

getSummonerIds

public Future<List<Long>> getSummonerIds(String... names)

Retrieve summoner ids for the specified names

Parameters:

names - The names of the users

Returns:

Their respective ids

getSummonerId

public Future<Long> getSummonerId(String name)

Retrieve the summoner id for the specified user

Parameters:

name - The name of the user

Returns:

Their respective ids

close

public void close()

Stops the threads handling pending requests. No further requests will be executed, but any running thread will complete first

Specified by:

close in interface AutoCloseable

developmentDefault

public static ThrottledApiHandler developmentDefault(Shard shard,
                                                     String token)

Returns a throttled api handler with the current development request limits, which is 10 requests per 10 seconds and 500 requests per 10 minutes

Parameters:

shard - The target server

token - The api key

Returns:

The api handler