Skip to main content
POST
https://xquik.com/api/v1
/
extractions
Create Extraction
curl --request POST \
  --url https://xquik.com/api/v1/extractions \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "toolType": "<string>",
  "targetTweetId": "<string>",
  "targetUsername": "<string>",
  "targetCommunityId": "<string>",
  "searchQuery": "<string>"
}
'
curl -X POST https://xquik.com/api/v1/extractions \
  -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.
Content-Type
string
required
Must be application/json.

Body

toolType
string
required
Extraction tool to run. See tool types below.
targetTweetId
string
Tweet ID to extract from. Required for reply_extractor, retweet_extractor, quote_extractor.
targetUsername
string
X username to extract from. The @ prefix is automatically stripped if included. Required for follower_explorer, verified_follower_explorer, mention_tracker.
targetCommunityId
string
Community ID to extract members from. Required for community_extractor.
searchQuery
string
Search query string. Required for user_search.

Tool Types

Each tool type requires a specific target field.
Tool TypeRequired FieldDescription
reply_extractortargetTweetIdExtract users who replied to a tweet
retweet_extractortargetTweetIdExtract users who retweeted a tweet
quote_extractortargetTweetIdExtract users who quote-tweeted a tweet
follower_explorertargetUsernameExtract followers of an account
verified_follower_explorertargetUsernameExtract verified followers of an account
community_extractortargetCommunityIdExtract members of a community
mention_trackertargetUsernameExtract users who mentioned an account
user_searchsearchQueryExtract users matching a search query

Response

id
string
Unique extraction job ID.
toolType
string
Tool type used for this extraction.
status
string
Job status. completed on success.
totalResults
number
Total number of extracted results.
{
  "id": "77777",
  "toolType": "reply_extractor",
  "status": "completed",
  "totalResults": 150
}
Next steps: Get Extraction to retrieve results with pagination, Export Extraction to download as CSV/XLSX/Markdown, or Estimate Extraction to check costs before running.