Internal
Optional config: IRettiwtConfigThe config object for configuring the Rettiwt instance.
Protected Optional Readonly authThe URL to the proxy server to use only for authentication.
Protected Optional Readonly userThe id of the authenticated user (if any).
Get the details of a user.
The username/id of the target user.
The details of the given user.
If no user matches the given id, returns undefined.
Fetching the details using username
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the details of the User with username 'user1'
rettiwt.user.details('user1')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Fetching the details using id
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the details of the User with id '1234567890'
rettiwt.user.details('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Follow a user.
The id the user to be followed.
Whether following was successful or not.
Code 108 if given user id is invalid.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Following the User with id '1234567890'
rettiwt.user.follow('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the followed feed of the logged in user.
Optional cursor: stringThe cursor to the batch of feed items to fetch.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 35 followed feed items of the logged-in user
rettiwt.user.followed()
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Always returns 35 feed items, with no way to customize the count.
Get the list followers of a user.
The id of the target user.
Optional count: numberThe number of followers to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of followers to fetch.
The list of users following the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 100 followers of the User with id '1234567890'
rettiwt.user.followers('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the list of users who are followed by a user.
The id of the target user.
Optional count: numberThe number of following to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of following to fetch.
The list of users followed by the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 100 following of the User with id '1234567890'
rettiwt.user.following('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the highlighted tweets of a user.
The id of the target user.
Optional count: numberThe number of followers to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of followers to fetch.
The list of highlighted tweets of the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the top 100 highlights of the User with id '1234567890'
rettiwt.user.highlights('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the list of tweets liked by the logged in user.
Optional count: numberThe number of likes to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of likes to fetch.
The list of tweets liked by the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the most recent 100 liked Tweets of the logged in User
rettiwt.user.likes()
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the media timeline of a user.
The id of the target user.
Optional count: numberThe number of media to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of media to fetch
The media timeline of the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 100 timeline media tweets of the User with id '1234567890'
rettiwt.user.timeline('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Stream notifications of the logged in user in pseudo real-time.
The interval in milliseconds to poll for new tweets. Default interval is 60000 ms.
An async generator that yields new notifications as they are received.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Creating a function that streams all new notifications
async function streamNotifications() {
try {
// Awaiting for the notifications returned by the AsyncGenerator returned by the method
for await (const notification of rettiwt.user.notifications(1000)) {
console.log(notification.message);
}
}
catch (err) {
console.log(err);
}
}
// Calling the function
streamNotifications();
Get the recommended feed of the logged in user.
Optional cursor: stringThe cursor to the batch of feed items to fetch.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 35 recommended feed items of the logged-in user
rettiwt.user.recommended()
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Always returns 35 feed items, with no way to customize the count.
Get the reply timeline of a user.
The id of the target user.
Optional count: numberThe number of replies to fetch, must be <= 20.
Optional cursor: stringThe cursor to the batch of replies to fetch.
The reply timeline of the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 100 timeline replies of the User with id '1234567890'
rettiwt.user.replies('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
Makes an HTTP request according to the given parameters.
The type of the returned response data.
The requested resource.
The raw data response received.
Fetching the raw details of a user with username 'user1'
import { FetcherService, EResourceType } from 'rettiwt-api';
// Creating a new FetcherService instance using the given 'API_KEY'
const fetcher = new FetcherService({ apiKey: API_KEY });
// Fetching the details of the User with username 'user1'
fetcher.request(EResourceType.USER_DETAILS_BY_USERNAME, { id: 'user1' })
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
})
Get the list of subscriptions of a user.
The id of the target user.
Optional count: numberThe number of subscriptions to fetch, must be <= 100.
Optional cursor: stringThe cursor to the batch of subscriptions to fetch.
The list of subscriptions by the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 100 subscriptions of the User with id '1234567890'
rettiwt.user.subscriptions('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Get the tweet timeline of a user.
The id of the target user.
Optional count: numberThe number of timeline items to fetch, must be <= 20.
Optional cursor: stringThe cursor to the batch of timeline items to fetch.
The timeline of the target user.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Fetching the first 20 timeline tweets of the User with id '1234567890'
rettiwt.user.timeline('1234567890')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Unfollow a user.
The id the user to be unfollowed.
Whether unfollowing was successful or not.
Code 34 if given user id is invalid.
import { Rettiwt } from 'rettiwt-api';
// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });
// Unfollowing the User with id '12345678'
rettiwt.user.unfollow('12345678')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
Generated using TypeDoc
Handles interacting with resources related to user account