---
title: "Estimate extraction cost"
method: POST
path: "/api/v1/extractions/estimate"
tags: ["Extractions"]
---

# Estimate extraction cost

`POST /api/v1/extractions/estimate`

Estimate extraction cost.

## Request body

- object
  - `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.
  - `targetTweetId` string
  - `targetUsername` string
  - `targetCommunityId` string — Community ID used to price community_post_extractor or community_search.
  - `targetListId` string — List ID used to price list_follower_explorer, list_member_extractor, or list_post_extractor.
  - `targetSpaceId` string — Space ID used to price space_explorer.
  - `resultsLimit` integer — Maximum number of results to estimate. When set, the estimate caps projected results to this value.
  - `searchQuery` string — Query used to price tweet_search_extractor or community_search.
  - `fromUser` string — Estimate only tweets from this author username (tweet_search_extractor)
  - `toUser` string — Estimate replies sent to this username (tweet_search_extractor)
  - `mentioning` string — Estimate tweets mentioning this username (tweet_search_extractor)
  - `language` string — Language code used for estimate filtering (tweet_search_extractor)
  - `sinceDate` string, date — Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
  - `untilDate` string, date — Estimate end date in YYYY-MM-DD format (tweet_search_extractor)
  - `mediaType` 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none' — Media type used for estimate filtering (tweet_search_extractor)
  - `minFaves` integer — Minimum likes threshold for estimated results (tweet_search_extractor)
  - `minRetweets` integer — Minimum retweets threshold for estimated results (tweet_search_extractor)
  - `minReplies` integer — Minimum replies threshold for estimated results (tweet_search_extractor)
  - `minQuotes` integer — Minimum quote count threshold for estimated results (tweet_search_extractor)
  - `verifiedOnly` boolean — Estimate only verified authors (tweet_search_extractor)
  - `replies` 'include' | 'exclude' | 'only' — Reply mode used for estimation (tweet_search_extractor)
  - `retweets` 'include' | 'exclude' | 'only' — Retweet mode used for estimation (tweet_search_extractor)
  - `quotes` 'include' | 'exclude' | 'only' — Quote mode used for estimation (tweet_search_extractor)
  - `exactPhrase` string — Exact phrase filter for search estimation
  - `excludeWords` string — Words or quoted phrases excluded from estimated results. Separate with spaces, commas, or lines.
  - `anyWords` string — Alternative words or quoted phrases for estimated results. Separate with spaces, commas, or lines.
  - `hashtags` string — Hashtags applied to the estimate, separated by spaces, commas, or lines.
  - `cashtags` string — Cashtags applied to the estimate, separated by spaces, commas, or lines.
  - `url` string — URL substring or domain filter used for estimation (tweet_search_extractor)
  - `conversationId` string — Conversation ID filter used for estimation (tweet_search_extractor)
  - `inReplyToTweetId` string — Estimate only replies to this tweet ID (tweet_search_extractor)
  - `quotesOfTweetId` string — Estimate only quotes of this tweet ID (tweet_search_extractor)
  - `retweetsOfTweetId` string — Estimate only retweets of this tweet ID (tweet_search_extractor)
  - `listId` string — Estimate search results within this list ID (tweet_search_extractor)
  - `place` string — Estimate search results within this place ID (tweet_search_extractor)
  - `placeCountry` string — Estimate search results within this country code (tweet_search_extractor)
  - `pointRadius` string — Geo point radius used for estimation, e.g. -73.99 40.73 25mi (tweet_search_extractor)
  - `boundingBox` string — Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
  - `advancedQuery` string — Raw advanced query string appended to the estimate (tweet_search_extractor)

## Response `200`

Extraction estimate

- object
  - `estimatedResults` integer, required
  - `creditsRequired` string, required
  - `creditsAvailable` string, required
  - `allowed` boolean, required
  - `source` 'followers' | 'following' | 'paginationCap' | 'posts' | 'quoteCount' | 'replyCount' | 'resultsLimit' | 'retweetCount' | 'unknown', required
  - `resolvedXUserId` string

## Other responses

- `400` — Invalid input
- `401` — Unauthenticated
- `402` — Payment required. Fixed-price direct MPP requests return a Machine Payments Protocol problem document and a WWW-Authenticate challenge. Authenticated X data requests return balances and explicit Stripe checkout-creation actions. Guest paid-read keys receive only the accountless guest top-up action. Direct MPP challenges also advertise the Stripe wallet action. Other authenticated endpoints return a legacy error shape. A failed request never creates checkout. Create checkout only after the user confirms a payment option.
- `404` — Not found
- `429` — Xquik tier rate limit exceeded. The response includes a `Retry-After` header with the number of seconds to wait before retrying.
- `default` — Unexpected error.

---

[API](https://skmtc.net/xquik-dev/apis/xquik-api-2.md) · [All operations](https://skmtc.net/xquik-dev/apis/xquik-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xquik-dev/xquik-api-2/versions/c70f0e286159/schema)