Class UserService

Handles interacting with resources related to user account

Hierarchy (View Summary)

FetcherService
- UserService

Index

Constructors

constructor

new UserService(config: RettiwtConfig): UserService
Internal
Parameters
- config: RettiwtConfig
  The config object for configuring the Rettiwt instance.
Returns UserService
Overrides FetcherService.constructor
- Defined in src/services/public/UserService.ts:50

Properties

`Protected` `Readonly`config

config: RettiwtConfig

The config object.

Methods

affiliates

affiliates(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<User>>
Get the list affiliates of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no id is provided, the logged-in user's id is used.
- Optionalcount: number
  The number of affiliates to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of affiliates to fetch.
Returns Promise<CursoredData<User>>
The list of users affiliated to the target user.
Example
```
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 affiliates of the User with id '1234567890'
rettiwt.user.affiliates('1234567890')
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:81

analytics

analytics(
    fromTime?: Date,
    toTime?: Date,
    granularity?: RawAnalyticsGranularity,
    metrics?: RawAnalyticsMetric[],
    showVerifiedFollowers?: boolean,
): Promise<Analytics>
Get the analytics overview of the logged in user.
Parameters
- OptionalfromTime: Date
  The start time of the analytics period. Defaults to 7 days ago.
- OptionaltoTime: Date
  The end time of the analytics period. Defaults to now.
- Optionalgranularity: RawAnalyticsGranularity
  The granularity of the analytics data. Defaults to daily.
- Optionalmetrics: RawAnalyticsMetric[]
  The metrics to include in the analytics data. Defaults to all available metrics available.
- OptionalshowVerifiedFollowers: boolean
  Whether to include verified follower count and relationship counts in the response. Defaults to true.
Returns Promise<Analytics>
The raw analytics data of the user.
Example
```
import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });

// Fetching the analytics overview of the logged in user
rettiwt.user.analytics().then(res => {
 console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:125

bookmarkFolders

bookmarkFolders(cursor?: string): Promise<CursoredData<BookmarkFolder>>
Get the list of bookmark folders of the logged in user.
Parameters
- Optionalcursor: string
  The cursor to the batch of bookmark folders to fetch.
Returns Promise<CursoredData<BookmarkFolder>>
The list of bookmark folders.
Example
```
import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });

// Fetching all bookmark folders of the logged in user
rettiwt.user.bookmarkFolders()
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:223

bookmarkFolderTweets

bookmarkFolderTweets(
    folderId: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<Tweet>>
Get the list of tweets in a specific bookmark folder of the logged in user.
Parameters
- folderId: string
  The ID of the bookmark folder.
- Optionalcount: number
  The number of tweets to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of tweets to fetch.
Returns Promise<CursoredData<Tweet>>
The list of tweets in the bookmark folder.
Example
```
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 tweets from bookmark folder with ID '2001752149647049173'
rettiwt.user.bookmarkFolderTweets('2001752149647049173')
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:182

bookmarks

bookmarks(count?: number, cursor?: string): Promise<CursoredData<Tweet>>
Get the list of bookmarks of the logged in user.
Parameters
- Optionalcount: number
  The number of bookmakrs to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of bookmarks to fetch.
Returns Promise<CursoredData<Tweet>>
The list of tweets bookmarked by the target user.
Example
```
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.bookmarks()
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:263

details

details(): Promise<undefined | User>

Get the details of the logged in user.

Returns Promise<undefined | User>

The details of the user.

Example

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
rettiwt.user.details()
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});

details(id: string): Promise<undefined | User>

Get the details of a user.

Parameters

id: string
The ID/username of the target user.

Returns Promise<undefined | User>

The details of the user.

Example

Fetching the details of a single user 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' or '@user1'
rettiwt.user.details('user1') // or @user1
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});

Example

Fetching the details of a single user 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);	# 'res' is a single tweet
})
.catch(err => {
	console.log(err);
});

details(id: string[]): Promise<User[]>

Get the details of multiple users in bulk.

Parameters

id: string[]
The list of IDs of the target users.

Returns Promise<User[]>

The details of the users.

Example

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 users with IDs '123', '456', '789'
rettiwt.user.details(['123', '456', '789'])
.then(res => {
	console.log(res);	# 'res' is an array of users
})
.catch(err => {
	console.log(err);
});

follow

follow(id: string): Promise<boolean>

Follow a user.

Parameters

id: string
The ID the user to be followed.

Returns Promise<boolean>

Whether following was successful or not.

Throws

Code 108 if given user id is invalid.

Example

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

followed

followed(cursor?: string): Promise<CursoredData<Tweet>>
Get the followed feed of the logged in user.
Parameters
- Optionalcursor: string
  The cursor to the batch of feed items to fetch.
Returns Promise<CursoredData<Tweet>>
- The followed feed of the logged-in user.
Example
```
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);
});
```
Remarks
Always returns 35 feed items, with no way to customize the count.
- Defined in src/services/public/UserService.ts:487

followers

followers(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<User>>
Get the list followers of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of followers to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of followers to fetch.
Returns Promise<CursoredData<User>>
The list of users following the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:528

following

following(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<User>>
Get the list of users who are followed by a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of following to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of following to fetch.
Returns Promise<CursoredData<User>>
The list of users followed by the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:571

highlights

highlights(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<Tweet>>
Get the highlighted tweets of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of followers to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of followers to fetch.
Returns Promise<CursoredData<Tweet>>
The list of highlighted tweets of the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:614

likes

likes(count?: number, cursor?: string): Promise<CursoredData<Tweet>>
Get the list of tweets liked by the logged in user.
Parameters
- Optionalcount: number
  The number of likes to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of likes to fetch.
Returns Promise<CursoredData<Tweet>>
The list of tweets liked by the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:656

lists

lists(count?: number, cursor?: string): Promise<CursoredData<List>>
Get the list of of the the logged in user. Includes both followed and owned.
Parameters
- Optionalcount: number
  The number of lists to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of likes to fetch.
Returns Promise<CursoredData<List>>
The list of tweets liked by the target user.
Example
```
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 Lists of the logged in User
rettiwt.user.lists()
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
- Defined in src/services/public/UserService.ts:698

