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

    Interface MyProfileActions

    What you can do on your own profile; call these on its handle: open the profile editor, and go back to the feed from the bottom tab bar.

    interface MyProfileActions {
        openEditProfile: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "EditProfile",
                "screen",
                {
                    backgroundFailures: readonly {
                        message?: string;
                        request: "contactPointPrefill"
                        | "identityReminder";
                        tag: string;
                    }[];
                    biography: string;
                    bioLinks: readonly {
                        linkId: string;
                        linkType: string;
                        title: string;
                        url: string;
                    }[];
                    fullName: string;
                    profileEditParams: {
                        fullName: {
                            confirmationDialogText: string;
                            disclaimerText: string;
                            isPendingReview: boolean;
                            shouldShowConfirmationDialog: boolean;
                        };
                        username: {
                            confirmationDialogText: string;
                            disclaimerText: string;
                            isPendingReview: boolean;
                            shouldShowConfirmationDialog: boolean;
                        };
                    };
                    userId: string;
                    username: string;
                },
                EditProfileActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                "userId",
                unknown,
            >,

                | IgApiError
                | HttpRequestError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
        openFeedTab: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "FeedTimeline",
                "tab",
                {
                    entries: readonly (
                        | {
                            key: string;
                            media: {
                                carousel_media?: readonly { pk: ... }[];
                                code: string;
                                id: string;
                                injected?: { ad_id?: (...) | (...) } | null;
                                inventory_source?: string;
                                logging_info_token?: string;
                                media_type: number;
                                mezql_token?: string;
                                pk?: string;
                                product_type?: string;
                                ranking_info_token?: string;
                                taken_at?: number;
                                user?: { pk: string; username: string };
                            };
                            position: number;
                            slide?: number;
                            type: "post";
                        }
                        | {
                            key: string;
                            media: {
                                carousel_media?: readonly { pk: ... }[];
                                code: string;
                                id: string;
                                injected?: { ad_id?: (...) | (...) } | null;
                                inventory_source?: string;
                                logging_info_token?: string;
                                media_type: number;
                                mezql_token?: string;
                                pk?: string;
                                product_type?: string;
                                ranking_info_token?: string;
                                taken_at?: number;
                                user?: { pk: string; username: string };
                            };
                            position: number;
                            type: "reel";
                        }
                        | {
                            key: string;
                            media: {
                                carousel_media?: readonly { pk: ... }[];
                                code: string;
                                id: string;
                                injected?: { ad_id?: (...) | (...) } | null;
                                inventory_source?: string;
                                logging_info_token?: string;
                                media_type: number;
                                mezql_token?: string;
                                pk?: string;
                                product_type?: string;
                                ranking_info_token?: string;
                                taken_at?: number;
                                user?: { pk: string; username: string };
                            };
                            position: number;
                            type: "ad";
                        }
                        | {
                            key: string;
                            media: {
                                carousel_media?: readonly { pk: ... }[];
                                code: string;
                                id: string;
                                injected?: { ad_id?: (...) | (...) } | null;
                                inventory_source?: string;
                                logging_info_token?: string;
                                media_type: number;
                                mezql_token?: string;
                                pk?: string;
                                product_type?: string;
                                ranking_info_token?: string;
                                taken_at?: number;
                                user?: { pk: string; username: string };
                            };
                            position: number;
                            source: string;
                            type: "explore_story";
                        }
                        | {
                            key: string;
                            position: number;
                            subtitle: string;
                            title: string;
                            type: "caught-up";
                        }
                        | {
                            key: string;
                            position: number;
                            posts: readonly {
                                id?: string;
                                media_type?: number;
                                user?: { pk: ...; username: ... };
                            }[];
                            title: string;
                            type: "threads";
                        }
                        | {
                            key: string;
                            position: number;
                            reels: readonly {
                                id?: string;
                                is_eof?: boolean
                                | null;
                                media_type?: number;
                                pk?: string;
                                user?: { pk: ...; username: ... };
                            }[];
                            title: string;
                            type: "suggested-reels";
                        }
                        | {
                            item: { kind: "unknown"; kindKey?: string; raw: Json };
                            key: string;
                            position: number;
                            type: "unknown";
                        }
                    )[];
                    more_available: boolean;
                    next_max_id?: string;
                    requestId: string;
                },
                FeedTimelineActions & Omit<
                    ScreenFeedMembers<
                        {
                            lastTakenAt?: number;
                            nextMaxId?: string;
                            position?: number;
                            reason: TimelineFeedReason;
                            requestId?: string;
                        },
                        FeedTimelineItems,
                        IgApiError
                        | HttpRequestError
                        | ScreenDataError,

                            | MobileSession
                            | MobileDevice
                            | MobileTelemetry
                            | GraphqlJsonHttp
                            | MobileApplication
                            | NavigationWire
                            | JsonResponseHttp
                            | MobileNetworkWire
                            | MobileProcessBackground
                            | MobileProcessMobileConfig
                            | MobileUserFlows,
                    >,
                    "stream",
                > & ScreenSwipeMembers<
                    {
                        lastTakenAt?: number;
                        nextMaxId?: string;
                        position?: number;
                        reason: TimelineFeedReason;
                        requestId?: string;
                    },
                    FeedTimelineItems,
                    ScreenFeedSwipeFailure<
                        IgApiError
                        | HttpRequestError
                        | ScreenDataError,
                        FeedTimelineItems,
                    >,
                    ScreenFeedPageServices<
                        | MobileSession
                        | MobileDevice
                        | MobileTelemetry
                        | GraphqlJsonHttp
                        | MobileApplication
                        | NavigationWire
                        | JsonResponseHttp
                        | MobileNetworkWire
                        | MobileProcessBackground
                        | MobileProcessMobileConfig
                        | MobileUserFlows,
                        FeedTimelineItems,
                    >,
                >,
                ScreenFeedItems<FeedTimelineItems>,
                ScreenHandle | undefined,
                "optional",
                false,
                never,
                unknown,
            >,

                | IgApiError
                | HttpRequestError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
    }
    Index

    Properties

    openEditProfile: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "EditProfile",
            "screen",
            {
                backgroundFailures: readonly {
                    message?: string;
                    request: "contactPointPrefill"
                    | "identityReminder";
                    tag: string;
                }[];
                biography: string;
                bioLinks: readonly {
                    linkId: string;
                    linkType: string;
                    title: string;
                    url: string;
                }[];
                fullName: string;
                profileEditParams: {
                    fullName: {
                        confirmationDialogText: string;
                        disclaimerText: string;
                        isPendingReview: boolean;
                        shouldShowConfirmationDialog: boolean;
                    };
                    username: {
                        confirmationDialogText: string;
                        disclaimerText: string;
                        isPendingReview: boolean;
                        shouldShowConfirmationDialog: boolean;
                    };
                };
                userId: string;
                username: string;
            },
            EditProfileActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            "userId",
            unknown,
        >,

            | IgApiError
            | HttpRequestError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps Edit profile: opens the profile editor over your profile. Answers the editor's handle, with this profile below it.

    openFeedTab: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "FeedTimeline",
            "tab",
            {
                entries: readonly (
                    | {
                        key: string;
                        media: {
                            carousel_media?: readonly { pk: ... }[];
                            code: string;
                            id: string;
                            injected?: { ad_id?: (...) | (...) } | null;
                            inventory_source?: string;
                            logging_info_token?: string;
                            media_type: number;
                            mezql_token?: string;
                            pk?: string;
                            product_type?: string;
                            ranking_info_token?: string;
                            taken_at?: number;
                            user?: { pk: string; username: string };
                        };
                        position: number;
                        slide?: number;
                        type: "post";
                    }
                    | {
                        key: string;
                        media: {
                            carousel_media?: readonly { pk: ... }[];
                            code: string;
                            id: string;
                            injected?: { ad_id?: (...) | (...) } | null;
                            inventory_source?: string;
                            logging_info_token?: string;
                            media_type: number;
                            mezql_token?: string;
                            pk?: string;
                            product_type?: string;
                            ranking_info_token?: string;
                            taken_at?: number;
                            user?: { pk: string; username: string };
                        };
                        position: number;
                        type: "reel";
                    }
                    | {
                        key: string;
                        media: {
                            carousel_media?: readonly { pk: ... }[];
                            code: string;
                            id: string;
                            injected?: { ad_id?: (...) | (...) } | null;
                            inventory_source?: string;
                            logging_info_token?: string;
                            media_type: number;
                            mezql_token?: string;
                            pk?: string;
                            product_type?: string;
                            ranking_info_token?: string;
                            taken_at?: number;
                            user?: { pk: string; username: string };
                        };
                        position: number;
                        type: "ad";
                    }
                    | {
                        key: string;
                        media: {
                            carousel_media?: readonly { pk: ... }[];
                            code: string;
                            id: string;
                            injected?: { ad_id?: (...) | (...) } | null;
                            inventory_source?: string;
                            logging_info_token?: string;
                            media_type: number;
                            mezql_token?: string;
                            pk?: string;
                            product_type?: string;
                            ranking_info_token?: string;
                            taken_at?: number;
                            user?: { pk: string; username: string };
                        };
                        position: number;
                        source: string;
                        type: "explore_story";
                    }
                    | {
                        key: string;
                        position: number;
                        subtitle: string;
                        title: string;
                        type: "caught-up";
                    }
                    | {
                        key: string;
                        position: number;
                        posts: readonly {
                            id?: string;
                            media_type?: number;
                            user?: { pk: ...; username: ... };
                        }[];
                        title: string;
                        type: "threads";
                    }
                    | {
                        key: string;
                        position: number;
                        reels: readonly {
                            id?: string;
                            is_eof?: boolean
                            | null;
                            media_type?: number;
                            pk?: string;
                            user?: { pk: ...; username: ... };
                        }[];
                        title: string;
                        type: "suggested-reels";
                    }
                    | {
                        item: { kind: "unknown"; kindKey?: string; raw: Json };
                        key: string;
                        position: number;
                        type: "unknown";
                    }
                )[];
                more_available: boolean;
                next_max_id?: string;
                requestId: string;
            },
            FeedTimelineActions & Omit<
                ScreenFeedMembers<
                    {
                        lastTakenAt?: number;
                        nextMaxId?: string;
                        position?: number;
                        reason: TimelineFeedReason;
                        requestId?: string;
                    },
                    FeedTimelineItems,
                    IgApiError
                    | HttpRequestError
                    | ScreenDataError,

                        | MobileSession
                        | MobileDevice
                        | MobileTelemetry
                        | GraphqlJsonHttp
                        | MobileApplication
                        | NavigationWire
                        | JsonResponseHttp
                        | MobileNetworkWire
                        | MobileProcessBackground
                        | MobileProcessMobileConfig
                        | MobileUserFlows,
                >,
                "stream",
            > & ScreenSwipeMembers<
                {
                    lastTakenAt?: number;
                    nextMaxId?: string;
                    position?: number;
                    reason: TimelineFeedReason;
                    requestId?: string;
                },
                FeedTimelineItems,
                ScreenFeedSwipeFailure<
                    IgApiError
                    | HttpRequestError
                    | ScreenDataError,
                    FeedTimelineItems,
                >,
                ScreenFeedPageServices<
                    | MobileSession
                    | MobileDevice
                    | MobileTelemetry
                    | GraphqlJsonHttp
                    | MobileApplication
                    | NavigationWire
                    | JsonResponseHttp
                    | MobileNetworkWire
                    | MobileProcessBackground
                    | MobileProcessMobileConfig
                    | MobileUserFlows,
                    FeedTimelineItems,
                >,
            >,
            ScreenFeedItems<FeedTimelineItems>,
            ScreenHandle | undefined,
            "optional",
            false,
            never,
            unknown,
        >,

            | IgApiError
            | HttpRequestError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps the feed tab on the bottom bar: goes back to the feed, as it was left when it was open in this session, or opens it. Answers the feed's handle.