@igpapi/android

The API reference of @igpapi/android

Android platform of igpapi, the Instagram private API Simulator for Node.js. This package runs the Instagram Android app on a virtual phone in your Node.js program: the process entries that start it, the login, the session, and the screens a person walks (the feed, Reels, search, profiles, Direct, publishing, challenges and more). The Android package is the priority direction of igpapi; the iOS package is implemented less exhaustively.

What is in it

• The entries: AndroidIgpapi.install, launch, resumeSilently, resumeFromBackground and resumeByReentering. Each starts one app process, runs your main on it and closes it (Ways to start the app).
• The screens: one class per screen, such as FeedTimelineScreen, with the actions a person takes on it (Screens).
• defineOtherwise: describes once what your program does about each challenge (Challenges).
• totpCodeOf: the six-digit code of an authenticator setup key (The authenticator code).
• The effects with no screen, called inside main (Effects inside main).
• AndroidApp: the app as an Effect layer, for programs that compose the effects themselves (Compose the app layer yourself).

The package re-exports everything from @igpapi/mobile and the names a program needs from @igpapi/core, so you import from @igpapi/android only.

Install

Get access and install sets up the registry, the token and the shared effect. Then:

npm install @igpapi/android effect@4.0.6

Then your first program.

Requirements

• Node.js ≥ 22
• TypeScript ≥ 7 (the published declarations are checked against TypeScript 7)
• the IGPAPI_LICENSE_TOKEN environment variable

Related packages

• @igpapi/ios: the iOS variant
• @igpapi/mobile: installed with this package
• @igpapi/core: installed with this package