Sign in

v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112893437.0 KB
Extractions

Estimate extraction cost

post/extractions/estimate

Request body

toolType'article_extractor' | 'community_extractor' | 'community_moderator_explorer' | 'community_post_extractor' | 'community_search' | 'favoriters' | 'follower_explorer' | 'following_explorer' | 'list_follower_explorer' | 'list_member_extractor' | 'list_post_extractor' | 'mention_extractor' | 'people_search' | 'post_extractor' | 'quote_extractor' | 'reply_extractor' | 'repost_extractor' | 'space_explorer' | 'thread_extractor' | 'tweet_search_extractor' | 'user_likes' | 'user_media' | 'verified_follower_explorer' required

Identifier for the extraction tool used to run a job.

targetTweetIdstring
targetUsernamestring
targetCommunityIdstring

Community ID used to price community_post_extractor or community_search.

targetListIdstring

List ID used to price list_follower_explorer, list_member_extractor, or list_post_extractor.

targetSpaceIdstring

Space ID used to price space_explorer.

resultsLimitinteger

Maximum number of results to estimate. When set, the estimate caps projected results to this value.

searchQuerystring

Query used to price tweet_search_extractor or community_search.

fromUserstring

Estimate only tweets from this author username (tweet_search_extractor)

toUserstring

Estimate replies sent to this username (tweet_search_extractor)

mentioningstring

Estimate tweets mentioning this username (tweet_search_extractor)

languagestring

Language code used for estimate filtering (tweet_search_extractor)

sinceDatestring date

Estimate start date in YYYY-MM-DD format (tweet_search_extractor)

untilDatestring date

Estimate end date in YYYY-MM-DD format (tweet_search_extractor)

mediaType'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none'

Media type used for estimate filtering (tweet_search_extractor)

minFavesinteger

Minimum likes threshold for estimated results (tweet_search_extractor)

minRetweetsinteger

Minimum retweets threshold for estimated results (tweet_search_extractor)

minRepliesinteger

Minimum replies threshold for estimated results (tweet_search_extractor)

minQuotesinteger

Minimum quote count threshold for estimated results (tweet_search_extractor)

verifiedOnlyboolean

Estimate only verified authors (tweet_search_extractor)

replies'include' | 'exclude' | 'only'

Reply mode used for estimation (tweet_search_extractor)

retweets'include' | 'exclude' | 'only'

Retweet mode used for estimation (tweet_search_extractor)

quotes'include' | 'exclude' | 'only'

Quote mode used for estimation (tweet_search_extractor)

exactPhrasestring

Exact phrase filter for search estimation

excludeWordsstring

Words or quoted phrases excluded from estimated results. Separate with spaces, commas, or lines.

anyWordsstring

Alternative words or quoted phrases for estimated results. Separate with spaces, commas, or lines.

hashtagsstring

Hashtags applied to the estimate, separated by spaces, commas, or lines.

cashtagsstring

Cashtags applied to the estimate, separated by spaces, commas, or lines.

urlstring

URL substring or domain filter used for estimation (tweet_search_extractor)

conversationIdstring

Conversation ID filter used for estimation (tweet_search_extractor)

inReplyToTweetIdstring

Estimate only replies to this tweet ID (tweet_search_extractor)

quotesOfTweetIdstring

Estimate only quotes of this tweet ID (tweet_search_extractor)

retweetsOfTweetIdstring

Estimate only retweets of this tweet ID (tweet_search_extractor)

listIdstring

Estimate search results within this list ID (tweet_search_extractor)

placestring

Estimate search results within this place ID (tweet_search_extractor)

placeCountrystring

Estimate search results within this country code (tweet_search_extractor)

pointRadiusstring

Geo point radius used for estimation, e.g. -73.99 40.73 25mi (tweet_search_extractor)

boundingBoxstring

Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)

advancedQuerystring

Raw advanced query string appended to the estimate (tweet_search_extractor)

Example request

{
  "toolType": "follower_explorer",
  "targetTweetId": "1234567890",
  "targetUsername": "elonmusk",
  "targetCommunityId": "1500000000000000000",
  "targetListId": "1234567890",
  "targetSpaceId": "1vOGwMdBqpwGB",
  "resultsLimit": 1000,
  "searchQuery": "AI trends 2025",
  "fromUser": "nasa",
  "toUser": "openai",
  "mentioning": "example_user",
  "language": "en",
  "sinceDate": "2025-01-01",
  "untilDate": "2025-12-31",
  "mediaType": "images",
  "minFaves": 10,
  "minRetweets": 5,
  "minReplies": 3,
  "minQuotes": 2,
  "replies": "include",
  "retweets": "exclude",
  "quotes": "include",
  "exactPhrase": "artificial intelligence",
  "excludeWords": "spam",
  "anyWords": "ChatGPT AI model",
  "hashtags": "#AI startups",
  "cashtags": "$TSLA $NVDA",
  "url": "example.com",
  "conversationId": "1234567890",
  "inReplyToTweetId": "1234567890",
  "quotesOfTweetId": "1234567890",
  "retweetsOfTweetId": "1234567890",
  "listId": "1234567890",
  "place": "96683cc9126741d1",
  "placeCountry": "US",
  "pointRadius": "-73.99 40.73 25mi",
  "boundingBox": "-74.1 40.6 -73.9 40.8",
  "advancedQuery": "min_faves:100"
}

Response

Extraction estimate

estimatedResultsinteger required
creditsRequiredstring required
creditsAvailablestring required
allowedboolean required
source'followers' | 'following' | 'paginationCap' | 'posts' | 'quoteCount' | 'replyCount' | 'resultsLimit' | 'retweetCount' | 'unknown' required
resolvedXUserIdstring

Example response

{
  "estimatedResults": 500,
  "creditsRequired": "500",
  "creditsAvailable": "50000",
  "allowed": true,
  "source": "replyCount",
  "resolvedXUserId": "123456"
}