API Reference

BaseSkill

Bases: BaseModel

Represent a base skill or a trace node in the character's skill tree.

Attributes:

Name	Type	Description
id	int	The unique identifier for the skill or trace node.
name	str | None	The name of the skill or trace node (optional for some traces).
description	str | None	The description of the skill or trace node (optional for some traces).
point_type	str	The type of point in the skill tree.
point_position	str	The position identifier within the skill tree.
max_level	int	The maximum level this skill or trace can reach.
is_default	bool	Whether this skill/trace is unlocked by default.
avatar_level_limit	int | None	The character level required to unlock this trace (optional).
avatar_promotion_limit	int | None	The character ascension rank required to unlock this trace (optional).
skill_list	list[SkillListSkill]	Detailed information if this node represents a main skill (Basic ATK, Skill, etc.).
status_list	list[Status]	List of status effects or stat bonuses granted by this trace node.
icon	str	The URL to the icon for this skill or trace node.
params	dict[str, list[float]] | None	Parameters used for scaling (optional).
promote	list[SkillPromote]	List of promotion costs for leveling up this skill or trace.

Book

Bases: BaseModel

Represent basic information about a book.

Attributes:

Name	Type	Description
id	int	The ID of the book.
name	str	The name of the book.
world_type	int	The numeric ID representing the type of world the book is associated with.
chapter_count	int	The number of chapters in the book.
icon	str	The URL of the book's icon.
route	str	The API route for this book.

BookDetail

Bases: BaseModel

Represent detailed information about a book.

Attributes:

Name	Type	Description
id	int	The ID of the book.
name	str	The name of the book.
world_type	str	The type of world the book is associated with.
chapter_count	int	The number of chapters in the book.
icon	str	The URL of the book's icon.
description	str	The description of the book.
series	list[BookSeries]	A list of book series entries contained within this book.

BookSeries

Bases: BaseModel

Represent a book series.

Attributes:

Name	Type	Description
id	int	The ID of the series.
name	str	The name of the series.
story	str	The story or description of the series.
image_list	list[str]	A list of image URLs associated with the series.

Changelog

Bases: BaseModel

Represent a changelog entry for a specific version.

Attributes:

Name	Type	Description
id	int	The unique identifier for the changelog entry.
version	str	The version string associated with these changes.
categories	list[ChangelogCategory]	A list of categories detailing the changes.
beta	bool	Whether this changelog pertains to a beta version.

ChangelogCategory

Bases: BaseModel

Represent a category of changes within a changelog entry.

Attributes:

Name	Type	Description
category	str	The name of the category (e.g., "avatar", "equipment").
item_ids	list[int]	A list of item IDs that were changed within this category.

Character

Bases: BaseModel

Represent basic information about a character.

Attributes:

Name	Type	Description
id	int	The unique identifier for the character.
name	str	The name of the character.
rarity	int	The rarity (star rating) of the character.
icon	str	The URL to the character's standard avatar icon.
types	CharacterType	Container for the character's Path and Combat Type enums.
route	str	The API route for this character.
beta	bool	Whether the character is currently in beta.
release_at	datetime | None	Datetime object representing the release timestamp (optional).

large_icon property

Return the URL to the large-sized avatar icon (full splash art).

medium_icon property

Return the URL to the medium-sized avatar icon.

round_icon property

Return the URL to the round avatar icon.

CharacterAscensionItem

Bases: BaseModel

Represent an item and amount required for character ascension.

Attributes:

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

CharacterCostItem

Bases: BaseModel

Represent an item and amount required for character level upgrades.

Attributes:

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

CharacterDetail

Bases: BaseModel

Represent detailed information about a character.

Attributes:

Name	Type	Description
id	int	The unique identifier for the character.
name	str	The name of the character.
beta	bool	Whether the character is currently in beta.
rarity	int	The rarity (star rating) of the character.
types	CharacterDetailTypes	The Path and Combat Type details of the character.
icon	str	The URL to the character's standard avatar icon.
release	int	Timestamp of the character's release (may be 0 if unreleased or unknown).
route	str	The API route for this character.
info	CharacterInfo	Additional fetter information (description, faction, VAs).
upgrades	list[CharacterUpgrade]	A list of ascension details for each rank.
traces	CharacterTraces	Container for all skill and trace information.
eidolons	list[CharacterEidolon]	A list of the character's Eidolons.
ascension	list[CharacterAscensionItem]	A list of materials required for ascension across all ranks.
script	CharacterScript	Container for character stories and voice lines.
release_at	datetime | None	Datetime object representing the release timestamp (optional).

large_icon property

Return the URL to the large-sized avatar icon (full splash art).

medium_icon property

Return the URL to the medium-sized avatar icon.

round_icon property

Return the URL to the round avatar icon.

CharacterDetailType

Bases: BaseModel

