ClashApiV1¶
-
class
riotwatcher._apis.league_of_legends.
ClashApiV1
(base_api: riotwatcher._apis.BaseApi.BaseApi)¶ This class wraps the Clash-v1 endpoint calls provided by the Riot API.
See https://developer.riotgames.com/apis#clash-v1 for more detailed information
Initialize a new ClashApiV1 which uses the provided base_api
Parameters: base_api (BaseApi) – the root API object to use for making all requests. -
by_summoner
(region: str, summoner_id: str)¶ This endpoint returns a list of active Clash players for a given summoner ID. If a summoner registers for multiple tournaments at the same time (e.g., Saturday and Sunday) then both registrations would appear in this list.
Parameters: - region (string) – The region to execute this request on.
- summoner_id (string) – The summoner ID.
Returns: List[PlayerDTO]: represents the summoner’s info for the current clash.
-
by_team
(region: str, team_id: str)¶ Get team by ID.
Parameters: - region (string) – The region to execute this request on
- team_id (string) – Team ID
Returns: TeamDTO: represents a clash team
-
by_tournament
(region: str, tournament_id: str)¶ Get tournament by ID.
Parameters: - region (string) – The region to execute this request on
- tournament_id (string) – Tournament ID
Returns: TournamentDTO: represents a clash tournament
-
tournament_by_team
(region: str, team_id: str)¶ Get tournament by team ID.
Parameters: - region (string) – The region to execute this request on
- team_id (string) – Team ID
Returns: TournamentDTO: represents a clash tournament
-
tournaments
(region: str)¶ Returns a list of active and upcoming tournaments.
Parameters: region (string) – The region to execute this request on Returns: List[TournamentDTO]: represents all of the current tournaments active
-