Skip to main content
New to Corsair? See API access, authentication, and error handling.

Balance

get

balance.get Get the API key balance (free, not billed) Risk: read
Input: empty object Output

Communities

getById

communities.getById Get community details by ID Risk: read
Input Output

getMembers

communities.getMembers Get members of a community Risk: read
Input Output

getModerators

communities.getModerators Get moderators of a community Risk: read
Input Output

getTweets

communities.getTweets Get tweets posted in a community Risk: read
Input Output

communities.search Search X communities by keyword Risk: read
Input Output

Lists

getDetails

lists.getDetails Get X list details by list ID Risk: read
Input Output

getFollowers

lists.getFollowers Get followers of an X list Risk: read
Input Output

getMembers

lists.getMembers Get members of an X list Risk: read
Input Output

getTweets

lists.getTweets Get tweets from an X list timeline Risk: read
Input Output

Monitors

addAccounts

monitors.addAccounts Watch X accounts for new tweets (up to 100 per request) Risk: write
Input Output

createWebhook

monitors.createWebhook Add a webhook for watched-account tweet events Risk: write
Input Output

deleteWebhook

monitors.deleteWebhook Remove an account-monitoring webhook Risk: destructive · Irreversible
Input Output: empty object

getDeliveries

monitors.getDeliveries Show latest monitor events with delivery status Risk: read
Input Output

getEvents

monitors.getEvents Pull monitor events after an event ID (7-day retention) Risk: read
Input Output

getPlan

monitors.getPlan Get the account-monitoring plan and webhooks Risk: read
Input: empty object Output

getWebhook

monitors.getWebhook Get one account-monitoring webhook Risk: read
Input Output

listAccounts

monitors.listAccounts List watched X accounts and plan usage Risk: read
Input: empty object Output

listWebhooks

monitors.listWebhooks List account-monitoring webhooks, oldest first Risk: read
Input: empty object Output

removeAccount

monitors.removeAccount Stop watching an X account Risk: destructive · Irreversible
Input Output: empty object

testWebhook

monitors.testWebhook Send a signed test event to a webhook Risk: write
Input Output

updateAccount

monitors.updateAccount Change a watched account’s reply/retweet/quote filters Risk: write
Input
Output

updateWebhook

monitors.updateWebhook Change a webhook URL, filter, secret, or active flag Risk: write
Input Output

getByLocation

trends.getByLocation Get trending topics by location (WOEID, 1 = worldwide) Risk: read
Input Output

getLocations

trends.getLocations List available trend locations (WOEIDs) Risk: read
Input: empty object Output

Tweets

getById

tweets.getById Get a single tweet by ID Risk: read
Input Output

getQuotes

tweets.getQuotes Get quote tweets for a tweet Risk: read
Input Output

getReplies

tweets.getReplies Get a tweet with its replies in display order Risk: read
Input Output

getRetweeters

tweets.getRetweeters Get users who retweeted a tweet Risk: read
Input Output

search

tweets.search Search X tweets (Top, Latest, Photos, Videos tabs) Risk: read
Input Output

Users

batchGetByIds

users.batchGetByIds Batch fetch up to 500 user profiles by IDs Risk: read
Input Output

getById

users.getById Get a user profile by numeric ID (or handle via username) Risk: read
Input Output

getByUsername

users.getByUsername Get a user profile by handle Risk: read
Input Output

getFollowers

users.getFollowers Get a user’s followers Risk: read
Input Output

getFollowings

users.getFollowings Get users that a user is following Risk: read
Input Output

getFriendship

users.getFriendship Show the relationship between two accounts Risk: read
Input Output

getLikes

users.getLikes Get a user’s liked tweets Risk: read
Input Output

getMedia

users.getMedia Get media tweets from a user’s timeline Risk: read
Input Output

getTweets

users.getTweets Get a user’s tweets Risk: read
Input Output

getTweetsAndReplies

users.getTweetsAndReplies Get a user’s tweets and replies Risk: read
Input Output

getVerifiedFollowers

users.getVerifiedFollowers Get a user’s verified followers Risk: read
Input Output

resolveIds

users.resolveIds Resolve up to 100 handles to user IDs Risk: read
Input Output