Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    twitter-1.1public

    Twitter API client library for node.js

    node-twitter aims to provide a complete, asynchronous client library for the Twitter API, including the REST, search and streaming endpoints. 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 util = require('util'),
    	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) {
    	console.log(util.inspect(data));
    });
    

    REST API (unstable, may change)

    Note that all functions may be chained:

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

    Search API (unstable, may change)

    twit.search('nodejs OR #node', function(data) {
    	console.log(util.inspect(data));
    });
    

    Streaming API (stable)

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

    twit.stream('statuses/sample', function(stream) {
    	stream.on('data', function(data) {
    		console.log(util.inspect(data));
    	});
    });
    

    node-twitter also supports user and site streams:

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

    Contributors

    TODO

    • Complete the convenience functions, preferably generated
    • Fix ALL THE THINGS! on the GitHub issues list

    Keywords

    none

    install

    npm i twitter-1.1

    Downloadsweekly downloads

    15

    version

    0.1.18

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar