Extractions

Changed on

Estimates extraction cost without creating a job.

post/api/v1/extractions/estimate

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/extractions/estimate
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

toolType'article_extractor' | 'community_extractor' | 'community_moderator_explorer' | 'community_post_extractor' | 'community_search' | 'favoriters' | 'follower_explorer' | 'following_explorer' | 'list_follower_explorer' | 'list_member_extractor' | 'list_post_extractor' | 'mention_extractor' | 'people_search' | 'post_extractor' | 'quote_extractor' | 'reply_extractor' | 'repost_extractor' | 'space_explorer' | 'thread_extractor' | 'tweet_search_extractor' | 'user_likes' | 'user_media' | 'verified_follower_explorer' required

Identifier for the extraction tool used to run a job.

targetTweetIdstring
targetUsernamestring
targetCommunityIdstring

Required for community_post_extractor & community_search.

targetListIdstring

Required for list_follower_explorer, list_member_extractor & list_post_extractor.

targetSpaceIdstring

Required for space_explorer. X names a Space's hosts & speakers without counts or bio, so Xquik reads each one's profile. Rows carry it, & profile filters such as minFollowers check it.

targetTweetIdsstring[]

Tweet IDs processed as 1 collection job.

targetUsernamesstring[]

Usernames processed concurrently in 1 job. With tweet_search_extractor, each username collects posts. Post & media jobs skip a protected profile & end with partial_failure.

targetCommunityIdsstring[]

Community IDs processed as 1 collection job.

targetListIdsstring[]

List IDs processed as 1 collection job.

searchQueriesstring[]

Search queries processed as 1 collection job. Each follows the rules of searchQuery, its structured fields & 512-character limit included.

queryType'Latest' | 'Top' | 'Both' | 'relevance'

Use Top for engagement. The relevance alias maps to Top.

maxItemsPerTargetinteger

Maximum results collected for each target.

maxPagesPerTargetinteger

Reply pages collected for each target.

startCursorstring

Resume 1 reply target from this cursor.

dedupeAcrossTargetsboolean

Merge duplicate results across collection targets.

dedupeMode'none' | 'first' | 'merge'

Keep target duplicates, first rows, or merged overlap.

overlapModeboolean

Shortcut for dedupeMode=merge.

includeSearchTermsboolean

Add matching search terms to collection metadata.

includeTargetMetadataboolean

Add source target metadata to each result.

enrichProfilesboolean

Add each user's full profile to follower_explorer, following_explorer, verified_follower_explorer, people_search & repost_extractor rows. Jobs take longer.

collectionStrategy'auto' | 'complete' | 'direct' | 'search' | 'thread'

Reply collection strategy.

scope'all' | 'direct' | 'nested'

Reply depth scope.

maxDepthinteger

Maximum nested reply depth.

sort'relevance' | 'latest' | 'oldest' | 'likes'

Reply result order.

excludeOriginalAuthorboolean

Exclude replies from the source author.

includeOriginalPostboolean

Include the source post in reply results.

hasMediaOnlyboolean

Return only replies with media.

minViewsinteger

Tweet or Community search minimum views.

minBookmarksinteger

Minimum Tweet bookmark count.

maxLikesinteger

Maximum Tweet like count.

maxRetweetsinteger

Maximum Tweet repost count.

maxRepliesinteger

Maximum Tweet reply count.

maxQuotesinteger

Maximum Tweet quote count.

blueVerifiedOnlyboolean

Return only Blue-verified Tweet authors. On a tool that returns users, return only profiles X marks as blue verified.

cardNamestring

Require Tweet cards whose name matches this value.

sourcestring

X search no longer supports source. An extraction with it answers 424 search_unavailable & charges nothing.

excludeSourcestring

X search ignores excludeSource, so an extraction with it returns unfiltered rows. Its answers carry Deprecation & Sunset headers. From 2027-01-15 an extraction with it answers 424 search_unavailable & charges nothing.

geocodestring

X search no longer supports geocode. An extraction with it answers 424 search_unavailable & charges nothing.

sinceIdstring

Require Tweet IDs above this ID.

maxIdstring

Require Tweet IDs at or below this ID.

nearstring

Restrict Tweet search to this place name. A country, such as Brazil, works like placeCountry. A city keeps Tweets about it.

withinstring

X search no longer supports within. An extraction with it answers 424 search_unavailable & charges nothing. Use near alone.

withinTimestring

Restrict Tweets to this recent time window.

nativeRetweetsboolean

Tweet or Community search native reposts.

safeboolean

