net.rithms.riot.api

Class RiotApi

java.lang.Object

net.rithms.riot.api.RiotApi

All Implemented Interfaces:

java.lang.Cloneable

public class RiotApi
extends java.lang.Object
implements java.lang.Cloneable

This is the main class for using this riot api wrapper. This api is typically used by first constructing a RiotApi instance, and then invoking methods on it to fire synchronous api calls.

Here is an example of how RiotApi is used:

 ApiConfig config = new ApiConfig().setKey("YOUR-API-KEY-HERE");
 RiotApi api = new RiotApi(config);
 Summoner summoner = api.getSummonerByName(Platform.NA, "Tryndamere"); // Gets a Summoner object for the summoner Tryndamere on NA
 

To fire asynchronous api calls, you need an instance of RiotApiAsync, which you can get by calling getAsyncApi().

Version:

4.0.1

Author:

Taylor Caldwell, Daniel 'Linnun' Figge

See Also:

ApiConfig, RiotApiAsync

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
RiotApi() Constructs a RiotApi object with default configuration.
RiotApi(ApiConfig config) Constructs a RiotApi object with the given configuration.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	callCustomApiMethod(ApiMethod method) Call a custom ApiMethod
RiotApi	clone()
int	createTournament(int providerId) Creates a tournament and returns its ID.
int	createTournament(java.lang.String tournamentName, int providerId) Creates a tournament and returns its ID.
java.util.List<java.lang.String>	createTournamentCodes(int tournamentId, int count, int teamSize, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, long... allowedSummonerIds) Create tournament codes for the given tournament.
java.util.List<java.lang.String>	createTournamentCodes(int tournamentId, int count, int teamSize, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, java.lang.String metaData, long... allowedSummonerIds) Create tournament codes for the given tournament.
int	createTournamentProvider(java.lang.String region, java.lang.String callbackUrl) Creates a tournament provider and returns its ID.
CurrentGameInfo	getActiveGameBySummoner(Platform platform, long summonerId) Get current game information for the given summoner ID.
RiotApiAsync	getAsyncApi() Provides a RiotApiAsync object to use for asynchronous api calls.
LeagueList	getChallengerLeagueByQueue(Platform platform, LeagueQueue queue) Get the challenger league for a given queue.
LeagueList	getChallengerLeagueByQueue(Platform platform, java.lang.String queue) Get the challenger league for a given queue.
Champion	getChampion(Platform platform, int id) Retrieve champion by id.
java.util.List<ChampionMastery>	getChampionMasteriesBySummoner(Platform platform, long summonerId) Get all champion mastery entries sorted by number of champion points descending
ChampionMastery	getChampionMasteriesBySummonerByChampion(Platform platform, long summonerId, int championId) Get a champion mastery by summonerId and championId.
int	getChampionMasteryScoresBySummoner(Platform platform, long summonerId) Get a player's total champion mastery score, which is sum of individual champion mastery levels
ChampionList	getChampions(Platform platform) Retrieve all champions.
ChampionList	getChampions(Platform platform, boolean freeToPlay) Retrieve all champions.
Champion	getDataChampion(Platform platform, int id) Retrieves a champion by id.
Champion	getDataChampion(Platform platform, int id, Locale locale, java.lang.String version, ChampionTags... tags) Retrieves a champion by id.
ChampionList	getDataChampionList(Platform platform) Retrieves champion list.
ChampionList	getDataChampionList(Platform platform, Locale locale, java.lang.String version, boolean dataById, ChampionListTags... tags) Retrieves champion list.
Item	getDataItem(Platform platform, int id) Retrieves item by id.
Item	getDataItem(Platform platform, int id, Locale locale, java.lang.String version, ItemTags... tags) Retrieves item by id.
ItemList	getDataItemList(Platform platform) Retrieves item list.
ItemList	getDataItemList(Platform platform, Locale locale, java.lang.String version, ItemListTags... tags) Retrieves item list.
java.util.List<java.lang.String>	getDataLanguages(Platform platform) Retrieve supported languages data.
LanguageStrings	getDataLanguageStrings(Platform platform) Retrieve language strings data.
LanguageStrings	getDataLanguageStrings(Platform platform, Locale locale, java.lang.String version) Retrieve language strings data.
MapData	getDataMaps(Platform platform) Retrieves map data.
MapData	getDataMaps(Platform platform, Locale locale, java.lang.String version) Retrieves map data.
Mastery	getDataMastery(Platform platform, int id) Retrieves mastery item by id.
Mastery	getDataMastery(Platform platform, int id, Locale locale, java.lang.String version, MasteryTags... tags) Retrieves mastery item by id.
MasteryList	getDataMasteryList(Platform platform) Retrieves mastery list.
MasteryList	getDataMasteryList(Platform platform, Locale locale, java.lang.String version, MasteryListTags... tags) Retrieves mastery list.
ProfileIconData	getDataProfileIcons(Platform platform) Retrieve profile icons.
ProfileIconData	getDataProfileIcons(Platform platform, Locale locale, java.lang.String version) Retrieve profile icons.
Realm	getDataRealm(Platform platform) Retrieve realm data.
Rune	getDataRune(Platform platform, int id) Retrieves rune by id.
Rune	getDataRune(Platform platform, int id, Locale locale, java.lang.String version, RuneTags... tags) Retrieves rune by id.
RuneList	getDataRuneList(Platform platform) Retrieves rune list.
RuneList	getDataRuneList(Platform platform, Locale locale, java.lang.String version, RuneListTags... tags) Retrieves rune list.
SummonerSpell	getDataSummonerSpell(Platform platform, int id) Retrieves summoner spell by id.
SummonerSpell	getDataSummonerSpell(Platform platform, int id, Locale locale, java.lang.String version, SpellTags... tags) Retrieves summoner spell by id.
SummonerSpellList	getDataSummonerSpellList(Platform platform) Retrieves summoner spell list.
SummonerSpellList	getDataSummonerSpellList(Platform platform, Locale locale, java.lang.String version, boolean dataById, SpellListTags... tags) Retrieves summoner spell list.
java.util.List<java.lang.String>	getDataVersions(Platform platform) Retrieve version data.
FeaturedGames	getFeaturedGames(Platform platform) Get list of featured games.
java.util.Set<LeaguePosition>	getLeaguePositionsBySummonerId(Platform platform, long summonerId) Get league positions in all queues for a given summonerId.
java.util.List<LeagueList>	getLeaguesBySummonerId(Platform platform, long summonerId) Get leagues in all queues for a given summonerId.
LobbyEventWrapper	getLobbyEventsByTournament(java.lang.String tournamentCode) Gets a list of lobby events by tournamentCode
MasteryPages	getMasteriesBySummoner(Platform platform, long summonerId) Get mastery pages for a given summonerId.
LeagueList	getMasterLeagueByQueue(Platform platform, LeagueQueue queue) Get the master league for a given queue.
LeagueList	getMasterLeagueByQueue(Platform platform, java.lang.String queue) Get the master league for a given queue.
Match	getMatch(Platform platform, long matchId) Get match by matchId.
Match	getMatch(Platform platform, long matchId, long forAccountId) Get match by matchId.
Match	getMatchByMatchIdAndTournamentCode(Platform platform, long matchId, java.lang.String tournamentCode) Retrieve match by matchId and tournamentCode.
java.util.List<java.lang.Long>	getMatchIdsByTournamentCode(Platform platform, java.lang.String tournamentCode) Retrieve match IDs by tournamentCode.
MatchList	getMatchListByAccountId(Platform platform, long accountId) Get matchlist for given account ID and platform ID.
MatchList	getMatchListByAccountId(Platform platform, long accountId, java.util.Set<java.lang.Integer> champion, java.util.Set<java.lang.Integer> queue, java.util.Set<java.lang.Integer> season) Get matchlist for given account ID and platform ID.
MatchList	getMatchListByAccountId(Platform platform, long accountId, java.util.Set<java.lang.Integer> champion, java.util.Set<java.lang.Integer> queue, java.util.Set<java.lang.Integer> season, long beginTime, long endTime, int beginIndex, int endIndex) Get matchlist for given account ID and platform ID.
MatchList	getRecentMatchListByAccountId(Platform platform, long accountId) Deprecated.
RunePages	getRunesBySummoner(Platform platform, long summonerId) Get rune pages for a given summonerId.
ShardStatus	getShardData(Platform platform) Get shard status.
Summoner	getSummoner(Platform platform, long summonerId) Get a summoner object for a given summonerId.
Summoner	getSummonerByAccount(Platform platform, long accountId) Get a summoner object for a given accountId.
Summoner	getSummonerByName(Platform platform, java.lang.String summonerName) Get a single summoner object for a given summonerName.
MatchTimeline	getTimelineByMatchId(Platform platform, long matchId) Get match timeline by matchId.
TournamentCode	getTournamentCode(java.lang.String tournamentCode) Returns the tournament code DTO associated with a tournamentCode.
void	updateTournamentCode(java.lang.String tournamentCode, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, long... allowedSummonerIds) Update the pick type, map, spectator type, or allowed summoners for a code.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final java.util.logging.Logger log

