Wiki Client

WikiClient

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

Wiki component.

Methods:

• get_wiki_page –

  Get a wiki page.

• get_wiki_pages –

  Get multiple wiki pages without modules.

• get_wiki_previews –

  Get a list of wiki previews.

• request_wiki –

  Make a request towards the wiki endpoint.

get_wiki_page async

get_wiki_page(
    id: IDOr[BaseWikiPreview], *, lang: Optional[str] = None
) -> WikiPage

Get a wiki page.

get_wiki_pages async

get_wiki_pages(
    ids: Collection[IDOr[BaseWikiPreview]],
    *,
    lang: Optional[str] = None,
) -> Sequence[WikiPage]

Get multiple wiki pages without modules.

get_wiki_previews async

get_wiki_previews(
    menu: Literal[CHARACTER], *, lang: Optional[str] = None
) -> Sequence[CharacterPreview]

get_wiki_previews(
    menu: Literal[WEAPON], *, lang: Optional[str] = None
) -> Sequence[WeaponPreview]

get_wiki_previews(
    menu: Literal[ARTIFACT], *, lang: Optional[str] = None
) -> Sequence[ArtifactPreview]

get_wiki_previews(
    menu: Literal[ENEMY], *, lang: Optional[str] = None
) -> Sequence[EnemyPreview]

get_wiki_previews(
    menu: int, *, lang: Optional[str] = None
) -> Sequence[BaseWikiPreview]

get_wiki_previews(
    menu: int, *, lang: Optional[str] = None
) -> Sequence[BaseWikiPreview]

Get a list of wiki previews.

request_wiki async

request_wiki(
    endpoint: str,
    *,
    lang: Optional[str] = None,
    headers: Optional[Mapping[str, str]] = None,
    **kwargs: Any,
) -> Mapping[str, Any]

Make a request towards the wiki endpoint.