Wondering what’s next for npm?Check out our public roadmap! »

    twitter-wrapi

    0.1.1 • Public • Published

    Twitter REST API Wrapper 🐦

    Client interface for accessing Twitter REST API.

    Usage

    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.

    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

    Media

    Direct_messages

    Search

    Friendships

    Friends

    Followers

    Account

    Blocks

    Users

    Suggestions

    Favorites

    Lists

    Members

    Subscribers

    Saved_searches

    Geo

    Trends

    Application

    Help

    License

    MIT

    Install

    npm i twitter-wrapi

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • avatar