API Reference

gi

Modules:

• artifact –

  Genshin Impact artifact models.

• character –

  Genshin Impact character models.

• mw –

  Miliastra Wonderland costume and item models.

• new –

  Genshin Impact new data model.

• stygian –

  Genshin Impact Stygian Onslaught models.

• weapon –

  Genshin Impact weapon models.

Classes:

• Artifact –

  Represent a Genshin Impact artifact.

• ArtifactSet –

  Represent a Genshin Impact artifact set.

• ArtifactSetDetail –

  Represent a Genshin Impact artifact set detail.

• ArtifactSetDetailSetEffects –

  Represent set effects of an artifact set detail.

• ArtifactSetEffect –

  Represent an artifact set effect.

• ArtifactSetEffects –

  Represent artifact set effects.

• Character –

  Represent a Genshin Impact character.

• CharacterConstellation –

  Represent a character's constellation.

• CharacterDetail –

  Represent a Genshin Impact character detail.

• CharacterInfo –

  Represent a character's information.

• CharacterPassive –

  Represent a character's passive talent.

• CharacterSkill –

  Represent a character's skill.

• CharacterStatsModifier –

  Represent a character's stat modifiers.

• FightPropGrowthCurve –

  Represent a character's stat growth curve data.

• MWCostume –

  Miliastra Wonderland costume

• MWCostumeSet –

  Miliastra Wonderland costume set

• MWItem –

  Miliastra Wonderland item

• Namecard –

  Represent a character's namecard.

• New –

  Represent new Genshin Impact data.

• SetEffect –

  Represent a set effect.

• SkillUpgradeInfo –

  Represent a character's skill upgrade information.

• Stygian –

  A Stygian Onslaught entry.

• StygianDetail –

  Details of a Stygian Onslaught entry.

• StygianDifficultyConfig –

  Configuration for a Stygian Onslaught difficulty.

• StygianEnemy –

  A Stygian Onslaught enemy.

• StygianEnemyBuff –

  A buff associated with a Stygian Abyss enemy.

• StygianEnemyRecommendation –

  Recommendations for dealing with a Stygian Abyss enemy.

• StygianLevel –

  A Stygian Onslaught level.

• UpgradeMaterial –

  Represent a character's upgrade material.

• UpgradeMaterialInfo –

  Represent character's upgrade material information.

• UpgradeMaterialInfos –

  Represent character's upgrade material information.

• Weapon –

  Represent a Genshin Impact weapon.

• WeaponDetail –

  Represent a Genshin Impact weapon detail.

• WeaponProperty –

  Represent a weapon's property.

• WeaponRefinement –

  Represent a weapon's refinement.

• WeaponStatModifier –

  Represent a weapon's stat modifier.

Artifact pydantic-model

Represent a Genshin Impact artifact.

Attributes:

• icon (str) –

  Icon URL of the artifact.

• name (str) –

  Name of the artifact.

• description (str) –

  Description of the artifact.

Fields:

• icon (str)
• name (str)
• description (str)

Validators:

• __format_fields
• __convert_icon → icon

description pydantic-field

description: str

icon pydantic-field

icon: str

name pydantic-field

name: str

ArtifactSet pydantic-model

Represent a Genshin Impact artifact set.

Attributes:

• id (int) –

  ID of the artifact set.

• icon (str) –

  Icon URL of the artifact set.

• rarities (list[int]) –

  List of rarities for the artifact set.

• set_effect (ArtifactSetEffects) –

  Set effects of the artifact set.

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

  Dictionary of names in different languages.

• name (str) –

  Name of the artifact set.

Fields:

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

Validators:

• __format_fields
• __convert_icon → icon
• __assign_set_effects → set_effect
• __extract_names

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

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

rarities pydantic-field

rarities: list[int]

set_effect pydantic-field

set_effect: ArtifactSetEffects

ArtifactSetDetail pydantic-model

Represent a Genshin Impact artifact set detail.

Attributes:

• id (int) –

  ID of the artifact set.

• icon (str) –

  Icon URL of the artifact set.

• set_effect (ArtifactSetDetailSetEffects) –

  Set effects of the artifact set.

• parts (dict[str, Artifact]) –

  Parts of the artifact set.

Fields:

• id (int)
• icon (str)
• set_effect (ArtifactSetDetailSetEffects)
• parts (dict[str, Artifact])

Validators:

• __format_fields
• __convert_icon → icon
• __assign_set_effect → set_effect

icon pydantic-field

icon: str

