Skip to content

aiograpi Method Coverage

aiograpi-rest wraps a focused subset of aiograpi==0.9.7. It does not expose every public aiograpi.Client method. This page is generated from the installed aiograpi.Client class and the local FastAPI router implementation.

Summary

  • Public aiograpi.Client methods: 500
  • Methods reached by REST routes: 124
  • Methods not exposed as REST routes: 376

Coverage By Area

Area Covered Total
account 6 14
aiograpi 1 1
album 3 6
auth 7 34
bloks 0 2
challenge 1 6
clip 3 10
collection 3 9
comment 6 22
direct 6 45
explore 0 3
fbsearch 1 16
fundraiser 0 1
graphql 0 8
hashtag 4 18
highlight 7 12
igtv 3 4
insights 3 3
location 4 20
media 21 59
multiple_accounts 0 2
note 3 8
notification 1 27
password 0 2
photo 4 10
private 2 13
public 0 9
share 0 3
signup 0 15
story 11 21
timeline 0 4
totp 2 4
track 0 5
user 18 74
video 4 10

REST Routes To aiograpi Methods

REST endpoint aiograpi methods used
GET /account/info account_info
PATCH /account/picture account_change_picture
PATCH /account/privacy account_set_private, account_set_public
PATCH /account/profile account_edit
GET /album/download album_download
GET /album/download/by/urls album_download_by_urls
POST /album/upload album_upload
POST /auth/challenge/resolve challenge_resolve
POST /auth/login login, set_locale, set_proxy, set_timezone_offset
POST /auth/login/by/sessionid login_by_sessionid
PATCH /auth/relogin relogin
GET /auth/settings get_settings
PATCH /auth/settings expose, set_locale, set_proxy, set_settings, set_timezone_offset
GET /auth/timeline/feed get_timeline_feed
DELETE /auth/totp totp_disable
POST /auth/totp/enable totp_enable
GET /clip/download clip_download
GET /clip/download/by/url clip_download_by_url
POST /clip/upload clip_upload
POST /clip/upload/by/url clip_upload
GET /direct/inbox direct_threads_chunk
DELETE /direct/message direct_message_delete
POST /direct/message direct_send
PATCH /direct/message/seen direct_message_seen
GET /direct/thread direct_thread
POST /direct/thread direct_thread_create
DELETE /hashtag/follow hashtag_unfollow
POST /hashtag/follow hashtag_follow
GET /hashtag/info hashtag_info
GET /hashtag/medias/recent hashtag_medias_v1_chunk
GET /hashtag/medias/top hashtag_medias_v1_chunk
DELETE /highlight highlight_delete
PATCH /highlight highlight_edit
POST /highlight highlight_create
GET /highlight/info highlight_info
DELETE /highlight/stories highlight_remove_stories
POST /highlight/stories highlight_add_stories
GET /igtv/download igtv_download
GET /igtv/download/by/url igtv_download_by_url
POST /igtv/upload igtv_upload
POST /igtv/upload/by/url igtv_upload
GET /insights/account insights_account
GET /insights/media insights_media
GET /insights/media/feed/all insights_media_feed_all
GET /location/info location_info
GET /location/medias/recent location_medias_v1_chunk
GET /location/medias/top location_medias_v1_chunk
GET /location/search location_search, location_search_name
DELETE /media media_delete
PATCH /media media_edit
DELETE /media/archive media_unarchive
POST /media/archive media_archive
DELETE /media/comment comment_bulk_delete
POST /media/comment media_comment
DELETE /media/comment/like comment_unlike
POST /media/comment/like comment_like
GET /media/comment/replies media_comment_replies
GET /media/comments media_comments
GET /media/id media_id
GET /media/info media_info
DELETE /media/like media_unlike
POST /media/like media_like
GET /media/liked liked_medias
GET /media/likers media_likers
GET /media/oembed media_oembed
DELETE /media/pin media_unpin
POST /media/pin media_pin
GET /media/pk media_pk
GET /media/pk/from/code media_pk_from_code
GET /media/pk/from/url media_pk_from_url
DELETE /media/save media_unsave
POST /media/save media_save
PATCH /media/seen media_seen
GET /media/user media_user
DELETE /note delete_note
POST /note create_note
GET /notes get_notes
GET /notifications news_inbox_v1
GET /notifications/settings -
PATCH /notifications/settings notification_settings
GET /photo/download photo_download
GET /photo/download/by/url photo_download_by_url
POST /photo/upload photo_upload
POST /photo/upload/by/url photo_upload
DELETE /story story_delete
GET /story/archive archive_story_days_paginated_v1
GET /story/download story_download
GET /story/download/by/url story_download_by_url
GET /story/info story_info
DELETE /story/like story_unlike
POST /story/like story_like
GET /story/pk/from/url story_pk_from_url
PATCH /story/seen story_seen
POST /story/upload photo_upload_to_story, user_stories, video_upload_to_story
POST /story/upload/by/url photo_upload_to_story, user_stories, video_upload_to_story
GET /story/user/stories user_stories
GET /story/viewers story_viewers_chunk
GET /user/about user_about_v1
DELETE /user/block user_unblock
POST /user/block user_block
GET /user/clips user_clips_paginated_v1, user_id_from_username
DELETE /user/follow user_unfollow
POST /user/follow user_follow
GET /user/follow/requests user_follow_requests_chunk
DELETE /user/follower user_remove_follower
GET /user/followers user_followers_v1_chunk
GET /user/following user_following_v1_chunk
GET /user/friendship user_friendship_v1
GET /user/highlights user_highlights
GET /user/id/from/username user_id_from_username
GET /user/info user_info
GET /user/info/by/username user_info_by_username
GET /user/medias user_id_from_username, user_medias_paginated
DELETE /user/mute/posts unmute_posts_from_follow
POST /user/mute/posts mute_posts_from_follow
DELETE /user/mute/stories unmute_stories_from_follow
POST /user/mute/stories mute_stories_from_follow
GET /user/search search_users
GET /user/tagged/medias user_id_from_username, usertag_medias_paginated
GET /user/username/from/id username_from_user_id
GET /user/videos user_id_from_username, user_videos_paginated_v1
GET /video/download video_download
GET /video/download/by/url video_download_by_url
POST /video/upload video_upload
POST /video/upload/by/url video_upload

Full Method Matrix