Apply safe-search filtering to Tweet results.

newsboolean

X search no longer supports filter:news. An extraction with news true answers 424 search_unavailable & charges nothing.

minFollowersinteger

Minimum follower count for profile results.

maxFollowersinteger

Maximum follower count for profile results.

minFollowinginteger

Minimum following count for profile results.

maxFollowinginteger

Maximum following count for profile results.

minPostsinteger

Minimum post count for profile results.

maxPostsinteger

Maximum post count for profile results.

minAccountAgeDaysinteger

Minimum profile age in days.

verifiedTypestring

Exact profile verification type.

hasWebsiteboolean

Require a profile website.

hasLocationboolean

Require a profile location.

hasEmailboolean

Require an email the profile publishes.

businessEmailOnlyboolean

Require an email the profile publishes outside free webmail, such as Gmail.

emailDomainsstring

Require an email at one of these domains. Separate domains with commas. Subdomains match.

bioContainsstring

Match any bio term, ignoring case. Separate terms with commas or lines.

locationContainsstring

Required profile location text.

usernameContainsstring

Required username text.

resultsLimitinteger

Maximum unique results to emit. Xquik bills emitted results, not this upper bound.

searchQuerystring

Required for tweet_search_extractor, people_search & community_search. tweet_search_extractor adds the structured search fields, such as fromUser & minFaves, to this query. X searches up to 512 characters. A longer tweet or people search answers 400, counted with the added fields.

fromUserstring

Filter by author username (tweet_search_extractor)

toUserstring

Replies to this username (tweet_search_extractor).

mentioningstring

Mentions this username (tweet_search_extractor).

languagestring

Tweet or Community search language.

sinceDatestring date

Tweet or Community search start date.

untilDatestring date

Tweet or Community search end date.

mediaType'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none'

Tweet or Community search media.

minFavesinteger

Tweet or Community search minimum likes.

minRetweetsinteger

Tweet or Community search minimum reposts.

minRepliesinteger

Tweet or Community search minimum replies.

minQuotesinteger

Minimum quote count threshold (tweet_search_extractor)

verifiedOnlyboolean

Tweet or Community search verified authors.

replies'include' | 'exclude' | 'only'

Choose whether tweet search includes, excludes, or isolates replies.

retweets'include' | 'exclude' | 'only'

Choose whether tweet search includes, excludes, or isolates reposts.

quotes'include' | 'exclude' | 'only'

Choose whether tweet search includes, excludes, or isolates quotes.

exactPhrasestring

Exact phrase to match (tweet_search_extractor)

excludeWordsstring

Excluded terms or phrases (tweet_search_extractor).

anyWordsstring

Any matching term or phrase (tweet_search_extractor).

hashtagsstring

Matching hashtags (tweet_search_extractor).

cashtagsstring

Matching cashtags (tweet_search_extractor).

urlstring

URL substring or domain filter (tweet_search_extractor)

conversationIdstring

Conversation ID filter (tweet_search_extractor)

inReplyToTweetIdstring

Only replies to this tweet ID (tweet_search_extractor)

quotesOfTweetIdstring

Only quotes of this tweet ID (tweet_search_extractor)

retweetsOfTweetIdstring

Only retweets of this tweet ID (tweet_search_extractor)

listIdstring

Search within a list ID (tweet_search_extractor)

placestring

Search within a place ID (tweet_search_extractor)

placeCountrystring

Search within a country code (tweet_search_extractor)

pointRadiusstring

Geo point radius, such as -73.99 40.73 25mi (tweet_search_extractor)

boundingBoxstring

Geo bounding box, such as -74.1 40.6 -73.9 40.8 (tweet_search_extractor)

advancedQuerystring

Raw advanced search query appended as-is (tweet_search_extractor)

Example request

{
  "toolType": "follower_explorer",
  "targetUsername": "elonmusk"
}

Response

Extraction estimate

allowedboolean required

Whether the balance covers the full estimate.

creditsAvailablestring required
creditsRequiredstring required
estimatedResultsinteger required

The row count the credit estimate uses. It does not say how many rows exist.

resolvedXUserIdstring

Resolved X user ID from count-based profile estimates.

source'followers' | 'following' | 'collection' | 'likeCount' | 'paginationCap' | 'quoteCount' | 'replyCount' | 'resultsLimit' | 'retweetCount' | 'unknown' required

Example response

{
  "allowed": true,
  "creditsAvailable": "50000",
  "creditsRequired": "500",
  "estimatedResults": 500,
  "resolvedXUserId": "123456",
  "source": "replyCount"
}

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status