0.2.4-alpha.1 • Published 4 months ago

instapeek-a-boo v0.2.4-alpha.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

instapeek-a-boo

Overview

This script is designed to automate the process of scraping images from Instagram stories of specified profiles and uploading or saving them. It leverages Puppeteer for browser automation, Axios for HTTP requests, and Node.js file system promises for file handling.

Features

  • Automated Instagram Login: Logs into Instagram with provided credentials.
  • Targeted Story Scraping: Scrapes images from the stories of specified Instagram profiles.
  • Image Processing: Buffers scraped images for upload or local saving.
  • Image Upload: Optional upload of images to a remote server.
  • Local Image Saving: Optional saving of images locally.

Configuration

  • Default configuration is provided in the DEFAULTS object. Override these by passing your options to initiateSession.
  • Mandatory fields: login, password, targets.
  • Optional fields: directory, fileActionType, headless, key, remote, userDataDir.
  • fileActionType can be save, upload, or both.

Usage

  1. Import the function from the script.
  2. Call initiateSession with necessary options.
import initiateSession from "instapeek-a-boo";

initiateSession({
  directory: "your_chosen_directory",
  fileActionType: "both",
  headless: "new",
  key: "your_remote_server_key",
  login: "your_instagram_username",
  password: "your_instagram_password",
  remote: "your_remote_server_url",
  targets: ["target_instagram_username_1", "target_instagram_username_2"],
  userDataDir: undefined,
});

Minimal Example

initiateSession({
  login: "your_instagram_username",
  password: "your_instagram_password",
  targets: ["target_instagram_username_1"],
});

Important Notes and Disclaimer

  • This script was created due to the limitations of the Instagram API, which currently does not allow access to stories. This lack of functionality prompted the development of this tool.
  • This script automates interactions with Instagram, which may violate Instagram's terms of service. Use at your own risk.

Maintenance and Updates

  • Instagram's frontend and website structure may change over time, which can impact the functionality of this script. To ensure its continued effectiveness, it may require periodic updates and adjustments.
  • Contributors and the community are encouraged to collaborate on maintaining and improving this tool to adapt to Instagram's evolving platform.

Project Demo

Check out the live demo to see the project in action.