Skip to main content

Instagram client built with Python 3.8 and the Selenium package.

Project description

instaclient

instaclient is a Python library for accessing Instagram's features. With this library you can create Instagram Bots with ease and simplicity. The InstaClient takes advantage of the selenium library to excecute tasks which are not allowed in the Instagram Graph API (such as sending DMs).

The only thing you need to worry about is to spread your requests throughout the day to avoid reaching Instagram spam limits.

Disclaimer: Please note that this is a research project. I am by no means responsible for any usage of this tool. Use it on your behalf. I'm also not responsible if your accounts get banned due to the extensive use of this tool.

Table of Contents

  1. Current Features
  2. Installation
  3. Usage
  4. Contributing
  5. Help - Community
  6. Credits
  7. License

Current Features

  • Scrape a user's followers
  • Follow a user
  • Unfollow a user
  • Send DMs to users
  • Like a users latest posts (max 15 for now - not working yet)
  • Get a users image media (not working yet)

Installation

Use the package manager pip to install instaclient.

pip install instaclient

To update the package:

pip install -U instaclient

Usage

INSTALL A DRIVER (LocalHost)

If you are running your code on a localhost, then you'll need to install a chromedriver from here. Install and extract the chromedriver.exe file and save it in your project folder. Make sure to install the version that matches your Chrome version. To check your chrome version, type chrome://version/ in the chrome address bar.

SET ENVIROMENT VARIABLES (Web Server)

If you are running your code on a web server (Like Heroku), you should set the following enviroment variable:

  • CHROMEDRIVER_PATH = /app/.chromedriver/bin/chromedriver
  • GOOGLE_CHROME_BIN = /app/.apt/usr/bin/google-chrome

CREATE THE CLIENT

from instaclient import InstaClient
from instaclient.errors import *

# Create a instaclient object. Place as driver_path argument the path that leads to where you saved the chromedriver.exe file
client = InstaClient(driver_path='<projectfolder>/chromedriver.exe')

LOGIN INTO INSTAGRAM

from instaclient.errors import *

try:
    client.login(username=username, password=password) # Go through Login Procedure
except VerificationCodeNecessary:
    # This error is raised if the user has 2FA turned on.
    code = input('Enter the 2FA security code generated by your Authenticator App or sent to you by SMS')
    client.input_verification_code(code)
except SuspisciousLoginAttemptError as error:
    # This error is reaised by Instagram
    if error.mode == SuspisciousLoginAttemptError.EMAIL:
        code = input('Enter the security code that was sent to you via email: ')
    else:
        code = input('Enter the security code that was sent to you via SMS: ')
    client.input_security_code(code)

SEND A DIRECT MESSAGE

result = client.send_dm('<username>', '<Message to send>') # send a DM to a user

Make sure to distrubute your client.send_dm() requests over a period of time to avoid reaching Instagram's spam limits.

GET A USER'S FOLLOWERS

followers = client.scrape_followers(user='<username>') # replace with the target username

The client.scrape_followers() method can take a lot of time depending on the amount of followers you want to scrape.

This method might be updated in the near future to cache scraped data in a SQLite database or to scrape the followers in a separate thread with a queue.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Help Community

You can join this Telegram Group to ask questions about the instabot's functionalities or to contribute to the package!

Credits

AUTHORS

License

MIT

Project details


Release history Release notifications | RSS feed

This version

2.1.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

instaclient-2.1.8.tar.gz (24.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page