Class PixivClient

Readonlyillusts

Readonlyimages

Readonlymanga

Readonlynovels

Readonlyugoira

Readonlyusers

userId

• get userId(): number

  Numeric user ID of the authenticated account.

  Available immediately after PixivClient.of resolves. The pixiv OAuth endpoint returns the ID as a string; this getter normalises it to number for consistency with resource method params (e.g. UserBookmarksIllustParams.userId).

  Returns number

  Example

  const client = await PixivClient.of(refreshToken)
  const bookmarks = await client.users.bookmarks.illusts({ userId: client.userId })
  Copy

getAccessToken

• getAccessToken(): string

  Returns the current OAuth access token.

  The access token is short-lived and changes after each call to PixivClient.of and after each automatic token refresh triggered by a 401 response.

  Returns string

  The current bearer access token string

getRefreshToken

• getRefreshToken(): string

  Returns the current OAuth refresh token.

  The refresh token is long-lived and is used to obtain new access tokens. It may rotate after a successful token refresh.

  Returns string

  The current refresh token string

Staticof

• of(refreshToken: string, options?: PixivClientOptions): Promise<PixivClient>

  Creates a PixivClient by refreshing the given token.

  Parameters

  • refreshToken: string

    Pixiv refresh token

  • Optionaloptions: PixivClientOptions

    Optional retry and response interceptor configuration

  Returns Promise<PixivClient>

  A fully initialised PixivClient