Using Cassiopeia

Objects that hold data from the Riot API can be created using two different interfaces. The top-level cassiopeia module contains methods to query for objects using method calls, as well as class constructors to create objects directly.

Example usage of the two interfaces:

import cassiopeia as cass
kalturi = cass.get_summoner(name="Kalturi")

from cassiopeia import Summoner
kalturi = Summoner(name="Kalturi")

Also note that many types can be pulled from Summoner objects. This is the preferred way to interact with these types. They are listed below:

from cassiopeia import Summoner
kalturi = Summoner(name="Kalturi")
kalturi.champion_masteries
kalturi.match_history
kalturi.mastery_pages
kalturi.rune_pages
kalturi.current_match
kalturi.leagues

Methods and Class Constructors

See on the links below for the method and class names for each type.

• Champions
• Champion Masteries
• Items
• Language Strings
• Leagues
• Locales
• Maps
• Masteries
• Matches
• Profile Icons
• Realms
• Runes
• Status
• Spectator
• Summoners
• Summoner Spells
• Versions

Data and Enums

These data are available as enums (constants) and can be used to interact with many of the objects and methods in Cass.

class cassiopeia.data.Division

Bases: enum.Enum

An enumeration.

five = 'V'

four = 'IV'

one = 'I'

three = 'III'

two = 'II'

class cassiopeia.data.GameMode

Bases: enum.Enum

An enumeration.

aram = 'ARAM'

arsr = 'ARSR'

ascension = 'ASCENSION'

assassinate = 'ASSASSINATE'

classic = 'CLASSIC'

dark_star = 'DARKSTAR'

dominion = 'ODIN'

doom_bots = 'DOOMBOTSTEEMO'

nexus_siege = 'SIEGE'

one_for_all = 'ONEFORALL'

poro_king = 'KINGPORO'

showdown = 'FIRSTBLOOD'

star_guardian = 'STARGUARDIAN'

tutorial = 'TUTORIAL'

urf = 'URF'

class cassiopeia.data.GameType

Bases: enum.Enum

An enumeration.

custom = 'CUSTOM_GAME'

matched = 'MATCHED_GAME'

tutorial = 'TUTORIAL_GAME'

class cassiopeia.data.Lane

Bases: enum.Enum

An enumeration.

bot_lane = 'BOT_LANE'

mid_lane = 'MID_LANE'

top_lane = 'TOP_LANE'

class cassiopeia.data.MasteryTree

Bases: enum.Enum

An enumeration.

cunning = 'Cunning'

ferocity = 'Ferocity'

resolve = 'Resolve'

class cassiopeia.data.Platform

Bases: enum.Enum

An enumeration.

brazil = 'BR1'

default_locale

europe_north_east = 'EUN1'

europe_west = 'EUW1'

japan = 'JP1'

korea = 'KR'

latin_america_north = 'LA1'

latin_america_south = 'LA2'

north_america = 'NA1'

oceania = 'OC1'

pbe = 'PBE1'

region

russia = 'RU'

turkey = 'TR1'

class cassiopeia.data.Queue

Bases: enum.Enum

An enumeration.

all_random_summoners_rift = 'ARSR_5x5'

all_random_urf = 'ARURF_5X5'

aram = 'ARAM_5x5'

ascension = 'ASCENSION_5x5'

black_market = 'BILGEWATER_5x5'

blood_hunt = 'ASSASSINATE_5x5'

bot_beginner_fives = 'BOT_5x5_BEGINNER'

bot_dominion = 'BOT_ODIN_5x5'

bot_fives = 'BOT_5x5'

bot_intermediate_fives = 'BOT_5x5_INTERMEDIATE'

bot_intro_fives = 'BOT_5x5_INTRO'

bot_threes = 'BOT_TT_3x3'

bot_urf = 'BOT_URF_5x5'

butchers_bridge = 'BILGEWATER_ARAM_5x5'

custom = 'CUSTOM'

darkstar = 'DARKSTAR_3x3'

definitely_not_dominion = 'DEFINITELY_NOT_DOMINION_5x5'

dominion_blind = 'ODIN_5x5_BLIND'

dominion_draft = 'ODIN_5x5_DRAFT'

doom_bots_1 = 'NIGHTMARE_BOT_5x5_RANK1'

doom_bots_2 = 'NIGHTMARE_BOT_5x5_RANK2'

