# Instagram-bot

Automation scripts for Instagram 
- With AI and Avoid Bans Example codes </br>
- Cross framework support: TFI can run their own tools or other tools like instabot </br>

we wrote this package for educational purposes and used it in our inbo.ir . 
https://inbo.ir

## How to use it

```
IG_USERNAME=myUsername
IG_PASSWORD=myPassword

# Uncomment next line if you want to be in offline chat status
# ONLINE_MODE=false
# Uncomment next line to use a proxy
# IG_PROXY=http://proxyuser:proxypassword@xxx.xxx.xxx.xxx:xxxxx
# Uncomment next line to use email verifications | sms by default
# IG_VERIFICATION=email
```
    3. Copy the example.js on the root folder of your project from the repo
    4. Execute'node example.js' to test the scripts.

#### Following steps:
    1. Write your automation bots or copy the existent ones inside Tools-for-Instagram module 
    (Recommended to create a 'bots' folder in root of the project)
    2. Tests the bot using 'node bots/yourBot.js'

### Git way:
    1. Download the repo and install dependencies using this terminal commands:
    npm i 
```
    2. Rename .env_example to .env and edit the configuration.
    3. Execute 'node example.js' to test the scripts.


## Bot skills:
- [x] Login Flow
- [x] SMS/Email verification modes
- [x] Save Cookies in files
- [x] Remove Cookies
- [x] Session Regeneration
- [x] Get User Information
- [x] Get User Recent Posts
- [x] Get recent post Likers / By Username
- [x] Get Followers of account (save into a json file)
- [x] Get Followings of account (save into a json file)
- [x] Get my Last followers / Detect new Followers
- [x] Read Following/Followers files generated and return Array.
- [x] Like Content by URL
- [x] Like Content by MediaId 
- [x] Like Content by Post
- [x] Follow by Username
- [x] Follow by Id
- [x] Follow User by Post
- [x] Unfollow by Id
- [x] Unfollow by Username
- [x] View stories by User Id
- [x] View stories by Username
- [x] Get polls from stories
- [x] Vote poll from story
- [x] Get recent posts list of a hashtag
- [x] Get top posts list of a hashtag
- [x] Get recent post list by location
- [x] Get top post list by location
- [x] Save post list into scrape list
- [x] Implement lowdb Database
- [x] Save Likes information
- [x] Save Follows information
- [x] Save Unfollows information
- [x] Get Like activity
- [x] Get Follow activity
- [x] Get Unfollow activity
- [x] Current Time In Range Validator [ex: from 8:00 to 23:00]
- [x] Proxies
- [x] Multi-login
- [x] Multi-proxy per login
- [x] Like Recent Hashtags By Intervals
- [x] Follow Recent Hashtags By Intervals
- [x] Simple Bots Folder
- [x] NPM package support
- [x] View Stories from User  Id/Ids
- [x] View Stories from User Followers
- [x] View Stories from User Following
- [x] Live Streaming
- [x] Comment Media by Id
- [x] Get Comments On Post by Id
- [x] Get Media information by Id
- [x] Upload Pictures 
- [x] Get Media Type (photo, video, album...)
- [x] Get Photo/Video Url
- [x] Get Ibox/Pending Messages
- [x] Approve/Decline Pending Messages
- [x] Reply Messages / Send Stories
- [x] Detect Faces / Gender / Age Avg.
- [x] Anti Ban Mode (Better with mobile proxies)
- [x] Cookie validator/regenerator on Login
- [x] "It was Me message" validator checker
- [x] Low consumption proxies examples
- [x] Create Workers/Bosses threads
- [x] Cross Framework Support
- [X] Cross Framework Instabot example
- [X] Online Simulation
- [ ] CLI Alpha under construction
- [ ] Postprocessing of scrape list (detect faces, language, business accounts)



## Api mods

- Injected loggedInUser inside ig Object after login (ig.loggedInUser)
- Injected db inside ig Object after login (ig.db)
- Injected shortid generator inside ig Object
- Injected realtime modules on login



By default it will use the proxy from .env file if the proxy is not set on login().

```javascript
    let acc = loadConfig('exampleAccount');
    let myAccount2 = await login(acc);
    //same as await login("username", "password");

```

To avoid the default proxy from the .env file use false as inputProxy parameter on login file.

```javascript
module.exports = {
    inputLogin: 'accountName',
    inputPassword: 'password',
    inputProxy: false,
}
```

#### setAntiBanMode(ig)
Currently Antiban is for likes/follow/unfollow. 
WARNING: Antiban IS NOT MAGIC, if you use simple code/examples Like_Easy or Like_With_Scanner (Super simple codes) it is possible to be banned anyway. A good Example is Like_Avoid_Bans, use it with caution.
```javascript
    let ig = await login();
    await setAntiBanMode(ig);
```
Also it is possible to disable it:
```javascript
    let ig = await login();
    await setAntiBanMode(ig, false);
```
#### getUserInfo(ig, username)
Get the user information of the desired username
```javascript
   let info = await getUserInfo(ig, 'Instagram');
```


#### getRecentPostLikers(ig, post);
Get the last likers (max of 1000) of a post
```javascript
    let posts = await getUserRecentPosts(ig, username);
    let likers = await getRecentPostLikers(ig, posts[0]);
```

#### getRecentPostLikersByUsername(ig, username)
Get the last likers (max of 1000) of the last post of the desired username

```javascript
let likers = await getRecentPostLikersByUsername(ig,'instagram');
//Show the last liker of the array
console.log(likers[likers.length-1]);
```


#### getFollowers(ig, username)
It will save the followers inside the outputfolder with the format "acountName_followers.json"
```javascript
   await getFollowers(ig, 'Instagram');
```

### getMyLastFollowers(ig)
Get your last 100 followers, and save it to database, when some follower is new you will a is_new_follower attirbute
```javascript
   let followers = await getMyLastFollowers(ig);
   console.log(followers[0].is_new_follower);
```


#### getFollowing(ig, username)
It will save the following inside the outputfolder with the format "acountName_following.json"
```javascript
   await getFollowing(ig, 'Instagram');
```

#### readFollowers(ig, username)
It will return the followers inside the outputfolder with the format "acountName_followers.json"
```javascript
   let followers = await readFollowers(ig, 'Instagram');
```
#### readFollowing(ig, username)
It will return the following inside the outputfolder with the format "acountName_following.json"
```javascript
   let followers = await readFollowing(ig, 'Instagram');
```

#### likeUrl(ig, username, [force: bool])
like the desired instagram Url, the like will be saved inside database. 
```javascript
   await likeUrl(ig, 'https://www.instagram.com/p/B1gzzVpA462/');
```
If 'force' is set to true, when the item was already liked before it will force to continue the operation.
```javascript
   await likeUrl(ig, 'https://www.instagram.com/p/B1gzzVpA462/', true);
```

#### viewStoriesFromUser(ig, username)
View all the current stories of the given username
```javascript
   await viewStoriesFromUser(ig, 'instagram');
```

#### getPollsFromStories(ig, username)
Get Stories that currently have polls
```javascript
    let user = await getUserInfo(ig, "its.crystinx");
    let stories = await getStoriesFromId(ig, user.id);
    let polls = await getPollsFromStories(ig, stories);
```

#### voteStoryPoll(ig, username, value = 1)
Vote a poll, the value can be 0 or 1 (left or right)
```javascript
    let stories = await getStoriesFromId(ig, 18839378120);
    let polls = await getPollsFromStories(ig, stories);
    
    for(p in polls) {
        await voteStoryPoll(ig, polls[p]);//By default the value is always 1 if we don't set it
    }
    
```

#### isTimeInRange(startTime, endTime)
Returns True or False if the current time is inside the range
```javascript
   await isTimeInRange("10:00", "23:00");
```
It is also possible to calculate night ranges between the current day and tomorrow.

```javascript
   await isTimeInRange("23:00", "3:00");
```

#### likeRecentHashtagsByIntervals(ig, hashtagArray, intervals, likesPerInterval, waitMinutesBetweenLikes)

Automate like actions on given array of recent hashtags feed

```javascript
    let likesPerInterval = 15;
    let waitMinutesBetweenLikes = 3;

    let intervals = [
        ["7:00",    "8:00"],
        ["10:00",   "11:00"],
        ["22:00",   "23:00"],
    ];
    let hashtagArray = [
        "cats",
        "dogs",
        "music"
    ];

   let likeInterval = likeRecentHashtagsByIntervals(
                                                    ig,
                                                    hashtagArray, 
                                                    intervals, 
                                                    likesPerInterval,
                                                    waitMinutesBetweenLikes);