Constructor Detail

RiotApi

public RiotApi()

Constructs a RiotApi object with default configuration. Please note that the default configuration does not contain an api key, and thus cannot be used for most endpoints.

RiotApi

public RiotApi(ApiConfig config)

Constructs a RiotApi object with the given configuration.

Parameters:

config - Configuration to use for this RiotApi object

See Also:

ApiConfig

Method Detail

callCustomApiMethod

public java.lang.Object callCustomApiMethod(ApiMethod method)
                                     throws RiotApiException

Call a custom ApiMethod

Parameters:

method - Custom ApiMethod object

Returns:

Result Dto (if any)

Throws:

java.lang.NullPointerException - If method is null

RiotApiException - If the API returns an error or unparsable result

clone

public RiotApi clone()

Overrides:

clone in class java.lang.Object

createTournament

public int createTournament(java.lang.String tournamentName,
                            int providerId)
                     throws RiotApiException

Creates a tournament and returns its ID.

Parameters:

tournamentName - The optional name of the tournament.

providerId - The provider ID to specify the regional registered provider data to associate this tournament.

Returns:

Tournament ID

Throws:

RiotApiException - If the API returns an error or unparsable result

createTournament

public int createTournament(int providerId)
                     throws RiotApiException

Creates a tournament and returns its ID.

