Twitter scraper API & bulk extraction jobs

{
  "allowed": true,
  "creditsAvailable": "10000",
  "creditsRequired": "1000",
  "estimatedResults": 1000,
  "source": "followers"
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "toolType": "follower_explorer",
  "status": "running"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "insufficient_credits",
  "message": "Insufficient credits. Top up or subscribe to continue."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

POST

extractions

Twitter scraper API & bulk extraction jobs

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>",
  "targetListId": "<string>",
  "targetSpaceId": "<string>",
  "searchQuery": "<string>",
  "targetTweetIds": [
    "<string>"
  ],
  "targetUsernames": [
    "<string>"
  ],
  "targetCommunityIds": [
    "<string>"
  ],
  "targetListIds": [
    "<string>"
  ],
  "searchQueries": [
    "<string>"
  ],
  "targets": [
    {}
  ],
  "relationTargets": [
    {}
  ],
  "queryType": "<string>",
  "resultsLimit": 123,
  "maxItemsPerTarget": 123,
  "maxPagesPerTarget": 123,
  "startCursor": "<string>",
  "dedupeAcrossTargets": true,
  "dedupeMode": "<string>",
  "overlapMode": true,
  "includeSearchTerms": true,
  "includeTargetMetadata": true,
  "collectionStrategy": "<string>",
  "scope": "<string>",
  "maxDepth": 123,
  "sort": "<string>",
  "excludeOriginalAuthor": true,
  "includeOriginalPost": true,
  "hasMediaOnly": true,
  "sinceTime": {},
  "untilTime": {},
  "minViews": 123,
  "minBookmarks": 123,
  "maxLikes": 123,
  "maxRetweets": 123,
  "maxReplies": 123,
  "maxQuotes": 123,
  "blueVerifiedOnly": true,
  "cardName": "<string>",
  "source": "<string>",
  "excludeSource": "<string>",
  "geocode": "<string>",
  "sinceId": "<string>",
  "maxId": "<string>",
  "near": "<string>",
  "within": "<string>",
  "withinTime": "<string>",
  "nativeRetweets": true,
  "safe": true,
  "news": true,
  "minFollowers": 123,
  "maxFollowers": 123,
  "minFollowing": 123,
  "maxFollowing": 123,
  "minPosts": 123,
  "maxPosts": 123,
  "minAccountAgeDays": 123,
  "verifiedType": "<string>",
  "hasWebsite": true,
  "hasLocation": true,
  "bioContains": "<string>",
  "locationContains": "<string>",
  "usernameContains": "<string>",
  "fromUser": "<string>",
  "toUser": "<string>",
  "mentioning": "<string>",
  "language": "<string>",
  "sinceDate": "<string>",
  "untilDate": "<string>",
  "mediaType": "<string>",
  "minFaves": 123,
  "minRetweets": 123,
  "minReplies": 123,
  "minQuotes": 123,
  "verifiedOnly": true,
  "replies": "<string>",
  "retweets": "<string>",
  "quotes": "<string>",
  "exactPhrase": "<string>",
  "excludeWords": "<string>",
  "anyWords": "<string>",
  "hashtags": "<string>",
  "cashtags": "<string>",
  "url": "<string>",
  "conversationId": "<string>",
  "inReplyToTweetId": "<string>",
  "quotesOfTweetId": "<string>",
  "retweetsOfTweetId": "<string>",
  "listId": "<string>",
  "place": "<string>",
  "placeCountry": "<string>",
  "pointRadius": "<string>",
  "boundingBox": "<string>",
  "advancedQuery": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/extractions"

payload = {
    "toolType": "<string>",
    "targetTweetId": "<string>",
    "targetUsername": "<string>",
    "targetCommunityId": "<string>",
    "targetListId": "<string>",
    "targetSpaceId": "<string>",
    "searchQuery": "<string>",
    "targetTweetIds": ["<string>"],
    "targetUsernames": ["<string>"],
    "targetCommunityIds": ["<string>"],
    "targetListIds": ["<string>"],
    "searchQueries": ["<string>"],
    "targets": [{}],
    "relationTargets": [{}],
    "queryType": "<string>",
    "resultsLimit": 123,
    "maxItemsPerTarget": 123,
    "maxPagesPerTarget": 123,
    "startCursor": "<string>",
    "dedupeAcrossTargets": True,
    "dedupeMode": "<string>",
    "overlapMode": True,
    "includeSearchTerms": True,
    "includeTargetMetadata": True,
    "collectionStrategy": "<string>",
    "scope": "<string>",
    "maxDepth": 123,
    "sort": "<string>",
    "excludeOriginalAuthor": True,
    "includeOriginalPost": True,
    "hasMediaOnly": True,
    "sinceTime": {},
    "untilTime": {},
    "minViews": 123,
    "minBookmarks": 123,
    "maxLikes": 123,
    "maxRetweets": 123,
    "maxReplies": 123,
    "maxQuotes": 123,
    "blueVerifiedOnly": True,
    "cardName": "<string>",
    "source": "<string>",
    "excludeSource": "<string>",
    "geocode": "<string>",
    "sinceId": "<string>",
    "maxId": "<string>",
    "near": "<string>",
    "within": "<string>",
    "withinTime": "<string>",
    "nativeRetweets": True,
    "safe": True,
    "news": True,
    "minFollowers": 123,
    "maxFollowers": 123,
    "minFollowing": 123,
    "maxFollowing": 123,
    "minPosts": 123,
    "maxPosts": 123,
    "minAccountAgeDays": 123,
    "verifiedType": "<string>",
    "hasWebsite": True,
    "hasLocation": True,
    "bioContains": "<string>",
    "locationContains": "<string>",
    "usernameContains": "<string>",
    "fromUser": "<string>",
    "toUser": "<string>",
    "mentioning": "<string>",
    "language": "<string>",
    "sinceDate": "<string>",
    "untilDate": "<string>",
    "mediaType": "<string>",
    "minFaves": 123,
    "minRetweets": 123,
    "minReplies": 123,
    "minQuotes": 123,
    "verifiedOnly": True,
    "replies": "<string>",
    "retweets": "<string>",
    "quotes": "<string>",
    "exactPhrase": "<string>",
    "excludeWords": "<string>",
    "anyWords": "<string>",
    "hashtags": "<string>",
    "cashtags": "<string>",
    "url": "<string>",
    "conversationId": "<string>",
    "inReplyToTweetId": "<string>",
    "quotesOfTweetId": "<string>",
    "retweetsOfTweetId": "<string>",
    "listId": "<string>",
    "place": "<string>",
    "placeCountry": "<string>",
    "pointRadius": "<string>",
    "boundingBox": "<string>",
    "advancedQuery": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    toolType: '<string>',
    targetTweetId: '<string>',
    targetUsername: '<string>',
    targetCommunityId: '<string>',
    targetListId: '<string>',
    targetSpaceId: '<string>',
    searchQuery: '<string>',
    targetTweetIds: ['<string>'],
    targetUsernames: ['<string>'],
    targetCommunityIds: ['<string>'],
    targetListIds: ['<string>'],
    searchQueries: ['<string>'],
    targets: [{}],
    relationTargets: [{}],
    queryType: '<string>',
    resultsLimit: 123,
    maxItemsPerTarget: 123,
    maxPagesPerTarget: 123,
    startCursor: '<string>',
    dedupeAcrossTargets: true,
    dedupeMode: '<string>',
    overlapMode: true,
    includeSearchTerms: true,
    includeTargetMetadata: true,
    collectionStrategy: '<string>',
    scope: '<string>',
    maxDepth: 123,
    sort: '<string>',
    excludeOriginalAuthor: true,
    includeOriginalPost: true,
    hasMediaOnly: true,
    sinceTime: {},
    untilTime: {},
    minViews: 123,
    minBookmarks: 123,
    maxLikes: 123,
    maxRetweets: 123,
    maxReplies: 123,
    maxQuotes: 123,
    blueVerifiedOnly: true,
    cardName: '<string>',
    source: '<string>',
    excludeSource: '<string>',
    geocode: '<string>',
    sinceId: '<string>',
    maxId: '<string>',
    near: '<string>',
    within: '<string>',
    withinTime: '<string>',
    nativeRetweets: true,
    safe: true,
    news: true,
    minFollowers: 123,
    maxFollowers: 123,
    minFollowing: 123,
    maxFollowing: 123,
    minPosts: 123,
    maxPosts: 123,
    minAccountAgeDays: 123,
    verifiedType: '<string>',
    hasWebsite: true,
    hasLocation: true,
    bioContains: '<string>',
    locationContains: '<string>',
    usernameContains: '<string>',
    fromUser: '<string>',
    toUser: '<string>',
    mentioning: '<string>',
    language: '<string>',
    sinceDate: '<string>',
    untilDate: '<string>',
    mediaType: '<string>',
    minFaves: 123,
    minRetweets: 123,
    minReplies: 123,
    minQuotes: 123,
    verifiedOnly: true,
    replies: '<string>',
    retweets: '<string>',
    quotes: '<string>',
    exactPhrase: '<string>',
    excludeWords: '<string>',
    anyWords: '<string>',
    hashtags: '<string>',
    cashtags: '<string>',
    url: '<string>',
    conversationId: '<string>',
    inReplyToTweetId: '<string>',
    quotesOfTweetId: '<string>',
    retweetsOfTweetId: '<string>',
    listId: '<string>',
    place: '<string>',
    placeCountry: '<string>',
    pointRadius: '<string>',
    boundingBox: '<string>',
    advancedQuery: '<string>'
  })
};