id pydantic-field

id: int

parts pydantic-field

parts: dict[str, Artifact]

set_effect pydantic-field

set_effect: ArtifactSetDetailSetEffects

ArtifactSetDetailSetEffects pydantic-model

Represent set effects of an artifact set detail.

Attributes:

• two_piece (SetEffect) –

  Two-piece set effect.

• four_piece (SetEffect | None) –

  Four-piece set effect, if available.

Fields:

• two_piece (SetEffect)
• four_piece (SetEffect | None)

Validators:

• __format_fields

four_piece pydantic-field

four_piece: SetEffect | None = None

two_piece pydantic-field

two_piece: SetEffect

ArtifactSetEffect pydantic-model

Represent an artifact set effect.

Attributes:

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

  Dictionary of names in different languages.

• name (str) –

  Name of the artifact set effect.

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

  Dictionary of descriptions in different languages.

• description (str) –

  Description of the artifact set effect.

Fields:

• names (dict[Literal['en', 'ko', 'zh', 'ja'], str])
• name (str)
• descriptions (dict[Literal['en', 'ko', 'zh', 'ja'], str])
• description (str)

Validators:

• __format_fields
• __transform_names

description pydantic-field

description: str = ''

descriptions pydantic-field

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

name pydantic-field

name: str = ''

names pydantic-field

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

ArtifactSetEffects pydantic-model

Represent artifact set effects.

Attributes:

• two_piece (ArtifactSetEffect) –

  Two-piece set effect.

• four_piece (ArtifactSetEffect | None) –

  Four-piece set effect, if available.

Fields:

• two_piece (ArtifactSetEffect)
• four_piece (ArtifactSetEffect | None)

Validators:

• __format_fields

four_piece pydantic-field

four_piece: ArtifactSetEffect | None = None

two_piece pydantic-field

two_piece: ArtifactSetEffect

Character pydantic-model

Represent a Genshin Impact character.

Attributes:

• id (str) –

  ID of the character.

• icon (str) –

  Icon URL of the character.

• rarity (Literal[4, 5]) –

  Rarity of the character.

• description (str) –

  Description of the character.

• element (GIElement | None) –

  Element of the character, if available.

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

  Dictionary of names in different languages.

• name (str) –

  Name of the character.

Fields:

• id (str)
• icon (str)
• rarity (Literal[4, 5])
• description (str)
• element (GIElement | None)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• name (str)

Validators:

• __format_fields
• __convert_icon → icon
• __convert_rarity → rarity
• __convert_element → element
• __transform_names

description pydantic-field

description: str

element pydantic-field

element: GIElement | None = None

icon pydantic-field

icon: str

id pydantic-field

id: str

name pydantic-field

name: str = ''

names pydantic-field

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

rarity pydantic-field

rarity: Literal[4, 5]

CharacterConstellation pydantic-model

Represent a character's constellation.

Attributes:

• name (str) –

  Name of the constellation.

• description (str) –

  Description of the constellation.

• parameters (list[float]) –

  List of parameters for the constellation.

• icon (str) –

  Icon URL of the constellation.

Fields:

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

Validators:

• __format_fields
• __convert_icon → icon

description pydantic-field

description: str

icon pydantic-field

icon: str

name pydantic-field

name: str

parameters pydantic-field

parameters: list[float]

CharacterDetail pydantic-model

Represent a Genshin Impact character detail.

Attributes:

• name (str) –

  Name of the character.

• description (str) –

  Description of the character.

• info (CharacterInfo) –

  Character information.

• rarity (Literal[4, 5]) –

  Rarity of the character.

• icon (str) –

  Icon URL of the character.

• skills (list[CharacterSkill]) –

  List of character skills.

• passives (list[CharacterPassive]) –

  List of character passive talents.

• constellations (list[CharacterConstellation]) –

  List of character constellations.

• stamina_recovery (float) –

  Stamina recovery rate of the character.

• base_hp (float) –

  Base HP of the character.

• base_atk (float) –

  Base ATK of the character.

• base_def (float) –

  Base DEF of the character.

• crit_rate (float) –

  Critical rate of the character.

• crit_dmg (float) –

  Critical damage of the character.

• stats_modifier (CharacterStatsModifier) –

  Character stat modifiers.

• upgrade_materials (UpgradeMaterialInfos) –

  Character upgrade materials.

Fields:

