API Reference

hsr

Modules:

• character –
• endgame –
• enemy_groups –
• light_cone –
• monster –
• new –
• relic –

Classes:

• ApocBuff –

  Represents the fixed global buff in Apocalyptic Shadow.

• ApocDetail –

  Apocalyptic Shadow event details.

• Character –

  Represent an HSR character.

• CharacterDetail –

  Represent an HSR character detail.

• ChildMonster –

  Represent the specific details of a monster type.

• DamageTypeResistance –

  Represent the damage resistance of an enemy in HSR.

• Eidolon –

  Represent a character's eidolon.

• EliteGroup –

  Represent an EliteGroup in HSR.

• EndgameBaseModel –

  Abstract base class for all HSR endgame modes.

• EndgameBuffOptions –

  Represents a selectable buff modifier in endgame.

• EndgameHalf –

  Represents one half of an endgame stage (first or second).

• EndgameStage –

  Represents a stage in an endgame mode.

• EndgameSummary –

  Summary metadata for an HSR endgame event.

• EndgameWave –

  Represents a wave of enemies in an endgame half.

• FullApocDetail –

  Apocalyptic Shadow event details with processed enemies.

• FullEndgameBaseModel –

  Endgame base model with processed enemies.

• FullEndgameHalf –

  Represents one half of an endgame stage (first or second) with processed enemies.

• FullEndgameStage –

  Represents a stage in an endgame mode with processed enemies.

• FullEndgameWave –

  Represents a wave of processed enemies in an endgame half.

• FullMOCDetail –

  Memory of Chaos event details with processed enemies.

• FullPFDetail –

  Pure Fiction event details with processed enemies.

• HSREnemySkill –

  Represents an enemy skill's information.

• HardLevelGroup –

  Represent a HardLevelGroup in HSR.

• LightCone –

  Represent an HSR light cone.

• LightConeDetail –

  Represent an HSR light cone detail.

• MOCDetail –

  Memory of Chaos event details.

• Monster –

  Represent an enemy monster in HSR.

• MonsterDetail –

  Represent an enemy monster with details in HSR.

• New –

  Represent new Honkai Star Rail data.

• PFDetail –

  Pure Fiction event details.

• ProcessedEnemy –

  Represents a processed enemy instance in a HSR endgame stage.

• Relic –

  Represent an HSR relic.

• RelicSet –

  Represent an HSR relic set.

• RelicSetDetail –

  Represent an HSR relic set detail.

• RelicSetEffect –

  Represent a relic set effect.

• RelicSetEffects –

  Represent a relic set's set effects.

• SetDetailSetEffect –

  Represent a relic set detail's set effect.

• SetDetailSetEffects –

  Represent relic set detail's set effects.

• Skill –

  Represent a character's skill.

• SkillLevelInfo –

  Represent a skill's level information.

• SuperimposeInfo –

  Represent a light cone's superimpose information.

ApocBuff pydantic-model

Represents the fixed global buff in Apocalyptic Shadow.

Attributes:

• name (str) –

  Name of the buff.

• desc (str) –

  Description of the effect.

Fields:

• name (str)
• desc (str)

Validators:

• __format_fields
• __handle_missing_fields → name, desc

desc pydantic-field

desc: str = ''

name pydantic-field

name: str = ''

ApocDetail pydantic-model

Apocalyptic Shadow event details.

Attributes:

• buff (ApocBuff) –

  The static global buff applied in all stages.

• buff_list_1 (list[EndgameBuffOptions]) –

  Selectable buffs for first half.

• buff_list_2 (list[EndgameBuffOptions]) –

  Selectable buffs for second half.

Fields:

• buff (ApocBuff)
• buff_list_1 (list[EndgameBuffOptions])
• buff_list_2 (list[EndgameBuffOptions])
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[EndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

Character pydantic-model

Represent an HSR character.

Attributes:

• id (int) –

  The ID of the character.

• icon (str) –

  The icon URL of the character.

• rarity (Literal[4, 5]) –

  The rarity of the character.

• description (str) –

  The description of the character.

• path (HSRPath) –

  The path of the character.

• element (HSRElement) –

  The element of the character.

• names (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  A dictionary of names in different languages.

• name (str) –

  The name of the character.

Fields:

• id (int)
• icon (str)
• rarity (Literal[4, 5])
• description (str)
• path (HSRPath)
• element (HSRElement)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• name (str)

Validators:

• __format_fields
• __convert_icon → icon
• __convert_rarity → rarity
• __convert_description → description
• __transform_names

description pydantic-field

description: str

element pydantic-field

element: HSRElement

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'zh', 'ko', 'ja'], str]