fetch('https://xquik.com/api/v1/extractions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/extractions"

	payload := strings.NewReader("{\n  \"toolType\": \"<string>\",\n  \"targetTweetId\": \"<string>\",\n  \"targetUsername\": \"<string>\",\n  \"targetCommunityId\": \"<string>\",\n  \"targetListId\": \"<string>\",\n  \"targetSpaceId\": \"<string>\",\n  \"searchQuery\": \"<string>\",\n  \"targetTweetIds\": [\n    \"<string>\"\n  ],\n  \"targetUsernames\": [\n    \"<string>\"\n  ],\n  \"targetCommunityIds\": [\n    \"<string>\"\n  ],\n  \"targetListIds\": [\n    \"<string>\"\n  ],\n  \"searchQueries\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {}\n  ],\n  \"relationTargets\": [\n    {}\n  ],\n  \"queryType\": \"<string>\",\n  \"resultsLimit\": 123,\n  \"maxItemsPerTarget\": 123,\n  \"maxPagesPerTarget\": 123,\n  \"startCursor\": \"<string>\",\n  \"dedupeAcrossTargets\": true,\n  \"dedupeMode\": \"<string>\",\n  \"overlapMode\": true,\n  \"includeSearchTerms\": true,\n  \"includeTargetMetadata\": true,\n  \"collectionStrategy\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"maxDepth\": 123,\n  \"sort\": \"<string>\",\n  \"excludeOriginalAuthor\": true,\n  \"includeOriginalPost\": true,\n  \"hasMediaOnly\": true,\n  \"sinceTime\": {},\n  \"untilTime\": {},\n  \"minViews\": 123,\n  \"minBookmarks\": 123,\n  \"maxLikes\": 123,\n  \"maxRetweets\": 123,\n  \"maxReplies\": 123,\n  \"maxQuotes\": 123,\n  \"blueVerifiedOnly\": true,\n  \"cardName\": \"<string>\",\n  \"source\": \"<string>\",\n  \"excludeSource\": \"<string>\",\n  \"geocode\": \"<string>\",\n  \"sinceId\": \"<string>\",\n  \"maxId\": \"<string>\",\n  \"near\": \"<string>\",\n  \"within\": \"<string>\",\n  \"withinTime\": \"<string>\",\n  \"nativeRetweets\": true,\n  \"safe\": true,\n  \"news\": true,\n  \"minFollowers\": 123,\n  \"maxFollowers\": 123,\n  \"minFollowing\": 123,\n  \"maxFollowing\": 123,\n  \"minPosts\": 123,\n  \"maxPosts\": 123,\n  \"minAccountAgeDays\": 123,\n  \"verifiedType\": \"<string>\",\n  \"hasWebsite\": true,\n  \"hasLocation\": true,\n  \"bioContains\": \"<string>\",\n  \"locationContains\": \"<string>\",\n  \"usernameContains\": \"<string>\",\n  \"fromUser\": \"<string>\",\n  \"toUser\": \"<string>\",\n  \"mentioning\": \"<string>\",\n  \"language\": \"<string>\",\n  \"sinceDate\": \"<string>\",\n  \"untilDate\": \"<string>\",\n  \"mediaType\": \"<string>\",\n  \"minFaves\": 123,\n  \"minRetweets\": 123,\n  \"minReplies\": 123,\n  \"minQuotes\": 123,\n  \"verifiedOnly\": true,\n  \"replies\": \"<string>\",\n  \"retweets\": \"<string>\",\n  \"quotes\": \"<string>\",\n  \"exactPhrase\": \"<string>\",\n  \"excludeWords\": \"<string>\",\n  \"anyWords\": \"<string>\",\n  \"hashtags\": \"<string>\",\n  \"cashtags\": \"<string>\",\n  \"url\": \"<string>\",\n  \"conversationId\": \"<string>\",\n  \"inReplyToTweetId\": \"<string>\",\n  \"quotesOfTweetId\": \"<string>\",\n  \"retweetsOfTweetId\": \"<string>\",\n  \"listId\": \"<string>\",\n  \"place\": \"<string>\",\n  \"placeCountry\": \"<string>\",\n  \"pointRadius\": \"<string>\",\n  \"boundingBox\": \"<string>\",\n  \"advancedQuery\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "toolType": "<string>",
  "status": "<string>"
}

1 credit per result extracted · All plans from $0.00012/credit

Query parameters

boolean

Return a cost estimate without creating a job. Defaults to false.

curl -X POST https://xquik.com/api/v1/extractions \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "toolType": "reply_extractor",
    "targetTweetId": "1893704267862470862",
    "resultsLimit": 500
  }' | jq

