Show / Hide Table of Contents

Class RiotApi

Entry point for the API.

Inheritance
System.Object
RiotApi
Namespace:RiotSharp
Assembly:RiotSharp.dll
Syntax
public class RiotApi : object, IRiotApi

Methods

GetAllChampionsMasteryEntries(Platform, Int64)

Gets all champions mastery by summoner ID synchronously.

Declaration
public List<ChampionMastery> GetAllChampionsMasteryEntries(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

Returns
Type Description
List<><ChampionMastery>

All champions mastery entries for the specified summoner ID.

Implements
IRiotApi.GetAllChampionsMasteryEntries(Platform, Int64)

GetAllChampionsMasteryEntriesAsync(Platform, Int64)

Gets all champions mastery by summoner ID asynchronously.

Declaration
public Task<List<ChampionMastery>> GetAllChampionsMasteryEntriesAsync(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

Returns
Type Description
Task<><List<><ChampionMastery>>

All champions mastery entries for the specified summoner ID.

Implements
IRiotApi.GetAllChampionsMasteryEntriesAsync(Platform, Int64)

GetChallengerLeague(Region, Queue)

Get the challenger league for a particular queue.

Declaration
public League GetChallengerLeague(Region region, Queue queue)
Parameters
Type Name Description
Region region

Region in which you wish to look for a challenger league.

Queue queue

Queue in which you wish to look for a challenger league.

Returns
Type Description
League

A league which contains all the challengers for this specific region and queue.

Implements
IRiotApi.GetChallengerLeague(Region, Queue)

GetChallengerLeagueAsync(Region, Queue)

Get the challenger league for a particular queue asynchronously.

Declaration
public Task<League> GetChallengerLeagueAsync(Region region, Queue queue)
Parameters
Type Name Description
Region region

Region in which you wish to look for a challenger league.

Queue queue

Queue in which you wish to look for a challenger league.

Returns
Type Description
Task<><League>

A league which contains all the challengers for this specific region and queue.

Implements
IRiotApi.GetChallengerLeagueAsync(Region, Queue)

GetChampion(Region, Int32)

Get a champion from its id synchronously.

Declaration
public Champion GetChampion(Region region, int championId)
Parameters
Type Name Description
Region region

Region in which you wish to look for a champion.

System.Int32 championId

Id of the champion you're looking for.

Returns
Type Description
Champion

A champion.

Implements
IRiotApi.GetChampion(Region, Int32)

GetChampionAsync(Region, Int32)

Get a champion from its id asynchronously.

Declaration
public Task<Champion> GetChampionAsync(Region region, int championId)
Parameters
Type Name Description
Region region

Region in which you wish to look for a champion.

System.Int32 championId

Id of the champion you're looking for.

Returns
Type Description
Task<><Champion>

A champion.

Implements
IRiotApi.GetChampionAsync(Region, Int32)

GetChampionMastery(Platform, Int64, Int32)

Gets a champion mastery by summoner ID synchronously.

Declaration
public ChampionMastery GetChampionMastery(Platform platform, long summonerId, int championId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

System.Int32 championId

ID of the champion for which to retrieve mastery.

Returns
Type Description
ChampionMastery

Champion mastery for summoner ID and champion ID.

Implements
IRiotApi.GetChampionMastery(Platform, Int64, Int32)

GetChampionMasteryAsync(Platform, Int64, Int32)

Gets a champion mastery by summoner ID asynchronously.

Declaration
public Task<ChampionMastery> GetChampionMasteryAsync(Platform platform, long summonerId, int championId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

System.Int32 championId

ID of the champion for which to retrieve mastery.

Returns
Type Description
Task<><ChampionMastery>

Champion mastery for summoner ID and champion ID.

Implements
IRiotApi.GetChampionMasteryAsync(Platform, Int64, Int32)

GetChampions(Region, Boolean)

Get the list of champions by region synchronously.

Declaration
public List<Champion> GetChampions(Region region, bool freeToPlay = false)
Parameters
Type Name Description
Region region

Region in which you wish to look for champions.

System.Boolean freeToPlay

If set to true will return only free to play champions.

Returns
Type Description
List<><Champion>

A list of champions.

Implements
IRiotApi.GetChampions(Region, Boolean)

GetChampionsAsync(Region, Boolean)

Get the list of champions by region asynchronously.

Declaration
public Task<List<Champion>> GetChampionsAsync(Region region, bool freeToPlay = false)
Parameters
Type Name Description
Region region

Region in which you wish to look for champions.

System.Boolean freeToPlay

If set to true will return only free to play champions.

Returns
Type Description
Task<><List<><Champion>>

A list of champions.

Implements
IRiotApi.GetChampionsAsync(Region, Boolean)

GetCurrentGame(Platform, Int64)

Gets the current game by summoner ID synchronously.

Declaration
public CurrentGame GetCurrentGame(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve current game.

Returns
Type Description
CurrentGame

Current game of the summoner.

Implements
IRiotApi.GetCurrentGame(Platform, Int64)

GetCurrentGameAsync(Platform, Int64)

Gets the current game by summoner ID asynchronously.

Declaration
public Task<CurrentGame> GetCurrentGameAsync(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve current game.

Returns
Type Description
Task<><CurrentGame>

Current game of the summoner.

Implements
IRiotApi.GetCurrentGameAsync(Platform, Int64)

GetEntireLeagues(Region, List<Int64>)

Retrieves the entire leagues for the specified summoners, you can submit more than 10 summoner ids.

Declaration
public Dictionary<long, List<League>> GetEntireLeagues(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of summoners.

List<><System.Int64> summonerIds

The summoner ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.Int64, List<><League>>

A map of list of leagues indexed by the summoner id.

Implements
IRiotApi.GetEntireLeagues(Region, List<Int64>)

GetEntireLeagues(Region, List<String>)

Retrieves the entire leagues for the specified teams, you can submit more than 10 team ids.

Declaration
public Dictionary<string, List<League>> GetEntireLeagues(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of teams.

List<><System.String> teamIds

The team ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.String, List<><League>>

A map of list of entire leagues indexed by the team id.

Implements
IRiotApi.GetEntireLeagues(Region, List<String>)

GetEntireLeaguesAsync(Region, List<Int64>)

Retrieves the entire leagues for the specified summoners asynchronously, you can submit more than 10 summoner ids.

Declaration
public Task<Dictionary<long, List<League>>> GetEntireLeaguesAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of summoners.

List<><System.Int64> summonerIds

The summoner ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.Int64, List<><League>>>

A map of list of leagues indexed by the summoner id.

Implements
IRiotApi.GetEntireLeaguesAsync(Region, List<Int64>)

GetEntireLeaguesAsync(Region, List<String>)

Retrieves the entire leagues for the specified teams asynchronously, you can submit more than 10 team ids.

Declaration
public Task<Dictionary<string, List<League>>> GetEntireLeaguesAsync(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of teams.

List<><System.String> teamIds

The team ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.String, List<><League>>>

A map of list of entire leagues indexed by the team id.

Implements
IRiotApi.GetEntireLeaguesAsync(Region, List<String>)

GetFeaturedGames(Region)

Gets the featured games by region synchronously.

Declaration
public FeaturedGames GetFeaturedGames(Region region)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

Returns
Type Description
FeaturedGames

Featured games for the region.

Implements
IRiotApi.GetFeaturedGames(Region)

GetFeaturedGamesAsync(Region)

Gets the featured games by region asynchronously.

Declaration
public Task<FeaturedGames> GetFeaturedGamesAsync(Region region)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

Returns
Type Description
Task<><FeaturedGames>

Featured games for the region.

Implements
IRiotApi.GetFeaturedGamesAsync(Region)

GetInstance(String, Int32, Int32)

Get the instance of RiotApi.

Declaration
public static RiotApi GetInstance(string apiKey, int rateLimitPer10s = 10, int rateLimitPer10m = 500)
Parameters
Type Name Description
System.String apiKey

The api key.

System.Int32 rateLimitPer10s

The 10 seconds rate limit for your production api key.

System.Int32 rateLimitPer10m

The 10 minutes rate limit for your production api key.

Returns
Type Description
RiotApi

The instance of RiotApi.

GetLeagues(Region, List<Int64>)

Retrieves the league entries for the specified summoners, you can submit more than 10 summoner ids.

Declaration
public Dictionary<long, List<League>> GetLeagues(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of summoners.

List<><System.Int64> summonerIds

The summoner ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.Int64, List<><League>>

A map of list of league entries indexed by the summoner id.

Implements
IRiotApi.GetLeagues(Region, List<Int64>)

GetLeagues(Region, List<String>)

Retrieves the league entries for the specified teams, you can submit more than 10 team ids.

Declaration
public Dictionary<string, List<League>> GetLeagues(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of teams.

List<><System.String> teamIds

The team ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.String, List<><League>>

A map of list of leagues indexed by the team id.

Implements
IRiotApi.GetLeagues(Region, List<String>)

GetLeaguesAsync(Region, List<Int64>)

Retrieves the league entries for the specified summoners asynchronously, you can submit more than 10 summoner ids.

Declaration
public Task<Dictionary<long, List<League>>> GetLeaguesAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of summoners.

List<><System.Int64> summonerIds

The summoner ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.Int64, List<><League>>>

A map of list of league entries indexed by the summoner id.

Implements
IRiotApi.GetLeaguesAsync(Region, List<Int64>)

GetLeaguesAsync(Region, List<String>)

Retrieves the league entries for the specified teams asynchronously, you can submit more than 10 team ids.

Declaration
public Task<Dictionary<string, List<League>>> GetLeaguesAsync(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for the leagues of teams.

List<><System.String> teamIds

The team ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.String, List<><League>>>

A map of list of league entries indexed by the team id.

Implements
IRiotApi.GetLeaguesAsync(Region, List<String>)

GetMasterLeague(Region, Queue)

Get the master league for a particular queue.

Declaration
public League GetMasterLeague(Region region, Queue queue)
Parameters
Type Name Description
Region region

Region in which you wish to look for a master league.

Queue queue

Queue in which you wish to look for a master league.

Returns
Type Description
League

A league which contains all the masters for this specific region and queue.

Implements
IRiotApi.GetMasterLeague(Region, Queue)

GetMasterLeagueAsync(Region, Queue)

Get the master league for a particular queue asynchronously.

Declaration
public Task<League> GetMasterLeagueAsync(Region region, Queue queue)
Parameters
Type Name Description
Region region

Region in which you wish to look for a master league.

Queue queue

Queue in which you wish to look for a master league.

Returns
Type Description
Task<><League>

A league which contains all the masters for this specific region and queue.

Implements
IRiotApi.GetMasterLeagueAsync(Region, Queue)

GetMasteryPages(Region, List<Int64>)

Get mastery pages for a list of summoner ids synchronously, you can submit more than 40 summoner ids.

Declaration
public Dictionary<long, List<MasteryPage>> GetMasteryPages(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for mastery pages for a list of summoners.

List<><System.Int64> summonerIds

A list of summoners' ids for which you wish to retrieve the masteries, not limited to 40.

Returns
Type Description
Dictionary<, ><System.Int64, List<><MasteryPage>>

A dictionary where the keys are the summoners' ids and the values are lists of mastery pages.

Implements
IRiotApi.GetMasteryPages(Region, List<Int64>)

GetMasteryPagesAsync(Region, List<Int64>)

Get mastery pages for a list of summoner ids asynchronously, you can submit more than 40 summoner ids.

Declaration
public Task<Dictionary<long, List<MasteryPage>>> GetMasteryPagesAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for mastery pages for a list of summoners.

List<><System.Int64> summonerIds

A list of summoners' ids for which you wish to retrieve the masteries, not limited to 40.

Returns
Type Description
Task<><Dictionary<, ><System.Int64, List<><MasteryPage>>>

A dictionary where the keys are the summoners' ids and the values are lists of mastery pages.

Implements
IRiotApi.GetMasteryPagesAsync(Region, List<Int64>)

GetMatch(Region, Int64, Boolean)

Get match information about a specific match synchronously.

Declaration
public MatchDetail GetMatch(Region region, long matchId, bool includeTimeline = false)
Parameters
Type Name Description
Region region

Region in which the match took place.

System.Int64 matchId

The match ID to be retrieved.

System.Boolean includeTimeline

Whether or not to include timeline information.

Returns
Type Description
MatchDetail

A match detail object containing information about the match.

Implements
IRiotApi.GetMatch(Region, Int64, Boolean)

GetMatchAsync(Region, Int64, Boolean)

Get match information about a specific match asynchronously.

Declaration
public Task<MatchDetail> GetMatchAsync(Region region, long matchId, bool includeTimeline = false)
Parameters
Type Name Description
Region region

Region in which the match took place.

System.Int64 matchId

The match ID to be retrieved.

System.Boolean includeTimeline

Whether or not to include timeline information.

Returns
Type Description
Task<><MatchDetail>

A match detail object containing information about the match.

Implements
IRiotApi.GetMatchAsync(Region, Int64, Boolean)

GetMatchList(Region, Int64, List<Int64>, List<Queue>, List<Season>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int32>, Nullable<Int32>)

Get the list of matches of a specific summoner synchronously.

Declaration
public MatchList GetMatchList(Region region, long summonerId, List<long> championIds = null, List<Queue> rankedQueues = null, List<Season> seasons = null, DateTime? beginTime = null, DateTime? endTime = null, int ? beginIndex = null, int ? endIndex = null)
Parameters
Type Name Description
Region region

Region in which the summoner is.

System.Int64 summonerId

Summoner ID for which you want to retrieve the match list.

List<><System.Int64> championIds

List of champion IDS to use for fetching games.

List<><Queue> rankedQueues

List of ranked queue types to use for fetching games. Non-ranked queue types will be ignored.

List<><Season> seasons

List of seasons for which to filter the match list by.

System.Nullable<><DateTime> beginTime

The earliest date you wish to get matches from.

System.Nullable<><DateTime> endTime

The latest date you wish to get matches from.

System.Nullable<><System.Int32> beginIndex

The begin index to use for fetching matches.

System.Nullable<><System.Int32> endIndex

The end index to use for fetching matches.

Returns
Type Description
MatchList

A list of Match references object.

GetMatchListAsync(Region, Int64, List<Int64>, List<Queue>, List<Season>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Int32>, Nullable<Int32>)

Get the list of matches of a specific summoner asynchronously.

Declaration
public Task<MatchList> GetMatchListAsync(Region region, long summonerId, List<long> championIds = null, List<Queue> rankedQueues = null, List<Season> seasons = null, DateTime? beginTime = null, DateTime? endTime = null, int ? beginIndex = null, int ? endIndex = null)
Parameters
Type Name Description
Region region

Region in which the summoner is.

System.Int64 summonerId

Summoner ID for which you want to retrieve the match list.

List<><System.Int64> championIds

List of champion IDS to use for fetching games.

List<><Queue> rankedQueues

List of ranked queue types to use for fetching games. Non-ranked queue types will be ignored.

List<><Season> seasons

List of seasons for which to filter the match list by.

System.Nullable<><DateTime> beginTime

The earliest date you wish to get matches from.

System.Nullable<><DateTime> endTime

The latest date you wish to get matches from.

System.Nullable<><System.Int32> beginIndex

The begin index to use for fetching matches.

System.Nullable<><System.Int32> endIndex

The end index to use for fetching matches.

Returns
Type Description
Task<><MatchList>

A list of Match references object.

GetRecentGames(Region, Int64)

Get the 10 most recent games by summoner ID synchronously.

Declaration
public List<Game> GetRecentGames(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve recent games.

Returns
Type Description
List<><Game>

A list of the 10 most recent games.

Implements
IRiotApi.GetRecentGames(Region, Int64)

GetRecentGamesAsync(Region, Int64)

Get the 10 most recent games by summoner ID asynchronously.

Declaration
public Task<List<Game>> GetRecentGamesAsync(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve recent games.

Returns
Type Description
Task<><List<><Game>>

A list of the 10 most recent games.

Implements
IRiotApi.GetRecentGamesAsync(Region, Int64)

GetRunePages(Region, List<Int64>)

Get rune pages for a list of summoner ids synchronously, you can submit more than 40 summoner ids.

Declaration
public Dictionary<long, List<RunePage>> GetRunePages(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for mastery pages for a list of summoners.

List<><System.Int64> summonerIds

A list of summoner ids for which you wish to retrieve the masteries, not limited to 40.

Returns
Type Description
Dictionary<, ><System.Int64, List<><RunePage>>

A dictionary where the keys are the summoners' ids and the values are lists of rune pages.

Implements
IRiotApi.GetRunePages(Region, List<Int64>)

GetRunePagesAsync(Region, List<Int64>)

Get rune pages for a list of summoner ids asynchronously, you can submit more than 40 summoner ids.

Declaration
public Task<Dictionary<long, List<RunePage>>> GetRunePagesAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for mastery pages for a list of summoners.

List<><System.Int64> summonerIds

A list of summoner ids for which you wish to retrieve the masteries, not limited to 40.

Returns
Type Description
Task<><Dictionary<, ><System.Int64, List<><RunePage>>>

A dictionary where the keys are the summoners' ids and the values are lists of rune pages.

Implements
IRiotApi.GetRunePagesAsync(Region, List<Int64>)

GetStatsRanked(Region, Int64)

Get ranked stats by summoner ID synchronously.

Declaration
public List<ChampionStats> GetStatsRanked(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve ranked stats.

Returns
Type Description
List<><ChampionStats>

A list of champion stats.

Implements
IRiotApi.GetStatsRanked(Region, Int64)

GetStatsRanked(Region, Int64, Season)

Get ranked stats by summoner ID synchronously.

Declaration
public List<ChampionStats> GetStatsRanked(Region region, long summonerId, Season season)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve ranked stats.

Season season

If specified, stats for the given season are returned. Otherwise, stats for the current season are returned.

Returns
Type Description
List<><ChampionStats>

A list of champion stats.

Implements
IRiotApi.GetStatsRanked(Region, Int64, Season)

GetStatsRankedAsync(Region, Int64)

Get ranked stats by summoner ID asynchronously.

Declaration
public Task<List<ChampionStats>> GetStatsRankedAsync(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve ranked stats.

Returns
Type Description
Task<><List<><ChampionStats>>

A list of champion stats.

Implements
IRiotApi.GetStatsRankedAsync(Region, Int64)

GetStatsRankedAsync(Region, Int64, Season)

Get ranked stats by summoner ID asynchronously.

Declaration
public Task<List<ChampionStats>> GetStatsRankedAsync(Region region, long summonerId, Season season)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve ranked stats.

Season season

If specified, stats for the given season are returned. Otherwise, stats for the current season are returned.

Returns
Type Description
Task<><List<><ChampionStats>>

A list of champion stats.

Implements
IRiotApi.GetStatsRankedAsync(Region, Int64, Season)

GetStatsSummaries(Region, Int64)

Get player stats by summoner ID synchronously.

Declaration
public List<PlayerStatsSummary> GetStatsSummaries(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve player stats.

Returns
Type Description
List<><PlayerStatsSummary>

A list of player stats summaries.

Implements
IRiotApi.GetStatsSummaries(Region, Int64)

GetStatsSummaries(Region, Int64, Season)

Get player stats by summoner ID synchronously.

Declaration
public List<PlayerStatsSummary> GetStatsSummaries(Region region, long summonerId, Season season)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve player stats.

Season season

If specified, stats for the given season are returned. Otherwise, stats for the current season are returned.

Returns
Type Description
List<><PlayerStatsSummary>

A list of player stats summaries.

Implements
IRiotApi.GetStatsSummaries(Region, Int64, Season)

GetStatsSummariesAsync(Region, Int64)

Get player stats by summoner ID asynchronously.

Declaration
public Task<List<PlayerStatsSummary>> GetStatsSummariesAsync(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve player stats.

Returns
Type Description
Task<><List<><PlayerStatsSummary>>

A list of player stats summaries.

Implements
IRiotApi.GetStatsSummariesAsync(Region, Int64)

GetStatsSummariesAsync(Region, Int64, Season)

Get player stats by summoner ID asynchronously.

Declaration
public Task<List<PlayerStatsSummary>> GetStatsSummariesAsync(Region region, long summonerId, Season season)
Parameters
Type Name Description
Region region

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve player stats.

Season season

If specified, stats for the given season are returned. Otherwise, stats for the current season are returned.

Returns
Type Description
Task<><List<><PlayerStatsSummary>>

A list of player stats summaries.

Implements
IRiotApi.GetStatsSummariesAsync(Region, Int64, Season)

GetSummoner(Region, Int64)

Get a summoner by id synchronously.

Declaration
public Summoner GetSummoner(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region in which you wish to look for a summoner.

System.Int64 summonerId

Id of the summoner you're looking for.

Returns
Type Description
Summoner

A summoner.

Implements
IRiotApi.GetSummoner(Region, Int64)

GetSummoner(Region, String)

Get a summoner by name synchronously.

Declaration
public Summoner GetSummoner(Region region, string summonerName)
Parameters
Type Name Description
Region region

Region in which you wish to look for a summoner.

System.String summonerName

Name of the summoner you're looking for.

Returns
Type Description
Summoner

A summoner.

Implements
IRiotApi.GetSummoner(Region, String)

GetSummonerAsync(Region, Int64)

Get a summoner by id asynchronously.

Declaration
public Task<Summoner> GetSummonerAsync(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region in which you wish to look for a summoner.

System.Int64 summonerId

Id of the summoner you're looking for.

Returns
Type Description
Task<><Summoner>

A summoner.

Implements
IRiotApi.GetSummonerAsync(Region, Int64)

GetSummonerAsync(Region, String)

Get a summoner by name asynchronously.

Declaration
public Task<Summoner> GetSummonerAsync(Region region, string summonerName)
Parameters
Type Name Description
Region region

Region in which you wish to look for a summoner.

System.String summonerName

Name of the summoner you're looking for.

Returns
Type Description
Task<><Summoner>

A summoner.

Implements
IRiotApi.GetSummonerAsync(Region, String)

GetSummonerName(Region, Int64)

Get a summoner's name and id synchronously.

Declaration
public SummonerBase GetSummonerName(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

System.Int64 summonerId

Id of the summoner you're looking for.

Returns
Type Description
SummonerBase

A summoner (id and name).

Implements
IRiotApi.GetSummonerName(Region, Int64)

GetSummonerNameAsync(Region, Int64)

Get a summoner's name and id asynchronously.

Declaration
public Task<SummonerBase> GetSummonerNameAsync(Region region, long summonerId)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

System.Int64 summonerId

Id of the summoner you're looking for.

Returns
Type Description
Task<><SummonerBase>

A summoner (id and name).

Implements
IRiotApi.GetSummonerNameAsync(Region, Int64)

GetSummonerNames(Region, List<Int64>)

Get a list of summoner's names and ids synchronously, you can submit more than 40 summoner ids.

Declaration
public List<SummonerBase> GetSummonerNames(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.Int64> summonerIds

List of ids of the summoners you're looking for, not limited to 40.

Returns
Type Description
List<><SummonerBase>

A list of ids and names of summoners.

Implements
IRiotApi.GetSummonerNames(Region, List<Int64>)

GetSummonerNamesAsync(Region, List<Int64>)

Get a list of summoner's names and ids asynchronously, you can submit more than 40 summoner ids.

Declaration
public Task<List<SummonerBase>> GetSummonerNamesAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.Int64> summonerIds

List of ids of the summoners you're looking for, not limited to 40.

Returns
Type Description
Task<><List<><SummonerBase>>

A list of ids and names of summoners.

Implements
IRiotApi.GetSummonerNamesAsync(Region, List<Int64>)

GetSummoners(Region, List<Int64>)

Get summoners by ids synchronously, you can submit more than 40 summoner ids.

Declaration
public List<Summoner> GetSummoners(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.Int64> summonerIds

List of ids of the summoners you're looking for, not limited to 40.

Returns
Type Description
List<><Summoner>

A list of summoners.

Implements
IRiotApi.GetSummoners(Region, List<Int64>)

GetSummoners(Region, List<String>)

Get summoners by names synchronously, you can submit more than 40 summoner names.

Declaration
public List<Summoner> GetSummoners(Region region, List<string> summonerNames)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.String> summonerNames

List of names of the summoners you're looking for, not limited to 40.

Returns
Type Description
List<><Summoner>

A list of summoners.

Implements
IRiotApi.GetSummoners(Region, List<String>)

GetSummonersAsync(Region, List<Int64>)

Get summoners by ids asynchronously, you can submit more than 40 summoner ids.

Declaration
public Task<List<Summoner>> GetSummonersAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.Int64> summonerIds

List of ids of the summoners you're looking for, not limited to 40.

Returns
Type Description
Task<><List<><Summoner>>

A list of summoners.

Implements
IRiotApi.GetSummonersAsync(Region, List<Int64>)

GetSummonersAsync(Region, List<String>)

Get summoners by names asynchronously, you can submit more than 40 summoner names.

Declaration
public Task<List<Summoner>> GetSummonersAsync(Region region, List<string> summonerNames)
Parameters
Type Name Description
Region region

Region in which you wish to look for summoners.

List<><System.String> summonerNames

List of names of the summoners you're looking for, not limited to 40.

Returns
Type Description
Task<><List<><Summoner>>

A list of summoners.

Implements
IRiotApi.GetSummonersAsync(Region, List<String>)

GetTeams(Region, List<Int64>)

Get the teams for the specified ids synchronously, you can submit more than 10 summoner ids.

Declaration
public Dictionary<long, List<Team>> GetTeams(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which the teams are located.

List<><System.Int64> summonerIds

List of summoner ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.Int64, List<><Team>>

A map of teams indexed by summoner id.

Implements
IRiotApi.GetTeams(Region, List<Int64>)

GetTeams(Region, List<String>)

Get the teams for the specified ids synchronously, you can submit more than 10 team ids.

Declaration
public Dictionary<string, Team> GetTeams(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which the teams are located.

List<><System.String> teamIds

List of the team ids, not limited to 10.

Returns
Type Description
Dictionary<, ><System.String, Team>

A map of teams indexed by their id.

Implements
IRiotApi.GetTeams(Region, List<String>)

GetTeamsAsync(Region, List<Int64>)

Get the teams for the specified ids asynchronously, you can submit more than 10 summoner ids.

Declaration
public Task<Dictionary<long, List<Team>>> GetTeamsAsync(Region region, List<long> summonerIds)
Parameters
Type Name Description
Region region

Region in which the teams are located.

List<><System.Int64> summonerIds

List of summoner ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.Int64, List<><Team>>>

A map of teams indexed by summoner id.

Implements
IRiotApi.GetTeamsAsync(Region, List<Int64>)

GetTeamsAsync(Region, List<String>)

Get the teams for the specified ids asynchronously, you can submit more than 10 team ids.

Declaration
public Task<Dictionary<string, Team>> GetTeamsAsync(Region region, List<string> teamIds)
Parameters
Type Name Description
Region region

Region in which the teams are located.

List<><System.String> teamIds

List of the team ids, not limited to 10.

Returns
Type Description
Task<><Dictionary<, ><System.String, Team>>

A map of teams indexed by their id.

Implements
IRiotApi.GetTeamsAsync(Region, List<String>)

GetTopChampionsMasteryEntries(Platform, Int64, Int32)

Gets specified number of top champion mastery entries, sorted by number of champion points descending, by summoner ID synchronously.

Declaration
public List<ChampionMastery> GetTopChampionsMasteryEntries(Platform platform, long summonerId, int count = 3)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

System.Int32 count

Number of entries to retrieve, defaults to 3.

Returns
Type Description
List<><ChampionMastery>

A list of the top champion mastery entries for the specified summoner ID.

Implements
IRiotApi.GetTopChampionsMasteryEntries(Platform, Int64, Int32)

GetTopChampionsMasteryEntriesAsync(Platform, Int64, Int32)

Gets specified number of top champion mastery entries, sorted by number of champion points descending, by summoner ID asynchronously.

Declaration
public Task<List<ChampionMastery>> GetTopChampionsMasteryEntriesAsync(Platform platform, long summonerId, int count = 3)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

System.Int32 count

Number of entries to retrieve, defaults to 3.

Returns
Type Description
Task<><List<><ChampionMastery>>

A list of the top champion mastery entries for the specified summoner ID.

Implements
IRiotApi.GetTopChampionsMasteryEntriesAsync(Platform, Int64, Int32)

GetTotalChampionMasteryScore(Platform, Int64)

Get a player's total champion mastery score, which is the sum of individual champion mastery levels, by summoner ID synchronously.

Declaration
public int GetTotalChampionMasteryScore(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

Returns
Type Description
System.Int32

Total champion mastery score for summoner ID.

Implements
IRiotApi.GetTotalChampionMasteryScore(Platform, Int64)

GetTotalChampionMasteryScoreAsync(Platform, Int64)

Get a player's total champion mastery score, which is the sum of individual champion mastery levels, by summoner ID asynchronously.

Declaration
public Task<int> GetTotalChampionMasteryScoreAsync(Platform platform, long summonerId)
Parameters
Type Name Description
Platform platform

Region where to retrieve the data.

System.Int64 summonerId

ID of the summoner for which to retrieve champion mastery.

Returns
Type Description
Task<><System.Int32>

Total champion mastery score for summoner ID.

Implements
IRiotApi.GetTotalChampionMasteryScoreAsync(Platform, Int64)
Back to top Copyright © 2015-2016 Microsoft
Generated by DocFX