Class: XTwitterScraper::Resources::Extractions

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/extractions.rb,
sig/x_twitter_scraper/resources/extractions.rbs

Overview

Bulk data extraction (23 tool types)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Extractions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Extractions.

Parameters:



600
601
602
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 600

def initialize(client:)
  @client = client
end

Instance Method Details

#estimate_cost(tool_type:, advanced_query: nil, any_words: nil, bio_contains: nil, blue_verified_only: nil, bounding_box: nil, card_name: nil, cashtags: nil, collection_strategy: nil, conversation_id: nil, dedupe_across_targets: nil, dedupe_mode: nil, exact_phrase: nil, exclude_original_author: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, has_location: nil, has_media_only: nil, has_website: nil, include_original_post: nil, include_search_terms: nil, include_target_metadata: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, location_contains: nil, max_depth: nil, max_followers: nil, max_following: nil, max_id: nil, max_items_per_target: nil, max_likes: nil, max_pages_per_target: nil, max_posts: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_account_age_days: nil, min_bookmarks: nil, min_faves: nil, min_followers: nil, min_following: nil, min_posts: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, overlap_mode: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, relation_targets: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, scope: nil, search_queries: nil, search_query: nil, since_date: nil, since_id: nil, since_time: nil, sort: nil, source: nil, start_cursor: nil, target_community_id: nil, target_community_ids: nil, target_list_id: nil, target_list_ids: nil, targets: nil, target_space_id: nil, target_tweet_id: nil, target_tweet_ids: nil, target_username: nil, target_usernames: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, username_contains: nil, verified_only: nil, verified_type: nil, within: nil, within_time: nil, request_options: {}) ⇒ XTwitterScraper::Models::ExtractionEstimateCostResponse

Some parameter documentations has been truncated, see Models::ExtractionEstimateCostParams for more details.

Estimate extraction cost

