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_extractorextracts article content from a tweet.favoritersextracts 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 witherrorMessageset toerrorXAccountRequired.quote_extractorextracts users who quote-tweeted a tweet.reply_extractorextracts users who replied to a tweet.repost_extractorextracts users who retweeted a tweet.thread_extractorextracts all tweets in a thread.
Username target
Use
targetUsername for account-centered jobs.follower_explorerextracts followers of an account.following_explorerextracts accounts followed by a user.mention_extractorextracts tweets mentioning an account.post_extractorextracts posts from an account.user_likesextracts 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 witherrorMessageset toerrorXAccountRequired.user_affiliatesextracts the accounts an organization lists as its affiliates.user_mediaextracts media posts from a user.verified_follower_explorerextracts verified followers of an account.
Community target
Use
targetCommunityId for community jobs.community_extractorextracts members of a community.community_moderator_explorerextracts moderators of a community.community_post_extractorextracts posts from a community.community_searchsearches matching posts within that community and also requiressearchQuery.
Search query
Use
searchQuery for keyword jobs.people_searchsearches for users by keyword.tweet_search_extractorsearches and extracts tweets by keyword or hashtag.
List target
Use
targetListId for X List jobs.list_follower_explorerextracts followers of a list.list_member_extractorextracts members of a list.list_post_extractorextracts posts from a list.
Space target
Use
targetSpaceId for Space jobs.space_explorerextracts participants of a Space.
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
Usetweet_search_extractor when one job needs several Tweet sources. Set each
source in targets. Use mediaType: "media" to keep rows with attachments.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 isno_subscription, subscription_inactive, no_credits or insufficient_credits.403 Protected account
Post, media & follower tools refuse a protectedtargetUsername. 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
Sendxquik-api-contract: 2026-04-29 to get 424 instead of the default 502.429 Rate limited
WaitRetry-After seconds, then retry.502 X API unavailable
The read service is unavailable. Retry with exponential backoff.Next steps.
- Get Extraction to retrieve results with pagination.
- Export Extraction to download as CSV, XLSX or Markdown.
- Estimate Extraction to check costs before running.
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." }