aiograpi method Area REST endpoint(s)
account_change_picture(self, path: pathlib._local.Path) -> aiograpi.types.UserShort account PATCH /account/picture
account_edit(self, **data: Dict) -> aiograpi.types.Account account PATCH /account/profile
account_info(self) -> aiograpi.types.Account account GET /account/info
account_security_info(self) -> dict account -
account_set_biography(self, biography: str) -> bool account -
account_set_private(self) -> bool account PATCH /account/privacy
account_set_public(self) -> bool account PATCH /account/privacy
accounts_create(self, username: str, password: str, email: str = '', email_code: str = '', phone_number: str = '', phone_code: str = '', full_name: str = '', year: int = None, month: int = None, day: int = None, **kwargs) -> dict signup -
album_configure(self, childs: List, caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> Dict album -
album_download(self, media_pk: int, folder: pathlib._local.Path = '', overwrite: bool = True) -> List[pathlib._local.Path] album GET /album/download
album_download_by_urls(self, urls: List[str], folder: pathlib._local.Path = '', overwrite: bool = True) -> List[pathlib._local.Path] album GET /album/download/by/urls
album_download_origin(self, media_pk: int) -> List[bytes] album -
album_upload(self, paths: List[pathlib._local.Path], caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, configure_timeout: int = 3, configure_handler=None, configure_exception=None, to_story=False, extra_data: Dict[str, str] = {}) -> aiograpi.types.Media album POST /album/upload
album_upload_with_music(self, paths: List[pathlib._local.Path], caption: str, track: Union[aiograpi.types.Track, Dict], usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, configure_timeout: int = 3, configure_handler=None, configure_exception=None, to_story=False, extra_data: Dict[str, str] = {}, audio_asset_start_time: Optional[int] = None, overlap_duration: int = 30000, browse_session_id: Optional[str] = None, alacorn_session_id: Optional[str] = None) -> aiograpi.types.Media album -
archive_medias(self, amount: int = 0) -> List[aiograpi.types.Media] media -
archive_medias_paginated_v1(self, amount: int = 0, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
archive_medias_v1(self, amount: int = 0) -> List[aiograpi.types.Media] media -
archive_stories(self, amount: int = 0) -> List[aiograpi.types.Story] story -
archive_stories_v1(self, amount: int = 0) -> List[aiograpi.types.Story] story -
archive_story_days(self, amount: int = 0, include_memories: bool = True) -> List[aiograpi.types.StoryArchiveDay] story -
archive_story_days_paginated_v1(self, amount: int = 0, end_cursor: str = '', include_memories: bool = True, reel_id: str = '') -> Tuple[List[aiograpi.types.StoryArchiveDay], str] story GET /story/archive
archive_story_days_v1(self, amount: int = 0, include_memories: bool = True) -> List[aiograpi.types.StoryArchiveDay] story -
bloks_action(self, action: str, data: dict) -> bool bloks -
bloks_change_password(self, password: str, challenge_context: dict) -> bool bloks -
chaining(self, user_id: str) -> dict user -
challenge_api(self, data) signup -
challenge_captcha(self, challenge_json_data) signup -
challenge_code_handler(self, username: str, choice=None) private -
challenge_code_or_raised(self, choice: aiograpi.mixins.challenge.ChallengeChoice, wait_seconds: int = 5, attempts: int = 24, challenge_url: str = None, sessionid: str = None) -> str challenge -
challenge_flow(self, data) signup -
challenge_resolve(self, last_json: Dict) -> bool challenge POST /auth/challenge/resolve
challenge_resolve_contact_form(self, challenge_url: str) -> bool challenge -
challenge_resolve_new_password_form(self, result) challenge -
challenge_resolve_simple(self, challenge_url: str) -> bool challenge -
challenge_submit_phone_number(self, data, phone_number) signup -
challenge_verify_sms_captcha(self, data, security_code) signup -
change_password(self, old_password: str, new_password: str) -> bool account -
change_password_handler(self, username: str) private -
check_age_eligibility(self, year, month, day) signup -
check_confirmation_code(self, email, code) -> dict signup -
check_email(self, email) -> dict signup -
check_phone_number(self, phone_number: str) signup -
check_username(self, username) signup -
clip_configure(self, upload_id: str, thumbnail: pathlib._local.Path, width: int, height: int, duration: int, caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, feed_show: str = '1', extra_data: Dict[str, str] = {}) -> Dict clip -
clip_download(self, media_pk: int, folder: pathlib._local.Path = '') -> str clip GET /clip/download
clip_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '') -> str clip GET /clip/download/by/url
clip_info_for_creation(self) -> Dict clip -
clip_pin(self, media_pk: str, revert: bool = False) -> bool clip -
clip_share_to_fb_config(self, device_status: Optional[Dict[str, object]] = None) -> Dict clip -
clip_trial_eligible(self) -> bool clip -
clip_unpin(self, media_pk: str) -> bool clip -
clip_upload(self, path: pathlib._local.Path, caption: str, thumbnail: pathlib._local.Path = None, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, configure_timeout: int = 10, feed_show: str = '1', extra_data: Dict[str, object] = {}, trial: bool = False, trial_graduation_strategy: str = 'manual') -> aiograpi.types.Media clip POST /clip/upload
POST /clip/upload/by/url
clip_upload_as_reel_with_music(self, path: pathlib._local.Path, caption: str, track: aiograpi.types.Track, extra_data: Dict[str, str] = {}) -> aiograpi.types.Media clip -
close_friend_add(self, user_id: str) user -
close_friend_remove(self, user_id: str) user -
collection_medias(self, collection_pk: str, amount: int = 21, last_media_pk: int = 0) -> List[aiograpi.types.Media] collection -
collection_medias_by_name(self, name: str) -> List[aiograpi.types.Collection] collection -
collection_medias_v1(self, collection_pk: str, amount: int = 21, last_media_pk: int = 0) -> List[aiograpi.types.Media] collection -
collection_medias_v1_chunk(self, collection_pk: str, max_id: str = '') -> Tuple[List[aiograpi.types.Media], str] collection -
collection_pk_by_name(self, name: str) -> int collection -
collections(self) -> List[aiograpi.types.Collection] collection -
comment_bulk_delete(self, media_id: str, comment_pks: List[int]) -> bool comment DELETE /media/comment
comment_like(self, comment_pk: int, revert: bool = False) -> bool comment POST /media/comment/like
comment_likers_gql(self, comment_pk: str, amount: int = 0) -> List[dict] comment -
comment_likers_gql_chunk(self, comment_pk: str, end_cursor: str = '') -> Tuple[List[dict], str] comment -
comment_pin(self, media_id: str, comment_pk: int, revert: bool = False) comment -
comment_unlike(self, comment_pk: int) -> bool comment DELETE /media/comment/like
comment_unpin(self, media_id: str, comment_pk: int) comment -
create_music_note(self, track: Union[aiograpi.types.Track, Dict], text: str = '', audience: int = 0, start_time: Optional[int] = None, duration: int = 30000, browse_session_id: Optional[str] = None, alacorn_session_id: Optional[str] = None) -> aiograpi.types.Note note -
create_note(self, text: str, audience: int = 0) -> aiograpi.types.Note note POST /note
creator_info(self, user_id: str, entry_point: str = 'direct_thread') -> Tuple[aiograpi.types.UserShort, Dict] user -
delete_note(self, note_id: int) -> bool note DELETE /note
direct_active_presence(self) -> Dict direct -
direct_answer(self, thread_id: int, text: str) -> aiograpi.types.DirectMessage direct -
direct_delete_reaction(self, thread_id: int, message_id: int, emoji: str = '❤', client_context: Optional[str] = None, action_source: str = 'double_tap', target_item_type: Optional[str] = None) -> bool direct -
direct_media(self, thread_id: int, amount: int = 20) -> List[aiograpi.types.Media] direct -
direct_media_share(self, media_id: str, user_ids: List[int], send_attribute: ('feed_timeline', 'feed_contextual_chain', 'feed_short_url', 'feed_contextual_self_profile', 'feed_contextual_profile') = 'feed_timeline', media_type: str = 'photo') -> aiograpi.types.DirectMessage direct -
direct_message(self, thread_id: int, message_id: int, amount: int = 20) -> aiograpi.types.DirectMessage direct -
direct_message_delete(self, thread_id: int, message_id: int) -> bool direct DELETE /direct/message
direct_message_like(self, thread_id: int, message_id: int, client_context: Optional[str] = None) -> bool direct -
direct_message_search(self, query: str) -> List[Tuple[aiograpi.types.DirectMessage, aiograpi.types.DirectShortThread]] direct -
direct_message_seen(self, thread_id: int, message_id: int) -> bool direct PATCH /direct/message/seen
direct_message_unlike(self, thread_id: int, message_id: int, client_context: Optional[str] = None) -> bool direct -
direct_message_unsend(self, thread_id: int, message_id: int) -> bool direct -
direct_messages(self, thread_id: int, amount: int = 20) -> List[aiograpi.types.DirectMessage] direct -
direct_pending_approve(self, thread_id: int) -> bool direct -
direct_pending_chunk(self, cursor: str = None) -> Tuple[List[aiograpi.types.DirectThread], str] direct -
direct_pending_inbox(self, amount: int = 20) -> List[aiograpi.types.DirectThread] direct -
direct_profile_share(self, user_id: str, user_ids: List[int] = [], thread_ids: List[int] = []) -> aiograpi.types.DirectMessage direct -
direct_request_approve(self, thread_id: int) -> bool direct -
direct_requests(self, amount: int = 20) -> List[aiograpi.types.DirectThread] direct -
direct_search(self, query: str, mode: Literal['raven', 'universal'] = 'universal') -> List[aiograpi.types.UserShort] direct -
direct_send(self, text: str, user_ids: List[int] = [], thread_ids: List[int] = [], send_attribute: Literal['message_button', 'inbox_search'] = 'message_button', reply_to_message: Optional[aiograpi.types.DirectMessage] = None) -> aiograpi.types.DirectMessage direct POST /direct/message
direct_send_cutout_sticker(self, sticker_pk: str, user_ids: List[int] = None, thread_ids: List[int] = None) -> aiograpi.types.DirectMessage direct -
direct_send_file(self, path: pathlib._local.Path, user_ids: List[int] = [], thread_ids: List[int] = [], content_type: str = 'photo') -> aiograpi.types.DirectMessage direct -
direct_send_photo(self, path: pathlib._local.Path, user_ids: List[int] = [], thread_ids: List[int] = []) -> aiograpi.types.DirectMessage direct -
direct_send_reaction(self, thread_id: int, message_id: int, emoji: str = '❤', client_context: Optional[str] = None, action_source: str = 'double_tap', target_item_type: Optional[str] = None) -> bool direct -
direct_send_seen(self, thread_id: int) -> bool direct -
direct_send_video(self, path: pathlib._local.Path, user_ids: List[int] = [], thread_ids: List[int] = []) -> aiograpi.types.DirectMessage direct -
direct_send_voice(self, path: pathlib._local.Path, user_ids: List[int] = [], thread_ids: List[int] = [], waveform: Optional[List[float]] = None) -> aiograpi.types.DirectMessage direct -
direct_spam_chunk(self, cursor: str = None) -> Tuple[List[aiograpi.types.DirectThread], str] direct -
direct_spam_inbox(self, amount: int = 20) -> List[aiograpi.types.DirectThread] direct -
direct_story_share(self, story_id: str, user_ids: List[int] = [], thread_ids: List[int] = []) -> aiograpi.types.DirectMessage direct -
direct_thread(self, thread_id: int, amount: int = 20) -> aiograpi.types.DirectThread direct GET /direct/thread
direct_thread_add_users(self, thread_id: int, user_ids: List[int]) -> bool direct -
direct_thread_by_participants(self, user_ids: List[int]) -> Dict direct -
direct_thread_create(self, user_ids: List[int], title: str = '') -> str direct POST /direct/thread
direct_thread_hide(self, thread_id: int, move_to_spam: bool = False) -> bool direct -
direct_thread_mark_unread(self, thread_id: int) -> bool direct -
direct_thread_mute(self, thread_id: int, revert: bool = False) -> bool direct -
direct_thread_mute_video_call(self, thread_id: int, revert: bool = False) -> bool direct -
direct_thread_unmute(self, thread_id: int) -> bool direct -
direct_thread_unmute_video_call(self, thread_id: int) -> bool direct -
direct_thread_update_title(self, thread_id: int, title: str) -> bool direct -
direct_threads(self, amount: int = 20, selected_filter: Literal['flagged', 'unread'] = '', box: Literal['general', 'primary'] = '', thread_message_limit: Optional[int] = None) -> List[aiograpi.types.DirectThread] direct -
direct_threads_chunk(self, selected_filter: Literal['flagged', 'unread'] = '', box: Literal['general', 'primary'] = '', thread_message_limit: Optional[int] = None, cursor: str = None) -> Tuple[List[aiograpi.types.DirectThread], str] direct GET /direct/inbox
direct_users_presence(self, user_ids: List[int]) -> Dict direct -
disable_posts_notifications(self, user_id: str) -> bool user -
disable_reels_notifications(self, user_id: str) -> bool user -
disable_stories_notifications(self, user_id: str) -> bool user -
disable_videos_notifications(self, user_id: str) -> bool user -
discover_recommended_accounts_for_category_v1(self, user_id: str) -> dict user -
dump_instaman(self) auth -
dump_settings(self, path: Union[str, pathlib._local.Path]) -> bool auth -
enable_posts_notifications(self, user_id: str, disable: bool = False) -> bool user -
enable_reels_notifications(self, user_id: str, revert: bool = False) -> bool user -
enable_stories_notifications(self, user_id: str, revert: bool = False) -> bool user -
enable_videos_notifications(self, user_id: str, revert: bool = False) -> bool user -
explore_page(self) explore -
explore_page_media_info(self, media_pk: int) explore -
explore_reels(self, amount: int = 10, last_media_pk: int = 0) -> List[aiograpi.types.Media] timeline -
expose(self) -> Dict auth PATCH /auth/settings
fbsearch_accounts_v2(self, query: str, page_token: Optional[str] = None) -> dict fbsearch -
fbsearch_item(self, item_id: str, search_surface: str, query: str, timezone_offset: int = 0, count: int = 30, reels_page_index: int = None, has_more_reels: str = None, reels_max_id: str = None, next_max_id: str = None, rank_token: str = None, page_index: int = None, page_token: str = None, paging_token: str = None) -> dict fbsearch -
fbsearch_keyword_typeahead(self, query: str, timezone_offset: int = 0, count: int = 30) -> dict fbsearch -
fbsearch_places(self, query: str, lat: float = 40.74, lng: float = -73.94) -> List[aiograpi.types.Location] fbsearch -
fbsearch_recent(self) -> List[Tuple[int, Union[aiograpi.types.UserShort, aiograpi.types.Hashtag, Dict]]] fbsearch -
fbsearch_reels_v2(self, query: str, reels_max_id: Optional[str] = None, rank_token: Optional[str] = None) -> dict fbsearch -
fbsearch_suggested_profiles(self, user_id: str) -> List[aiograpi.types.UserShort] fbsearch -
fbsearch_topsearch_flat(self, query: str) -> List[dict] fbsearch -
fbsearch_topsearch_v2(self, query: str, next_max_id: Optional[str] = None, reels_max_id: Optional[str] = None, rank_token: Optional[str] = None) -> dict fbsearch -
fbsearch_typeahead_stream(self, query: str, timezone_offset: int = 0, count: int = 30) -> dict fbsearch -
fbsearch_typehead(self, query: str) -> List[dict] fbsearch -
featured_accounts_v1(self, target_user_id: str) -> dict multiple_accounts -
feed_user_stream_item(self, item_id: str, is_pull_to_refresh: bool = False) -> dict user -
fetch_fb_dtsg(self) graphql -
fetch_suggestion_details(self, user_id: str, chained_ids: Union[str, List[Union[str, int]]]) -> dict user -
friends_reels(self, amount: int = 10, last_media_pk: int = 0) -> List[aiograpi.types.Media] timeline -
gen_user_breadcrumb(self, size: int) -> str auth -
generate_android_device_id(self) -> str auth -
generate_mutation_token(self) -> str auth -
generate_uuid(self, prefix: str = '', suffix: str = '') -> str auth -
get_account_family_v1(self) -> dict multiple_accounts -
get_note_by_user(self, notes: List[aiograpi.types.Note], username: str) -> Optional[aiograpi.types.Note] note -
get_note_text_by_user(self, notes: List[aiograpi.types.Note], username: str) -> Optional[str] note -
get_notes(self) -> List[aiograpi.types.Note] note GET /notes
get_prefill_candidates(self, login: bool = False) -> Dict auth -
get_reels_tray_feed(self, reason: Literal['cold_start', 'pull_to_refresh'] = 'pull_to_refresh') -> Dict auth -
get_settings(self) -> Dict auth GET /auth/settings
get_signup_config(self) -> dict signup -
get_timeline_feed(self, reason: Literal['cold_start_fetch', 'warm_start_fetch', 'pagination', 'pull_to_refresh', 'auto_refresh'] = 'pull_to_refresh', max_id: str = None, seen_posts: Union[str, Iterable[str], NoneType] = None, feed_view_info: Union[str, List[Dict[str, Any]], NoneType] = None) -> Dict auth GET /auth/timeline/feed
graphql_request(self, data=None, params=None, headers=None, return_json=True, retries_count=1, retries_timeout=2) graphql -
handle_challenge_result(self, challenge: Dict) challenge -
hashtag_follow(self, hashtag: str, unfollow: bool = False) -> bool hashtag POST /hashtag/follow
hashtag_info(self, name: str) -> aiograpi.types.Hashtag hashtag GET /hashtag/info
hashtag_info_a1(self, name: str, max_id: str = None) -> aiograpi.types.Hashtag hashtag -
hashtag_info_gql(self, name: str, amount: int = 12, end_cursor: str = None) -> aiograpi.types.Hashtag hashtag -
hashtag_info_v1(self, name: str) -> aiograpi.types.Hashtag hashtag -
hashtag_medias_a1(self, name: str, amount: int = 27, tab_key: str = '') -> List[aiograpi.types.Media] hashtag -
hashtag_medias_a1_chunk(self, name: str, max_amount: int = 27, tab_key: str = '', end_cursor: str = None) -> Tuple[List[aiograpi.types.Media], str] hashtag -
hashtag_medias_recent(self, name: str, amount: int = 27) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_recent_a1(self, name: str, amount: int = 71) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_recent_v1(self, name: str, amount: int = 27) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_reels_v1(self, name: str, amount: int = 27) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_top(self, name: str, amount: int = 9) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_top_a1(self, name: str, amount: int = 9) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_top_v1(self, name: str, amount: int = 9) -> List[aiograpi.types.Media] hashtag -
hashtag_medias_v1(self, name: str, amount: int = 27, tab_key: str = '') -> List[aiograpi.types.Media] hashtag -
hashtag_medias_v1_chunk(self, name: str, max_amount: int = 27, tab_key: str = '', max_id: str = None) -> Tuple[List[aiograpi.types.Media], str] hashtag GET /hashtag/medias/recent
GET /hashtag/medias/top
hashtag_related_hashtags(self, name: str) -> List[aiograpi.types.Hashtag] hashtag -
hashtag_unfollow(self, hashtag: str) -> bool hashtag DELETE /hashtag/follow
highlight_add_stories(self, highlight_pk: str, added_media_ids: List[str]) -> aiograpi.types.Highlight highlight POST /highlight/stories
highlight_change_cover(self, highlight_pk: str, cover_path: pathlib._local.Path) -> aiograpi.types.Highlight highlight -
highlight_change_title(self, highlight_pk: str, title: str) -> aiograpi.types.Highlight highlight -
highlight_create(self, title: str, story_ids: List[str], cover_story_id: str = '', crop_rect: List[float] = [0.0, 0.21830457, 1.0, 0.78094524]) -> aiograpi.types.Highlight highlight POST /highlight
highlight_delete(self, highlight_pk: str) -> bool highlight DELETE /highlight
highlight_edit(self, highlight_pk: str, title: str = '', cover: Dict = {}, added_media_ids: List[str] = [], removed_media_ids: List[str] = []) highlight PATCH /highlight
highlight_info(self, highlight_pk: str) -> aiograpi.types.Highlight highlight GET /highlight/info
highlight_info_v1(self, highlight_pk: str) -> aiograpi.types.Highlight highlight -
highlight_pk_from_url(self, url: str) -> str highlight -
highlight_remove_stories(self, highlight_pk: str, removed_media_ids: List[str]) -> aiograpi.types.Highlight highlight DELETE /highlight/stories
igtv_configure(self, upload_id: str, thumbnail: pathlib._local.Path, width: int, height: int, duration: int, title: str, caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> Dict igtv -
igtv_download(self, media_pk: int, folder: pathlib._local.Path = '') -> str igtv GET /igtv/download
igtv_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '') -> str igtv GET /igtv/download/by/url
igtv_upload(self, path: pathlib._local.Path, title: str, caption: str, thumbnail: pathlib._local.Path = None, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, configure_timeout: int = 10, extra_data: Dict[str, str] = {}) -> aiograpi.types.Media igtv POST /igtv/upload
POST /igtv/upload/by/url
init(self) -> bool auth -
inject_sessionid_to_public(self) -> bool auth -
insights_account(self) -> Dict insights GET /insights/account
insights_media(self, media_pk: int) -> Dict insights GET /insights/media
insights_media_feed_all(self, post_type: Literal['ALL', 'CAROUSEL_V2', 'IMAGE', 'SHOPPING', 'VIDEO'] = 'ALL', time_frame: Literal['ONE_WEEK', 'ONE_MONTH', 'THREE_MONTHS', 'SIX_MONTHS', 'ONE_YEAR', 'TWO_YEARS'] = 'TWO_YEARS', data_ordering: Literal['REACH_COUNT', 'LIKE_COUNT', 'FOLLOW', 'SHARE_COUNT', 'BIO_LINK_CLICK', 'COMMENT_COUNT', 'IMPRESSION_COUNT', 'PROFILE_VIEW', 'VIDEO_VIEW_COUNT', 'SAVE_COUNT'] = 'REACH_COUNT', count: int = 0, sleep: int = 2) -> List[Dict] insights GET /insights/media/feed/all
last_seen_update_note(self) -> bool note -
liked_medias(self, amount: int = 21, last_media_pk: int = 0) -> List[aiograpi.types.Media] collection GET /media/liked
load_settings(self, path: Union[str, pathlib._local.Path], override_app_version: bool = False) -> Dict auth -
location_build(self, location: aiograpi.types.Location) -> str location -
location_complete(self, location: aiograpi.types.Location) -> aiograpi.types.Location location -
location_feed(self, location_id, count=16, end_cursor=None) public -
location_guides_v1(self, location_pk: int) -> List[aiograpi.types.Guide] location -
location_info(self, location_pk: int) -> aiograpi.types.Location location GET /location/info
location_info_a1(self, location_pk: int) -> aiograpi.types.Location location -
location_info_v1(self, location_pk: int) -> aiograpi.types.Location location -
location_medias_a1(self, location_pk: int, amount: int = 24, sleep: float = 0.5, tab_key: str = '') -> List[aiograpi.types.Media] location -
location_medias_a1_chunk(self, location_pk: int, max_amount: int = 24, sleep: float = 0.5, tab_key: str = '', max_id: str = None) -> Tuple[List[aiograpi.types.Media], str] location -
location_medias_recent(self, location_pk: int, amount: int = 63, sleep: float = 0.5) -> List[aiograpi.types.Media] location -
location_medias_recent_a1(self, location_pk: int, amount: int = 24, sleep: float = 0.5) -> List[aiograpi.types.Media] location -
location_medias_recent_v1(self, location_pk: int, amount: int = 63) -> List[aiograpi.types.Media] location -
location_medias_top(self, location_pk: int, amount: int = 27, sleep: float = 0.5) -> List[aiograpi.types.Media] location -
location_medias_top_a1(self, location_pk: int, amount: int = 9, sleep: float = 0.5) -> List[aiograpi.types.Media] location -
location_medias_top_v1(self, location_pk: int, amount: int = 21) -> List[aiograpi.types.Media] location -
location_medias_v1(self, location_pk: int, amount: int = 63, tab_key: str = '') -> List[aiograpi.types.Media] location -
location_medias_v1_chunk(self, location_pk: int, max_amount: int = 63, tab_key: str = '', max_id: str = None) -> Tuple[List[aiograpi.types.Media], str] location GET /location/medias/recent
GET /location/medias/top
location_search(self, lat: float, lng: float) -> List[aiograpi.types.Location] location GET /location/search
location_search_name(self, name: str) -> List[aiograpi.types.Location] location GET /location/search
location_search_pk(self, location_pk: int) -> aiograpi.types.Location location -
location_story_sticker_id(self, location: aiograpi.types.Location) -> str location -
login(self, username: Optional[str] = None, password: Optional[str] = None, relogin: bool = False, verification_code: str = '') -> bool auth POST /auth/login
login_by_sessionid(self, sessionid: str) -> bool auth POST /auth/login/by/sessionid
login_flow(self) -> bool auth -
logout(self) -> bool auth -
media_archive(self, media_id: str, revert: bool = False) -> bool media POST /media/archive
media_check_offensive_comment(self, media_id: str, text: str) -> bool comment -
media_check_offensive_comment_v2(self, media_id: str, comment: str) -> dict comment -
media_code_from_pk(self, media_pk: str) -> str media -
media_comment(self, media_id: str, text: str, replied_to_comment_id: Optional[int] = None) -> aiograpi.types.Comment comment POST /media/comment
media_comment_infos(self, media_ids: List[str]) -> dict comment -
media_comment_replies(self, media_id: str, comment_id: str, amount: int = 0) -> List[aiograpi.types.Comment] comment GET /media/comment/replies
media_comment_replies_chunk(self, media_id: str, comment_id: str, max_amount: int, min_id: str = None) -> Tuple[List[aiograpi.types.Comment], str] comment -
media_comments(self, media_id: str, amount: int = 20) -> List[aiograpi.types.Comment] comment GET /media/comments
media_comments_chunk(self, media_id: str, max_amount: int, min_id: str = None) -> Tuple[List[aiograpi.types.Comment], str] comment -
media_comments_gql(self, media_pk: str, amount: int = 50, max_requests: int = 0) -> List[dict] comment -
media_comments_gql_chunk(self, media_pk: str, end_cursor: str = '') -> Tuple[List[dict], str] comment -
media_comments_threaded_gql(self, media_pk: str, comment_pk: str, amount: int = 0) -> List[dict] comment -
media_comments_threaded_gql_chunk(self, media_pk: str, comment_pk: str, end_cursor: str = '') -> Tuple[List[dict], str] comment -
media_comments_v1(self, media_id: str, amount: int = 20) -> List[aiograpi.types.Comment] comment -
media_comments_v1_chunk(self, media_id: str, min_id: str = '', max_id: str = '') -> Tuple[List[aiograpi.types.Comment], str, str] comment -
media_configure_to_cutout_sticker(self, upload_id: str, source_type: str = 'library', manual_box: List[float] = None, use_ai_detection: bool = False, extra_data: Dict[str, str] = None) -> aiograpi.types.Media media -
media_create_livestream(self, title='Instagram Live') media -
media_delete(self, media_id: str) -> bool media DELETE /media
media_edit(self, media_id: str, caption: str, title: str = '', usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None) -> Dict media PATCH /media
media_end_livestream(self, broadcast_id) media -
media_get_livestream_comments(self, broadcast_id) media -
media_get_livestream_info(self, broadcast_id) media -
media_get_livestream_viewers(self, broadcast_id) media -
media_id(self, media_pk: str) -> str media GET /media/id
media_info(self, media_pk: str, use_cache: bool = True) -> aiograpi.types.Media media GET /media/info
media_info_a1(self, media_pk: str, max_id: str = None) -> aiograpi.types.Media media -
media_info_gql(self, media_pk: str) -> aiograpi.types.Media media -
media_info_v1(self, media_pk: str) -> aiograpi.types.Media media -
media_info_v2(self, media_id: str) -> aiograpi.types.Media media -
media_like(self, media_id: str, revert: bool = False) -> bool media POST /media/like
media_likers(self, media_id: str) -> List[aiograpi.types.UserShort] media GET /media/likers
media_likers_gql(self, media_pk: str, amount: int = 0) -> List[dict] media -
media_likers_gql_chunk(self, media_pk: str, end_cursor: str = '') -> Tuple[List[dict], str] media -
media_oembed(self, url: str) -> Dict media GET /media/oembed
media_pin(self, media_pk: str, revert: bool = False) media POST /media/pin
media_pk(media_id: str) -> str media GET /media/pk
media_pk_from_code(self, code: str) -> str media GET /media/pk/from/code
media_pk_from_url(self, url: str) -> str media GET /media/pk/from/url
media_save(self, media_id: str, collection_pk: int = None, revert: bool = False) -> bool collection POST /media/save
media_seen(self, media_ids: List[str], skipped_media_ids: List[str] = []) media PATCH /media/seen
media_start_livestream(self, broadcast_id) media -
media_stream_comments_v1_chunk(self, media_id: str, min_id: str = '', max_id: str = '') -> Tuple[List[aiograpi.types.Comment], str, str] comment -
media_template_v1(self, media_id: str) media -
media_unarchive(self, media_id: str) -> bool media DELETE /media/archive
media_unlike(self, media_id: str) -> bool media DELETE /media/like
media_unpin(self, media_pk) media DELETE /media/pin
media_unsave(self, media_id: str, collection_pk: int = None) -> bool collection DELETE /media/save
media_user(self, media_pk: str) -> aiograpi.types.UserShort media GET /media/user
music_in_feed_audio_browser(self, browse_session_id: Optional[str] = None) -> Dict track -
mute_posts_from_follow(self, user_id: str, revert: bool = False) -> bool user POST /user/mute/posts
mute_stories_from_follow(self, user_id: str, revert: bool = False) -> bool user POST /user/mute/stories
new_feed_exist(self) -> bool user -
news_inbox_v1(self, mark_as_seen: bool = False) -> dict account GET /notifications
notes_music_browser(self) -> Dict note -
notification_announcements(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_comment_likes(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_comments(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_connection(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_direct_group_requests(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_direct_share_activity(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_disable(self) -> bool notification -
notification_felix_upload_result(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_first_post(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_follow_request_accepted(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_fundraiser_creator(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_fundraiser_supporter(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_like_and_comment_on_photo_user_tagged(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_likes(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_live_broadcast(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_login(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_mute_all(self, setting_value: Literal['cancel', '15_minutes', '1_hour', '2_hour', '4_hour', '8_hour'] = '8_hour') -> bool notification -
notification_new_follower(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_pending_direct_share(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_reminders(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_report_updated(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_rooms(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_settings(self, content_type: str, setting_value: str) -> bool notification PATCH /notifications/settings
notification_tagged_in_bio(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_user_tagged(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_video_call(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
notification_view_count(self, setting_value: Literal['off', 'following_only', 'everyone'] = 'off') -> bool notification -
one_tap_app_login(self, user_id: str, nonce: str) -> bool auth -
parse_authorization(self, authorization) -> dict auth -
password_encrypt(self, password) password -
password_publickeys(self) password -
photo_configure(self, upload_id: str, width: int, height: int, caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> Dict photo -
photo_configure_to_story(self, upload_id: str, width: int, height: int, caption: str, mentions: List[aiograpi.types.StoryMention] = [], locations: List[aiograpi.types.StoryLocation] = [], links: List[aiograpi.types.StoryLink] = [], hashtags: List[aiograpi.types.StoryHashtag] = [], stickers: List[aiograpi.types.StorySticker] = [], medias: List[aiograpi.types.StoryMedia] = [], polls: List[aiograpi.types.StoryPoll] = [], extra_data: Dict[str, str] = {}) -> Dict photo -
photo_download(self, media_pk: int, folder: pathlib._local.Path = '', overwrite: bool = True) -> pathlib._local.Path photo GET /photo/download
photo_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '', overwrite: bool = True) -> pathlib._local.Path photo GET /photo/download/by/url
photo_download_by_url_origin(self, url: str) -> bytes photo -
photo_rupload(self, path: pathlib._local.Path, upload_id: str = '', to_album: bool = False, for_story: bool = False) -> tuple photo -
photo_upload(self, path: pathlib._local.Path, caption: str, upload_id: str = '', usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> aiograpi.types.Media photo POST /photo/upload
POST /photo/upload/by/url
photo_upload_to_cutout_sticker(self, path: pathlib._local.Path, bypass_ai: bool = True) -> aiograpi.types.Media photo -
photo_upload_to_story(self, path: pathlib._local.Path, caption: str = '', upload_id: str = '', mentions: List[aiograpi.types.StoryMention] = [], locations: List[aiograpi.types.StoryLocation] = [], links: List[aiograpi.types.StoryLink] = [], hashtags: List[aiograpi.types.StoryHashtag] = [], stickers: List[aiograpi.types.StorySticker] = [], medias: List[aiograpi.types.StoryMedia] = [], polls: List[aiograpi.types.StoryPoll] = [], extra_data: Dict[str, str] = {}) -> aiograpi.types.Story photo POST /story/upload
POST /story/upload/by/url
photo_upload_with_music(self, path: pathlib._local.Path, caption: str, track: Union[aiograpi.types.Track, Dict], upload_id: str = '', usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}, audio_asset_start_time: Optional[int] = None, overlap_duration: int = 30000, browse_session_id: Optional[str] = None, alacorn_session_id: Optional[str] = None) -> aiograpi.types.Media photo -
pre_login_flow(self) -> bool auth -
private_graphql_clips_profile(self, target_user_id: str, client_doc_id: str = '209049231614685382737238866578', priority: str = None, initial_stream_count: int = 6, page_size: int = 12, no_of_medias_in_each_chunk: int = 6) -> dict user -
private_graphql_followers_list(self, user_id: str, rank_token: str, client_doc_id: str = '28479704798344003308647327139', max_id: int = None, priority: str = None, exclude_field_is_favorite: bool = None, exclude_unused_fields: bool = None) -> dict user -
private_graphql_following_list(self, user_id: str, rank_token: str, client_doc_id: str = '16104639289023609826830352479', max_id: int = None, priority: str = None, exclude_field_is_favorite: bool = None, exclude_unused_fields: bool = None) -> dict user -
private_graphql_inbox_tray_for_user(self, user_id: str, client_doc_id: str = '2035639076042015234490020607', priority: str = None) -> dict user -
private_graphql_memories_pog(self, client_doc_id: str = '4160563056814166588457451196', direct_region_hint: str = None) -> dict graphql -
private_graphql_query_request(self, friendly_name: str, root_field_name: str, variables: dict = None, client_doc_id: str = None, priority: str = None, extra_headers: dict = None) -> dict graphql -
private_graphql_realtime_region_hint(self, client_doc_id: str = '52232106018313849661757113193') -> dict graphql -
private_graphql_request(self, data: dict, headers: dict = None, domain: str = None) -> dict graphql -
private_graphql_top_audio_trends_eligible_categories(self, client_doc_id: str = '10243243298540497152200027985') -> dict graphql -
private_graphql_update_inbox_tray_last_seen(self, client_doc_id: str = '41048505499858972910914091441') -> dict graphql -
private_request(self, endpoint, data=None, params=None, login=False, with_signature=True, headers=None, extra_sig=None, domain: str = None) private -
profile_related_info(self, profile_id) public -
public_a1_request(self, endpoint, data=None, params=None, headers=None, full=False) public -
public_a1_request_user_info_by_username(self, username, data=None, params=None) public -
public_doc_id_graphql_request(self, doc_id: str, variables: Dict[str, Any], referer: Optional[str] = None, headers: Optional[Dict[str, str]] = None) -> Dict[str, Any] public -
public_graphql_request(self, variables, query_hash=None, query_id=None, data=None, params=None, headers=None) public -
public_head(self, url: str, follow_redirects: bool = False) public -
public_request(self, url, data=None, params=None, headers=None, update_headers=None, return_json=False, retries_count=None, retries_timeout=None) public -
reels(self, amount: int = 10, last_media_pk: int = 0) -> List[aiograpi.types.Media] timeline -
reels_timeline_media(self, collection_pk: str, amount: int = 10, last_media_pk: int = 0) -> List[aiograpi.types.Media] timeline -
relogin(self) -> bool auth PATCH /auth/relogin
remove_bio_links(self, link_ids: list) -> dict account -
report_explore_media(self, media_pk: int) explore -
request_log(self, response) private -
reset_password(self, username: str) -> Dict account -
search_followers(self, user_id: str, query: str) -> List[aiograpi.types.UserShort] user -
search_followers_v1(self, user_id: str, query: str) -> List[aiograpi.types.UserShort] user -
search_following(self, user_id: str, query: str) -> List[aiograpi.types.UserShort] user -
search_following_v1(self, user_id: str, query: str) -> List[aiograpi.types.UserShort] user -
search_hashtags(self, query: str) -> List[aiograpi.types.Hashtag] fbsearch -
search_music(self, query: str) -> List[aiograpi.types.Track] fbsearch -
search_users(self, query: str) -> List[aiograpi.types.UserShort] fbsearch GET /user/search
search_users_v1(self, query: str, count: int) -> List[aiograpi.types.UserShort] user -
send_confirm_email(self, email: str) -> dict account -
send_confirm_phone_number(self, phone_number: str) -> dict account -
send_signup_sms_code(self, phone_number: str) signup -
send_verify_email(self, email) -> dict signup -
set_app(self, app: Union[str, Dict] = None, seed: str = None) -> bool auth -
set_contact_point_prefill(self, usage: str = 'prefill') -> Dict auth -
set_country(self, country: str = 'US') private -
set_country_code(self, country_code: int = 1) private -
set_device(self, device: Dict = None, reset: bool = False) -> bool auth -
set_external_url(self, external_url) -> dict account -
set_ig_u_rur(self, value) private -
set_ig_www_claim(self, value) private -
set_locale(self, locale: str = 'en_US') private POST /auth/login
PATCH /auth/settings
set_proxy(self, dsn: Optional[str]) aiograpi POST /auth/login
PATCH /auth/settings
set_retry_config(self, request_timeout: Union[int, float, NoneType] = None, public_request_retries_count: int = None, public_request_retries_timeout: Union[int, float] = None, session_retry_total: int = None, session_retry_backoff_factor: Union[int, float] = None, session_retry_statuses: list = None, public_transport: Optional[str] = None, public_transport_impersonate: Optional[str] = None) -> bool auth -
set_settings(self, settings: Dict) -> bool auth PATCH /auth/settings
set_timezone_offset(self, seconds: int = 0) private POST /auth/login
PATCH /auth/settings
set_user_agent(self, user_agent: str = '', reset: bool = False) -> bool auth -
set_uuids(self, uuids: Dict = None) -> bool auth -
share_code_from_url(self, url: str) -> str share -
share_info(self, code: str) -> aiograpi.types.Share share -
share_info_by_url(self, url: str) -> aiograpi.types.Share share -
signup(self, username: str, password: str, email: str = '', phone_number: str = '', full_name: str = '', year: int = None, month: int = None, day: int = None) -> aiograpi.types.UserShort signup -
small_delay(self) private -
standalone_fundraiser_info_v1(self, user_id: str) fundraiser -
sticker_tray(self) -> dict story -
story_delete(self, story_pk: str) -> bool story DELETE /story
story_download(self, story_pk: str, filename: str = '', folder: pathlib._local.Path = '') -> pathlib._local.Path story GET /story/download
story_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '') -> pathlib._local.Path story GET /story/download/by/url
story_info(self, story_pk: str, use_cache: bool = True) -> aiograpi.types.Story story GET /story/info
story_info_v1(self, story_pk: str) -> aiograpi.types.Story story -
story_like(self, story_id: str, revert: bool = False) -> bool story POST /story/like
story_pk_from_url(self, url: str) -> str story GET /story/pk/from/url
story_seen(self, story_pks: List[str], skipped_story_pks: List[str] = []) story PATCH /story/seen
story_unlike(self, story_id: str) -> bool story DELETE /story/like
story_viewers(self, story_pk: str, amount: int = 0) -> List[aiograpi.types.Viewer] story -
story_viewers_chunk(self, story_pk: str, max_amount: int = 0, max_id: str = '') -> tuple[typing.List[aiograpi.types.Viewer], str] story GET /story/viewers
sync_device_features(self, login: bool = False) -> Dict auth -
sync_launcher(self, login: bool = False) -> Dict auth -
top_search(self, query) public -
totp_disable(self) -> bool totp DELETE /auth/totp
totp_enable(self, verification_code: str) -> List[str] totp POST /auth/totp/enable
totp_generate_code(seed: str) -> str totp -
totp_generate_seed(self) -> str totp -
track_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '') -> pathlib._local.Path track -
track_info_by_canonical_id(self, music_canonical_id: str) -> aiograpi.types.Track track -
track_info_by_id(self, track_id: str, max_id: str = '') -> Dict track -
track_stream_info_by_id(self, track_id: str, max_id: str = '') -> Dict track -
unmute_posts_from_follow(self, user_id: str) -> bool user DELETE /user/mute/posts
unmute_stories_from_follow(self, user_id: str) -> bool user DELETE /user/mute/stories
user_about_v1(self, user_id: str) -> aiograpi.types.About user GET /user/about
user_block(self, user_id: str, surface: str = 'profile') -> bool user POST /user/block
user_clips(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
user_clips_chunk_v1(self, user_id: int, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
user_clips_paginated_v1(self, user_id: str, amount: int = 50, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media GET /user/clips
user_clips_v1(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
user_follow(self, user_id: str) -> bool user POST /user/follow
user_follow_request_approve(self, user_id: str) -> bool user -
user_follow_request_decline(self, user_id: str) -> bool user -
user_follow_requests(self, amount: int = 0) -> List[aiograpi.types.UserShort] user -
user_follow_requests_approve(self, user_ids: List[str]) -> Dict[str, bool] user -
user_follow_requests_chunk(self, max_amount: int = 0, max_id: str = '') -> Tuple[List[aiograpi.types.UserShort], str] user GET /user/follow/requests
user_follow_requests_decline(self, user_ids: List[str]) -> Dict[str, bool] user -
user_followers(self, user_id: str, amount: int = 0) -> Dict[str, aiograpi.types.UserShort] user -
user_followers_gql(self, user_id: str, amount: int = 0) -> List[aiograpi.types.UserShort] user -
user_followers_gql_chunk(self, user_id: str, max_amount: int = 0, end_cursor: str = None) -> Tuple[List[aiograpi.types.UserShort], str] user -
user_followers_v1(self, user_id: str, amount: int = 0) -> List[aiograpi.types.UserShort] user -
user_followers_v1_chunk(self, user_id: str, max_amount: int = 0, max_id: str = '') -> Tuple[List[aiograpi.types.UserShort], str] user GET /user/followers
user_following(self, user_id: str, amount: int = 0) -> Dict[str, aiograpi.types.UserShort] user -
user_following_gql(self, user_id: str, amount: int = 0) -> List[aiograpi.types.UserShort] user -
user_following_gql_chunk(self, user_id: str, max_amount: int = 0, end_cursor: str = None) -> Tuple[List[aiograpi.types.UserShort], str] user -
user_following_v1(self, user_id: str, amount: int = 0) -> List[aiograpi.types.UserShort] user -
user_following_v1_chunk(self, user_id: str, max_amount: int = 0, max_id: str = '') -> Tuple[List[aiograpi.types.UserShort], str] user GET /user/following
user_friendship_v1(self, user_id: str) -> aiograpi.types.Relationship user GET /user/friendship
user_friendships_v1(self, user_ids: List[str]) -> List[aiograpi.types.RelationshipShort] user -
user_guides_v1(self, user_id: int) -> List[aiograpi.types.Guide] user -
user_highlights(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Highlight] highlight GET /user/highlights
user_highlights_v1(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Highlight] highlight -
user_id_from_username(self, username: str) -> str user GET /user/clips
GET /user/id/from/username
GET /user/medias
GET /user/tagged/medias
GET /user/videos
user_info(self, user_id: str) -> aiograpi.types.User user GET /user/info
user_info_by_username(self, username: str) -> aiograpi.types.User user GET /user/info/by/username
user_info_by_username_a1(self, username: str) -> dict user -
user_info_by_username_gql(self, username: str) -> aiograpi.types.User user -
user_info_by_username_v1(self, username: str) -> aiograpi.types.User user -
user_info_by_username_v2_gql(self, username: str) -> aiograpi.types.User user -
user_info_gql(self, user_id: str) -> aiograpi.types.User user -
user_info_v1(self, user_id: str, from_module: Literal['self_profile', 'feed_timeline', 'reel_feed_timeline'] = 'self_profile', is_app_start: bool = False) -> aiograpi.types.User user -
user_info_v2_gql(self, user_id: str) -> aiograpi.types.User user -
user_medias(self, user_id: int, amount: int = 0, sleep: int = 0) -> List[aiograpi.types.Media] media -
user_medias_chunk(self, user_id: int, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
user_medias_chunk_gql(self, user_id: int, sleep: int = 2, end_cursor=None, amount: int = 0) -> Tuple[List[aiograpi.types.Media], str] media -
user_medias_chunk_v1(self, user_id: int, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
user_medias_gql(self, user_id: int, amount: int = 0, sleep: int = 0) -> List[aiograpi.types.Media] media -
user_medias_paginated(self, user_id: str, amount: int = 0, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media GET /user/medias
user_medias_paginated_gql(self, user_id: str, amount: int = 0, sleep: int = 2, end_cursor=None) -> Tuple[List[aiograpi.types.Media], str] media -
user_medias_paginated_v1(self, user_id: str, amount: int = 33, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
user_medias_v1(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
user_pinned_medias(self, user_id) -> List[aiograpi.types.Media] media -
user_related_profiles_gql(self, user_id: str) -> List[aiograpi.types.UserShort] user -
user_remove_follower(self, user_id: str) -> bool user DELETE /user/follower
user_short_gql(self, user_id: str) -> aiograpi.types.UserShort user -
user_stories(self, user_id: str, amount: int = None) -> List[aiograpi.types.Story] story POST /story/upload
POST /story/upload/by/url
GET /story/user/stories
user_stories_gql(self, user_id: str, amount: int = None) -> List[aiograpi.types.Story] story -
user_stories_v1(self, user_id: str, amount: int = None) -> List[aiograpi.types.Story] story -
user_stream_by_id_flat(self, user_id: str) -> dict user -
user_stream_by_id_v1(self, user_id: str) -> dict user -
user_stream_by_username_flat(self, username: str) -> dict user -
user_stream_by_username_v1(self, username: str) -> dict user -
user_unblock(self, user_id: str, surface: str = 'profile') -> bool user DELETE /user/block
user_unfollow(self, user_id: str) -> bool user DELETE /user/follow
user_videos_chunk_v1(self, user_id: int, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
user_videos_paginated_v1(self, user_id: str, amount: int = 50, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media GET /user/videos
user_videos_v1(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
user_web_profile_info_gql(self, user_id: str) -> dict user -
user_web_profile_info_v1(self, username: str) -> dict user -
username_from_user_id(self, user_id: str) -> str user GET /user/username/from/id
username_from_user_id_gql(self, user_id: str) -> str user -
users_stories_gql(self, user_ids: List[str], amount: int = 0) -> List[aiograpi.types.UserShort] story -
usertag_medias(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
usertag_medias_gql(self, user_id: int, amount: int = 0, sleep: int = 2) -> List[aiograpi.types.Media] media -
usertag_medias_paginated(self, user_id: str, amount: int = 0, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media GET /user/tagged/medias
usertag_medias_paginated_gql(self, user_id: str, amount: int = 0, sleep: int = 2, end_cursor=None) -> Tuple[List[aiograpi.types.Media], str] media -
usertag_medias_paginated_v1(self, user_id: str, amount: int = 0, end_cursor: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
usertag_medias_v1(self, user_id: int, amount: int = 0) -> List[aiograpi.types.Media] media -
usertag_medias_v1_chunk(self, user_id: int, max_id: str = '') -> Tuple[List[aiograpi.types.Media], str] media -
very_small_delay(self) private -
video_configure(self, upload_id: str, width: int, height: int, duration: int, thumbnail: pathlib._local.Path, caption: str, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> Dict video -
video_configure_to_story(self, upload_id: str, width: int, height: int, duration: int, thumbnail: pathlib._local.Path, caption: str, mentions: List[aiograpi.types.StoryMention] = [], locations: List[aiograpi.types.StoryLocation] = [], links: List[aiograpi.types.StoryLink] = [], hashtags: List[aiograpi.types.StoryHashtag] = [], stickers: List[aiograpi.types.StorySticker] = [], medias: List[aiograpi.types.StoryMedia] = [], polls: List[aiograpi.types.StoryPoll] = [], thread_ids: List[int] = [], extra_data: Dict[str, str] = {}) -> Dict video -
video_download(self, media_pk: int, folder: pathlib._local.Path = '', overwrite: bool = True) -> pathlib._local.Path video GET /video/download
video_download_by_url(self, url: str, filename: str = '', folder: pathlib._local.Path = '', overwrite: bool = True) -> pathlib._local.Path video GET /video/download/by/url
video_download_by_url_origin(self, url: str) -> bytes video -
video_rupload(self, path: pathlib._local.Path, thumbnail: pathlib._local.Path = None, to_album: bool = False, to_story: bool = False, to_direct: bool = False) -> tuple video -
video_upload(self, path: pathlib._local.Path, caption: str, thumbnail: pathlib._local.Path = None, usertags: List[aiograpi.types.Usertag] = [], location: aiograpi.types.Location = None, extra_data: Dict[str, str] = {}) -> aiograpi.types.Media video POST /video/upload
POST /video/upload/by/url
video_upload_to_cutout_sticker(self, path: pathlib._local.Path, bypass_ai: bool = True) -> aiograpi.types.Media video -
video_upload_to_direct(self, path: pathlib._local.Path, caption: str = '', thumbnail: pathlib._local.Path = None, mentions: List[aiograpi.types.StoryMention] = [], medias: List[aiograpi.types.StoryMedia] = [], thread_ids: List[int] = [], extra_data: Dict[str, str] = {}) -> aiograpi.types.DirectMessage video -
video_upload_to_story(self, path: pathlib._local.Path, caption: str = '', thumbnail: pathlib._local.Path = None, mentions: List[aiograpi.types.StoryMention] = [], locations: List[aiograpi.types.StoryLocation] = [], links: List[aiograpi.types.StoryLink] = [], hashtags: List[aiograpi.types.StoryHashtag] = [], stickers: List[aiograpi.types.StorySticker] = [], medias: List[aiograpi.types.StoryMedia] = [], polls: List[aiograpi.types.StoryPoll] = [], extra_data: Dict[str, str] = {}) -> aiograpi.types.Story video POST /story/upload
POST /story/upload/by/url
web_search_topsearch(self, query: str) -> dict fbsearch -
web_search_topsearch_hashtags(self, query: str) -> List[aiograpi.types.Hashtag] fbsearch -
with_action_data(self, data: Dict) -> Dict auth -
with_default_data(self, data: Dict) -> Dict auth -
with_extra_data(self, data: Dict) -> Dict auth -
with_query_params(data, params) private -