Models

hsr

Modules:

• build –
• character –
• icon –
• player –
• response –

Classes:

• Build –

  Represents a HSR build.

• Character –

  Represents a character in HSR.

• CharacterIcon –

  Represents a HSR character icon.

• LightCone –

  Represents a light cone (weapon.)

• LightConeIcon –

  Represents a HSR light cone icon.

• Player –

  Represents a HSR player.

• PlayerStats –

  Represents the statistics of a HSR player.

• Relic –

  Represents a relic in HSR.

• RelicSubAffix –

  Represents a relic's sub-stat information.

• ShowcaseResponse –

  Represents a HSR showcase response.

• Stat –

  Represents a HSR stat.

• Trace –

  Represents a character's trace (skill).

Build pydantic-model

Represents a HSR build.

Attributes:

• id (int) –

  The build's ID.

• name (str) –

  The build's name.

• order (Decimal) –

  The build's order.

• live (bool) –

  Whether the build is live.

• character_id (int) –

  The build's character ID.

• character (C) –

  The build's character data.

Fields:

• id (int)
• name (str)
• order (Decimal)
• live (bool)
• character_id (int)
• character (C)

Character pydantic-model

Represents a character in HSR.

Attributes:

• level (int) –

  The character's level.

• ascension (Literal[0, 1, 2, 3, 4, 5, 6]) –

  The character's ascension level.

• id (int) –

  The character's ID.

• traces (list[Trace]) –

  List of the character's traces (skills).

• light_cone (LightCone | None) –

  The character's light cone (weapon).

• relics (list[Relic]) –

  List of the character's relics.

• eidolons (list[Eidolon]) –

  List of the character's eidolons.

• eidolons_unlocked (int) –

  The number of unlocked eidolons.

• is_assist (bool) –

  Whether the character is an assist character.

• icon (CharacterIcon) –

  The character's icon.

• name (str) –

  The character's name.

• rarity (Literal[4, 5]) –

  The character's rarity.

• element (Element) –

  The character's element (type.)

• path (Path) –

  The character's path.

• stats (dict[StatType, Stat]) –

  The character's stats.

• enhanced (bool) –

  Whether the character's traces are enhanced.

Config:

• arbitrary_types_allowed: True

Fields:

• level (int)
• ascension (Literal[0, 1, 2, 3, 4, 5, 6])
• id (int)
• traces (list[Trace])
• light_cone (LightCone | None)
• relics (list[Relic])
• eidolons (list[Eidolon])
• eidolons_unlocked (int)
• is_assist (bool)
• icon (CharacterIcon)
• name (str)
• rarity (Literal[4, 5])
• element (Element)
• path (Path)
• stats (dict[StatType, Stat])
• enhanced (bool)

Validators:

• __no_light_cone → light_cone

ascension pydantic-field

ascension: Literal[0, 1, 2, 3, 4, 5, 6] = 0

eidolons pydantic-field

eidolons: list[Eidolon]

eidolons_unlocked pydantic-field

eidolons_unlocked: int = 0

element pydantic-field

element: Element = FIRE

enhanced pydantic-field

enhanced: bool = False

highest_dmg_bonus_stat property

highest_dmg_bonus_stat: Stat

Character's highest damage bonus stat.

icon pydantic-field

icon: CharacterIcon

id pydantic-field

id: int

is_assist pydantic-field

is_assist: bool = False

level pydantic-field

level: int

light_cone pydantic-field

light_cone: LightCone | None = None

max_level property

max_level: Literal[20, 30, 40, 50, 60, 70, 80]

Character's max level.

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name pydantic-field

name: str = ''

path pydantic-field

path: Path = ABUNDANCE

rarity pydantic-field

rarity: Literal[4, 5] = 4

relics pydantic-field

relics: list[Relic]

stats pydantic-field

stats: dict[StatType, Stat]

traces pydantic-field

traces: list[Trace]

CharacterIcon pydantic-model

Represents a HSR character icon.

Attributes:

• character_id (int) –

  The character's ID.

Fields:

• character_id (int)

card property

card: str

Character icon in card shape.

Provided by Project Yatta. e.g. https://api.yatta.top/hsr/assets/UI//avatar/medium/1001.png

character_id pydantic-field

character_id: int

gacha property

gacha: str

Character gacha splash art.

e.g. https://enka.network/ui/hsr/SpriteOutput/AvatarDrawCard/1001.png

round property

round: str