const response = await fetch("https://xquik.com/api/v1/extractions", {
  method: "POST",
  headers: {
    "x-api-key": "xq_YOUR_KEY_HERE",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    toolType: "reply_extractor",
    targetTweetId: "1893704267862470862",
    resultsLimit: 500,
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://xquik.com/api/v1/extractions",
    headers={"x-api-key": "xq_YOUR_KEY_HERE"},
    json={
        "toolType": "reply_extractor",
        "targetTweetId": "1893704267862470862",
        "resultsLimit": 500,
    },
)
data = response.json()

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    body, _ := json.Marshal(map[string]interface{}{
        "toolType":      "reply_extractor",
        "targetTweetId": "1893704267862470862",
        "resultsLimit":  500,
    })

    req, err := http.NewRequest("POST", "https://xquik.com/api/v1/extractions", bytes.NewReader(body))
    if err != nil {
        panic(err)
    }
    req.Header.Set("x-api-key", "xq_YOUR_KEY_HERE")
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var data map[string]interface{}
    if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
        panic(err)
    }
    fmt.Println(data)
}

Headers

string

required

Your API key. Session cookie authentication is also supported.

string

required

Must be application/json.

Body

string

required

Extraction tool to run or estimate. See the endpoint’s tool list.

Single targets

string

