API Reference

Abyss

Bases: BaseModel

Represents a full Spiral Abyss cycle configuration.

Attributes:

Name	Type	Description
id	int	The unique ID identifying this Spiral Abyss cycle.
open_time	datetime	The start date and time of this cycle.
close_time	datetime	The end date and time of this cycle.
blessing	Blessing	The Benediction of the Abyssal Moon active during this cycle.
abyss_corridor	AbyssData	Data for the Abyss Corridor floors (usually 1-8).
abyssal_moon_spire	AbyssData	Data for the Abyssal Moon Spire floors (usually 9-12).

AbyssData

Bases: BaseModel

Represents data for either the Abyss Corridor or the Abyssal Moon Spire.

Attributes:

Name	Type	Description
open_time	datetime | None	The time when this specific section (usually Spire) becomes available (optional).
floors	list[Floor]	A list of floors within this section.

AbyssEnemy

Bases: BaseModel

Represents an enemy that can appear in the Spiral Abyss.

Attributes:

Name	Type	Description
icon	str	The icon URL for the enemy.
id	int	The unique ID of the enemy.
link	bool	A boolean indicating if there's a link available (purpose unclear).
name	str	The name of the enemy.
properties	list[AbyssEnemyProperty]	A list of base properties (like HP, ATK, DEF) and their growth curves.

AbyssEnemyProperty

Bases: BaseModel

Represents a base property of an enemy found in the Spiral Abyss.

Attributes:

Name	Type	Description
initial_value	float	The base value of the property at level 1.
type	str	The identifier string for the property (e.g., "FIGHT_PROP_BASE_HP").
growth_type	str	The identifier string for the property's growth curve.

AbyssResponse

Bases: BaseModel

Represents the complete response for Spiral Abyss data.

Attributes:

Name	Type	Description
enemies	dict[str, AbyssEnemy]	A dictionary mapping enemy IDs to their details (AbyssEnemy).
abyss_items	list[Abyss]	A list containing data for one or more Spiral Abyss cycles (Abyss).

Achievement

Bases: BaseModel

Represents an achievement, potentially with multiple stages or levels.

Attributes:

Name	Type	Description
id	int	The base ID for the achievement (stages might share this).
order	int	The display order of the achievement within its category.
details	list[AchievementDetail]	A list containing details for each stage or level of the achievement.

AchievementCategory

Bases: BaseModel

Represents a category of achievements.

Attributes:

Name	Type	Description
id	int	The unique ID of the achievement category.
name	str	The name of the category (e.g., "Wonders of the World").
order	int	The display order of the category.
icon	str	The icon URL for the category.
achievements	list[Achievement]	A list of achievements belonging to this category.

AchievementDetail

Bases: BaseModel

Represents the details of a specific achievement.

Attributes:

Name	Type	Description
id	int	The unique ID of the achievement.
title	str	The title or name of the achievement.
description	str	The description or requirement for the achievement.
rewards	list[AchievementReward]	A list of rewards granted upon completion.

AchievementReward

Bases: BaseModel

Represents a reward granted for completing an achievement.

Attributes:

Name	Type	Description
rarity	int	The rarity rank of the reward item (often Primogems).
amount	int	The quantity of the reward item granted.
icon	str	The icon URL for the reward item.

Artifact

Bases: BaseModel

Represents a single artifact piece within a set.

Attributes:

Name	Type	Description
pos	str	The position or slot of the artifact (e.g., "flower", "plume", "sands", "goblet", "circlet").
name	str	The name of the specific artifact piece.
description	str	The flavor text or description of the artifact piece.
max_rarity	int	The maximum rarity level this artifact piece can have.
icon	str	The icon URL for the artifact piece.

ArtifactAffix

Bases: BaseModel

Represents an artifact set's bonus effect (2-piece or 4-piece).

Attributes:

Name	Type	Description
id	str	The identifier for the set effect (e.g., "2" or "4").
effect	str	The description of the set effect.

ArtifactSet

Bases: BaseModel

Represents an artifact set summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the artifact set.
name	str	The name of the artifact set.
rarity_list	list[int]	A list of possible rarity levels for artifacts in this set.
affix_list	list[ArtifactAffix]	A list of the set bonus effects (2-piece and 4-piece).
icon	str	The icon URL representing the artifact set (usually the flower piece).
route	str	The route identifier for the artifact set.
sort_order	int	The sorting order value for the artifact set.

ArtifactSetDetail

Bases: BaseModel

Represents detailed information about an artifact set.

Attributes:

Name	Type	Description
id	int	The unique ID of the artifact set.
name	str	The name of the artifact set.
rarity_list	list[int]	A list of possible rarity levels for artifacts in this set.
affix_list	list[ArtifactAffix]	A list of the set bonus effects (2-piece and 4-piece).
icon	str	The icon URL representing the artifact set (usually the flower piece).
route	str	The route identifier for the artifact set.
artifacts	list[Artifact]	A list of the individual artifact pieces belonging to this set.

AscensionMaterial

Bases: BaseModel

Represents a material required for character ascension.

Attributes:

Name	Type	Description
id	int	The ID of the ascension material.
rarity	int	The rarity rank of the material.