Character icon in round shape.

e.g. https://enka.network/ui/hsr/SpriteOutput/AvatarRoundIcon/1001.png

LightCone pydantic-model

Represents a light cone (weapon.)

Attributes:

• id (int) –

  The light cone's ID.

• level (int) –

  The light cone's level.

• ascension (Literal[0, 1, 2, 3, 4, 5, 6]) –

  The light cone's ascension level.

• superimpose (Literal[1, 2, 3, 4, 5]) –

  The light cone's superimpose level.

• name (str) –

  The name of the light cone.

• stats (list[Stat]) –

  The stats of the light cone.

• rarity (Literal[3, 4, 5]) –

  The rarity of the light cone.

• icon (LightConeIcon) –

  The icon of the light cone.

• path (Path) –

  The light cone's path.

Config:

• arbitrary_types_allowed: True

Fields:

• id (int)
• level (int)
• ascension (Literal[0, 1, 2, 3, 4, 5, 6])
• superimpose (Literal[1, 2, 3, 4, 5])
• name (str)
• stats (list[Stat])
• icon (LightConeIcon)
• rarity (Literal[3, 4, 5])
• path (Path)

Validators:

• _stringify_name → name
• _flatten_flat

ascension pydantic-field

ascension: Literal[0, 1, 2, 3, 4, 5, 6] = 0

icon pydantic-field

icon: LightConeIcon

id pydantic-field

id: int

level pydantic-field

level: int

max_level property

max_level: Literal[20, 30, 40, 50, 60, 70, 80]

Light Cone's max level.

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name pydantic-field

name: str

path pydantic-field

path: Path = NONE

rarity pydantic-field

rarity: Literal[3, 4, 5] = 3

stats pydantic-field

stats: list[Stat]

superimpose pydantic-field

superimpose: Literal[1, 2, 3, 4, 5]

LightConeIcon pydantic-model

Represents a HSR light cone icon.

Attributes:

• light_cone_id (int) –

  The light cone's ID.

Fields:

• light_cone_id (int)

image property

image: str

Light cone icon image.

e.g. https://enka.network/ui/hsr/SpriteOutput/LightConeFigures/20000.png

item property

item: str

Light cone icon item.

Provided by Project Yatta. e.g. https://api.yatta.top/hsr/assets/UI//equipment/medium/20000.png

light_cone_id pydantic-field

light_cone_id: int

Player pydantic-model

Represents a HSR player.

Attributes:

• nickname (str) –

  The player's nickname.

• signature (str) –

  The player's signature.

• uid (int) –

  The player's UID.

• level (int) –

  The player's level.

• equilibrium_level (int) –

  The player's equilibrium level.

• friend_count (int) –

  The number of friends the player has.

• stats (PlayerStats) –

  The player's statistics.

Fields:

• nickname (str)
• signature (str)
• uid (int)
• level (int)
• equilibrium_level (int)
• friend_count (int)
• stats (PlayerStats)
• icon (str)

Validators:

• _stringify_icon → icon

equilibrium_level pydantic-field

equilibrium_level: int = 0

friend_count pydantic-field

friend_count: int = 0

icon pydantic-field

icon: str = ''

level pydantic-field

level: int

nickname pydantic-field

nickname: str

signature pydantic-field

signature: str = ''

stats pydantic-field

stats: PlayerStats

uid pydantic-field

uid: int

PlayerStats pydantic-model

Represents the statistics of a HSR player.

Attributes:

• achievement_count (int) –

  The number of achievements the player has.

• light_cone_count (int) –

  The number of light cones the player has.

• character_count (int) –

  The number of characters the player has.

• max_simulated_universe_world (int | None) –

  The maximum world completed in the simulated universe.

• book_count (int | None) –

  The number of books the player has, added in game version 2.2

• relic_count (int | None) –

  The number of relics the player has, added in game version 2.2

• music_count (int | None) –

  The number of music tracks the player has, added in game version 2.2

Fields:

• achievement_count (int)
• light_cone_count (int)
• character_count (int)
• max_simulated_universe_world (int | None)
• book_count (int | None)
• relic_count (int | None)
• music_count (int | None)

achievement_count pydantic-field

achievement_count: int = 0

book_count pydantic-field

book_count: int | None = None

character_count pydantic-field

character_count: int

light_cone_count pydantic-field

light_cone_count: int = 0

max_simulated_universe_world pydantic-field

max_simulated_universe_world: int | None = None

