Integrate X into the workflow. Search tweets, manage bookmarks, follow/block/mute users, like and retweet, view trends, and more.
| Parameter | Type | Required | Description |
|---|
text | string | Yes | No description |
replyToTweetId | string | No | No description |
quoteTweetId | string | No | No description |
mediaIds | string | No | No description |
replySettings | string | No | Who can reply: "mentionedUsers", "following", "subscribers", or "verified" |
| Parameter | Type | Description |
|---|
id | string | The ID of the created tweet |
text | string | The text of the created tweet |
| Parameter | Type | Required | Description |
|---|
tweetId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the tweet was successfully deleted |
| Parameter | Type | Required | Description |
|---|
query | string | Yes | Search query (supports operators like "from:", "to:", "#hashtag", "has:images", "is:retweet", "lang:") |
maxResults | number | No | No description |
startTime | string | No | No description |
endTime | string | No | No description |
sinceId | string | No | No description |
untilId | string | No | No description |
sortOrder | string | No | Sort order: "recency" or "relevancy" |
nextToken | string | No | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of tweets matching the search query |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Search metadata including result count and pagination tokens |
↳ resultCount | number | Number of results returned |
↳ newestId | string | ID of the newest tweet |
↳ oldestId | string | ID of the oldest tweet |
↳ nextToken | string | Pagination token for next page |
| Parameter | Type | Required | Description |
|---|
ids | string | Yes | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of tweets matching the provided IDs |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
| Parameter | Type | Required | Description |
|---|
tweetId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of quote tweets |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
tweetId | string | Yes | No description |
hidden | boolean | Yes | No description |
| Parameter | Type | Description |
|---|
hidden | boolean | Whether the reply is now hidden |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
startTime | string | No | No description |
endTime | string | No | No description |
sinceId | string | No | No description |
untilId | string | No | No description |
exclude | string | No | Comma-separated types to exclude: "retweets", "replies" |
| Parameter | Type | Description |
|---|
tweets | array | Array of tweets by the user |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ newestId | string | ID of the newest tweet |
↳ oldestId | string | ID of the oldest tweet |
↳ nextToken | string | Token for next page |
↳ previousToken | string | Token for previous page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
startTime | string | No | No description |
endTime | string | No | No description |
sinceId | string | No | No description |
untilId | string | No | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of tweets mentioning the user |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ newestId | string | ID of the newest tweet |
↳ oldestId | string | ID of the oldest tweet |
↳ nextToken | string | Token for next page |
↳ previousToken | string | Token for previous page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
startTime | string | No | No description |
endTime | string | No | No description |
sinceId | string | No | No description |
untilId | string | No | No description |
exclude | string | No | Comma-separated types to exclude: "retweets", "replies" |
| Parameter | Type | Description |
|---|
tweets | array | Array of timeline tweets |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ newestId | string | ID of the newest tweet |
↳ oldestId | string | ID of the oldest tweet |
↳ nextToken | string | Token for next page |
↳ previousToken | string | Token for previous page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
tweetId | string | Yes | No description |
action | string | Yes | Action to perform: "like" or "unlike" |
| Parameter | Type | Description |
|---|
liked | boolean | Whether the tweet is now liked |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
tweetId | string | Yes | No description |
action | string | Yes | Action to perform: "retweet" or "unretweet" |
| Parameter | Type | Description |
|---|
retweeted | boolean | Whether the tweet is now retweeted |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of liked tweets |
↳ id | string | Tweet ID |
↳ text | string | Tweet content |
↳ createdAt | string | Creation timestamp |
↳ authorId | string | Author user ID |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
tweetId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of users who liked the tweet |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
tweetId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of users who retweeted the tweet |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
tweets | array | Array of bookmarked tweets |
↳ id | string | Tweet ID |
↳ text | string | Tweet text content |
↳ createdAt | string | Tweet creation timestamp |
↳ authorId | string | Author user ID |
↳ conversationId | string | Conversation thread ID |
↳ inReplyToUserId | string | User ID being replied to |
↳ publicMetrics | object | Engagement metrics |
↳ retweetCount | number | Number of retweets |
↳ replyCount | number | Number of replies |
↳ likeCount | number | Number of likes |
↳ quoteCount | number | Number of quotes |
includes | object | Additional data including user profiles |
↳ users | array | Array of user objects referenced in tweets |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ newestId | string | ID of the newest tweet |
↳ oldestId | string | ID of the oldest tweet |
↳ nextToken | string | Token for next page |
↳ previousToken | string | Token for previous page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
tweetId | string | Yes | No description |
| Parameter | Type | Description |
|---|
bookmarked | boolean | Whether the tweet was successfully bookmarked |
Remove a tweet from the authenticated user
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
tweetId | string | Yes | No description |
| Parameter | Type | Description |
|---|
bookmarked | boolean | Whether the tweet is still bookmarked (should be false after deletion) |
Get the authenticated user
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
user | object | Authenticated user profile |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
| Parameter | Type | Required | Description |
|---|
query | string | Yes | No description |
maxResults | number | No | No description |
nextToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of users matching the search query |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Search metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | nextToken output from the tool |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of follower user profiles |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of users being followed |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
targetUserId | string | Yes | No description |
action | string | Yes | Action to perform: "follow" or "unfollow" |
| Parameter | Type | Description |
|---|
following | boolean | Whether you are now following the user |
pendingFollow | boolean | Whether the follow request is pending (for protected accounts) |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
targetUserId | string | Yes | No description |
action | string | Yes | Action to perform: "block" or "unblock" |
| Parameter | Type | Description |
|---|
blocking | boolean | Whether you are now blocking the user |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
maxResults | number | No | No description |
paginationToken | string | No | No description |
| Parameter | Type | Description |
|---|
users | array | Array of blocked user profiles |
↳ id | string | User ID |
↳ username | string | Username without @ symbol |
↳ name | string | Display name |
↳ description | string | User bio |
↳ profileImageUrl | string | Profile image URL |
↳ verified | boolean | Whether the user is verified |
↳ metrics | object | User statistics |
↳ followersCount | number | Number of followers |
↳ followingCount | number | Number of users following |
↳ tweetCount | number | Total number of tweets |
meta | object | Pagination metadata |
↳ resultCount | number | Number of results returned |
↳ nextToken | string | Token for next page |
| Parameter | Type | Required | Description |
|---|
userId | string | Yes | No description |
targetUserId | string | Yes | No description |
action | string | Yes | Action to perform: "mute" or "unmute" |
| Parameter | Type | Description |
|---|
muting | boolean | Whether you are now muting the user |
Get trending topics for a specific location by WOEID (e.g., 1 for worldwide, 23424977 for US)
| Parameter | Type | Required | Description |
|---|
woeid | string | Yes | Yahoo Where On Earth ID (e.g., "1" for worldwide, "23424977" for US, "23424975" for UK) |
maxTrends | number | No | No description |
| Parameter | Type | Description |
|---|
trends | array | Array of trending topics |
↳ trendName | string | Name of the trending topic |
↳ tweetCount | number | Number of tweets for this trend |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
trends | array | Array of personalized trending topics |
↳ trendName | string | Name of the trending topic |
↳ postCount | number | Number of posts for this trend |
↳ category | string | Category of the trend |
↳ trendingSince | string | ISO 8601 timestamp of when the topic started trending |
| Parameter | Type | Required | Description |
|---|
days | number | No | No description |
| Parameter | Type | Description |
|---|
capResetDay | number | Day of month when usage cap resets |
projectId | string | The project ID |
projectCap | number | The project tweet consumption cap |
projectUsage | number | Total tweets consumed in current period |
dailyProjectUsage | array | Daily project usage breakdown |
↳ date | string | Usage date in ISO 8601 format |
↳ usage | number | Number of tweets consumed |
dailyClientAppUsage | array | Daily per-app usage breakdown |
↳ clientAppId | string | Client application ID |
↳ usage | array | Daily usage entries for this app |
↳ date | string | Usage date in ISO 8601 format |
↳ usage | number | Number of tweets consumed |
