Skip to main content
curl -X POST https://xquik.com/api/v1/extractions/estimate \
  -H "x-api-key: xq_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" \
  -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. Only toolType and the corresponding target field are required for the estimate.
​
toolType
string
required
Extraction tool to estimate. One of: reply_extractor, retweet_extractor, quote_extractor, follower_explorer, verified_follower_explorer, community_extractor, mention_tracker, user_search.
​
targetTweetId
string
Tweet ID to estimate. Required for reply_extractor, retweet_extractor, quote_extractor.
​
targetUsername
string
X username to estimate. Required for follower_explorer, verified_follower_explorer, mention_tracker.
​
targetCommunityId
string
Community ID to estimate. Required for community_extractor.
​
searchQuery
string
Search query to estimate. Required for user_search.

​
Response

​
allowed
boolean
Whether the extraction can proceed without exceeding the usage cap.
​
source
string
Data source used for the estimate. One of: replyCount, retweetCount, quoteCount, followers, 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.