Parameters:

providerId - The provider ID to specify the regional registered provider data to associate this tournament.

Returns:

Tournament ID

Throws:

RiotApiException - If the API returns an error or unparsable result

createTournamentCodes

public java.util.List<java.lang.String> createTournamentCodes(int tournamentId,
                                                              int count,
                                                              int teamSize,
                                                              TournamentMap mapType,
                                                              PickType pickType,
                                                              SpectatorType spectatorType,
                                                              java.lang.String metaData,
                                                              long... allowedSummonerIds)
                                                       throws RiotApiException

Create tournament codes for the given tournament.

Parameters:

tournamentId - The tournament ID

count - The number of codes to create (max 1000)

teamSize - The team size of the game. Valid values are 1-5.

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

metaData - Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Returns:

A list of tournament codes

Throws:

java.lang.NullPointerException - If mapType or pickType or spectatorType is null

RiotApiException - If the API returns an error or unparsable result

createTournamentCodes

public java.util.List<java.lang.String> createTournamentCodes(int tournamentId,
                                                              int count,
                                                              int teamSize,
                                                              TournamentMap mapType,
                                                              PickType pickType,
                                                              SpectatorType spectatorType,
                                                              long... allowedSummonerIds)
                                                       throws RiotApiException

Create tournament codes for the given tournament.

