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

    Interface LoginHomepageActions

    The actions of LoginHomepageScreen: the methods you call on its handle while the screen is open. logIn's own transitions to the two-factor screens and the recovery code-entry screen are action edges: the trail records them, but a handle shows no transition that skips the login that issued them.

    interface LoginHomepageActions {
        createNewAccount: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "RegistrationPhoneNumber",
                "screen",
                {},
                RegistrationPhoneNumberActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError
                | RegistrationPhoneNumberEnterFailure,
            never,
        >;
        logIn: (
            ...args: [credentials: LoginInput],
        ) => Effect<
            LoginHomepageAnswer,
            | IgNotFoundError
            | IgRateLimitError
            | IgSpamError
            | IgCheckpointError
            | IgAccountSuspendedError
            | IgAccountDisabledError
            | IgCookieConsentRequiredError
            | IgLoginRequiredError
            | IgUserLoggedOutError
            | IgPrivateUserError
            | IgInactiveUserError
            | IgSentryBlockError
            | IgIpBlockError
            | IgLoginTwoFactorRequiredError
            | RequestError
            | ParseError
            | TransportError
            | PasswordEncryptionKeysUnavailableError
            | LoginBloksParseError
            | LoginBloksRejectedError
            | LoginTwoFactorEntrypointParseError
            | LoginAccountRecoveryRequiredError
            | LoginAccountRecoveryContinueError
            | IgBloks429Error
            | IgLoginBadPasswordError
            | AccountRecoveryBloksIssuedParamsMissingError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | AppAlreadyStartedError
            | ScreenEdgeInputError,
            never,
        >;
        recoverPassword: (
            ...args: [],
        ) => Effect<
            AssembledHandle<
                "AccountRecoverySearch",
                "screen",
                {
                    aac: string;
                    searchScreenType: string;
                    searchTicket: string & Brand<"SearchTicket">;
                    textInputId: string;
                    waterfallId: string;
                },
                AccountRecoverySearchActions,
                Record<never, never>,
                ScreenHandle,
                "required",
                true,
                never,
                AndroidScreens,
            >,

                | BloksHttpError
                | AccountRecoveryBloksIssuedParamsMissingError
                | ScreenEnterConcurrentError
                | ScreenDataError
                | ScreenEdgeInputError,
            never,
        >;
    }
    Index

    Properties

    createNewAccount logIn recoverPassword

    Properties

    createNewAccount: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "RegistrationPhoneNumber",
            "screen",
            {},
            RegistrationPhoneNumberActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError
            | RegistrationPhoneNumberEnterFailure,
        never,
    >

    Taps Create new account and opens the first registration screen. Answers its handle.

    logIn: (
        ...args: [credentials: LoginInput],
    ) => Effect<
        LoginHomepageAnswer,
        | IgNotFoundError
        | IgRateLimitError
        | IgSpamError
        | IgCheckpointError
        | IgAccountSuspendedError
        | IgAccountDisabledError
        | IgCookieConsentRequiredError
        | IgLoginRequiredError
        | IgUserLoggedOutError
        | IgPrivateUserError
        | IgInactiveUserError
        | IgSentryBlockError
        | IgIpBlockError
        | IgLoginTwoFactorRequiredError
        | RequestError
        | ParseError
        | TransportError
        | PasswordEncryptionKeysUnavailableError
        | LoginBloksParseError
        | LoginBloksRejectedError
        | LoginTwoFactorEntrypointParseError
        | LoginAccountRecoveryRequiredError
        | LoginAccountRecoveryContinueError
        | IgBloks429Error
        | IgLoginBadPasswordError
        | AccountRecoveryBloksIssuedParamsMissingError
        | ScreenEnterConcurrentError
        | ScreenDataError
        | AppAlreadyStartedError
        | ScreenEdgeInputError,
        never,
    >

    Types your username and password and taps Log in. Answers where the login leads: the feed, the two-factor approval or method-picker screen, or the last-resort recovery code-entry screen. Each call is one login: two concurrent calls send two logins.

    recoverPassword: (
        ...args: [],
    ) => Effect<
        AssembledHandle<
            "AccountRecoverySearch",
            "screen",
            {
                aac: string;
                searchScreenType: string;
                searchTicket: string & Brand<"SearchTicket">;
                textInputId: string;
                waterfallId: string;
            },
            AccountRecoverySearchActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | BloksHttpError
            | AccountRecoveryBloksIssuedParamsMissingError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >

    Taps Forgot password and opens the account-recovery search. Answers its handle; fails with the recovery step's typed error when the login home issued no recovery entry.

    Settings

    Member Visibility

    On This Page

    Properties