```
It is also possible to stop the interval clearing it

```javascript
   clearInterval(likeInterval);
```

#### uploadPicture(ig, caption, picturePath, namesToTag = [])
Upload a picture from computer to Instagram account
```javascript
const path = require('path');
let myPicturePath = path.join(__dirname, '/images');
await uploadPicture(ig, "My picture", myPicturePath);
```
#### uploadAlbum(ig, caption, album, namesToTag = [])
This example is not tested yet, if anyone can verify, please send a message to Issues section:
Set tagged accounts to it
```javascript
const path = require('path');
let myPicture = path.join(__dirname, '/images/image.jpg');
let album = [];
album.push(myPicture);
await uploadAlbum(ig, "My picture", "caption", album, namesToTag = ['linkfytester', 'instagram']);
```

#### uploadPictureByUrl(ig, caption, pictureUrl)
```javascript

let pictureUrl = "https://i.ytimg.com/vi/w6-1O0WCdGM/maxresdefault.jpg";
let caption = "This is a test image that I'll delete in a few seconds";
let image = await uploadPictureByUrl(ig, caption, pictureUrl);
```

#### commentMediaId(ig, mediaId, commentContent)
Post a comment on the desired post giving the media Id
```javascript
 let posts = await recentHashtagList(ig, "dogs");
 await commentMediaId(ig, posts[0].pk, "Amazing!");
```
#### commentPost(ig, post, comment)
```javascript
    let posts = await recentHashtagList(ig, "dogs");
    await commentPost(ig, posts[0], "Lovely!");
```

#### getPostCommentsById(ig, id)
By default you will get 20 comments:
```javascript
    let posts = await topHashtagList(ig, "dogs");
    //Each post have a pk (private key) that is used as Id.
    let comments = await getPostCommentsById(ig, posts[0].pk);
    comments.forEach(comment => {
        console.log(comment.text);
    });
```
You can specify a max for the comments:
```javascript
    let posts = await topHashtagList(ig, "dogs");
    //Get 100 comments
    let comments = await getPostCommentsById(ig, posts[0].pk, 100);
    comments.forEach(comment => {
        console.log(comment.text);
    });
```
#### replyDirectMessage(ig, {userId:id}, message)
Send message by user id
```javascript
    let user = await getUserInfo(ig, "Instagram");
    let sendDm = await replyDirectMessage(ig,{ userId : user.pk }, "yay!");
```
#### replyDirectMessage(ig, {threadId:id}, message)
Send message by Inbox thread Id
```javascript
    let inbox = await getInbox(ig);
    let sendDm = await replyDirectMessage(ig,{ threadId : inbox[0].threadId }, "yay!");
```

#### replyDirectMessage(ig, {userId, story})

Send Story as a Message to userId or ThreadId 
```javascript
    let ig = await login();
    let instagram = await getUserInfo(ig, 'instagram');
    let stories = await getStoriesFromId(ig, instagram.id);
    let linkfy = await getUserInfo(ig, 'linkfytester');
    //Share normal message
    await replyDirectMessage(ig, {userId: linkfy.id}, 'I will send you a story');
    //Share story test
    await replyDirectMessage(ig, {userId: linkfy.id, story:stories[0]});