Parameters:

tournamentId - The tournament ID

count - The number of codes to create (max 1000)

teamSize - The team size of the game. Valid values are 1-5.

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Returns:

A list of tournament codes

Throws:

java.lang.NullPointerException - If mapType or pickType or spectatorType is null

RiotApiException - If the API returns an error or unparsable result

createTournamentProvider

public int createTournamentProvider(java.lang.String region,
                                    java.lang.String callbackUrl)
                             throws RiotApiException

Creates a tournament provider and returns its ID.

Parameters:

region - The region in which the provider will be running tournaments.

callbackUrl - The provider's callback URL to which tournament game results in this region should be posted. (http URLs must use port 80, https URLs must use port 443).

Returns:

A provider ID

Throws:

java.lang.NullPointerException - If region or callbackUrl is null

RiotApiException - If the API returns an error or unparsable result

getActiveGameBySummoner

public CurrentGameInfo getActiveGameBySummoner(Platform platform,
                                               long summonerId)
                                        throws RiotApiException

Get current game information for the given summoner ID.

Parameters:

platform - Platform to execute the method call against.

summonerId - The ID of the summoner.

Returns:

Current game info

Throws:

java.lang.NullPointerException - If platform or summonerId is null

RiotApiException - If the API returns an error or unparsable result

See Also:

CurrentGameInfo

getAsyncApi

public RiotApiAsync getAsyncApi()

Provides a RiotApiAsync object to use for asynchronous api calls.

Returns:

RotApiAsync object

See Also:

RiotApiAsync

getChallengerLeagueByQueue

public LeagueList getChallengerLeagueByQueue(Platform platform,
                                             java.lang.String queue)
                                      throws RiotApiException

Get the challenger league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If platform or queue is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LeagueList

getChallengerLeagueByQueue

public LeagueList getChallengerLeagueByQueue(Platform platform,
                                             LeagueQueue queue)
                                      throws RiotApiException

Get the challenger league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If queue is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LeagueList

getChampion

public Champion getChampion(Platform platform,
                            int id)
                     throws RiotApiException

Retrieve champion by id.

Parameters:

platform - Platform to execute the method call against.

id - The ID of the desired champion

Returns:

The champion of the given ID

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Champion

getChampionMasteriesBySummoner

public java.util.List<ChampionMastery> getChampionMasteriesBySummoner(Platform platform,
                                                                      long summonerId)
                                                               throws RiotApiException

Get all champion mastery entries sorted by number of champion points descending

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

Returns:

A list of champion masteries for a given summoner.

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionMastery

getChampionMasteriesBySummonerByChampion

public ChampionMastery getChampionMasteriesBySummonerByChampion(Platform platform,
                                                                long summonerId,
                                                                int championId)
                                                         throws RiotApiException

Get a champion mastery by summonerId and championId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

championId - Champion ID to retrieve Champion Mastery for

Returns:

Champion mastery for a given summoner and championId, or null if given player has no mastery for given champion.

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionMastery

getChampionMasteryScoresBySummoner

public int getChampionMasteryScoresBySummoner(Platform platform,
                                              long summonerId)
                                       throws RiotApiException

Get a player's total champion mastery score, which is sum of individual champion mastery levels

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

Returns:

The total champion mastery score of a given summoner.

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

getChampions

public ChampionList getChampions(Platform platform,
                                 boolean freeToPlay)
                          throws RiotApiException

Retrieve all champions.

Parameters:

platform - Platform to execute the method call against.

freeToPlay - Optional filter param to retrieve only free to play champions.

Returns:

This object contains a collection of champion information.

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionList

getChampions

public ChampionList getChampions(Platform platform)
                          throws RiotApiException

