Skip to content

Zenless Zone Zero

ZZZBattleChronicleClient 

ZZZBattleChronicleClient(
    cookies: Optional[AnyCookieOrHeader] = None,
    *,
    authkey: Optional[str] = None,
    lang: Lang = "en-us",
    region: Region = OVERSEAS,
    proxy: Optional[str] = None,
    game: Optional[Game] = None,
    uid: Optional[int] = None,
    hoyolab_id: Optional[int] = None,
    device_id: Optional[str] = None,
    device_fp: Optional[str] = None,
    headers: Optional[LooseHeaders] = None,
    cache: Optional[BaseCache] = None,
    debug: bool = False,
    on_cookie_update: Optional[CookieUpdateHook] = None,
)

ZZZ battle chronicle component.

Methods:

chronicle_signal_history 

chronicle_signal_history(
    banner_type: Optional[Union[int, Sequence[int]]] = None,
    *,
    limit: Optional[int] = None,
    lang: Optional[str] = None,
    uid: Optional[int] = None,
    end_id: int = 0,
) -> Paginator[SignalSearch]

Get the signal search history of a user.

get_all_zzz_agent_upgrade_guides async 

get_all_zzz_agent_upgrade_guides(
    uid: Optional[int] = None,
    *,
    unlocked_only: bool = True,
    lang: Optional[str] = None,
) -> Sequence[ZZZAgentUpgradeGuide]

Get the upgrade guides for all of the user's agents.

The agents are fetched first, then their guides are requested in batches of 10 simultaneously. If unlocked_only is True (the default), only unlocked agents are included.

get_annihilation_simulacrum async 

get_annihilation_simulacrum(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
) -> AnnihilationSimulacrum

get_annihilation_simulacrum(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[True] = ...,
) -> Mapping[str, Any]

get_annihilation_simulacrum(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
    raw: bool = False,
) -> Union[AnnihilationSimulacrum, Mapping[str, Any]]

Get ZZZ Annihilation Simulacrum stats.

get_bangboos async 

get_bangboos(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> Sequence[ZZZBaseBangboo]

Get all owned ZZZ bangboos.

get_deadly_assault async 

get_deadly_assault(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
) -> DeadlyAssault

get_deadly_assault(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[True] = ...,
) -> Mapping[str, Any]

get_deadly_assault(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
    raw: bool = False,
) -> Union[DeadlyAssault, Mapping[str, Any]]

Get ZZZ Deadly Assault stats.

get_lost_void_summary async 

get_lost_void_summary(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> LostVoidSummary

Get ZZZ Lost Void summary.

get_shiyu_defense async 

get_shiyu_defense(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
) -> Union[ShiyuDefenseV1, ShiyuDefenseV2]

get_shiyu_defense(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[True] = ...,
) -> Mapping[str, Any]

get_shiyu_defense(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
    raw: bool = False,
) -> Union[
    ShiyuDefenseV1, ShiyuDefenseV2, Mapping[str, Any]
]

Get ZZZ Shiyu defense stats.

get_threshold_simulation async 

get_threshold_simulation(
    id: Optional[int] = ...,
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
) -> ThresholdSimulation

get_threshold_simulation(
    id: Optional[int] = ...,
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[True] = ...,
) -> Mapping[str, Any]

get_threshold_simulation(
    id: Optional[int] = None,
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
    raw: bool = False,
) -> Union[ThresholdSimulation, Mapping[str, Any]]

Get ZZZ Threshold Simulation stats.

If no ID is given, the latest run will be fetched.

get_threshold_simulation_brief async 

get_threshold_simulation_brief(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
) -> ThresholdSimulationInfo

Get ZZZ Threshold Simulation brief info.

get_zzz_agent_info async 

get_zzz_agent_info(
    character_id: int,
    *,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> ZZZFullAgent

get_zzz_agent_info(
    character_id: Sequence[int],
    *,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> Sequence[ZZZFullAgent]

get_zzz_agent_info(
    character_id: Union[int, Sequence[int]],
    *,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> Union[ZZZFullAgent, Sequence[ZZZFullAgent]]

Get a ZZZ character's detailed info.

get_zzz_agent_upgrade_guide async 

get_zzz_agent_upgrade_guide(
    character_id: Union[int, Sequence[int]],
    *,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> Sequence[ZZZAgentUpgradeGuide]

Get detailed builds and recommended upgrade guides for ZZZ agents.

get_zzz_agents async 

get_zzz_agents(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> Sequence[ZZZPartialAgent]

Get all owned ZZZ characters (only brief info).

get_zzz_diary async 

get_zzz_diary(
    uid: Optional[int] = None,
    *,
    month: Optional[str] = None,
    lang: Optional[str] = None,
) -> ZZZDiary

Get ZZZ inter-knot monthly earning data.

get_zzz_diary_detail async 

get_zzz_diary_detail(
    month: str,
    *,
    type: ZZZCurrencyType,
    page: int = 1,
    page_size: int = 20,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> ZZZDiaryDetail

Get ZZZ inter-knot monthly earning data.

get_zzz_event_calendar async 

get_zzz_event_calendar(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> Sequence[ZZZEvent]

Get ZZZ event calendar.

get_zzz_gacha_calendar async 

get_zzz_gacha_calendar(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> ZZZGachaCalendar

Get ZZZ gacha calendar.

get_zzz_gacha_info async 

get_zzz_gacha_info(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> ZZZGachaInfo

Get ZZZ gacha info.

get_zzz_notes async 

get_zzz_notes(
    uid: Optional[int] = ...,
    *,
    lang: Optional[str] = ...,
    autoauth: bool = ...,
    return_raw_data: Literal[False] = ...,
) -> ZZZNotes

get_zzz_notes(
    uid: Optional[int] = ...,
    *,
    lang: Optional[str] = ...,
    autoauth: bool = ...,
    return_raw_data: Literal[True] = ...,
) -> Mapping[str, Any]

get_zzz_notes(
    uid: Optional[int] = None,
    *,
    lang: Optional[str] = None,
    autoauth: bool = True,
    return_raw_data: bool = False,
) -> Union[ZZZNotes, Mapping[str, Any]]

Get ZZZ sticky notes (real-time notes).

get_zzz_upgrade_guide_agents async 

get_zzz_upgrade_guide_agents(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> Sequence[ZZZUpgradeGuideAgent]

Get all agents available in the ZZZ agent upgrade guide tool.

get_zzz_user async 

get_zzz_user(
    uid: Optional[int] = None, *, lang: Optional[str] = None
) -> ZZZUserStats

Get ZZZ user stats.