doom_bots_5 = 'NIGHTMARE_BOT_5x5_RANK5'

dynamic_queue = 'TEAM_BUILDER_DRAFT_UNRANKED_5x5'

flex = 'RANKED_FLEX_SR'

flex_threes = 'RANKED_FLEX_TT'

from_id(id: int)

hexakill_summoners_rift = 'SR_6x6'

hexakill_twisted_treeline = 'HEXAKILL'

nemesis_draft = 'COUNTER_PICK'

nexus_siege = 'SIEGE'

normal_blind_fives = 'NORMAL_5x5_BLIND'

normal_blind_threes = 'NORMAL_3x3'

normal_draft_fives = 'NORMAL_5x5_DRAFT'

one_for_all = 'ONEFORALL_5x5'

one_for_all_mirror = 'ONEFORALL_MIRRORMODE_5x5'

poro_king = 'KING_PORO_5x5'

ranked_dynamic_queue = 'TEAM_BUILDER_DRAFT_RANKED_5x5'

ranked_fives = 'RANKED_TEAM_5x5'

ranked_premade_fives = 'RANKED_PREMADE_5x5'

ranked_premade_threes = 'RANKED_PREMADE_3x3'

ranked_solo = 'RANKED_SOLO_5x5'

ranked_solo_queue = 'TEAM_BUILDER_RANKED_SOLO'

ranked_threes = 'RANKED_TEAM_3x3'

showdown_duo = 'FIRSTBLOOD_2x2'

showdown_solo = 'FIRSTBLOOD_1x1'

team_builder = 'GROUP_FINDER_5x5'

urf = 'URF_5x5'

class cassiopeia.data.Region

Bases: enum.Enum

An enumeration.

brazil = 'BR'

default_locale

europe_north_east = 'EUNE'

europe_west = 'EUW'

japan = 'JP'

korea = 'KR'

latin_america_north = 'LAN'

latin_america_south = 'LAS'

north_america = 'NA'

oceania = 'OCE'

pbe = 'PBE'

platform

russia = 'RU'

turkey = 'TR'

class cassiopeia.data.Resource

Bases: enum.Enum

An enumeration.

blood_well = 'Blood Well'

courage = 'Courage'

crimson_rush = 'Crimson Rush'

energy = 'Energy'

ferocity = 'Ferocity'

flow = 'Flow'

fury = 'Fury'

heat = 'Heat'

mana = 'Mana'

no_cost = 'No Cost'

none = 'None'

rage = 'Rage'

shield = 'Shield'

class cassiopeia.data.Role

Bases: enum.Enum

An enumeration.

adc = 'DUO_CARRY'

jungle = 'JUNGLE'

middle = 'MIDDLE'

support = 'DUO_SUPPORT'

top = 'TOP'

class cassiopeia.data.RuneType

Bases: enum.Enum

An enumeration.

glyph = 'blue'

mark = 'red'

quint = 'black'

seal = 'yellow'

class cassiopeia.data.Season

Bases: enum.Enum

An enumeration.

from_id(id: int)

preseason_3 = 'PRESEASON3'

preseason_4 = 'PRESEASON2014'

preseason_5 = 'PRESEASON2015'

preseason_6 = 'PRESEASON2016'

preseason_7 = 'PRESEASON2017'

season_3 = 'SEASON3'

season_4 = 'SEASON2014'

season_5 = 'SEASON2015'

season_6 = 'SEASON2016'

season_7 = 'SEASON2017'

class cassiopeia.data.Side

Bases: enum.Enum

An enumeration.

blue = 100

red = 200

class cassiopeia.data.Tier

Bases: enum.Enum

An enumeration.

bronze = 'BRONZE'

challenger = 'CHALLENGER'

diamond = 'DIAMOND'

gold = 'GOLD'

master = 'MASTER'

platinum = 'PLATINUM'

silver = 'SILVER'

unranked = 'UNRANKED'

class cassiopeia.patches.Patch(season: str, name: str, start: typing.Union[datetime.datetime, float], end: typing.Union[datetime.datetime, float, NoneType])

Bases: object

end

classmethod from_date(date: datetime.datetime) → cassiopeia.patches.Patch

classmethod from_str(string: str) → cassiopeia.patches.Patch

major

majorminor

minor

name

revision

season

start