Retrieve all champions.

Parameters:

platform - Platform to execute the method call against.

Returns:

This object contains a collection of champion information.

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionList

getDataChampion

public Champion getDataChampion(Platform platform,
                                int id,
                                Locale locale,
                                java.lang.String version,
                                ChampionTags... tags)
                         throws RiotApiException

Retrieves a champion by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Champion ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, key, name, and title are returned by default if this parameter isn't specified. To return all additional data, use ChampionTags.ALL.

Returns:

A single champion

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Champion

getDataChampion

public Champion getDataChampion(Platform platform,
                                int id)
                         throws RiotApiException

Retrieves a champion by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Champion ID

Returns:

A single champion

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

Champion

getDataChampionList

public ChampionList getDataChampionList(Platform platform,
                                        Locale locale,
                                        java.lang.String version,
                                        boolean dataById,
                                        ChampionListTags... tags)
                                 throws RiotApiException

Retrieves champion list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

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

tags - Tags to return additional data. Only id, key, name, and title are returned by default if this parameter isn't specified. To return all additional data, use ChampionListTags.ALL.

Returns:

A list with champions

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionList

getDataChampionList

public ChampionList getDataChampionList(Platform platform)
                                 throws RiotApiException

Retrieves champion list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with champions

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

ChampionList

getDataItem

public Item getDataItem(Platform platform,
                        int id,
                        Locale locale,
                        java.lang.String version,
                        ItemTags... tags)
                 throws RiotApiException

Retrieves item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Item ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, basic, data, id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use ItemTags.ALL.

Returns:

A single item

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Item

getDataItem

public Item getDataItem(Platform platform,
                        int id)
                 throws RiotApiException

Retrieves item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Item ID

Returns:

A single item

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

Item

getDataItemList

public ItemList getDataItemList(Platform platform,
                                Locale locale,
                                java.lang.String version,
                                ItemListTags... tags)
                         throws RiotApiException

Retrieves item list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, basic, data, id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use ItemListTags.ALL.

Returns:

A list of items

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ItemList

getDataItemList

public ItemList getDataItemList(Platform platform)
                         throws RiotApiException

Retrieves item list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list of items

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

ItemList

getDataLanguages

public java.util.List<java.lang.String> getDataLanguages(Platform platform)
                                                  throws RiotApiException

Retrieve supported languages data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with languages

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

getDataLanguageStrings

public LanguageStrings getDataLanguageStrings(Platform platform,
                                              Locale locale,
                                              java.lang.String version)
                                       throws RiotApiException

Retrieve language strings data.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

Language strings

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LanguageStrings

getDataLanguageStrings

public LanguageStrings getDataLanguageStrings(Platform platform)
                                       throws RiotApiException

Retrieve language strings data.

Parameters:

platform - Platform to execute the method call against.

Returns:

Language strings

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

LanguageStrings

getDataMaps

public MapData getDataMaps(Platform platform,
                           Locale locale,
                           java.lang.String version)
                    throws RiotApiException

Retrieves map data.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

A list of game maps

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MapData

getDataMaps

public MapData getDataMaps(Platform platform)
                    throws RiotApiException

Retrieves map data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list of game maps

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

MapData

getDataMastery

public Mastery getDataMastery(Platform platform,
                              int id,
                              Locale locale,
                              java.lang.String version,
                              MasteryTags... tags)
                       throws RiotApiException

Retrieves mastery item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Mastery ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use MasteryTags.ALL.

Returns:

A single mastery

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Mastery

getDataMastery

public Mastery getDataMastery(Platform platform,
                              int id)
                       throws RiotApiException

Retrieves mastery item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Mastery ID

Returns:

A single mastery

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

Mastery

getDataMasteryList

public MasteryList getDataMasteryList(Platform platform,
                                      Locale locale,
                                      java.lang.String version,
                                      MasteryListTags... tags)
                               throws RiotApiException

