Implemented types
- class async_riot_api.types.RiotApiResponse(success: bool = True, **kwargs)
Bases:
objectSuperclass of all API responses.
- Parameters
success (bool) – wether the response was successful. Useful to spot errors
- class async_riot_api.types.RiotApiError(message: str = 'Bad Request', status_code: int = 400, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseGeneral API response error.
- class async_riot_api.types.ShortChampionDD(blurb: str, id: str, image: dict, info: dict, key: str, name: str, partype: str, stats: dict, tags: List[str], title: str, version: str, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseShort information about a champion
- Parameters
blurb (str) – short description
id (str) – name of the champion without non-alphabetic characters
image (
ChampionImageDD) – information about the images of a championinfo (
ChampionInfoDD) – schematic information about the championkey (str) – unique key for a champion. For some reason this is originally a string, despite representing an integer
name (str) – complete name of the champion
partype (str) – type of energy used by the champion. Usually ‘Mana’ but could be ‘Energy’ or others
stats (
ChampionStatsDD) – statistics of the championtags (List[str]) – tags about the champion, like ‘Fighter’, ‘Mage’
title (str) – short title of the champion
version (str) – valid version for this object
- Other attributes:
- int_id (
int): integer representation of param
ShortChampionDD.key. Not present in the original data type, useful for some methods and, more importantly, coherent with the represented value
- int_id (
- class async_riot_api.types.ChampionDD(id: str, key: str, name: str, title: str, image: dict, skins: List[dict], lore: str, blurb: str, allytips: List[str], enemytips: List[str], tags: List[str], partype: str, info: dict, stats: dict, spells: List[dict], passive: dict, recommended: list, version: str, **kwargs)
Bases:
async_riot_api.types.ShortChampionDDComplete information about a champion.
Look at
ShortChampionDDfor the complete list of parameters.- Parameters
skins (List[
ChampionSkinDD]) – list of skinslore (str) – lore of the champion
allytips (List[str]) – list of tips for summoners playing the champion
enemytips (List[str]) – list of tipo for summoners playing against the champion
spells (List[
ChampionSpellDD]) – list of information about this champion’s spellspassive (
ChampionPassiveDD) – information about this champion’s passive abilityrecommended (List[unknown]) – no idea of what this is, haven’t found any champion with a non-empty list of
recommended
- class async_riot_api.types.ChampionImageDD(full: str, sprite: str, group: str, x: int, y: int, w: int, h: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseDetails about the champion’s image.
- Parameters
full (str) – file name of the image. The complete url can be obtained from
get_champion_image_url_from_id()sprite (str) – don’t really know what this is, some kind of image with more images inside. You can find more info here
group (str) – sub-category in which you can find the sprite of this image, more info in the same link as above
x (int) – x coordinate of the sprite in which you can find this image
y (int) – y coordinate of the sprite in which you can find this image
w (int) – width of the image in the sprite, starting from coordinates (x, y)
h (int) – height of the image in the sprite, starting from coordinates (x, y)
- class async_riot_api.types.ChampionSkinDD(id: str, num: int, name: str, chromas: bool, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseDetails about the champion’s skins.
- Parameters
id (str) – unique id of the skin. It is made by concatenating the champ ID and the skin number (with 3 digits). Example: champion “Veigar” (ID 45), skin “Final Boss” (num 8), result: “45008”
num (int) – number of the skin
name (str) – name of the skin, including the champion name (if present)
chromas (bool) – if the skin has got chromas
- class async_riot_api.types.ChampionInfoDD(attack: int, defense: int, magic: int, difficulty: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseSchematic information about the champion. You can find this information in the LoL client by going to a champion’s page.
- Parameters
attack (int) – the higher this value, the higher the champion deals damage using auto attacks
defense (int) – the higher this value, the higher the champion is tanky
magic (int) – the higher this value, the higher the champion deals damage using spells
difficulty (int) – the higher this value, the more difficult is to master this champion
- class async_riot_api.types.ChampionStatsDD(hp: int, hpperlevel: int, mp: int, mpperlevel: int, movespeed: int, armor: int, armorperlevel: float, spellblock: int, spellblockperlevel: float, attackrange: int, hpregen: int, hpregenperlevel: int, mpregen: int, mpregenperlevel: int, crit: int, critperlevel: int, attackdamage: int, attackdamageperlevel: int, attackspeedperlevel: float, attackspeed: float, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseDetailed information about a champion’s base stats and how they increase when leveling up. Here i list their meanings and their unit of measurement where:
ustands for “unit”lstands for “level”sstands for “second”
- Parameters
hp (int) – base health points (
u)hpperlevel (int) – extra HP per level (
u / l)mp (int) – base mana points (
u)mpperlevel (int) – extra mana points per level (
u / l)movespeed (int) – base movement speed (
u / s)armor (int) – base armor (
u)armorperlevel (float) – extra armor per level (
u / l)spellblock (int) – base magic resistance (
u)spellblockperlevel (float) – extra magic resistance per level (
u / l)attackrange (int) – base attack range (
u)hpregen (int) – base HP regeneration (
u / 5s)hpregenperlevel (int) – extra HP regeneration per level (
u / 5s / l)mpregen (int) – base mana regeneration (
u / 5s)mpregenperlevel (int) – extra mana regeneration per level (
u / 5s / l)crit (int) – base critical chance (
u)critperlevel (int) – extra critical chance per level (
u / l)attackdamage (int) – base attack damage (
u)attackdamageperlevel (int) – extra attack damage per level (
u / l)attackspeedperlevel (float) – extra attack speed per level (
u / s / l)attackspeed (float) – base attack speed (
u / s)
- class async_riot_api.types.ChampionSpellDD(id: str, name: str, description: str, tooltip: str, maxrank: int, cooldown: List[int], cooldownBurn: str, cost: List[int], costBurn: str, datavalues: dict, effect: List[Optional[List[int]]], effectBurn: List[Optional[str]], vars: List[Any], costType: str, maxammo: str, range: List[int], rangeBurn: str, image: dict, leveltip: Optional[dict] = None, resource: Optional[str] = None, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseSpecific information about a champion spell (skill). Complete documentation about string placeholders and parsing is here.
- Parameters
id (str) – spell’s ID, including champion name and spell name
name (str) – spell’s name
description (str) – spell’s description
tooltip (str) – similar to
description, but contains placeholders to build a string including data about damage per level, AP/AD scaling ecc. Can be parsed to make the string look like the one in gamemaxrank (int) – maximum rank for this ability
cooldown (List[int]) – data about placeholders for cooldown
cooldownBurn (str) – like
cooldown, but as stringcost (List[int]) – data about placeholders for cost
costBurn (str) – like
cost, but as stringdatavalues (
ChampionSpellDatavaluesDD) – no documentation found. No champion found with a non-empty dict ofdatavalueseffect (List[Optional[List[int]]]) – like
cost, but when the spell costs health. The first element is always None for design reasonseffectBurn (List[Optional[str]]) – like
effect, but as stringvars (List[unknown]) – no documentation found. No champion found with a non-empty list of
varscostType (str) – type of resources spent for using the ability
maxammo (str) – in case the spell has ammos, like traps. ‘-1’ if no ammos. For some reason this integer is represented as a string
range (List[int]) – data about placeholders for range
rangeBurn (str) – like
range, but as stringimage (
ChampionSpellImageDD) – details about the spell’s imageleveltip (
ChampionSpellLeveltipDD) – data about placeholders for levelsresource (Optional[str]) – placeholder for cost
- class async_riot_api.types.ChampionSpellDatavaluesDD(**kwargs)
- class async_riot_api.types.ChampionSpellImageDD(full: str, sprite: str, group: str, x: int, y: int, w: int, h: int, **kwargs)
- class async_riot_api.types.ChampionPassiveImageDD(full: str, sprite: str, group: str, x: int, y: int, w: int, h: int, **kwargs)
- class async_riot_api.types.QueueDD(queueId: int, map: str, description: str, notes: str, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseRepresentation of a queue. Not actually returned by any API call, but still usefu sometimes.
- class async_riot_api.types.AccountDto(puuid: str, gameName: str, tagLine: str, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseBasic information about a Riot Games account.
- class async_riot_api.types.ActiveShardDto(puuid: str, game: str, activeShard: str, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseNo idea about what this is. Probably the server in which the summoner plays.
- class async_riot_api.types.ChampionMasteryDto(championPointsUntilNextLevel: int, chestGranted: bool, championId: int, lastPlayTime: int, championLevel: int, summonerId: str, championPoints: int, championPointsSinceLastLevel: int, tokensEarned: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseInformation about a summoner’s mastery levels, tokens and chests.
- Parameters
championPointsUntilNextLevel (int) – points needed for the mastery to upgrade to the next level
chestGranted (bool) – if the player already got the weekly chest on the champion
championId (int) – champion ID
lastPlayTime (int) – laste time the player played the champion
lastPlayTimeSeconds (int) – laste time the player played the champion (granted to be in seconds)
championLevel (int) – mastery level for the champion. Min 1, max 7
summonerId (str) – summoner ID
championPoints (int) – mastery points for the champion
championPointsSinceLastLevel (int) – points earned since last mastery level
tokensEarned (int) – tokens earned to upgrade the mastery level to level 6 (0-2) or 7 (0-3)
- class async_riot_api.types.ChampionInfo(maxNewPlayerLevel: int, freeChampionIdsForNewPlayers: List[int], freeChampionIds: List[int], **kwargs)
Bases:
async_riot_api.types.RiotApiResponseInformation about the current champion rotation and the new players’ champion rotation.
- class async_riot_api.types.PlayerDto(summonerId: str, teamId: str, position: str, role: str, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseData about a player in a clash.
- class async_riot_api.types.ClashTeamDto(id: str, tournamentId: int, name: str, iconId: int, tier: int, captain: str, abbreviation: str, players: List[dict], **kwargs)
- class async_riot_api.types.TournamentDto(id: int, themeId: int, nameKey: str, nameKeySecondary: str, schedule: List[dict], **kwargs)
Bases:
async_riot_api.types.RiotApiResponseInformation about a tournament.
- Parameters
id (int) – tournament ID
themeId (int) – no idea, not originally documented
nameKey (str) – no idea, not originally documented
nameKeySecondary (str) – no idea, not originally documented
schedule (
TournamentPhaseDto) – schedule for this tournament
- class async_riot_api.types.TournamentPhaseDto(id: int, registrationTime: int, startTime: int, cancelled: bool, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseSchedule information for a tournament.
- class async_riot_api.types.LeagueListDTO(tier: str, leagueId: str, queue: str, name: str, entries: List[dict], **kwargs)
Bases:
async_riot_api.types.RiotApiResponseList of information about leagues for summoners in the same queue.
- Parameters
tier (str) – rank tier, like ‘CHALLENGER’ or ‘MASTER’
leagueId (str) – league ID
queue (str) – queue type, like ‘RANKED_SOLO_5x5’
name (str) – list name
entries (List[
LeagueItemDTO]) – entries for this list
- class async_riot_api.types.LeagueItemDTO(summonerId: str, summonerName: str, leaguePoints: int, rank: str, wins: int, losses: int, veteran: bool, inactive: bool, freshBlood: bool, hotStreak: bool, miniSeries: Optional[dict] = None, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseSimplified information about a summoner’s rank in a queue, returned by methods for apex tiers. Some information are missing since they are included in the higher level object
LeagueListDTOcontaining this object.- Parameters
summonerId (str) – summoner ID
summonerName (str) – summoner name
leaguePoints (int) – aka LP
rank (str) – rank of the summoner, between ‘I’ and ‘IV’ (in roman numbers)
wins (int) – wins for this season
losses (int) – losses for this season
veteran (bool) – wether the summoner is a veteran in this rank
inactive (bool) – wether the summoner is inactive
freshBlood (bool) – wether the summoner is a new entry in this rank
hotStreak (bool) – wether the summoner is on a hot streak (winning streak)
miniSeries (Optional[
MiniSeriesDTO]) – information about a summoner miniseries, if they are about to get promoted from a tier to the next
- class async_riot_api.types.LeagueEntryDTO(summonerId: str, summonerName: str, queueType: str, leaguePoints: int, wins: int, losses: int, hotStreak: bool, veteran: bool, freshBlood: bool, inactive: bool, miniSeries: Optional[dict] = None, leagueId: Optional[str] = None, tier: Optional[str] = None, rank: Optional[str] = None, **kwargs)
Bases:
async_riot_api.types.LeagueItemDTOComplete information about summoner’s league.
Look at
LeagueItemDTOfor the complete list of parameters.- Parameters
- Other attributes:
- short (
Optional[str]): short representation of rank and tier. For example ‘DIAMOND III’ becomes ‘D3’. Exception is made for ‘GRANDMASTER x’ which becomes ‘GMx’ due to the ambuguity between ‘GOLD’ and ‘GRANDMASTER’
- short (
- class async_riot_api.types.MiniSeriesDTO(losses: int, progress: str, target: int, wins: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseInformation about a summoner’s miniseries, if they are about to get promoted to the next tier. Miniseries consist in 5 matches in which you have to win 3 times to get promoted. Before season 11, miniseries were also required when passing from a rank to another, with 3 matches instead of 5 and 2 victories instead of 3.
- class async_riot_api.types.ShardStatus(name: str, slug: str, locales: List[str], hostname: str, region_tag: str, services: List[dict], **kwargs)
- class async_riot_api.types.Service(name: str, slug: str, status: str, incidents: List[dict], **kwargs)
- class async_riot_api.types.Incident(id: int, active: bool, created_at: str, updates: List[dict], **kwargs)
- class async_riot_api.types.Message(id: str, author: str, heading: str, content: str, severity: str, created_at: str, updated_at: str, translations: List[dict], **kwargs)
- class async_riot_api.types.PlatformDataDto(id: str, name: str, locales: List[str], maintenances: List[dict], incidents: List[dict], **kwargs)
- class async_riot_api.types.StatusDto(id: int, maintenance_status: str, incident_severity: Optional[str], titles: List[dict], updates: List[dict], created_at: str, archive_at: str, updated_at: Optional[str], platforms: List[str], **kwargs)
- class async_riot_api.types.UpdateDto(id: int, author: str, publish: bool, publish_locations: List[str], translations: List[dict], created_at: str, updated_at: str, **kwargs)
- class async_riot_api.types.LorMatchDto(metadata: dict, info: dict, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseBase object containing inforamtion about a LoR match.
- Parameters
metadata (
LorMetadataDto) – to access the ordered list of participantsinfo (
LorInfoDto) – more detailed infor about players
- class async_riot_api.types.LorMetadataDto(data_version: str, match_id: str, participants: List[str], **kwargs)
Bases:
async_riot_api.types.RiotApiResponseMetadata about the match.
- class async_riot_api.types.LorInfoDto(game_mode: str, game_type: str, game_start_time_utc: str, game_version: str, players: List[dict], total_turn_count: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseDetailed information about a LoR match. Contains information about mode, duration and players.
- Parameters
game_mode (str) – game mode
game_type (str) – game type
game_start_time_utc (str) – game start time utc
game_version (str) – game version
players (List[
LorPlayerDto]) – list of detailed information about the players involved in the match, in the same order asLorMetadataDtototal_turn_count (int) – total turn count
- class async_riot_api.types.LorPlayerDto(puuid: str, deck_id: str, deck_code: str, factions: List[str], game_outcome: str, order_of_play: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseDetailed information about a player in a LoR match.
- class async_riot_api.types.LorLeaderboardDto(players: List[dict], **kwargs)
Bases:
async_riot_api.types.RiotApiResponseList of players in LoR Master tier. :param players: list of players :type players: List[
LorLeaderboardPlayerDto]
- class async_riot_api.types.LorLeaderboardPlayerDto(name: str, rank: int, lp: int, **kwargs)
Bases:
async_riot_api.types.RiotApiResponseInformation about a player in LoR Master tier.
- class async_riot_api.types.MetadataDto(dataVersion: str, matchId: str, participants: List[str], **kwargs)
- class async_riot_api.types.InfoDto(gameCreation: int, gameDuration: int, gameId: int, gameMode: str, gameName: str, gameStartTimestamp: int, gameType: str, gameVersion: str, mapId: int, participants: List[str], platformId: str, queueId: int, teams: List[dict], tournamentCode: Optional[str] = None, gameEndTimestamp: int = 0, **kwargs)
- class async_riot_api.types.ParticipantDto(assists: int, baronKills: int, bountyLevel: int, champExperience: int, champLevel: int, championId: int, championName: str, championTransform: int, consumablesPurchased: int, damageDealtToBuildings: int, damageDealtToObjectives: int, damageDealtToTurrets: int, damageSelfMitigated: int, deaths: int, detectorWardsPlaced: int, doubleKills: int, dragonKills: int, firstBloodAssist: bool, firstBloodKill: bool, firstTowerAssist: bool, firstTowerKill: bool, gameEndedInEarlySurrender: bool, gameEndedInSurrender: bool, goldEarned: int, goldSpent: int, individualPosition: str, inhibitorKills: int, inhibitorsLost: int, item0: int, item1: int, item2: int, item3: int, item4: int, item5: int, item6: int, itemsPurchased: int, killingSprees: int, kills: int, lane: str, largestCriticalStrike: int, largestKillingSpree: int, largestMultiKill: int, longestTimeSpentLiving: int, magicDamageDealt: int, magicDamageDealtToChampions: int, magicDamageTaken: int, neutralMinionsKilled: int, nexusKills: int, nexusLost: int, objectivesStolen: int, objectivesStolenAssists: int, participantId: int, pentaKills: int, perks: dict, physicalDamageDealt: int, physicalDamageDealtToChampions: int, physicalDamageTaken: int, profileIcon: int, puuid: str, quadraKills: int, riotIdName: str, riotIdTagline: str, role: str, sightWardsBoughtInGame: int, spell1Casts: int, spell2Casts: int, spell3Casts: int, spell4Casts: int, summoner1Casts: int, summoner1Id: int, summoner2Casts: int, summoner2Id: int, summonerId: str, summonerLevel: int, summonerName: str, teamEarlySurrendered: bool, teamId: int, teamPosition: str, timeCCingOthers: int, timePlayed: int, totalDamageDealt: int, totalDamageDealtToChampions: int, totalDamageShieldedOnTeammates: int, totalDamageTaken: int, totalHeal: int, totalHealsOnTeammates: int, totalMinionsKilled: int, totalTimeCCDealt: int, totalTimeSpentDead: int, totalUnitsHealed: int, tripleKills: int, trueDamageDealt: int, trueDamageDealtToChampions: int, trueDamageTaken: int, turretKills: int, turretsLost: int, unrealKills: int, visionScore: int, visionWardsBoughtInGame: int, wardsKilled: int, wardsPlaced: int, win: bool, inhibitorTakedowns: int = 0, nexusTakedowns: int = 0, turretTakedowns: int = 0, **kwargs)
- class async_riot_api.types.PerkStyleDto(description: str, selections: List[dict], style: int, **kwargs)
- class async_riot_api.types.PerkStyleSelectionDto(perk: int, var1: int, var2: int, var3: int, **kwargs)
- class async_riot_api.types.TeamDto(bans: List[dict], objectives: dict, teamId: int, win: bool, **kwargs)
- class async_riot_api.types.ObjectivesDto(baron: dict, champion: dict, dragon: dict, inhibitor: dict, riftHerald: dict, tower: dict, **kwargs)
- class async_riot_api.types.MTLInfoDto(frameInterval: int, frames: List[dict], gameId: int, participants: List[dict], **kwargs)
- class async_riot_api.types.MTLFrameDto(events: List[dict], participantFrames: dict, timestamp: int, **kwargs)
- class async_riot_api.types.MTLEventDto(timestamp: int, type: str, levelUpType: Optional[str] = None, participantId: Optional[int] = None, skillSlot: Optional[int] = None, realTimestamp: Optional[int] = None, itemId: Optional[int] = None, afterId: Optional[int] = None, beforeId: Optional[int] = None, goldGain: Optional[int] = None, creatorId: Optional[int] = None, wardType: Optional[int] = None, assistingParticipantIds: Optional[List[int]] = None, bounty: Optional[int] = None, killStreakLength: Optional[int] = None, killerId: Optional[int] = None, position: Optional[dict] = None, victimDamageDealt: Optional[List[dict]] = None, victimDamageReceived: Optional[List[dict]] = None, victimId: Optional[int] = None, killType: Optional[int] = None, level: Optional[int] = None, multiKillLength: Optional[int] = None, laneType: Optional[str] = None, teamId: Optional[int] = None, killerTeamId: Optional[int] = None, monsterSubType: Optional[str] = None, monsterType: Optional[str] = None, buildingType: Optional[str] = None, towerType: Optional[str] = None, name: Optional[str] = None, gameId: Optional[int] = None, winningTeam: Optional[int] = None, **kwargs)
- class async_riot_api.types.MTLDamageDto(basic: bool, magicDamage: int, name: str, participantId: int, physicalDamage: int, spellName: str, spellSlot: int, trueDamage: int, type: str, **kwargs)
- class async_riot_api.types.MTLParticipantFramesDto(f1: dict, f2: dict, f3: dict, f4: dict, f5: dict, f6: dict, f7: dict, f8: dict, f9: dict, f10: dict, **kwargs)
- class async_riot_api.types.MTLParticipantFrameDto(championStats: dict, currentGold: int, damageStats: dict, goldPerSecond: int, jungleMinionsKilled: int, level: int, minionsKilled: int, participantId: int, position: dict, timeEnemySpentControlled: int, totalGold: int, xp: int, **kwargs)
- class async_riot_api.types.MTLChampionStatsDto(abilityHaste: int, abilityPower: int, armor: int, armorPen: int, armorPenPercent: int, attackDamage: int, attackSpeed: int, bonusArmorPenPercent: int, bonusMagicPenPercent: int, ccReduction: int, cooldownReduction: int, health: int, healthMax: int, healthRegen: int, lifesteal: int, magicPen: int, magicPenPercent: int, magicResist: int, movementSpeed: int, omnivamp: int, physicalVamp: int, power: int, powerMax: int, powerRegen: int, spellVamp: int, **kwargs)
- class async_riot_api.types.MTLDamageStatsDto(magicDamageDone: int, magicDamageDoneToChampions: int, magicDamageTaken: int, physicalDamageDone: int, physicalDamageDoneToChampions: int, physicalDamageTaken: int, totalDamageDone: int, totalDamageDoneToChampions: int, totalDamageTaken: int, trueDamageDone: int, trueDamageDoneToChampions: int, trueDamageTaken: int, **kwargs)
- class async_riot_api.types.CurrentGameInfo(gameId: int, gameType: str, gameStartTime: int, mapId: int, gameLength: int, platformId: str, gameMode: str, bannedChampions: List[dict], gameQueueConfigId: int, observers: dict, participants: List[dict], **kwargs)
- class async_riot_api.types.CurrentGameParticipant(championId: int, perks: dict, profileIconId: int, bot: bool, teamId: int, summonerName: str, summonerId: str, spell1Id: int, spell2Id: int, gameCustomizationObjects: List[dict], **kwargs)
- class async_riot_api.types.FeaturedGames(gameList: List[dict], clientRefreshInterval: int, **kwargs)
- class async_riot_api.types.FeaturedGameInfo(gameMode: str, gameLength: int, mapId: int, gameType: str, bannedChampions: List[dict], gameId: int, observers: dict, gameQueueConfigId: int, gameStartTime: int, participants: List[dict], platformId: str, **kwargs)