igpapi

Appearance

Screens ​

Everything a person can do in the Instagram Android app, screen by screen. Each page below says what the person sees, what you do, and gives a program for each thing you can do on that screen.

How a screen page is laid out ​

  1. What the person sees, with a screenshot of the screen.
  2. What you do: the screen classes the page covers and what their actions are.
  3. The setup: the imports and the stored session every example starts from.
  4. The matrix: one row for each thing a person does, with the screen it starts on, the action and the result.
  5. The scenarios: one for each row, in the same order. Each says what the person does, shows the screenshot where one fits, gives the program, and says what you get.
  6. What this screen does not offer, where a reader would expect something the app has but the Simulator has no action for.

The shared setup ​

Every example starts from session.json, the session Your first program saved, and names the screen it expects (screen: FeedTimelineScreen). The examples show the success path: errors are answered as in Errors, and challenges by your otherwise constant (Challenges).

A handle, data and raw, back() and the screen in focus are explained once, in Work with screens.

The screen map ​

You reach a screen through an action of the screen before it.

AreaScreensHow you reach it
LoginLoginHomepageScreenAndroidIgpapi.install hands it to main
Two-factor loginLoginTwoFactorChooseMethodScreen, LoginTwoFactorApproveFromAnotherDeviceScreen, LoginTwoFactorAuthenticationAppCodeScreenlogIn(…) on an account with a second step
Account recoveryAccountRecoverySearchScreen, AccountRecoveryEmailCodeScreen, AccountRecoveryAuthenticationConfirmationScreenrecoverPassword() on the login screen
RegistrationRegistrationPhoneNumberScreen, RegistrationConfirmationCodeScreen, RegistrationPasswordScreen, RegistrationTermsOfServiceScreencreateNewAccount() on the login screen
ChallengesChallengeSelectVerifyMethodScreen, ChallengeVerifyCodeScreen, ChallengeRecaptchaScreenInstagram raises them; your otherwise branches receive them
Home feedFeedTimelineScreen, FeedTimelineFollowingScreenlaunch hands it to main; logIn(…) ends on it
ReelsReelsViewerScreenfeed.openReelsTab(), or a reel item's open()
Explore tabExploreScreenfeed.openSearchTab()
SearchSearchInputScreen, SearchResultsTopTabScreen, SearchResultsAccountsTabScreenexplore.openSearchInput(), then change(…) and search(…)
ProfilesUserProfileScreen, MyProfileScreen, EditProfileScreena search result's openProfile(); the profile tab
Likes, reposts and commentsPostOpenedFromLinkScreen, MediaCommentsScreena feed post's open(); openComments({})
Carousel poststhe post screen and the comments sheeta carousel post's open()
PublishingPostingGalleryPickerScreen, PostingPostEditScreen, PostingReelEditorScreen, PostingStoryPhotoEditorScreenfeed.openCreation('post' | 'reel' | 'story')
DirectDirectInboxScreen, DirectThreadScreen, DirectRecipientPickerScreen, DirectThreadDetailsScreenfeed.openDirectTab(), a profile's openDirectThread()

The pages of this site are the README files of the repository. The API reference is generated from the source.