Twitter REST API Wrapper 🐦

Client interface for accessing Twitter REST API.

Usage

Create a client object to connect to Twitter API endpoints.

vartwitterWrapi=require('twitter-wrapi');varclient=newtwitterWrapi({consumer_key: 'YOUR_CONSUMER_KEY',// Consumer Key (API Key)consumer_secret: 'TWITTER_CONSUMER_SECRET',// Consumer Secret (API Secret)token: 'TWITTER_ACCESS_TOKEN_KEY',// Access Tokentoken_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.

Examples

List Twitter suggested user categories

client.users.suggestions.get(function(err,data){if(!err){console.log(data);}});

Fetch Single Tweet

client.statuses.show(23,function(err,data){if(!err){console.log(data);}});

Get User Profile

client.users.show({screen_name: "jack"},function(err,data){if(!err){console.log(data);}});

Friends List

client.friends.list({cursor:-1,screen_name:"twitterapi",skip_status:true,include_user_entities:false},function(err,data){if(!err){console.log(data);}});

Search

client.search.tweets({q: "#freebandnames",since_id: "24012619984051000",max_id: "250126199840518145",result_type: "mixed",count:4},function(err,data){if(!err){console.log(data);}});

Create a saved search

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);}});

API Functions

Statuses

• 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

Media

• media.upload
• media.upload_chunked

Direct_messages

• direct_messages.get
• direct_messages.sent
• direct_messages.show
• direct_messages.destroy
• direct_messages.new

Search

• search.tweets

Friendships

• friendships.no_retweets
• friendships.incoming
• friendships.outgoing
• friendships.create
• friendships.update
• friendships.show
• friendships.lookup

Friends

• friends.ids
• friends.list

Followers

• followers.ids
• followers.list

Account

• account.account
• account.verify_credentials
• account.settings
• account.update_delivery_device
• account.update_profile
• account.update_profile_background_image
• account.update_profile_image

Blocks

• blocks.list
• blocks.ids
• blocks.create
• blocks.destroy

Users

• users.lookup
• users.show
• users.search
• users.profile_banner
• users.report_spam

Suggestions

• users.suggestions.get
• users.suggestions.slug
• users.suggestions.members

Favorites

• favorites.list
• favorites.create
• favorites.destroy

Lists

• lists.list
• lists.statuses
• lists.memberships
• lists.destroy
• lists.update
• lists.create
• lists.show
• lists.subscriptions
• lists.ownerships

Members

• lists.members.get
• lists.members.destroy
• lists.members.create_all
• lists.members.show
• lists.members.create
• lists.members.destroy_all

Subscribers

• lists.subscribers.get
• lists.subscribers.create
• lists.subscribers.show
• lists.subscribers.destroy

Saved_searches

• saved_searches.list
• saved_searches.show
• saved_searches.create
• saved_searches.destroy

Geo

• geo.id
• geo.reverse_geocode
• geo.search
• geo.place

Trends

• trends.place
• trends.available
• trends.closest

Application

• application.rate_limit_status

Help

• help.configuration
• help.languages
• help.privacy
• help.tos

License

MIT