# node-twitter-bot

> Node Twitter Bot

Latest version **0.1.0** (published 2015-11-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-twitter-bot
pnpm add node-twitter-bot
yarn add node-twitter-bot
bun add node-twitter-bot
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-11-01 |
| First published | 2015-09-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Anton Nikolenko |
| Maintainers | nikolenkoanton92 |
| Keywords | twitter, bot |

## Links

- npm: https://www.npmjs.com/package/node-twitter-bot
- Repository: https://github.com/nikolenkoanton92/node-twitter-bot
- Issues: https://github.com/nikolenkoanton92/node-twitter-bot/issues
- npm.io page: https://npm.io/package/node-twitter-bot

## Dependencies (2)

- [twit](https://npm.io/package/twit.md) ^2.1.0
- [superpipe](https://npm.io/package/superpipe.md) ^0.4.1

## Recent versions

- 0.1.0 (latest) — 2015-11-01
- 0.0.91 — 2015-10-07
- 0.0.9 — 2015-10-06
- 0.0.8 — 2015-09-27
- 0.0.7 — 2015-09-25
- 0.0.6 — 2015-09-22
- 0.0.5 — 2015-09-13
- 0.0.4 — 2015-09-13
- 0.0.3 — 2015-09-12
- 0.0.2 — 2015-09-11
- 0.0.1 — 2015-09-09

## README

# Node Twitter Bot

[![Join the chat at https://gitter.im/nikolenkoanton92/node-twitter-bot](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/nikolenkoanton92/node-twitter-bot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

##  This version is Unstable, You can use for fun.


##  Installation

The easiest way to install node-twitter-bot is with [`npm`](http://npmjs.org)

```sh
npm install node-twitter-bot
```

Alternately, download the source.

```sh
git clone https://github.com/nikolenkoanton92/node-twitter-bot.git
```

##  Features

* follow users by tweet
* follow user by specified user
* unfollow users


##  Usage

You will also need to create an app account on [https://dev.twitter.com/apps](https://dev.twitter.com/apps)

*  Sign in with your Twitter account
*  Create a new app account
*  Modify the settings for that app account to allow read & write
*  Generate a new OAuth token with those permissions

Following these steps will create 4 tokens that you will need to place in the configuration file discussed below.

``` consumerKey ``` , ```consumerSecret ``` , ``` accessToken ``` , ``` accessTokenSecret ``` are your API keys that you received from creating your app account.

```javascript
var  NodeTwitterBot = require('node-twitter-bot');

var nodeTwitterBot = new NodeTwitterBot({
  consumerKey : 'Your Consumer Key',
  consumerSecret : 'Your consumer Secret',
  accessToken : 'Your access Token',
  accessTokenSecret : 'Your access Token Secret'
});
```

## API

This API should work exactly the same in node. Open an issue if this is not the case.

#### `nodeTwitterBot.followByTweets(phrase,[options])`

Start following people by `phrase` in tweet.

If ```options``` is specified, then the default options(shown bellow) will be overridden.

```javascript
{
  result_type: String, // Specifies what type of search results you would prefer to receive. By default : popular. You can change to recent, popular, mixed.
  count: Number, // The number of tweets to return per page, up to a maximum of 100. Defaults to 15.
}
```
#### `nodeTwitterBot.followByUser(user,[options])`

Start following peoply by 'user name'(should be String) in tweet.

if ```options``` is specified, the the default options(show bellow) will be overridden.

```javascript
{
  count: Number, // Maximum of 5,000 per distinct request. Defaults to 15.
  file : {
    save : true, // if you would like save followers to file add true, by default it is false.
    fileName:  'file name of the file' // set filename of file
  }
}

```

#### `nodeTwitterBot.unfollowAll(user,[options])`

Start unfollowing people.

`user` can be any of the following:

* the ID of the user for whom to return results for.
* the screen name of the user for whom to return results for.

---
_Source: https://npm.io/package/node-twitter-bot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._