path pydantic-field

path: HSRPath

rarity pydantic-field

rarity: Literal[4, 5]

CharacterDetail pydantic-model

Represent an HSR character detail.

Attributes:

• id (int) –

  The ID of the character.

• name (str) –

  The name of the character.

• description (str) –

  The description of the character.

• rarity (Literal[4, 5]) –

  The rarity of the character.

• eidolons (dict[str, Eidolon]) –

  A dictionary of eidolons for the character.

• skills (dict[str, Skill]) –

  A dictionary of skills for the character.

• ascension_stats (dict[str, dict[str, Any]]) –

  A dictionary of ascension stats for the character.

Fields:

• id (int)
• name (str)
• description (str)
• rarity (Literal[4, 5])
• eidolons (dict[str, Eidolon])
• skills (dict[str, Skill])
• ascension_stats (dict[str, dict[str, Any]])

Validators:

• __format_fields
• __convert_rarity → rarity
• __convert_description → description
• __remove_invalid_skills → skills
• __extract_id

ascension_stats pydantic-field

ascension_stats: dict[str, dict[str, Any]]

description pydantic-field

description: str

eidolons pydantic-field

eidolons: dict[str, Eidolon]

gacha_art property

gacha_art: str

Get the character's gacha art URL.

icon property

icon: str

Get the character's icon URL.

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: Literal[4, 5]

skills pydantic-field

skills: dict[str, Skill]

ChildMonster pydantic-model

Represent the specific details of a monster type.

Attributes:

• id (int) –

  The ID of this instance of the monster.

• attack_modify_ratio (float) –

  Multiplier applied to the monster's base attack.

• defence_modify_ratio (float) –

  Multiplier applied to the monster's base defense.

• hp_modify_ratio (float) –

  Multiplier applied to the monster's base HP.

• spd_modify_ratio (float) –

  Multiplier applied to the monster's base speed.

• spd_modify_value (float | None) –

  An optional fixed value added to the monster's speed (can override base speed).

• stance_modify_value (float) –

  Multiplier applied to the monster's base toughness.

• stance_weak_list (list[HSRElement]) –

  List of elemental types that this monster is weak to (for toughness damage).

• damage_type_resistances (list[DamageTypeResistance]) –

  List of resistances the monster has against specific elements.

• skills (list[HSREnemySkill]) –

  List of skills this monster instance can use in combat.

Fields:

• id (int)
• attack_modify_ratio (float)
• defence_modify_ratio (float)
• hp_modify_ratio (float)
• spd_modify_ratio (float)
• spd_modify_value (float | None)
• stance_modify_value (float)
• stance_weak_list (list[HSRElement])
• damage_type_resistances (list[DamageTypeResistance])
• skills (list[HSREnemySkill])

Validators:

• __format_fields

attack_modify_ratio pydantic-field

attack_modify_ratio: float = 1

damage_type_resistances pydantic-field

damage_type_resistances: list[DamageTypeResistance]

defence_modify_ratio pydantic-field

defence_modify_ratio: float = 1

hp_modify_ratio pydantic-field

hp_modify_ratio: float = 1

id pydantic-field

id: int

skills pydantic-field

skills: list[HSREnemySkill]

spd_modify_ratio pydantic-field

spd_modify_ratio: float = 1

spd_modify_value pydantic-field

spd_modify_value: float | None = None

stance_modify_value pydantic-field

stance_modify_value: float = 1

stance_weak_list pydantic-field

stance_weak_list: list[HSRElement]

DamageTypeResistance pydantic-model

Represent the damage resistance of an enemy in HSR.

Attributes:

• element (HSRElement) –

  The element of the resistance.

• value (float) –

  The value of the resistance.

Fields:

• element (HSRElement)
• value (float)

Validators:

• __format_fields

element pydantic-field

element: HSRElement

value pydantic-field

value: float

Eidolon pydantic-model

Represent a character's eidolon.

Attributes:

• id (int) –

  The ID of the eidolon.

• name (str) –

  The name of the eidolon.

• description (str) –

  The description of the eidolon.

