Models

zzz

Modules:

• build –
• character –
• icon –
• player –
• response –

Classes:

• Agent –

  Represents a ZZZ agent (character).

• AgentColor –

  Represents a ZZZ agent's color scheme.

• AgentIcon –

  Represents a ZZZ character's icon.

• AgentSkill –

  Represents a ZZZ agent's skill.

• AgentStat –

  Represents an agent's stat.

• Build –

  Represents a ZZZ build.

• DriveDisc –

  Represents a drive disc.

• DriveDiscStat –

  Represents a drive disc's stat.

• Medal –

  Represents a medal obtained by a player in ZZZ.

• Namecard –

  Represents a namecard obtained by a player in ZZZ.

• Player –

  Represents a ZZZ player's profile information.

• ShowcaseResponse –

  Represents a ZZZ player's showcase information.

• Stat –

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

• Title –

  Represents a title obtained by a player in ZZZ.

• WEngine –

  Represents a W-Engine.

Agent pydantic-model

Represents a ZZZ agent (character).

Attributes:

• 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.

• potential_id (int) –

  The ID of the agent's Potential.

• 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.

Fields:

• id (int)
• level (int)
• promotion (Literal[1, 2, 3, 4, 5, 6])
• mindscape (Literal[0, 1, 2, 3, 4, 5, 6])
• skin_id (int | None)
• core_skill_level_num (int)
• is_sig_engine_effect_on (bool | None)
• obtained_at (datetime)
• skills (list[AgentSkill])
• discs (list[DriveDisc])
• w_engine (WEngine | None)
• potential_id (int)
• name (str)
• rarity_num (int)
• elements (list[Element])
• icon (AgentIcon)
• sig_engine_id (int)
• color (AgentColor | None)
• highlight_stats (list[StatType])
• stats (dict[AgentStatType, AgentStat])
• specialty (ProfessionType)

Validators:

• __convert_is_sig_engine_effect_on → is_sig_engine_effect_on
• __convert_skin_id → skin_id
• __convert_color → color

color pydantic-field

color: AgentColor | None = None

core_skill_level property

core_skill_level: Literal['A', 'B', 'C', 'D', 'E', 'F']

The agent's core skill level.

core_skill_level_num pydantic-field

core_skill_level_num: int

discs pydantic-field

discs: list[DriveDisc]

elements pydantic-field

elements: list[Element]

highlight_stats pydantic-field

highlight_stats: list[StatType]

icon pydantic-field

icon: AgentIcon = None

id pydantic-field

id: int

is_sig_engine_effect_on pydantic-field

is_sig_engine_effect_on: bool | None

level pydantic-field

level: int

mindscape pydantic-field

mindscape: Literal[0, 1, 2, 3, 4, 5, 6]

name pydantic-field

name: str = ''

obtained_at pydantic-field

obtained_at: datetime

potential property

potential: int

The agent's potential level, 0 means this character has none.

potential_id pydantic-field

potential_id: int = 0

promotion pydantic-field

promotion: Literal[1, 2, 3, 4, 5, 6]

rarity property

rarity: Literal['S', 'A', 'B', '?']

The agent's rarity.

rarity_num pydantic-field

rarity_num: int = 0

sig_engine_id pydantic-field

sig_engine_id: int = 0

skills pydantic-field

skills: list[AgentSkill]

skin_id pydantic-field

skin_id: int | None

specialty pydantic-field

specialty: ProfessionType = UNKNOWN

stats pydantic-field

stats: dict[AgentStatType, AgentStat]

w_engine pydantic-field

w_engine: WEngine | None = None

AgentColor pydantic-model

Represents a ZZZ agent's color scheme.

Attributes:

• accent (str) –

  The accent color of the agent.

• mindscape (str) –

  The mindscape color of the agent.

Fields:

• accent (str)
• mindscape (str)

accent pydantic-field

accent: str

mindscape pydantic-field

mindscape: str

AgentIcon pydantic-model

Represents a ZZZ character's icon.

Attributes:

• filename (str) –

  Should be "IconRoleXX", parsed from "image" property.

Fields:

• filename (str)

filename pydantic-field

filename: str

image property

image: str

Character's full image.

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

round property

round: str

Character's icon in circle/rounded shape.

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

select property

select: str

Character's icon in the select screen.

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

AgentSkill pydantic-model

Represents a ZZZ agent's skill.

Attributes:

• level (int) –

  The level of the skill.

• type (SkillType) –

  The type of the skill.

Fields:

• level (int)
• type (SkillType)

level pydantic-field

level: int

type pydantic-field

type: SkillType

AgentStat pydantic-model

Represents an agent's stat.

Attributes:

• 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.

Fields:

• value (int)
• name (str)
• format (str)
• format_type (Literal['default', 'ratio', 'delta'])
• type (AgentStatType)

type pydantic-field

type: AgentStatType

Build pydantic-model

Represents a ZZZ build.

Attributes:

• 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.

Fields:

• id (int)
• name (str)
• order (Decimal)
• live (bool)
• character_id (int)
• character (C)

DriveDisc pydantic-model

Represents a drive disc.

Attributes:

• 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.

Fields:

• slot (Literal[1, 2, 3, 4, 5, 6])
• id (int)
• uid (int)
• level (int)
• roll_times (int)
• main_stat (DriveDiscStat)
• sub_stats (list[DriveDiscStat])
• is_locked (bool)
• is_trash (bool)
• rarity_num (int)
• set_id (int)
• set_name (str)
• name (str)