Parameters:

  • tool_type (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::ToolType) —

    Identifier for the extraction tool used to run a job.

  • advanced_query (String) —

    Raw advanced search query appended as-is (tweet_search_extractor)

  • any_words (String) —

    Words or quoted phrases where any one can match. Separate with spaces, commas, o

  • bio_contains (String) —

    Bio terms separated by commas or lines.

  • blue_verified_only (Boolean) —

    Return only Blue-verified Tweet authors.

  • bounding_box (String) —

    Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)

  • card_name (String) —

    Match the Tweet card name.

  • cashtags (String) —

    Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)

  • collection_strategy (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::CollectionStrategy) —

    Reply collection strategy.

  • conversation_id (String) —

    Conversation ID filter (tweet_search_extractor)

  • dedupe_across_targets (Boolean) —

    Merge duplicate results across collection targets.

  • dedupe_mode (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::DedupeMode) —

    Keep target duplicates, first rows, or merged overlap.

  • exact_phrase (String) —

    Exact phrase to match (tweet_search_extractor)

  • exclude_original_author (Boolean) —

    Exclude replies from the source author.

  • exclude_source (String) —

    Exclude a source application.

  • exclude_words (String) —

    Words or quoted phrases to exclude. Separate with spaces, commas, or lines. (twe

  • from_user (String) —

    Filter by author username (tweet_search_extractor)

  • geocode (String) —

    Match latitude, longitude, and radius.

  • hashtags (String) —

    Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)

  • has_location (Boolean) —

    Require a profile location.

  • has_media_only (Boolean) —

    Return only replies with media.

  • has_website (Boolean) —

    Require a profile website.

  • include_original_post (Boolean) —

    Include the source post in reply results.

  • include_search_terms (Boolean) —

    Add matching search terms to collection metadata.

  • include_target_metadata (Boolean) —

    Add source target metadata to each result.

  • in_reply_to_tweet_id (String) —

    Only replies to this tweet ID (tweet_search_extractor)

  • language (String) —

    Language code filter (tweet_search_extractor)

  • list_id (String) —

    Search within a list ID (tweet_search_extractor)

  • location_contains (String) —

    Required profile location text.

  • max_depth (Integer) —

    Maximum nested reply depth.

  • max_followers (Integer) —

    Maximum follower count for profile results.

  • max_following (Integer) —

    Maximum following count for profile results.

  • max_id (String) —

    Return Tweets older than this Tweet ID.

  • max_items_per_target (Integer) —

    Maximum results collected for each target.

  • max_likes (Integer) —

    Maximum Tweet like count.

  • max_pages_per_target (Integer) —

    Reply pages collected for each target.

  • max_posts (Integer) —

    Maximum post count for profile results.

  • max_quotes (Integer) —

    Maximum Tweet quote count.

  • max_replies (Integer) —

    Maximum Tweet reply count.

  • max_retweets (Integer) —

    Maximum Tweet repost count.

  • media_type (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::MediaType) —

    Media type filter (tweet_search_extractor)

  • mentioning (String) —

    Filter tweets mentioning a username (tweet_search_extractor)

  • min_account_age_days (Integer) —

    Minimum profile age in days.

  • min_bookmarks (Integer) —

    Minimum Tweet bookmark count.

  • min_faves (Integer) —

    Minimum likes threshold (tweet_search_extractor)

  • min_followers (Integer) —

    Minimum follower count for profile results.

  • min_following (Integer) —

    Minimum following count for profile results.

  • min_posts (Integer) —

    Minimum post count for profile results.

  • min_quotes (Integer) —

    Minimum quote count threshold (tweet_search_extractor)

  • min_replies (Integer) —

    Minimum replies threshold (tweet_search_extractor)

  • min_retweets (Integer) —

    Minimum retweets threshold (tweet_search_extractor)

  • min_views (Integer) —

    Minimum Tweet view count.

  • native_retweets (Boolean) —

    Only return native reposts.

  • near (String) —

    Match a place name.

  • news (Boolean) —

    Only return news results.

  • overlap_mode (Boolean) —

    Shortcut for dedupeMode=merge.

  • place (String) —

    Search within a place ID (tweet_search_extractor)

  • place_country (String) —

    Search within a country code (tweet_search_extractor)

  • point_radius (String) —

    Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)

  • query_type (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::QueryType) —

    Search ranking applied to every query.

  • quotes (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Quotes) —

    Quote mode (tweet_search_extractor)

  • quotes_of_tweet_id (String) —

    Only quotes of this tweet ID (tweet_search_extractor)

  • relation_targets (Array<XTwitterScraper::Models::ExtractionEstimateCostParams::RelationTarget>) —

    Profile relations processed within one job.

  • replies (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Replies) —

    Reply mode (tweet_search_extractor)

  • results_limit (Integer) —

    Maximum number of results to extract. When set, the extraction stops after reach

  • retweets (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Retweets) —

    Retweet mode (tweet_search_extractor)

  • retweets_of_tweet_id (String) —

    Only retweets of this tweet ID (tweet_search_extractor)

  • safe (Boolean) —

    Enable the safe-search filter.

  • scope (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Scope) —

    Reply depth scope.

  • search_queries (Array<String>) —

    Search queries processed as one collection job.

  • search_query (String) —

    Required for tweet_search_extractor & community_search.

  • since_date (Date) —

    Start date YYYY-MM-DD (tweet_search_extractor)

  • since_id (String) —

    Return Tweets newer than this Tweet ID.

  • since_time (Time, Integer) —

    Reply start time as ISO 8601 or Unix seconds.

  • sort (Symbol, XTwitterScraper::Models::ExtractionEstimateCostParams::Sort) —

    Reply result order.

  • source (String) —

    Match the source application.

  • start_cursor (String) —

    Resume one reply target from this cursor.

  • target_community_id (String) —

    Required for community_post_extractor & community_search.

  • target_community_ids (Array<String>) —

    Community IDs processed as one collection job.

  • target_list_id (String) —

    Required for list_follower_explorer, list_member_extractor & list_post_extractor

  • target_list_ids (Array<String>) —

    List IDs processed as one collection job.

  • targets (Array<String, XTwitterScraper::Models::ExtractionEstimateCostParams::Target::UnionMember1>) —

    Mixed targets auto-routed within one job.

  • target_space_id (String) —

    Required for space_explorer.

  • target_tweet_id (String)
  • target_tweet_ids (Array<String>) —

    Tweet IDs processed as one collection job.

  • target_username (String)
  • target_usernames (Array<String>) —

    Usernames processed as one collection job.

  • to_user (String) —

    Filter replies sent to a username (tweet_search_extractor)

  • until_date (Date) —

    End date YYYY-MM-DD (tweet_search_extractor)

  • until_time (Time, Integer) —

    Reply end time as ISO 8601 or Unix seconds.

  • url (String) —

    URL substring or domain filter (tweet_search_extractor)

  • username_contains (String) —

    Required username text.

  • verified_only (Boolean) —

    Only verified authors (tweet_search_extractor)

  • verified_type (String) —

    Exact profile verification type.

  • within (String) —

    Set the radius for the near filter.

  • within_time (String) —

    Match Tweets inside a recent time window.

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



