Sign in
Extractions

Run extraction

post/extractions

Request body

toolType'article_extractor' | 'community_extractor' | 'community_moderator_explorer' | 'community_post_extractor' | 'community_search' | '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' | 'verified_follower_explorer' required

Identifier for the extraction tool used to run a job.

targetTweetIdstring
targetUsernamestring
targetCommunityIdstring
targetListIdstring
targetSpaceIdstring
searchQuerystring
exactPhrasestring

Exact phrase to match (tweet_search_extractor)

excludeWordsstring

Words to exclude from results (tweet_search_extractor)

advancedQuerystring

Raw advanced search query appended as-is (tweet_search_extractor)

Example request

{
  "toolType": "follower_explorer",
  "targetTweetId": "1234567890",
  "targetUsername": "elonmusk",
  "targetCommunityId": "1500000000000000000",
  "targetListId": "1234567890",
  "targetSpaceId": "1vOGwMdBqpwGB",
  "searchQuery": "AI trends 2025",
  "exactPhrase": "artificial intelligence",
  "excludeWords": "spam",
  "advancedQuery": "min_faves:100"
}

Response

Extraction started

idstring required
toolType'article_extractor' | 'community_extractor' | 'community_moderator_explorer' | 'community_post_extractor' | 'community_search' | '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' | 'verified_follower_explorer' required

Identifier for the extraction tool used to run a job.

status'running' required

Example response

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

Changes