API Reference

zzz

Modules:

• bangboo –
• character –
• common –
• disc –
• items –
• new –
• weapon –

Classes:

• Bangboo –

  Represent a Zenless Zone Zero bangboo companion.

• BangbooAscension –

  Represent bangboo ascension phase data.

• BangbooDetail –

  Provide comprehensive bangboo information and progression data.

• BangbooSkill –

  Represent a bangboo skill or ability.

• CharaCoreSkillLevel –

  Represent a single level of a character core skill.

• CharaSkillDescParam –

  Represent a skill description parameter.

• CharaSkillDescParamProp –

  Represent skill description parameter properties.

• Character –

  Represent a Zenless Zone Zero character (agent).

• CharacterAscension –

  Represent character ascension phase data.

• CharacterCoreSkill –

  Represent a character's core skill progression system.

• CharacterDetail –

  Provide comprehensive character information and progression data.

• CharacterExtraAscension –

  Represent character bonus ascension data.

• CharacterInfo –

  Contain detailed character lore and background information.

• CharacterProp –

  Represent a character property in Zenless Zone Zero.

• CharacterSkill –

  Represent a character skill with upgrade information.

• CharacterSkillDesc –

  Represent a character skill description entry.

• DriveDisc –

  Represent a Zenless Zone Zero drive disc set.

• DriveDiscDetail –

  Provide comprehensive drive disc set information.

• DriveDiscInfo –

  Represent drive disc information in a specific language.

• Item –

  Represent a ZZZ item.

• MindscapeCinema –

  Represent a character mindscape cinema level (constellation equivalent).

• New –

  Represent new Zenless Zone Zero data.

• Weapon –

  Represent a ZZZ weapon (w-engine).

• WeaponDetail –

  Represent detailed information about a ZZZ weapon.

• WeaponLevel –

  Represent weapon leveling information.

• WeaponProp –

  Represent a weapon stat property.

• WeaponRefinement –

  Represent weapon refinement level data.

• WeaponStar –

  Represent weapon star ranking information.

• WeaponType –

  Represent a weapon type classification.

Bangboo pydantic-model

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:

• 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', 'zh', 'ko'], str]) –

  Bangboo names in different languages.

Fields:

• id (int)
• icon (str)
• rarity (Literal['S', 'A'] | None)
• code_name (str)
• description (str)
• name (str)
• names (dict[Literal['en', 'ja', 'zh', 'ko'], str])

Validators:

• __format_fields
• __convert_icon → icon
• __convert_rarity → rarity
• __pop_names

code_name pydantic-field

code_name: str

description pydantic-field

description: str

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'ja', 'zh', 'ko'], str]

rarity pydantic-field

rarity: Literal['S', 'A'] | None

BangbooAscension pydantic-model

Represent bangboo ascension phase data.

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

Attributes:

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

Fields:

• max_hp (int)
• attack (int)
• defense (int)
• max_level (int)
• min_level (int)
• materials (list[ZZZMaterial])
• extra_props (list[ZZZExtraProp])

Validators:

• __format_fields
• __convert_extra_props → extra_props
• __convert_materials → materials

attack pydantic-field

attack: int

defense pydantic-field

defense: int

extra_props pydantic-field

extra_props: list[ZZZExtraProp]

materials pydantic-field

materials: list[ZZZMaterial]

max_hp pydantic-field

max_hp: int

max_level pydantic-field

max_level: int

min_level pydantic-field

min_level: int

BangbooDetail pydantic-model

Provide comprehensive bangboo information and progression data.

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

Attributes:

• 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] | None]) –

  Skills organized by type (A, B, C).

Fields:

• id (int)
• code_name (str)
• name (str)
• description (str)
• rarity (Literal['S', 'A'])
• icon (str)
• stats (dict[str, float])
• ascensions (dict[str, BangbooAscension])
• skills (dict[Literal['a', 'b', 'c'], dict[str, BangbooSkill] | None])

Validators:

• __format_fields
• __unnest_level → skills
• __convert_icon → icon
• __convert_rarity → rarity

ascensions pydantic-field

ascensions: dict[str, BangbooAscension]

code_name pydantic-field

code_name: str

description pydantic-field

description: str

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

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

skills pydantic-field

skills: dict[
    Literal["a", "b", "c"], dict[str, BangbooSkill] | None
]

stats pydantic-field

stats: dict[str, float]

BangbooSkill pydantic-model

Represent a bangboo skill or ability.

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

Attributes:

• name (str) –

  Skill name.

• description (str) –

  Skill effect description.

