Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

instagram

package module

Go to main page

Versions in this module

v1

v1.4.1

Aug 4, 2026

v1.4.0

Aug 4, 2026

Changes in this version

+ const PublishingCaptureVersion

+ var ErrAccountMismatch = errors.New("instagram: authenticated account mismatch")

+ var ErrFeedbackRequired = errors.New("instagram: feedback required")

+ var ErrInvalidPublishInput = errors.New("instagram: invalid publishing input")

+ var ErrMutationPrecondition = errors.New("instagram: mutation precondition failed")

+ var ErrPartialUpload = errors.New("instagram: partial upload")

+ var ErrProcessingFailed = errors.New("instagram: media processing failed")

+ var ErrProcessingTimeout = errors.New("instagram: media processing timed out")

+ var ErrPublishingCaptureRequired = errors.New("instagram: verified publishing capture required")

+ var ErrUploadTooLarge = errors.New("instagram: upload too large")

+ type AccountMismatchError struct

+ ActualAccountID string

+ ExpectedAccountID string

+ func (e *AccountMismatchError) Error() string

+ func (e *AccountMismatchError) Unwrap() error

+ type AccountMutationResult struct

+ AccountID string

+ After T

+ Before T

+ Verified bool

+ type AccountSearchResult struct

+ HasMore bool

+ NumResults int

+ PageToken string

+ RankToken string

+ Users []*User

+ type AccountSettings struct

+ AccountID string

+ IsPrivate bool

+ Profile ProfileFields

type Client

+ func (c *Client) DeleteMedia(ctx context.Context, mediaID string, kind PublishedMediaKind) error

+ func (c *Client) GetAccountSettings(ctx context.Context) (*AccountSettings, error)

+ func (c *Client) GetCurrentAccount(ctx context.Context) (*CurrentAccount, error)

+ func (c *Client) GetDirectInbox() *Iterator[*DirectThread]

+ func (c *Client) GetDirectThread(threadID string) *Iterator[*DirectItem]

+ func (c *Client) GetProfessionalAccountState(ctx context.Context) (*ProfessionalAccountState, error)

+ func (c *Client) KeywordTypeahead(ctx context.Context, query string) ([]string, error)

+ func (c *Client) PublishPhoto(ctx context.Context, in PublishPhotoInput) (*PublishResult, error)

+ func (c *Client) PublishReel(ctx context.Context, in PublishReelInput) (*PublishResult, error)

+ func (c *Client) PublishStory(ctx context.Context, in PublishStoryInput) (*PublishResult, error)

+ func (c *Client) SearchAccounts(ctx context.Context, query string) (*AccountSearchResult, error)

+ func (c *Client) SearchKeywordPosts(query string) *Iterator[*Post]

+ func (c *Client) SearchPosts(query string) *Iterator[*Post]

+ func (c *Client) SearchReels(query string) *Iterator[*Post]

+ func (c *Client) SearchTypeaheadUsers(ctx context.Context, query string, count int) (*TypeaheadSearchResult, error)

+ func (c *Client) SendDirectText(ctx context.Context, in DirectTextRequest) (*DirectSendResult, error)

+ func (c *Client) SetPrivacy(ctx context.Context, p SetPrivacyParams) (*AccountMutationResult[bool], error)

+ func (c *Client) UpdateProfessionalSettings(ctx context.Context, p UpdateProfessionalSettingsParams) (*AccountMutationResult[ProfessionalSettings], error)

+ func (c *Client) UpdateProfileFields(ctx context.Context, p UpdateProfileFieldsParams) (*AccountMutationResult[ProfileFields], error)

+ type CurrentAccount struct

+ AccountID string

+ AccountType int

+ IsPrivate bool

+ IsProfessional bool

+ Profile ProfileFields

+ Username string

+ type DirectItem struct

+ ClientContext string

+ ID string

+ IsSentByViewer bool

+ ItemType string

+ Raw json.RawMessage