Retrieves mastery list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, data, id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use MasteryListTags.ALL.

Returns:

A list with masteries

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MasteryList

getDataMasteryList

public MasteryList getDataMasteryList(Platform platform)
                               throws RiotApiException

Retrieves mastery list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with masteries

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

MasteryList

getDataProfileIcons

public ProfileIconData getDataProfileIcons(Platform platform,
                                           Locale locale,
                                           java.lang.String version)
                                    throws RiotApiException

Retrieve profile icons.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

Profile icons

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ProfileIconData

getDataProfileIcons

public ProfileIconData getDataProfileIcons(Platform platform)
                                    throws RiotApiException

Retrieve profile icons.

Parameters:

platform - Platform to execute the method call against.

Returns:

Profile icons

Throws:

RiotApiException

See Also:

ProfileIconData

getDataRealm

public Realm getDataRealm(Platform platform)
                   throws RiotApiException

Retrieve realm data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A single realm

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Realm

getDataRune

public Rune getDataRune(Platform platform,
                        int id,
                        Locale locale,
                        java.lang.String version,
                        RuneTags... tags)
                 throws RiotApiException

Retrieves rune by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Rune ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use RuneTags.ALL.

Returns:

A single rune

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Rune

getDataRune

public Rune getDataRune(Platform platform,
                        int id)
                 throws RiotApiException

Retrieves rune by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Rune ID

Returns:

A single rune

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

Rune

getDataRuneList

public RuneList getDataRuneList(Platform platform,
                                Locale locale,
                                java.lang.String version,
                                RuneListTags... tags)
                         throws RiotApiException

Retrieves rune list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, data, id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use RuneListTags.ALL.

Returns:

A list with runes

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

RuneList

getDataRuneList

public RuneList getDataRuneList(Platform platform)
                         throws RiotApiException

Retrieves rune list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with runes

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

RuneList

getDataSummonerSpell

public SummonerSpell getDataSummonerSpell(Platform platform,
                                          int id,
                                          Locale locale,
                                          java.lang.String version,
                                          SpellTags... tags)
                                   throws RiotApiException

Retrieves summoner spell by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Summoner spell ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use SpellTags.ALL.

Returns:

A single summoner spell

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

SummonerSpell

getDataSummonerSpell

public SummonerSpell getDataSummonerSpell(Platform platform,
                                          int id)
                                   throws RiotApiException

Retrieves summoner spell by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Summoner spell ID

Returns:

A single summoner spell

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

SummonerSpell

getDataSummonerSpellList

public SummonerSpellList getDataSummonerSpellList(Platform platform,
                                                  Locale locale,
                                                  java.lang.String version,
                                                  boolean dataById,
                                                  SpellListTags... tags)
                                           throws RiotApiException

Retrieves summoner spell list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

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

tags - Tags to return additional data. Only type, version, data, id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use SpellListTags.ALL.

Returns:

A list with summoner spells

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

SummonerSpellList

getDataSummonerSpellList

public SummonerSpellList getDataSummonerSpellList(Platform platform)
                                           throws RiotApiException

Retrieves summoner spell list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with summoner spells

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

SummonerSpellList

getDataVersions

public java.util.List<java.lang.String> getDataVersions(Platform platform)
                                                 throws RiotApiException

Retrieve version data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with versions

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

getFeaturedGames

public FeaturedGames getFeaturedGames(Platform platform)
                               throws RiotApiException

Get list of featured games.

Parameters:

platform - Platform to execute the method call against.

Returns:

Featured games

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

FeaturedGames

getLeaguePositionsBySummonerId

public java.util.Set<LeaguePosition> getLeaguePositionsBySummonerId(Platform platform,
                                                                    long summonerId)
                                                             throws RiotApiException

Get league positions in all queues for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID

Returns:

List of league positions

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LeagueList

getLeaguesBySummonerId

