Create extraction
Starts an asynchronous extraction. Call waitUrl for a bounded wait, or poll statusUrl after pollAfterMs until job status is terminal.
Query parameters
Estimate cost without creating an extraction.
Headers
Generate one unique value for each intended extraction. Reuse it only when retrying the same request. Exact retries return the original job.
Request body
Identifier for the extraction tool used to run a job.
Required for community_post_extractor & community_search.
Required for list_follower_explorer, list_member_extractor & list_post_extractor.
Required for space_explorer.
Tweet IDs processed as one collection job.
Usernames processed as one collection job.
Community IDs processed as one collection job.
List IDs processed as one collection job.
Search queries processed as one collection job.
Use Top for engagement. The relevance alias maps to Top.
Maximum results collected for each target.
Reply pages collected for each target.
Resume one reply target from this cursor.
Merge duplicate results across collection targets.
Keep target duplicates, first rows, or merged overlap.
Shortcut for dedupeMode=merge.
Add matching search terms to collection metadata.
Add source target metadata to each result.
Reply collection strategy.
Reply depth scope.
Maximum nested reply depth.
Reply result order.
Exclude replies from the source author.
Include the source post in reply results.
Return only replies with media.
Minimum Tweet view count.
Minimum Tweet bookmark count.
Maximum Tweet like count.
Maximum Tweet repost count.
Maximum Tweet reply count.
Maximum Tweet quote count.
Return only Blue-verified Tweet authors.
Require Tweet cards whose name matches this value.
Require Tweets from this source application.
Drop Tweets from this source application.
Restrict Tweets by latitude, longitude, and radius.
Require Tweets newer than this ID.
Require Tweets older than this ID.
Restrict Tweet search to this place name.
Set the radius around the requested place.
Restrict Tweets to this recent time window.
Require native repost results.
Apply safe-search filtering to Tweet results.
Require news-classified Tweet results.
Minimum follower count for profile results.
Maximum follower count for profile results.
Minimum following count for profile results.
Maximum following count for profile results.
Minimum post count for profile results.
Maximum post count for profile results.
Minimum profile age in days.
Exact profile verification type.
Require a profile website.
Require a profile location.
Bio terms separated by commas or lines.
Required profile location text.
Required username text.
Maximum unique results to emit. Billing follows emitted results, not this upper bound.
Required for tweet_search_extractor & community_search. Passed unchanged.
Filter by author username (tweet_search_extractor)
Replies to this username (tweet_search_extractor).
Mentions this username (tweet_search_extractor).
Only when requested (tweet_search_extractor).
Start date YYYY-MM-DD (tweet_search_extractor)
End date YYYY-MM-DD (tweet_search_extractor)
Media type filter (tweet_search_extractor)
Minimum likes threshold (tweet_search_extractor)
Minimum retweets threshold (tweet_search_extractor)
Minimum replies threshold (tweet_search_extractor)
Minimum quote count threshold (tweet_search_extractor)
Only verified authors (tweet_search_extractor)
Only when requested (tweet_search_extractor).
Only when requested (tweet_search_extractor).
Only when requested (tweet_search_extractor).
Exact phrase to match (tweet_search_extractor)
Excluded terms or phrases (tweet_search_extractor).
Any matching term or phrase (tweet_search_extractor).
Matching hashtags (tweet_search_extractor).
Matching cashtags (tweet_search_extractor).
URL substring or domain filter (tweet_search_extractor)
Conversation ID filter (tweet_search_extractor)
Only replies to this tweet ID (tweet_search_extractor)
Only quotes of this tweet ID (tweet_search_extractor)
Only retweets of this tweet ID (tweet_search_extractor)
Search within a list ID (tweet_search_extractor)
Search within a place ID (tweet_search_extractor)
Search within a country code (tweet_search_extractor)
Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
Raw advanced search query appended as-is (tweet_search_extractor)
Example request
{
"toolType": "follower_explorer",
"targetUsername": "elonmusk"
}Response
Dry-run estimate
Whether the balance covers the full estimate.
Credit calculation row count, not source availability.
Example response
{
"allowed": true,
"creditsAvailable": "50000",
"creditsRequired": "500",
"estimatedResults": 500,
"resolvedXUserId": "123456",
"source": "replyCount"
}