+ Text string

+ ThreadID string

+ Timestamp int64

+ UserID string

+ type DirectSendError struct

+ ClientContext string

+ Err error

+ RetryToken string

+ ThreadID string

+ func (e *DirectSendError) Error() string

+ func (e *DirectSendError) Unwrap() error

+ type DirectSendResult struct

+ ClientContext string

+ ItemID string

+ RecipientID string

+ Status string

+ ThreadID string

+ type DirectTextRequest struct

+ ClientContext string

+ RecipientID string

+ RetryToken string

+ Text string

+ ThreadID string

+ type DirectThread struct

+ ID string

+ IsGroup bool

+ IsPending bool

+ Items []*DirectItem

+ LastActivityAt int64

+ Muted bool

+ Raw json.RawMessage

+ ReadState int

+ Title string

+ Users []*User

type Iterator

+ func (it *Iterator[T]) WithCursor(cursor string) *Iterator[T]

+ type MutationPreconditionError struct

+ Field string

+ Reason string

+ func (e *MutationPreconditionError) Error() string

+ func (e *MutationPreconditionError) Unwrap() error

type Option

+ func WithAPIAppID(id string) Option

+ func WithAPIHost(host string) Option

+ func WithAPIUserAgent(ua string) Option

+ func WithPublishingLimits(photoBytes, videoBytes int64) Option

+ func WithPublishingTimeouts(upload, processing time.Duration) Option

+ func WithWWWHost(host string) Option

+ type ProfessionalAccountState struct

+ AccountID string

+ AccountType int

+ CategoryName string

+ IsBusiness bool

+ IsProfessional bool

+ Settings ProfessionalSettings

+ type ProfessionalSettings struct

+ CategoryID string

+ DisplayCategory bool

+ type ProfileFields struct

+ Biography string

+ ExternalURL string

+ FullName string

+ type PublishError struct

+ ClientID string

+ Partial bool

+ Stage string

+ Underlying error

+ UploadID string

+ func (e *PublishError) Error() string

+ func (e *PublishError) Unwrap() []error

+ type PublishPhotoInput struct

+ Caption string

+ IdempotencyKey string

+ Media UploadSource

+ type PublishReelInput struct

+ Caption string

+ IdempotencyKey string

+ Media UploadSource

+ Thumbnail UploadSource

+ type PublishResult struct

+ ClientID string

+ Code string

+ Kind PublishedMediaKind

+ MediaID string

+ UploadID string

+ type PublishStoryInput struct

+ Caption string

+ IdempotencyKey string

+ Media UploadSource

+ Thumbnail *UploadSource

+ type PublishedMediaKind string

+ const PublishedMediaPhoto

+ const PublishedMediaReel

+ const PublishedMediaStory

+ type SetPrivacyParams struct

+ After *bool

+ Before *bool

+ Confirm bool

+ ExpectedAccountID string

+ type TypeaheadSearchResult struct

+ RankToken string

+ Users []*User

+ type UpdateProfessionalSettingsParams struct

+ After *ProfessionalSettings

+ Before *ProfessionalSettings

+ Confirm bool

+ ExpectedAccountID string

+ type UpdateProfileFieldsParams struct

+ After *ProfileFields

+ Before *ProfileFields

+ Confirm bool

+ ExpectedAccountID string

+ type UploadSource struct

+ Duration time.Duration

+ Filename string

+ Height int

+ MIMEType string

+ Reader io.Reader

+ Size int64

+ Width int

type User

+ IsSearchBoosted bool

+ SearchSERPType string

+ SearchSocialContext string

+ SocialContext string

v1.3.0

Jun 13, 2026

Changes in this version

+ type LoginParams struct

+ HTTPClient *http.Client

+ Password string

+ ProxyURL string

+ SidecarURL string

+ Username string

+ VerificationCode string

+ VerificationProvider func(ctx context.Context) (string, error)

+ type LoginResult struct

+ Cookies Cookies