• properties (list[str]) –

  List of skill properties.

• parameter (str) –

  Skill parameter values.

Fields:

• name (str)
• description (str)
• properties (list[str])
• parameter (str)

Validators:

• __format_fields
• __cleanup_text → description

description pydantic-field

description: str

name pydantic-field

name: str

parameter pydantic-field

parameter: str

properties pydantic-field

properties: list[str]

CharaCoreSkillLevel pydantic-model

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:

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

Fields:

• level (int)
• id (int)
• names (list[str])
• descriptions (list[str])

Validators:

• __format_fields
• __cleanup_text → descriptions

descriptions pydantic-field

descriptions: list[str]

id pydantic-field

id: int

level pydantic-field

level: int

names pydantic-field

names: list[str]

CharaSkillDescParam pydantic-model

Represent a skill description parameter.

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

Attributes:

• name (str) –

  Parameter name.

• description (str) –

  Parameter description.

• params (dict[str, CharaSkillDescParamProp] | None) –

  Dictionary of parameter properties.

Fields:

• name (str)
• description (str)
• params (dict[str, CharaSkillDescParamProp] | None)

Validators:

• __format_fields

description pydantic-field

description: str

name pydantic-field

name: str

params pydantic-field

params: dict[str, CharaSkillDescParamProp] | None = None

CharaSkillDescParamProp pydantic-model

Represent skill description parameter properties.

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

Attributes:

• main (int) –

  Base parameter value.

• growth (int) –

  Growth rate per level.

• format (str) –

  Display formatting specification.

Fields:

• main (int)
• growth (int)
• format (str)

Validators:

• __format_fields

format pydantic-field

format: str

growth pydantic-field

growth: int

main pydantic-field

main: int

Character pydantic-model

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:

• 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', 'zh', 'ja'], str]) –

  Character names in different languages.

Fields:

• id (int)
• name (str)
• rarity (Literal['S', 'A'] | None)
• specialty (ZZZSpecialty)
• element (ZZZElement | None)
• attack_type (ZZZAttackType | None)
• image (str)
• en_description (str)
• names (dict[Literal['en', 'ko', 'zh', 'ja'], str])
• skins (list[CharacterSkin])

Validators:

• __format_fields
• __convert_rarity → rarity
• __convert_attack_type → attack_type
• __convert_image → image
• __pop_names
• __convert_skins → skins

attack_type pydantic-field

attack_type: ZZZAttackType | None = None

cropped_icon property

cropped_icon: str

Agent cropped icon.

Example: https://static.nanoka.cc/zzz/UI/IconRoleCrop01.webp

element pydantic-field

element: ZZZElement | None = None

en_description pydantic-field

en_description: str

icon property

icon: str

Agent icon.

Example: https://static.nanoka.cc/zzz/UI/IconRoleSelect01.webp

id pydantic-field

id: int

image pydantic-field

image: str

name pydantic-field

name: str

names pydantic-field

names: dict[Literal['en', 'ko', 'zh', 'ja'], str]

phase_1_cinema_art property

phase_1_cinema_art: str

Agent phase 1 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_1.webp

phase_2_cinema_art property

phase_2_cinema_art: str

Agent phase 2 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_2.webp

phase_3_cinema_art property

phase_3_cinema_art: str

Agent phase 3 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_3.webp

rarity pydantic-field

rarity: Literal['S', 'A'] | None

skins pydantic-field

skins: list[CharacterSkin]

specialty pydantic-field

specialty: ZZZSpecialty

CharacterAscension pydantic-model

Represent character ascension phase data.

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

Attributes:

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

Fields:

• max_hp (int)
• attack (int)
• defense (int)
• max_level (int)
• min_level (int)
• materials (list[ZZZMaterial])

Validators:

• __format_fields
• __convert_materials → materials

attack pydantic-field

attack: int

defense pydantic-field

defense: int

materials pydantic-field

materials: list[ZZZMaterial]

max_hp pydantic-field

max_hp: int

max_level pydantic-field

max_level: int

min_level pydantic-field

min_level: int

CharacterCoreSkill pydantic-model

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:

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

Fields:

• levels (dict[int, CharaCoreSkillLevel])
• level_up_materials (dict[str, list[ZZZMaterial]] | None)

Validators:

• __format_fields
• __convert_materials → level_up_materials
• __intify_keys → levels

level_up_materials pydantic-field

level_up_materials: dict[str, list[ZZZMaterial]] | None = (
    None
)

levels pydantic-field

levels: dict[int, CharaCoreSkillLevel]

