Skip to content

Diary Client

DiaryClient

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

Diary component.

Methods:

diary_log

diary_log(
    uid: Optional[int] = None,
    *,
    limit: Optional[int] = None,
    type: int = PRIMOGEMS,
    month: Optional[int] = None,
    lang: Optional[str] = None,
) -> DiaryPaginator

Create a new daily reward paginator.

genshin_diary_log

genshin_diary_log(
    uid: Optional[int] = None,
    *,
    limit: Optional[int] = None,
    type: int = PRIMOGEMS,
    month: Optional[int] = None,
    lang: Optional[str] = None,
) -> DiaryPaginator

Create a new daily reward paginator.

get_diary async

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

Get a traveler's diary with earning details for the month.

get_genshin_diary async

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

Get a traveler's diary with earning details for the month.

get_starrail_diary async

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

Get a blazer's diary with earning details for the month.

request_ledger async

request_ledger(
    uid: Optional[int] = None,
    *,
    game: Optional[Game] = None,
    detail: bool = False,
    month: Union[int, str, None] = None,
    lang: Optional[str] = None,
    params: Optional[Mapping[str, Any]] = None,
    **kwargs: Any,
) -> Mapping[str, Any]

Make a request towards the ys ledger endpoint.

starrail_diary_log

starrail_diary_log(
    uid: Optional[int] = None,
    *,
    limit: Optional[int] = None,
    type: int = STELLARJADE,
    month: Optional[str] = None,
    lang: Optional[str] = None,
) -> StarRailDiaryPaginator

Create a new daily reward paginator.