Tweet ID for a tweet-centered extraction.

string

Username for an account-centered extraction. You may include @.

string

Community ID for a community extraction.

string

List ID for a list extraction.

string

Space ID for space_explorer.

string

Query for tweet_search_extractor or community_search.

Collection targets

string[]

Process 1-10,000 Tweet IDs in one collection job.

string[]

Process 1-100 unique usernames in one collection job.

string[]

Process 1-100 unique community IDs in one collection job.

string[]

Process 1-100 unique List IDs in one collection job.

string[]

Process 1-100 unique search queries in one collection job.

array

Process up to 10,000 mixed targets with automatic routing.

Each target accepts a supported string or { "kind": "...", "value": "..." }.

array

Process up to 100 profile relations in one collection job.

Each relation target uses { "relation": "...", "value": "..." }.

Collection controls

string

Search ranking: Latest, Top, or Both. Defaults to Latest.

integer

Stop after this many results. Omit it to collect all available results.

integer

Maximum results collected for each target. Minimum: 1.

integer

Reply pages collected per target. Range: 1-1,000.

string

Resume one reply target from this cursor.

boolean

Merge duplicates across targets. Defaults to true.

string

Duplicate handling: none, first, or merge.

boolean

Use dedupeMode=merge. Defaults to false.

boolean

Add matched search terms to collection metadata. Defaults to false.

boolean

Add source target metadata to each result. Defaults to true.

Reply collection

string

Strategy: auto, complete, direct, search, or thread.

string

Reply scope: all, direct, or nested. Defaults to all.

integer

Maximum nested reply depth. Minimum: 1.

string

Order: relevance, latest, oldest, or likes.

boolean

Exclude replies from the source author. Defaults to false.

boolean

Include the source post. Defaults to false.

boolean

Return only replies with media. Defaults to false.

string | integer

Reply start time as ISO 8601 or Unix seconds.

string | integer

Reply end time as ISO 8601 or Unix seconds.

Tweet result filters

integer

Minimum Tweet view count.

integer

Minimum Tweet bookmark count.

integer

Maximum Tweet like count.

integer

Maximum Tweet repost count.

integer

Maximum Tweet reply count.

integer

Maximum Tweet quote count.

boolean

Return only Blue-verified Tweet authors. Defaults to false.

string

Match the Tweet card name.

string

Match the source application.

string

Exclude a source application.

string

Match latitude, longitude, and radius.

string

Return Tweets newer than this Tweet ID.

string

Return Tweets older than this Tweet ID.

string

Match a place name.

string

Set the radius for near.

string

Match Tweets inside a recent time window.

boolean

Return only native reposts. Defaults to false.

boolean

Enable safe search. Defaults to false.

boolean

Return only news results. Defaults to false.

Profile result filters

integer

Minimum profile follower count.

integer

Maximum profile follower count.

integer

Minimum profile following count.

integer

Maximum profile following count.

integer

Minimum profile post count.

integer

Maximum profile post count.

integer

Minimum profile age in days.

string

Match the exact profile verification type.

boolean

Require a profile website. Defaults to false.

boolean

Require a profile location. Defaults to false.

string

Require bio terms separated by commas or lines.

string

Require matching profile location text.

string

Require matching username text.

These fields apply to tweet_search_extractor.

string

Match an author username without @.

string

Match replies sent to a username.

string

Match Tweets mentioning a username.

string

Match a language code, such as en.

string

