Interface: FeedApi

Media feeds.

Methods

hashtag()

hashtag(tag, options?): Promise<Page<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>>;

One page of the posts for a hashtag, ranked by relevance (see LIMITATIONS.md).

Parameters

Parameter	Type
tag	string
options?	FeedOptions

Returns

Promise<Page<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>>

---

location()

location(locationId, options?): Promise<Page<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>>;

One page of the recent posts at a place.

Parameters

Parameter	Type
locationId	string
options?	FeedOptions

Returns

Promise<Page<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>>

---

paginateHashtag()

paginateHashtag(tag): AsyncGenerator<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>;

Walks the posts for a hashtag, one at a time across pages.

Parameters

Parameter	Type
tag	string

Returns

AsyncGenerator<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>

---

paginateLocation()

paginateLocation(locationId): AsyncGenerator<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>;

Walks the recent posts at a place, one at a time across pages.

Parameters

Parameter	Type
locationId	string

Returns

AsyncGenerator<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>

---

paginateTimeline()

paginateTimeline(): AsyncGenerator<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>;

Walks the home timeline, one post at a time across pages.

Returns

AsyncGenerator<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>

---

paginateUser()

paginateUser(pk): AsyncGenerator<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>;

Walks a user's posts, one at a time across pages.

Parameters

Parameter	Type
pk	string

Returns

AsyncGenerator<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>

---

timeline()

timeline(options?): Promise<Page<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>>;

One page of the home timeline.

Parameters

Parameter	Type
options?	FeedOptions

Returns

Promise<Page<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>>

---

user()

user(pk, options?): Promise<Page<{
[key: string]: unknown;
  caption?:   | {
   [key: string]: unknown;
     text?: string;
   }
     | null;
  code?: string;
  comment_count?: number | null;
  id?: string;
  image_versions2?: {
   [key: string]: unknown;
     candidates?: object[];
  };
  like_count?: number | null;
  media_type?: number;
  pk?: string;
  taken_at?: number;
  user?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  usertags?:   | {
   [key: string]: unknown;
     in?: object[];
   }
     | null;
  video_versions?: object[] | null;
}>>;

One page of a user's posts.

Parameters

Parameter	Type
pk	string
options?	FeedOptions

Returns

Promise<Page<{ [key: string]: unknown; caption?: | { [key: string]: unknown; text?: string; } | null; code?: string; comment_count?: number | null; id?: string; image_versions2?: { [key: string]: unknown; candidates?: object[]; }; like_count?: number | null; media_type?: number; pk?: string; taken_at?: number; user?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; usertags?: | { [key: string]: unknown; in?: object[]; } | null; video_versions?: object[] | null; }>>