Represent either the Path or Combat Type with its ID and name.

Attributes:

Name	Type	Description
id	str	The identifier string (e.g., "Warrior", "Ice").
name	str	The display name (e.g., "Destruction", "Ice").

CharacterDetailTypes

Bases: BaseModel

Contain the character's Path and Combat Type details.

Attributes:

Name	Type	Description
path_type	CharacterDetailType	The character's Path details.
combat_type	CharacterDetailType	The character's Combat Type details.

CharacterEidolon

Bases: BaseModel

Represent a character Eidolon.

Attributes:

Name	Type	Description
id	int	The unique identifier for the Eidolon.
rank	int	The rank of the Eidolon (1-6).
name	str	The name of the Eidolon.
params	list[int | float] | None	Parameters used for placeholder replacement in the description.
description	str	The formatted description of the Eidolon's effect.
skill_add_level_list	list[SkillAdd]	List of skills whose levels are increased by this Eidolon.
icon	str	The URL to the Eidolon's icon.

skill_add_level_list = Field(alias='skillAddLevelList') class-attribute instance-attribute

List of skills that increase their level because of this eidolon

CharacterInfo

Bases: BaseModel

Represent additional information about a character (fetter info).

Attributes:

Name	Type	Description
faction	str | None	The faction or affiliation of the character (optional).
description	str	A general description or profile of the character.
voice_actors	list[VoiceActor]	A list of voice actors for different languages.

CharacterScript

Bases: BaseModel

Contain character stories and voice lines.

Attributes:

Name	Type	Description
stories	list[CharacterStory]	A list of character story sections.
voices	list[CharacterVoice]	A list of character voice lines.

CharacterStory

Bases: BaseModel

Represent a piece of character story/lore.

Attributes:

Name	Type	Description
title	str	The title of the story section.
text	str	The content of the story section.

CharacterTraces

Bases: BaseModel

Contain all character traces (skills and passive abilities).

Attributes:

Name	Type	Description
main_skills	list[BaseSkill]	List of main skills (Basic ATK, Skill, Ultimate, Talent).
sub_skills	list[BaseSkill]	List of passive trace nodes (stat bonuses, extra abilities).
tree_skills	list[SkillTree]	List representing the structure and connections of the skill trees.

CharacterType

Bases: BaseModel

Contain the character's Path and Combat Type enums.

Attributes:

Name	Type	Description
path_type	PathType	The character's Path enum.
combat_type	CombatType	The character's Combat Type enum.

CharacterUpgrade

Bases: BaseModel

Represent the details for a specific character ascension rank.

Attributes:

Name	Type	Description
level	int	The ascension rank (0-indexed).
cost_items	list[CharacterCostItem]	A list of items required for this ascension.
max_level	int	The maximum character level achievable after this ascension.
required_player_level	int	The Trailblaze Level required for this ascension.
required_world_level	int	The Equilibrium Level required for this ascension.
skill_base	dict[str, int | float]	Base stats of the character at this ascension rank (level 1 of the rank).
skill_add	dict[str, int | float]	Additional stats gained per level within this ascension rank.

CharacterVoice

Bases: BaseModel

Represent a character voice line.

Attributes:

Name	Type	Description
title	str	The title or trigger condition of the voice line.
text	str	The transcribed text of the voice line.
audio	int | None	The ID or reference to the audio file (optional).

Contact

Bases: BaseModel

Represent a message contact.

Attributes:

Name	Type	Description
name	str	The name of the contact.
signature	str | None	The signature of the contact (optional).
type	int	The type identifier of the contact.
icon	str	The URL to the contact's avatar icon.

ExtraEffect

Bases: BaseModel

Represent an extra effect associated with a skill.

Attributes:

Name	Type	Description
name	str	The name of the extra effect.
description	str	The description of the extra effect.
icon	str	The URL to the icon for the extra effect.

Item

Bases: BaseModel

Represent basic information about an item.

Attributes:

Name	Type	Description
id	int	The unique identifier for the item.
name	str	The name of the item.
beta	bool	Whether the item is currently in beta.
rarity	int	The rarity (star rating) of the item.
type	int	The numeric ID representing the item type.
tags	list[str]	A list of tags associated with the item.
icon	str	The URL to the item's icon.
route	str	The API route for this item.

ItemDetail

Bases: BaseModel

Represent detailed information about an item.

Attributes:

Name	Type	Description
id	int	The unique identifier for the item.
name	str	The name of the item.
beta	bool	Whether the item is currently in beta.
rarity	int	The rarity (star rating) of the item.
tags	list[str]	A list of tags associated with the item.
icon	str	The URL to the item's icon.
route	str	The API route for this item.
description	str	The functional description of the item.
story	str | None	The lore or background story of the item (optional).
sources	list[ItemSource]	A list of sources where this item can be obtained.

