igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface NavigationWireValues

    What the navigation state looks like on the wire, in the platform's spelling. One value feeds every place a request names the navigation: the x-ig-nav-chain header and the nav_chain field of a body, the x-ig-client-endpoint header, and the container_module field — so they can never disagree.

    interface NavigationWireValues {
        bodyNavChain: string | undefined;
        clientEndpoint: string | undefined;
        containerModule:
            | "CLOSE_FRIENDS_V2_LIST"
            | "com.bloks.www.caa.login.login_homepage"
            | "com.bloks.www.caa.ar.search"
            | "com.bloks.www.caa.ar.authentication_confirmation"
            | "com.bloks.www.bloks.caa.reg.confirmation"
            | "com.bloks.www.bloks.caa.reg.password"
            | "com.bloks.www.bloks.caa.reg.birthday"
            | "com.bloks.www.bloks.caa.reg.name.ig.and.soap"
            | "com.bloks.www.bloks.caa.reg.username"
            | "com.bloks.www.bloks.caa.reg.tos"
            | "com.bloks.www.ap.two_step_verification.code_entry"
            | "com.bloks.www.bloks.ig.ndx.ls.entry.screen"
            | "RepostComposerFragment"
            | "ThreadDetailHomePageFragment"
            | "ThreadDetailsNicknamesFragment"
            | "ThreadDetailsNicknameChangeFragment"
            | "ThreadDetailsCustomGroupNameAndImageFragment"
            | "clips_profile"
            | "gallery_picker"
            | "quick_edit_fragment"
            | "media_broadcast_share"
            | "stories_precapture_camera"
            | "clips_precapture_camera"
            | "stories_gallery"
            | "clips_gallery"
            | "clips_postcapture_camera"
            | "clips_share_sheet"
            | "panavideo_share_sheet"
            | "clips_viewer"
            | "clips_viewer_clips_profile"
            | "clips_viewer_clips_tab"
            | "clips_viewer_explore_popular_major_unit"
            | "clips_viewer_reel"
            | "comment_likers"
            | "comment_owner"
            | "comments_v2"
            | "comments_v2_clips_viewer_clips_profile"
            | "comments_v2_clips_viewer_reel"
            | "comments_v2_feed_contextual_hashtag"
            | "comments_v2_feed_contextual_profile"
            | "comments_v2_feed_short_url"
            | "comments_v2_feed_timeline"
            | "customize_chat"
            | "direct_inbox"
            | "direct_recipient_picker"
            | "direct_thread"
            | "direct_thread_shared_media"
            | "direct_thread_theme_picker"
            | "direct_story_audience_picker"
            | "explore_people"
            | "explore_popular"
            | "explore_popular_major_unit"
            | "edit_media_info"
            | "edit_profile"
            | "edit_profile_links_list"
            | "edit_profile_links_list_edit"
            | "feed_contextual"
            | "feed_contextual_hashtag"
            | "feed_contextual_location"
            | "feed_contextual_newsfeed_multi_media_liked"
            | "feed_contextual_post"
            | "feed_contextual_profile"
            | "feed_contextual_chain"
            | "feed_hashtag"
            | "feed_short_url"
            | "feed_timeline"
            | "feed_timeline_following"
            | "find_friends_contacts"
            | "followers"
            | "following"
            | "igtv_feed_timeline"
            | "likers_likers_media_view_profile"
            | "likers_likers_photo_view_profile"
            | "likers_likers_video_view_profile"
            | "media_view_profile"
            | "music_browser_home_fragment"
            | "clips_music_editor"
            | "music_overlay_detail"
            | "music_search"
            | "newsfeed"
            | "photo_view_profile"
            | "profile"
            | "profile_edit_bio"
            | "profile_edit_username"
            | "private_stories_share_sheet"
            | "reel_composer_camera"
            | "reel_feed_timeline"
            | "search_typeahead"
            | "self_followers"
            | "self_following"
            | "self_likers_self_likers_media_view_profile"
            | "self_likers_self_likers_photo_view_profile"
            | "self_likers_self_likers_video_view_profile"
            | "self_profile"
            | "serp_tags"
            | "serp_top"
            | "serp_users"
            | "stories_postcapture_camera"
            | "story_camera_clips_v2"
            | "story_camera_music_overlay_post_capture"
            | "story_camera_music_overlay_pre_capture"
            | "story_stickers_tray"
            | "story_viewer_default"
            | "story_viewer_profile"
            | "video_view_profile"
            | "your_story_placeholder"
            | undefined;
        currentEndpointModule: string
        | undefined;
        currentResumedAtMs: number | undefined;
        navChain: string | undefined;
        requestSourceModule: string | undefined;
        screenModule: string | undefined;
        surfaces?: readonly NavigationWireSurface[];
    }
    Index

    Properties

    bodyNavChain clientEndpoint containerModule currentEndpointModule currentResumedAtMs navChain requestSourceModule screenModule surfaces?

    Properties

    bodyNavChain: string | undefined

    The nav_chain field of a signed body or query: the chain when the platform sends it there and a chain exists, undefined otherwise. Android sends it; iOS sends nav_chain in no request body, so it omits the field rather than porting Android's shape.

    clientEndpoint: string | undefined

    x-ig-client-endpoint; undefined while the platform renders none.

    containerModule:
        | "CLOSE_FRIENDS_V2_LIST"
        | "com.bloks.www.caa.login.login_homepage"
        | "com.bloks.www.caa.ar.search"
        | "com.bloks.www.caa.ar.authentication_confirmation"
        | "com.bloks.www.bloks.caa.reg.confirmation"
        | "com.bloks.www.bloks.caa.reg.password"
        | "com.bloks.www.bloks.caa.reg.birthday"
        | "com.bloks.www.bloks.caa.reg.name.ig.and.soap"
        | "com.bloks.www.bloks.caa.reg.username"
        | "com.bloks.www.bloks.caa.reg.tos"
        | "com.bloks.www.ap.two_step_verification.code_entry"
        | "com.bloks.www.bloks.ig.ndx.ls.entry.screen"
        | "RepostComposerFragment"
        | "ThreadDetailHomePageFragment"
        | "ThreadDetailsNicknamesFragment"
        | "ThreadDetailsNicknameChangeFragment"
        | "ThreadDetailsCustomGroupNameAndImageFragment"
        | "clips_profile"
        | "gallery_picker"
        | "quick_edit_fragment"
        | "media_broadcast_share"
        | "stories_precapture_camera"
        | "clips_precapture_camera"
        | "stories_gallery"
        | "clips_gallery"
        | "clips_postcapture_camera"
        | "clips_share_sheet"
        | "panavideo_share_sheet"
        | "clips_viewer"
        | "clips_viewer_clips_profile"
        | "clips_viewer_clips_tab"
        | "clips_viewer_explore_popular_major_unit"
        | "clips_viewer_reel"
        | "comment_likers"
        | "comment_owner"
        | "comments_v2"
        | "comments_v2_clips_viewer_clips_profile"
        | "comments_v2_clips_viewer_reel"
        | "comments_v2_feed_contextual_hashtag"
        | "comments_v2_feed_contextual_profile"
        | "comments_v2_feed_short_url"
        | "comments_v2_feed_timeline"
        | "customize_chat"
        | "direct_inbox"
        | "direct_recipient_picker"
        | "direct_thread"
        | "direct_thread_shared_media"
        | "direct_thread_theme_picker"
        | "direct_story_audience_picker"
        | "explore_people"
        | "explore_popular"
        | "explore_popular_major_unit"
        | "edit_media_info"
        | "edit_profile"
        | "edit_profile_links_list"
        | "edit_profile_links_list_edit"
        | "feed_contextual"
        | "feed_contextual_hashtag"
        | "feed_contextual_location"
        | "feed_contextual_newsfeed_multi_media_liked"
        | "feed_contextual_post"
        | "feed_contextual_profile"
        | "feed_contextual_chain"
        | "feed_hashtag"
        | "feed_short_url"
        | "feed_timeline"
        | "feed_timeline_following"
        | "find_friends_contacts"
        | "followers"
        | "following"
        | "igtv_feed_timeline"
        | "likers_likers_media_view_profile"
        | "likers_likers_photo_view_profile"
        | "likers_likers_video_view_profile"
        | "media_view_profile"
        | "music_browser_home_fragment"
        | "clips_music_editor"
        | "music_overlay_detail"
        | "music_search"
        | "newsfeed"
        | "photo_view_profile"
        | "profile"
        | "profile_edit_bio"
        | "profile_edit_username"
        | "private_stories_share_sheet"
        | "reel_composer_camera"
        | "reel_feed_timeline"
        | "search_typeahead"
        | "self_followers"
        | "self_following"
        | "self_likers_self_likers_media_view_profile"
        | "self_likers_self_likers_photo_view_profile"
        | "self_likers_self_likers_video_view_profile"
        | "self_profile"
        | "serp_tags"
        | "serp_top"
        | "serp_users"
        | "stories_postcapture_camera"
        | "story_camera_clips_v2"
        | "story_camera_music_overlay_post_capture"
        | "story_camera_music_overlay_pre_capture"
        | "story_stickers_tray"
        | "story_viewer_default"
        | "story_viewer_profile"
        | "video_view_profile"
        | "your_story_placeholder"
        | undefined

    container_module of the screen in front in the platform's own spelling; undefined when the platform has no spelling for the screen, so the field is omitted (never an Android spelling on iOS, never an invented default for a screen the catalog does not name).

    currentEndpointModule: string | undefined

    Endpoint module of the screen in front: the module part of its x-ig-client-endpoint (the catalog's endpointModule when it names one, else its chain module). Request bodies that name the screen they were sent from as a module (from_module) read this, never a caller literal. undefined before the first screen.

    currentResumedAtMs: number | undefined

    When the screen in front last came to front, for a navigation-derived request field; undefined before the first screen.

    navChain: string | undefined

    The header rendering (x-ig-nav-chain); undefined while the platform renders none (Android: no chain yet; iOS: a screen the catalog does not name). iOS also has a sentinel for "no screen yet" (not_init), which is this header's value and never a body's.

    requestSourceModule: string | undefined

    The module the launch's get_account_family reports as request_source: the screen in front's own module, except that a CDS-hosted Bloks screen reports the module of the screen that hosts its container when the state names one (the recovery code-entry screen reports the CAA landing screen). undefined before the first screen or when the platform has no spelling for it.

    screenModule: string | undefined

    Chain module of the screen in front in the platform's spelling (the screen's own module, never the host of a container it runs in). undefined before the first screen or when the platform has no spelling for it.

    surfaces?: readonly NavigationWireSurface[]

    The session's foreground surface trail (the app's app_session_navigation), in order, each screen's surface module and when it came to front. The module is the screen's surface (container) module in the platform's spelling — what the app counts as the surface the visit was — not its chain module; a screen the platform has no container spelling for reports its chain module (the Android 451 following filter is feed_timeline_following in the trail while its chain entry stays feed_contextual, and the launch's save-credentials prompt is its Bloks app id). surface says whether the screen is a surface of the app (a native screen) rather than a Bloks screen shown over one; the app counts only the former as a surface (the 451 launch's save-credentials prompt is not one). Omitted while empty, so a NavigationWire written before the trail existed keeps compiling.

    Settings

    Member Visibility

    On This Page

    Properties