Versions in this module Expand all Collapse all v0 v0.1.1 Jun 10, 2026 Changes in this version type ImageUrls + Original *string v0.1.0 Jun 3, 2026 Changes in this version + var ErrAuthRequired = errors.New("pixivgo: authentication required; call Auth() or SetAuth() first") + func Bool(v bool) *bool + func Int(v int) *int + func ParseNextURL(nextURL *string) url.Values + func String(v string) *string + type AuthResponse struct + AccessToken string + ExpiresIn int + RefreshToken string + Scope string + TokenType string + User UserInfo + type BookmarkDetail struct + IsBookmarked bool + Restrict string + Tags []BookmarkTag + type BookmarkDetailResponse struct + BookmarkDetail BookmarkDetail + type BookmarkTag struct + IsRegistered bool + Name string + type Client struct + func NewClient(opts ...Option) *Client + func (c *Client) Auth(ctx context.Context, refreshToken string) (*AuthResponse, error) + func (c *Client) Clone() *Client + func (c *Client) Download(ctx context.Context, imageURL string, opts *DownloadOptions) (string, error) + func (c *Client) DownloadToWriter(ctx context.Context, imageURL string, w io.Writer) error + func (c *Client) IllustBookmarkAdd(ctx context.Context, params IllustBookmarkAddParams) error + func (c *Client) IllustBookmarkDelete(ctx context.Context, params IllustBookmarkDeleteParams) error + func (c *Client) IllustBookmarkDetail(ctx context.Context, params IllustBookmarkDetailParams) (*BookmarkDetailResponse, error) + func (c *Client) IllustComments(ctx context.Context, params IllustCommentsParams) (*IllustCommentsResponse, error) + func (c *Client) IllustDetail(ctx context.Context, params IllustDetailParams) (*IllustDetailResponse, error) + func (c *Client) IllustFollow(ctx context.Context, params IllustFollowParams) (*IllustListResponse, error) + func (c *Client) IllustNew(ctx context.Context, params IllustNewParams) (*IllustListResponse, error) + func (c *Client) IllustRanking(ctx context.Context, params IllustRankingParams) (*IllustListResponse, error) + func (c *Client) IllustRecommended(ctx context.Context, params IllustRecommendedParams) (*IllustListResponse, error) + func (c *Client) IllustRelated(ctx context.Context, params IllustRelatedParams) (*IllustListResponse, error) + func (c *Client) NovelComments(ctx context.Context, params NovelCommentsParams) (*NovelComments, error) + func (c *Client) NovelDetail(ctx context.Context, params NovelDetailParams) (*NovelInfo, error) + func (c *Client) NovelFollow(ctx context.Context, params NovelFollowParams) (*NovelListResponse, error) + func (c *Client) NovelNew(ctx context.Context, params NovelNewParams) (*NovelListResponse, error) + func (c *Client) NovelRecommended(ctx context.Context, params NovelRecommendedParams) (*NovelListResponse, error) + func (c *Client) NovelSeries(ctx context.Context, params NovelSeriesParams) (*NovelSeriesResponse, error) + func (c *Client) SearchIllust(ctx context.Context, params SearchIllustParams) (*SearchIllustrations, error) + func (c *Client) SearchNovel(ctx context.Context, params SearchNovelParams) (*SearchNovelResponse, error) + func (c *Client) SearchUser(ctx context.Context, params SearchUserParams) (*UserListResponse, error) + func (c *Client) SetAPIProxy(proxyHosts string) + func (c *Client) SetAcceptLanguage(lang string) + func (c *Client) SetAdditionalHeaders(h http.Header) + func (c *Client) SetAuth(accessToken string, refreshToken string) + func (c *Client) ShowcaseArticle(ctx context.Context, params ShowcaseArticleParams) (*ShowcaseArticleResponse, error) + func (c *Client) TrendingTagsIllust(ctx context.Context, params TrendingTagsIllustParams) (*TrendingTagsResponse, error) + func (c *Client) UgoiraMetadata(ctx context.Context, params UgoiraMetadataParams) (*UgoiraMetadataResponse, error) + func (c *Client) UserBookmarkTagsIllust(ctx context.Context, params UserBookmarkTagsIllustParams) (*UserBookmarkTagsResponse, error) + func (c *Client) UserBookmarksIllust(ctx context.Context, params UserBookmarksIllustParams) (*UserBookmarksIllustrations, error) + func (c *Client) UserBookmarksNovel(ctx context.Context, params UserBookmarksNovelParams) (*UserBookmarksNovel, error) + func (c *Client) UserDetail(ctx context.Context, params UserDetailParams) (*UserInfoDetailed, error) + func (c *Client) UserEditAIShowSettings(ctx context.Context, params UserEditAIShowSettingsParams) error + func (c *Client) UserFollowAdd(ctx context.Context, params UserFollowAddParams) error + func (c *Client) UserFollowDelete(ctx context.Context, params UserFollowDeleteParams) error + func (c *Client) UserFollower(ctx context.Context, params UserFollowerParams) (*UserListResponse, error) + func (c *Client) UserFollowing(ctx context.Context, params UserFollowingParams) (*UserFollowing, error) + func (c *Client) UserID() string + func (c *Client) UserIllusts(ctx context.Context, params UserIllustsParams) (*UserIllustrations, error) + func (c *Client) UserList(ctx context.Context, params UserListParams) (*UserListResponse, error) + func (c *Client) UserMyPixiv(ctx context.Context, params UserMyPixivParams) (*UserListResponse, error) + func (c *Client) UserNovels(ctx context.Context, params UserNovelsParams) (*UserNovels, error) + func (c *Client) UserRecommended(ctx context.Context, params UserRecommendedParams) (*UserListResponse, error) + func (c *Client) UserRelated(ctx context.Context, params UserRelatedParams) (*UserListResponse, error) + func (c *Client) WebviewNovel(ctx context.Context, params WebviewNovelParams) (*WebviewNovelResult, error) + type Comment struct + Comment string + Date string + ID FlexInt + ParentComment *Comment + User *CommentUser + type CommentUser struct + Account string + ID FlexInt + Name string + ProfileImageUrls ProfileImageUrls + type DownloadOptions struct + Name string + Path string + Prefix string + Referer string + Replace bool + type Duration string + const WithinLastDay + const WithinLastMonth + const WithinLastWeek + type Filter string + const FilterForIOS + const FilterNone + type FlexInt int + func (fi *FlexInt) UnmarshalJSON(data []byte) error + func (fi FlexInt) Int() int + func (fi FlexInt) MarshalJSON() ([]byte, error) + type IllustBookmarkAddParams struct + IllustID int + NoAuth bool + Restrict Restrict + Tags []string + type IllustBookmarkDeleteParams struct + IllustID int + NoAuth bool + type IllustBookmarkDetailParams struct + IllustID int + NoAuth bool + type IllustCommentsParams struct + IllustID int + IncludeTotalComments *bool + NoAuth bool + Offset *int + type IllustCommentsResponse struct + CommentAccessControl int + Comments []Comment + NextURL *string + TotalComments int + type IllustDetailParams struct + IllustID int + NoAuth bool + type IllustDetailResponse struct + Illust IllustrationInfo + type IllustFollowParams struct + NoAuth bool + Offset *int + Restrict Restrict + type IllustListResponse struct + Illusts []IllustrationInfo + NextURL *string + type IllustNewParams struct + ContentType IllustType + Filter Filter + MaxIllustID *int + NoAuth bool + type IllustRankingParams struct + Date *string + Filter Filter + Mode RankingMode + NoAuth bool + Offset *int + type IllustRecommendedParams struct + BookmarkIllustIDs []string + ContentType IllustType + Filter Filter + IncludePrivacyPolicy *string + IncludeRankingIllusts *bool + IncludeRankingLabel *bool + MaxBookmarkIDForRecommend *int + MinBookmarkIDForRecentIllust *int + NoAuth bool + Offset *int + Viewed []string + type IllustRelatedParams struct + Filter Filter + IllustID int + NoAuth bool + Offset *int + SeedIllustIDs []string + Viewed []string + type IllustType string + const IllustTypeIllust + const IllustTypeManga + type IllustrationInfo struct + Caption string + CreateDate string + Height int + ID FlexInt + IllustAIType int + IllustBookStyle int + ImageUrls ImageUrls + IsBookmarked bool + IsMuted bool + MetaPages []MetaPage + MetaSinglePage MetaSinglePage + PageCount int + Restrict int + RestrictionAttributes []string + SanityLevel int + Series *Series + Tags []IllustrationTag + Title string + Tools []string + TotalBookmarks int + TotalComments *int + TotalView int + Type string + User UserInfo + Visible bool + Width int + XRestrict int + type IllustrationTag struct + Name string + TranslatedName *string + type ImageUrls struct + Large string + Medium string + SquareMedium string + type MetaPage struct + ImageUrls ImageUrls + type MetaSinglePage struct + OriginalImageURL *string + type NovelComments struct + CommentAccessControl int + Comments []Comment + NextURL *string + TotalComments int + type NovelCommentsParams struct + IncludeTotalComments *bool + NoAuth bool + NovelID int + Offset *int + type NovelDetailParams struct + NoAuth bool + NovelID int + type NovelDetailResponse struct + Novel NovelInfo + type NovelFollowParams struct + NoAuth bool + Offset *int + Restrict Restrict + type NovelInfo struct + Caption string + CommentAccessControl *int + CreateDate string + ID FlexInt + ImageUrls ImageUrls + IsBookmarked bool + IsMuted bool + IsMyPixivOnly bool + IsOriginal bool + IsXRestricted bool + NovelAIType int + PageCount int + Restrict int + Series *Series + Tags []NovelTag + TextLength int + Title string + TotalBookmarks int + TotalComments int + TotalView int + User UserInfo + Visible bool + XRestrict int + type NovelListResponse struct + NextURL *string + Novels []NovelInfo + type NovelNavigationInfo struct + ContentOrder string + CoverURL string + ID FlexInt + Title string + Viewable bool + ViewableMessage *string + type NovelNewParams struct + Filter Filter + MaxNovelID *int + NoAuth bool + type NovelRating struct + Bookmark int + Like int + View int + type NovelRecommendedParams struct + AlreadyRecommended []string + Filter Filter + IncludePrivacyPolicy *string + IncludeRankingLabel *bool + IncludeRankingNovels *bool + MaxBookmarkIDForRecommend *int + NoAuth bool + Offset *int + type NovelSeriesParams struct + Filter Filter + LastOrder *string + NoAuth bool + SeriesID int + type NovelSeriesResponse struct + NextURL *string + NovelSeriesDetail any + Novels []NovelInfo + type NovelTag struct + AddedByUploadedUser bool + Name string + TranslatedName *string + type Option func(*Client) + func WithAcceptLanguage(lang string) Option + func WithAdditionalHeaders(h http.Header) Option + func WithBaseURL(baseURL string) Option + func WithHTTPClient(hc *http.Client) Option + type PixivError struct + Body string + Err error + Header http.Header + Message string + StatusCode int + func (e *PixivError) Error() string + func (e *PixivError) Unwrap() error + type Profile struct + AddressID int + BackgroundImageURL string + Birth string + BirthDay string + BirthYear int + CountryCode string + Gender string + IsPremium bool + IsUsingCustomProfileImage bool + Job string + JobID int + PawooURL *string + Region string + TotalFollowUsers int + TotalIllustBookmarksPublic int + TotalIllustSeries int + TotalIllusts int + TotalManga int + TotalMyPixivUsers int + TotalNovelSeries int + TotalNovels int + TwitterAccount string + TwitterURL *string + Webpage *string + type ProfileImageUrls struct + Medium string + type ProfilePublicity struct + BirthDay string + BirthYear string + Gender string + Job string + Pawoo bool + Region string + type RankingMode string + const ModeDay + const ModeDayFemale + const ModeDayFemaleR18 + const ModeDayMale + const ModeDayMaleR18 + const ModeDayManga + const ModeDayR18 + const ModeMonth + const ModeWeek + const ModeWeekOriginal + const ModeWeekR18 + const ModeWeekR18G + const ModeWeekRookie + type Restrict string + const RestrictPrivate + const RestrictPublic + type SearchIllustParams struct + Duration *Duration + EndDate *string + Filter Filter + NoAuth bool + Offset *int + SearchAIType *int + SearchTarget SearchTarget + Sort Sort + StartDate *string + Word string + type SearchIllustrations struct + Illusts []IllustrationInfo + NextURL *string + SearchSpanLimit int + ShowAI bool + type SearchNovelParams struct + EndDate *string + Filter *string + IncludeTranslatedTagResults *string + MergePlainKeywordResults *string + NoAuth bool + Offset *int + SearchAIType *int + SearchTarget SearchTarget + Sort Sort + StartDate *string + Word string + type SearchNovelResponse struct + NextURL *string + Novels []NovelInfo + SearchSpanLimit int + ShowAI bool + type SearchTarget string + const ExactMatchForTags + const Keyword + const PartialMatchForTags + const TitleAndCaption + type SearchUserParams struct + Duration *Duration + Filter Filter + NoAuth bool + Offset *int + Sort Sort + Word string + type Series struct + ID FlexInt + Title string + type ShowcaseArticleParams struct + ShowcaseID int + type ShowcaseArticleResponse struct + Body any + type Sort string + const SortDateAsc + const SortDateDesc + const SortPopularDesc + type TrendTag struct + Illust IllustrationInfo + Tag IllustrationTag + TranslatedName *string + type TrendingTagsIllustParams struct + Filter Filter + NoAuth bool + type TrendingTagsResponse struct + TrendTags []TrendTag + type UgoiraFrame struct + Delay int + File string + type UgoiraMetadata struct + Frames []UgoiraFrame + ZipUrls UgoiraZipUrls + type UgoiraMetadataParams struct + IllustID int + NoAuth bool + type UgoiraMetadataResponse struct + UgoiraMetadata UgoiraMetadata + type UgoiraZipUrls struct + Medium string + type UserBookmarkTag struct + Count int + Name string + type UserBookmarkTagsIllustParams struct + NoAuth bool + Offset *int + Restrict Restrict + UserID int + type UserBookmarkTagsResponse struct + BookmarkTags []UserBookmarkTag + NextURL *string + type UserBookmarksIllustParams struct + Filter Filter + MaxBookmarkID *int + NoAuth bool + Restrict Restrict + Tag *string + UserID int + type UserBookmarksIllustrations struct + Illusts []IllustrationInfo + NextURL *string + type UserBookmarksNovel struct + NextURL *string + Novels []NovelInfo + type UserBookmarksNovelParams struct + Filter Filter + MaxBookmarkID *int + NoAuth bool + Restrict Restrict + Tag *string + UserID int + type UserDetailParams struct + Filter Filter + NoAuth bool + UserID int + type UserEditAIShowSettingsParams struct + NoAuth bool + ShowAI bool + type UserFollowAddParams struct + NoAuth bool + Restrict Restrict + UserID int + type UserFollowDeleteParams struct + NoAuth bool + UserID int + type UserFollowerParams struct + Filter Filter + NoAuth bool + Offset *int + UserID int + type UserFollowing struct + NextURL *string + UserPreviews []UserPreview + type UserFollowingParams struct + NoAuth bool + Offset *int + Restrict Restrict + UserID int + type UserIllustrations struct + Illusts []IllustrationInfo + NextURL *string + User UserInfo + type UserIllustsParams struct + Filter Filter + NoAuth bool + Offset *int + Type IllustType + UserID int + type UserInfo struct + Account string + Comment *string + ID FlexInt + IsAcceptRequest *bool + IsAccessBlockingUser *bool + IsFollowed *bool + Name string + ProfileImageUrls ProfileImageUrls + type UserInfoDetailed struct + Profile Profile + ProfilePublicity ProfilePublicity + User UserInfo + Workspace Workspace + type UserListParams struct + Filter Filter + NoAuth bool + Offset *int + UserID int + type UserListResponse struct + NextURL *string + UserPreviews []UserPreview + type UserMyPixivParams struct + NoAuth bool + Offset *int + UserID int + type UserNovels struct + NextURL *string + Novels []NovelInfo + User UserInfo + type UserNovelsParams struct + Filter Filter + NoAuth bool + Offset *int + UserID int + type UserPreview struct + Illusts []IllustrationInfo + IsMuted bool + Novels []NovelInfo + User UserInfo + type UserRecommendedParams struct + Filter Filter + NoAuth bool + Offset *int + type UserRelatedParams struct + Filter Filter + NoAuth bool + Offset *int + SeedUserID int + type WebviewNovel struct + AIType int + CDate string + Caption string + CoverURL string + GlossaryItems []string + ID string + Illusts []string + Images []string + IsOriginal bool + Marker *string + Rating NovelRating + ReplaceableItemIDs []string + SeriesID *string + SeriesIsWatched *bool + SeriesNavigation *NovelNavigationInfo + SeriesTitle *string + Tags []string + Text string + Title string + UserID string + type WebviewNovelParams struct + NoAuth bool + NovelID int + Raw bool + type WebviewNovelResult struct + Novel *WebviewNovel + RawHTML string + type Workspace struct + Chair string + Comment string + Desk string + Desktop string + Monitor string + Mouse string + Music string + PC string + Printer string + Scanner string + Tablet string + Tool string + WorkspaceImageURL *string