287
288
289
290
291
292
293
294
295
296
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 287

def estimate_cost(params)
  parsed, options = XTwitterScraper::ExtractionEstimateCostParams.dump_request(params)
  @client.request(
    method: :post,
    path: "extractions/estimate",
    body: parsed,
    model: XTwitterScraper::Models::ExtractionEstimateCostResponse,
    options: options
  )
end

#export_results(id, format_:, has_description: nil, has_location: nil, has_media: nil, lang: nil, max_followers: nil, max_following: nil, max_posts: nil, min_followers: nil, min_following: nil, min_likes: nil, min_posts: nil, min_replies: nil, min_retweets: nil, min_views: nil, search: nil, since_date: nil, until_date: nil, verified: nil, request_options: {}) ⇒ StringIO

Export extraction results

Parameters:

  • id (String) —

    Extraction public ID

  • format_ (Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format) —

    Export file format

  • has_description (Boolean) —

    Require a non-empty description.

  • has_location (Boolean) —

    Require a non-empty location.

  • has_media (Boolean) —

    Require media.

  • lang (String) —

    Filter by language code.

  • max_followers (Integer) —

    Maximum follower count.

  • max_following (Integer) —

    Maximum following count.

  • max_posts (Integer) —

    Maximum post count.

  • min_followers (Integer) —

    Minimum follower count.

  • min_following (Integer) —

    Minimum following count.

  • min_likes (Integer) —

    Minimum like count.

  • min_posts (Integer) —

    Minimum post count.

  • min_replies (Integer) —

    Minimum reply count.

  • min_retweets (Integer) —

    Minimum repost count.

  • min_views (Integer) —

    Minimum view count.

  • search (String) —

    Search exported result text.

  • since_date (Date) —

    Include results on or after this date.

  • until_date (Date) —

    Include results on or before this date.

  • verified (Boolean) —

    Filter by verified status.

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (StringIO)

See Also:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 347

def export_results(id, params)
  parsed, options = XTwitterScraper::ExtractionExportResultsParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["extractions/%1$s/export", id],
    query: query.transform_keys(
      format_: "format",
      has_description: "hasDescription",
      has_location: "hasLocation",
      has_media: "hasMedia",
      max_followers: "maxFollowers",
      max_following: "maxFollowing",
      max_posts: "maxPosts",
      min_followers: "minFollowers",
      min_following: "minFollowing",
      min_likes: "minLikes",
      min_posts: "minPosts",
      min_replies: "minReplies",
      min_retweets: "minRetweets",
      min_views: "minViews",
      since_date: "sinceDate",
      until_date: "untilDate"
    ),
    headers: {"accept" => "application/octet-stream"},
    model: StringIO,
    options: options
  )
end

#list(cursor: nil, limit: nil, status: nil, tool_type: nil, request_options: {}) ⇒ XTwitterScraper::Models::ExtractionListResponse

