Genshin

GenshinBattleChronicleClient

GenshinBattleChronicleClient(
    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,
)

Genshin battle chronicle component.

Methods:

• genshin_tcg –

  Get genshin tcg cards.

• get_envisaged_echoes –

  Get Genshin Envisaged Echo characters information.

• get_full_genshin_user –

  Get a genshin user with all their possible data.

• get_genshin_activities –

  Get genshin activities.

• get_genshin_characters –

  Get genshin user characters.

• get_genshin_detailed_characters –

  Return a list of genshin characters with full details.

• get_genshin_event_calendar –

  Get Genshin event calendar.

• get_genshin_notes –

  Get genshin real-time notes.

• get_genshin_spiral_abyss –

  Get genshin spiral abyss runs.

• get_genshin_tcg_matches –

  Get genshin tcg match history.

• get_genshin_tcg_preview –

  Get genshin tcg.

• get_genshin_user –

  Get genshin user.

• get_imaginarium_theater –

  Get Genshin Impact imaginarium theater runs.

• get_partial_genshin_user –

  Get partial genshin user without character equipment.

• get_stygian_onslaught –

  Get Stygian Onslaught data.

• set_top_genshin_characters –

  Set the top 8 visible genshin characters for the current user.

Attributes:

• get_activities –
• get_notes –
• get_spiral_abyss –

get_activities class-attribute instance-attribute

get_activities = get_genshin_activities

get_notes class-attribute instance-attribute

get_notes = get_genshin_notes

get_spiral_abyss class-attribute instance-attribute

get_spiral_abyss = get_genshin_spiral_abyss

genshin_tcg

genshin_tcg(
    uid: Optional[int] = None,
    *,
    limit: Optional[int] = None,
    characters: bool = True,
    action: bool = True,
    page_size: int = 32,
    lang: Optional[str] = None,
) -> PagedPaginator[TCGBaseCard]

Get genshin tcg cards.

get_envisaged_echoes async

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

Get Genshin Envisaged Echo characters information.

get_full_genshin_user async

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

Get a genshin user with all their possible data.

get_genshin_activities async

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

Get genshin activities.

get_genshin_characters async

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

Get genshin user characters.

get_genshin_detailed_characters async

get_genshin_detailed_characters(
    uid: Optional[int] = ...,
    *,
    characters: Optional[Sequence[int]] = ...,
    lang: Optional[str] = ...,
    return_raw_data: Literal[False] = ...,
) -> GenshinDetailCharacters

get_genshin_detailed_characters(
    uid: Optional[int] = ...,
    *,
    characters: Optional[Sequence[int]] = ...,
    lang: Optional[str] = ...,
    return_raw_data: Literal[True] = ...,
) -> Mapping[str, Any]

get_genshin_detailed_characters(
    uid: Optional[int] = None,
    *,
    characters: Optional[Sequence[int]] = None,
    lang: Optional[str] = None,
    return_raw_data: bool = False,
) -> Union[GenshinDetailCharacters, Mapping[str, Any]]

Return a list of genshin characters with full details.

get_genshin_event_calendar async

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

Get Genshin event calendar.

get_genshin_notes async

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

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

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

Get genshin real-time notes.

get_genshin_spiral_abyss async

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

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

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

Get genshin spiral abyss runs.

get_genshin_tcg_matches async

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

Get genshin tcg match history.

get_genshin_tcg_preview async

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

Get genshin tcg.

get_genshin_user async

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

Get genshin user.

get_imaginarium_theater async

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

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

get_imaginarium_theater(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    need_detail: bool = True,
    lang: Optional[str] = None,
    raw: bool = False,
) -> Union[ImgTheater, Mapping[str, Any]]

Get Genshin Impact imaginarium theater runs.

get_partial_genshin_user async

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

Get partial genshin user without character equipment.

get_stygian_onslaught async

get_stygian_onslaught(
    uid: Optional[int] = ...,
    *,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
    need_detail: bool = ...,
) -> list[HardChallenge]

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

get_stygian_onslaught(
    uid: Optional[int] = None,
    *,
    lang: Optional[str] = None,
    raw: bool = False,
    need_detail: bool = True,
) -> Union[list[HardChallenge], list[Mapping[str, Any]]]

Get Stygian Onslaught data.

set_top_genshin_characters async

set_top_genshin_characters(
    characters: Sequence[IDOr[BaseCharacter]],
    *,
    uid: Optional[int] = None,
) -> None

Set the top 8 visible genshin characters for the current user.