Available Fields
User Fields
These fields are available on all user tools (getTwitterUser, getTwitterUsers, searchTwitterUsers, getTwitterUserConnections, getTwitterUsersByKeywords, getTwitterPostInteractingUsers).
Default: id, username, name
getTwitterUsersByKeywords also returns aggregation fields: aggRelevance, relevantTweetsCount, relevantTweetsImpressionsSum, relevantTweetsLikesSum, relevantTweetsQuotesSum, relevantTweetsRepliesSum, relevantTweetsRetweetsSum.
Post Fields
These fields are available on all post tools (getTwitterPostsByIds, getTwitterPostsByAuthor, getTwitterPostsByKeywords, getTwitterPostRetweets, getTwitterPostQuotes, getTwitterPostComments).
Default: id, text, authorUsername, createdAtDate
User Tools
getTwitterUser
Get a single Twitter user profile by ID or username.getTwitterUsers
Get one or more Twitter user profiles by IDs or usernames (1-100 per request).
Returns only found users, omitting not-found identifiers.
searchTwitterUsers
Search users by name, partial username, or fuzzy match with real-time results.This tool performs a real-time search. For exact username lookups, use
getTwitterUser instead.getTwitterUserConnections
Get followers or following for a Twitter user.
Supports server-side pagination with 1,000 users per page (with default fields) or 100 per page (with extra fields). See Pagination for details.
getTwitterUsersByKeywords
Search for users who authored tweets matching keywords. Returns unique, deduplicated user profiles.
Supports server-side pagination with 100 users per page. See Pagination and Query Syntax for details.
Post Tools
getTwitterPostsByIds
Get one or more Twitter posts by numeric IDs (1-100 per request).
Returns only found posts, omitting not-found IDs. Returns the most up-to-date data available.
getTwitterPostsByAuthor
Get posts from a Twitter user by username.
Supports server-side pagination with 100 posts per page. Returns the most up-to-date data available.
getTwitterPostsByKeywords
Search Twitter posts by keywords.
Supports server-side pagination with 100 posts per page. See Query Syntax for details on search operators.
getTwitterPostRetweets
Get retweets of a specific post. Database-only — searches historical retweet data.
Supports server-side pagination with 100 posts per page.
This tool searches historical retweet data only. For quote posts, use
getTwitterPostQuotes instead.getTwitterPostQuotes
Get quote posts of a specific post.Data older than 10 days is automatically refreshed.
getTwitterPostComments
Get comments (replies) to a specific post.Data older than 10 days is automatically refreshed.
getTwitterPostInteractingUsers
Get user profiles of people who interacted with a specific post.This tool returns user profiles, not post data. The
fields parameter accepts user fields (see User Fields above).
