@youmind-openlab/rettiwt-api 1.0.0 → 1.0.2

package/src/requests/User.ts

@@ -11,6 +11,20 @@ import { IProfileUpdateOptions } from '../types/args/ProfileArgs';
  * @public
  */
 export class UserRequests {
+	/**
+	 * @param userName - The username of the user whose about profile is to be fetched.
+	 */
+	public static aboutByUsername(userName: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/zs_jFPFT78rBpXv9Z3U2YQ/AboutAccountQuery',
+			params: {
+				variables: JSON.stringify({ screenName: userName }),
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+
 	/**
 	 * @param id - The id of the user whose affiliates are to be fetched.
 	 * @param count - The number of affiliates to fetch. Only works as a lower limit when used with a cursor.
@@ -231,6 +245,7 @@ export class UserRequests {
 	public static bookmarks(count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
+			// TODO: Bookmarks listing removed from Twitter bundle 2026-02-13
 			url: 'https://x.com/i/api/graphql/-LGfdImKeQz0xS_jjUwzlA/Bookmarks',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
@@ -317,7 +332,7 @@ export class UserRequests {
 	public static detailsById(id: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/Bbaot8ySMtJD7K2t01gW7A/UserByRestId',
+			url: 'https://x.com/i/api/graphql/pBP53RhZiQHExruxf-I8ig/UserByRestId',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({ userId: id, withSafetyModeUserFields: true }),
@@ -346,7 +361,7 @@ export class UserRequests {
 	public static detailsByUsername(userName: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/-oaLodhGbbnzJBACb1kk2Q/UserByScreenName',
+			url: 'https://x.com/i/api/graphql/AWbeRIdkLtqTRN7yL_H8yw/UserByScreenName',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({ screen_name: userName, withGrokTranslatedBio: false }),
@@ -394,7 +409,7 @@ export class UserRequests {
 	public static followed(count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/_qO7FJzShSKYWi9gtboE6A/HomeLatestTimeline',
+			url: 'https://x.com/i/api/graphql/7LL9B2gjCKU7swZw3aKF7g/HomeLatestTimeline',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -454,7 +469,7 @@ export class UserRequests {
 	public static followers(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/kuFUYP9eV1FPoEy4N-pi7w/Followers',
+			url: 'https://x.com/i/api/graphql/efNzdTpE-mkUcLARCd3RPQ/Followers',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -514,7 +529,7 @@ export class UserRequests {
 	public static following(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/C1qZ6bs-L3oc_TKSZyxkXQ/Following',
+			url: 'https://x.com/i/api/graphql/M3LO-sJg6BCWdEliN_C2fQ/Following',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -570,7 +585,7 @@ export class UserRequests {
 	public static highlights(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/kzKWdUA6Y1LCqlvaVILZwQ/UserHighlightsTweets',
+			url: 'https://x.com/i/api/graphql/dZc2IL7haTg9IbZ-vDV3xw/UserHighlightsTweets',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -631,7 +646,7 @@ export class UserRequests {
 	public static likes(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/JR2gceKucIKcVNB_9JkhsA/Likes',
+			url: 'https://x.com/i/api/graphql/JPxbOQGc_tXQ0Y29mvHKSw/Likes',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -695,7 +710,7 @@ export class UserRequests {
 	public static lists(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/9mQl9vR31wjodBP9b7_wyQ/ListsManagementPageTimeline',
+			url: 'https://x.com/i/api/graphql/FHavhcMS-6NrywtPkWiOHg/ListsManagementPageTimeline',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({ count: 100, cursor: cursor }),
@@ -750,7 +765,7 @@ export class UserRequests {
 	public static media(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/MMnr49cP_nldzCTfeVDRtA/UserMedia',
+			url: 'https://x.com/i/api/graphql/SJpoWbz8n_i3vN3sOPfXvw/UserMedia',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -869,7 +884,7 @@ export class UserRequests {
 	public static recommended(count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/V7xdnRnvW6a8vIsMr9xK7A/HomeTimeline',
+			url: 'https://x.com/i/api/graphql/y_gEr8-rsIu-XEOVAkh00A/HomeTimeline',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -941,7 +956,7 @@ export class UserRequests {
 	public static search(userName: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/M1jEez78PEfVfbQLvlWMvQ/SearchTimeline',
+			url: 'https://x.com/i/api/graphql/cGK-Qeg1XJc2sZ6kgQw_Iw/SearchTimeline',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -1002,7 +1017,7 @@ export class UserRequests {
 	public static subscriptions(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/fl06vhYypYRcRxgLKO011Q/UserCreatorSubscriptions',
+			url: 'https://x.com/i/api/graphql/5nn_EKhv4toQ_rhMjjwGoA/UserCreatorSubscriptions',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -1061,7 +1076,7 @@ export class UserRequests {
 	public static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/-V26I6Pb5xDZ3C7BWwCQ_Q/UserTweets',
+			url: 'https://x.com/i/api/graphql/eApPT8jppbYXlweF_ByTyA/UserTweets',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -1124,7 +1139,7 @@ export class UserRequests {
 	public static tweetsAndReplies(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/61HQnvcGP870hiE-hCbG4A/UserTweetsAndReplies',
+			url: 'https://x.com/i/api/graphql/aDl2OEiH_EFH10mA_ewZ9A/UserTweetsAndReplies',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({

package/src/services/public/SpaceService.ts

@@ -0,0 +1,65 @@
+import { Extractors } from '../../collections/Extractors';
+import { ResourceType } from '../../enums/Resource';
+import { Space } from '../../models/data/Space';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { ISpaceDetailsOptions } from '../../types/args/FetchArgs';
+import { IAudioSpaceByIdResponse } from '../../types/raw/space/AudioSpaceById';
+
+import { FetcherService } from './FetcherService';
+
+/**
+ * Handles interacting with resources related to spaces.
+ *
+ * @public
+ */
+export class SpaceService extends FetcherService {
+	/**
+	 * @param config - The config object for configuring the Rettiwt instance.
+	 *
+	 * @internal
+	 */
+	public constructor(config: RettiwtConfig) {
+		super(config);
+	}
+
+	/**
+	 * Get the details of a space.
+	 *
+	 * @param id - The ID of the target space.
+	 * @param options - Additional options for the fetch.
+	 *
+	 * @returns The details of the space with the given ID.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * rettiwt.space.details('1YqJDNEzvoVKV', { withListeners: true })
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async details(id: string, options?: ISpaceDetailsOptions): Promise<Space | undefined> {
+		const resource = ResourceType.SPACE_DETAILS;
+
+		// Fetching raw space details
+		const response = await this.request<IAudioSpaceByIdResponse>(resource, {
+			id: id,
+			withReplays: options?.withReplays,
+			withListeners: options?.withListeners,
+			isMetatagsQuery: options?.isMetatagsQuery,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+}

package/src/services/public/UserService.ts

@@ -9,8 +9,10 @@ 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 { UserAbout } from '../../models/data/UserAbout';
 import { RettiwtConfig } from '../../models/RettiwtConfig';
 import { IProfileUpdateOptions } from '../../types/args/ProfileArgs';
+import { IUserAboutResponse } from '../../types/raw/user/About';
 import { IUserAffiliatesResponse } from '../../types/raw/user/Affiliates';
 import { IUserAnalyticsResponse } from '../../types/raw/user/Analytics';
 import { IUserBookmarkFoldersResponse } from '../../types/raw/user/BookmarkFolders';
@@ -52,6 +54,47 @@ export class UserService extends FetcherService {
 		super(config);
 	}
 
+	/**
+	 * Get the about profile of a user.
+	 *
+	 * @param userName - The username/screenname of the target user.
+	 *
+	 * @returns The about profile of the user.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Fetching the about profile of the User with username 'user1' or '@user1'
+	 * rettiwt.user.about('user1') // or @user1
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async about(userName: string): Promise<UserAbout | undefined> {
+		const resource = ResourceType.USER_ABOUT_BY_USERNAME;
+
+		if (userName.startsWith('@')) {
+			userName = userName.slice(1);
+		}
+
+		// Fetching raw about profile
+		const response = await this.request<IUserAboutResponse>(resource, { id: userName });
+
+		// Deserializing response
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Get the list affiliates of a user.
 	 *

package/src/types/args/FetchArgs.ts

@@ -71,7 +71,7 @@ export interface IFetchArgs {
 	 *
 	 * @remarks
 	 * - Required for all resources except {@link ResourceType.TWEET_SEARCH} and {@link ResourceType.USER_TIMELINE_RECOMMENDED}.
-	 * - For {@link ResourceType.USER_DETAILS_BY_USERNAME} and {@link ResourceType.USER_SEARCH}, can be alphanumeric, while for others, is strictly numeric.
+	 * - For {@link ResourceType.USER_DETAILS_BY_USERNAME}, {@link ResourceType.USER_ABOUT_BY_USERNAME}, and {@link ResourceType.USER_SEARCH}, can be alphanumeric, while for others, is strictly numeric.
 	 */
 	id?: string;
 
@@ -83,6 +83,30 @@ export interface IFetchArgs {
 	 */
 	ids?: string[];
 
+	/**
+	 * Whether to include replay information when fetching space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	withReplays?: boolean;
+
+	/**
+	 * Whether to include listeners information when fetching space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	withListeners?: boolean;
+
+	/**
+	 * Whether to request metatags for space details.
+	 *
+	 * @remarks
+	 * - Only works for {@link ResourceType.SPACE_DETAILS}.
+	 */
+	isMetatagsQuery?: boolean;
+
 	/**
 	 * The sorting to use for tweet results.
 	 *
@@ -132,6 +156,22 @@ export interface IFetchArgs {
 	showVerifiedFollowers?: boolean;
 }
 
+/**
+ * Options specifying the data that is to be fetched for space details.
+ *
+ * @public
+ */
+export interface ISpaceDetailsOptions {
+	/** Whether to include replay information. */
+	withReplays?: boolean;
+
+	/** Whether to include listeners information. */
+	withListeners?: boolean;
+
+	/** Whether the request is a metatags query. */
+	isMetatagsQuery?: boolean;
+}
+
 /**
  * The filter to be used for searching tweets.
  *

package/src/types/data/Space.ts

@@ -0,0 +1,122 @@
+/**
+ * The details of a single Space.
+ *
+ * @public
+ */
+export interface ISpace {
+	/** The rest id of the space. */
+	id: string;
+
+	/** The current state of the space. */
+	state?: string;
+
+	/** The title of the space. */
+	title?: string;
+
+	/** The media key of the space. */
+	mediaKey?: string;
+
+	/** The creation date of the space. */
+	createdAt?: string;
+
+	/** The scheduled start time of the space. */
+	scheduledStart?: string;
+
+	/** The actual start time of the space. */
+	startedAt?: string;
+
+	/** The end time of the space. */
+	endedAt?: string;
+
+	/** The time at which the space was last updated. */
+	updatedAt?: string;
+
+	/** The id of the user who created the space. */
+	creatorId?: string;
+
+	/** The conversation controls value for the space. */
+	conversationControls?: number;
+
+	/** Whether joining the space is disallowed. */
+	disallowJoin?: boolean;
+
+	/** Whether the space is for employees only. */
+	isEmployeeOnly?: boolean;
+
+	/** Whether the space is locked. */
+	isLocked?: boolean;
+
+	/** Whether the space is muted. */
+	isMuted?: boolean;
+
+	/** Whether clipping is available for the space. */
+	isSpaceAvailableForClipping?: boolean;
+
+	/** Whether replay is available for the space. */
+	isSpaceAvailableForReplay?: boolean;
+
+	/** Whether incognito is disabled for the space. */
+	noIncognito?: boolean;
+
+	/** The total live listeners count for the space. */
+	totalLiveListeners?: number;
+
+	/** The total replay watched count for the space. */
+	totalReplayWatched?: number;
+
+	/** The total participant count reported in the response. */
+	participantCount?: number;
+
+	/** Whether the authenticated user is subscribed to the space. */
+	isSubscribed?: boolean;
+
+	/** The participants information for the space. */
+	participants?: ISpaceParticipants;
+}
+
+/**
+ * The participants of a Space grouped by roles.
+ *
+ * @public
+ */
+export interface ISpaceParticipants {
+	/** The total count of participants. */
+	total?: number;
+
+	/** The list of admins in the space. */
+	admins: ISpaceParticipant[];
+
+	/** The list of speakers in the space. */
+	speakers: ISpaceParticipant[];
+
+	/** The list of listeners in the space. */
+	listeners: ISpaceParticipant[];
+}
+
+/**
+ * The details of a single space participant.
+ *
+ * @public
+ */
+export interface ISpaceParticipant {
+	/** The rest id of the user. */
+	id?: string;
+
+	/** The screen name of the user. */
+	screenName?: string;
+
+	/** The display name of the user. */
+	displayName?: string;
+
+	/** The avatar URL of the user. */
+	avatarUrl?: string;
+
+	/** Whether the user is verified. */
+	isVerified?: boolean;
+
+	/** Whether the user is muted by admins. */
+	isMutedByAdmin?: boolean;
+
+	/** Whether the user is muted by guests. */
+	isMutedByGuest?: boolean;
+}

package/src/types/data/UserAbout.ts

@@ -0,0 +1,87 @@
+/**
+ * The about profile details of a single user.
+ *
+ * @public
+ */
+export interface IUserAbout {
+	/** The rest id of the user. */
+	id: string;
+
+	/** The username/screenname of the user. */
+	userName: string;
+
+	/** The full name of the user. */
+	fullName: string;
+
+	/** The creation date of user's account. */
+	createdAt: string;
+
+	/** The url of the profile image. */
+	profileImage: string;
+
+	/** The shape of the profile image. */
+	profileImageShape?: string;
+
+	/** Whether the account is verified or not. */
+	isVerified: boolean;
+
+	/** Whether the account is protected. */
+	isProtected?: boolean;
+
+	/** About profile details of the user. */
+	aboutProfile?: IUserAboutProfile;
+
+	/** Verification metadata of the user. */
+	verificationInfo?: IUserAboutVerificationInfo;
+}
+
+/**
+ * About profile information for a user.
+ *
+ * @public
+ */
+export interface IUserAboutProfile {
+	/** Whether the created country is accurate. */
+	createdCountryAccurate?: boolean;
+
+	/** The country where the account is based. */
+	accountBasedIn?: string;
+
+	/** Whether the location is accurate. */
+	locationAccurate?: boolean;
+
+	/** The help URL for verified accounts. */
+	learnMoreUrl?: string;
+
+	/** The source platform of the account. */
+	source?: string;
+
+	/** Username change metadata for the user. */
+	usernameChanges?: IUserAboutUsernameChanges;
+}
+
+/**
+ * Username change metadata for a user.
+ *
+ * @public
+ */
+export interface IUserAboutUsernameChanges {
+	/** The number of username changes. */
+	count?: number;
+
+	/** The last time the username was changed. */
+	lastChangedAt?: string;
+}
+
+/**
+ * Verification metadata for a user.
+ *
+ * @public
+ */
+export interface IUserAboutVerificationInfo {
+	/** Whether the user's identity is verified. */
+	isIdentityVerified?: boolean;
+
+	/** When the account was verified. */
+	verifiedSince?: string;
+}

package/src/types/raw/base/Space.ts

@@ -9,27 +9,47 @@ import { ITweet } from './Tweet';
  *
  * @public
  */
-export interface ISpace {
+export interface IRawSpace {
 	rest_id: string;
-	state: string;
-	title: string;
-	media_key: string;
-	created_at: number;
-	started_at: number;
-	ended_at: string;
-	replay_start_time: number;
-	updated_at: number;
-	creator_results: IDataResult<IUser>;
-	conversation_controls: number;
-	disallow_join: boolean;
-	is_employee_only: boolean;
-	is_locked: boolean;
-	is_muted: boolean;
-	is_space_available_for_clipping: boolean;
-	is_space_available_for_replay: boolean;
-	narrow_cast_space_type: number;
-	no_incognito: boolean;
-	total_replay_watched: number;
-	total_live_listeners: number;
-	tweet_results: IDataResult<ITweet>;
+	state?: string;
+	title?: string;
+	media_key?: string;
+	content_type?: string;
+	created_at?: number | string;
+	scheduled_start?: number | string;
+	started_at?: number | string;
+	ended_at?: number | string;
+	replay_start_time?: number | string;
+	updated_at?: number | string;
+	creator_id?: string;
+	creator_results?: IDataResult<IUser>;
+	conversation_controls?: number;
+	disallow_join?: boolean;
+	is_employee_only?: boolean;
+	is_locked?: boolean;
+	is_muted?: boolean;
+	is_space_available_for_clipping?: boolean;
+	is_space_available_for_replay?: boolean;
+	narrow_cast_space_type?: number;
+	no_incognito?: boolean;
+	pending_admin_twitter_user_ids?: Array<{ rest_id?: string }>;
+	total_replay_watched?: number;
+	total_live_listeners?: number;
+	participant_count?: number;
+	subscriber_count?: number;
+	max_guest_sessions?: number;
+	max_admin_capacity?: number;
+	is_ticketed?: boolean | string;
+	lang?: string;
+	host_ids?: string[];
+	speaker_ids?: string[];
+	invited_user_ids?: string[];
+	topics?: IRawSpaceTopic[];
+	tweet_results?: IDataResult<ITweet>;
+}
+
+export interface IRawSpaceTopic {
+	id: string;
+	name: string;
+	description?: string;
 }

package/src/types/raw/space/AudioSpaceById.ts

@@ -0,0 +1,57 @@
+/* eslint-disable */
+
+import { IRawSpace } from '../base/Space';
+
+/**
+ * The raw data received when fetching the details of a given Space.
+ *
+ * @public
+ */
+export interface IAudioSpaceByIdResponse {
+	data?: {
+		audioSpace?: IAudioSpace;
+	};
+	errors?: unknown[];
+}
+
+export interface IAudioSpace {
+	metadata?: IRawSpace;
+	participants?: IAudioSpaceParticipants;
+	sharings?: IAudioSpaceSharings;
+	is_subscribed?: boolean;
+}
+
+export interface IAudioSpaceParticipants {
+	total?: number;
+	admins?: IAudioSpaceParticipant[];
+	speakers?: IAudioSpaceParticipant[];
+	listeners?: IAudioSpaceParticipant[];
+}
+
+export interface IAudioSpaceParticipant {
+	periscope_user_id?: string;
+	start?: number | string;
+	twitter_screen_name?: string;
+	display_name?: string;
+	avatar_url?: string;
+	is_verified?: boolean;
+	is_muted_by_admin?: boolean;
+	is_muted_by_guest?: boolean;
+	user_results?: {
+		rest_id?: string;
+		result?: {
+			__typename?: string;
+			rest_id?: string;
+			is_blue_verified?: boolean;
+			verification?: {
+				verified_type?: string;
+				verified?: boolean;
+			};
+		};
+	};
+}
+
+export interface IAudioSpaceSharings {
+	items?: unknown[];
+	slice_info?: unknown;
+}