org.dc.riot.lol.rx.service.RiotApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lol-api-rxjava Show documentation
Show all versions of lol-api-rxjava Show documentation
Service library for League of Legends API
package org.dc.riot.lol.rx.service;
import java.io.IOException;
import java.net.Proxy;
import java.util.Map;
import org.dc.riot.lol.rx.model.champion.ChampDto;
import org.dc.riot.lol.rx.model.champion.ChampListDto;
import org.dc.riot.lol.rx.model.championmastery.ChampionMasteryDto;
import org.dc.riot.lol.rx.model.common.QueueType;
import org.dc.riot.lol.rx.model.common.RankedQueue;
import org.dc.riot.lol.rx.model.common.Season;
import org.dc.riot.lol.rx.model.currentgame.CurrentGameInfo;
import org.dc.riot.lol.rx.model.featuredgame.FeaturedGamesDto;
import org.dc.riot.lol.rx.model.game.RecentGamesDto;
import org.dc.riot.lol.rx.model.league.LeagueDto;
import org.dc.riot.lol.rx.model.league.LeagueEntryDto;
import org.dc.riot.lol.rx.model.match.MatchDetail;
import org.dc.riot.lol.rx.model.match.MatchListDto;
import org.dc.riot.lol.rx.model.staticdata.ChampionDto;
import org.dc.riot.lol.rx.model.staticdata.ChampionListDto;
import org.dc.riot.lol.rx.model.staticdata.ItemDto;
import org.dc.riot.lol.rx.model.staticdata.ItemListDto;
import org.dc.riot.lol.rx.model.staticdata.LanguageStringsDto;
import org.dc.riot.lol.rx.model.staticdata.MapDataDto;
import org.dc.riot.lol.rx.model.staticdata.MasteryDto;
import org.dc.riot.lol.rx.model.staticdata.MasteryListDto;
import org.dc.riot.lol.rx.model.staticdata.RealmDto;
import org.dc.riot.lol.rx.model.staticdata.RuneDto;
import org.dc.riot.lol.rx.model.staticdata.RuneListDto;
import org.dc.riot.lol.rx.model.staticdata.SummonerSpellDto;
import org.dc.riot.lol.rx.model.staticdata.SummonerSpellListDto;
import org.dc.riot.lol.rx.model.stats.PlayerStatsSummaryListDto;
import org.dc.riot.lol.rx.model.stats.RankedStatsDto;
import org.dc.riot.lol.rx.model.status.Shard;
import org.dc.riot.lol.rx.model.status.ShardStatus;
import org.dc.riot.lol.rx.model.summoner.MasteryPagesDto;
import org.dc.riot.lol.rx.model.summoner.RunePagesDto;
import org.dc.riot.lol.rx.model.summoner.SummonerDto;
import org.dc.riot.lol.rx.model.team.TeamDto;
import org.dc.riot.lol.rx.service.error.HttpException;
import org.dc.riot.lol.rx.service.error.InvalidVersionException;
import org.dc.riot.lol.rx.service.request.ChampDataTag;
import org.dc.riot.lol.rx.service.request.ChampListDataTag;
import org.dc.riot.lol.rx.service.request.ItemDataTag;
import org.dc.riot.lol.rx.service.request.ItemListDataTag;
import org.dc.riot.lol.rx.service.request.MasteryDataTag;
import org.dc.riot.lol.rx.service.request.MasteryListDataTag;
import org.dc.riot.lol.rx.service.request.RuneDataTag;
import org.dc.riot.lol.rx.service.request.RuneListDataTag;
import org.dc.riot.lol.rx.service.request.SpellDataTag;
/**
* Basic organization structure for all Riot APIs. Creating
* instances of the sub-interfaces of this interface and calling
* their methods will retrieve data from the LoL API.
* Riot Developer Site
*
* @author Dc
* @since 1.0.0
* @see org.dc.riot.lol.rx.service.interfaces.ApiFactory ApiFactory
*/
public interface RiotApi {
/**
* Rate type enumeration. Mostly used in determining
* what kind of rate-too-fast notifications might be
* coming from the LoL API.
*
* @author Dc
* @since 1.0.0
*/
public enum RateType {
PERSONAL("user"), SERVICE("service");
private final String text;
private RateType(String text) {
this.text = text;
}
@Override
public String toString() {
return text;
}
public static RateType from(String s) {
for (RateType t : RateType.values()) {
if (t.text.equals(s)) {
return t;
}
}
return null;
}
}
/**
* @return the {@link RateType} that this {@link RiotApi} instance
* operates under
*/
public default RateType getRateType() {
return RateType.PERSONAL;
}
/**
* @return the {@link Region} that this {@link RiotApi} instance is set to
* query against
*/
public Region getRegion();
/**
* @return the {@link ApiKey} this {@link RiotApi} instance is using
*/
public ApiKey getApiKey();
/**
* @return the version of this {@link RiotApi} instance
*/
public float getVersion();
/**
* Enable or disable rate throttling.
* @param control turn on / off rate controlling
*/
public void setRateControl(boolean control);
/**
* @param proxy {@link Proxy} for http requests
*/
public void setProxy(Proxy proxy);
/**
* @param autoRetry whether this {@link RiotApi} instance should
* automatically retry failed requests
*/
public void setAutoRetry(boolean autoRetry);
/**
* @param retryCount number of automatic retries to attempt. If
* {@link #setAutoRetry(boolean)} is false this this has no effect.
*/
public void setRetryCount(int retryCount);
/**
* @param print turn off/on URL printing. Mainly for debugging
*/
public void setPrintUrl(boolean print);
/**
* Not for stats. This API is more concerned with enabled, ranked, free to play, etc.
* For champion stats see the {@link RiotApi.StaticData} interface.
*
* @author Dc
* @since 1.0.0
* @see RiotApi.StaticData#getChampion(long, String, String, ChampDataTag...)
* @see RiotApi.StaticData#getChampions(boolean, String, String, ChampListDataTag...)
*/
public interface Champion extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.2f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v1.2/champion
*
* 400 Bad request
* 401 Unauthorized
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param freeToPlay fetch only free to play champions
* @return {@link ChampListDto}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampListDto getChampions(boolean freeToPlay) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.2/champion/{id}
*
* 400 Bad request
* 401 Unauthorized
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param championId the champ id
* @return {@link ChampDto} single champion dto
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampDto getChampion(long championId) throws IOException, HttpException;
}
/**
* Champion mastery API to fetch player's champion mastery.
*
* @author Dc
* @since 1.0.0
*/
public interface ChampionMastery extends RiotApi {
/**
*
* @param version a positive value denoting the version (e.g. 1.0);
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.0) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /championmastery/location/{platformId}/player/{summonerId}/champion/{championId}
*
* 404 Not found
* 500 Something bad happened
*
* @param summonerId summoner ID associated with the player
* @param championId champion ID to retrieve champion mastery for
* @return {@link ChampionMasteryDto} mapping player to champion mastery
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampionMasteryDto getPlayerChampionMastery(long summonerId, long championId) throws IOException, HttpException;
/**
* /championmastery/location/{platformId}/player/{summonerId}/champions
*
* 404 Not found
* 500 Something bad happened
*
* @param summonerId summoner ID associated with the player
* @return array of {@link ChampionMasteryDto} mapping player to champion mastery
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampionMasteryDto[] getPlayerAllMastery(long summonerId) throws IOException, HttpException;
/**
* /championmastery/location/{platformId}/player/{summonerId}/score
*
* 404 Not found
* 500 Something bad happened
*
* @param summonerId summoner ID associated with the player
* @return total mastery score for the given player
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
int getMasteryScore(long summonerId) throws IOException, HttpException;
/**
* /championmastery/location/{platformId}/player/{summonerId}/topchampions
*
* 404 Not found
* 500 Something bad happened
*
* @param summonerId summonerId associated with the player
* @param count best N champions
* @return array of {@link ChampionMasteryDto} mapping player to champion mastery
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampionMasteryDto[] getTopChampions(long summonerId, int count) throws IOException, HttpException;
}
/**
* Spectator details
*
* @author Dc
* @since 1.0.0
*/
public interface CurrentGame extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.0f) {
return Region.values();
} else {
throw new InvalidVersionException();
}
}
/**
* /observer-mode/rest/consumer/getSpectatorGameInfo/{platformId}/{summonerId}
*
* 403 Forbidden
* 429 Rate limit exceeded
*
* @param summonerId summoner id number
* @return {@link CurrentGameInfo} object
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
CurrentGameInfo getSpectatorInfo(long summonerId) throws IOException, HttpException;
}
/**
* Gain access to the featured games that appear on the main client page
*
* @author Dc
* @since 1.0.0
*/
public interface FeaturedGames extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.0f) {
return Region.values();
} else {
throw new InvalidVersionException();
}
}
/**
* /observer-mode/rest/featured
*
* 403 Forbidden
* 429 Rate limit exceeded
*
* @return {@link FeaturedGames} object with all the featured games for the {@link Region}
* queried against or null if some network error occurred
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
FeaturedGamesDto getFeaturedGames() throws IOException, HttpException;
}
/**
* Get recent game data on specific players
*
* @author Dc
* @since 1.0.0
*/
public interface RecentGames extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.3f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v1.3/game/by-summoner/{summonerId}/recent
*
* 400 Bad request
* 401 Unauthorized
* 404 Game data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerId player's summoner ID, See the {@link Summoner} interface for valid IDs.
* @return {@link RecentGamesDto} for the given player or null if no data found
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
RecentGamesDto getRecentGames(long summonerId) throws IOException, HttpException;
}
/**
* Retrieves data about players' leagues. Generally, requests with invalid
* parameters will return null instead of of throwing exceptions.
*
* @see LeagueDto
* @see LeagueEntryDto
*
* @author Dc
* @since 1.0.0
*/
public interface League extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 2.5f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry
*
* 400 Bad request
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds set of summoners to look up
* @return a Map of summonerId Strings to List of {@link LeagueDto} objects or null
* if nothing found
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getBySummonerEntries(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry
*
* 400 Bad request
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds set of summoners to look up
* @return a Map of summonerId Strings to List of {@link LeagueDto} objects or null
* if nothing found
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getBySummoners(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.5/league/by-team/{teamIds}
*
* 400 Bad request
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param teamIds set of teams to look up, max length of 10
* @return Map of teamId Strings to List of {@link LeagueDto} objects or null
* if nothing found
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getByTeams(String... teamIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.5/league/by-team/{teamIds}/entry
*
* 400 Bad request
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param teamIds set of teams to look up
* @return a Map of teamId Strings to List of {@link LeagueDto} objects or null
* if nothing found
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getByTeamEntries(String... teamIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.5/league/challenger
*
* 400 Bad request, (e.g. requested Challenger data for an unranked queue type)
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param queue the queue type to search for
* @return a {@link LeagueDto} object with data or null if bad request.
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
LeagueDto getChallenger(QueueType.ChallengerMaster queue) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.5/league/master
*
* 400 Bad request
* 401 Unauthorized
* 404 League data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param queue the queue type to search for
* @return a {@link LeagueDto} object with data or null if bad request
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
LeagueDto getMaster(QueueType.ChallengerMaster queue) throws IOException, HttpException;
}
/**
* Static data on champion stats, items, gold, runes, masteries, etc. all served up on
* a per patch basis
*
* @author Dc
* @since 1.0.0
*/
public interface StaticData extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.2f) {
return Region.values();
} else {
throw new InvalidVersionException();
}
}
@Override
public default RateType getRateType() {
return RateType.SERVICE;
}
/**
* /api/lol/static-data/{region}/v1.2/champion
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param dataById If specified as true, the returned data map will use the champions' IDs as the keys. If not specified or specified as false, the returned data map will use the champions' keys instead.
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param champData Champ data tags to retrieve. Only id, key, name, and title are returned
* by default if this parameter isn't specified, null is ok
* @return a {@link ChampionDto} object with requested data filled in or null
* if no champion could be found matching the given query
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampionListDto getChampions(boolean dataById, String version, String locale, ChampListDataTag... champData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/champion/{id}
*
* 400 Bad request
* 401 Unauthorized
* 404 Champion not found, bad champId
* 500 Internal server error
* 503 Service unavailable
*
* @param champId the champion ID
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param champData Champ data tags to retrieve. Only id, key, name, and title are returned
* by default if this parameter isn't specified, null is ok
* @return a {@link ChampionDto} object with requested data filled in or null
* if no champion could be found matching the given query
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ChampionDto getChampion(long champId, String version, String locale, ChampDataTag... champData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/item
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param itemListData 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
* the tag 'all'.
* @return {@link ItemListDto} filled in
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ItemListDto getItems(String version, String locale, ItemListDataTag... itemListData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/item/{id}
*
* 400 Bad request
* 401 Unauthorized
* 404 Item id not found
* 500 Internal server error
* 503 Service unavailable
*
* @param itemId item id to fetch
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param itemData Tags to return additional data. Only id, name, plaintext, group, and
* description are returned by default if this parameter isn't specified.
* To return all additional data, use the tag 'all'.
* @return {@link ItemListDto} filled in according to itemListData
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ItemDto getItem(long itemId, String version, String locale, ItemDataTag... itemData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/language-strings
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @return {@link LanguageStringsDto}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
LanguageStringsDto getLanguageStrings(String version, String locale) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/languages
*
* Gets language strings
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @return String array of all supported locales
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
String[] getLocales() throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/map
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @return {@link MapDataDto} object
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
MapDataDto getMap(String version, String locale) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/mastery
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param masteryListData 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 the tag 'all'.
* @return {@link MasteryListDto} filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
MasteryListDto getMasteries(String version, String locale, MasteryListDataTag... masteryListData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/mastery/{id}
*
* 400 Bad request
* 401 Unauthorized
* 404 Mastery data not found
* 500 Internal server error
* 503 Service unavailable
*
* @param id mastery id
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param masteryData 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 the tag 'all'.
* @return {@link MasteryDto} filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
MasteryDto getMastery(long id, String version, String locale, MasteryDataTag... masteryData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/realm
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @return {@link RealmDto} object
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
RealmDto getRealm() throws IOException, HttpException;
/**
* /api/lol/static-data/na/v1.2/rune
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param runeListData 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 the tag 'all'.
* @return {@link RuneListDto} object filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
RuneListDto getRunes(String version, String locale, RuneListDataTag... runeListData) throws IOException, HttpException;
/**
* /api/lol/static-data/na/v1.2/rune/{id}
*
* 400 Bad request
* 401 Unauthorized
* 403 Forbidden
* 404 Rune data not found
* 500 Internal server error
* 503 Service unavailable
*
* @param id rune id to query
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param runeData 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 the tag 'ALL'.
* @return {@link RuneListDto} object filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
RuneDto getRune(long id, String version, String locale, RuneDataTag... runeData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/summoner-spell
*
* 400 Bad request
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @param dataById If specified as true, the returned data map will use the spells' IDs as
* the keys. If not specified or specified as false,
* the returned data map will use the spells' keys instead.
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param spellData 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 the tag 'ALL'.
* @return {@link SummonerSpellListDto} object filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
SummonerSpellListDto getSummonerSpells(boolean dataById, String version, String locale, SpellDataTag... spellData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/summoner-spell/{id}
*
* 400 Bad request
* 401 Unauthorized
* 404 Summoner spell data not found
* 500 Internal server error
* 503 Service unavailable
*
* @param id summoner spell ID
* @param version patch to reference, null will use latest patch
* @param locale locale String (e.g. en_US) null will use default for region
* @param spellData 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 the tag 'ALL'.
* @return {@link SummonerSpellDto} object filled in according to tags
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
SummonerSpellDto getSummonerSpell(long id, String version, String locale, SpellDataTag... spellData) throws IOException, HttpException;
/**
* /api/lol/static-data/{region}/v1.2/versions
*
* 401 Unauthorized
* 500 Internal server error
* 503 Service unavailable
*
* @return String array with every patch arranged from newest at [0] to oldest
* at [length - 1]
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
String[] getVersions() throws IOException, HttpException;
}
/**
* Get statuses of servers. API calls to this endpoint
* do not count against rate limit
*
* @author Dc
* @since 1.0.0
*/
public interface LolStatus extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.0f) {
return Region.getExcluding(Region.KOREA);
} else {
throw new InvalidVersionException();
}
}
/**
* /shards
*
* Most useful for finding which locales are supported on which servers
*
* 403 Forbidden
*
* @return Array of {@link Shard} statuses
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Shard[] getShards() throws IOException, HttpException;
/**
* /shards/{region}
*
* Get shard status. Returns the data available on the status.leagueoflegends.com website for the given region.
*
* 403 Forbidden
*
* @return a {@link ShardStatus} for the specified {@link Region}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
ShardStatus getShard() throws IOException, HttpException;
}
/**
* This interface is closely related to the {@link MatchList} interface. Retrieves very detailed
* statistics for specified matches.
*
* @author Dc
* @since 1.0.0
*/
public interface Match extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 2.2f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v2.2/match/{matchId}
*
* 400 Bad request
* 401 Unauthorized
* 404 Match not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param matchId {@link MatchList} interface to get valid match IDs
* @param includeTimeline Attempt to include timeline data. Not all matches have timeline
* data associated with them.
* @return a {@link MatchDetail}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
MatchDetail getMatch(long matchId, boolean includeTimeline) throws IOException, HttpException;
}
/**
* Interface to allow search of matches by Summoner ID. This interface is closely related
* to the {@link Match} interface.
*
* @author Dc
* @since 1.0.0
*/
public interface MatchList extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 2.2f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v2.2/matchlist/by-summoner/{summonerId}
*
* A number of optional parameters are provided for filtering.
* It is up to the caller to ensure that the combination of filter parameters provided is
* valid for the requested summoner, otherwise, no matches may be returned.
* If either of the beginTime or endTime parameters is set, they must both be set,
* although there is no maximum limit on their range. If the beginTime parameter is
* specified on its own, endTime is assumed to be the current time.
* If the endTime parameter is specified on its own, beginTime is assumed to be the start
* of the summoner's match history.
*
* 400 Bad request
* 401 Unauthorized
* 404 Game not found
* 422 Summoner has an entry, but hasn't played since the start of 2013
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerId ID of summoner to search. See the {@link Summoner} interface for valid IDs.
* @param championIds Optional. ID(s) to search; null is ok.
* @param rankedQueues Optional. Ranked queues to search.
* @param seasons Optional. Seasons to search.
* @param beginTime Optional. Specify -1 for no value.
* @param endTime Optional. Specify -1 for no value.
* @param beginIndex Optional. Specify -1 for no value.
* @param endIndex Optional. Specify -1 for no value.
* @return {@link MatchListDto}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
MatchListDto getMatchList(long summonerId, long[] championIds, RankedQueue[] rankedQueues, Season[] seasons, long beginTime, long endTime, int beginIndex, int endIndex) throws IOException, HttpException;
}
/**
* Get player performance statistics.
*
* @author Dc
* @since 1.0.0
*/
public interface Stats extends RiotApi {
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.3f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v1.3/stats/by-summoner/{summonerId}/ranked
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerId ID of summoner. See {@link Summoner} to fetch valid IDs.
* @param season Optional. Competitive {@link Season} to search.
* @return a {@link RankedStatsDto} for the specified player.
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
RankedStatsDto getRanked(long summonerId, Season season) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.3/stats/by-summoner/{summonerId}/summary
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerId ID of summoner. See {@link Summoner} to fetch valid IDs.
* @param season Optional. Competitive {@link Season} to search.
* @return Full player stats summary.
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
PlayerStatsSummaryListDto getSummary(long summonerId, Season season) throws IOException, HttpException;
}
/**
* Interface for retrieving data on individual players.
*
* @author Dc
* @since 1.0.0
*/
public interface Summoner extends RiotApi {
public static String encodeName(String name) {
return name.toLowerCase().replace(" ", "").trim();
}
/**
* @param version a positive value denoting the version (e.g. 1.2)
* @return the set of {@link Region}s this API supports
* @throws InvalidVersionException if the version number cannot be mapped to a valid version
*/
public static Region[] getSupportedRegions(float version) {
if (version >= 1.4f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v1.4/summoner/by-name/{summonerNames}
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerNames array of String names
* @return Map of encoded names (name with all lowercase and spaces trimmed) to
* {@link SummonerDto}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getByNames(String... summonerNames) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.4/summoner/by-account/{accountIds}
*
* 400 Bad request
* 401 Unauthorized
* 404 No summoner data found for any specified inputs
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param accountIds Comma-separated list of account IDs associated with summoners to retrieve.
* Maximum allowed at once is 40.
* @return Map of summoner data mapped from long Strings to {@link SummonerDto}
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getByAccounts(long... accountIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.4/summoner/{summonerIds}
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds List of long IDs
* @return Map of summoner IDs mapped from longs to Strings
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getByIds(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.4/summoner/{summonerIds}/masteries
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds List of long IDs
* @return Map of summoner IDs mapped from longs to Strings
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getMasteries(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.4/summoner/{summonerIds}/name
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds List of long IDs
* @return Map of summoner IDs mapped from longs to Strings
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getNames(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v1.4/summoner/{summonerIds}/runes
*
* 400 Bad request
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds List of long IDs
* @return Map of summoner IDs mapped from longs to Strings
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getRunes(long... summonerIds) throws IOException, HttpException;
}
/**
* Fetch player teams
*
* @author Dc
* @since 1.0.0
*/
public interface Team extends RiotApi {
public static Region[] getSupportedRegions(float version) {
if (version >= 2.4f) {
return Region.getExcluding(Region.PUBLIC_BETA_ENVIRONMENT);
} else {
throw new InvalidVersionException();
}
}
/**
* /api/lol/{region}/v2.4/team/by-summoner/{summonerIds}
*
* 400 Bad request, usually means too many IDs
* 401 Unauthorized
* 404 Stats data not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param summonerIds List of summoner IDs to search. See {@link Summoner} to get valid
* summoner IDs. Max count in this method is 10.
* @return Map of stringified summonerIds to list of {@link TeamDto} objects that is the
* collection of all teams of which that summoner is a member.
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getTeamsBySummoners(long... summonerIds) throws IOException, HttpException;
/**
* /api/lol/{region}/v2.4/team/{teamIds}
*
* 400 Bad request, usually means too many IDs
* 401 Unauthorized
* 404 Team not found
* 429 Rate limit exceeded
* 500 Internal server error
* 503 Service unavailable
*
* @param teamIds List of team IDs. Max length of 10.
* @return Map of team ID to {@link TeamDto} objects.
* @throws HttpException non 2XX response code returned
* @throws IOException some connection error (e.g. server down)
*/
Map getTeams(String... teamIds) throws IOException, HttpException;
}
}