CharacterDetail pydantic-model

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:

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

Fields:

• id (int)
• image (str)
• name (str)
• code_name (str)
• rarity (Literal['S', 'A'] | None)
• specialty (CharacterProp)
• element (CharacterProp)
• attack_type (CharacterProp)
• faction (CharacterProp)
• gender (Literal['M', 'F'])
• info (CharacterInfo | None)
• stats (dict[str, float])
• mindscape_cinemas (list[MindscapeCinema])
• ascension (list[CharacterAscension])
• extra_ascension (list[CharacterExtraAscension])
• skills (dict[ZZZSkillType, CharacterSkill])
• passive (CharacterCoreSkill)
• skins (list[CharacterSkin])
• potentials (list[CharacterPotential])

Validators:

• __format_fields
• __convert_info → info
• __convert_skills → skills
• __convert_extra_ascension → extra_ascension
• __convert_ascension → ascension
• __dict_to_list → mindscape_cinemas
• __pop_tags → stats
• __transform_gender → gender
• __convert_rarity → rarity
• __convert_image → image
• __convert_skins → skins
• __flatten_potentials → potentials

ascension pydantic-field

ascension: list[CharacterAscension]

attack_type pydantic-field

attack_type: CharacterProp

code_name pydantic-field

code_name: str

element pydantic-field

element: CharacterProp

extra_ascension pydantic-field

extra_ascension: list[CharacterExtraAscension]

faction pydantic-field

faction: CharacterProp

gender pydantic-field

gender: Literal['M', 'F']

icon property

icon: str

Character icon.

Example: https://static.nanoka.cc/zzz/UI/IconRoleSelect01.webp

id pydantic-field

id: int

image pydantic-field

image: str

info pydantic-field

info: CharacterInfo | None

mindscape_cinemas pydantic-field

mindscape_cinemas: list[MindscapeCinema]

name pydantic-field

name: str

passive pydantic-field

passive: CharacterCoreSkill

phase_1_cinema_art property

phase_1_cinema_art: str

Agent phase 1 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_1.webp

phase_2_cinema_art property

phase_2_cinema_art: str

Agent phase 2 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_2.webp

phase_3_cinema_art property

phase_3_cinema_art: str

Agent phase 3 mindscape cinema art.

Example: https://static.nanoka.cc/zzz/UI/Mindscape_1041_3.webp

potentials pydantic-field

potentials: list[CharacterPotential]

rarity pydantic-field

rarity: Literal['S', 'A'] | None

skills pydantic-field

skills: dict[ZZZSkillType, CharacterSkill]

skins pydantic-field

skins: list[CharacterSkin]

specialty pydantic-field

specialty: CharacterProp

stats pydantic-field

stats: dict[str, float]

CharacterExtraAscension pydantic-model

Represent character bonus ascension data.

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

Attributes:

• max_level (int) –

  Maximum level for this bonus phase.

• props (list[ZZZExtraProp]) –

  Additional properties and bonuses gained.

Fields:

• max_level (int)
• props (list[ZZZExtraProp])

Validators:

• __format_fields
• __convert_props → props

max_level pydantic-field

max_level: int

props pydantic-field

props: list[ZZZExtraProp]

CharacterInfo pydantic-model

Contain detailed character lore and background information.

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

Attributes:

• 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 | None) –

  Character outlook description.

• profile_desc (str) –

  Character profile description.

• faction (str | None) –

  Character faction or group.

• unlock_conditions (list[str]) –

  List of conditions to unlock the character.

Fields:

• birthday (str)
• full_name (str)
• gender (str)
• female_impression (str)
• male_impression (str)
• outlook_desc (str | None)
• profile_desc (str)
• faction (str | None)
• unlock_conditions (list[str])

Validators:

• __format_fields
• __cleanup_text → female_impression, male_impression, outlook_desc, profile_desc

birthday pydantic-field

birthday: str

faction pydantic-field

faction: str | None = None

female_impression pydantic-field

female_impression: str

full_name pydantic-field

full_name: str

gender pydantic-field

gender: str

male_impression pydantic-field

male_impression: str

outlook_desc pydantic-field

outlook_desc: str | None = None

profile_desc pydantic-field

profile_desc: str

unlock_conditions pydantic-field

unlock_conditions: list[str]

CharacterProp pydantic-model

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:

• id (int) –

  Unique property identifier.

• name (str) –

  Human-readable property name.

Fields:

• id (int)
• name (str)

Validators:

• __format_fields
• __transform

id pydantic-field

id: int