• parameters (list[float]) –

  A list of parameters for the eidolon.

Fields:

• id (int)
• name (str)
• description (str)
• parameters (list[float])

Validators:

• __format_fields

description pydantic-field

description: str

id pydantic-field

id: int

image property

image: str

Get the eidolon's image URL.

name pydantic-field

name: str

parameters pydantic-field

parameters: list[float]

EliteGroup pydantic-model

Represent an EliteGroup in HSR.

All enemies in HSR follow the following formula for ATK, DEF, HP, and SPD: Base x BaseModifyRatio x EliteGroup Ratio x HardLevelGroup(Level) Ratio x (1 + HPMultiplier)

Attributes:

• id (int) –

  The ID of the group.

• attack_ratio (float) –

  The ratio to multiply to get final attack.

• defence_ratio (float) –

  The ratio to multiply to get final defence.

• hp_ratio (float) –

  The ratio to multiply to get final HP.

• spd_ratio (float) –

  The ratio to multiply to get final speed.

Fields:

• id (int)
• attack_ratio (float)
• defence_ratio (float)
• hp_ratio (float)
• spd_ratio (float)
• stance_ratio (float)

Validators:

• __format_fields
• handle_missing_fields → attack_ratio, defence_ratio, hp_ratio, spd_ratio, stance_ratio

attack_ratio pydantic-field

attack_ratio: float = 0

defence_ratio pydantic-field

defence_ratio: float = 0

hp_ratio pydantic-field

hp_ratio: float = 0

id pydantic-field

id: int

spd_ratio pydantic-field

spd_ratio: float = 0

stance_ratio pydantic-field

stance_ratio: float = 0

handle_missing_fields pydantic-validator

handle_missing_fields(value: Any) -> float

EndgameBaseModel pydantic-model

Abstract base class for all HSR endgame modes.

Attributes:

• id (int) –

  Unique ID of the endgame event.

• name (str) –

  Display name of the event.

• begin_time (str) –

  Event start timestamp.

• end_time (str) –

  Event end timestamp.

• stages (list[EndgameStage]) –

  List of stages in this endgame mode.

Fields:

• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[EndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

begin_time pydantic-field

begin_time: str = ''

end_time pydantic-field

end_time: str = ''

id pydantic-field

id: int

name pydantic-field

name: str = ''

stages pydantic-field

stages: list[EndgameStage]

EndgameBuffOptions pydantic-model

Represents a selectable buff modifier in endgame.

Attributes:

• name (str) –

  Name of the buff.

• desc (str) –

  Description of the buff effect.

• params (list[float]) –

  List of parameters applied by the buff.

Fields:

• name (str)
• desc (str)
• params (list[float])

Validators:

• __format_fields

desc pydantic-field

desc: str

name pydantic-field

name: str

params pydantic-field

params: list[float]

EndgameHalf pydantic-model

Represents one half of an endgame stage (first or second).

Attributes:

• hlg_id (int) –

  ID of the HardLevelGroup used to determine difficulty scaling.

• hlg_level (int) –

  Level of the HardLevelGroup (affects enemy stats).

• eg_id (int) –

  ID of the EliteGroup (affects enemy traits).

• waves (list[EndgameWave]) –

  List of enemy waves in this half.

Fields:

• hlg_id (int)
• hlg_level (int)
• eg_id (int)
• waves (list[EndgameWave])

Validators:

• __format_fields

eg_id pydantic-field

eg_id: int = 1

hlg_id pydantic-field

hlg_id: int = 1

hlg_level pydantic-field

hlg_level: int = 1

waves pydantic-field

waves: list[EndgameWave]

EndgameStage pydantic-model

Represents a stage in an endgame mode.

Attributes:

• id (int) –

  Unique ID of the stage.

• name (str) –

  Stage name.

• first_half_weaknesses (list[HSRElement]) –

  Elements that enemies in the first half are weak to.

• second_half_weaknesses (list[HSRElement]) –

  Elements that enemies in the second half are weak to.

• first_half (EndgameHalf) –

  The first half of the stage.

• second_half (EndgameHalf | None) –

  The second half of the stage.

Fields:

• id (int)
• name (str)
• first_half_weaknesses (list[HSRElement])
• second_half_weaknesses (list[HSRElement])
• first_half (EndgameHalf)
• second_half (EndgameHalf | None)

Validators:

• __format_fields
• __handle_missing_name → name
• __unwrap_event_lists

first_half pydantic-field

first_half: EndgameHalf

first_half_weaknesses pydantic-field

first_half_weaknesses: list[HSRElement]

id pydantic-field

id: int

name pydantic-field

name: str

second_half pydantic-field

second_half: EndgameHalf | None

second_half_weaknesses pydantic-field

second_half_weaknesses: list[HSRElement]

EndgameSummary pydantic-model

Summary metadata for an HSR endgame event.

Attributes:

• id (int) –

  ID of the endgame.

• type (HSREndgameType) –

  The type/category of the endgame.

• names (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  Dictionary containing localized names in English (en), Chinese (cn), Korean (kr), and Japanese (jp).

• name (str) –

  The selected name to display (populated during post-processing).

• begin (str) –

  Event start timestamp.

• end (str) –

  Event end timestamp.

Fields:

• id (int)
• type (HSREndgameType)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• name (str)
• begin (str)
• end (str)

Validators:

• __format_fields
• __transform_names

begin pydantic-field

begin: str = ''

end pydantic-field

end: str = ''

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'zh', 'ko', 'ja'], str]

