twitter-stream

Simple Node.js Twitter (API 1.1) stream client (https://dev.twitter.com/streaming/overview)

Install

npm install twitter-stream

Usage

var TwitterStream = require('twitter-stream');
var stream = new TwitterStream({
    consumer_key: '',
    consumer_secret: '',
    access_token_key: '',
    access_token_secret: '',
    stream_url: 'https://stream.twitter.com/1.1/statuses/filter.json'
});

//create stream
stream.stream({
    track: '#github'
});

//listen stream data
stream.on('data', function(json) {
  console.log(json);
});

Events

• data - stream data in JSON format
• garbage - stream data who can't be parsed to JSON
• close - stream close event (stream connection closed)
• error - error event (request error, response error, response status code greater than 200)
• connected - stream created
• heartbeat - twitter emitted heartbeat

Methods

• stream - create stream connection
• destroy - destroy/close stream connection

Streaming API request parameters link

var params = {
    with: 'user'
}
//create stream
stream.stream(params);

Reserved parameters for lib

• delimited
• stall_warnings