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

    Interface IgpapiClientOptions

    interface IgpapiClientOptions {
        dangerAcceptInvalidCerts?: boolean;
        fcmToken?: string;
        http3AttemptTimeoutMs?: number;
        location?: MobileDeviceLocation;
        network?: MobileNetwork;
        protocolMode?: TransportProtocolMode;
        proxy?: string;
        pushToken?: string;
        requestTimeoutMs?: number;
        seed?: string;
        snapshot?: {
            application: MobileApplicationState;
            cookies: unknown;
            device: MobileDeviceState;
            session: MobileSessionState;
        };
        timezone?: string;
    }
    Index

    Properties

    dangerAcceptInvalidCerts?: boolean
    fcmToken?: string

    The device's Google (FCM) registration token, when the platform has one (Android's AndroidIgpapiOptions.fcmToken). It is a device fact (MobileDeviceState.fcmToken), supplied by the caller and never generated (“Architecture”, “Identities a service issues are not measurements”); when set it replaces a restored snapshot's token. Absent: the device has no Google push channel and registers only its FBNS channel.

    http3AttemptTimeoutMs?: number

    How long the transport tries HTTP/3 before falling back (auto); passed as is when set.

    The coarse position the device knows, when the caller models one. It is a device fact (the 450 app sends it on the search results, the 451 app sends none on a device without one); set it here or in the snapshot. When set it replaces a restored snapshot's position.

    network?: MobileNetwork

    The network the device is on. Default: cellular LTE for a new device; a restored snapshot keeps the network it was saved with. Pass { kind: 'wifi' } to present the device on Wi-Fi; when set it also replaces a restored snapshot's network. See MobileNetwork.

    protocolMode?: TransportProtocolMode

    Protocol mode passed to the native transport as is; overrides the platform default (TransportPlatformDefaults.protocolMode).

    proxy?: string
    pushToken?: string

    The device's push token from the platform push SDK (FCM/FBNS on Android, APNs on iOS). It is a device fact, so the launch reads it from the device (MobileDeviceState.pushToken); when set it replaces a restored snapshot's token. Absent: no push registration, never an invented token.

    requestTimeoutMs?: number

    Timeout of every API request, in milliseconds (default DEFAULT_REQUEST_TIMEOUT_MS); a request's own timeoutMs wins. A timed-out request is abandoned, not cancelled — see createHttpTransportLayer.

    seed?: string
    snapshot?: {
        application: MobileApplicationState;
        cookies: unknown;
        device: MobileDeviceState;
        session: MobileSessionState;
    }

    The stored snapshot, as an object (owner decision, 2026-10-24: only an object, never JSON text — the caller parses what its storage returns). A value that is not the snapshot's shape, text included, is a SnapshotDecodeError.

    timezone?: string

    The device's time zone, as an IANA name (Asia/Makassar). It is a device fact: the app reports the zone's name (x-ig-device-timezone, device_timezone_name) and its offset for the zone (x-ig-timezone-offset, timezone_offset, derived here from the name). Set it so the virtual phone's clock matches the proxy's exit country; absent, a new device takes the host machine's zone. When set it replaces a restored snapshot's zone.