Validators:

• __get_first_main_stat_value → main_stat
• __unnest_info

id pydantic-field

id: int

is_locked pydantic-field

is_locked: bool

is_trash pydantic-field

is_trash: bool

level pydantic-field

level: int

main_stat pydantic-field

main_stat: DriveDiscStat

name pydantic-field

name: str = ''

rarity property

rarity: Literal['S', 'A', 'B', '?']

The drive disc's rarity.

rarity_num pydantic-field

rarity_num: int = 0

roll_times pydantic-field

roll_times: int

set_id pydantic-field

set_id: int = 0

set_name pydantic-field

set_name: str = ''

slot pydantic-field

slot: Literal[1, 2, 3, 4, 5, 6]

sub_stats pydantic-field

sub_stats: list[DriveDiscStat]

uid pydantic-field

uid: int

DriveDiscStat pydantic-model

Represents a drive disc's stat.

Attributes:

• 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.

Fields:

• format_type (Literal['default', 'ratio', 'delta'])
• type (StatType)
• roll_times (int)
• value (int)
• name (str)
• format (str)

format pydantic-field

format: str = ''

name pydantic-field

name: str = ''

roll_times pydantic-field

roll_times: int

type pydantic-field

type: StatType

value pydantic-field

value: int

Medal pydantic-model

Represents a medal obtained by a player in ZZZ.

Attributes:

• 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.

Fields:

• value (int)
• type (int)
• icon_id (int)

icon_id pydantic-field

icon_id: int

type pydantic-field

type: int

value pydantic-field

value: int

Namecard pydantic-model

Represents a namecard obtained by a player in ZZZ.

Attributes:

• id (int) –

  The unique identifier for the name card.

• icon (str) –

  The icon associated with the name card.

Fields:

• id (int)
• icon (str)

icon pydantic-field

icon: str = ''

id pydantic-field

id: int

Player pydantic-model

Represents a ZZZ player's profile information.

Attributes:

• 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.

Fields:

• medals (list[Medal])
• nickname (str)
• avatar_id (int)
• uid (int)
• level (int)
• signature (str)
• title (Title | None)
• id (int)
• namecard_id (int)
• namecard (Namecard)
• avatar (str | None)

Validators:

• __unnest_info
• __validate_medals → medals
• __validate_title → title

avatar pydantic-field

avatar: str | None = None

avatar_id pydantic-field

avatar_id: int

id pydantic-field

id: int

level pydantic-field

level: int

medals pydantic-field

medals: list[Medal]

namecard pydantic-field

namecard: Namecard

namecard_id pydantic-field

namecard_id: int

nickname pydantic-field

nickname: str

signature pydantic-field

signature: str

title pydantic-field

title: Title | None

title_id property

title_id: int | None

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

uid pydantic-field

uid: int

ShowcaseResponse pydantic-model

Represents a ZZZ player's showcase information.

Attributes:

• 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.

Fields:

• agents (list[Agent])
• player (Player)
• owner (Owner | None)
• uid (int)
• ttl (int)

Validators:

• __get_agents → agents
• __unnest_info

agents pydantic-field

agents: list[Agent]

owner pydantic-field

owner: Owner | None = None

player pydantic-field

player: Player

ttl pydantic-field

ttl: int

uid pydantic-field

uid: int

url property

url: str

The URL of the showcase.

Stat pydantic-model

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

Attributes:

• 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.

Fields:

• type (StatType)
• value (int)
• name (str)
• format (str)
• format_type (Literal['default', 'ratio', 'delta'])

format pydantic-field

format: str

format_type pydantic-field

format_type: Literal['default', 'ratio', 'delta'] = 'default'

formatted_value property

formatted_value: str

The formatted value of the stat.

name pydantic-field

name: str

type pydantic-field

type: StatType

value pydantic-field

value: int

Title pydantic-model

Represents a title obtained by a player in ZZZ.

Attributes:

• 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").

Fields:

• id (int)
• text (str)
• color1 (str)
• color2 (str)

color1 pydantic-field

color1: str = ''

color2 pydantic-field

color2: str = ''

id pydantic-field

id: int

text pydantic-field

text: str = ''

WEngine pydantic-model

Represents a W-Engine.

Attributes:

• 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.

Fields:

• id (int)
• uid (int)
• level (int)
• modification (Literal[0, 1, 2, 3, 4, 5])
• phase (Literal[1, 2, 3, 4, 5])
• is_locked (bool)
• rarity_num (int)
• name (str)
• specialty (ProfessionType)
• icon (str)
• main_stat (Stat)
• sub_stat (Stat)

icon pydantic-field

icon: str = ''

id pydantic-field

id: int

is_locked pydantic-field

is_locked: bool

level pydantic-field

level: int

main_stat pydantic-field

main_stat: Stat = None

modification pydantic-field

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

name pydantic-field

name: str = ''

phase pydantic-field

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

rarity property

rarity: Literal['S', 'A', 'B', '?']

The W-Engine's rarity.

rarity_num pydantic-field

rarity_num: int = 0

specialty pydantic-field

specialty: ProfessionType = UNKNOWN

sub_stat pydantic-field

sub_stat: Stat = None

uid pydantic-field

uid: int