Class igApi

Constructors

constructor

new igApi(IgCookie?, AxiosOpts?): igApi
Recommended to set cookie for most all IG Request
Parameters
- IgCookie: string = ''
  cookie you can get it by using getSessionId function, see README.md or example file
- AxiosOpts: AxiosRequestConfig<any> = {}
Returns igApi
- Defined in index.ts:36

Properties

AxiosOpts

AxiosOpts: AxiosRequestConfig<any> = {}

Methods

_getReels

_getReels(ids): Promise<HMedia>
get media urls from highlight id
Parameters
- ids: string
  of highlight
Returns Promise<HMedia>
- Defined in index.ts:399

_getReelsIds

_getReelsIds(username): Promise<ReelsIds[]>
Fetch all reels/highlight id
Parameters
- username: string
Returns Promise<ReelsIds[]>
- Defined in index.ts:374

accountInfo

accountInfo(userID?): Promise<UserGraphQL>
fetch client account profile
Parameters
- userID: string = ...
Returns Promise<UserGraphQL>
- Defined in index.ts:216

addPost

addPost(photo, type?, options): Promise<PostFeedResult | PostStoryResult>
Post a photo to instagram
Parameters
- photo: string | Buffer<ArrayBufferLike>
  file path or Buffer
- type: "feed" | "story" = 'feed'
  post type
- options: MediaConfigureOptions
Returns Promise<PostFeedResult | PostStoryResult>
- Defined in index.ts:619

changeProfilePicture

changeProfilePicture(photo): Promise<IChangedProfilePicture>
Parameters
- photo: string | Buffer<ArrayBufferLike>
  input must be filepath or buffer
Returns Promise<IChangedProfilePicture>
- Defined in index.ts:680

fetchHighlights

fetchHighlights(username): Promise<IHighlightsMetadata>
fetches highlight metadata
Parameters
- username: string
  username target to fetch the highlights, also work with private profile if you use cookie \w your account that follows target account
Returns Promise<IHighlightsMetadata>
- Defined in index.ts:427

fetchPost

fetchPost(url): Promise<IPostModels>
Parameters
- url: string
Returns Promise<IPostModels>
- Defined in index.ts:161

fetchPostByMediaId

fetchPostByMediaId(mediaId): Promise<IRawBody>
Parameters
- mediaId: string | number
Returns Promise<IRawBody>
- Defined in index.ts:184

fetchPostByShortcode

fetchPostByShortcode(shortcode): Promise<PostGraphQL>
Parameters
- shortcode: string
Returns Promise<PostGraphQL>
- Defined in index.ts:196

fetchStories

fetchStories(username): Promise<IGStoriesMetadata>
fetches stories metadata
Parameters
- username: string
  username target to fetch the stories, also work with private profile if you use cookie \w your account that follows target account
Returns Promise<IGStoriesMetadata>
- Defined in index.ts:347

fetchUser

fetchUser(username): Promise<IGUserMetadata>
fetch profile by username. including email, phone number
Parameters
- username: string
Returns Promise<IGUserMetadata>
- Defined in index.ts:236

fetchUserIDPostsV2

fetchUserIDPostsV2(userId, next_max_id?, num_posts?): Promise<IPaginatedPosts>
fetches user posts, with pagination
Parameters
- userId: string
- next_max_id: string = ''
  get next_max_id by fetchUserPostsV2 first
- num_posts: number = 12
  number of posts to fetch (default 12)
Returns Promise<IPaginatedPosts>
- Defined in index.ts:495

fetchUserPosts

fetchUserPosts(username, end_cursor?): Promise<IPaginatedPosts>
fetches user posts, with pagination
Parameters
- username: string
- end_cursor: string = ''
  get end_cursor by fetch user posts first
Returns Promise<IPaginatedPosts>
Deprecated
Does not return all information about a post, use fetchUserPostsV2()
- Defined in index.ts:461

fetchUserPostsV2

fetchUserPostsV2(username, next_max_id?, num_posts?): Promise<IPaginatedPosts>
fetches user posts, with pagination
Parameters
- username: string
- next_max_id: string = ''
  get next_max_id by fetchUserPostsV2 first
- num_posts: number = 12
  number of posts to fetch (default 12)
Returns Promise<IPaginatedPosts>
- Defined in index.ts:482

fetchUserReel

fetchUserReel(username, end_cursor?, count?): Promise<ProfileReel>
fetch user reel same as reel tab on app
Parameters
- username: string
  username ig
- end_cursor: undefined | null | string = ''
- count: number = 12
Returns Promise<ProfileReel>
- Defined in index.ts:516

fetchUserV2

fetchUserV2(username): Promise<UserGraphQlV2>
hmmm..?
Parameters
- username: string
Returns Promise<UserGraphQlV2>
- Defined in index.ts:272

getIdByUsername

getIdByUsername(username): Promise<string>
get user id by username
Parameters
- username: string
Returns Promise<string>
- Defined in index.ts:89

getReelData

getReelData(code): Promise<any>
Parameters
- code: string
Returns Promise<any>
- Defined in index.ts:540

isFollowMe

isFollowMe(username): Promise<undefined | boolean>
simple method to check is user follow me
Parameters
- username: string
Returns Promise<undefined | boolean>
true if user is follow me
- Defined in index.ts:287

searchFollower

searchFollower(userId, seachTerm): Promise<ISearchFollow>
Parameters
- userId: string
- seachTerm: string
Returns Promise<ISearchFollow>
- Defined in index.ts:94

searchFollowing

searchFollowing(userId, seachTerm): Promise<ISearchFollow>
Parameters
- userId: string
- seachTerm: string
Returns Promise<ISearchFollow>
- Defined in index.ts:103