+ FinalURL string

+ func Login(ctx context.Context, p LoginParams) (LoginResult, error)

v1.2.2

Apr 22, 2026

v1.2.1

Apr 22, 2026

v1.2.0

Apr 22, 2026

v1.1.0

Apr 22, 2026

Changes in this version

+ var ErrCSRF = errors.New("instagram: csrf token rejected")

+ var ErrChallengeRequired = errors.New("instagram: checkpoint / challenge required")

+ var ErrInvalidAuth = errors.New("instagram: invalid auth")

+ var ErrMediaUnavailable = errors.New("instagram: media unavailable")

+ var ErrNotFound = errors.New("instagram: not found")

+ var ErrPrivateAccount = errors.New("instagram: private account")

+ var ErrRateLimited = errors.New("instagram: rate limited")

+ var ErrSessionExpired = errors.New("instagram: session expired or invalidated")

+ var ErrUnexpectedResponse = errors.New("instagram: unexpected response")

+ var ErrWriteSoftBlock = errors.New("instagram: write soft-blocked")

+ type APIError struct

+ Body string

+ Method string

+ Status string

+ StatusCode int

+ URL string

+ func (e *APIError) Error() string

+ type AudioInfo struct

+ ArtistName string

+ AudioAssetID string

+ DurationMs int64

+ IPADURL string

+ OriginalAudio bool

+ OwnerID string

+ ProgressiveURL string

+ Title string

+ type Client struct

+ func New(cookies Cookies, opts ...Option) (*Client, error)

+ func (c *Client) Block(ctx context.Context, userID string) (*FriendshipStatus, error)

+ func (c *Client) DeleteComment(ctx context.Context, mediaPK, commentID string) error

+ func (c *Client) Follow(ctx context.Context, userID string) (*FriendshipStatus, error)

+ func (c *Client) FollowHashtag(ctx context.Context, name string) error

+ func (c *Client) GetCommentLikers(ctx context.Context, mediaPK, commentID string) ([]*User, error)

+ func (c *Client) GetCommentReplies(mediaPK, parentID string) *Iterator[*Comment]

+ func (c *Client) GetComments(mediaPK string) *Iterator[*Comment]

+ func (c *Client) GetExplore() *Iterator[*Post]

+ func (c *Client) GetFollowers(userID string) *Iterator[*User]

+ func (c *Client) GetFollowing(userID string) *Iterator[*User]

+ func (c *Client) GetFriendship(ctx context.Context, userID string) (*FriendshipStatus, error)

+ func (c *Client) GetFriendships(ctx context.Context, userIDs []string) (map[string]*FriendshipStatus, error)

+ func (c *Client) GetHashtag(ctx context.Context, name string) (*Hashtag, error)

+ func (c *Client) GetHashtagClips(name string) *Iterator[*Post]

+ func (c *Client) GetHashtagPosts(name string) *Iterator[*Post]

+ func (c *Client) GetHashtagTopPosts(name string) *Iterator[*Post]

+ func (c *Client) GetHighlights(ctx context.Context, userID string) ([]*StoryReel, error)

+ func (c *Client) GetLikers(ctx context.Context, mediaPK string) ([]*User, error)

+ func (c *Client) GetLocation(ctx context.Context, id string) (*Location, error)

+ func (c *Client) GetLocationPosts(id string) *Iterator[*Post]

+ func (c *Client) GetLocationTopPosts(id string) *Iterator[*Post]

+ func (c *Client) GetPost(ctx context.Context, shortcode string) (*Post, error)

+ func (c *Client) GetPostByID(ctx context.Context, mediaID string) (*Post, error)

+ func (c *Client) GetPosts(userID string) *Iterator[*Post]

+ func (c *Client) GetProfile(ctx context.Context, username string) (*User, error)

+ func (c *Client) GetProfileByID(ctx context.Context, userID string) (*User, error)

+ func (c *Client) GetReels(userID string) *Iterator[*Post]