type pydantic-field

type: HSREndgameType

EndgameWave pydantic-model

Represents a wave of enemies in an endgame half.

Attributes:

• enemies (list[int]) –

  A list of enemy IDs.

• hp_multiplier (float) –

  Multiplier applied to enemy HP in this wave.

Fields:

• enemies (list[int])
• hp_multiplier (float)

Validators:

• __format_fields
• __handle_missing_hp → hp_multiplier
• __extract_monster_ids

enemies pydantic-field

enemies: list[int]

hp_multiplier pydantic-field

hp_multiplier: float = 0

FullApocDetail pydantic-model

Apocalyptic Shadow event details with processed enemies.

Attributes:

• buff (ApocBuff) –

  The static global buff applied in all stages.

• buff_list_1 (list[EndgameBuffOptions]) –

  Selectable buffs for first half.

• buff_list_2 (list[EndgameBuffOptions]) –

  Selectable buffs for second half.

Fields:

• buff (ApocBuff)
• buff_list_1 (list[EndgameBuffOptions])
• buff_list_2 (list[EndgameBuffOptions])
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[FullEndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

FullEndgameBaseModel pydantic-model

Endgame base model with processed enemies.

Attributes:

• id (int) –

  Unique ID of the endgame event.

• name (str) –

  Display name of the event.

• begin_time (str) –

  Event start timestamp.

• end_time (str) –

  Event end timestamp.

• stages (list[FullEndgameStage]) –

  List of stages in this endgame mode with processed enemies.

Fields:

• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[FullEndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

stages pydantic-field

stages: list[FullEndgameStage]

FullEndgameHalf pydantic-model

Represents one half of an endgame stage (first or second) with processed enemies.

Attributes:

• hlg_id (int) –

  ID of the HardLevelGroup used to determine difficulty scaling.

• hlg_level (int) –

  Level of the HardLevelGroup (affects enemy stats).

• eg_id (int) –

  ID of the EliteGroup (affects enemy traits).

• waves (list[FullEndgameWave]) –

  List of enemy waves in this half with processed enemies.

Fields:

• hlg_id (int)
• hlg_level (int)
• eg_id (int)
• waves (list[FullEndgameWave])

Validators:

• __format_fields

waves pydantic-field

waves: list[FullEndgameWave]

FullEndgameStage pydantic-model

Represents a stage in an endgame mode with processed enemies.

Attributes:

• first_half (FullEndgameHalf) –

  The first half of the stage with processed enemies.

• second_half (FullEndgameHalf | None) –

  The second half of the stage with processed enemies.

Fields:

• id (int)
• name (str)
• first_half_weaknesses (list[HSRElement])
• second_half_weaknesses (list[HSRElement])
• first_half (FullEndgameHalf)
• second_half (FullEndgameHalf | None)

Validators:

• __format_fields
• __handle_missing_name → name
• __unwrap_event_lists

first_half pydantic-field

first_half: FullEndgameHalf

second_half pydantic-field

second_half: FullEndgameHalf | None

FullEndgameWave pydantic-model

Represents a wave of processed enemies in an endgame half.

Attributes:

• enemies (list[ProcessedEnemy]) –

  A list of processed enemy instances.

• hp_multiplier (float) –

  Multiplier applied to enemy HP in this wave.

Fields:

• hp_multiplier (float)
• enemies (list[ProcessedEnemy])

Validators:

• __format_fields
• __handle_missing_hp → hp_multiplier
• __extract_monster_ids

enemies pydantic-field

enemies: list[ProcessedEnemy]

FullMOCDetail pydantic-model

Memory of Chaos event details with processed enemies.

Attributes:

• memory_turbulence (str) –

  Global modifier for the current MoC rotation.

Fields:

• memory_turbulence (str)
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[FullEndgameStage])

Validators:

• __format_fields
• __transform_data
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

FullPFDetail pydantic-model

Pure Fiction event details with processed enemies.

Attributes:

• buff_options (list[EndgameBuffOptions]) –

  First tier of optional buffs.

• buff_suboptions (list[EndgameBuffOptions]) –

  Second tier of optional buffs.

Fields:

• buff_options (list[EndgameBuffOptions])
• buff_suboptions (list[EndgameBuffOptions])
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[FullEndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages
• __transform_level_data

HSREnemySkill pydantic-model

Represents an enemy skill's information.

Attributes:

• id (int) –

  The id of the skill.

• name (str) –

  The name of the skill

• desc (str) –

  The description of what the skill does

• damage_type (HSRElement | None) –

  The type of damage the skill does (out of the HSRElements or None)

Fields:

• id (int)
• name (str)
• desc (str)
• damage_type (HSRElement | None)

Validators:

• __format_fields
• default_empty_string → name, desc
• empty_string_to_none → damage_type

damage_type pydantic-field

damage_type: HSRElement | None = None

desc pydantic-field

desc: str = ''

id pydantic-field

id: int

name pydantic-field

name: str = ''

default_empty_string pydantic-validator

default_empty_string(value: str | None) -> str

empty_string_to_none pydantic-validator

empty_string_to_none(v: str | None) -> str | None

HardLevelGroup pydantic-model

Represent a HardLevelGroup in HSR.

All enemies in HSR follow the following formula for ATK, DEF, HP, and SPD: Base x BaseModifyRatio x EliteGroup Ratio x HardLevelGroup(Level) Ratio x (1 + HPMultiplier)

Attributes:

• id (int) –

  The ID of the group.

• level (int) –

  The level of the enemy.

• attack_ratio (float) –

  The ratio to multiply to get final attack.

• defence_ratio (float) –

  The ratio to multiply to get final defence.

• hp_ratio (float) –

  The ratio to multiply to get final HP.

• spd_ratio (float) –

  The ratio to multiply to get final speed.

Fields:

• id (int)
• level (int)
• attack_ratio (float)
• defence_ratio (float)
• hp_ratio (float)
• spd_ratio (float)
• stance_ratio (float)
• status_resistance (float)

Validators:

• __format_fields
• handle_missing_fields → attack_ratio, defence_ratio, hp_ratio, spd_ratio, stance_ratio, status_resistance

attack_ratio pydantic-field

attack_ratio: float = 0

defence_ratio pydantic-field

defence_ratio: float = 0

hp_ratio pydantic-field

hp_ratio: float = 0

id pydantic-field

id: int

level pydantic-field

level: int

spd_ratio pydantic-field

spd_ratio: float = 0

stance_ratio pydantic-field

stance_ratio: float = 0

status_resistance pydantic-field

status_resistance: float = 0

handle_missing_fields pydantic-validator

handle_missing_fields(value: Any) -> float

LightCone pydantic-model

Represent an HSR light cone.

Attributes:

• id (int) –

  The ID of the light cone.

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

  The rarity of the light cone.

• description (str) –

  The description of the light cone.

• path (HSRPath) –

  The path of the light cone.

• names (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  A dictionary of names in different languages.

• name (str) –

  The name of the light cone.

Fields:

• id (int)
• rarity (Literal[3, 4, 5])
• description (str)
• path (HSRPath)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• name (str)

Validators:

• __format_fields
• __handle_null_value → description
• __convert_icon → icon
• __convert_rarity → rarity
• __transform_names

description pydantic-field

description: str

icon property

icon: str

Get the light cone's icon URL.

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'zh', 'ko', 'ja'], str]

path pydantic-field

path: HSRPath

rarity pydantic-field

rarity: Literal[3, 4, 5]

LightConeDetail pydantic-model

Represent an HSR light cone detail.

Attributes:

• id (int) –

  The ID of the light cone.

• name (str) –

  The name of the light cone.

• description (str | None) –

  The description of the light cone.

• path (HSRPath) –

  The path of the light cone.

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

  The rarity of the light cone.

• superimpose_info (SuperimposeInfo) –

  Superimpose information for the light cone.

• ascension_stats (list[dict[str, Any]]) –

  A list of ascension stats for the light cone.

Fields:

• id (int)
• name (str)
• description (str | None)
• path (HSRPath)
• rarity (Literal[3, 4, 5])
• superimpose_info (SuperimposeInfo)
• ascension_stats (list[dict[str, Any]])

Validators:

• __format_fields
• __convert_rarity → rarity
• __extract_id

ascension_stats pydantic-field

ascension_stats: list[dict[str, Any]]

description pydantic-field

description: str | None = None

icon property

icon: str

Get the light cone's icon URL.

id pydantic-field

id: int

image property

image: str

Get the light cone's image URL.

name pydantic-field

name: str

path pydantic-field

path: HSRPath

rarity pydantic-field

rarity: Literal[3, 4, 5]

superimpose_info pydantic-field

superimpose_info: SuperimposeInfo

MOCDetail pydantic-model

Memory of Chaos event details.

Attributes:

• memory_turbulence (str) –

  Global modifier for the current MoC rotation.

Fields:

• memory_turbulence (str)
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[EndgameStage])

