Skip to main content
POST https://xquik.com/api/v1/extractions
1 credit per result extracted · All plans from $0.00012/credit

Query parameters

Headers

Body

Each tool reads its own target, collection, and filter fields. See extraction parameters for every field.

Tool types

Choose supported target fields. resultsLimit defaults to 10,000. Send a positive integer to change it.

Tweet target

Use targetTweetId for tweet-centered jobs.
  • article_extractor extracts article content from a tweet.
  • favoriters extracts visible users who liked a post. Liker identities can be unavailable even when the post reports likes. The job reads through your connected X account. Without one, the job fails with errorMessage set to errorXAccountRequired.
  • quote_extractor extracts users who quote-tweeted a tweet.
  • reply_extractor extracts users who replied to a tweet.
  • repost_extractor extracts users who retweeted a tweet.
  • thread_extractor extracts all tweets in a thread.

Username target

Use targetUsername for account-centered jobs.
  • follower_explorer extracts followers of an account.
  • following_explorer extracts accounts followed by a user.
  • mention_extractor extracts tweets mentioning an account.
  • post_extractor extracts posts from an account.
  • user_likes extracts liked tweets that X makes visible. X shows likes only to their owner. The job reads through your connected X account. Without one, the job fails with errorMessage set to errorXAccountRequired.
  • user_affiliates extracts the accounts an organization lists as its affiliates.
  • user_media extracts media posts from a user.
  • verified_follower_explorer extracts verified followers of an account.

Community target

Use targetCommunityId for community jobs.
  • community_extractor extracts members of a community.
  • community_moderator_explorer extracts moderators of a community.
  • community_post_extractor extracts posts from a community.
  • community_search searches matching posts within that community and also requires searchQuery.

Search query

Use searchQuery for keyword jobs.
  • people_search searches for users by keyword.
  • tweet_search_extractor searches and extracts tweets by keyword or hashtag.

List target

Use targetListId for X List jobs.
  • list_follower_explorer extracts followers of a list.
  • list_member_extractor extracts members of a list.
  • list_post_extractor extracts posts from a list.

Space target

Use targetSpaceId for Space jobs.
  • space_explorer extracts participants of a Space.
Store targetSpaceId beside the returned extraction id. Poll Get Extraction or use Export Extraction after completion to read participant user rows.

Collect attached media from mixed sources

Use tweet_search_extractor when one job needs several Tweet sources. Set each source in targets. Use mediaType: "media" to keep rows with attachments.
Full output stores attachments at enrichmentData.tweet.media. Add outputPreset=flat while retrieving results to return media at row level. Use user_media with targetUsername for one profile-only job.

Response

202 Accepted

Prefer waitUrl while the job runs. Use statusUrl for immediate checks. New jobs include Location and Retry-After. Terminal replays return pollAfterMs: 0 and omit Retry-After.

400 Invalid input

The request body is missing or malformed. Send every required field.

400 Invalid tool type

Use one of the 23 tool types.

401 Unauthenticated

Missing or invalid API key.

402 Insufficient credits

The balance can’t cover the extraction. The error is no_subscription, subscription_inactive, no_credits or insufficient_credits.

403 Protected account

Post, media & follower tools refuse a protected targetUsername. Choose a public account. A multi-target job skips it & ends with partial_failure.

404 Not found

The target tweet or user doesn’t exist, was deleted, or is suspended.

409 Idempotency conflict

The key was used for a different request.

424 X API dependency failed

Send xquik-api-contract: 2026-04-29 to get 424 instead of the default 502.

429 Rate limited

Wait Retry-After seconds, then retry.

502 X API unavailable

The read service is unavailable. Retry with exponential backoff.
Next steps.

Response examples

200 example

202 example

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 402 { "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }
  • 403 { "error": "api_key_budget_reached", "message": "This API key reached its monthly credit budget. Raise or remove it at dashboard.xquik.com/api-keys, or wait for the next UTC month." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 409 { "error": "idempotency_conflict", "message": "Idempotency-Key belongs to another request. Use a new key." }
  • 424 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }
  • 502 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }