Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Asynchronous Twitter REST/stream/search client API for node.js
JavaScript

This branch is 16 commits behind jdub:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
LICENSE
README.md
index.js
package.json

README.md

Asynchronous Twitter client API for node.js

node-twitter aims to provide a complete, asynchronous client library for Twitter (and other compliant endpoints), including REST, stream and search APIs. It was inspired by, and uses some code from, technoweenie's twitter-node.

Requirements

You can install node-twitter and its dependencies with npm: npm install twitter.

Getting started

It's early days for node-twitter, so I'm going to assume a fair amount of knowledge for the moment. Better documentation to come as we head towards a stable release.

Setup API (stable)

var sys = require('sys'),
    twitter = require('twitter');
var twit = new twitter({
    consumer_key: 'STATE YOUR NAME',
    consumer_secret: 'STATE YOUR NAME',
    access_token_key: 'STATE YOUR NAME',
    access_token_secret: 'STATE YOUR NAME'
});

Basic OAuth-enticated GET/POST API (stable)

The convenience APIs aren't finished, but you can get started with the basics:

twit.get('/statuses/show/27593302936.json', {include_entities:true}, function(data) {
    sys.puts(sys.inspect(data));
});

REST API (unstable, may change)

Note that all functions may be chained:

twit
    .verifyCredentials(function (data) {
        sys.puts(sys.inspect(data));
    })
    .updateStatus('Test tweet from node-twitter/' + twitter.VERSION,
        function (data) {
            sys.puts(sys.inspect(data));
        }
    );

Search API (unstable, may change)

twit.search('nodejs OR #node', function(data) {
    sys.puts(sys.inspect(data));
});

Streaming API (stable)

The stream() callback receives a Stream-like EventEmitter:

twit.stream('statuses/sample', function(stream) {
    stream.on('data', function (data) {
        sys.puts(sys.inspect(data));
    });
});

node-twitter also supports user and site streams:

twit.stream('user', {track:'nodejs'}, function(stream) {
    stream.on('data', function (data) {
        sys.puts(sys.inspect(data));
    });
    // Disconnect stream after five seconds
    setTimeout(stream.destroy, 5000);
});

Contributors

TODO

  • Complete the convenience functions, preferably generated
  • Support recommended reconnection behaviour for the streaming APIs
  • Should probably implement basic auth for non-Twitter endpoints
Something went wrong with that request. Please try again.