music_count pydantic-field

music_count: int | None = None

relic_count pydantic-field

relic_count: int | None = None

Relic pydantic-model

Represents a relic in HSR.

Attributes:

• id (int) –

  The relic's ID.

• level (int) –

  The relic's level.

• type (RelicType) –

  The relic's type.

• main_affix_id (int) –

  The ID of the main affix.

• set_name (str) –

  The name of the relic set.

• set_id (int) –

  The ID of the relic set.

• stats (list[Stat]) –

  The stats of the relic.

• sub_affix_list (list[RelicSubAffix]) –

  List of sub-stat information for the relic.

• icon (str) –

  The icon of the relic.

• rarity (Literal[3, 4, 5]) –

  The rarity of the relic.

Fields:

• id (int)
• level (int)
• type (RelicType)
• main_affix_id (int)
• stats (list[Stat])
• sub_affix_list (list[RelicSubAffix])
• icon (str)
• rarity (Literal[3, 4, 5])
• set_id (int)
• set_name (str)

Validators:

• _stringify_set_name → set_name
• _extract_props

icon pydantic-field

icon: str = ''

id pydantic-field

id: int

level pydantic-field

level: int = 0

main_affix_id pydantic-field

main_affix_id: int

main_stat property

main_stat: Stat

The relic's main stat.

rarity pydantic-field

rarity: Literal[3, 4, 5] = 3

set_id pydantic-field

set_id: int = 0

set_name pydantic-field

set_name: str = ''

stats pydantic-field

stats: list[Stat]

sub_affix_list pydantic-field

sub_affix_list: list[RelicSubAffix]

sub_stats property

sub_stats: list[Stat]

The relic's sub-stats.

type pydantic-field

type: RelicType

RelicSubAffix pydantic-model

Represents a relic's sub-stat information.

Attributes:

• id (int) –

  The ID of the sub-stat.

• cnt (int) –

  The count of the sub-stat.

• step (int | None) –

  The step of the sub-stat.

Fields:

• id (int)
• cnt (int)
• step (int | None)

cnt pydantic-field

cnt: int

id pydantic-field

id: int

step pydantic-field

step: int | None = None

ShowcaseResponse pydantic-model

Represents a HSR showcase response.

Attributes:

• characters (list[Character]) –

  The characters in the showcase.

• player (Player) –

  The player.

• ttl (int) –

  The time to live of the response.

• uid (str) –

  The UID of the showcase.

• owner (Owner | None) –

  The owner of the showcase's account, if any.

Fields:

• characters (list[Character])
• player (Player)
• ttl (int)
• uid (str)
• owner (Owner | None)

Validators:

• _flatten_data

characters pydantic-field

characters: list[Character]

owner pydantic-field

owner: Owner | None = None

player pydantic-field

player: Player

ttl pydantic-field

ttl: int = 0

uid pydantic-field

uid: str

Stat pydantic-model

Represents a HSR stat.

Attributes:

• type (StatType) –

  The type of the stat.

• value (float) –

  The value of the stat.

• name (str) –

  The name of the stat.

• icon (str) –

  The icon of the stat.

Fields:

• type (StatType)
• value (float)
• name (str)
• icon (str)

formatted_value property

formatted_value: str

The formatted value of the stat.

icon pydantic-field

icon: str = ''

is_percentage property

is_percentage: bool

Whether the stat is a percentage stat.

name pydantic-field

name: str = ''

type pydantic-field

type: StatType

value pydantic-field

value: float

Trace pydantic-model

Represents a character's trace (skill).

Attributes:

• id (int) –

  The trace's ID.

• level (int) –

  The trace's level.

• boosted (bool) –

  Whether the trace's level is boosted by an activated eidolon's effect.

• icon (str) –

  The trace's icon.

• max_level (int) –

  The trace's maximum level.

• anchor (str) –

  The trace's anchor.

• type (TraceType) –

  The trace's type.

Fields:

• id (int)
• level (int)
• boosted (bool)
• icon (str)
• max_level (int)
• anchor (str)
• type (TraceType)

anchor pydantic-field

anchor: str = ''

boosted pydantic-field

boosted: bool = False

Whether the level of this trace is boosted by an activated eidolon's effect.

icon pydantic-field

icon: str = ''

id pydantic-field

id: int

level pydantic-field

level: int

max_level pydantic-field

max_level: int = 0

type pydantic-field

type: TraceType = UNKNOWN