public java.util.List<LeagueList> getLeaguesBySummonerId(Platform platform,
                                                         long summonerId)
                                                  throws RiotApiException

Get leagues in all queues for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID

Returns:

List of league lists

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LeagueList

getLobbyEventsByTournament

public LobbyEventWrapper getLobbyEventsByTournament(java.lang.String tournamentCode)
                                             throws RiotApiException

Gets a list of lobby events by tournamentCode

Parameters:

tournamentCode - Tournament code used to enter the lobby.

Returns:

Lobby event data

Throws:

java.lang.NullPointerException - If tournamentCode is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LobbyEventWrapper

getMasterLeagueByQueue

public LeagueList getMasterLeagueByQueue(Platform platform,
                                         java.lang.String queue)
                                  throws RiotApiException

Get the master league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If platform or queue is null

RiotApiException - If the API returns an error or unparsable result

See Also:

LeagueList

getMasterLeagueByQueue

public LeagueList getMasterLeagueByQueue(Platform platform,
                                         LeagueQueue queue)
                                  throws RiotApiException

Get the master league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

RiotApiException - If the API returns an error or unparsable result

java.lang.NullPointerException - If queue is null

See Also:

LeagueList

getMasteriesBySummoner

public MasteryPages getMasteriesBySummoner(Platform platform,
                                           long summonerId)
                                    throws RiotApiException

Get mastery pages for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerIds - Summoner ID associated with masteries to retrieve.

Returns:

Mastery pages of the given summoners

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MasteryPages

getMatch

public Match getMatch(Platform platform,
                      long matchId,
                      long forAccountId)
               throws RiotApiException

Get match by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

forAccountId - If provided, used to identify the participant to be unobfuscated.

Returns:

A map with match details

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Match

getMatch

public Match getMatch(Platform platform,
                      long matchId)
               throws RiotApiException

Get match by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

Returns:

A map with match details

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

Match

getMatchByMatchIdAndTournamentCode

public Match getMatchByMatchIdAndTournamentCode(Platform platform,
                                                long matchId,
                                                java.lang.String tournamentCode)
                                         throws RiotApiException

Retrieve match by matchId and tournamentCode.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

tournamentCode - The code of the tournament.

Returns:

A map with match details

Throws:

java.lang.NullPointerException - If platform or tournamentCode is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Match

getMatchIdsByTournamentCode

public java.util.List<java.lang.Long> getMatchIdsByTournamentCode(Platform platform,
                                                                  java.lang.String tournamentCode)
                                                           throws RiotApiException

Retrieve match IDs by tournamentCode.

Parameters:

platform - Platform to execute the method call against.

tournamentCode - The code of the tournament.

Returns:

A list of match IDs

Throws:

java.lang.NullPointerException - If platform or tournamentCode is null

RiotApiException - If the API returns an error or unparsable result

getMatchListByAccountId

public MatchList getMatchListByAccountId(Platform platform,
                                         long accountId,
                                         java.util.Set<java.lang.Integer> champion,
                                         java.util.Set<java.lang.Integer> queue,
                                         java.util.Set<java.lang.Integer> season,
                                         long beginTime,
                                         long endTime,
                                         int beginIndex,
                                         int endIndex)
                                  throws RiotApiException

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

champion - Set of champion IDs for which to filtering matchlist.

queue - Set of queue IDs for which to filtering matchlist.

season - Set of season IDs for which to filtering matchlist.

beginTime - The begin time to use for filtering matchlist specified as epoch milliseconds. Use -1 to not use this parameter.

endTime - The end time to use for filtering matchlist specified as epoch milliseconds. Use -1 to not use this parameter.

beginIndex - The begin index to use for filtering matchlist. Use -1 to not use this parameter.

endIndex - The end index to use for filtering matchlist. Use -1 to not use this parameter.

Returns:

A list with matches

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MatchList

getMatchListByAccountId