AvailableItems

Bases: BaseModel

Container for available characters, weapons, and artifacts referenced in guides.

Attributes:

Name	Type	Description
characters	dict[str, GuideCharacter]	A dictionary mapping character IDs to GuideCharacter objects.
weapons	dict[str, GuideWeapon]	A dictionary mapping weapon IDs to GuideWeapon objects.
artifacts	dict[str, GuideArtifact]	A dictionary mapping artifact set IDs to GuideArtifact objects.

AzaBestArtifact

Bases: BaseModel

Represents an artifact piece within a best artifact set from genshin.aza.gg.

Attributes:

Name	Type	Description
id	int	The artifact set ID.
num	int	The number of pieces recommended from this set (e.g., 2 or 4).

AzaBestArtifactSets

Bases: BaseModel

Represents a ranked artifact set combination from genshin.aza.gg.

Attributes:

Name	Type	Description
sets	list[AzaBestArtifact]	A list describing the combination of artifact sets (AzaBestArtifact).
value	float	A numerical value representing the ranking or usage rate of this combination.

percentage property

Formats the value as a percentage string (e.g., "72.1%").

AzaBestItem

Bases: BaseModel

Represents a best-ranked item (character or weapon) from genshin.aza.gg.

Attributes:

Name	Type	Description
id	int	The ID of the item (character or weapon).
value	float	A numerical value representing the ranking or usage rate.

percentage property

Formats the value as a percentage string (e.g., "85.3%").

AzaData

Bases: BaseModel

Container for all genshin.aza.gg guide data for a character.

Attributes:

Name	Type	Description
best_characters	dict[str, AzaBestItem]	Dictionary mapping character IDs to their ranking/usage data.
best_weapons	dict[str, AzaBestItem]	Dictionary mapping weapon IDs to their ranking/usage data.
best_artifact_sets	list[AzaBestArtifactSets]	List of ranked artifact set combinations.
constellation_usage	dict[str, float]	Dictionary mapping constellation numbers (as strings) to usage rates.

Birthday

Bases: BaseModel

Represents a character's birthday.

Attributes:

Name	Type	Description
month	int	The month of the birthday.
day	int	The day of the birthday.

Blessing

Bases: BaseModel

Represents the Benediction of the Abyssal Moon (Blessing) for a Spiral Abyss cycle.

Attributes:

Name	Type	Description
description	str	The description of the blessing's effect.
level_config_name	str	Internal configuration name for the blessing.
visible	bool	Whether the blessing is currently visible or active.

Book

Bases: BaseModel

Represents a book summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the book.
name	str	The name or title of the book.
rarity	int	The rarity rank of the book item.
icon	str	The icon URL for the book item.
route	str	The route identifier for the book.

BookDetail

Bases: BaseModel

Represents detailed information about a book, including its volumes.

Attributes:

Name	Type	Description
id	int	The unique ID of the book.
name	str	The name or title of the book.
rarity	int	The rarity rank of the book item.
icon	str	The icon URL for the book item.
volumes	list[BookVolume]	A list of volumes contained within the book.

BookVolume

Bases: BaseModel

Represents a single volume or chapter within a book.

Attributes:

Name	Type	Description
id	int	The unique ID of this volume.
name	str	The name or title of the volume.
description	str	The text content of the volume.
story_id	int	An associated story ID.

CardDictionary

Bases: BaseModel

Represents a dictionary entry (like a skill description) for a TCG card.

Attributes:

Name	Type	Description
id	str	The dictionary entry's ID.
name	str	The name of the entry (e.g., skill name).
params	dict[str, Any] | None	Optional parameters used for placeholder replacement in the description.
description	str	The detailed description of the entry.
cost	list[DiceCost]	The dice cost associated with this entry, if any.

CardTag

Bases: BaseModel

Represents a tag associated with a TCG card.

Attributes:

Name	Type	Description
id	str	The tag's identifier string.
name	str	The tag's display name.

CardTalent

Bases: BaseModel

Represents a talent or skill associated with a TCG card.

Attributes:

Name	Type	Description
id	str	The talent's ID.
name	str	The talent's name.
params	dict[str, Any] | None	Optional parameters used for placeholder replacement in the description.
description	str	The detailed description of the talent.
cost	list[DiceCost]	The dice cost to use the talent.
tags	list[CardTag]	A list of tags associated with the talent.
icon	str	The icon URL for the talent.
sub_skills	dict[str, Any] | None	Optional dictionary of sub-skills related to this talent.

small_icon property

Returns the URL for the small version of the talent icon.

ChallengeTarget

Bases: BaseModel

Represents the challenge targets for a Spiral Abyss chamber (e.g., time limits).

Attributes:

Name	Type	Description
type	str	A format string describing the challenge type (e.g., "Challenge time limit: {}s").
values	list[int]	A list of numerical values corresponding to the targets (e.g., time limits for 1, 2, 3 stars).

formatted property

Returns the challenge target description with values formatted in.

Chamber

Bases: BaseModel

Represents a single chamber within a Spiral Abyss floor.

Attributes:

Name	Type	Description
id	int	The ID of the chamber (usually 1, 2, or 3).
challenge_target	ChallengeTarget	The challenge targets (e.g., time limits) for this chamber.
enemy_level	int	The base level of the enemies in this chamber.
wave_one_enemies	list[int]	A list of enemy IDs appearing in the first half/wave.
wave_two_enemies	list[int] | None	An optional list of enemy IDs appearing in the second half/wave.

Changelog

Bases: BaseModel

Represents a change log entry.

Attributes:

Name	Type	Description
id	int	The unique identifier for the change log.
version	str	The version string associated with the change log.
items	list[Item]	A list of items detailing the changes in this version.
beta	bool	Indicates if this change log is for a beta version.

Character

Bases: BaseModel

Represents a character summary.

Attributes:

Name	Type	Description
id	str	The character's unique ID (as a string).
rarity	int	The character's rarity rank (4 or 5).
name	str	The character's name.
element	Element	The character's element.
weapon_type	WeaponType	The type of weapon the character uses.
icon	str	The icon URL for the character.
birthday	Birthday	The character's birthday.
release	datetime | None	The date and time the character was released (optional).
route	str	The route identifier for the character.
beta	bool	Whether the character data is considered beta/unreleased.
special_stat	SpecialStat | str	The specialized stat gained through ascension (e.g., Crit Rate, Pyro DMG Bonus).
region	str	The region the character is associated with.

gacha property

Returns the URL for the character's gacha artwork (full body image).

CharacterBaseStat

Bases: BaseModel

Represents a base stat of a character and its growth type.

Attributes:

Name	Type	Description
prop_type	str	The identifier string for the stat (e.g., "FIGHT_PROP_BASE_HP").
init_value	float	The initial value of the stat at level 1.
growth_type	str	The identifier string for the stat's growth curve (e.g., "GROW_CURVE_HP_S4").

CharacterCV

Bases: BaseModel

Represents character voice actor information for a specific language.

Attributes:

Name	Type	Description
lang	str	The language code (e.g., "en", "jp").
va	str	The name of the voice actor for this language.

CharacterDetail

Bases: BaseModel

Represents detailed information about a character.

Attributes:

Name	Type	Description
id	str	The character's unique ID (as a string).
rarity	int	The character's rarity rank (4 or 5).
name	str	The character's name.
element	Element	The character's element.
weapon_type	WeaponType	The type of weapon the character uses.
icon	str	The icon URL for the character.
birthday	Birthday	The character's birthday.
release	datetime | None	The date and time the character was released (optional).
route	str	The route identifier for the character.
info	CharacterInfo	Detailed profile information (title, story, CVs, etc.).
upgrade	CharacterUpgrade	Information about the character's stats and ascension progression.
ascension_materials	list[AscensionMaterial]	A list of materials required for ascension.
talents	list[Talent]	A list of the character's talents (active and passive).
constellations	list[Constellation]	A list of the character's constellations.
beta	bool	Whether the character data is considered beta/unreleased.
special_stat	SpecialStat | str	The specialized stat gained through ascension (e.g., Crit Rate, Pyro DMG Bonus).
region	str	The region the character is associated with.

gacha property

Returns the URL for the character's gacha artwork (full body image).

CharacterFetter

Bases: BaseModel

Container for character quotes and stories (fetter information).

Attributes:

Name	Type	Description
quotes	list[Quote]	A list of character voice-over quotes.
stories	list[Story]	A list of character story entries.

CharacterGuide

Bases: BaseModel

Represents the complete guide data for a character, combining multiple sources.

Attributes:

Name	Type	Description
available_items	AvailableItems	Information about items (characters, weapons, artifacts) referenced in the guide.
gw_data	GWData | None	Optional guide data sourced from Genshin Wizard.
aza_data	AzaData | None	Optional guide data sourced from genshin.aza.gg.

aza_data = Field(None, alias='azaData') class-attribute instance-attribute

genshin.aza.gg data.

gw_data = Field(None, alias='gwData') class-attribute instance-attribute

Genshin Wizard data.

CharacterInfo

Bases: BaseModel

Represents detailed character information like title, story, affiliation, and CVs.

Attributes:

Name	Type	Description
title	str	The character's title (e.g., "Spark Knight").
detail	str	The character's story or profile description.
constellation	str	The name of the character's constellation.
native	str	The character's affiliation or origin (e.g., "Mondstadt").
cv	list[CharacterCV]	A list of voice actor information for different languages.

CharacterPromote

Bases: BaseModel

Represents a character promotion (ascension) level.

Attributes:

Name	Type	Description
promote_level	int	The ascension phase number (e.g., 1 for first ascension).
unlock_max_level	int	The maximum character level unlocked after this promotion.
cost_items	list[CharacterPromoteMaterial] | None	A list of materials required for this promotion (optional).
add_stats	list[CharacterPromoteStat] | None	A list of stat bonuses granted by this promotion (optional).
required_player_level	int | None	The minimum Adventure Rank required for this promotion (optional).
coin_cost	int | None	The Mora cost for this promotion (optional).

CharacterPromoteMaterial

Bases: BaseModel