• name (str)
• description (str)
• info (CharacterInfo)
• rarity (Literal[4, 5])
• icon (str)
• skills (list[CharacterSkill])
• passives (list[CharacterPassive])
• constellations (list[CharacterConstellation])
• stamina_recovery (float)
• base_hp (float)
• base_atk (float)
• base_def (float)
• crit_rate (float)
• crit_dmg (float)
• stats_modifier (CharacterStatsModifier)
• upgrade_materials (UpgradeMaterialInfos)

Validators:

• __format_fields
• __convert_icon → icon
• __convert_rarity → rarity

base_atk pydantic-field

base_atk: float

base_def pydantic-field

base_def: float

base_hp pydantic-field

base_hp: float

constellations pydantic-field

constellations: list[CharacterConstellation]

crit_dmg pydantic-field

crit_dmg: float

crit_rate pydantic-field

crit_rate: float

description pydantic-field

description: str

gacha_art property

gacha_art: str

Get the character's gacha art URL.

icon pydantic-field

icon: str

info pydantic-field

info: CharacterInfo

name pydantic-field

name: str

passives pydantic-field

passives: list[CharacterPassive]

rarity pydantic-field

rarity: Literal[4, 5]

skills pydantic-field

skills: list[CharacterSkill]

stamina_recovery pydantic-field

stamina_recovery: float

stats_modifier pydantic-field

stats_modifier: CharacterStatsModifier

upgrade_materials pydantic-field

upgrade_materials: UpgradeMaterialInfos

CharacterInfo pydantic-model

Represent a character's information.

Attributes:

• namecard (Namecard | None) –

  Character's namecard, if available.

Fields:

• namecard (Namecard | None)

Validators:

• __format_fields
• __handle_empty_namecard → namecard

namecard pydantic-field

namecard: Namecard | None = None

CharacterPassive pydantic-model

Represent a character's passive talent.

Attributes:

• name (str) –

  Name of the passive talent.

• description (str) –

  Description of the passive talent.

• parameters (list[float]) –

  List of parameters for the passive talent.

• icon (str) –

  Icon URL of the passive talent.

Fields:

• name (str)
• description (str)
• unlock (int | list[int])
• parameters (list[float])
• icon (str)

Validators:

• __format_fields
• __convert_icon → icon

description pydantic-field

description: str

icon pydantic-field

icon: str

name pydantic-field

name: str

parameters pydantic-field

parameters: list[float]

unlock pydantic-field

unlock: int | list[int]

CharacterSkill pydantic-model

Represent a character's skill.

Attributes:

• name (str) –

  Name of the skill.

• description (str) –

  Description of the skill.

• upgrade_info (dict[str, SkillUpgradeInfo]) –

  Dictionary of skill upgrade information.

Fields:

• name (str)
• description (str)
• upgrade_info (dict[str, SkillUpgradeInfo])

Validators:

• __format_fields

description pydantic-field

description: str

name pydantic-field

name: str

upgrade_info pydantic-field

upgrade_info: dict[str, SkillUpgradeInfo]

CharacterStatsModifier pydantic-model

Represent a character's stat modifiers.

Attributes:

• hp (dict[str, float]) –

  HP stat modifiers.

• atk (dict[str, float]) –

  ATK stat modifiers.

• def_ (dict[str, float]) –

  DEF stat modifiers.

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

  List of ascension stat modifiers.

• prop_growth_curves (list[FightPropGrowthCurve] | None) –

  List of property growth curves.

Fields:

• hp (dict[str, float])
• atk (dict[str, float])
• def_ (dict[str, float])
• ascension (list[dict[str, float]])
• prop_growth_curves (list[FightPropGrowthCurve] | None)

Validators:

• __format_fields

ascension pydantic-field

ascension: list[dict[str, float]]

atk pydantic-field

atk: dict[str, float]

def_ pydantic-field

def_: dict[str, float]

hp pydantic-field

hp: dict[str, float]

prop_growth_curves pydantic-field

prop_growth_curves: list[FightPropGrowthCurve] | None = None

FightPropGrowthCurve pydantic-model

Represent a character's stat growth curve data.

Attributes:

• stat_type (str) –

  Type of the stat.

• growth_type (str) –

  Type of the growth curve.

Fields:

• stat_type (str)
• growth_type (str)

Validators:

• __format_fields

growth_type pydantic-field

growth_type: str

stat_type pydantic-field

stat_type: str

MWCostume pydantic-model

Miliastra Wonderland costume

Fields:

• id (int)
• name (str)
• description (str)
• rarity (Literal[5, 4, 3, 2] | None)
• icon (str)
• body_types (list[MWCostumeBodyType])
• colors (list[str])
• slots (list[str])