public MatchList getMatchListByAccountId(Platform platform,
                                         long accountId,
                                         java.util.Set<java.lang.Integer> champion,
                                         java.util.Set<java.lang.Integer> queue,
                                         java.util.Set<java.lang.Integer> season)
                                  throws RiotApiException

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

champion - Set of champion IDs for which to filtering matchlist.

queue - Set of queue IDs for which to filtering matchlist.

season - Set of season IDs for which to filtering matchlist.

Returns:

A list with matches

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

MatchList

getMatchListByAccountId

public MatchList getMatchListByAccountId(Platform platform,
                                         long accountId)
                                  throws RiotApiException

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

Returns:

A list with matches

Throws:

RiotApiException - If the API returns an error or unparsable result

See Also:

MatchList

getRecentMatchListByAccountId

@Deprecated
public MatchList getRecentMatchListByAccountId(Platform platform,
                                                            long accountId)
                                                     throws RiotApiException

Deprecated.

Get recent matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

Returns:

A list with matches

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MatchList

getRunesBySummoner

public RunePages getRunesBySummoner(Platform platform,
                                    long summonerId)
                             throws RiotApiException

Get rune pages for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerIds - Summoner ID associated with runes to retrieve.

Returns:

Rune pages of the given summoners

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

RunePages

getShardData

public ShardStatus getShardData(Platform platform)
                         throws RiotApiException

Get shard status. Returns the data available on the status.leagueoflegends.com website for the given region.

Parameters:

platform - Platform to execute the method call against.

Returns:

Status for a single shard

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

ShardStatus

getSummonerByAccount

public Summoner getSummonerByAccount(Platform platform,
                                     long accountId)
                              throws RiotApiException

Get a summoner object for a given accountId.

Parameters:

platform - Platform to execute the method call against.

accountId - Account ID associated with summoner to retrieve.

Returns:

The desired summoner

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Summoner

getSummoner

public Summoner getSummoner(Platform platform,
                            long summonerId)
                     throws RiotApiException

Get a summoner object for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with summoner to retrieve.

Returns:

The desired summoner

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Summoner

getSummonerByName

public Summoner getSummonerByName(Platform platform,
                                  java.lang.String summonerName)
                           throws RiotApiException

Get a single summoner object for a given summonerName.

Parameters:

platform - Platform to execute the method call against.

summonerName - Summoner name associated with summoner to retrieve.

Returns:

Desired summoner

Throws:

java.lang.IllegalArgumentException - If summonerName is not a valid summoner name

java.lang.NullPointerException - If platform or summonerName is null

RiotApiException - If the API returns an error or unparsable result

See Also:

Summoner

getTimelineByMatchId

public MatchTimeline getTimelineByMatchId(Platform platform,
                                          long matchId)
                                   throws RiotApiException

Get match timeline by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

Returns:

A map with match timeline details

Throws:

java.lang.NullPointerException - If platform is null

RiotApiException - If the API returns an error or unparsable result

See Also:

MatchTimeline

getTournamentCode

public TournamentCode getTournamentCode(java.lang.String tournamentCode)
                                 throws RiotApiException

Returns the tournament code DTO associated with a tournamentCode.

Parameters:

tournamentCode - The tournament code

Returns:

Tournament code DTO

Throws:

java.lang.NullPointerException - If tournamentCode is null

RiotApiException - If the API returns an error or unparsable result

See Also:

TournamentCode

updateTournamentCode

public void updateTournamentCode(java.lang.String tournamentCode,
                                 TournamentMap mapType,
                                 PickType pickType,
                                 SpectatorType spectatorType,
                                 long... allowedSummonerIds)
                          throws RiotApiException

Update the pick type, map, spectator type, or allowed summoners for a code.

Parameters:

tournamentCode - The tournament code

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Throws:

java.lang.NullPointerException - If tournamentCode is null

RiotApiException - If the API returns an error or unparsable result