Include Tweets on or after YYYY-MM-DD.

string

Include Tweets before YYYY-MM-DD.

string

Media: images, videos, gifs, media, links, or none.

integer

Minimum like count.

integer

Minimum repost count.

integer

Minimum reply count.

integer

Minimum quote count.

boolean

Return only verified authors.

string

Reply mode: include, exclude, or only.

string

Repost mode: include, exclude, or only.

string

Quote mode: include, exclude, or only.

string

Match one exact phrase.

string

Exclude words or quoted phrases.

string

Match any listed word or quoted phrase.

string

Match hashtags separated by spaces, commas, or lines.

string

Match cashtags separated by spaces, commas, or lines.

string

Match a URL substring or domain.

string

Match a conversation ID.

string

Return only replies to this Tweet ID.

string

Return only quotes of this Tweet ID.

string

Return only reposts of this Tweet ID.

string

Search within a List ID.

string

Search within a place ID.

string

Search within a country code.

string

Set a geographic center and radius.

string

Set a geographic bounding box.

string

Append raw advanced search syntax.

Tool types

Each extraction job needs one target field based on toolType. resultsLimit works with every type when you want to cap returned rows.

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.
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 tweets liked by a user.
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.

Response

202 Accepted

string

Unique extraction job ID (UUID).

string

Tool type used for this extraction.

string

Job status. running when first created.

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "toolType": "reply_extractor",
  "status": "running"
}

Extraction runs asynchronously. Poll Get Extraction until status is completed or failed.

400 Invalid input

{ "error": "invalid_input", "message": "Missing or malformed request body" }

Request body is missing or malformed. Ensure all required fields are present.

400 Invalid tool type

{ "error": "invalid_tool_type", "message": "Unrecognized tool type" }

The toolType value is not one of the 23 supported tools. See tool types.

401 Unauthenticated

{ "error": "unauthenticated", "message": "Missing or invalid API key" }

Missing or invalid API key.

402 Insufficient credits