```

### Undocumented methods:
#### recentHashtagList(ig, hashtag)
#### topHashtagList(ig, hashtag)
#### likeMediaId(ig, pk)
#### likePost(ig, post)
#### recentLocationList(ig, location, [randomize: bool])
#### topLocationList(ig, location, [randomize: bool])
#### savePosts(ig, posts, filename)
#### followUser(ig, username)
#### followById(ig, userId)
#### followUserByPost(ig, post)
#### getLikeActivityByHours(ig, startingHour)
#### getFollowActivityByHours(ig, startingHour)
#### getUnfollowActivityByHours(ig, startingHour)
#### getLikeActivityFromHourToNow(ig, "12:05")
#### lastLikeMinutesAgo(ig)
#### removeCookie(ig)
#### followRecentHashtagsByIntervals(ig, hashtagArray, intervals, followsPerInterval, waitMinutesBetweenFollows)
#### viewStoriesFromId(ig, userId)
#### getStoriesFromId(ig, userId);
#### viewStoriesFromFollowing(ig, username)
#### viewStoriesFromFollowers(ig, username)
#### getUserRecentPosts(ig, username)
#### requestLivestream(ig)
#### getMediaIdInfo(ig, mediaId)
#### getMediaUrlInfo(ig, url)
#### getMediaType(ig, mediaIdOrUrl)
#### getPhotoUrl(ig, mediaIdOrUrl)
#### getVideoUrl(ig, mediaIdOrUrl)
#### getInbox(ig)
#### getInboxPending(ig)
#### approveInboxPending(ig, id)
#### declineInboxPending(ig, id)
#### unfollowUser(ig, accountName)
#### unfollowById(ig, id)
#### regenerateSession(ig)
#### executeAntiBanChecks(ig)

## Scrapper / Spider
### Login is not required for the next functions

#### spider.getUserInfo(username)
Get the basic information of some user, also the last posts
```javascript
(async () => {

    let info = await spider.getUserInfo("linkfytester");
    console.log(info);
})();
```

#### spider.userHasStories(username)
Get true or false if the user has stories
```javascript
(async () => {

    let info = await spider.userHasStories("linkfytester");
    console.log(info);
})();
```
#### spider.getUserLikers(username, maxUsers)
Get user likers of some post, it is useful when trying to scrap more than 10k users
```javascript
(async () => {

    let users = await spider.getUserLikers("linkfytester");
    console.log(info);
})();
```

```javascript
(async () => {

    let users = await spider.getUserLikers("linkfytester", maxUsers=50);
    console.log(info);
})();
```

## Advanced Stuff

### Using Bosses and Workers

We will be able to use "workers". Multiple executions of bots that work as "threads" and report the execution to a Boss or Controller. Example Uses:
1. Bot continue execution when one worker is not working
2. Bot have a max time to resolve operations, (useful to know if a service is down)
3. Bot can retry the worker code if it fails
4. Bot can run code that is not from from the repo/or is another language like python or C++ and expect a result in a certain time

#### How to use properly
* All workers must go inside the bots/workers folder
* All bosses must go inside the bots/bosses folder
* The accounts used by th workers must be declared inside the account folder as the example show (not all the fields are required)
* Not all the workers will need an account, it depends on the code of your worker, maybe you use want to use a worker for Maths for example

#### Developing a worker and boss
1. Copy the example worker from bots/workers and modify the code
2. Copy the example boss from bots/bosses and edit the code, (a boss can work as a normal bot, but they are specially designed to manage workers)
3. Use the executeWorker as the example shows to call workers sync/async as you preffer on the boss script, all parameters are optional except workerName
4. Call the boss script from the root directory where the accounts are located (thats important, it will try to load the accounts from there), example below

```sh
node bots/bosses/exampleBoss
```
#### Advanced workers, execution of script bots as a worker subroutine
There is also possible to execute advanced workers with the function executeAdvancedWorker, instead of sending an 'accountLogin' parameter, use the 'variables' parameter to send all the related parameters and information to the bot. <br>

For example the advanced boss scriptLoaderBoss.js sends an script name to the scriptLoader.js worker.

```javascript
    let worker1 =  executeAdvancedWorker({
        workerName: 'scriptLoader',
        variables: {scriptName: 'Message_New_Followers'},
        timeout: Infinity  // Set to Infinity to avoid Timeout seconds on subroutines
    });
```

The advanced worker read the variables like that:
```javascript
module.exports = function (variables, callback) {
    (async () => {
        console.log(variables.scriptName +'.js')
        ///...
```
Recursive intervals (setInterval) are only executed once when normal scripts are called from a worker, so consider to set the intervals inside the worker code and not inside the script code. In this example (scriptLoader.js) you can see how Message_New_Followers is only executed once for that reason.

### Using CLI for development
The CLI is currently under construction so it will change constantly

#### Installing
Inside the root folder on git / the node_modules folder on npm
```sh
cd cli
npm link
cd ..
```
Well done! Now you can use tfi on your current session

#### Using tfi
Use tfi from the root working folder to see expected results.

Get the current available commands:

```sh
tfi help
```

Create a new bot:

```sh
tfi new bot
```

Create a new bot called myBot:

```sh
tfi new bot myBot
```

Execute an existing bot [Proxy is optional]:

```sh
tfi start -b bots/botname.js -u username -p password -y proxy 
```

When the cookie exists you can use it without password
```sh
tfi start -b bots/botname.js -u username
```