Validators:

• __format_fields
• __convert_rarity → rarity
• __icon_url → icon

slots pydantic-field

slots: list[str]

MWCostumeSet pydantic-model

Miliastra Wonderland costume set

Fields:

• id (int)
• name (str)
• description (str)
• rarity (Literal[5, 4, 3, 2] | None)
• icon (str)
• body_types (list[MWCostumeBodyType])
• colors (list[str])

Validators:

• __format_fields
• __convert_rarity → rarity
• __icon_url → icon

MWItem pydantic-model

Miliastra Wonderland item

Fields:

• id (int)
• name (str)
• description (str)
• rarity (Literal[5, 4, 3, 2, 1] | None)
• icon (str | None)
• type (str)
• sources (list[str])

Validators:

• __format_fields
• __icon_url → icon

description pydantic-field

description: str

icon pydantic-field

icon: str | None

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: Literal[5, 4, 3, 2, 1] | None

sources pydantic-field

sources: list[str]

type pydantic-field

type: str

Namecard pydantic-model

Represent a character's namecard.

Attributes:

• id (int) –

  ID of the namecard.

• name (str) –

  Name of the namecard.

• description (str) –

  Description of the namecard.

• icon (str) –

  Icon URL of the namecard.

Fields:

• id (int)
• name (str)
• description (str)
• icon (str)

Validators:

• __format_fields
• __convert_icon → icon

description pydantic-field

description: str

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

New pydantic-model

Represent new Genshin Impact data.

Attributes:

• character_ids (list[str | int]) –

  A list of character IDs.

• weapon_ids (list[int]) –

  A list of weapon IDs.

• artifact_set_ids (list[int]) –

  A list of artifact 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[str | int])
• weapon_ids (list[int])
• artifact_set_ids (list[int])
• monster_ids (list[int])
• item_ids (list[int])
• version (str)

Validators:

• __format_fields

artifact_set_ids pydantic-field

artifact_set_ids: list[int]

character_ids pydantic-field

character_ids: list[str | int]

item_ids pydantic-field

item_ids: list[int]

monster_ids pydantic-field

monster_ids: list[int]

version pydantic-field

version: str

weapon_ids pydantic-field

weapon_ids: list[int]

SetEffect pydantic-model

Represent a set effect.

Attributes:

• id (int) –

  ID of the set effect.

• affix_id (int) –

  Affix ID of the set effect.

• name (str) –

  Name of the set effect.

• description (str) –

  Description of the set effect.

• parameters (list[float]) –

  List of parameters for the set effect.

Fields:

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

Validators:

• __format_fields

affix_id pydantic-field

affix_id: int

description pydantic-field

description: str

id pydantic-field

id: int

name pydantic-field

name: str

parameters pydantic-field

parameters: list[float]

SkillUpgradeInfo pydantic-model

Represent a character's skill upgrade information.

Attributes:

• level (int) –

  Level of the skill upgrade.

• icon (str) –

  Icon URL of the skill upgrade.

• attributes (list[str]) –

  List of attributes for the skill upgrade.

• parameters (list[float]) –

  List of parameters for the skill upgrade.

Fields:

• level (int)
• icon (str)
• attributes (list[str])
• parameters (list[float])

Validators:

• __format_fields
• __convert_icon → icon
• __remove_empty_attributes → attributes

attributes pydantic-field

attributes: list[str]

icon pydantic-field

icon: str

level pydantic-field

level: int

parameters pydantic-field

parameters: list[float]

Stygian pydantic-model

A Stygian Onslaught entry.

Attributes:

• id (int) –

  The Stygian ID.

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

  A dictionary of names in different languages.

• beta_start_at (datetime | None) –

  The start datetime of the beta period, if applicable.

• beta_end_at (datetime | None) –

  The end datetime of the beta period, if applicable.

• live_start_at (datetime | None) –

  The start datetime of the live period, if applicable.

• live_end_at (datetime | None) –

  The end datetime of the live period, if applicable.

• name (str) –

  The name of the Stygian (added in post-processing).

Fields:

• id (int)
• names (dict[Literal['en', 'zh', 'ko', 'ja'], str])
• beta_start_at (datetime | None)
• beta_end_at (datetime | None)
• live_start_at (datetime | None)
• live_end_at (datetime | None)
• name (str)

Validators:

• __format_fields
• __transform_names

beta_end_at pydantic-field

beta_end_at: datetime | None = None