Validators:

• __format_fields
• __transform_data
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

Monster pydantic-model

Represent an enemy monster in HSR.

Attributes:

• id (int) –

  The ID of the monster.

• icon (str) –

  The icon URL of the monster.

• children (list[int]) –

  A list of child monster IDs associated with this monster.

• weaknesses (list[HSRElement]) –

  List of elements that this monster is weak to (used for breaking toughness).

• names (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  A dictionary of names in different languages.

• description (str) –

  The English description of the monster.

• name (str) –

  The English name of the monster.

Fields:

• id (int)
• icon (str)
• children (list[int])
• weaknesses (list[HSRElement])
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• description (str)
• name (str)

Validators:

• __format_fields
• default_empty_string_listing → description
• __convert_icon → icon
• __transform_names

children pydantic-field

children: list[int]

description pydantic-field

description: str = ''

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'zh', 'ko', 'ja'], str]

weaknesses pydantic-field

weaknesses: list[HSRElement]

default_empty_string_listing pydantic-validator

default_empty_string_listing(value: str | None) -> str

MonsterDetail pydantic-model

Represent an enemy monster with details in HSR.

Attributes:

• id (int) –

  Unique identifier for the monster.

• name (str) –

  Name of the monster.

• description (str) –

  The description of the monster.

• attack_base (float) –

  The base attack stat for this monster.

