Class: XTwitterScraper::Models::X::TweetSearchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/x/tweet_search_params.rb,
sig/x_twitter_scraper/models/x/tweet_search_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::X::Tweets#search

Defined Under Namespace

Modules: MediaType, Mode, QueryType, Quotes, Replies, Retweets

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(q:, advanced_query: nil, any_words: nil, blue_verified_only: nil, bounding_box: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, list_id: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, mode: nil, native_retweets: nil, near: nil, news: nil, place: nil, place_country: nil, point_radius: nil, query_type: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, since_time: nil, source: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::X::TweetSearchParams for more details.

Parameters:

  • q (String) —

    Query, Tweet ID, or status URL. Valid inline bounds apply per page.

  • advanced_query (String) (defaults to: nil) —

    Raw advanced search query appended as-is.

  • any_words (String) (defaults to: nil) —

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

  • blue_verified_only (Boolean) (defaults to: nil) —

    Only return tweets from Blue-verified authors.

  • bounding_box (String) (defaults to: nil) —

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

  • card_name (String) (defaults to: nil) —

    Match the Tweet card name.

  • cashtags (String) (defaults to: nil) —

    Cashtags separated by spaces, commas, or lines.

  • conversation_id (String) (defaults to: nil) —

    Conversation ID filter.

  • cursor (String) (defaults to: nil) —

    Cursor from the previous response. Xquik cursors resume automatic coverage. Exis

  • exact_phrase (String) (defaults to: nil) —

    Exact phrase to match.

  • exclude_source (String) (defaults to: nil) —

    Exclude a source application.

  • exclude_words (String) (defaults to: nil) —

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

  • from_user (String) (defaults to: nil) —

    Filter by author username.

  • geocode (String) (defaults to: nil) —

    Match latitude, longitude, and radius.

  • hashtags (String) (defaults to: nil) —

    Hashtags separated by spaces, commas, or lines.

  • in_reply_to_tweet_id (String) (defaults to: nil) —

    Only replies to this tweet ID.

  • language (String) (defaults to: nil) —

    Language code filter, e.g. en or tr.

  • limit (Integer) (defaults to: nil) —

    Result upper bound. Omit it for the existing 20-row page size. Explicit coverage

  • list_id (String) (defaults to: nil) —

    Search within a list ID.

  • max_faves (Integer) (defaults to: nil) —

    Maximum likes threshold. maxLikes is also accepted.

  • max_id (String) (defaults to: nil) —

    Return Tweets older than this Tweet ID.

  • max_quotes (Integer) (defaults to: nil) —

    Maximum quotes threshold.

  • max_replies (Integer) (defaults to: nil) —

    Maximum replies threshold.

  • max_retweets (Integer) (defaults to: nil) —

    Maximum retweets threshold.

  • media_type (Symbol, XTwitterScraper::Models::X::TweetSearchParams::MediaType) (defaults to: nil) —

    Filter by media type.

  • mentioning (String) (defaults to: nil) —

    Filter tweets mentioning a username.

  • min_bookmarks (Integer) (defaults to: nil) —

    Minimum bookmark count threshold.

  • min_faves (Integer) (defaults to: nil) —

    Minimum likes threshold. minLikes is also accepted.

  • min_quotes (Integer) (defaults to: nil) —

    Minimum quote count threshold.

  • min_replies (Integer) (defaults to: nil) —

    Minimum replies threshold.

  • min_retweets (Integer) (defaults to: nil) —

    Minimum retweets threshold.

  • min_views (Integer) (defaults to: nil) —

    Minimum view count threshold.

  • mode (Symbol, XTwitterScraper::Models::X::TweetSearchParams::Mode) (defaults to: nil) —

    Omit mode for resumable maximum coverage. Standard keeps legacy pagination. Cove

  • native_retweets (Boolean) (defaults to: nil) —

    Only return native reposts.

  • near (String) (defaults to: nil) —

    Match a place name.

  • news (Boolean) (defaults to: nil) —

    Only return news results.

  • place (String) (defaults to: nil) —

    Search within a place ID.

  • place_country (String) (defaults to: nil) —

    Search within a country code.

  • point_radius (String) (defaults to: nil) —

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

  • query_type (Symbol, XTwitterScraper::Models::X::TweetSearchParams::QueryType) (defaults to: nil) —

    Sort order - Latest (chronological) or Top (engagement-ranked)

  • quotes (Symbol, XTwitterScraper::Models::X::TweetSearchParams::Quotes) (defaults to: nil) —

    Quote mode.

  • quotes_of_tweet_id (String) (defaults to: nil) —

    Only quotes of this tweet ID.

  • replies (Symbol, XTwitterScraper::Models::X::TweetSearchParams::Replies) (defaults to: nil) —

    Reply mode.

  • retweets (Symbol, XTwitterScraper::Models::X::TweetSearchParams::Retweets) (defaults to: nil) —

    Retweet mode.

  • retweets_of_tweet_id (String) (defaults to: nil) —

    Only retweets of this tweet ID.

  • safe (Boolean) (defaults to: nil) —

    Enable the safe-search filter.

  • since_date (Date) (defaults to: nil) —

    Start date in YYYY-MM-DD format.

  • since_id (String) (defaults to: nil) —

    Return Tweets newer than this Tweet ID.

  • since_time (String) (defaults to: nil) —

    Inclusive ISO bound.

  • source (String) (defaults to: nil) —

    Match the source application.

  • to_user (String) (defaults to: nil) —

    Filter replies sent to a username.

  • until_date (Date) (defaults to: nil) —

    End date in YYYY-MM-DD format.

  • until_time (String) (defaults to: nil) —

    Exclusive ISO bound.

  • url (String) (defaults to: nil) —

    URL substring or domain filter.

  • verified_only (Boolean) (defaults to: nil) —

    Only return tweets from verified authors.

  • within (String) (defaults to: nil) —

    Set the radius for the near filter.

  • within_time (String) (defaults to: nil) —

    Match Tweets inside a recent time window.

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



# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 362

Instance Attribute Details

#advanced_query ⇒ String?

Raw advanced search query appended as-is.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 25

optional :advanced_query, String

#any_words ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


32
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 32

optional :any_words, String

#blue_verified_only ⇒ Boolean?

Only return tweets from Blue-verified authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 38

optional :blue_verified_only, XTwitterScraper::Internal::Type::Boolean

#bounding_box ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


44
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 44

optional :bounding_box, String

#card_name ⇒ String?

Match the Tweet card name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


50
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 50

optional :card_name, String

#cashtags ⇒ String?

Cashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 56

optional :cashtags, String

#conversation_id ⇒ String?

Conversation ID filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


62
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 62

optional :conversation_id, String

#cursor ⇒ String?

Cursor from the previous response. Xquik cursors resume automatic coverage. Existing unprefixed cursors keep legacy standard behavior.

Parameters:

  • (String)

Returns:

  • (String, nil) 


69
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 69

optional :cursor, String

#exact_phrase ⇒ String?

Exact phrase to match.

Parameters:

  • (String)

Returns:

  • (String, nil) 


75
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 75

optional :exact_phrase, String

#exclude_source ⇒ String?

Exclude a source application.

Parameters:

  • (String)

Returns:

  • (String, nil) 


81
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 81

optional :exclude_source, String

#exclude_words ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


87
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 87

optional :exclude_words, String

#from_user ⇒ String?

Filter by author username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


93
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 93

optional :from_user, String

#geocode ⇒ String?

Match latitude, longitude, and radius.

Parameters:

  • (String)

Returns:

  • (String, nil) 


99
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 99

optional :geocode, String

#hashtags ⇒ String?

Hashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


105
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 105

optional :hashtags, String

#in_reply_to_tweet_id ⇒ String?

Only replies to this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


111
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 111

optional :in_reply_to_tweet_id, String

#language ⇒ String?

Language code filter, e.g. en or tr.

Parameters:

  • (String)

Returns:

  • (String, nil) 


117
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 117

optional :language, String

#limit ⇒ Integer?

Result upper bound. Omit it for the existing 20-row page size. Explicit coverage defaults to 2000 and allows 10000. For paid requests, remaining credits can reduce results. Zero affordable results returns 402.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


125
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 125

optional :limit, Integer

#list_id ⇒ String?

Search within a list ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


131
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 131

optional :list_id, String

#max_faves ⇒ Integer?

Maximum likes threshold. maxLikes is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


137
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 137

optional :max_faves, Integer

#max_id ⇒ String?

Return Tweets older than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


143
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 143

optional :max_id, String

#max_quotes ⇒ Integer?

Maximum quotes threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


149
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 149

optional :max_quotes, Integer

#max_replies ⇒ Integer?

Maximum replies threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


155
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 155

optional :max_replies, Integer

#max_retweets ⇒ Integer?

Maximum retweets threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


161
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 161

optional :max_retweets, Integer

#media_type ⇒ Symbol, ...

Filter by media type.

Returns:



167
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 167

optional :media_type, enum: -> { XTwitterScraper::X::TweetSearchParams::MediaType }

#mentioning ⇒ String?

Filter tweets mentioning a username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


173
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 173

optional :mentioning, String

#min_bookmarks ⇒ Integer?

Minimum bookmark count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


179
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 179

optional :min_bookmarks, Integer

#min_faves ⇒ Integer?

Minimum likes threshold. minLikes is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


185
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 185

optional :min_faves, Integer

#min_quotes ⇒ Integer?

Minimum quote count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


191
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 191

optional :min_quotes, Integer

#min_replies ⇒ Integer?

Minimum replies threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


197
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 197

optional :min_replies, Integer

#min_retweets ⇒ Integer?

Minimum retweets threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


203
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 203

optional :min_retweets, Integer

#min_views ⇒ Integer?

Minimum view count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


209
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 209

optional :min_views, Integer

#mode ⇒ Symbol, ...

Omit mode for resumable maximum coverage. Standard keeps legacy pagination. Coverage returns diagnostics once and rejects cursors.

Returns:



216
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 216

optional :mode, enum: -> { XTwitterScraper::X::TweetSearchParams::Mode }

#native_retweets ⇒ Boolean?

Only return native reposts.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


222
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 222

optional :native_retweets, XTwitterScraper::Internal::Type::Boolean

#near ⇒ String?

Match a place name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


228
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 228

optional :near, String

#news ⇒ Boolean?

Only return news results.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


234
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 234

optional :news, XTwitterScraper::Internal::Type::Boolean

#place ⇒ String?

Search within a place ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


240
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 240

optional :place, String

#place_country ⇒ String?

Search within a country code.

Parameters:

  • (String)

Returns:

  • (String, nil) 


246
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 246

optional :place_country, String

#point_radius ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


252
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 252

optional :point_radius, String

#q ⇒ String

Query, Tweet ID, or status URL. Valid inline bounds apply per page.

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 19

required :q, String

#query_type ⇒ Symbol, ...

Sort order - Latest (chronological) or Top (engagement-ranked)

Returns:



258
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 258

optional :query_type, enum: -> { XTwitterScraper::X::TweetSearchParams::QueryType }

#quotes ⇒ Symbol, ...

Quote mode.

Returns:



264
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 264

optional :quotes, enum: -> { XTwitterScraper::X::TweetSearchParams::Quotes }

#quotes_of_tweet_id ⇒ String?

Only quotes of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


270
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 270

optional :quotes_of_tweet_id, String

#replies ⇒ Symbol, ...

Reply mode.

Returns:



276
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 276

optional :replies, enum: -> { XTwitterScraper::X::TweetSearchParams::Replies }

#retweets ⇒ Symbol, ...

Retweet mode.

Returns:



282
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 282

optional :retweets, enum: -> { XTwitterScraper::X::TweetSearchParams::Retweets }

#retweets_of_tweet_id ⇒ String?

Only retweets of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


288
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 288

optional :retweets_of_tweet_id, String

#safe ⇒ Boolean?

Enable the safe-search filter.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


294
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 294

optional :safe, XTwitterScraper::Internal::Type::Boolean

#since_date ⇒ Date?

Start date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


300
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 300

optional :since_date, Date

#since_id ⇒ String?

Return Tweets newer than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


306
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 306

optional :since_id, String

#since_time ⇒ String?

Inclusive ISO bound.

Parameters:

  • (String)

Returns:

  • (String, nil) 


312
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 312

optional :since_time, String

#source ⇒ String?

Match the source application.

Parameters:

  • (String)

Returns:

  • (String, nil) 


318
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 318

optional :source, String

#to_user ⇒ String?

Filter replies sent to a username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


324
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 324

optional :to_user, String

#until_date ⇒ Date?

End date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


330
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 330

optional :until_date, Date

#until_time ⇒ String?

Exclusive ISO bound.

Parameters:

  • (String)

Returns:

  • (String, nil) 


336
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 336

optional :until_time, String

#url ⇒ String?

URL substring or domain filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


342
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 342

optional :url, String

#verified_only ⇒ Boolean?

Only return tweets from verified authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


348
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 348

optional :verified_only, XTwitterScraper::Internal::Type::Boolean

#within ⇒ String?

Set the radius for the near filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


354
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 354

optional :within, String

#within_time ⇒ String?

Match Tweets inside a recent time window.

Parameters:

  • (String)

Returns:

  • (String, nil) 


360
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 360

optional :within_time, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/x/tweet_search_params.rb', line 493

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


373
 
# File 'sig/x_twitter_scraper/models/x/tweet_search_params.rbs', line 373

def to_hash: -> {