{ "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }

The available balance cannot cover the extraction. Possible error values include no_subscription, subscription_inactive, no_credits, and insufficient_credits.

404 Not found

{ "error": "tweet_not_found", "message": "Tweet not found" }

The target tweet does not exist, was deleted, or the ID is invalid.

{ "error": "user_not_found", "message": "X user not found" }

The target user does not exist or is suspended.

424 X API dependency failed

{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable" }

Send xquik-api-contract: 2026-04-29 to receive this status for dependency failures that return 502 by default.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }

Wait for the Retry-After value before retrying the extraction request.

502 X API unavailable

{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable" }

The read service is temporarily unavailable. Retry with exponential backoff.

Run receipt handoff

Treat the 202 Accepted body as a run receipt, not as extracted data. Store the job ID immediately, then poll or list jobs until the job reaches completed or failed.

{
  "extraction_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tool_type": "reply_extractor",
  "status": "running",
  "receipt_format": "extraction_job",
  "poll_path": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "inventory_path": "/api/v1/extractions?status=completed&toolType=reply_extractor",
  "export_path_after_complete": "/api/v1/extractions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export?format=csv"
}

Receipt fields

Store id, toolType, and status. Do not wait for results, totalResults, createdAt, hasMore, or nextCursor in this response.

Poll results

Use Get Extraction with the returned id to read job.status, paginated results, hasMore, and nextCursor.

Find later

Use List Extractions with status and toolType filters when a worker needs to resume from job inventory.

Export after completion

Use Export Extraction after the detail response reports job.status as completed.

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.

{
  "allowed": true,
  "creditsAvailable": "10000",
  "creditsRequired": "1000",
  "estimatedResults": 1000,
  "source": "followers"
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "toolType": "follower_explorer",
  "status": "running"
}

{
  "error": "invalid_input",
  "message": "Invalid input. Check the request body."
}

{
  "error": "unauthenticated",
  "message": "Authentication required. Provide a valid API key or bearer token."
}

{
  "error": "insufficient_credits",
  "message": "Insufficient credits. Top up or subscribe to continue."
}

{
  "error": "not_found",
  "message": "Resource not found."
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Try again later.",
  "retryAfter": 60
}

{
  "error": "x_api_unavailable",
  "message": "X data source temporarily unavailable. Try again later."
}

Twitter scraper API & bulk extraction jobs

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>",
  "targetListId": "<string>",
  "targetSpaceId": "<string>",
  "searchQuery": "<string>",
  "targetTweetIds": [
    "<string>"
  ],
  "targetUsernames": [
    "<string>"
  ],
  "targetCommunityIds": [
    "<string>"
  ],
  "targetListIds": [
    "<string>"
  ],
  "searchQueries": [
    "<string>"
  ],
  "targets": [
    {}
  ],
  "relationTargets": [
    {}
  ],
  "queryType": "<string>",
  "resultsLimit": 123,
  "maxItemsPerTarget": 123,
  "maxPagesPerTarget": 123,
  "startCursor": "<string>",
  "dedupeAcrossTargets": true,
  "dedupeMode": "<string>",
  "overlapMode": true,
  "includeSearchTerms": true,
  "includeTargetMetadata": true,
  "collectionStrategy": "<string>",
  "scope": "<string>",
  "maxDepth": 123,
  "sort": "<string>",
  "excludeOriginalAuthor": true,
  "includeOriginalPost": true,
  "hasMediaOnly": true,
  "sinceTime": {},
  "untilTime": {},
  "minViews": 123,
  "minBookmarks": 123,
  "maxLikes": 123,
  "maxRetweets": 123,
  "maxReplies": 123,
  "maxQuotes": 123,
  "blueVerifiedOnly": true,
  "cardName": "<string>",
  "source": "<string>",
  "excludeSource": "<string>",
  "geocode": "<string>",
  "sinceId": "<string>",
  "maxId": "<string>",
  "near": "<string>",
  "within": "<string>",
  "withinTime": "<string>",
  "nativeRetweets": true,
  "safe": true,
  "news": true,
  "minFollowers": 123,
  "maxFollowers": 123,
  "minFollowing": 123,
  "maxFollowing": 123,
  "minPosts": 123,
  "maxPosts": 123,
  "minAccountAgeDays": 123,
  "verifiedType": "<string>",
  "hasWebsite": true,
  "hasLocation": true,
  "bioContains": "<string>",
  "locationContains": "<string>",
  "usernameContains": "<string>",
  "fromUser": "<string>",
  "toUser": "<string>",
  "mentioning": "<string>",
  "language": "<string>",
  "sinceDate": "<string>",
  "untilDate": "<string>",
  "mediaType": "<string>",
  "minFaves": 123,
  "minRetweets": 123,
  "minReplies": 123,
  "minQuotes": 123,
  "verifiedOnly": true,
  "replies": "<string>",
  "retweets": "<string>",
  "quotes": "<string>",
  "exactPhrase": "<string>",
  "excludeWords": "<string>",
  "anyWords": "<string>",
  "hashtags": "<string>",
  "cashtags": "<string>",
  "url": "<string>",
  "conversationId": "<string>",
  "inReplyToTweetId": "<string>",
  "quotesOfTweetId": "<string>",
  "retweetsOfTweetId": "<string>",
  "listId": "<string>",
  "place": "<string>",
  "placeCountry": "<string>",
  "pointRadius": "<string>",
  "boundingBox": "<string>",
  "advancedQuery": "<string>"
}
'

import requests

url = "https://xquik.com/api/v1/extractions"

payload = {
    "toolType": "<string>",
    "targetTweetId": "<string>",
    "targetUsername": "<string>",
    "targetCommunityId": "<string>",
    "targetListId": "<string>",
    "targetSpaceId": "<string>",
    "searchQuery": "<string>",
    "targetTweetIds": ["<string>"],
    "targetUsernames": ["<string>"],
    "targetCommunityIds": ["<string>"],
    "targetListIds": ["<string>"],
    "searchQueries": ["<string>"],
    "targets": [{}],
    "relationTargets": [{}],
    "queryType": "<string>",
    "resultsLimit": 123,
    "maxItemsPerTarget": 123,
    "maxPagesPerTarget": 123,
    "startCursor": "<string>",
    "dedupeAcrossTargets": True,
    "dedupeMode": "<string>",
    "overlapMode": True,
    "includeSearchTerms": True,
    "includeTargetMetadata": True,
    "collectionStrategy": "<string>",
    "scope": "<string>",
    "maxDepth": 123,
    "sort": "<string>",
    "excludeOriginalAuthor": True,
    "includeOriginalPost": True,
    "hasMediaOnly": True,
    "sinceTime": {},
    "untilTime": {},
    "minViews": 123,
    "minBookmarks": 123,
    "maxLikes": 123,
    "maxRetweets": 123,
    "maxReplies": 123,
    "maxQuotes": 123,
    "blueVerifiedOnly": True,
    "cardName": "<string>",
    "source": "<string>",
    "excludeSource": "<string>",
    "geocode": "<string>",
    "sinceId": "<string>",
    "maxId": "<string>",
    "near": "<string>",
    "within": "<string>",
    "withinTime": "<string>",
    "nativeRetweets": True,
    "safe": True,
    "news": True,
    "minFollowers": 123,
    "maxFollowers": 123,
    "minFollowing": 123,
    "maxFollowing": 123,
    "minPosts": 123,
    "maxPosts": 123,
    "minAccountAgeDays": 123,
    "verifiedType": "<string>",
    "hasWebsite": True,
    "hasLocation": True,
    "bioContains": "<string>",
    "locationContains": "<string>",
    "usernameContains": "<string>",
    "fromUser": "<string>",
    "toUser": "<string>",
    "mentioning": "<string>",
    "language": "<string>",
    "sinceDate": "<string>",
    "untilDate": "<string>",
    "mediaType": "<string>",
    "minFaves": 123,
    "minRetweets": 123,
    "minReplies": 123,
    "minQuotes": 123,
    "verifiedOnly": True,
    "replies": "<string>",
    "retweets": "<string>",
    "quotes": "<string>",
    "exactPhrase": "<string>",
    "excludeWords": "<string>",
    "anyWords": "<string>",
    "hashtags": "<string>",
    "cashtags": "<string>",
    "url": "<string>",
    "conversationId": "<string>",
    "inReplyToTweetId": "<string>",
    "quotesOfTweetId": "<string>",
    "retweetsOfTweetId": "<string>",
    "listId": "<string>",
    "place": "<string>",
    "placeCountry": "<string>",
    "pointRadius": "<string>",
    "boundingBox": "<string>",
    "advancedQuery": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    toolType: '<string>',
    targetTweetId: '<string>',
    targetUsername: '<string>',
    targetCommunityId: '<string>',
    targetListId: '<string>',
    targetSpaceId: '<string>',
    searchQuery: '<string>',
    targetTweetIds: ['<string>'],
    targetUsernames: ['<string>'],
    targetCommunityIds: ['<string>'],
    targetListIds: ['<string>'],
    searchQueries: ['<string>'],
    targets: [{}],
    relationTargets: [{}],
    queryType: '<string>',
    resultsLimit: 123,
    maxItemsPerTarget: 123,
    maxPagesPerTarget: 123,
    startCursor: '<string>',
    dedupeAcrossTargets: true,
    dedupeMode: '<string>',
    overlapMode: true,
    includeSearchTerms: true,
    includeTargetMetadata: true,
    collectionStrategy: '<string>',
    scope: '<string>',
    maxDepth: 123,
    sort: '<string>',
    excludeOriginalAuthor: true,
    includeOriginalPost: true,
    hasMediaOnly: true,
    sinceTime: {},
    untilTime: {},
    minViews: 123,
    minBookmarks: 123,
    maxLikes: 123,
    maxRetweets: 123,
    maxReplies: 123,
    maxQuotes: 123,
    blueVerifiedOnly: true,
    cardName: '<string>',
    source: '<string>',
    excludeSource: '<string>',
    geocode: '<string>',
    sinceId: '<string>',
    maxId: '<string>',
    near: '<string>',
    within: '<string>',
    withinTime: '<string>',
    nativeRetweets: true,
    safe: true,
    news: true,
    minFollowers: 123,
    maxFollowers: 123,
    minFollowing: 123,
    maxFollowing: 123,
    minPosts: 123,
    maxPosts: 123,
    minAccountAgeDays: 123,
    verifiedType: '<string>',
    hasWebsite: true,
    hasLocation: true,
    bioContains: '<string>',
    locationContains: '<string>',
    usernameContains: '<string>',
    fromUser: '<string>',
    toUser: '<string>',
    mentioning: '<string>',
    language: '<string>',
    sinceDate: '<string>',
    untilDate: '<string>',
    mediaType: '<string>',
    minFaves: 123,
    minRetweets: 123,
    minReplies: 123,
    minQuotes: 123,
    verifiedOnly: true,
    replies: '<string>',
    retweets: '<string>',
    quotes: '<string>',
    exactPhrase: '<string>',
    excludeWords: '<string>',
    anyWords: '<string>',
    hashtags: '<string>',
    cashtags: '<string>',
    url: '<string>',
    conversationId: '<string>',
    inReplyToTweetId: '<string>',
    quotesOfTweetId: '<string>',
    retweetsOfTweetId: '<string>',
    listId: '<string>',
    place: '<string>',
    placeCountry: '<string>',
    pointRadius: '<string>',
    boundingBox: '<string>',
    advancedQuery: '<string>'
  })
};

