twitterapiio.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Api
webhooks.addRule
api.webhooks.addRule
Create a new tweet filter rule for the webhook stream (inactive by default — call updateRule to activate)
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
tag | string | Yes | Custom label to identify this rule |
value | string | Yes | Filter expression (e.g. “from:elonmusk OR from:kaitoeasyapi”). Rules are inactive until updated with isActive: true. |
intervalSeconds | number | Yes | How often to check for new tweets matching this rule (seconds, 100–86400) |
| Name | Type | Required | Description |
|---|---|---|---|
rule_id | string | No | — |
status | string | No | — |
msg | string | No | — |
webhooks.deleteRule
api.webhooks.deleteRule
Permanently delete a tweet filter rule
Risk: destructive · Irreversible
| Name | Type | Required | Description |
|---|---|---|---|
ruleId | string | Yes | ID of the rule to delete |
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
msg | string | No | — |
webhooks.getRules
api.webhooks.getRules
List all existing tweet filter rules
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
rules | object[] | No | — |
status | string | No | — |
msg | string | No | — |
rules full type
rules full type
webhooks.updateRule
api.webhooks.updateRule
Update a tweet filter rule, including activating or deactivating it
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
ruleId | string | Yes | ID of the rule to update |
tag | string | Yes | Custom label |
value | string | Yes | Filter expression |
intervalSeconds | number | Yes | Check interval in seconds (100–86400) |
isActive | boolean | Yes | true to activate the rule, false to deactivate |
| Name | Type | Required | Description |
|---|---|---|---|
rule_id | string | No | — |
status | string | No | — |
msg | string | No | — |
Communities
create
communities.create
Create a new Twitter community
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
description | string | No | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
delete
communities.delete
Delete a Twitter community
Risk: destructive · Irreversible
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
getById
communities.getById
Get community info by ID
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
data | object | No | — |
data full type
data full type
getMembers
communities.getMembers
Get members of a community
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
members | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
members full type
members full type
getModerators
communities.getModerators
Get moderators of a community
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
members | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
members full type
members full type
getTweets
communities.getTweets
Get tweets posted in a community
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
join
communities.join
Join a Twitter community
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
leave
communities.leave
Leave a Twitter community
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
communityId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
searchTweets
communities.searchTweets
Search tweets across all communities
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
Lists
getFollowers
lists.getFollowers
Get followers of a Twitter list
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
getMembers
lists.getMembers
Get members of a Twitter list
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
getTweets
lists.getTweets
Get tweets from a Twitter list timeline
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
Replies
get
replies.get
Get replies to a tweet, paginated by time range — stored independently in the replies table so engagement changes are tracked per reply
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
sinceTime | string | No | — |
untilTime | string | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
replies | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
message | string | No | — |
replies full type
replies full type
getV2
replies.getV2
Get replies to a tweet (v2) with sort order control (Relevance, Latest, Likes) — stored independently in the replies table so engagement changes are tracked per reply
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
queryType | Relevance | Latest | Likes | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
replies | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
message | string | No | — |
replies full type
replies full type
Stream
addUser
stream.addUser
Add a Twitter user to the real-time tweet monitor stream
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | Twitter/X handle to add to the real-time monitor stream |
| Name | Type | Required | Description |
|---|---|---|---|
status | success | error | No | — |
msg | string | No | — |
listUsers
stream.listUsers
List all Twitter users currently in the monitor stream
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
users | string[] | No | — |
status | string | No | — |
msg | string | No | — |
removeUser
stream.removeUser
Remove a Twitter user from the real-time tweet monitor stream
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | Twitter/X handle to remove from the monitor stream |
| Name | Type | Required | Description |
|---|---|---|---|
status | success | error | No | — |
msg | string | No | — |
Trends
get
trends.get
Get trending topics by location (woeid)
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
woeid | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
trends | object[] | No | — |
trends full type
trends full type
Tweets
advancedSearch
tweets.advancedSearch
Search tweets using structured operators (keywords, users, dates, engagement thresholds, media filters, etc.)
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
keywords | string[] | No | — |
exactPhrase | string | No | — |
anyOf | string[] | No | — |
excludeKeywords | string[] | No | — |
hashtags | string[] | No | — |
fromUsers | string[] | No | — |
toUsers | string[] | No | — |
mentioningUsers | string[] | No | — |
language | am | ar | bg | bn | bo | ca | cs | cy | da | de | dv | el | en | es | et | eu | fa | fi | fr | ga | gl | gu | he | hi | hr | hy | id | is | it | ja | ka | km | kn | ko | lo | lt | lv | ml | mr | my | ne | nl | no | or | pa | pl | ps | pt | ro | ru | si | sk | sl | sq | sr | sv | sw | ta | te | th | tl | tr | ug | uk | ur | vi | zh | No | — |
since | string | No | — |
until | string | No | — |
sinceTime | number | No | — |
untilTime | number | No | — |
replies | only | exclude | No | — |
retweets | only | exclude | No | — |
onlyLinks | boolean | No | — |
onlyMedia | boolean | No | — |
onlyImages | boolean | No | — |
onlyVideos | boolean | No | — |
minReplies | number | No | — |
minLikes | number | No | — |
minRetweets | number | No | — |
queryType | Latest | Top | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
create
tweets.create
Post a new tweet or reply
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
tweet | string | Yes | Tweet text content |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
replyToTweetId | string | No | — |
mediaIds | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
delete
tweets.delete
Delete a tweet
Risk: destructive · Irreversible
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
getByIds
tweets.getByIds
Fetch tweets by their IDs
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetIds | string | Yes | Comma-separated list of tweet IDs |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
tweets full type
tweets full type
getQuotations
tweets.getQuotations
Get quote tweets for a tweet
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
getRetweeters
tweets.getRetweeters
Get users who retweeted a tweet
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
getThreadContext
tweets.getThreadContext
Get the full thread context for a tweet
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
getUserLastTweets
tweets.getUserLastTweets
Retrieve a user’s most recent tweets by username
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
getUserMentions
tweets.getUserMentions
Get tweets that mention a user
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
getUserTimeline
tweets.getUserTimeline
Retrieve a user’s tweet timeline by user ID
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
like
tweets.like
Like a tweet
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
retweet
tweets.retweet
Retweet a tweet
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
search
tweets.search
Search tweets with a raw query string
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
queryType | Top | Latest | Photos | Videos | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
tweets | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
tweets full type
tweets full type
unlike
tweets.unlike
Remove a like from a tweet
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
tweetId | string | Yes | — |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
Users
batchGetByIds
users.batchGetByIds
Batch fetch user profiles by user IDs
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userIds | string | Yes | Comma-separated list of user IDs |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
data | object[] | No | — |
data full type
data full type
checkFollowRelationship
users.checkFollowRelationship
Check if two users follow each other
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
sourceUserName | string | Yes | — |
targetUserName | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
isFollowing | boolean | No | — |
isFollowedBy | boolean | No | — |
follow
users.follow
Follow a user
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
followId | string | Yes | User ID to follow |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |
getByUsername
users.getByUsername
Get user profile by username
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
data | object | No | — |
data full type
data full type
getFollowers
users.getFollowers
Get a user’s followers
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
getFollowings
users.getFollowings
Get users that a user is following
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
getMe
users.getMe
Get the authenticated account info
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
data | object | No | — |
data full type
data full type
getVerifiedFollowers
users.getVerifiedFollowers
Get a user’s verified (blue-check) followers
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
login
users.login
Authenticate a Twitter account via credentials and obtain a login cookie for v2 endpoints
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
userName | string | Yes | Twitter username |
email | string | Yes | Account email address |
password | string | Yes | Account password |
totpSecret | string | No | — |
proxy | string | Yes | High-quality residential proxy URL (e.g. http://user:pass@host:port) |
| Name | Type | Required | Description |
|---|---|---|---|
login_cookie | string | No | — |
status | string | No | — |
msg | string | No | — |
search
users.search
Search users by keyword
Risk: read
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | Yes | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
users | object[] | No | — |
next_cursor | string | No | — |
has_next_page | boolean | No | — |
users full type
users full type
unfollow
users.unfollow
Unfollow a user
Risk: write
| Name | Type | Required | Description |
|---|---|---|---|
followId | string | Yes | User ID to unfollow |
loginCookie | string | Yes | Twitter login cookie from user_login_v2 |
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
message | string | No | — |