Skip to content

transitive-bullshit/puppeteer-instagram

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

puppeteer-instagram

Instagram automation driven by headless chrome.

NPM Build Status JavaScript Style Guide

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

Instagram automation driven by headless chrome.

Type: function (opts)


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
  • 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

Somewhat Related

License

MIT © Travis Fischer

Support my OSS work by following me on twitter twitter

About

Instagram automation driven by headless chrome.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published