Skip to content

Lineup Clients

LineupClient 

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

Lineup component.

Methods:

get_favorite_lineups async 

get_favorite_lineups(
    *,
    limit: Optional[int] = None,
    lang: Optional[str] = None,
) -> Sequence[LineupPreview]

Get favorited lineups of the currently logged-in user.

get_lineup_character_history async 

get_lineup_character_history(
    *,
    limit: Optional[int] = None,
    lang: Optional[str] = None,
) -> Sequence[LineupCharacter]

Get previous character builds of the currently logged-in user..

get_lineup_details async 

get_lineup_details(
    lineup: Union[str, LineupPreview],
    *,
    lang: Optional[str] = None,
) -> Lineup

Get lineup with detailed characters.

get_lineup_fields async 

get_lineup_fields(
    *, lang: Optional[str] = None, use_cache: bool = True
) -> LineupFields

Get configuration lineup fields.

get_lineup_scenarios async 

get_lineup_scenarios(
    *, lang: Optional[str] = None
) -> LineupScenarios

Get lineup scenarios.

get_lineups 

get_lineups(
    scenario: Optional[IDOr[LineupScenario]] = None,
    *,
    limit: Optional[int] = None,
    page_size: Optional[int] = None,
    newest: bool = False,
    match_characters: bool = False,
    characters: Optional[Sequence[IDOr[Character]]] = None,
    uid: Optional[int] = None,
    lang: Optional[str] = None,
) -> TokenPaginator[LineupPreview]

Get lineups.

get_user_lineups async 

get_user_lineups(
    *,
    limit: Optional[int] = None,
    lang: Optional[str] = None,
) -> Sequence[LineupPreview]

Get lineups of the currently logged-in user.

request_lineup async 

request_lineup(
    endpoint: str,
    *,
    method: str = "GET",
    lang: Optional[str] = None,
    params: Optional[Mapping[str, Any]] = None,
    **kwargs: Any,
) -> Mapping[str, Any]

Make a request towards the lineup endpoint.

HSRLineupClient 

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

HSR lineup simulator client.

Methods:

get_starrail_lineup_floor 

get_starrail_lineup_floor(
    game_modes: Sequence[StarRailGameMode],
    *,
    type: LineupGameMode,
    floor: int,
) -> Optional[StarRailGameModeFloor]

Get a specific floor from the game modes.

get_starrail_lineup_game_modes async 

get_starrail_lineup_game_modes(
    *, lang: Optional[str] = None
) -> list[StarRailGameMode]

Get the available game modes for the HSR lineup simulator.

get_starrail_lineup_schedules async 

get_starrail_lineup_schedules(
    type: Union[Literal[MOC], Literal["Chasm"]],
    *,
    lang: Optional[str] = ...,
) -> list[MOCSchedule]

get_starrail_lineup_schedules(
    type: Union[Literal[PURE_FICTION], Literal["Story"]],
    *,
    lang: Optional[str] = ...,
) -> list[PureFictionSchedule]

get_starrail_lineup_schedules(
    type: Union[Literal[APC_SHADOW], Literal["Boss"]],
    *,
    lang: Optional[str] = ...,
) -> list[APCShadowSchedule]

get_starrail_lineup_schedules(
    type: LineupGameMode, *, lang: Optional[str] = None
) -> Union[
    list[MOCSchedule],
    list[PureFictionSchedule],
    list[APCShadowSchedule],
]

Get the schedule for the HSR lineup simulator.

get_starrail_lineups async 

get_starrail_lineups(
    *,
    tag_id: int,
    group_id: int,
    type: Union[Literal[MOC], Literal["Chasm"]],
    next_page_token: Optional[str] = ...,
    order: Literal["Hot", "Match", "CreatedTime"] = ...,
    lang: Optional[str] = ...,
) -> StarRailLineupResponse

get_starrail_lineups(
    *,
    tag_id: int,
    group_id: int,
    type: Union[Literal[PURE_FICTION], Literal["Story"]],
    next_page_token: Optional[str] = ...,
    order: Literal["Hot", "Match", "CreatedTime"] = ...,
    lang: Optional[str] = ...,
) -> PureFictionLineupResponse

get_starrail_lineups(
    *,
    tag_id: int,
    group_id: int,
    type: Union[Literal[APC_SHADOW], Literal["Boss"]],
    next_page_token: Optional[str] = ...,
    order: Literal["Hot", "Match", "CreatedTime"] = ...,
    lang: Optional[str] = ...,
) -> APCShadowLineupResponse

get_starrail_lineups(
    *,
    tag_id: int,
    group_id: int,
    type: LineupGameMode,
    next_page_token: Optional[str] = None,
    order: Literal["Hot", "Match", "CreatedTime"] = "Match",
    lang: Optional[str] = None,
) -> Union[
    StarRailLineupResponse,
    PureFictionLineupResponse,
    APCShadowLineupResponse,
]

Get the available lineups for the HSR lineup simulator.