name pydantic-field

name: str

CharacterSkill pydantic-model

Represent a character skill with upgrade information.

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

Attributes:

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

Fields:

• descriptions (list[CharacterSkillDesc])
• materials (dict[str, list[ZZZMaterial]])
• type (ZZZSkillType)

Validators:

• __format_fields
• __convert_materials → materials

descriptions pydantic-field

descriptions: list[CharacterSkillDesc]

materials pydantic-field

materials: dict[str, list[ZZZMaterial]]

type pydantic-field

type: ZZZSkillType

CharacterSkillDesc pydantic-model

Represent a character skill description entry.

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

Attributes:

• name (str) –

  Skill description name.

• description (str | None) –

  Skill effect description.

• params (list[CharaSkillDescParam] | None) –

  List of skill parameters.

Fields:

• name (str)
• description (str | None)
• params (list[CharaSkillDescParam] | None)

Validators:

• __format_fields

description pydantic-field

description: str | None = None

name pydantic-field

name: str

params pydantic-field

params: list[CharaSkillDescParam] | None = None

DriveDisc pydantic-model

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:

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

Fields:

• id (int)
• icon (str)
• name (str)
• two_piece_effect (str)
• four_piece_effect (str)
• en_info (DriveDiscInfo | None)
• ko_info (DriveDiscInfo | None)
• chs_info (DriveDiscInfo)
• ja_info (DriveDiscInfo | None)

Validators:

• __format_fields
• __convert_icon → icon

chs_info pydantic-field

chs_info: DriveDiscInfo

en_info pydantic-field

en_info: DriveDiscInfo | None = None

four_piece_effect pydantic-field

four_piece_effect: str = ''

icon pydantic-field

icon: str

id pydantic-field

id: int

ja_info pydantic-field

ja_info: DriveDiscInfo | None = None

ko_info pydantic-field

ko_info: DriveDiscInfo | None = None

name pydantic-field

name: str = ''

two_piece_effect pydantic-field

two_piece_effect: str = ''

DriveDiscDetail pydantic-model

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:

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

Fields:

• id (int)
• name (str)
• two_piece_effect (str)
• four_piece_effect (str)
• story (str)
• icon (str)

Validators:

• __format_fields
• __convert_icon → icon

four_piece_effect pydantic-field

four_piece_effect: str

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

story pydantic-field

story: str

two_piece_effect pydantic-field

two_piece_effect: str

DriveDiscInfo pydantic-model

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

Fields:

• name (str)
• two_piece_effect (str)
• four_piece_effect (str)

Validators:

• __format_fields

four_piece_effect pydantic-field

four_piece_effect: str

name pydantic-field

name: str

two_piece_effect pydantic-field

two_piece_effect: str

Item pydantic-model

Represent a ZZZ item.

Attributes:

• icon (str) –

  Icon URL of the item.

