API Reference

zzz

Classes:

• ZZZClient –

  Client to interact with the Hakushin Zenless Zone Zero API.

ZZZClient

Client to interact with the Hakushin Zenless Zone Zero API.

Methods:

• fetch_bangboo_detail –

  Fetch the details of a Zenless Zone Zero bangboo.

• fetch_bangboos –

  Fetch all Zenless Zone Zero bangboos.

• fetch_character_detail –

  Fetch the details of a Zenless Zone Zero character.

• fetch_characters –

  Fetch all Zenless Zone Zero characters.

• fetch_drive_disc_detail –

  Fetch the details of a Zenless Zone Zero drive disc.

• fetch_drive_discs –

  Fetch all Zenless Zone Zero drive discs.

• fetch_items –

  Fetch all Zenless Zone Zero items.

• fetch_weapon_detail –

  Fetch the details of a Zenless Zone Zero weapon.

• fetch_weapons –

  Fetch all Zenless Zone Zero weapons (w-engines).

fetch_bangboo_detail async

fetch_bangboo_detail(
    bangboo_id: int, *, use_cache: bool = True
) -> BangbooDetail

Fetch the details of a Zenless Zone Zero bangboo.

Parameters:

• bangboo_id

  (int) –

  The bangboo ID.

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• BangbooDetail –

  The bangboo details object.

fetch_bangboos async

fetch_bangboos(
    *, use_cache: bool = True, version: str | None = None
) -> list[Bangboo]

Fetch all Zenless Zone Zero bangboos.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

• version

  (str | None, default: None ) –

  The game version to fetch data for.

Returns: A list of bangboo objects.

fetch_character_detail async

fetch_character_detail(
    character_id: int,
    *,
    version: str | None = None,
    use_cache: bool = True,
) -> CharacterDetail

Fetch the details of a Zenless Zone Zero character.

Parameters:

• character_id

  (int) –

  The character ID.

• version

  (str | None, default: None ) –

  The game version to fetch data for.

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• CharacterDetail –

  The character details object.

fetch_characters async

fetch_characters(
    *, version: str | None = None, use_cache: bool = True
) -> list[Character]

Fetch all Zenless Zone Zero characters.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• list[Character] –

  A list of character objects.

fetch_drive_disc_detail async

fetch_drive_disc_detail(
    drive_disc_id: int, *, use_cache: bool = True
) -> DriveDiscDetail

Fetch the details of a Zenless Zone Zero drive disc.

Parameters:

• drive_disc_id

  (int) –

  The drive disc ID.

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• DriveDiscDetail –

  The drive disc details object.

fetch_drive_discs async

fetch_drive_discs(
    *, use_cache: bool = True, version: str | None = None
) -> list[DriveDisc]

Fetch all Zenless Zone Zero drive discs.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

• version

  (str | None, default: None ) –

  The game version to fetch data for.

Returns: A list of drive disc objects.

fetch_items async

fetch_items(*, use_cache: bool = True) -> Sequence[Item]

Fetch all Zenless Zone Zero items.

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• Sequence[Item] –

  A list of item objects.

fetch_weapon_detail async

fetch_weapon_detail(
    weapon_id: int, *, use_cache: bool = True
) -> WeaponDetail

Fetch the details of a Zenless Zone Zero weapon.

Parameters:

• weapon_id

  (int) –

  The weapon ID.

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

Returns:

• WeaponDetail –

  The weapon details object.

fetch_weapons async

fetch_weapons(
    *, use_cache: bool = True, version: str | None = None
) -> list[Weapon]

Fetch all Zenless Zone Zero weapons (w-engines).

Parameters:

• use_cache

  (bool, default: True ) –

  Whether to use the response cache.

• version

  (str | None, default: None ) –

  The game version to fetch data for.

Returns: A list of weapon objects.