Merge pull request #824 from Rishikant181/dev

Rishikant181 · web-flow · commit c10e85335c8f · 2026-01-07T19:39:08.000+05:30
6.2.0
diff --git a/README.md b/README.md
@@ -72,6 +72,7 @@ Rettiwt-API can be used with or without logging in to Twitter. As such, the two
     - User Subscriptions
     - User Timeline
     - User Unfollow
+    - User Profile Update
 
 By default, Rettiwt-API uses 'guest' authentication. If however, access to the full set of resources is required, 'user' authentication can be used. This is done by using the cookies associated with your Twitter/X account, and encoding them into an `API_KEY` for convenience. The said `API_KEY` can be obtained by using a browser extension, as follows:
 
@@ -498,6 +499,7 @@ So far, the following operations are supported:
 - [Getting the replies timeline of the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#replies)
 - [Getting the tweet timeline of the given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#timeline)
 - [Unfollowing a given user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#unfollow)
+- [Updating the profile of the logged-in user](https://rishikant181.github.io/Rettiwt-API/classes/UserService.html#updateProfile)
 
 ## CLI Usage
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "rettiwt-api",
-	"version": "6.1.7",
+	"version": "6.2.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "An API for fetching data from TwitterAPI, without any rate limits!",
diff --git a/src/collections/Extractors.ts b/src/collections/Extractors.ts
@@ -46,6 +46,7 @@ import { IUserLikesResponse } from '../types/raw/user/Likes';
 import { IUserListsResponse } from '../types/raw/user/Lists';
 import { IUserMediaResponse } from '../types/raw/user/Media';
 import { IUserNotificationsResponse } from '../types/raw/user/Notifications';
+import { IUserProfileUpdateResponse } from '../types/raw/user/ProfileUpdate';
 import { IUserRecommendedResponse } from '../types/raw/user/Recommended';
 import { IUserSubscriptionsResponse } from '../types/raw/user/Subscriptions';
 import { IUserTweetsResponse } from '../types/raw/user/Tweets';
@@ -139,6 +140,7 @@ export const Extractors = {
 	USER_TIMELINE_AND_REPLIES: (response: IUserTweetsAndRepliesResponse): CursoredData<Tweet> =>
 		new CursoredData<Tweet>(response, BaseType.TWEET),
 	USER_UNFOLLOW: (response: IUserUnfollowResponse): boolean => (response?.id ? true : false),
+	USER_PROFILE_UPDATE: (response: IUserProfileUpdateResponse): boolean => (response?.name ? true : false),
 
 	/* eslint-enable @typescript-eslint/naming-convention */
 };
diff --git a/src/collections/Groups.ts b/src/collections/Groups.ts
@@ -74,4 +74,5 @@ export const PostResourcesGroup = [
 	ResourceType.TWEET_UNSCHEDULE,
 	ResourceType.USER_FOLLOW,
 	ResourceType.USER_UNFOLLOW,
+	ResourceType.USER_PROFILE_UPDATE,
 ];
diff --git a/src/collections/Requests.ts b/src/collections/Requests.ts
@@ -80,6 +80,7 @@ export const Requests: { [key in keyof typeof ResourceType]: (args: IFetchArgs |
 	USER_TIMELINE: (args: IFetchArgs) => UserRequests.tweets(args.id!, args.count, args.cursor),
 	USER_TIMELINE_AND_REPLIES: (args: IFetchArgs) => UserRequests.tweetsAndReplies(args.id!, args.count, args.cursor),
 	USER_UNFOLLOW: (args: IPostArgs) => UserRequests.unfollow(args.id!),
+	USER_PROFILE_UPDATE: (args: IPostArgs) => UserRequests.updateProfile(args.profileOptions!),
 
 	/* eslint-enable @typescript-eslint/naming-convention */
 };
diff --git a/src/commands/User.ts b/src/commands/User.ts
@@ -274,6 +274,27 @@ function createUserCommand(rettiwt: Rettiwt): Command {
 			}
 		});
 
+	// Update Profile
+	user.command('update-profile')
+		.description('Update your profile information')
+		.option('-n, --name <string>', 'Display name (max 50 characters)')
+		.option('-u, --url <string>', 'Profile URL')
+		.option('-l, --location <string>', 'Location (max 30 characters)')
+		.option('-d, --description <string>', 'Description/bio (max 160 characters)')
+		.action(async (options?: UserProfileUpdateOptions) => {
+			try {
+				const result = await rettiwt.user.updateProfile({
+					name: options?.name,
+					url: options?.url,
+					location: options?.location,
+					description: options?.description,
+				});
+				output(result);
+			} catch (error) {
+				output(error);
+			}
+		});
+
 	return user;
 }
 
@@ -288,4 +309,14 @@ type UserAnalyticsOptions = {
 	verifiedFollowers?: boolean;
 };
 
+/**
+ * The options for updating user profile.
+ */
+type UserProfileUpdateOptions = {
+	name?: string;
+	url?: string;
+	location?: string;
+	description?: string;
+};
+
 export default createUserCommand;
diff --git a/src/enums/Resource.ts b/src/enums/Resource.ts
@@ -62,4 +62,5 @@ export enum ResourceType {
 	USER_TIMELINE = 'USER_TIMELINE',
 	USER_TIMELINE_AND_REPLIES = 'USER_TIMELINE_AND_REPLIES',
 	USER_UNFOLLOW = 'USER_UNFOLLOW',
+	USER_PROFILE_UPDATE = 'USER_PROFILE_UPDATE',
 }
diff --git a/src/index.ts b/src/index.ts
@@ -18,6 +18,7 @@ export * from './enums/Tweet';
 // MODELS
 export * from './models/args/FetchArgs';
 export * from './models/args/PostArgs';
+export * from './models/args/ProfileArgs';
 export * from './models/data/Conversation';
 export * from './models/data/CursoredData';
 export * from './models/data/DirectMessage';
@@ -45,6 +46,7 @@ export * from './services/public/UserService';
 // TYPES
 export * from './types/args/FetchArgs';
 export * from './types/args/PostArgs';
+export * from './types/args/ProfileArgs';
 export * from './types/data/Conversation';
 export * from './types/data/CursoredData';
 export * from './types/data/DirectMessage';
@@ -111,6 +113,7 @@ export { IUserSubscriptionsResponse as IRawUserSubscriptionsResponse } from './t
 export { IUserTweetsResponse as IRawUserTweetsResponse } from './types/raw/user/Tweets';
 export { IUserTweetsAndRepliesResponse as IRawUserTweetsAndRepliesResponse } from './types/raw/user/TweetsAndReplies';
 export { IUserUnfollowResponse as IRawUserUnfollowResponse } from './types/raw/user/Unfollow';
+export { IUserProfileUpdateResponse as IRawUserProfileUpdateResponse } from './types/raw/user/ProfileUpdate';
 export * from './types/ErrorHandler';
 export * from './types/RettiwtConfig';
 export { IConversationTimelineResponse as IRawConversationTimelineResponse } from './types/raw/dm/Conversation';
diff --git a/src/models/args/PostArgs.ts b/src/models/args/PostArgs.ts
@@ -1,12 +1,16 @@
 import { INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
 
+import { ProfileUpdateOptions } from './ProfileArgs';
+
 /**
  * Options specifying the data that is to be posted.
  *
  * @public
  */
 export class PostArgs implements IPostArgs {
+	public conversationId?: string;
 	public id?: string;
+	public profileOptions?: ProfileUpdateOptions;
 	public tweet?: NewTweet;
 	public upload?: UploadArgs;
 	public userId?: string;
@@ -20,6 +24,8 @@ export class PostArgs implements IPostArgs {
 		this.tweet = args.tweet ? new NewTweet(args.tweet) : undefined;
 		this.upload = args.upload ? new UploadArgs(args.upload) : undefined;
 		this.userId = args.userId;
+		this.conversationId = args.conversationId;
+		this.profileOptions = args.profileOptions ? new ProfileUpdateOptions(args.profileOptions) : undefined;
 	}
 }
 
diff --git a/src/models/args/ProfileArgs.ts b/src/models/args/ProfileArgs.ts
@@ -0,0 +1,68 @@
+import { IProfileUpdateOptions } from '../../types/args/ProfileArgs';
+
+/**
+ * Configuration for profile update.
+ *
+ * @public
+ */
+export class ProfileUpdateOptions implements IProfileUpdateOptions {
+	public description?: string;
+	public location?: string;
+	public name?: string;
+	public url?: string;
+
+	/**
+	 * @param options - The options specifying the profile fields to update.
+	 */
+	public constructor(options: IProfileUpdateOptions) {
+		this.description = options.description;
+		this.location = options.location;
+		this.name = options.name;
+		this.url = options.url;
+
+		// At least one field must be provided
+		if (
+			this.name === undefined &&
+			this.url === undefined &&
+			this.location === undefined &&
+			this.description === undefined
+		) {
+			throw new Error('At least one profile field must be provided');
+		}
+
+		// Name validation
+		if (this.name !== undefined) {
+			if (this.name.trim().length === 0) {
+				throw new Error('Name cannot be empty');
+			}
+			if (this.name.length > 50) {
+				throw new Error('Name cannot exceed 50 characters');
+			}
+		}
+
+		// URL validation (minimal - just check if not empty when provided)
+		if (this.url !== undefined && this.url.trim().length === 0) {
+			throw new Error('URL cannot be empty');
+		}
+
+		// Location validation
+		if (this.location !== undefined) {
+			if (this.location.trim().length === 0) {
+				throw new Error('Location cannot be empty');
+			}
+			if (this.location.length > 30) {
+				throw new Error('Location cannot exceed 30 characters');
+			}
+		}
+
+		// Description validation
+		if (this.description !== undefined) {
+			if (this.description.trim().length === 0) {
+				throw new Error('Description cannot be empty');
+			}
+			if (this.description.length > 160) {
+				throw new Error('Description cannot exceed 160 characters');
+			}
+		}
+	}
+}
diff --git a/src/models/data/Tweet.ts b/src/models/data/Tweet.ts
@@ -272,7 +272,7 @@ export class Tweet implements ITweet {
  *
  * @public
  */
-export class TweetEntities {
+export class TweetEntities implements ITweetEntities {
 	/** The list of hashtags mentioned in the tweet. */
 	public hashtags: string[] = [];
 
@@ -325,7 +325,10 @@ export class TweetEntities {
  *
  * @public
  */
-export class TweetMedia {
+export class TweetMedia implements ITweetMedia {
+	/** The ID of the media. */
+	public id: string;
+
 	/** The thumbnail URL for the video content of the tweet. */
 	public thumbnailUrl?: string;
 
@@ -339,6 +342,8 @@ export class TweetMedia {
 	 * @param media - The raw media details.
 	 */
 	public constructor(media: IRawExtendedMedia) {
+		this.id = media.id_str;
+
 		// If the media is a photo
 		if (media.type == RawMediaType.PHOTO) {
 			this.type = MediaType.PHOTO;
@@ -374,6 +379,7 @@ export class TweetMedia {
 	 */
 	public toJSON(): ITweetMedia {
 		return {
+			id: this.id,
 			thumbnailUrl: this.thumbnailUrl,
 			type: this.type,
 			url: this.url,
diff --git a/src/requests/User.ts b/src/requests/User.ts
@@ -3,6 +3,7 @@ import qs from 'querystring';
 import { AxiosRequestConfig } from 'axios';
 
 import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../enums/raw/Analytics';
+import { IProfileUpdateOptions } from '../types/args/ProfileArgs';
 
 /**
  * Collection of requests related to users.
@@ -1014,4 +1015,20 @@ export class UserRequests {
 			}),
 		};
 	}
+
+	/**
+	 * @param options - The profile update options.
+	 */
+	public static updateProfile(options: IProfileUpdateOptions): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/1.1/account/update_profile.json',
+			data: qs.stringify({
+				...(options.name && { name: options.name }),
+				...(options.url && { url: options.url }),
+				...(options.location && { location: options.location }),
+				...(options.description && { description: options.description }),
+			}),
+		};
+	}
 }
diff --git a/src/services/public/UserService.ts b/src/services/public/UserService.ts
@@ -1,13 +1,15 @@
 import { Extractors } from '../../collections/Extractors';
 import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
 import { ResourceType } from '../../enums/Resource';
+import { ProfileUpdateOptions } from '../../models/args/ProfileArgs';
 import { Analytics } from '../../models/data/Analytics';
 import { CursoredData } from '../../models/data/CursoredData';
 import { List } from '../../models/data/List';
 import { Notification } from '../../models/data/Notification';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
 import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { IProfileUpdateOptions } from '../../types/args/ProfileArgs';
 import { IUserAffiliatesResponse } from '../../types/raw/user/Affiliates';
 import { IUserAnalyticsResponse } from '../../types/raw/user/Analytics';
 import { IUserBookmarksResponse } from '../../types/raw/user/Bookmarks';
@@ -22,6 +24,7 @@ import { IUserLikesResponse } from '../../types/raw/user/Likes';
 import { IUserListsResponse } from '../../types/raw/user/Lists';
 import { IUserMediaResponse } from '../../types/raw/user/Media';
 import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
+import { IUserProfileUpdateResponse } from '../../types/raw/user/ProfileUpdate';
 import { IUserRecommendedResponse } from '../../types/raw/user/Recommended';
 import { IUserSubscriptionsResponse } from '../../types/raw/user/Subscriptions';
 import { IUserTweetsResponse } from '../../types/raw/user/Tweets';
@@ -954,4 +957,69 @@ export class UserService extends FetcherService {
 
 		return data;
 	}
+
+	/**
+	 * Update the logged in user's profile.
+	 *
+	 * @param options - The profile update options.
+	 *
+	 * @returns Whether the profile update was successful or not.
+	 *
+	 * @example
+	 *
+	 * #### Updating only the display name
+	 * ```ts
+	 * 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
+	 * ```ts
+	 * 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);
+	 * });
+	 * ```
+	 */
+	public async updateProfile(options: IProfileUpdateOptions): Promise<boolean> {
+		const resource = ResourceType.USER_PROFILE_UPDATE;
+
+		// Validating the options
+		const validatedOptions = new ProfileUpdateOptions(options);
+
+		// Updating the profile
+		const response = await this.request<IUserProfileUpdateResponse>(resource, { profileOptions: validatedOptions });
+
+		// Deserializing the response
+		const data = Extractors[resource](response) ?? false;
+
+		return data;
+	}
 }
diff --git a/src/types/args/PostArgs.ts b/src/types/args/PostArgs.ts
diff --git a/src/types/args/ProfileArgs.ts b/src/types/args/ProfileArgs.ts
diff --git a/src/types/data/Tweet.ts b/src/types/data/Tweet.ts
diff --git a/src/types/raw/user/ProfileUpdate.ts b/src/types/raw/user/ProfileUpdate.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "rettiwt-api",`
`3`		`- "version": "6.1.7",`
	`3`	`+ "version": "6.2.0",`
`4`	`4`	`"main": "dist/index.js",`
`5`	`5`	`"types": "dist/index.d.ts",`
`6`	`6`	`"description": "An API for fetching data from TwitterAPI, without any rate limits!",`
Original file line number	Diff line number	Diff line change
`@@ -62,4 +62,5 @@ export enum ResourceType {`
`62`	`62`	`USER_TIMELINE = 'USER_TIMELINE',`
`63`	`63`	`USER_TIMELINE_AND_REPLIES = 'USER_TIMELINE_AND_REPLIES',`
`64`	`64`	`USER_UNFOLLOW = 'USER_UNFOLLOW',`
	`65`	`+ USER_PROFILE_UPDATE = 'USER_PROFILE_UPDATE',`
`65`	`66`	`}`