• rarity (Literal[0, 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.

Fields:

• icon (str)
• rarity (Literal[0, 1, 2, 3, 4, 5])
• class_ (int)
• name (str)
• id (int)

Validators:

• __format_fields
• __convert_icon → icon

class_ pydantic-field

class_: int

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str

rarity pydantic-field

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

MindscapeCinema pydantic-model

Represent a character mindscape cinema level (constellation equivalent).

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

Attributes:

• level (int) –

  Cinema level (1-6).

• name (str) –

  Cinema ability name.

• description (str) –

  Primary effect description.

• description2 (str) –

  Secondary effect description.

Fields:

• level (int)
• name (str)
• description (str)
• description2 (str)

Validators:

• __format_fields
• __cleanup_text → description, description2

description pydantic-field

description: str

description2 pydantic-field

description2: str

level pydantic-field

level: int

name pydantic-field

name: str

New pydantic-model

Represent new Zenless Zone Zero data.

Attributes:

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

Fields:

• character_ids (list[int])
• bangboo_ids (list[int])
• weapon_ids (list[int])
• equipment_ids (list[int])
• item_ids (list[int])
• current_version (str)
• previous_versions (list[str])

Validators:

• __format_fields

bangboo_ids pydantic-field

bangboo_ids: list[int]

character_ids pydantic-field

character_ids: list[int]

current_version pydantic-field

current_version: str

equipment_ids pydantic-field

equipment_ids: list[int]

item_ids pydantic-field

item_ids: list[int]

previous_versions pydantic-field

previous_versions: list[str]

weapon_ids pydantic-field

weapon_ids: list[int]

Weapon pydantic-model

Represent a ZZZ weapon (w-engine).

Attributes:

• id (int) –

  ID of the weapon.

• icon (str) –

  Icon URL of the weapon.

• name (str) –

  Name of the weapon.

• names (dict[Literal['en', 'ja', 'zh', 'ko'], str]) –

  Dictionary of names in different languages.

• specialty (ZZZSpecialty) –

  Specialty of the weapon.

• rarity (Literal['S', 'A', 'B']) –

  Rarity of the weapon.

Fields:

• id (int)
• icon (str)
• name (str)
• names (dict[Literal['en', 'ja', 'zh', 'ko'], str])
• specialty (ZZZSpecialty)
• rarity (Literal['S', 'A', 'B'])

Validators:

• __format_fields
• __convert_rarity → rarity
• __convert_icon → icon
• __pop_names

icon pydantic-field

icon: str

id pydantic-field

id: int

name pydantic-field

name: str = ''

names pydantic-field

names: dict[Literal['en', 'ja', 'zh', 'ko'], str]

rarity pydantic-field

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

specialty pydantic-field

specialty: ZZZSpecialty

WeaponDetail pydantic-model

Represent detailed information about a ZZZ weapon.

Attributes:

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

Fields:

• id (int)
• code_name (str)
• name (str)
• description (str)
• description2 (str)
• short_description (str)
• rarity (Literal['S', 'A', 'B'] | None)
• icon (str)
• type (WeaponType)
• base_property (WeaponProp)
• rand_property (WeaponProp)
• levels (dict[str, WeaponLevel])
• stars (dict[str, WeaponStar])
• materials (str)
• refinements (dict[str, WeaponRefinement])

Validators:

• __format_fields
• __convert_type → type
• __convert_icon → icon
• __convert_rarity → rarity

base_property pydantic-field

base_property: WeaponProp

code_name pydantic-field

code_name: str

description pydantic-field

description: str

description2 pydantic-field

description2: str

icon pydantic-field

icon: str

id pydantic-field

id: int

levels pydantic-field

levels: dict[str, WeaponLevel]

materials pydantic-field

materials: str

name pydantic-field

name: str

rand_property pydantic-field

rand_property: WeaponProp

rarity pydantic-field

rarity: Literal['S', 'A', 'B'] | None

refinements pydantic-field

refinements: dict[str, WeaponRefinement]

Dictionary of refinements, key starts from 1.

short_description pydantic-field

short_description: str

stars pydantic-field

stars: dict[str, WeaponStar]

type pydantic-field

type: WeaponType

WeaponLevel pydantic-model

Represent weapon leveling information.

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

Attributes:

• exp (int) –

  Experience points required.

• rate (int) –

  Primary stat scaling rate.

• rate2 (int) –

  Secondary stat scaling rate.

Fields:

• exp (int)
• rate (int)
• rate2 (int)

Validators:

• __format_fields

exp pydantic-field

exp: int

rate pydantic-field

rate: int

rate2 pydantic-field

rate2: int

WeaponProp pydantic-model

Represent a weapon stat property.

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

Attributes:

• name (str) –

  Primary property name.

• name2 (str) –

  Secondary property name.

• format (str) –

  Value formatting specification.

• value (float) –

  Numerical property value.

Fields:

• name (str)
• name2 (str)
• format (str)
• value (float)

Validators:

• __format_fields

format pydantic-field

format: str

formatted_value property

formatted_value: str

Get the formatted value of this property.

name pydantic-field

name: str

name2 pydantic-field

name2: str

value pydantic-field

value: float

WeaponRefinement pydantic-model

Represent weapon refinement level data.

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

Attributes:

• name (str) –

  Refinement level name or description.

Fields:

• name (str)
• description (str)

Validators:

• __format_fields
• __cleanup_text → description

description pydantic-field

description: str

name pydantic-field

name: str

WeaponStar pydantic-model

Represent weapon star ranking information.

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

Attributes:

• star_rate (int) –

  Star rating value.

• rand_rate (int) –

  Randomization rate factor.

Fields:

• star_rate (int)
• rand_rate (int)

Validators:

• __format_fields

rand_rate pydantic-field

rand_rate: int

star_rate pydantic-field

star_rate: int

WeaponType pydantic-model

Represent a weapon type classification.

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

Attributes:

• type (ZZZSpecialty) –

  Weapon specialty classification.

• name (str) –

  Human-readable weapon type name.

Fields:

• type (ZZZSpecialty)
• name (str)

Validators:

• __format_fields

name pydantic-field

name: str

type pydantic-field

type: ZZZSpecialty