Represents a material required for character promotion (ascension).

Attributes:

Name	Type	Description
id	int	The ID of the required material.
count	int	The quantity of the material required.

CharacterPromoteStat

Bases: BaseModel

Represents a stat bonus gained from character promotion (ascension).

Attributes:

Name	Type	Description
id	str	The identifier string for the stat (e.g., "FIGHT_PROP_HP").
value	float	The value of the stat bonus.

CharacterUpgrade

Bases: BaseModel

Represents the upgrade details (stats and promotions) of a character.

Attributes:

Name	Type	Description
base_stats	list[CharacterBaseStat]	A list of the character's base stats and their growth types.
promotes	list[CharacterPromote]	A list of promotion (ascension) levels and their details.

City

Bases: IntEnum

Enumeration of cities/regions associated with domains.

Constellation

Bases: BaseModel

Represents a character constellation.

Attributes:

Name	Type	Description
name	str	The name of the constellation.
description	str	The description of the constellation's effect.
extra_level	TalentExtraLevel | None	Information about extra talent levels granted by this constellation (optional).
icon	str	The icon URL for the constellation.

DiceCost

Bases: BaseModel

Represents the dice cost for a TCG card action.

Attributes:

Name	Type	Description
type	str	The type of dice required (e.g., "GCG_COST_DICE_PYRO", "GCG_COST_DICE_VOID").
amount	int	The number of dice required.

Domain

Bases: BaseModel

Represents a domain and its potential rewards for a specific day.

Attributes:

Name	Type	Description
id	int	The unique ID of the domain.
name	str	The name of the domain.
rewards	list[DomainReward]	A list of potential rewards available from the domain.
city	City	The city/region the domain is located in.

DomainReward

Bases: BaseModel

Represents a potential reward from a domain.

Attributes:

Name	Type	Description
id	int	The ID of the reward item.

icon property

Returns the icon URL for the reward item.

Domains

Bases: BaseModel

Container for domains available on each day of the week.

Attributes:

Name	Type	Description
monday	list[Domain]	List of domains available on Monday.
tuesday	list[Domain]	List of domains available on Tuesday.
wednesday	list[Domain]	List of domains available on Wednesday.
thursday	list[Domain]	List of domains available on Thursday.
friday	list[Domain]	List of domains available on Friday.
saturday	list[Domain]	List of domains available on Saturday.
sunday	list[Domain]	List of domains available on Sunday.

Floor

Bases: BaseModel

Represents a floor within the Spiral Abyss (either Corridor or Spire).

Attributes:

Name	Type	Description
id	int	The ID of the floor (e.g., 9, 10, 11, 12).
chambers	list[Chamber]	A list of chambers within this floor.
ley_line_disorders	list[LeyLineDisorder]	A list of Ley Line Disorders active on this floor.
override_enemy_level	int	An optional override for the enemy level on this floor.
team_num	int	The number of teams required for this floor (usually 1 or 2).

Food

Bases: BaseModel

Represents a food item (summary view).

Attributes:

Name	Type	Description
id	int	The unique identifier for the food.
name	str	The name of the food.
type	str	The type or category of the food.
recipe	bool	Indicates if the food is obtained via a recipe.
icon	str	The URL of the food's icon.
rarity	int	The rarity or rank of the food.
route	str	The internal route or identifier for the food.
effect_icon	str | None	The URL of the icon representing the food's effect category, if applicable.

FoodDetail

Bases: BaseModel

Represents detailed information about a food item.

Attributes:

Name	Type	Description
name	str	The name of the food.
description	str	The description of the food.
type	str	The type or category of the food.
recipe	FoodRecipe | bool	Details about the recipe if the food can be cooked, otherwise False.
sources	list[FoodSource]	A list of sources where the food can be obtained.
icon	str	The URL of the food's icon.
rarity	int	The rarity or rank of the food.
route	str	The internal route or identifier for the food.

FoodEffect

Bases: BaseModel

Represents the effect of a food item.

Attributes:

Name	Type	Description
id	str	The identifier for the effect.
description	str	The description of the effect.

FoodRecipe

Bases: BaseModel

Represents the recipe details for a food item.

Attributes:

Name	Type	Description
effect_icon	str	The URL of the icon representing the food's effect category.
effects	list[FoodEffect]	A list of specific effects provided by the food.

FoodSource

Bases: BaseModel

Represents a source where food can be obtained.

Attributes:

Name	Type	Description
name	str	The name of the source (e.g., an NPC or location).
type	str	The type of source (e.g., "Shop", "Quest").

Furniture

Bases: BaseModel

Represents a furniture summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the furniture.
name	str	The name of the furniture.
cost	int | None	The load cost of the furniture (optional).
comfort	int | None	The comfort value (Adeptal Energy) provided by the furniture (optional).
rarity	int	The rarity rank of the furniture.
icon	str	The icon URL for the furniture.
route	str	The route identifier for the furniture.
categories	list[str]	A list of categories the furniture belongs to.
types	list[str]	A list of types the furniture belongs to.

FurnitureDetail

Bases: BaseModel

Represents detailed information about a piece of furniture.

Attributes:

Name	Type	Description
id	int	The unique ID of the furniture.
name	str	The name of the furniture.
cost	int | None	The load cost of the furniture (optional).
comfort	int | None	The comfort value (Adeptal Energy) provided by the furniture (optional).
rarity	int	The rarity rank of the furniture.
icon	str	The icon URL for the furniture.
route	str	The route identifier for the furniture.
categories	list[str]	A list of categories the furniture belongs to.
types	list[str]	A list of types the furniture belongs to.
description	str	The description of the furniture.
recipe	FurnitureRecipe | None	The crafting recipe for the furniture (optional).

FurnitureItem

Bases: BaseModel

Represents a single furniture item within a furniture set.

Attributes:

Name	Type	Description
id	int	The ID of the furniture item.
rarity	int	The rarity rank of the furniture item.
icon	str	The icon URL of the furniture item.

FurnitureRecipe

Bases: BaseModel

Represents the crafting recipe for a piece of furniture.

Attributes:

Name	Type	Description
exp	int	The amount of Adeptal Energy experience gained upon crafting.
time	int	The time required to craft the furniture (in some unit, likely hours or seconds).
inputs	list[FurnitureRecipeInput]	A list of materials required to craft the furniture.

FurnitureRecipeInput

Bases: BaseModel

Represents an input material required for a furniture recipe.

Attributes:

Name	Type	Description
id	int	The ID of the input material.
icon	str	The icon URL of the input material.
amount	int	The quantity of the material required.

FurnitureSet

Bases: BaseModel

Represents a furniture set summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the furniture set.
name	str	The name of the furniture set.
icon	str	The icon URL for the furniture set.
route	str	The route identifier for the furniture set.
categories	list[str]	A list of categories the set belongs to.
types	list[str]	A list of types the set belongs to.

FurnitureSetDetail

Bases: BaseModel

Represents detailed information about a furniture set.

Attributes:

Name	Type	Description
id	int	The unique ID of the furniture set.
name	str	The name of the furniture set.
icon	str	The icon URL for the furniture set.
route	str	The route identifier for the furniture set.
categories	list[str]	A list of categories the set belongs to.
types	list[str]	A list of types the set belongs to.
description	str	The description of the furniture set.
furniture_items	list[FurnitureItem]	A list of furniture items included in the set.
favorite_npcs	list[FurnitureSetFavoriteNPC]	A list of NPCs who favor this set.

FurnitureSetFavoriteNPC

Bases: BaseModel

Represents an NPC who favors a particular furniture set.

Attributes:

Name	Type	Description
id	str	The ID of the NPC.
icon	str	The icon URL of the NPC.

GWBuild

Bases: BaseModel

Represents a complete build recommendation from Genshin Wizard.

Attributes:

Name	Type	Description
title	str	The title of the build (e.g., "Support Build").
credits	str	Attribution for the build information.
info	list[GWBuildInfo]	A list of detailed information sections (GWBuildInfo) for the build.

GWBuildInfo

Bases: BaseModel

Represents a specific piece of information within a Genshin Wizard build section.

Attributes:

Name	Type	Description
inline	bool	Whether the information should be displayed inline.
name	str	The name or label for this piece of information (e.g., "Main Stats").
value	str | None	The textual value associated with the name (optional).
weapons	dict[int, str] | None	A dictionary mapping recommended weapon IDs to their names (optional).
artifacts	list[GWBuildInfoNormalArtifact | GwBuildInfoCustomArtifact] | None	A list of recommended artifact sets (normal or custom) (optional).

weapons = Field(None, alias='weaponList') class-attribute instance-attribute

Weapon ID to weapon name.

GWBuildInfoNormalArtifact

Bases: BaseModel

Represents a standard artifact reference in a Genshin Wizard build.

Attributes:

Name	Type	Description
id	int	The artifact set ID.
type	Literal['normal']	Always "normal".

GWData

Bases: BaseModel

Container for all Genshin Wizard guide data for a character.

Attributes:

Name	Type	Description
builds	list[GWBuild]	A list of recommended builds (GWBuild).
playstyle	GWPlaystyle | None	Optional playstyle information (GWPlaystyle).
synergies	GWSynergy	Synergy and team composition information (GWSynergy).

GWPlaystyle

Bases: BaseModel

Represents playstyle information from Genshin Wizard.

Attributes:

Name	Type	Description
title	str	The title of the playstyle section.
description	str	The detailed description of the playstyle.
credits	str	Attribution for the playstyle information.

GWSynergy

Bases: BaseModel

Represents synergy and team composition information from Genshin Wizard.

Attributes:

Name	Type	Description
title	str	The title of the synergy section.
info	list[GWSynergyInfo] | None	Optional list of textual synergy information (GWSynergyInfo).
teams	list[list[GWSynergyNormalCharacter | GWSynergyElementCharacter | GWSynergyFlexibleCharacter]]	A list of recommended team compositions. Each team is a list of character slots.
credits	str	Attribution for the synergy information.

GWSynergyElementCharacter

Bases: BaseModel

Represents a character slot recommendation based on element in a Genshin Wizard synergy team.

Attributes:

Name	Type	Description
element	Element	The recommended element for this slot.
type	Literal['element']	Always "element".

GWSynergyFlexibleCharacter

Bases: BaseModel

Represents a flexible character slot in a Genshin Wizard synergy team.

Attributes:

Name	Type	Description
type	Literal['flexible']	Always "flexible".

GWSynergyInfo

Bases: BaseModel

Represents a piece of textual information related to Genshin Wizard synergies.

Attributes:

Name	Type	Description
inline	bool	Whether the information should be displayed inline.
name	str	The name or label for this piece of information.
value	str	The textual value associated with the name.

GWSynergyNormalCharacter

Bases: BaseModel

Represents a specific character recommendation in a Genshin Wizard synergy team.

Attributes:

Name	Type	Description
id	str | int	The character's ID (can be string or int).
type	Literal['normal']	Always "normal".

GuideArtifact

Bases: BaseModel

Represents an artifact within a guide context.

Attributes:

Name	Type	Description
id	int	The artifact set's ID.
icon	str	The icon URL (likely for one piece of the set).
rarities	list[int]	A list of possible rarity levels for the artifact set.
route	str	The route identifier for the artifact set.

GuideCharacter

Bases: BaseModel

Represents a character within a guide context.

Attributes:

Name	Type	Description
id	str | int	The character's ID (can be string or int).
rarity	Literal[4, 5]	The character's rarity (4 or 5 star).
weapon_type	WeaponType	The type of weapon the character uses.
icon	str	The character's icon URL.
route	str	The route identifier for the character.

GuideWeapon

Bases: BaseModel

Represents a weapon within a guide context.

Attributes:

Name	Type	Description
id	int	The weapon's ID.
rarity	Literal[1, 2, 3, 4, 5]	The weapon's rarity (1 to 5 star).
type	WeaponType	The type of the weapon.
icon	str	The weapon's icon URL.
route	str	The route identifier for the weapon.

GwBuildInfoCustomArtifact

Bases: BaseModel

Represents a custom artifact reference in a Genshin Wizard build.

Attributes:

Name	Type	Description
id	str	A custom identifier string for the artifact.
type	Literal['custom']	Always "custom".

Item

Bases: BaseModel

Represents an item within a changelog.

Attributes:

Name	Type	Description
category	str	The category of the item (e.g., "characters", "weapons").
ids	list[str]	A list of IDs belonging to this category that were changed.

LeyLineDisorder

Bases: BaseModel

Represents a Ley Line Disorder effect active on a Spiral Abyss floor.

Attributes:

Name	Type	Description
description	str	The description of the disorder's effect.
level_config_name	str	Internal configuration name for the disorder.
visible	bool	Whether the disorder is currently visible or active.

Material

Bases: BaseModel

Represents a material summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the material.
name	str	The name of the material.
type	str	The type or category of the material.
recipe	bool	Whether the material can be crafted.
icon	str	The icon URL for the material.
rarity	int	The rarity rank of the material.
route	str	The route identifier for the material.

MaterialDetail

Bases: BaseModel

Represents detailed information about a material.

Attributes:

Name	Type	Description
name	str	The name of the material.
description	str	The description of the material.
type	str	The type or category of the material.
recipe	list[MaterialRecipe]	A list of input items required if this material can be crafted.
sources	list[MaterialSource]	A list of sources where this material can be obtained.
icon	str	The icon URL for the material.
rarity	int	The rarity rank of the material.
route	str	The route identifier for the material.

MaterialRecipe

Bases: BaseModel

Represents an item used as input in a material crafting recipe.

Attributes:

Name	Type	Description
icon	str	The icon URL of the input item.
amount	int	The quantity of the input item required.

MaterialSource

Bases: BaseModel

Represents a source where a material can be obtained.

Attributes:

Name	Type	Description
name	str	The name of the source (e.g., "Cecilia Garden", "Dropped by Cryo Slimes").
type	str	The type of source (e.g., "Domain", "Monster").
days	list[int] | None	A list of integers representing the days of the week the source is available (optional, 1=Monday, 7=Sunday).

Monster

Bases: BaseModel

Represents a monster or living being summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the monster/being.
name	str	The name of the monster/being.
type	str	The type or category of the monster/being.
icon	str	The icon URL for the monster/being.
route	str	The route identifier for the monster/being.

MonsterDetail

Bases: BaseModel

Represents detailed information about a monster or living being.

Attributes:

Name	Type	Description
id	int	The unique ID of the monster.
name	str	The name of the monster.
type	str	The type or category of the monster.
icon	str	The icon URL for the monster.
route	str	The route identifier for the monster.
title	str | None	An optional title associated with the monster.
special_name	str | None	An optional special name for the monster.
description	str	The description of the monster.
entries	list[MonsterEntry]	A list of different entries or variants of this monster.

MonsterEntry

Bases: BaseModel

Represents an entry or variant of a monster.

Attributes:

Name	Type	Description
id	int	The ID of this specific monster entry/variant.
type	str	The type or category of this entry.
rewards	list[MonsterReward]	A list of potential rewards for this entry.

MonsterReward

Bases: BaseModel

Represents a potential reward dropped by a monster.

Attributes:

Name	Type	Description
id	int	The ID of the reward item.
rarity	int	The rarity rank of the reward item.
icon	str	The icon URL of the reward item.
count	float | None	The typical amount dropped (optional).

Namecard

Bases: BaseModel

Represents a namecard summary.

Attributes:

Name	Type	Description
id	int	The namecard's unique ID.
name	str	The namecard's name.
type	str	The type or category of the namecard.
rarity	int	The rarity rank of the namecard.
icon	str	The icon URL for the namecard.
route	str	The route identifier for the namecard.

picture property

Returns the URL for the full picture version of the namecard.

NamecardDetail

Bases: BaseModel

Represents detailed information about a namecard.

Attributes:

Name	Type	Description
id	int	The namecard's unique ID.
name	str	The namecard's name.
rarity	int	The rarity rank of the namecard.
icon	str	The icon URL for the namecard.
route	str	The route identifier for the namecard.
description	str	The general description of the namecard.
description_special	str	A special or alternative description (optional).
source	str | None	How the namecard is obtained (optional).

picture property

Returns the URL for the full picture version of the namecard.

Quest

Bases: BaseModel

Represents a quest summary.

Attributes:

Name	Type	Description
id	int	The quest's unique ID.
type	str | None	The type or category of the quest (optional).
chapter_num	str | None	The chapter number associated with the quest (optional).
chapter_title	str	The title of the quest chapter.
chapter_icon	str | None	The icon URL for the quest chapter (optional).
chapter_image_title	str | None	The title associated with the chapter image (optional).
route	str	The route identifier for the quest.
chapter_count	int	The count related to the quest chapter.

Quote

Bases: BaseModel

Represents a character voice-over quote.

Attributes:

Name	Type	Description
title	str	The title or category of the quote (e.g., "Chat: Knights").
audio_id	str	The identifier for the audio file associated with the quote.
text	str	The transcribed text of the quote.
tips	str | None	Optional tips or context related to the quote.
tasks	list[Task]	A list of tasks required to unlock this quote.

Story

Bases: BaseModel

Represents a character story entry.

Attributes:

Name	Type	Description
title	str	The title of the story entry (e.g., "Character Story 1").
title2	str | None	An alternative or secondary title (optional).
text	str	The main text content of the story entry.
text2	str | None	Alternative or secondary text content (optional).
tips	str | None	Optional tips or context related to the story entry.

TCGCard

Bases: BaseModel

Represents a TCG card summary.

Attributes:

Name	Type	Description
id	int	The card's unique ID.
name	str	The card's name.
type	str	The type of card (e.g., "GCG_CARD_CHARACTER", "GCG_CARD_EVENT").
tags	list[CardTag]	A list of tags associated with the card.
dice_cost	list[DiceCost]	The dice cost required to play the card.
icon	str	The main icon URL for the card.
route	str	The route identifier for the card.
sort_order	int	The sorting order value for the card.

small_icon property

Returns the URL for the small version of the card icon.

TCGCardDetail

Bases: BaseModel

Represents detailed information about a TCG card.

Attributes:

Name	Type	Description
id	int	The card's unique ID.
name	str	The card's name.
type	str	The type of card (e.g., "GCG_CARD_CHARACTER", "GCG_CARD_EVENT").
tags	list[CardTag]	A list of tags associated with the card.
props	dict[str, int] | None	Optional properties, often representing dice cost or other stats.
icon	str	The main icon URL for the card.
route	str	The route identifier for the card.
story_title	str	The title of the card's story/flavor text.
story_detail	str	The main body of the card's story/flavor text.
source	str	How the card is obtained.
dictionaries	list[CardDictionary]	Associated dictionary entries (skills, effects).
talents	list[CardTalent]	Associated talents or special skills.

small_icon property

Returns the URL for the small version of the card icon.

Talent

Bases: BaseModel

Represents a character talent.

Attributes:

Name	Type	Description
type	TalentType	The type of talent (Normal, Skill, Ultimate, Passive).
name	str	The name of the talent.
description	str	The base description of the talent.
icon	str	The icon URL for the talent.
upgrades	list[TalentUpgrade] | None	A list of upgrade details for each level (optional, usually for active talents).
cooldown	float | None	The cooldown time in seconds (optional).
cost	int | None	The energy cost (optional, usually for Ultimate).

TalentExtraLevel

Bases: BaseModel

Represents an extra talent level granted by a constellation.

Attributes:

Name	Type	Description
talent_type	ExtraLevelType	The type of talent that gets the extra level (Normal, Skill, Ultimate).
extra_level	int	The number of extra levels granted.

TalentUpgrade

Bases: BaseModel

Represents a specific level upgrade for a talent.

Attributes:

Name	Type	Description
level	int	The target level of the upgrade.
cost_items	list[TalentUpgradeItem] | None	A list of items required for this upgrade level (optional).
mora_cost	int | None	The Mora cost for this upgrade level (optional).
description	list[str]	A list of strings describing the talent's effect at this level.
params	list[int | float]	A list of numerical parameters associated with the talent's effect at this level.

TalentUpgradeItem

