Skip to main content
POST
/
extractions
/
estimate
Estimate extraction
curl --request POST \
  --url https://api.example.com/extractions/estimate \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "toolType": "<string>",
  "targetTweetId": "<string>",
  "targetUsername": "<string>",
  "targetCommunityId": "<string>",
  "searchQuery": "<string>",
  "targetListId": "<string>",
  "targetSpaceId": "<string>",
  "resultsLimit": 123
}
'
Free — does not consume credits
curl -X POST https://xquik.com/api/v1/extractions/estimate \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "toolType": "reply_extractor",
    "targetTweetId": "1893704267862470862"
  }' | jq

​
Headers

​
x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
​
Content-Type
string
required
Must be application/json.

​
Body

The request body accepts the same fields as Create Extraction, including all 16 tweet search filter parameters. Only toolType and the corresponding target field are required for the estimate.
​
toolType
string
required
Extraction tool to estimate. One of: article_extractor, community_extractor, community_moderator_explorer, community_post_extractor, community_search, 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, verified_follower_explorer.
​
targetTweetId
string
Tweet ID to estimate. Required for reply_extractor, repost_extractor, quote_extractor, thread_extractor, article_extractor.
​
targetUsername
string
X username to estimate. Required for follower_explorer, following_explorer, verified_follower_explorer, mention_extractor, post_extractor.
​
targetCommunityId
string
Community ID to estimate. Required for community_extractor, community_moderator_explorer, community_post_extractor.
​
searchQuery
string
Search query to estimate. Required for people_search, community_search, tweet_search_extractor.
​
targetListId
string
X List ID to estimate. Required for list_member_extractor, list_post_extractor, list_follower_explorer.
​
targetSpaceId
string
X Space ID to estimate. Required for space_explorer.
​
resultsLimit
integer
Maximum number of results to extract. When set, the estimate caps estimatedResults to this value and adjusts projected usage accordingly. Useful for previewing the cost of a partial extraction.

​
Response

​
allowed
boolean
Whether the extraction can proceed without exceeding the usage limit.
​
source
string
Data source used for the estimate. One of: replyCount, retweetCount, quoteCount, followers, resultsLimit, unknown.
​
estimatedResults
number
Estimated number of results the extraction will return.
​
usagePercent
number
Current usage as a percentage of the monthly cap (0-100).
​
projectedPercent
number
Projected usage percentage after this extraction completes (0-100+).
{
  "allowed": true,
  "source": "replyCount",
  "estimatedResults": 150,
  "usagePercent": 45,
  "projectedPercent": 78
}
When allowed is false, the projected usage would exceed the monthly cap:
{
  "allowed": false,
  "source": "followers",
  "estimatedResults": 250000,
  "usagePercent": 82,
  "projectedPercent": 340
}
Always call this endpoint before running an extraction to avoid hitting usage limits. If allowed is false, the corresponding Create Extraction request will return a 402 error. Check your current usage on the dashboard.
Next steps: Create Extraction to start an extraction, or Extraction Workflow Guide for the full flow.