API Reference

Bangboo

Bases: APIModel

Represent a Zenless Zone Zero bangboo companion.

Bangboos are AI companions that assist agents in combat and exploration. They have different rarities, skills, and can be leveled up.

Attributes:

Name	Type	Description
id	int	Unique bangboo identifier.
icon	str	Bangboo icon image URL.
rarity	Literal['S', 'A'] | None	Bangboo rarity rank (S or A).
code_name	str	Bangboo code designation.
description	str	Bangboo description text.
name	str	Bangboo display name (may be empty).
names	dict[Literal['EN', 'JA', 'CHS', 'KO'], str]	Bangboo names in different languages.

BangbooAscension

Bases: APIModel

Represent bangboo ascension phase data.

Contains stat bonuses, level requirements, and materials needed for each bangboo ascension phase.

Attributes:

Name	Type	Description
max_hp	int	Maximum HP bonus at this phase.
attack	int	Attack stat bonus.
defense	int	Defense stat bonus.
max_level	int	Maximum level achievable in this phase.
min_level	int	Minimum level for this phase.
materials	list[ZZZMaterial]	Required materials for ascension.
extra_props	list[ZZZExtraProp]	Additional properties gained.

BangbooDetail

Bases: APIModel

Provide comprehensive bangboo information and progression data.

Contains complete bangboo details including stats, ascension data, skills, and all progression information.

Attributes:

Name	Type	Description
id	int	Unique bangboo identifier.
code_name	str	Bangboo code designation.
name	str	Bangboo display name.
description	str	Bangboo description text.
rarity	Literal['S', 'A']	Bangboo rarity rank (S or A).
icon	str	Bangboo icon image URL.
stats	dict[str, float]	Base stats dictionary.
ascensions	dict[str, BangbooAscension]	Ascension data by level (key starts from 1).
skills	dict[Literal['A', 'B', 'C'], dict[str, BangbooSkill]]	Skills organized by type (A, B, C).

BangbooSkill

Bases: APIModel

Represent a bangboo skill or ability.

Each bangboo has multiple skills that provide different effects and bonuses during gameplay.

Attributes:

Name	Type	Description
name	str	Skill name.
description	str	Skill effect description.
properties	list[str]	List of skill properties.
parameter	str	Skill parameter values.

CharaCoreSkillLevel

Bases: APIModel

Represent a single level of a character core skill.

Core skills are passive abilities that can be upgraded to provide enhanced effects and bonuses.

Attributes:

Name	Type	Description
level	int	Core skill level.
id	int	Unique core skill identifier.
names	list[str]	Skill names in different contexts.
descriptions	list[str]	Skill effect descriptions.

CharaSkillDescParam

Bases: APIModel

Represent a skill description parameter.

Contains parameter information for skill descriptions including names, descriptions, and numerical properties.

Attributes:

Name	Type	Description
name	str	Parameter name.
description	str	Parameter description.
params	dict[str, CharaSkillDescParamProp] | None	Dictionary of parameter properties.

CharaSkillDescParamProp

Bases: APIModel

Represent skill description parameter properties.

Contains numerical properties for skill parameter calculations including base values, growth rates, and formatting.

Attributes:

Name	Type	Description
main	int	Base parameter value.
growth	int	Growth rate per level.
format	str	Display formatting specification.

Character

Bases: APIModel

Represent a Zenless Zone Zero character (agent).

Contains basic character information including stats, element, specialty, and visual assets. Agents are the playable characters in ZZZ.

Attributes:

Name	Type	Description
id	int	Unique character identifier.
name	str	Character name/code.
rarity	Literal['S', 'A'] | None	Character rarity rank (S or A).
specialty	ZZZSpecialty	Character specialty type.
element	ZZZElement | None	Elemental attribute of the character.
attack_type	ZZZAttackType | None	Combat attack type.
image	str	Character portrait image URL.
en_description	str	English description text.
names	dict[Literal['EN', 'KO', 'CHS', 'JA'], str]	Character names in different languages.

icon property

Agent icon.

Example: https://api.hakush.in/zzz/UI/IconRoleSelect01.webp

phase_1_cinema_art property

Agent phase 1 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_1.webp

phase_2_cinema_art property

Agent phase 2 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_2.webp

phase_3_cinema_art property

Agent phase 3 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_3.webp

CharacterAscension

Bases: APIModel

Represent character ascension phase data.

Contains stat bonuses and material requirements for each character ascension phase.

Attributes:

Name	Type	Description
max_hp	int	Maximum HP bonus at this phase.
attack	int	Attack stat bonus.
defense	int	Defense stat bonus.
max_level	int	Maximum level achievable in this phase.
min_level	int	Minimum level for this phase.
materials	list[ZZZMaterial]	Required materials for ascension.

CharacterCoreSkill

Bases: APIModel

Represent a character's core skill progression system.

Core skills are passive abilities that provide ongoing benefits and can be upgraded through multiple levels.

Attributes:

Name	Type	Description
levels	dict[int, CharaCoreSkillLevel]	Core skill levels mapped by level number.
level_up_materials	dict[str, list[ZZZMaterial]] | None	Materials required for each upgrade level.

CharacterDetail

Bases: APIModel

Provide comprehensive character information and progression data.

Contains complete character details including stats, skills, ascension data, mindscape cinemas, and all progression information for a ZZZ agent.

Attributes:

Name	Type	Description
id	int	Unique character identifier.
image	str	Character portrait image URL.
name	str	Character display name.
code_name	str	Character code designation.
rarity	Literal['S', 'A'] | None	Character rarity rank (S or A).
specialty	CharacterProp	Character weapon specialty.
element	CharacterProp	Character elemental attribute.
attack_type	CharacterProp	Character combat attack type.
faction	CharacterProp	Character faction or camp.
gender	Literal['M', 'F']	Character gender (M or F).
info	CharacterInfo | None	Detailed character background information.
stats	dict[str, float]	Base character statistics.
mindscape_cinemas	list[MindscapeCinema]	Character mindscape cinema upgrades.
ascension	list[CharacterAscension]	Character ascension phase data.
extra_ascension	list[CharacterExtraAscension]	Additional ascension bonuses.
skills	dict[ZZZSkillType, CharacterSkill]	Character skills by type.
passive	CharacterCoreSkill	Character core passive skill.

icon property

Character icon.

Example: https://api.hakush.in/zzz/UI/IconRoleSelect01.webp

phase_1_cinema_art property

Agent phase 1 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_1.webp

phase_2_cinema_art property

Agent phase 2 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_2.webp

phase_3_cinema_art property

Agent phase 3 mindscape cinema art.

Example: https://api.hakush.in/zzz/UI/Mindscape_1041_3.webp

CharacterExtraAscension

Bases: APIModel

Represent character bonus ascension data.

Contains additional ascension bonuses and properties that are granted beyond the standard ascension phases.

Attributes:

Name	Type	Description
max_level	int	Maximum level for this bonus phase.
props	list[ZZZExtraProp]	Additional properties and bonuses gained.

CharacterInfo

Bases: APIModel

Contain detailed character lore and background information.

Provides extensive character details including personal information, impressions, descriptions, and unlock requirements.

Attributes:

Name	Type	Description
birthday	str	Character birth date.
full_name	str	Character's complete name.
gender	str	Character gender.
female_impression	str	Female player impression text.
male_impression	str	Male player impression text.
outlook_desc	str	Character outlook description.
profile_desc	str	Character profile description.
faction	str	Character faction or group.
unlock_conditions	list[str]	List of conditions to unlock the character.

CharacterProp

Bases: APIModel

Represent a character property in Zenless Zone Zero.

Properties include elements, weapon types, attack types, and other character attributes that are referenced by ID and name.

Attributes:

Name	Type	Description
id	int	Unique property identifier.
name	str	Human-readable property name.

CharacterSkill

Bases: APIModel

Represent a character skill with upgrade information.

Contains complete skill data including descriptions, upgrade materials, and skill type classification.

Attributes:

Name	Type	Description
descriptions	list[CharacterSkillDesc]	List of skill effect descriptions.
materials	dict[str, list[ZZZMaterial]]	Required materials for skill upgrades by level.
type	ZZZSkillType	Skill type classification.

CharacterSkillDesc

Bases: APIModel

Represent a character skill description entry.

Contains detailed information about specific skill effects including names, descriptions, and parameters.

Attributes:

Name	Type	Description
name	str	Skill description name.
description	str | None	Skill effect description.
params	list[CharaSkillDescParam] | None	List of skill parameters.

DriveDisc

Bases: APIModel

Represent a Zenless Zone Zero drive disc set.

Drive discs are equipment sets that provide bonuses when multiple pieces are equipped. Contains basic info and localized descriptions.

Attributes:

Name	Type	Description
id	int	Unique drive disc set identifier.
icon	str	Drive disc icon image URL.
name	str	Set name (may be empty if not in API response).
two_piece_effect	str	2-piece effect description (may be empty).
four_piece_effect	str	4-piece effect description (may be empty).
en_info	DriveDiscInfo | None	English localization data.
ko_info	DriveDiscInfo | None	Korean localization data.
chs_info	DriveDiscInfo	Chinese Simplified localization data.
ja_info	DriveDiscInfo | None	Japanese localization data.

DriveDiscDetail

Bases: APIModel

Provide comprehensive drive disc set information.

Contains complete drive disc data including set bonuses, lore, and visual assets for a specific drive disc set.

Attributes:

Name	Type	Description
id	int	Unique drive disc set identifier.
name	str	Drive disc set name.
two_piece_effect	str	Effect when 2 pieces are equipped.
four_piece_effect	str	Effect when 4 pieces are equipped.
story	str	Background lore and story text.
icon	str	Drive disc icon image URL.