Bases: BaseModel

Represents an item required for talent upgrades.

Attributes:

Name	Type	Description
id	int	The ID of the required item.
amount	int	The quantity of the item required.

Task

Bases: BaseModel

Represents a task or condition required to unlock a character quote.

Attributes:

Name	Type	Description
type	str	The type of task (e.g., "FETTER_TASK_FINISH_QUEST").
quest_list	list[Quest]	A list of quests associated with this task.

Upgrade

Bases: BaseModel

Represents upgrade information for a character or weapon type.

Attributes:

Name	Type	Description
id	str	The ID of the character or weapon.
name	str | None	The name of the character or weapon (optional).
icon	str	The icon URL of the character or weapon.
items	list[UpgradeItem]	A list of items required for the upgrade.

UpgradeData

Bases: BaseModel

Container for character and weapon upgrade data.

Attributes:

Name	Type	Description
character	list[Upgrade]	A list of character upgrade information.
weapon	list[Upgrade]	A list of weapon upgrade information.

UpgradeItem

Bases: BaseModel

Represents an item required for an upgrade.

Attributes:

Name	Type	Description
id	int	The item's ID.
rarity	int	The item's rarity.

Weapon

Bases: BaseModel

Represents a weapon summary.

Attributes:

Name	Type	Description
id	int	The unique ID of the weapon.
rarity	int	The rarity rank of the weapon (1 to 5).
type	str	The type identifier string for the weapon (e.g., "WEAPON_SWORD_ONE_HAND").
name	str	The name of the weapon.
icon	str	The icon URL for the weapon.
route	str	The route identifier for the weapon.

WeaponAffix

Bases: BaseModel

Represents a weapon's affix (passive ability).

Attributes:

Name	Type	Description
name	str	The name of the affix.
upgrades	list[WeaponAffixUpgrade]	A list detailing the affix effect at each refinement level.

WeaponAffixUpgrade

Bases: BaseModel

Represents an upgrade level (refinement) for a weapon affix (passive ability).

Attributes:

Name	Type	Description
level	int	The refinement level (1 to 5).
description	str	The description of the affix effect at this refinement level.

WeaponAscensionMaterial

Bases: BaseModel

Represents a material required for weapon ascension.

Attributes:

Name	Type	Description
id	int	The ID of the ascension material.
rarity	int	The rarity rank of the material.

WeaponBaseStat

Bases: BaseModel

Represents a base stat of a weapon and its growth type.

Attributes:

Name	Type	Description
prop_type	str | None	The identifier string for the stat (e.g., "FIGHT_PROP_BASE_ATTACK", "FIGHT_PROP_CRITICAL"). Optional.
init_value	float	The initial value of the stat at level 1.
growth_type	str	The identifier string for the stat's growth curve (e.g., "GROW_CURVE_ATTACK_101").

WeaponDetail

Bases: BaseModel

Represents detailed information about a weapon.

Attributes:

Name	Type	Description
id	int	The unique ID of the weapon.
rarity	int	The rarity rank of the weapon (1 to 5).
type	str	The type identifier string for the weapon (e.g., "WEAPON_SWORD_ONE_HAND").
name	str	The name of the weapon.
description	str	The flavor text or description of the weapon.
icon	str	The icon URL for the weapon.
story_id	int | None	The ID related to the weapon's story (optional).
affix	WeaponAffix | None	The weapon's passive ability (affix) details (optional).
route	str	The route identifier for the weapon.
upgrade	WeaponUpgrade	Information about the weapon's stats, ascension, and refinement costs.
ascension_materials	list[WeaponAscensionMaterial]	A list of materials required for ascension.

WeaponPromote

Bases: BaseModel

Represents a weapon promotion (ascension) level.

Attributes:

Name	Type	Description
unlock_max_level	int	The maximum weapon level unlocked after this promotion.
promote_level	int	The ascension phase number (e.g., 1 for first ascension).
cost_items	list[WeaponPromoteCostItem] | None	A list of materials required for this promotion (optional).
coin_cost	int | None	The Mora cost for this promotion (optional).
required_player_level	int | None	The minimum Adventure Rank required for this promotion (optional).
add_stats	list[WeaponPromoteStat] | None	A list of stat bonuses granted by this promotion (optional).

WeaponPromoteCostItem

Bases: BaseModel

Represents an item required for weapon promotion (ascension).

Attributes:

Name	Type	Description
id	int	The ID of the required item.
amount	int	The quantity of the item required.

WeaponPromoteStat

Bases: BaseModel

Represents a stat bonus gained from weapon promotion (ascension).

Attributes:

Name	Type	Description
id	str	The identifier string for the stat (e.g., "FIGHT_PROP_ATTACK").
value	float	The value of the stat bonus.

WeaponUpgrade

Bases: BaseModel

Represents the upgrade details (stats, promotions, awaken cost) of a weapon.

Attributes:

Name	Type	Description
awaken_cost	list[int]	A list of Mora costs for each refinement level (?).
base_stats	list[WeaponBaseStat]	A list of the weapon's base stats and their growth types.
promotes	list[WeaponPromote]	A list of promotion (ascension) levels and their details.