waifuim
    Preparing search index...

    Interface SearchImagesOptions

    interface SearchImagesOptions {
        byteSize?: string | number;
        childrenReviewStatus?: ReviewStatusFilter;
        excludedArtists?: string | string[];
        excludedIds?: string | string[];
        excludedTags?: string | string[];
        height?: string | number;
        includedArtists?: string | string[];
        includedIds?: string | string[];
        includedTags?: string | string[];
        isAnimated?: AnimatedMode;
        isNsfw?: NsfwMode;
        orderBy?: ImageOrderBy;
        orientation?: ImageOrientationFilter;
        page?: number;
        pageSize?: number;
        reviewStatus?: ReviewStatusFilter;
        uploaderId?: number;
        width?: string | number;
    }
    Index

    Properties

    byteSize? childrenReviewStatus? excludedArtists? excludedIds? excludedTags? height? includedArtists? includedIds? includedTags? isAnimated? isNsfw? orderBy? orientation? page? pageSize? reviewStatus? uploaderId? width?

    Properties

    byteSize?: string | number

    Filter by file size in bytes. Examples: 1000000 (exact), >=500000 (min), <=2000000 (max), 500000..2000000 (range).

    childrenReviewStatus?: ReviewStatusFilter

    Filter child entities (tags, artists) by review status (Moderator/Admin only). Default: Accepted.

    excludedArtists?: string | string[]

    Exclude images by these artists (by ID).

    Example: [1]

    excludedIds?: string | string[]

    Exclude these specific image IDs.

    Example: [8108]

    excludedTags?: string | string[]

    Exclude images with ANY of these tags.

    Example: ['uniform', 'maid']

    height?: string | number

    Filter by height in pixels. Examples: 1080 (exact), >=1080 (min), <=1080 (max), 720..1080 (range).

    includedArtists?: string | string[]

    Only include images by these artists (by ID, AND logic).

    Example: [1]

    includedIds?: string | string[]

    Only include these specific image IDs.

    Example: [8108, 8008]

    includedTags?: string | string[]

    Only include images with ALL these tags (AND logic).

    Example: ['waifu', 'maid']

    isAnimated?: AnimatedMode

    Filter by animation status. Default: all.

    isNsfw?: NsfwMode

    Filter by NSFW status. Default: false (SFW only).

    orderBy?: ImageOrderBy

    Sort order. Default: random.

    Note: AddedToAlbum only works on album images endpoint.

    orientation?: ImageOrientationFilter

    Filter by image orientation. Default: all.

    Optionalpage

    page?: number

    Page number for pagination. Default: 1.

    pageSize?: number

    Number of results per page. Default: 1. Max: unlimited.

    reviewStatus?: ReviewStatusFilter

    Filter by review status (Moderator/Admin only). Default: Accepted.

    uploaderId?: number

    Filter by uploader user ID (Moderator/Admin only).

    width?: string | number

    Filter by width in pixels. Examples: 1920 (exact), >=1920 (min), <=1920 (max), 1280..1920 (range).

    Settings

    Member Visibility

    On This Page

    Properties