Skip to content

Main Navigation Guide API Examples

Appearance

Sidebar Navigation

API reference

Classes

AccountSuspendedError

BadPasswordError

CaaTwoFactorRequiredError

ChallengeRequiredError

ClientForbiddenError

ClientJsonError

ClientSchemaError

FakeTransport

FeedbackRequiredError

FetchTransport

FileSessionStore

HttpsTransport

IgApiError

IgError

IgFlare

IgResponseError

InvalidVerificationCodeError

LoginRequiredError

MemorySessionStore

PleaseWaitError

PrivateClient

RateLimitError

RetryTransport

SentryBlockError

TwoFactorRequiredError

Interfaces

AccountApi

Activity

AlbumUploadOptions

ApiErrorPayload

AuthState

BaseHeadersInput

BloksActionOptions

CaaLoginCredentials

CaaLoginOptions

Challenge

CollectionApi

CollectionPageOptions

CommentListOptions

CommentOptions

ContentInsightsOptions

CreateHighlightOptions

CreateNoteOptions

CreateSessionOptions

CursorOptions

DeviceProfile

DeviceState

DirectApi

EditHighlightOptions

EditMediaOptions

EncryptPasswordOptions

EndpointDefinition

ExploreApi

ExploreOptions

FeedApi

FeedOptions

FollowListOptions

FriendshipApi

GenerateUsdidOptions

HashtagApi

HideThreadOptions

HighlightApi

HttpRequest

HttpResponse

HttpsTransportOptions

HttpTransport

IgFlareOptions

ImageSize

InsightsApi

InsightsRange

LocationApi

LocationState

LoginCredentials

MediaApi

MuteOptions

NotesApi

Page

PasswordPublicKey

PhotoUploadOptions

PrivateClientOptions

PrivateRequestInput

PrivateResponseJson

ReactionOptions

ReelsApi

ReelsPageOptions

ReelUploadOptions

RegistrationTokenOptions

ReplyListOptions

RetryOptions

SaveOptions

SearchApi

SessionData

SessionStore

ShareMediaOptions

Signer

StoryApi

TotpOptions

TwoFactorOptions

UploadApi

UsdidHeaderOptions

UsdidIdentity

UserApi

UserReelsOptions

UserTag

VideoMeta

VideoUploadOptions

VoiceOptions

Type Aliases

AccountInsights

ActivityItem

AlbumItem

AudienceInsights

BioLink

BodyEncoding

Collection

Comment

ContentInsight

DirectMessage

DirectSendResult

EndpointName

FakeHandler

FriendshipStatus

Hashtag

Highlight

HttpMethod

IgFlareLogin

InsightMetric

InsightsContentType

InsightsTime

Location

LocationInfo

Media

MediaInsights

Note

NoteAudience

PrivateRequestOptions

RecipientSearchMode

Reel

SendTarget

Thread

TwoFactorSource

User

Variables

accountInsightsSchema

activityItemSchema

API_DOMAIN

ATTESTATION_KEYSTORE_ERROR

audienceInsightsSchema

bioLinkSchema

CAA_API_DOMAIN

CHALLENGE_EMAIL

CHALLENGE_SMS

collectionSchema

commentSchema

contentInsightSchema

contentPageSchema

DEFAULT_DEVICE_PROFILE

DEFAULT_LOCATION

directMessageSchema

directSendResultSchema

endpoints

friendshipStatusSchema

hashtagSchema

highlightSchema

insightMetricSchema

locationInfoSchema

locationSchema

mediaInsightsSchema

mediaSchema

noteSchema

reelSchema

threadSchema

USDID_TOKEN_TTL

userSchema

Functions

addCloseFriend

addThreadUsers

applyResponseToSession

approveRequest

approveThread

archiveMedia

base64url

blockUser

bloksAsyncAction

buildAttestationParams

buildBaseHeaders

buildPrivateRequest

buildSignedBody

buildUsdidHeader

buildUsdidRegistrationToken

buildUserAgent

caaLogin

commentMedia

createCollection

createDeviceState

createGroupThread

createHighlight

createNote

createSession

createSigner

deleteCollection

deleteComment

deleteComments

deleteHighlight

deleteMedia

deleteMessage

deleteNote

denyRequest

editHighlight

editMedia

encryptPassword

fetchPasswordPublicKey

findThreadByParticipants

followUser

generateAndroidDeviceId

generateTotp

generateUsdidIdentity

generateUuid

getAccountInsights

getActivity

getAudienceInsights

getBioLinks

getCollectionMedias

getCommentReplies

getComments

getContentInsights

getCurrentUser

getExploreFeed

getExploreReels

getFollowers

getFollowing

getFriendshipStatus

getFriendsReels

getHashtagFeed

getHashtagInfo

getHighlight

getInbox

getLikedMedias

getLikers

getLocationFeed

getLocationInfo

getMediaInfo

getNotes

getPendingInbox

getPendingRequests

getPostInsights

getReelInsights

getReelsFeed

getReelsTray

getSavedPosts

getSpamInbox

getThread

getTimelineFeed

getUserFeed

getUserInfo

getUserInfoByUsername

getUserReels

getUserStories

hideThread

jazoest

likeComment

likeMedia

listCollections

listHighlights

login

markMessageSeen

markStoriesSeen

muteThread

muteUser

paginate

paginateCollectionMedias

paginateCommentReplies

paginateComments

paginateContentInsights

paginateExploreFeed

paginateExploreReels

paginateFollowers

paginateFollowing

paginateHashtagFeed

paginateInbox

paginateLikedMedias

paginateLocationFeed

paginatePendingInbox

paginatePendingRequests

paginateReelsFeed

paginateSavedPosts

paginateSpamInbox

paginateThread

paginateTimeline

paginateUserFeed

paginateUserReels

parseJpegSize

parseMp4Meta

parsePrivateResponse

parseSessionData

pinComment

pinMedia

quotePlus

reactToMessage

removeBioLinks

removeCloseFriend

removeFollower

removeProfilePicture

resolveCaaTwoFactor

resolveTwoFactorCode

saveMedia

searchHashtags

searchNearby

searchPlaces

searchRecipients

searchUsers

selectChallengeMethod

sendLink

sendPhoto

sendText

sendVideo

sendVoice

setBiography

setBioLink

setName

setProfilePicture

setThreadTitle

shareMedia

shareProfile

shareStory

signUsdid

startChallenge

submitChallengeCode

twoFactorLogin

unarchiveMedia

unblockUser

unfollowUser

unlikeComment

unlikeMedia

unmuteThread

unmuteUser

unpinComment

unpinMedia

unsaveMedia

uploadAlbum

uploadPhoto

uploadReel

uploadStoryPhoto

uploadVideo

usdidPublicKeyDer

On this page

Interface: AlbumUploadOptions

Options for a carousel post.

Properties

Property	Modifier	Type
`caption?`	`readonly`	`string`

Edit this page on GitHub

Pager

Previous pageActivity

Next pageApiErrorPayload

MIT License. Not affiliated with, endorsed or sponsored by Meta or Instagram.

Copyright 2026 Matheus Oliveira