beta_start_at pydantic-field

beta_start_at: datetime | None = None

id pydantic-field

id: int

live_end_at pydantic-field

live_end_at: datetime | None = None

live_start_at pydantic-field

live_start_at: datetime | None = None

name pydantic-field

name: str = ''

names pydantic-field

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

StygianDetail pydantic-model

Details of a Stygian Onslaught entry.

Attributes:

• id (int) –

  The Stygian ID.

• name (str) –

  The name of the Stygian.

• start_at (datetime) –

  The start datetime of the Stygian event.

• end_at (datetime) –

  The end datetime of the Stygian event.

• levels (dict[int, StygianLevel]) –

  A mapping of level IDs to StygianLevel objects.

Fields:

• id (int)
• name (str)
• start_at (datetime)
• end_at (datetime)
• levels (dict[int, StygianLevel])

Validators:

• __format_fields
• __process_levels → levels

end_at pydantic-field

end_at: datetime

id pydantic-field

id: int

levels pydantic-field

levels: dict[int, StygianLevel]

name pydantic-field

name: str

start_at pydantic-field

start_at: datetime

StygianDifficultyConfig pydantic-model

Configuration for a Stygian Onslaught difficulty.

Attributes:

• level (int) –

  The difficulty level.

• name (str) –

  The name of the difficulty.

• descriptions (list[str]) –

  A list of descriptions for the difficulty.

Fields:

• level (int)
• name (str)
• descriptions (list[str])

Validators:

• __format_fields

descriptions pydantic-field

descriptions: list[str]

level pydantic-field

level: int

name pydantic-field

name: str

StygianEnemy pydantic-model

A Stygian Onslaught enemy.

Attributes:

• id (int) –

  The enemy ID.

• name (str) –

  The enemy name.

• description (str) –

  The enemy description.

• icon (str) –

  The enemy icon URL.

• buffs (list[StygianEnemyBuff]) –

  A list of buffs associated with the enemy.

• recommendation (StygianEnemyRecommendation | None) –

  Recommendations for dealing with the enemy.

Fields:

• id (int)
• name (str)
• description (str)
• icon (str)
• buffs (list[StygianEnemyBuff])
• recommendation (StygianEnemyRecommendation | None)

Validators:

• __format_fields
• __process_icon → icon
• __process_model

buffs pydantic-field

buffs: list[StygianEnemyBuff]

description pydantic-field

description: str

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

recommendation pydantic-field

recommendation: StygianEnemyRecommendation | None = None

StygianEnemyBuff pydantic-model

A buff associated with a Stygian Abyss enemy.

Attributes:

• name (str) –

  The buff name.

• description (str) –

  The buff description.

Fields:

• name (str)
• description (str)

Validators:

• __format_fields

description pydantic-field

description: str

name pydantic-field

name: str

StygianEnemyRecommendation pydantic-model

Recommendations for dealing with a Stygian Abyss enemy.

Attributes:

• recommend (str) –

  Recommended strategies or characters.

• dont_recommend (str | None) –

  Strategies or characters to avoid.

Fields:

• recommend (str)
• dont_recommend (str | None)

Validators:

• __format_fields
• __remove_color_tags → recommend, dont_recommend

dont_recommend pydantic-field

dont_recommend: str | None = None

recommend pydantic-field

recommend: str

StygianLevel pydantic-model

A Stygian Onslaught level.

Attributes:

• id (int) –

  The level ID.

• enemy_level (int) –

  The enemy level.

• difficulty_config (StygianDifficultyConfig) –

  The difficulty configuration.

• enemies (dict[int, StygianEnemy]) –

  A mapping of enemy IDs to enemy details.

Fields:

• id (int)
• enemy_level (int)
• difficulty_config (StygianDifficultyConfig)
• enemies (dict[int, StygianEnemy])

Validators:

• __format_fields
• __process_enemies → enemies

difficulty_config pydantic-field

difficulty_config: StygianDifficultyConfig

enemies pydantic-field

enemies: dict[int, StygianEnemy]

enemy_level pydantic-field

enemy_level: int

id pydantic-field

id: int

UpgradeMaterial pydantic-model

Represent a character's upgrade material.

Attributes:

• name (str) –

  Name of the material.

• id (int) –

  ID of the material.

• count (int) –

  Count of the material.

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

  Rarity of the material.

Fields:

• name (str)
• id (int)
• count (int)
• rarity (Literal[0, 1, 2, 3, 4, 5])

Validators:

• __format_fields