Some parameter documentations has been truncated, see Models::ExtractionListParams for more details.

List extraction jobs

Parameters:

Returns:

See Also:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 71

def list(params = {})
  parsed, options = XTwitterScraper::ExtractionListParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "extractions",
    query: query.transform_keys(tool_type: "toolType"),
    model: XTwitterScraper::Models::ExtractionListResponse,
    options: options
  )
end

#retrieve(id, cursor: nil, field_style: nil, include_raw: nil, limit: nil, output_mode: nil, output_preset: nil, request_options: {}) ⇒ XTwitterScraper::Models::ExtractionRetrieveResponse

Get extraction results

Parameters:

Returns:

See Also:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 34

def retrieve(id, params = {})
  parsed, options = XTwitterScraper::ExtractionRetrieveParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["extractions/%1$s", id],
    query: query.transform_keys(
      field_style: "fieldStyle",
      include_raw: "includeRaw",
      output_mode: "outputMode",
      output_preset: "outputPreset"
    ),
    model: XTwitterScraper::Models::ExtractionRetrieveResponse,
    options: options
  )
end

#run(tool_type:, dry_run: nil, advanced_query: nil, any_words: nil, bio_contains: nil, blue_verified_only: nil, bounding_box: nil, card_name: nil, cashtags: nil, collection_strategy: nil, conversation_id: nil, dedupe_across_targets: nil, dedupe_mode: nil, exact_phrase: nil, exclude_original_author: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, has_location: nil, has_media_only: nil, has_website: nil, include_original_post: nil, include_search_terms: nil, include_target_metadata: nil, in_reply_to_tweet_id: nil, language: nil, list_id: nil, location_contains: nil, max_depth: nil, max_followers: nil, max_following: nil, max_id: nil, max_items_per_target: nil, max_likes: nil, max_pages_per_target: nil, max_posts: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_account_age_days: nil, min_bookmarks: nil, min_faves: nil, min_followers: nil, min_following: nil, min_posts: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, overlap_mode: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, relation_targets: nil, replies: nil, results_limit: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, scope: nil, search_queries: nil, search_query: nil, since_date: nil, since_id: nil, since_time: nil, sort: nil, source: nil, start_cursor: nil, target_community_id: nil, target_community_ids: nil, target_list_id: nil, target_list_ids: nil, targets: nil, target_space_id: nil, target_tweet_id: nil, target_tweet_ids: nil, target_username: nil, target_usernames: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, username_contains: nil, verified_only: nil, verified_type: nil, within: nil, within_time: nil, request_options: {}) ⇒ XTwitterScraper::Models::ExtractionRunResponse

Some parameter documentations has been truncated, see Models::ExtractionRunParams for more details.

Run extraction

Parameters:

  • tool_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::ToolType) —

    Body param: Identifier for the extraction tool used to run a job.

  • dry_run (Boolean) —

    Query param: Estimate cost without creating an extraction.

  • advanced_query (String) —

    Body param: Raw advanced search query appended as-is (tweet_search_extractor)

  • any_words (String) —

    Body param: Words or quoted phrases where any one can match. Separate with space

  • bio_contains (String) —

    Body param: Bio terms separated by commas or lines.

  • blue_verified_only (Boolean) —

    Body param: Return only Blue-verified Tweet authors.

  • bounding_box (String) —

    Body param: Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor

  • card_name (String) —

    Body param: Match the Tweet card name.

  • cashtags (String) —

    Body param: Cashtags separated by spaces, commas, or lines. (tweet_search_extrac

  • collection_strategy (Symbol, XTwitterScraper::Models::ExtractionRunParams::CollectionStrategy) —

    Body param: Reply collection strategy.

  • conversation_id (String) —

    Body param: Conversation ID filter (tweet_search_extractor)

  • dedupe_across_targets (Boolean) —

    Body param: Merge duplicate results across collection targets.

  • dedupe_mode (Symbol, XTwitterScraper::Models::ExtractionRunParams::DedupeMode) —

    Body param: Keep target duplicates, first rows, or merged overlap.

  • exact_phrase (String) —

    Body param: Exact phrase to match (tweet_search_extractor)

  • exclude_original_author (Boolean) —

    Body param: Exclude replies from the source author.

  • exclude_source (String) —

    Body param: Exclude a source application.

  • exclude_words (String) —

    Body param: Words or quoted phrases to exclude. Separate with spaces, commas, or

  • from_user (String) —

    Body param: Filter by author username (tweet_search_extractor)

  • geocode (String) —

    Body param: Match latitude, longitude, and radius.

  • hashtags (String) —

    Body param: Hashtags separated by spaces, commas, or lines. (tweet_search_extrac

  • has_location (Boolean) —

    Body param: Require a profile location.

  • has_media_only (Boolean) —

    Body param: Return only replies with media.

  • has_website (Boolean) —

    Body param: Require a profile website.

  • include_original_post (Boolean) —

    Body param: Include the source post in reply results.

  • include_search_terms (Boolean) —

    Body param: Add matching search terms to collection metadata.

  • include_target_metadata (Boolean) —

    Body param: Add source target metadata to each result.

  • in_reply_to_tweet_id (String) —

    Body param: Only replies to this tweet ID (tweet_search_extractor)

  • language (String) —

    Body param: Language code filter (tweet_search_extractor)

  • list_id (String) —

    Body param: Search within a list ID (tweet_search_extractor)

  • location_contains (String) —

    Body param: Required profile location text.

  • max_depth (Integer) —

    Body param: Maximum nested reply depth.

  • max_followers (Integer) —

    Body param: Maximum follower count for profile results.

  • max_following (Integer) —

    Body param: Maximum following count for profile results.

  • max_id (String) —

    Body param: Return Tweets older than this Tweet ID.

  • max_items_per_target (Integer) —

    Body param: Maximum results collected for each target.

  • max_likes (Integer) —

    Body param: Maximum Tweet like count.

  • max_pages_per_target (Integer) —

    Body param: Reply pages collected for each target.

  • max_posts (Integer) —

    Body param: Maximum post count for profile results.

  • max_quotes (Integer) —

    Body param: Maximum Tweet quote count.

  • max_replies (Integer) —

    Body param: Maximum Tweet reply count.

  • max_retweets (Integer) —

    Body param: Maximum Tweet repost count.

  • media_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::MediaType) —

    Body param: Media type filter (tweet_search_extractor)

  • mentioning (String) —

    Body param: Filter tweets mentioning a username (tweet_search_extractor)

  • min_account_age_days (Integer) —

    Body param: Minimum profile age in days.

  • min_bookmarks (Integer) —

    Body param: Minimum Tweet bookmark count.

  • min_faves (Integer) —

    Body param: Minimum likes threshold (tweet_search_extractor)

  • min_followers (Integer) —

    Body param: Minimum follower count for profile results.

  • min_following (Integer) —

    Body param: Minimum following count for profile results.

  • min_posts (Integer) —

    Body param: Minimum post count for profile results.

  • min_quotes (Integer) —

    Body param: Minimum quote count threshold (tweet_search_extractor)

  • min_replies (Integer) —

    Body param: Minimum replies threshold (tweet_search_extractor)

  • min_retweets (Integer) —

    Body param: Minimum retweets threshold (tweet_search_extractor)

  • min_views (Integer) —

    Body param: Minimum Tweet view count.

  • native_retweets (Boolean) —

    Body param: Only return native reposts.

  • near (String) —

    Body param: Match a place name.

  • news (Boolean) —

    Body param: Only return news results.

  • overlap_mode (Boolean) —

    Body param: Shortcut for dedupeMode=merge.

  • place (String) —

    Body param: Search within a place ID (tweet_search_extractor)

  • place_country (String) —

    Body param: Search within a country code (tweet_search_extractor)

  • point_radius (String) —

    Body param: Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)

  • query_type (Symbol, XTwitterScraper::Models::ExtractionRunParams::QueryType) —

    Body param: Search ranking applied to every query.

  • quotes (Symbol, XTwitterScraper::Models::ExtractionRunParams::Quotes) —

    Body param: Quote mode (tweet_search_extractor)

  • quotes_of_tweet_id (String) —

    Body param: Only quotes of this tweet ID (tweet_search_extractor)

  • relation_targets (Array<XTwitterScraper::Models::ExtractionRunParams::RelationTarget>) —

    Body param: Profile relations processed within one job.

  • replies (Symbol, XTwitterScraper::Models::ExtractionRunParams::Replies) —

    Body param: Reply mode (tweet_search_extractor)

  • results_limit (Integer) —

    Body param: Maximum number of results to extract. When set, the extraction stops

  • retweets (Symbol, XTwitterScraper::Models::ExtractionRunParams::Retweets) —

    Body param: Retweet mode (tweet_search_extractor)

  • retweets_of_tweet_id (String) —

    Body param: Only retweets of this tweet ID (tweet_search_extractor)

  • safe (Boolean) —

    Body param: Enable the safe-search filter.

  • scope (Symbol, XTwitterScraper::Models::ExtractionRunParams::Scope) —

    Body param: Reply depth scope.

  • search_queries (Array<String>) —

    Body param: Search queries processed as one collection job.

  • search_query (String) —

    Body param: Required for tweet_search_extractor & community_search.

  • since_date (Date) —

    Body param: Start date YYYY-MM-DD (tweet_search_extractor)

  • since_id (String) —

    Body param: Return Tweets newer than this Tweet ID.

  • since_time (Time, Integer) —

    Body param: Reply start time as ISO 8601 or Unix seconds.

  • sort (Symbol, XTwitterScraper::Models::ExtractionRunParams::Sort) —

    Body param: Reply result order.

  • source (String) —

    Body param: Match the source application.

  • start_cursor (String) —

    Body param: Resume one reply target from this cursor.

  • target_community_id (String) —

    Body param: Required for community_post_extractor & community_search.

  • target_community_ids (Array<String>) —

    Body param: Community IDs processed as one collection job.

  • target_list_id (String) —

    Body param: Required for list_follower_explorer, list_member_extractor & list_po

  • target_list_ids (Array<String>) —

    Body param: List IDs processed as one collection job.

  • targets (Array<String, XTwitterScraper::Models::ExtractionRunParams::Target::UnionMember1>) —

    Body param: Mixed targets auto-routed within one job.

  • target_space_id (String) —

    Body param: Required for space_explorer.

  • target_tweet_id (String) —

    Body param

  • target_tweet_ids (Array<String>) —

    Body param: Tweet IDs processed as one collection job.

  • target_username (String) —

    Body param

  • target_usernames (Array<String>) —

    Body param: Usernames processed as one collection job.

  • to_user (String) —

    Body param: Filter replies sent to a username (tweet_search_extractor)

  • until_date (Date) —

    Body param: End date YYYY-MM-DD (tweet_search_extractor)

  • until_time (Time, Integer) —

    Body param: Reply end time as ISO 8601 or Unix seconds.

  • url (String) —

    Body param: URL substring or domain filter (tweet_search_extractor)

  • username_contains (String) —

    Body param: Required username text.

  • verified_only (Boolean) —

    Body param: Only verified authors (tweet_search_extractor)

  • verified_type (String) —

    Body param: Exact profile verification type.

  • within (String) —

    Body param: Set the radius for the near filter.

  • within_time (String) —

    Body param: Match Tweets inside a recent time window.

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/x_twitter_scraper/resources/extractions.rb', line 583

def run(params)
  query_params = [:dry_run]
  parsed, options = XTwitterScraper::ExtractionRunParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "extractions",
    query: query,
    body: parsed.except(*query_params),
    model: XTwitterScraper::Models::ExtractionRunResponse,
    options: options
  )
end