Client interface for accessing Twitter REST API.
Create a client object to connect to Twitter API endpoints.
var twitterWrapi = require('twitter-wrapi');
var client = new twitterWrapi({
consumer_key: 'YOUR_CONSUMER_KEY', // Consumer Key (API Key)
consumer_secret: 'TWITTER_CONSUMER_SECRET', // Consumer Secret (API Secret)
token: 'TWITTER_ACCESS_TOKEN_KEY', // Access Token
token_secret: 'TWITTER_ACCESS_TOKEN_SECRET' // Access Token Secret
});
// Now you are ready to make API calls to twitter.
Provide parameters and a callback.
API calls follow this syntax:
client.apigroup.action(param1, ..., queryString, callback);
param
- (if required) url parameters - eg: For statuses.show the value for:id
.queryString
- (as required) API endpoint parameters as key-value pairs.
client.users.suggestions.get(function(err, data) {
if (!err) {
console.log(data);
}
});
client.statuses.show(23, function(err, data) {
if (!err) {
console.log(data);
}
});
client.users.show({screen_name: "jack"}, function(err, data) {
if (!err) {
console.log(data);
}
});
client.friends.list({
cursor:-1,
screen_name:"twitterapi",
skip_status:true,
include_user_entities:false
},
function(err, data) {
if (!err) {
console.log(data);
}
}
);
client.search.tweets({
q: "#freebandnames",
since_id: "24012619984051000",
max_id: "250126199840518145",
result_type: "mixed",
count:4
},
function(err, data) {
if (!err) {
console.log(data);
}
}
);
This is a POST method call that expects a body
content. Pass null
, if body is not required.
client.saved_searches.create({query: "sandwiches"}, null, function(err, data) {
if (!err) {
console.log(data);
}
});
- statuses.mentions_timeline
- statuses.user_timeline
- statuses.home_timeline
- statuses.retweets_of_me
- statuses.retweets
- statuses.show
- statuses.destroy
- statuses.update
- statuses.retweet
- statuses.update_with_media
- statuses.oembed
- statuses.retweeters.ids
- statuses.lookup
- direct_messages.get
- direct_messages.sent
- direct_messages.show
- direct_messages.destroy
- direct_messages.new
- friendships.no_retweets
- friendships.incoming
- friendships.outgoing
- friendships.create
- friendships.update
- friendships.show
- friendships.lookup
- account.account
- account.verify_credentials
- account.settings
- account.update_delivery_device
- account.update_profile
- account.update_profile_background_image
- account.update_profile_image
- lists.list
- lists.statuses
- lists.memberships
- lists.destroy
- lists.update
- lists.create
- lists.show
- lists.subscriptions
- lists.ownerships