API Reference
Artifact
Bases: APIModel
Represent a Genshin Impact artifact.
Attributes:
| Name | Type | Description |
|---|---|---|
icon |
str
|
Icon URL of the artifact. |
name |
str
|
Name of the artifact. |
description |
str
|
Description of the artifact. |
__convert_icon(value)
classmethod
Convert the icon path to a full URL.
ArtifactSet
Bases: APIModel
Represent a Genshin Impact artifact set.
Attributes:
| Name | Type | Description |
|---|---|---|
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', 'KR', 'CHS', 'JP'], str]
|
Dictionary of names in different languages. |
name |
str
|
Name of the artifact set. |
__assign_set_effects(value)
classmethod
Assign the set effects to the appropriate fields.
__convert_icon(value)
classmethod
Convert the icon path to a full URL.
__extract_names(values)
classmethod
Extract names from the set effect.
ArtifactSetDetail
Bases: APIModel
Represent a Genshin Impact artifact set detail.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
__assign_set_effect(value)
classmethod
Assign the set effect to the appropriate fields.
__convert_icon(value)
classmethod
Convert the icon path to a full URL.
ArtifactSetDetailSetEffects
ArtifactSetEffect
Bases: APIModel
Represent an artifact set effect.
Attributes:
| Name | Type | Description |
|---|---|---|
names |
dict[Literal['EN', 'KR', 'CHS', 'JP'], str]
|
Dictionary of names in different languages. |
name |
str
|
Name of the artifact set effect. |
descriptions |
dict[Literal['EN', 'KR', 'CHS', 'JP'], str]
|
Dictionary of descriptions in different languages. |
description |
str
|
Description of the artifact set effect. |
__transform_names(values)
classmethod
Transform the names field.
ArtifactSetEffects
Bases: APIModel
Represent artifact set effects.
Attributes:
| Name | Type | Description |
|---|---|---|
two_piece |
ArtifactSetEffect
|
Two-piece set effect. |
four_piece |
ArtifactSetEffect | None
|
Four-piece set effect, if available. |
Character
Bases: APIModel
Represent a Genshin Impact character.
Attributes:
| Name | Type | Description |
|---|---|---|
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', 'CHS', 'KR', 'JP'], str]
|
Dictionary of names in different languages. |
name |
str
|
Name of the character. |
CharacterConstellation
Bases: APIModel
Represent a character's constellation.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
CharacterDetail
Bases: APIModel
Represent a Genshin Impact character detail.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
gacha_art
property
Get the character's gacha art URL.
CharacterInfo
Bases: APIModel
Represent a character's information.
Attributes:
| Name | Type | Description |
|---|---|---|
namecard |
Namecard | None
|
Character's namecard, if available. |
CharacterPassive
Bases: APIModel
Represent a character's passive talent.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the passive talent. |
description |
str
|
Description of the passive talent. |
unlock |
int
|
Unlock requirement for the passive talent. |
parameters |
list[float]
|
List of parameters for the passive talent. |
icon |
str
|
Icon URL of the passive talent. |
CharacterSkill
Bases: APIModel
Represent a character's skill.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the skill. |
description |
str
|
Description of the skill. |
upgrade_info |
dict[str, SkillUpgradeInfo]
|
Dictionary of skill upgrade information. |
CharacterStatsModifier
Bases: APIModel
Represent a character's stat modifiers.
Attributes:
| Name | Type | Description |
|---|---|---|
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]
|
List of property growth curves. |
FightPropGrowthCurve
Bases: APIModel
Represent a character's stat growth curve data.
Attributes:
| Name | Type | Description |
|---|---|---|
stat_type |
str
|
Type of the stat. |
growth_type |
str
|
Type of the growth curve. |
Namecard
Bases: APIModel
Represent a character's namecard.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
New
Bases: APIModel
Represent new Genshin Impact data.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
SetEffect
Bases: APIModel
Represent a set effect.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
SkillUpgradeInfo
Bases: APIModel
Represent a character's skill upgrade information.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
UpgradeMaterial
Bases: APIModel
Represent a character's upgrade material.
Attributes:
| Name | Type | Description |
|---|---|---|
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. |
icon
property
Get the material's icon URL.
UpgradeMaterialInfo
Bases: APIModel
Represent character's upgrade material information.
Attributes:
| Name | Type | Description |
|---|---|---|
materials |
list[UpgradeMaterial]
|
List of upgrade materials. |
mora_cost |
int
|
Mora cost for the upgrade. |
UpgradeMaterialInfos
Bases: APIModel
Represent character's upgrade material information.
Attributes:
| Name | Type | Description |
|---|---|---|
ascensions |
list[UpgradeMaterialInfo]
|
List of upgrade material information for ascensions. |
talents |
list[list[UpgradeMaterialInfo]]
|
List of lists of upgrade material information for talents. |
Weapon
Bases: APIModel
Represent a Genshin Impact weapon.
Attributes:
| Name | Type | Description |
|---|---|---|
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', 'CHS', 'KR', 'JP'], str]
|
Dictionary of names in different languages. |
name |
str
|
Name of the weapon. |
WeaponDetail
Bases: APIModel
Represent a Genshin Impact weapon detail.
Attributes:
| Name | Type | Description |
|---|---|---|
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]
|
Dictionary of stat modifiers for the weapon. |
xp_requirements |
dict[str, float]
|
Dictionary of XP requirements for the weapon. |
ascension |
dict[str, dict[str, float]]
|
Dictionary of ascension data for the weapon. |
refinments |
dict[str, WeaponRefinement]
|
Dictionary of refinements for the weapon. |
WeaponProperty
Bases: APIModel
Represent a weapon's property.
Attributes:
| Name | Type | Description |
|---|---|---|
type |
str
|
Type of the property. |
init_value |
float
|
Initial value of the property. |
growth_type |
str
|
Growth type of the property. |
WeaponRefinement
Bases: APIModel
Represent a weapon's refinement.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the refinement. |
description |
str
|
Description of the refinement. |
parameters |
list[float]
|
List of parameters for the refinement. |
WeaponStatModifier
Bases: APIModel
Represent a weapon's stat modifier.
Attributes:
| Name | Type | Description |
|---|---|---|
base |
float
|
Base value of the stat modifier. |
levels |
dict[str, float]
|
Dictionary of level-based stat modifiers. |