ItemSource

Bases: BaseModel

Represent a source from which an item can be obtained.

Attributes:

Name	Type	Description
description	str	A description of the source (e.g., "Omni-Synthesizer").
recipes	list[Recipe]	A list of recipes associated with this source.

ItemType

Bases: BaseModel

Represent the type of an item.

Attributes:

Name	Type	Description
id	int	The numeric ID of the item type.
name	str	The display name of the item type.

LightCone

Bases: BaseModel

Represent basic information about a light cone.

Attributes:

Name	Type	Description
id	int	The unique identifier for the light cone.
name	str	The name of the light cone.
beta	bool	Whether the light cone is currently in beta.
rarity	int	The rarity (star rating) of the light cone.
icon	str	The URL to the light cone's standard icon.
type	str	The identifier string for the path type (e.g., "Warrior").
is_sellable	bool	Whether the light cone can be sold.
route	str	The API route for this light cone.

large_icon property

Return the URL to the large-sized icon.

medium_icon property

Return the URL to the medium-sized icon.

LightConeAscensionMaterial

Bases: BaseModel

Represent a material required for light cone ascension.

Attributes:

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

LightConeCostItem

Bases: BaseModel

Represent an item and its amount required for upgrading a light cone.

Attributes:

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

LightConeDetail

Bases: BaseModel

Represent detailed information about a light cone.

Attributes:

Name	Type	Description
id	int	The unique identifier for the light cone.
name	str	The name of the light cone.
beta	bool	Whether the light cone is currently in beta.
rarity	int	The rarity (star rating) of the light cone.
type	LightConePathType	The path type of the light cone.
icon	str	The URL to the light cone's standard icon.
is_sellable	bool	Whether the light cone can be sold.
route	str	The API route for this light cone.
description	str	The lore or background description of the light cone.
upgrades	list[LightConeUpgrade]	A list of ascension details for each rank.
skill	LightConeSkill	The skill details of the light cone.
ascension_materials	list[LightConeAscensionMaterial]	A list of materials required for ascension across all ranks.

large_icon property

Return the URL to the large-sized icon.

medium_icon property

Return the URL to the medium-sized icon.

LightConePathType

Bases: BaseModel

Represent the path type of a light cone.

Attributes:

Name	Type	Description
id	str	The identifier string for the path type (e.g., "Warrior").
name	str	The display name of the path type (e.g., "Destruction").

LightConeSkill

Bases: BaseModel

Represent the skill of a light cone.

Attributes:

Name	Type	Description
name	str	The name of the light cone skill.
description	str	The description of the light cone skill.
params	dict[str, list[int | float]]	Parameters associated with the skill's effects, often scaling with superimposition.

LightConeUpgrade

Bases: BaseModel

Represent the details for a specific ascension level of a light cone.

Attributes:

Name	Type	Description
level	int	The ascension level (0-indexed).
cost_items	list[LightConeCostItem]	A list of items required for this ascension.
max_level	int	The maximum character level achievable after this ascension.
required_player_level	int	The Trailblaze Level required for this ascension.
required_world_level	int	The Equilibrium Level required for this ascension.
skill_base	dict[str, int | float]	Base stats provided by the light cone at this ascension.
skill_add	dict[str, int | float]	Additional stats gained per level within this ascension rank.

Message

Bases: BaseModel

Represent a message thread or conversation.

Attributes:

Name	Type	Description
id	int	The unique identifier for the message thread.
contact	Contact	The contact associated with this message thread.
section_count	int	The number of sections or messages in the thread.
route	str | None	The API route for this message thread (optional).

Recipe

Bases: BaseModel

Represent a recipe to craft or obtain an item.

Attributes:

Name	Type	Description
coin_cost	int	The amount of credits required.
required_world_level	int	The Equilibrium Level required to use this recipe.
materials	list[RecipeMaterial]	A list of standard materials required.
special_materials	list[RecipeMaterial]	A list of special materials required (e.g., event currency).

RecipeMaterial

Bases: BaseModel

Represent a material required for a recipe.

Attributes:

Name	Type	Description
id	int	The ID of the material item.
rarity	int	The rarity of the material item.
icon	str	The URL to the material item's icon.
amount	int	The amount of the material required.

Relic

Bases: BaseModel

Represent a single relic piece.

Attributes:

Name	Type	Description
pos	str	The position/slot of the relic (e.g., "HEAD", "HAND").
name	str	The name of the relic piece.
description	str	The description of the relic piece.
story	str	The lore or story associated with the relic piece.
icon	str	The URL to the relic piece's icon.

RelicSet

Bases: BaseModel

Represent basic information about a relic set.

Attributes:

Name	Type	Description
id	int	The unique identifier for the relic set.
name	str	The name of the relic set.
beta	bool	Whether the relic set is currently in beta.
icon	str	The URL to the relic set's icon.
rarity_list	list[int]	A list of rarities this set is available in.
is_planar_suit	bool	Whether the set is a Planar Ornament set.
route	str	The API route for this relic set.

RelicSetDetail

Bases: BaseModel

Represent detailed information about a relic set.

Attributes:

Name	Type	Description
id	int	The unique identifier for the relic set.
name	str	The name of the relic set.
icon	str	The URL to the relic set's icon.
rarity_list	list[int]	A list of rarities this set is available in.
is_planar_suit	bool	Whether the set is a Planar Ornament set.
route	str	The API route for this relic set.
beta	bool	Whether the relic set is currently in beta.
set_effects	SetEffects	The 2-piece and 4-piece effects of the set.
relics	list[Relic]	A list of individual relic pieces belonging to this set.

SetEffect

Bases: BaseModel

Represent a set effect for a relic set.

Attributes:

Name	Type	Description
params	dict[str, list[int | float]] | None	Parameters used in the description placeholder replacement.
description	str	The formatted description of the set effect.

SetEffects

Bases: BaseModel

Contain the 2-piece and 4-piece set effects.

Attributes:

Name	Type	Description
two_piece	SetEffect	The effect activated when 2 pieces of the set are equipped.
four_piece	SetEffect | None	The effect activated when 4 pieces of the set are equipped (optional).

SkillAdd

Bases: BaseModel

Represent a skill level increase granted by an Eidolon.

Attributes:

Name	Type	Description
id	int	ID of the skill whose level is increased.
level	int	The number of levels added to the skill.

id instance-attribute

ID of the skill

level instance-attribute

Level added to the skill

SkillListSkill

Bases: BaseModel

Represent detailed information about a specific character skill (Basic ATK, Skill, Ultimate, Talent).

Attributes:

Name	Type	Description
id	int	The unique identifier for the skill.
name	str	The name of the skill.
tag	str | None	A tag associated with the skill (e.g., "Single Target").
type	str	The type of the skill (e.g., "Basic ATK", "Skill", "Ultimate", "Talent").
max_level	int	The maximum level this skill can reach.
skill_points	list[SkillPoint]	Information about skill point generation/consumption.
weakness_break	list[WeaknessBreak]	Information about toughness damage dealt.
description	str | None	The detailed description of the skill (may contain placeholders).
simplified_description	str | None	A simplified description of the skill.
traces	list[int]	List of trace IDs related to this skill.
eidolons	list[int]	List of Eidolon IDs related to this skill.
extra_effects	list[ExtraEffect]	List of extra effects associated with this skill.
attack_type	str | None	The attack type (e.g., "Normal", "AoE").
damage_type	str | None	The damage type (e.g., "Physical", "Fire").
icon	str	The URL to the skill's icon.
params	dict[str, list[float]] | None	Parameters used for scaling and placeholder replacement in descriptions.

SkillPoint

Bases: BaseModel

Represent skill point generation or consumption by a skill.

Attributes:

Name	Type	Description
type	str	The type of skill point interaction (e.g., "SkillPoint", "EnergyGenerate").
value	int | None	The amount of skill points generated (positive) or consumed (negative), or energy generated.

SkillPromote

Bases: BaseModel

Represent the cost to promote (level up) a skill/trace to a specific level.

Attributes:

Name	Type	Description
level	int	The target level for the promotion.
cost_items	list[SkillPromoteCostItem]	A list of items required for this promotion.

SkillPromoteCostItem

Bases: BaseModel

Represent an item and amount required for promoting (leveling up) a skill/trace.

Attributes:

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

SkillTree

Bases: BaseModel

Represent a skill tree structure for a character.

Attributes:

Name	Type	Description
id	int	The identifier for this skill tree.
type	str	The type of skill tree.
tree	list[SkillTreeSkill]	A list of skills/connections within the tree.

SkillTreeSkill

Bases: BaseModel

Represent a connection or node within a skill tree structure.

Attributes:

Name	Type	Description
id	int	The ID of the skill/trace node this connection points to or represents.
points_direction	str | None	The direction of the connection (optional).
points	list[int]	A list of connected skill/trace node IDs.

Status

Bases: BaseModel

Represent a status effect or stat bonus granted by a trace node.

Attributes:

Name	Type	Description
name	str	The name of the status or stat (e.g., "HPAddedRatio").
value	int | float	The value of the status or stat bonus.
icon	str	The URL to the icon representing the status or stat.

VoiceActor

Bases: BaseModel

Represent a voice actor for a specific language.

Attributes:

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

WeaknessBreak

Bases: BaseModel

Represent the toughness damage dealt by a skill.

Attributes:

Name	Type	Description
type	str	The type of weakness break (e.g., "Skill").
value	int	The amount of toughness damage dealt.