• defence_base (float) –

  The base defense stat.

• hp_base (float) –

  The base HP value.

• spd_base (float) –

  The base speed stat.

• stance_base (float) –

  The base toughness value.

• status_resistance_base (float) –

  The base status resistance (used for debuff resist chance).

• monster_types (list[ChildMonster]) –

  A list of ChildMonster variants derived from this monster.

Fields:

• id (int)
• rank (str)
• name (str)
• description (str)
• attack_base (float)
• defence_base (float)
• hp_base (float)
• spd_base (float)
• stance_base (float)
• status_resistance_base (float)
• monster_types (list[ChildMonster])

Validators:

• __format_fields
• default_zero_if_none → attack_base, defence_base, hp_base, spd_base, stance_base, status_resistance_base
• default_empty_string → description

attack_base pydantic-field

attack_base: float = 0

defence_base pydantic-field

defence_base: float = 0

description pydantic-field

description: str = ''

hp_base pydantic-field

hp_base: float = 0

icon property

icon: str

Get the monster's icon URL.

id pydantic-field

id: int

monster_types pydantic-field

monster_types: list[ChildMonster]

name pydantic-field

name: str = ''

rank pydantic-field

rank: str

spd_base pydantic-field

spd_base: float = 0

stance_base pydantic-field

stance_base: float = 0

status_resistance_base pydantic-field

status_resistance_base: float = 0

default_empty_string pydantic-validator

default_empty_string(value: str | None) -> str

default_zero_if_none pydantic-validator

