Honkai: Star Rail

StarRailBattleChronicleClient

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

StarRail battle chronicle component.

Methods:

• get_anomaly_arbitration –

  Get starrail anomaly arbitration runs.

• get_starrail_apc_shadow –

  Get starrail apocalyptic shadow runs.

• get_starrail_challenge –

  Get starrail challenge runs.

• get_starrail_characters –

  Get starrail characters.

• get_starrail_event_calendar –

  Get HSR event calendar.

• get_starrail_notes –

  Get starrail real-time notes.

• get_starrail_pure_fiction –

  Get starrail pure fiction runs.

• get_starrail_rogue –

  Get starrail rogue runs.

• get_starrail_user –

  Get starrail user.

Attributes:

• get_apocalyptic_shadow –

  Alias for :meth:get_starrail_apc_shadow.

get_apocalyptic_shadow class-attribute instance-attribute

get_apocalyptic_shadow = get_starrail_apc_shadow

Alias for :meth:get_starrail_apc_shadow.

get_anomaly_arbitration async

get_anomaly_arbitration(
    uid: Optional[int] = ...,
    *,
    previous: bool = ...,
    lang: Optional[str] = ...,
    raw: Literal[False] = ...,
    schedule_type: Literal[1, 3] = ...,
) -> AnomalyArbitration

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

get_anomaly_arbitration(
    uid: Optional[int] = None,
    *,
    previous: bool = False,
    lang: Optional[str] = None,
    raw: bool = False,
    schedule_type: Literal[1, 3] = 3,
) -> Union[AnomalyArbitration, Mapping[str, Any]]

Get starrail anomaly arbitration runs.

schedule_type=1 returns the current run, schedule_type=3 returns three most recent runs.

get_starrail_apc_shadow async

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

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

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

Get starrail apocalyptic shadow runs.

get_starrail_challenge async

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

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

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

Get starrail challenge runs.

get_starrail_characters async

get_starrail_characters(
    uid: Optional[int] = ...,
    *,
    lang: Optional[str] = ...,
    simple: Literal[False] = ...,
) -> StarRailDetailCharacterResponse

get_starrail_characters(
    uid: Optional[int] = ...,
    *,
    lang: Optional[str] = ...,
    simple: Literal[True] = ...,
) -> StarRailSimpleCharacterResponse

get_starrail_characters(
    uid: Optional[int] = None,
    *,
    lang: Optional[str] = None,
    simple: bool = False,
) -> Union[
    StarRailSimpleCharacterResponse,
    StarRailDetailCharacterResponse,
]

Get starrail characters.

get_starrail_event_calendar async

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

Get HSR event calendar.

get_starrail_notes async

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

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

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

Get starrail real-time notes.

get_starrail_pure_fiction async

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

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

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

Get starrail pure fiction runs.

get_starrail_rogue async

get_starrail_rogue(
    uid: Optional[int] = None,
    *,
    schedule_type: int = 3,
    lang: Optional[str] = None,
) -> StarRailRogue

Get starrail rogue runs.

get_starrail_user async

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

Get starrail user.