1.0.1 • Published 6 years ago

tweeto v1.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
6 years ago

License: MIT Build Status

What is tweeto?

  • tweeto is a node.js module for accessing Twitter's REST APIs.
  • provide methods for application only authenticated endpoints.
  • tweeto uses native ES6 promises.

Installation

npm install --save tweeto

Usage

var Tweeto = require('tweeto').Tweeto;

var configObject = {
  consumer_key: your_consumer_key,
  consumer_secret: your_consumer_secret
};

var tweeto = new Tweeto(configObject);

// Example to fetch user timeline
tweeto.getUserTimetine({count: 5, screen_name: 'twitter'})
    .then(function(response) { console.log(response); })
    .catch(function(err) { console.log(err); });

Documentation

List of all supported endpoints of Twitter's REST API.

#NameDescriptionMore Info
1getUserTimetineReturns a collection of the most recent Tweets posted by the userview more
2getFavoriteListReturns the 20 most recent Tweets liked by the userview more
3getFollowersIdsReturns a cursored collection of user IDs for every user following the specified userview more
4getFollowersListReturns a cursored collection of user objects for users following the specified userview more
5getFriendsIdsReturns a cursored collection of user IDs for every user the specified user is following (otherwise known as their “friends”)view more
6getFriendsListReturns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”)view more
7getFriendshipsShowReturns detailed information about the relationship between two arbitrary usersview more
8getListsReturns all lists the specified user subscribes to, including their ownview more
9getListsMembersReturns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified listview more
10getListsMembersShowCheck if the specified user is a member of the specified listview more
11getListsMembershipsReturns the lists the specified user has been added toview more