media

media(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<Tweet>>
Get the media timeline of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of media to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of media to fetch
Returns Promise<CursoredData<Tweet>>
The media timeline of the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:741

notifications

notifications(pollingInterval?: number): AsyncGenerator<Notification>

Stream notifications of the logged in user in pseudo real-time.

Parameters

pollingInterval: number = 60000
The interval in milliseconds to poll for new tweets. Default interval is 60000 ms.

Returns AsyncGenerator<Notification>

An async generator that yields new notifications as they are received.

Example

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(5000)) {
			console.log(notification.message);
		}
	}
	catch (err) {
		console.log(err);
	}
}

// Calling the function
streamNotifications();

recommended(cursor?: string): Promise<CursoredData<Tweet>>
Get the recommended feed of the logged in user.
Parameters
- Optionalcursor: string
  The cursor to the batch of feed items to fetch.
Returns Promise<CursoredData<Tweet>>
- The recommended feed of the logged-in user.
Example
```
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);
});
```
Remarks
Always returns 35 feed items, with no way to customize the count.
- Defined in src/services/public/UserService.ts:857

replies

replies(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<Tweet>>
Get the reply timeline of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of replies to fetch, must be <= 20.
- Optionalcursor: string
  The cursor to the batch of replies to fetch.
Returns Promise<CursoredData<Tweet>>
The reply timeline of the target user.
Example
```
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);
});
```
Remarks
If the target user has a pinned tweet, the returned reply timeline has one item extra and this is always the pinned tweet.
- Defined in src/services/public/UserService.ts:902

request

request<T = unknown>(
resource: ResourceType,
args: IFetchArgs | IPostArgs,
): Promise<T>
Makes an HTTP request according to the given parameters.
Type Parameters
- T = unknown
  The type of the returned response data.
Parameters
- resource: ResourceType
  The requested resource.
- args: IFetchArgs | IPostArgs
Returns Promise<T>
The raw data response received.
Example
Fetching the raw details of a single user, using their username
```
import { FetcherService, ResourceType } 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(ResourceType.USER_DETAILS_BY_USERNAME, { id: 'user1' })
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});
```
Inherited from FetcherService.request
- Defined in src/services/public/FetcherService.ts:282

subscriptions

subscriptions(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<User>>
Get the list of subscriptions of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of subscriptions to fetch, must be <= 100.
- Optionalcursor: string
  The cursor to the batch of subscriptions to fetch.
Returns Promise<CursoredData<User>>
The list of subscriptions by the target user.
Example
```
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);
});
```
- Defined in src/services/public/UserService.ts:945

timeline

timeline(
    id?: string,
    count?: number,
    cursor?: string,
): Promise<CursoredData<Tweet>>
Get the tweet timeline of a user.
Parameters
- Optionalid: string
  The ID of the target user. If no ID is provided, the logged-in user's ID is used.
- Optionalcount: number
  The number of timeline items to fetch, must be <= 20.
- Optionalcursor: string
  The cursor to the batch of timeline items to fetch.
Returns Promise<CursoredData<Tweet>>
The timeline of the target user.
Example
```
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);
});
```
Remarks
- If the target user has a pinned tweet, the returned timeline has one item extra and this is always the pinned tweet.
- If timeline is fetched without authenticating, then the most popular tweets of the target user are returned instead.
- Defined in src/services/public/UserService.ts:993

unfollow

unfollow(id: string): Promise<boolean>

Unfollow a user.

Parameters

id: string
The ID the user to be unfollowed.

Returns Promise<boolean>

Whether unfollowing was successful or not.

Example

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

updateProfile

updateProfile(options: IProfileUpdateOptions): Promise<boolean>

Update the logged in user's profile.

Parameters

options: IProfileUpdateOptions
The profile update options.

Returns Promise<boolean>

Whether the profile update was successful or not.

Example

Updating only the display name

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });

// Updating the display name of the logged in user
rettiwt.user.updateProfile({ name: 'New Display Name' })
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});

Example

Updating multiple profile fields

import { Rettiwt } from 'rettiwt-api';

// Creating a new Rettiwt instance using the given 'API_KEY'
const rettiwt = new Rettiwt({ apiKey: API_KEY });

// Updating multiple profile fields
rettiwt.user.updateProfile({
	name: 'New Display Name',
	location: 'Istanbul',
	description: 'Hello world!',
	url: 'https://example.com'
})
.then(res => {
	console.log(res);
})
.catch(err => {
	console.log(err);
});

Class UserService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserService

Properties

Protected Readonlyconfig

Methods

affiliates

Parameters

Returns Promise<CursoredData<User>>

Example

analytics

Parameters

Returns Promise<Analytics>

Example

bookmarkFolders

Parameters

Returns Promise<CursoredData<BookmarkFolder>>

Example

bookmarkFolderTweets

Parameters

Returns Promise<CursoredData<Tweet>>

Example

bookmarks

Parameters

Returns Promise<CursoredData<Tweet>>

Example

details

Returns Promise<undefined | User>

Example

Parameters

Returns Promise<undefined | User>

Example

Fetching the details of a single user using username

Example

Fetching the details of a single user using ID

Parameters

Returns Promise<User[]>

Example

follow

Parameters

Returns Promise<boolean>

Throws

Example

followed

Parameters

Returns Promise<CursoredData<Tweet>>

Example

Remarks

followers

Parameters

Returns Promise<CursoredData<User>>

Example

following

Parameters

Returns Promise<CursoredData<User>>

Example

highlights

Parameters

Returns Promise<CursoredData<Tweet>>

Example

likes

Parameters

Returns Promise<CursoredData<Tweet>>

Example

lists

Parameters

Returns Promise<CursoredData<List>>

Example

media

Parameters

Returns Promise<CursoredData<Tweet>>

Example

notifications

`Protected` `Readonly`config