@book000/pixivts - v0.61.1
    Preparing search index...

    Interface PixivIllustItem

    A pixiv illust or manga work item as returned by the API.

    Returned by GET /v1/illust/detail, GET /v1/search/illust, GET /v1/illust/ranking, GET /v1/illust/recommended, etc.

    interface PixivIllustItem {
        caption: string;
        commentAccessControl?: number;
        createDate: string;
        height: number;
        id: number;
        illustAiType: number;
        illustBookStyle: number;
        imageUrls: ImageUrls;
        isBookmarked: boolean;
        isMuted: boolean;
        metaPages: MetaPages[];
        metaSinglePage: MetaSinglePage | Record<string, never>;
        pageCount: number;
        restrict: number;
        restrictionAttributes?: string[];
        sanityLevel: number;
        series: Series | null;
        tags: Tag[];
        title: string;
        tools: string[];
        totalBookmarks: number;
        totalComments?: number;
        totalView: number;
        type: "illust" | "manga" | "ugoira";
        user: PixivUser;
        visible: boolean;
        width: number;
        xRestrict: number;
    }
    Index

    Properties

    caption: string

    Work caption / description (may contain HTML).

    commentAccessControl?: number

    Controls who can post comments (may be absent).

    createDate: string

    ISO 8601 date-time string of when the work was posted.

    height: number

    Canvas height in pixels.

    id: number

    Work ID.

    Illusts and novels are numbered in separate sequences — the same ID can appear in both.

    illustAiType: number

    AI-generated content flag: 0 = no AI, 1 = partial AI, 2 = fully AI

    illustBookStyle: number

    Book-style rendering flag (0 = normal, 1 = book).

    imageUrls: ImageUrls

    Thumbnail image URLs at various sizes.

    isBookmarked: boolean

    Whether the authenticated user has bookmarked this work.

    isMuted: boolean

    Whether the work is muted for the authenticated user.

    metaPages: MetaPages[]

    Per-page image URLs for multi-page works (empty array for single-page).

    metaSinglePage: MetaSinglePage | Record<string, never>

    For single-page works: { originalImageUrl: string }. For multi-page works (manga): {} (empty object; originalImageUrl will be undefined).

    pageCount: number

    Number of images in a multi-page work (1 for single-page).

    restrict: number

    Content restriction level (0 = public, 1 = mypixiv-only, 2 = private).

    restrictionAttributes?: string[]

    Additional access-restriction attributes (may be absent).

    sanityLevel: number

    Sanity / sensitivity level assigned by the pixiv content filter.

    series: Series | null

    Series this work belongs to, or null if not part of a series.

    tags: Tag[]

    Tags attached to the work.

    title: string

    Title of the work.

    tools: string[]

    Creation tools listed by the author (e.g. "Photoshop").

    totalBookmarks: number

    Total number of bookmarks.

    totalComments?: number

    Total number of comments (may be absent on some endpoints).

    totalView: number

    Total number of views.

    type: "illust" | "manga" | "ugoira"

    Work category: illustration, manga, or animated illustration.

    user: PixivUser

    Author of the work.

    visible: boolean

    Whether the work is publicly visible.

    width: number

    Canvas width in pixels.

    xRestrict: number

    Age restriction: 0 = all-ages, 1 = R-18, 2 = R-18G