Awesome

puppeteer-instagram

Instagram automation driven by headless chrome.

This module also has a CLI.

Install

npm install --save puppeteer-instagram

Usage

This example signs into an Instagram account.

const PuppeteerInstagram = require('puppeteer-instagram')

const instagram = new PuppeteerInstagram()

await instagram.signin({ username: 'xxx', password: 'xxx' })
await instagram.close()

API

Table of Contents

• PuppeteerInstagram
  • isAuthenticated
  • user
  • browser
  • signup
  • signin
  • signout
  • verifyEmail
  • close

PuppeteerInstagram

Instagram automation driven by headless chrome.

Type: function (opts)

• opts Object Options (optional, default {})
  • opts.browser Object? Puppeteer browser instance to use
  • opts.puppeteer Object? Puppeteer launch options

isAuthenticated

Whether or not this instance is authenticated with Instagram.

Type: boolean

user

Authenticated user if authenticated with Instagram.

Type: Object

browser

Puppeteer Browser instance to use.

Type: function ()

signup

Automates the creation of a new Instagram account.

Type: function (user, opts): Promise

• user object User details for new account
  • user.email string Email
  • user.username string? Username
  • user.firstName string? First name
  • user.lastName string? Last name
  • user.password string? Password
• opts object Options (optional, default {})
  • opts.verify boolean? Whether or not to verify email
  • opts.emailPassword string? Email password for verification

signin

Signs into an existing Instagram account.

Note: either username or email is required.

Type: function (user, opts): Promise

• user Object User details for new account
  • user.username string? Username
  • user.email string? Email
  • user.password string Password
• opts Object Options (optional, default {})

signout

Signs out of the currently authenticated Instagram account.

Type: function (): Promise

verifyEmail

Verifies the authenticated Instagram account's email via puppeteer-email.

Type: function (opts): Promise

• opts Object Options
  • opts.emailPassword string Email password for verification
  • opts.email string? Email verification (defaults to user's GitHub email)

close

Closes the underlying browser instance, effectively ending this session.

Type: function (): Promise

Related

• puppeteer-instagram-cli - CLI for this module.
• puppeteer-email - Email automation driven by headless chrome.
• puppeteer - Headless Chrome Node API.
• awesome-puppeteer - Curated list of awesome puppeteer resources.

Somewhat Related

• private api - Instagram's private API (php)
• instabot.py - Popular Instagram bot (python)
• instagram-node - Deprecated node SDK (javascript)
• node-instagram - More recent node SDK (javascript)

License

MIT © Travis Fischer

Support my OSS work by <a href="https://twitter.com/transitive_bs">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a>