count pydantic-field

count: int

icon property

icon: str

Get the material's icon URL.

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

rarity: Literal[0, 1, 2, 3, 4, 5]

UpgradeMaterialInfo pydantic-model

Represent character's upgrade material information.

Attributes:

• materials (list[UpgradeMaterial]) –

  List of upgrade materials.

• mora_cost (int) –

  Mora cost for the upgrade.

Fields:

• materials (list[UpgradeMaterial])
• mora_cost (int)

Validators:

• __format_fields

materials pydantic-field

materials: list[UpgradeMaterial]

mora_cost pydantic-field

mora_cost: int

UpgradeMaterialInfos pydantic-model

Represent character's upgrade material information.

Attributes:

• ascensions (list[UpgradeMaterialInfo]) –

  List of upgrade material information for ascensions.

• talents (list[list[UpgradeMaterialInfo]]) –

  List of lists of upgrade material information for talents.

Fields:

• ascensions (list[UpgradeMaterialInfo])
• talents (list[list[UpgradeMaterialInfo]])

Validators:

• __format_fields

ascensions pydantic-field

ascensions: list[UpgradeMaterialInfo]

talents pydantic-field

talents: list[list[UpgradeMaterialInfo]]

Weapon pydantic-model

Represent a Genshin Impact weapon.

Attributes:

• id (int) –

  ID of the weapon.

• icon (str) –

  Icon URL of the weapon.

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

  Rarity of the weapon.

• description (str) –

  Description of the weapon.

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

  Dictionary of names in different languages.

• name (str) –

  Name of the weapon.

Fields:

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

Validators:

• __format_fields
• __convert_icon → icon
• __transform_names

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]

rarity pydantic-field

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

WeaponDetail pydantic-model

Represent a Genshin Impact weapon detail.

Attributes:

• name (str) –

  Name of the weapon.

• description (str) –

  Description of the weapon.

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

  Rarity of the weapon.

• icon (str) –

  Icon URL of the weapon.

• stat_modifiers (dict[str, WeaponStatModifier] | None) –

  Dictionary of stat modifiers for the weapon.

• xp_requirements (dict[str, float] | None) –

  Dictionary of XP requirements for the weapon.

• ascension (dict[str, dict[str, float]] | None) –

  Dictionary of ascension data for the weapon.

• refinments (dict[str, WeaponRefinement] | None) –

  Dictionary of refinements for the weapon.

Fields:

• name (str)
• description (str)
• rarity (Literal[1, 2, 3, 4, 5])
• icon (str)
• stat_modifiers (dict[str, WeaponStatModifier] | None)
• xp_requirements (dict[str, float] | None)
• ascension (dict[str, dict[str, float]] | None)
• refinments (dict[str, WeaponRefinement] | None)

Validators:

• __format_fields
• __convert_icon → icon

ascension pydantic-field

ascension: dict[str, dict[str, float]] | None = None

description pydantic-field

description: str

icon pydantic-field

icon: str

name pydantic-field

name: str

rarity pydantic-field

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

refinments pydantic-field

refinments: dict[str, WeaponRefinement] | None = None

stat_modifiers pydantic-field

stat_modifiers: dict[str, WeaponStatModifier] | None = None

xp_requirements pydantic-field

xp_requirements: dict[str, float] | None = None

WeaponProperty pydantic-model

Represent a weapon's property.

Attributes:

• type (str) –

  Type of the property.

• init_value (float) –

  Initial value of the property.

• growth_type (str) –

  Growth type of the property.

Fields:

• type (str)
• init_value (float)
• growth_type (str)

Validators:

• __format_fields

growth_type pydantic-field

growth_type: str

init_value pydantic-field

init_value: float

type pydantic-field

type: str

WeaponRefinement pydantic-model

Represent a weapon's refinement.

Attributes:

• name (str) –

  Name of the refinement.

• description (str) –

  Description of the refinement.

• parameters (list[float]) –

  List of parameters for the refinement.

Fields:

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

Validators:

• __format_fields

description pydantic-field

description: str

name pydantic-field

name: str

parameters pydantic-field

parameters: list[float]

WeaponStatModifier pydantic-model

Represent a weapon's stat modifier.

Attributes:

• base (float) –

  Base value of the stat modifier.

• levels (dict[str, float]) –

  Dictionary of level-based stat modifiers.

Fields:

• base (float)
• levels (dict[str, float])

Validators:

• __format_fields

base pydantic-field

base: float

levels pydantic-field

levels: dict[str, float]