+ func (c *Client) GetReelsMedia(ctx context.Context, reelIDs []string) (map[string]*StoryReel, error)

+ func (c *Client) GetStoryTray(ctx context.Context) ([]*StoryReel, error)

+ func (c *Client) GetSuggestedUsers(ctx context.Context, targetID string) ([]*User, error)

+ func (c *Client) GetTaggedPosts(userID string) *Iterator[*Post]

+ func (c *Client) GetTimeline() *Iterator[*Post]

+ func (c *Client) GetUserStories(ctx context.Context, userID string) (*StoryReel, error)

+ func (c *Client) LikeComment(ctx context.Context, commentID string) error

+ func (c *Client) LikePost(ctx context.Context, mediaPK string) error

+ func (c *Client) MarkStorySeen(ctx context.Context, reelID, mediaPK string, takenAt int64) error

+ func (c *Client) Me(ctx context.Context) (*User, error)

+ func (c *Client) MutePosts(ctx context.Context, userID string) error

+ func (c *Client) PostComment(ctx context.Context, mediaPK, text string) (*Comment, error)

+ func (c *Client) RateLimit() RateLimitState

+ func (c *Client) SavePost(ctx context.Context, mediaPK string) error

+ func (c *Client) Search(ctx context.Context, query string) (*SearchResult, error)

+ func (c *Client) SearchLocations(ctx context.Context, query string) ([]*Location, error)

+ func (c *Client) SearchUsers(ctx context.Context, query string, count int) ([]*User, error)

+ func (c *Client) Unblock(ctx context.Context, userID string) (*FriendshipStatus, error)

+ func (c *Client) Unfollow(ctx context.Context, userID string) (*FriendshipStatus, error)

+ func (c *Client) UnfollowHashtag(ctx context.Context, name string) error

+ func (c *Client) UnlikeComment(ctx context.Context, commentID string) error

+ func (c *Client) UnlikePost(ctx context.Context, mediaPK string) error

+ func (c *Client) UnmutePosts(ctx context.Context, userID string) error

+ func (c *Client) UnsavePost(ctx context.Context, mediaPK string) error

+ func (c *Client) WaitForCooldown(ctx context.Context) error

+ type ClipsMetadata struct

+ AudioRankingInfo *AudioInfo

+ MusicInfo *AudioInfo

+ OriginalAudioTitle string

+ OriginalSoundInfo *AudioInfo

+ type Comment struct

+ ChildCommentCount int

+ CreatedAt int64

+ HasLikedComment bool

+ ID string

+ LikeCount int

+ ParentCommentID string

+ Raw json.RawMessage

+ Replies []*Comment

+ Text string

+ User *User

+ UserID string

+ type Cookies struct

+ CSRFToken string

+ DSUserID string

+ Datr string

+ IgDid string

+ IgNrcb string

+ Mid string

+ PsL string

+ PsN string

+ Rur string

+ SessionID string

+ Wd string

+ type FriendshipStatus struct

+ Blocking bool

+ FollowedBy bool

+ Following bool

+ IncomingRequest bool

+ IsBestie bool

+ IsFeedFavorite bool

+ IsPrivate bool

+ IsRestricted bool

+ Muting bool

+ OutgoingRequest bool

+ type Hashtag struct

+ Following bool

+ FollowingCount int

+ ID string

+ MediaCount int

+ Name string

+ ProfilePicURL string

+ Raw json.RawMessage

+ type ImageVersion struct

+ Height int

+ URL string

+ Width int

+ type Iterator struct

+ func (it *Iterator[T]) Collect(ctx context.Context) ([]T, error)

+ func (it *Iterator[T]) Cursor() string

+ func (it *Iterator[T]) Err() error

+ func (it *Iterator[T]) Item() T

+ func (it *Iterator[T]) Next(ctx context.Context) bool

+ func (it *Iterator[T]) WithMaxPages(n int) *Iterator[T]

