Models

`Agent`

Bases: BaseModel

Represents a ZZZ agent (character).

Attributes:

Name	Type	Description
`id`	`int`	The ID of the agent.
`uid`	`int`	The unique identifier of the agent.
`level`	`int`	The level of the agent.
`promotion`	`Literal[1, 2, 3, 4, 5, 6]`	The promotion level of the agent.
`mindscape`	`Literal[0, 1, 2, 3, 4, 5, 6]`	The mindscape level of the agent.
`skin_id`	`int \| None`	The ID of the agent's skin.
`core_skill_level_num`	`int`	The core skill level number of the agent.
`is_sig_engine_effect_on`	`bool \| None`	Whether the signature engine effect is on.
`obtained_at`	`datetime`	The time when the agent was obtained, in server timezone.
`skills`	`list[AgentSkill]`	List of skills for the agent.
`discs`	`list[DriveDisc]`	List of drive discs equipped by the agent.
`w_engine`	`WEngine \| None`	The W-Engine associated with the agent.
`name`	`str`	The name of the agent.
`rarity_num`	`int`	The rarity number of the agent.
`elements`	`list[Element]`	List of elements associated with the agent.
`icon`	`AgentIcon`	The icon of the agent.
`sig_engine_id`	`int`	The ID of the signature W-Engine.
`color`	`AgentColor \| None`	The color scheme of the agent.
`highlight_stats`	`list[StatType]`	List of stats that are highlighted in the agent menu.
`stats`	`dict[AgentStatType, AgentStat]`	Dictionary of stats for the agent.

`core_skill_level` `property`

The agent's core skill level.

`rarity` `property`

The agent's rarity.

`AgentColor`

Bases: BaseModel

Represents a ZZZ agent's color scheme.

Attributes:

Name	Type	Description
`accent`	`str`	The accent color of the agent.
`mindscape`	`str`	The mindscape color of the agent.

`AgentIcon`

Bases: BaseModel

Represents a ZZZ character's icon.

Attributes:

Name	Type	Description
`filename`	`str`	Should be "IconRoleXX", parsed from "image" property.

`image` `property`

Character's full image.

e.g. https://enka.network/ui/zzz/IconRole13.png

`round` `property`

Character's icon in circle/rounded shape.

e.g. https://enka.network/ui/zzz/IconRoleCircle13.png

`select` `property`

Character's icon in the select screen.

e.g. https://api.hakush.in/zzz/UI/IconRoleSelect13.webp

`AgentSkill`

Bases: BaseModel

Represents a ZZZ agent's skill.

Attributes:

Name	Type	Description
`level`	`int`	The level of the skill.
`type`	`SkillType`	The type of the skill.

`AgentStat`

Bases: Stat

Represents an agent's stat.

Attributes:

Name	Type	Description
`type`	`AgentStatType`	The type of the stat.
`value`	`int`	The value of the stat.
`name`	`str`	The name of the stat.
`format`	`str`	The format specifier.

`Build`

Bases: BaseBuild[Agent]

Represents a ZZZ build.

Attributes:

Name	Type	Description
`id`	`int`	The build's ID.
`name`	`str`	The build's name.
`order`	`Decimal`	The build's order.
`live`	`bool`	Whether the build is live.
`character_id`	`int`	The build's character ID.
`character`	`C`	The build's character data.

`DriveDisc`

Bases: BaseModel

Represents a drive disc.

Attributes:

Name	Type	Description
`slot`	`Literal[1, 2, 3, 4, 5, 6]`	The slot number of the drive disc.
`id`	`int`	The ID of the drive disc.
`uid`	`int`	The unique identifier of the drive disc.
`level`	`int`	The level of the drive disc.
`roll_times`	`int`	The number of times random stats are being rolled.
`main_stat`	`DriveDiscStat`	The main stat of the drive disc.
`sub_stats`	`list[DriveDiscStat]`	List of sub-stats of the drive disc.
`is_locked`	`bool`	Whether the drive disc is marked as locked in-game.
`is_trash`	`bool`	Whether the drive disc is marked as trash in-game.
`rarity_num`	`int`	The rarity number of the drive disc.
`set_id`	`int`	The set ID of the drive disc.

`rarity` `property`

The drive disc's rarity.

`DriveDiscStat`

Bases: Stat

Represents a drive disc's stat.

Attributes:

Name	Type	Description
`type`	`StatType`	The type of the stat.
`roll_times`	`int`	The number of times the stat has been rolled.
`value`	`int`	The value of the stat.
`name`	`str`	The name of the stat.
`format`	`str`	The format specifier.

`Medal`

Bases: BaseModel

Represents a medal obtained by a player in ZZZ.

Attributes:

Name	Type	Description
`value`	`int`	The value associated with the medal.
`type`	`int`	The type identifier of the medal.
`icon_id`	`int`	The identifier for the medal's icon.

`Namecard`

Bases: BaseModel

Represents a namecard obtained by a player in ZZZ.

Attributes:

Name	Type	Description
`id`	`int`	The unique identifier for the name card.
`icon`	`str`	The icon associated with the name card.

`Player`

Bases: BaseModel

Represents a ZZZ player's profile information.

Attributes:

Name	Type	Description
`medals`	`list[Medal]`	List of medals obtained by the player.
`nickname`	`str`	The player's in-game nickname.
`avatar_id`	`int`	The ID of the player's selected avatar.
`uid`	`int`	The player's unique identifier.
`level`	`int`	The player's current level.
`signature`	`str`	The player's custom signature or description.
`title`	`Title \| None`	The player's title.
`id`	`int`	The player's profile ID.
`namecard_id`	`int`	The ID of the player's namecard.
`namecard`	`Namecard`	The player's namecard.

`title_id` `property`

(Deprecated) The ID of the player's selected title.

`ShowcaseResponse`

Bases: BaseModel

Represents a ZZZ player's showcase information.

Attributes:

Name	Type	Description
`agents`	`list[Agent]`	List of agents (characters) in the player's showcase.
`player`	`Player`	The player's profile information.
`uid`	`int`	The player's unique identifier.
`ttl`	`int`	The time-to-live for the showcase data.

`url` `property`

The URL of the showcase.

`Stat`

Bases: BaseModel

Represents a agent's or W-Engine's stat.

Attributes:

Name	Type	Description
`type`	`StatType`	The type of the stat.
`value`	`int`	The value of the stat.
`name`	`str`	The name of the stat.
`format`	`str`	The format specifier.

`formatted_value` `property`

The formatted value of the stat.

`Title`

Bases: BaseModel

Represents a title obtained by a player in ZZZ.

Attributes:

Name	Type	Description
`id`	`int`	The unique identifier for the title.
`name`	`int`	The name of the title (e.g., "Cooked More Than a Hamburger").
`color1`	`str`	The primary color associated with the title (e.g., "#e6e9ea").
`color2`	`str`	The secondary color associated with the title (e.g., "#8ea3ae").

`WEngine`

Bases: BaseModel

Represents a W-Engine.

Attributes:

Name	Type	Description
`id`	`int`	The ID of the W-Engine.
`uid`	`int`	The unique identifier of the W-Engine.
`level`	`int`	The level of the W-Engine.
`modification`	`Literal[0, 1, 2, 3, 4, 5]`	The modification level of the W-Engine.
`phase`	`Literal[1, 2, 3, 4, 5]`	The phase level of the W-Engine.
`is_locked`	`bool`	Whether the W-Engine is marked as locked in-game.
`rarity_num`	`int`	The rarity number of the W-Engine.
`name`	`str`	The name of the W-Engine.
`specialty`	`ProfessionType`	The specialty of the W-Engine.
`icon`	`str`	The icon of the W-Engine.
`main_stat`	`Stat`	The main stat of the W-Engine.
`sub_stat`	`Stat`	The sub-stat of the W-Engine.

`rarity` `property`

The W-Engine's rarity.

Models

Agent

core_skill_level property

rarity property

AgentColor

AgentIcon

image property

round property

select property

AgentSkill

AgentStat

Build

DriveDisc

rarity property

DriveDiscStat

Medal

Namecard

Player

title_id property

ShowcaseResponse

url property

Stat

formatted_value property

Title

WEngine

rarity property

`Agent`

`core_skill_level` `property`

`rarity` `property`

`AgentColor`

`AgentIcon`

`image` `property`

`round` `property`

`select` `property`

`AgentSkill`

`AgentStat`

`Build`

`DriveDisc`

`rarity` `property`

`DriveDiscStat`

`Medal`

`Namecard`

`Player`

`title_id` `property`

`ShowcaseResponse`

`url` `property`

`Stat`

`formatted_value` `property`

`Title`

`WEngine`

`rarity` `property`