default_zero_if_none(
    value: int | float | None,
) -> int | float

New pydantic-model

Represent new Honkai Star Rail data.

Attributes:

• character_ids (list[int]) –

  A list of character IDs.

• light_cone_ids (list[int]) –

  A list of light cone IDs.

• relic_set_ids (list[int]) –

  A list of relic set IDs.

• monster_ids (list[int]) –

  A list of monster IDs.

• item_ids (list[int]) –

  A list of item IDs.

• version (str) –

  The current version.

Fields:

• character_ids (list[int])
• light_cone_ids (list[int])
• relic_set_ids (list[int])
• monster_ids (list[int])
• item_ids (list[int])
• version (str)

Validators:

• __format_fields

character_ids pydantic-field

character_ids: list[int]

item_ids pydantic-field

item_ids: list[int]

light_cone_ids pydantic-field

light_cone_ids: list[int]

monster_ids pydantic-field

monster_ids: list[int]

relic_set_ids pydantic-field

relic_set_ids: list[int]

version pydantic-field

version: str

PFDetail pydantic-model

Pure Fiction event details.

Attributes:

• buff_options (list[EndgameBuffOptions]) –

  First tier of optional buffs.

• buff_suboptions (list[EndgameBuffOptions]) –

  Second tier of optional buffs.

Fields:

• buff_options (list[EndgameBuffOptions])
• buff_suboptions (list[EndgameBuffOptions])
• id (int)
• name (str)
• begin_time (str)
• end_time (str)
• stages (list[EndgameStage])

Validators:

• __format_fields
• __handle_missing_fields → name, begin_time, end_time
• __handle_invalid_stages → stages

ProcessedEnemy pydantic-model

Represents a processed enemy instance in a HSR endgame stage.

Attributes:

• id (int) –

  The unique monster ID.

• name (str) –

  The name of the enemy.

• weaknesses (list[HSRElement]) –

  A list of elements this enemy is weak to.

• level (int) –

  The level of the enemy.

• base_hp (int) –

  The calculated HP of the enemy after all multipliers.

• speed (int | None) –

  The calculated speed value.

• toughness (int | None) –

  The calculated toughness value.

• effect_res (float | None) –

  Total status effect resistance value.

Fields:

• id (int)
• name (str)
• weaknesses (list[HSRElement])
• level (int)
• base_hp (int)
• speed (int | None)
• toughness (int | None)
• effect_res (float | None)

Validators:

• __format_fields

base_hp pydantic-field

base_hp: int

effect_res pydantic-field

effect_res: float | None

id pydantic-field

id: int

level pydantic-field

level: int

name pydantic-field

name: str = ''

speed pydantic-field

speed: int | None

toughness pydantic-field

toughness: int | None

weaknesses pydantic-field

weaknesses: list[HSRElement]

Relic pydantic-model

Represent an HSR relic.

Attributes:

• id (int) –

  The ID of the relic.

• name (str) –

  The name of the relic.

• description (str | None) –

  The description of the relic.

• story (str | None) –

  The story of the relic.

Fields:

• id (int)
• name (str)
• description (str | None)
• story (str | None)

Validators:

• __format_fields

description pydantic-field

description: str | None = None

icon property

icon: str

Get the relic's icon URL.

id pydantic-field

id: int = 0

name pydantic-field

name: str

story pydantic-field

story: str | None = None

RelicSet pydantic-model

Represent an HSR relic set.

Attributes:

• id (int) –

  The ID of the relic set.

• icon (str) –

  The icon URL of the relic set.

• names (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  A dictionary of names in different languages.

• name (str) –

  The name of the relic set.

• set_effect (RelicSetEffects) –

  The set effects of the relic set.

Fields:

• id (int)
• icon (str)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• name (str)
• set_effect (RelicSetEffects)

Validators:

• __format_fields
• __convert_icon → icon
• __assign_set_effect → set_effect
• __assign_names

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'zh', 'ko', 'ja'], str]

set_effect pydantic-field

set_effect: RelicSetEffects

RelicSetDetail pydantic-model

Represent an HSR relic set detail.

Attributes:

• name (str) –

  The name of the relic set.

• icon (str) –

  The icon URL of the relic set.

• parts (dict[str, Relic]) –

  A dictionary of relic parts.

• set_effects (SetDetailSetEffects) –

  The set effects of the relic set.

Fields:

• name (str)
• icon (str)
• parts (dict[str, Relic])
• set_effects (SetDetailSetEffects)

Validators:

• __format_fields
• __convert_icon → icon
• __assign_set_effects → set_effects
• __convert_parts → parts

icon pydantic-field

icon: str

name pydantic-field

name: str

parts pydantic-field

parts: dict[str, Relic]

set_effects pydantic-field

set_effects: SetDetailSetEffects

RelicSetEffect pydantic-model

Represent a relic set effect.

Attributes:

• descriptions (dict[Literal['en', 'zh', 'ko', 'ja'], str]) –

  A dictionary of descriptions in different languages.

• description (str) –

  The description of the relic set effect.

• parameters (list[float]) –

  A list of parameters for the relic set effect.

Fields:

• descriptions (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• description (str)
• parameters (list[float])

Validators:

• __format_fields
• __assign_descriptions

description pydantic-field

description: str = ''

descriptions pydantic-field

descriptions: dict[Literal['en', 'zh', 'ko', 'ja'], str]

parameters pydantic-field

parameters: list[float]

RelicSetEffects pydantic-model

Represent a relic set's set effects.

Attributes:

• two_piece (RelicSetEffect) –

  The two-piece set effect.

• four_piece (RelicSetEffect | None) –

  The four-piece set effect, if available.

Fields:

• two_piece (RelicSetEffect)
• four_piece (RelicSetEffect | None)

Validators:

• __format_fields

four_piece pydantic-field

four_piece: RelicSetEffect | None = None

two_piece pydantic-field

two_piece: RelicSetEffect

SetDetailSetEffect pydantic-model

Represent a relic set detail's set effect.

Attributes:

• description (str) –

  The description of the set effect.

• parameters (list[float]) –

  A list of parameters for the set effect.

Fields:

• description (str)
• parameters (list[float])

Validators:

• __format_fields
• __format_parameters

description pydantic-field

description: str

parameters pydantic-field

parameters: list[float]

SetDetailSetEffects pydantic-model

Represent relic set detail's set effects.

Attributes:

• two_piece (SetDetailSetEffect) –

  The two-piece set effect.

• four_piece (SetDetailSetEffect | None) –

  The four-piece set effect, if available.

Fields:

• two_piece (SetDetailSetEffect)
• four_piece (SetDetailSetEffect | None)

Validators:

• __format_fields

four_piece pydantic-field

four_piece: SetDetailSetEffect | None = None

two_piece pydantic-field

two_piece: SetDetailSetEffect

Skill pydantic-model

Represent a character's skill.

Attributes:

• name (str) –

  The name of the skill.

• description (str | None) –

  The description of the skill, if available.

• type (str | None) –

  The type of the skill, if available.

• tag (str) –

  The tag of the skill.

• energy_generation (int | None) –

  The energy generation of the skill, if available.

• level_info (dict[str, SkillLevelInfo]) –

  A dictionary of skill level information.

Fields:

• name (str)
• description (str | None)
• type (str | None)
• tag (str)
• energy_generation (int | None)
• level_info (dict[str, SkillLevelInfo])

Validators:

• __format_fields

description pydantic-field

description: str | None = None

energy_generation pydantic-field

energy_generation: int | None = None

level_info pydantic-field

level_info: dict[str, SkillLevelInfo]

max_level property

max_level: int

Get the skill's maximum level.

name pydantic-field

name: str

tag pydantic-field

tag: str

type pydantic-field

type: str | None = None

SkillLevelInfo pydantic-model

Represent a skill's level information.

Attributes:

• level (int) –

  The level of the skill.

• parameters (list[float]) –

  A list of parameters for the skill level.

Fields:

• level (int)
• parameters (list[float])

Validators:

• __format_fields

level pydantic-field

level: int

parameters pydantic-field

parameters: list[float]

SuperimposeInfo pydantic-model

Represent a light cone's superimpose information.

Attributes:

• name (str) –

  The name of the superimpose information.

• description (str) –

  The description of the superimpose information.

• parameters (dict[str, list[float]]) –

  A dictionary of parameters for the superimpose information.

Fields:

• name (str)
• description (str)
• parameters (dict[str, list[float]])

Validators:

• __format_fields
• __flatten_parameters

description pydantic-field

description: str

name pydantic-field

name: str

parameters pydantic-field

parameters: dict[str, list[float]]