org.dc.riot.lol.rx.service

Interface RiotApi.Stats

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.Stats
extends RiotApi

Get player performance statistics.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.dc.riot.lol.rx.service.RiotApi

RiotApi.Champion, RiotApi.ChampionMastery, RiotApi.CurrentGame, RiotApi.FeaturedGames, RiotApi.League, RiotApi.LolStatus, RiotApi.Match, RiotApi.MatchList, RiotApi.RateType, RiotApi.RecentGames, RiotApi.StaticData, RiotApi.Stats, RiotApi.Summoner, RiotApi.Team

Method Summary

Modifier and Type	Method and Description
RankedStatsDto	getRanked(long summonerId, Season season) /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
PlayerStatsSummaryListDto	getSummary(long summonerId, Season season) /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
static Region[]	getSupportedRegions(float version)

Methods inherited from interface org.dc.riot.lol.rx.service.RiotApi

getApiKey, getRateType, getRegion, getVersion, setAutoRetry, setPrintUrl, setProxy, setRateControl, setRetryCount

Method Detail

getSupportedRegions

static Region[] getSupportedRegions(float version)

Parameters:

version - a positive value denoting the version (e.g. 1.2)

Returns:

the set of Regions this API supports

Throws:

InvalidVersionException - if the version number cannot be mapped to a valid version

getRanked

RankedStatsDto getRanked(long summonerId,
                         Season season)
                  throws java.io.IOException,
                         HttpException

/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

Parameters:

summonerId - ID of summoner. See RiotApi.Summoner to fetch valid IDs.

season - Optional. Competitive Season to search.

Returns:

a RankedStatsDto for the specified player.

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getSummary

PlayerStatsSummaryListDto getSummary(long summonerId,
                                     Season season)
                              throws java.io.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

Parameters:

summonerId - ID of summoner. See RiotApi.Summoner to fetch valid IDs.

season - Optional. Competitive Season to search.

Returns:

Full player stats summary.

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)