Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Branch: master
Fetching contributors…

Cannot retrieve contributors at this time

182 lines (130 sloc) 4.61 KB


Connect to Twitter's Streaming API via Node.js Streams (using EventStreams)


  • Uses Node Streams
  • With the help of EventStream
  • and Request (which also uses EventStream)
  • This means you can pipe() stuff around, which is really great
  • Can pull down and deflate gzipped data (and does so by default)
  • Inspiration (and some borrowed logic) from ntwitter


  • No tests
  • Site streams currently unsupported
  • Lacking in error handling

Put some tweets in your pipe and do stuff with them

Basic usage


var TweetPipe = require('tweet-pipe');

var tp = new TweetPipe({
  consumer_key: 'yourconsumerkey',
  consumer_secret: 'yourconsumersecret',
  token: 'youraccesstoken',
  token_secret: 'youraccesstokensecret'

Streamin' [, params] [, data_events] [, callback(stream)])'statuses/sample'); // returns a Stream that emits tweet JSON

That won't really do anything, but from there you can pipe the tweets into other streams that do stuff:'statuses/sample')

With params

var params = {
  'track': ['ball', 'rim', 'john'],
  'locations': ['-122.75,36.8,-121.75,37.8', '-74,40,-73,41'], // SF and NY
  'follow': ['justinbieber', 'nodejs']
};'statuses/filter', params); // will emit tweets that match any one of the params

All parameters

With a callback'statuses/sample', function (stream) {
  // hook to emitted events and do stuff
  stream.on('tweet', function (tweet) {
    // do stuff with tweet

Change what gets emitted as 'data'

By default, will only pipe out tweets (as JSON). You can change this so that other message types are emitted as 'data'.

// pipe out 'delete' and 'scrub_geo' messages as well'statuses/sample', ['tweet', 'delete', 'scrub_geo']);

// pipe out all message types'statuses/sample', ['all']);

// don't pipe anything out'statuses/sample', false);

// pipe out only tweet text'statuses/sample', false, function (stream) {
  stream.on('tweet', function (tweet) {
    stream.emit('data', tweet.text);

Supported events

Refer to:

'tweet', 'delete', 'limit', 'scrub_geo', 'status_withheld', 'user_withheld', 'friends', 'event'

'all' emits data chunks of all types

Raw streams and convenience methods

You can also access the raw, [un-deflated,] unparsed stream with tp.raw_stream(method, params, callback). Note that the callback here is on the Request object -- the above events are not emitted.

If you're piping this stream elsewhere you can use tp.unzip() to deflate gzipped streams and tp.parse() to convert the stream into JSON. tp.stringify() is also available and can be useful with

  .pipe(tp.parse()) // to JSON
  .pipe(tp.stringify()); // woo, back to a string!


Track the popularity of various Mexican cuisine for one minute:

var TweetPipe = require('tweet-pipe');

var oauth = {
  consumer_key: 'yourconsumerkey',
  consumer_secret: 'yourconsumersecret',
  token: 'youraccesstoken',
  token_secret: 'youraccesstokensecret'

var tp = new TweetPipe(oauth);

var tacos = burritos = enchiladas = 0;

var params = { track: ['taco', 'burrito', 'enchilada'] };'statuses/filter', params, false, function (stream) {

  stream.on('tweet', function (tweet) {
    if (\btacos?\b/i) >= 0) tacos++;
    if (\bburritos?\b/i) >= 0) burritos++;
    if (\benchiladas?\b/i) >= 0) enchiladas++;

    // choose what gets piped to next stream (if anything)
    // in this case, pipe out tweet text
    stream.emit('data', tweet.text + '\n');

  stream.on('error', function (error) {
    console.log('Uh oh: ' + error);

  stream.on('end', function () {
    console.log("THE RESULTS");
    console.log('Tacos: ' + tacos);
    console.log('Burritos: ' + burritos);
    console.log('Enchiladas: ' + enchiladas);

  // stop the stream after 60 seconds
  stream.timeout(60 * 1000);
}).pipe(process.stdout); // tweet text piped to stdout



Jump to Line
Something went wrong with that request. Please try again.