DriveDiscInfo

Bases: APIModel

Represent drive disc information in a specific language.

Contains localized drive disc name and set bonus descriptions for 2-piece and 4-piece effects.

Attributes:

Name	Type	Description
name	str	Drive disc set name.
two_piece_effect	str	Effect when 2 pieces are equipped.
four_piece_effect	str	Effect when 4 pieces are equipped.

Item

Bases: APIModel

Represent a ZZZ item.

Attributes:

Name	Type	Description
icon	str	Icon URL of the item.
rarity	Literal[1, 2, 3, 4, 5]	Rarity of the item.
class_	int	Class of the item.
name	str	Name of the item.
id	int	ID of the item.

MindscapeCinema

Bases: APIModel

Represent a character mindscape cinema level (constellation equivalent).

Mindscape cinemas are upgrades that enhance character abilities and provide new effects when unlocked.

Attributes:

Name	Type	Description
level	int	Cinema level (1-6).
name	str	Cinema ability name.
description	str	Primary effect description.
description2	str	Secondary effect description.

New

Bases: APIModel

Represent new Zenless Zone Zero data.

Attributes:

Name	Type	Description
character_ids	list[int]	A list of character IDs.
bangboo_ids	list[int]	A list of Bangboo IDs.
weapon_ids	list[int]	A list of weapon IDs.
equipment_ids	list[int]	A list of equipment IDs.
item_ids	list[int]	A list of item IDs.
current_version	str	The current version.
previous_versions	list[str]	A list of previous versions.

Weapon

Bases: APIModel

Represent a ZZZ weapon (w-engine).

Attributes:

Name	Type	Description
id	int	ID of the weapon.
icon	str	Icon URL of the weapon.
name	str	Name of the weapon.
names	dict[Literal['EN', 'JA', 'CHS', 'KO'], str]	Dictionary of names in different languages.
specialty	ZZZSpecialty	Specialty of the weapon.
rarity	Literal['S', 'A', 'B']	Rarity of the weapon.

__convert_icon(value) classmethod

Convert the icon path to a full URL.

__convert_rarity(value) classmethod

Convert the rarity value to a string literal.

__pop_names(values) classmethod

Pop names from the values and assign them to the 'names' field.

WeaponDetail

Bases: APIModel

Represent detailed information about a ZZZ weapon.

Attributes:

Name	Type	Description
id	int	ID of the weapon.
code_name	str	Code name of the weapon.
name	str	Name of the weapon.
description	str	Description of the weapon.
description2	str	Second description of the weapon.
short_description	str	Short description of the weapon.
rarity	Literal['S', 'A', 'B'] | None	Rarity of the weapon.
icon	str	Icon URL of the weapon.
type	WeaponType	Type of the weapon.
base_property	WeaponProp	Base property of the weapon.
rand_property	WeaponProp	Random property of the weapon.
levels	dict[str, WeaponLevel]	Dictionary of weapon levels.
stars	dict[str, WeaponStar]	Dictionary of weapon stars.
materials	str	Materials required for the weapon.
refinements	dict[str, WeaponRefinement]	Dictionary of weapon refinements.

refinements = Field(alias='Talents') class-attribute instance-attribute

Dictionary of refinements, key starts from 1.

__convert_icon(value) classmethod

Convert the icon path to a full URL.

__convert_rarity(value) classmethod

Convert the rarity value to a string literal.

__convert_type(value) classmethod

Convert the weapon type data to a WeaponType object.

WeaponLevel

Bases: APIModel

Represent weapon leveling information.

Contains experience requirements and stat scaling rates for weapon level progression.

Attributes:

Name	Type	Description
exp	int	Experience points required.
rate	int	Primary stat scaling rate.
rate2	int	Secondary stat scaling rate.

WeaponProp

Bases: APIModel

Represent a weapon stat property.

Contains stat information including names, formatting, and values for weapon statistics like attack, crit rate, etc.

Attributes:

Name	Type	Description
name	str	Primary property name.
name2	str	Secondary property name.
format	str	Value formatting specification.
value	float	Numerical property value.

formatted_value property

Get the formatted value of this property.

WeaponRefinement

Bases: APIModel

Represent weapon refinement level data.

Contains information about weapon refinement stages and their associated names or effects.

Attributes:

Name	Type	Description
name	str	Refinement level name or description.

__cleanup_text(value) classmethod

Clean up the description text.

WeaponStar

Bases: APIModel

Represent weapon star ranking information.

Contains star rating data and randomization rates for weapon rarity and quality assessment.

Attributes:

Name	Type	Description
star_rate	int	Star rating value.
rand_rate	int	Randomization rate factor.

WeaponType

Bases: APIModel

Represent a weapon type classification.

Defines the specialty and name of weapon types that characters can use in Zenless Zone Zero.

Attributes:

Name	Type	Description
type	ZZZSpecialty	Weapon specialty classification.
name	str	Human-readable weapon type name.