fetch('https://xquik.com/api/v1/extractions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://xquik.com/api/v1/extractions"

	payload := strings.NewReader("{\n  \"toolType\": \"<string>\",\n  \"targetTweetId\": \"<string>\",\n  \"targetUsername\": \"<string>\",\n  \"targetCommunityId\": \"<string>\",\n  \"targetListId\": \"<string>\",\n  \"targetSpaceId\": \"<string>\",\n  \"searchQuery\": \"<string>\",\n  \"targetTweetIds\": [\n    \"<string>\"\n  ],\n  \"targetUsernames\": [\n    \"<string>\"\n  ],\n  \"targetCommunityIds\": [\n    \"<string>\"\n  ],\n  \"targetListIds\": [\n    \"<string>\"\n  ],\n  \"searchQueries\": [\n    \"<string>\"\n  ],\n  \"targets\": [\n    {}\n  ],\n  \"relationTargets\": [\n    {}\n  ],\n  \"queryType\": \"<string>\",\n  \"resultsLimit\": 123,\n  \"maxItemsPerTarget\": 123,\n  \"maxPagesPerTarget\": 123,\n  \"startCursor\": \"<string>\",\n  \"dedupeAcrossTargets\": true,\n  \"dedupeMode\": \"<string>\",\n  \"overlapMode\": true,\n  \"includeSearchTerms\": true,\n  \"includeTargetMetadata\": true,\n  \"collectionStrategy\": \"<string>\",\n  \"scope\": \"<string>\",\n  \"maxDepth\": 123,\n  \"sort\": \"<string>\",\n  \"excludeOriginalAuthor\": true,\n  \"includeOriginalPost\": true,\n  \"hasMediaOnly\": true,\n  \"sinceTime\": {},\n  \"untilTime\": {},\n  \"minViews\": 123,\n  \"minBookmarks\": 123,\n  \"maxLikes\": 123,\n  \"maxRetweets\": 123,\n  \"maxReplies\": 123,\n  \"maxQuotes\": 123,\n  \"blueVerifiedOnly\": true,\n  \"cardName\": \"<string>\",\n  \"source\": \"<string>\",\n  \"excludeSource\": \"<string>\",\n  \"geocode\": \"<string>\",\n  \"sinceId\": \"<string>\",\n  \"maxId\": \"<string>\",\n  \"near\": \"<string>\",\n  \"within\": \"<string>\",\n  \"withinTime\": \"<string>\",\n  \"nativeRetweets\": true,\n  \"safe\": true,\n  \"news\": true,\n  \"minFollowers\": 123,\n  \"maxFollowers\": 123,\n  \"minFollowing\": 123,\n  \"maxFollowing\": 123,\n  \"minPosts\": 123,\n  \"maxPosts\": 123,\n  \"minAccountAgeDays\": 123,\n  \"verifiedType\": \"<string>\",\n  \"hasWebsite\": true,\n  \"hasLocation\": true,\n  \"bioContains\": \"<string>\",\n  \"locationContains\": \"<string>\",\n  \"usernameContains\": \"<string>\",\n  \"fromUser\": \"<string>\",\n  \"toUser\": \"<string>\",\n  \"mentioning\": \"<string>\",\n  \"language\": \"<string>\",\n  \"sinceDate\": \"<string>\",\n  \"untilDate\": \"<string>\",\n  \"mediaType\": \"<string>\",\n  \"minFaves\": 123,\n  \"minRetweets\": 123,\n  \"minReplies\": 123,\n  \"minQuotes\": 123,\n  \"verifiedOnly\": true,\n  \"replies\": \"<string>\",\n  \"retweets\": \"<string>\",\n  \"quotes\": \"<string>\",\n  \"exactPhrase\": \"<string>\",\n  \"excludeWords\": \"<string>\",\n  \"anyWords\": \"<string>\",\n  \"hashtags\": \"<string>\",\n  \"cashtags\": \"<string>\",\n  \"url\": \"<string>\",\n  \"conversationId\": \"<string>\",\n  \"inReplyToTweetId\": \"<string>\",\n  \"quotesOfTweetId\": \"<string>\",\n  \"retweetsOfTweetId\": \"<string>\",\n  \"listId\": \"<string>\",\n  \"place\": \"<string>\",\n  \"placeCountry\": \"<string>\",\n  \"pointRadius\": \"<string>\",\n  \"boundingBox\": \"<string>\",\n  \"advancedQuery\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "toolType": "<string>",
  "status": "<string>"
}

​Query parameters

​Headers

​Body

​Single targets

​Collection targets

​Collection controls

​Reply collection

​Tweet result filters

​Profile result filters

​Tweet search filters

​Tool types

Tweet target

Username target

Community target

Search query

List target

Space target

​Response

​202 Accepted

​400 Invalid input

​400 Invalid tool type

​401 Unauthenticated

​402 Insufficient credits

​404 Not found

​424 X API dependency failed

​429 Rate limited

​502 X API unavailable

​Run receipt handoff

Receipt fields

Poll results

Find later

Export after completion

Query parameters

Headers

Body

Single targets

Collection targets

Collection controls

Reply collection

Tweet result filters

Profile result filters

Tweet search filters

Tool types

Response

202 Accepted

400 Invalid input

400 Invalid tool type

401 Unauthenticated

402 Insufficient credits

404 Not found

424 X API dependency failed

429 Rate limited

502 X API unavailable

Run receipt handoff