npm install tweetstream
A tweet stream has the following methods, members, events, and usage.
var tweetstream = require('tweetstream'),
sys = require('sys');
var stream = tweetstream.createTweetStream({ track:["twitter"]
, username:"twitterusername"
, password:"mypassword"
});
stream.addListener("tweet", function (tweet) {sys.puts(sys.inspect(tweet))});
The first argument is an options object. The username and password options are required, all others are optional but you'll need at least the track, follow, track or locations.
-
'username'
- A twitter username. -
'password'
- The password for the provided twitter username.
Stream type options. The default stream type is the 'chirp
stream unless filter options are passed.
-
'chirp'
- boolean. default is true. - '
firehose
' - boolean. Full twitter firehose, requires an account with escalated privileges. - '
links
' - boolean. All tweets that contain a URI in the text, requires an account with escalated privileges. - '
retweet
' - boolean. All tweets that are retweets, requires an account with escalated privileges.
Filter options. Using any of the following options will default to the filter stream.
-
'track'
- An array of keywords to track. -
'follow'
- An array of userids to follow. -
'locations'
- An array of locations to follow.
function (tweet) { }
The 'tweet'
event emits a decoded JSON object from the 'status
' event.
function (info) { }
When using the chirp stream the first line sent to the stream contains info about the user which is decoded and sent as 'info'
to this event.
function (line) { }
The 'line'
event emits a utf8 string which is a usually a single twitter status message. This message should be in JSON format but is not decoded, if you intend to decode it you should use the 'tweet
' event.
function (data) { }
The 'data'
event emits a Buffer
directly from the HTTP stream. It includes the newlines sent as heartbeats.