+ type Location struct

+ Address string

+ City string

+ ExternalSource string

+ FacebookPlacesID string

+ ID string

+ Lat float64

+ Lng float64

+ MediaCount int

+ Name string

+ Raw json.RawMessage

+ ShortName string

+ type MediaType int

+ const MediaTypeCarousel

+ const MediaTypePhoto

+ const MediaTypeUnknown

+ const MediaTypeVideo

+ type Option func(*Client)

+ func WithAppID(id string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithMinRequestGap(d time.Duration) Option

+ func WithMinWriteGap(d time.Duration) Option

+ func WithProxy(proxyURL string) Option

+ func WithRateLimitCooldown(read, write time.Duration) Option

+ func WithRetry(maxAttempts int, base time.Duration) Option

+ func WithSkipSessionValidation() Option

+ func WithUserAgent(ua string) Option

+ type Page struct

+ HasMore bool

+ Items []T

+ NextCursor string

+ type PageOptions struct

+ Cursor string

+ Limit int

+ type Place struct

+ Location *Location

+ Subtitle string

+ Title string

+ type Post struct

+ Caption string

+ CaptionUserID string

+ CarouselMedia []*Post

+ ClipsMetadata *ClipsMetadata

+ Code string

+ CommentCount int

+ HasLiked bool

+ Hashtags []string

+ ID string

+ IGTVViewCount int

+ ImageVersions []ImageVersion

+ IsPaidPartner bool

+ IsPinned bool

+ LikeCount int

+ Location *Location

+ MediaType MediaType

+ Mentions []string

+ OriginalHeight int

+ OriginalWidth int

+ Owner *User

+ PK string

+ PermalinkURL string

+ PlayCount int

+ ProductType string

+ Raw json.RawMessage

+ ReshareCount int

+ SaveCount int

+ TakenAt int64

+ VideoDurationS float64

+ VideoVersions []VideoVersion

+ ViewCount int

+ type RateLimitState struct

+ BlockedReason string

+ CapacityLevel int

+ ConnectionQuality string

+ CooldownReadUntil time.Time

+ CooldownWriteUntil time.Time

+ LastBlockedAt time.Time

+ LastReadAt time.Time

+ LastServerElapsedMs int

+ LastWriteAt time.Time

+ OriginRegion string

+ PeakTime bool

+ PeakV2 bool

+ ServerRegion string

+ WriteBlocked bool

+ type SearchResult struct

+ Hashtags []*Hashtag

+ Places []*Place

+ Users []*User

+ type Story struct

+ Audience string

+ ExpiringAt int64

+ ID string

+ ImageVersions []ImageVersion

+ MediaType MediaType

+ Raw json.RawMessage

+ TakenAt int64

+ User *User

+ VideoVersions []VideoVersion

+ type StoryReel struct

+ HasMore bool

+ ID string

+ Items []*Story

+ LatestReelMedia int64

+ Raw json.RawMessage

+ Title string

+ User *User

+ type User struct

+ AccountType int

+ AddressStreet string

+ Biography string

+ BusinessCategory string

+ Category string

+ City string

+ ContactPhone string

+ ExternalURL string

+ FollowerCount int

+ FollowingCount int

+ FriendshipStatus *FriendshipStatus

+ FullName string

+ HasChaining bool

+ HasGuides bool

+ HasHighlightReels bool

+ HasReels bool

+ HideLikeAndViewCnts bool

+ ID string

+ IsBusiness bool

+ IsBusinessOwned bool

+ IsPrivate bool

+ IsProfessional bool

+ IsVerified bool

+ MediaCount int

+ ProfilePicURL string

+ ProfilePicURLHD string

+ Pronouns []string

+ PublicEmail string

+ PublicPhone string

+ Raw json.RawMessage

+ TotalIGTVCount int

+ Username string

+ Zip string

+ type VideoVersion struct

+ Height int

+ Type int

+ URL string

+ Width int