Class: XTwitterScraper::Models::X::TweetGetRepliesParams

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_get_replies_params.rb,
sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::X::Tweets#get_replies

Defined Under Namespace

Modules: MediaType, Mode, Quotes, Replies, Retweets, Scope, Sort

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(id:, any_words: nil, blue_verified_only: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_original_author: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, has_media_only: nil, include_original_post: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, max_depth: 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, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, scope: nil, since_date: nil, since_id: nil, since_time: nil, sort: 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::TweetGetRepliesParams for more details.

Parameters:

  • id (String)
  • 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.

  • 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_original_author (Boolean) (defaults to: nil)

    Exclude replies written by the source-post author.

  • 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.

  • has_media_only (Boolean) (defaults to: nil)

    Only return replies containing media.

  • include_original_post (Boolean) (defaults to: nil)

    Include the source post and count it toward limit.

  • 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)

    With mode=complete, maximum combined direct and nested reply rows (1-25000, defa

  • max_depth (Integer) (defaults to: nil)

    Maximum reply depth from the source post.

  • 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::TweetGetRepliesParams::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::TweetGetRepliesParams::Mode) (defaults to: nil)

    Optional advanced override. Omit mode for automatic maximum direct reply coverag

  • 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.

  • page_size (Integer) (defaults to: nil)

    Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20. Cont

  • quotes (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::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::TweetGetRepliesParams::Replies) (defaults to: nil)

    Reply mode.

  • retweets (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::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.

  • scope (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Scope) (defaults to: nil)

    Select all replies, direct replies, or nested replies.

  • 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)

    Unix timestamp - return replies posted after this time

  • sort (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Sort) (defaults to: nil)

    Sort the selected replies before applying limit.

  • 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)

    Unix timestamp - return replies posted before this time

  • 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_get_replies_params.rb', line 364

Instance Attribute Details

#any_wordsString?

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

Parameters:

  • (String)

Returns:

  • (String, nil)


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

optional :any_words, String

#blue_verified_onlyBoolean?

Only return tweets from Blue-verified authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


31
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 31

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

#card_nameString?

Match the Tweet card name.

Parameters:

  • (String)

Returns:

  • (String, nil)


37
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 37

optional :card_name, String

#cashtagsString?

Cashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil)


43
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 43

optional :cashtags, String

#conversation_idString?

Conversation ID filter.

Parameters:

  • (String)

Returns:

  • (String, nil)


49
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 49

optional :conversation_id, String

#cursorString?

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

Parameters:

  • (String)

Returns:

  • (String, nil)


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

optional :cursor, String

#exact_phraseString?

Exact phrase to match.

Parameters:

  • (String)

Returns:

  • (String, nil)


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

optional :exact_phrase, String

#exclude_original_authorBoolean?

Exclude replies written by the source-post author.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


68
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 68

optional :exclude_original_author, XTwitterScraper::Internal::Type::Boolean

#exclude_sourceString?

Exclude a source application.

Parameters:

  • (String)

Returns:

  • (String, nil)


74
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 74

optional :exclude_source, String

#exclude_wordsString?

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

Parameters:

  • (String)

Returns:

  • (String, nil)


80
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 80

optional :exclude_words, String

#from_userString?

Filter by author username.

Parameters:

  • (String)

Returns:

  • (String, nil)


86
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 86

optional :from_user, String

#geocodeString?

Match latitude, longitude, and radius.

Parameters:

  • (String)

Returns:

  • (String, nil)


92
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 92

optional :geocode, String

#has_media_onlyBoolean?

Only return replies containing media.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


104
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 104

optional :has_media_only, XTwitterScraper::Internal::Type::Boolean

#hashtagsString?

Hashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil)


98
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 98

optional :hashtags, String

#idString

Parameters:

  • value (String)

Returns:

  • (String)


18
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 18

required :id, String

#in_reply_to_tweet_idString?

Only replies to this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil)


116
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 116

optional :in_reply_to_tweet_id, String

#include_original_postBoolean?

Include the source post and count it toward limit.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


110
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 110

optional :include_original_post, XTwitterScraper::Internal::Type::Boolean

#languageString?

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

Parameters:

  • (String)

Returns:

  • (String, nil)


122
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 122

optional :language, String

#limitInteger?

With mode=complete, maximum combined direct and nested reply rows (1-25000, default 25000). Automatic pages accept 1-300. Standard pages accept 1-100. Prefer pageSize outside complete mode.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


130
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 130

optional :limit, Integer

#max_depthInteger?

Maximum reply depth from the source post.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


136
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 136

optional :max_depth, Integer

#max_favesInteger?

Maximum likes threshold. maxLikes is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


142
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 142

optional :max_faves, Integer

#max_idString?

Return Tweets older than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil)


148
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 148

optional :max_id, String

#max_quotesInteger?

Maximum quotes threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


154
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 154

optional :max_quotes, Integer

#max_repliesInteger?

Maximum replies threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


160
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 160

optional :max_replies, Integer

#max_retweetsInteger?

Maximum retweets threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


166
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 166

optional :max_retweets, Integer

#media_typeSymbol, ...

Filter by media type.



172
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 172

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

#mentioningString?

Filter tweets mentioning a username.

Parameters:

  • (String)

Returns:

  • (String, nil)


178
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 178

optional :mentioning, String

#min_bookmarksInteger?

Minimum bookmark count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


184
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 184

optional :min_bookmarks, Integer

#min_favesInteger?

Minimum likes threshold. minLikes is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


190
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 190

optional :min_faves, Integer

#min_quotesInteger?

Minimum quote count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


196
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 196

optional :min_quotes, Integer

#min_repliesInteger?

Minimum replies threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


202
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 202

optional :min_replies, Integer

#min_retweetsInteger?

Minimum retweets threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


208
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 208

optional :min_retweets, Integer

#min_viewsInteger?

Minimum view count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


214
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 214

optional :min_views, Integer

#modeSymbol, ...

Optional advanced override. Omit mode for automatic maximum direct reply coverage with pagination. Standard keeps legacy pagination. Complete returns direct and nested replies with diagnostics, scope, depth, sorting, and original-post controls.



223
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 223

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

#native_retweetsBoolean?

Only return native reposts.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


229
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 229

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

#nearString?

Match a place name.

Parameters:

  • (String)

Returns:

  • (String, nil)


235
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 235

optional :near, String

#newsBoolean?

Only return news results.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


241
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 241

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

#page_sizeInteger?

Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20. Continue while has_next_page is true. Deprecated aliases remain accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil)


248
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 248

optional :page_size, Integer

#quotesSymbol, ...

Quote mode.



254
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 254

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

#quotes_of_tweet_idString?

Only quotes of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil)


260
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 260

optional :quotes_of_tweet_id, String

#repliesSymbol, ...

Reply mode.



266
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 266

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

#retweetsSymbol, ...

Retweet mode.



272
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 272

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

#retweets_of_tweet_idString?

Only retweets of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil)


278
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 278

optional :retweets_of_tweet_id, String

#safeBoolean?

Enable the safe-search filter.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


284
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 284

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

#scopeSymbol, ...

Select all replies, direct replies, or nested replies.



290
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 290

optional :scope, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Scope }

#since_dateDate?

Start date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil)


296
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 296

optional :since_date, Date

#since_idString?

Return Tweets newer than this Tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil)


302
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 302

optional :since_id, String

#since_timeString?

Unix timestamp - return replies posted after this time

Parameters:

  • (String)

Returns:

  • (String, nil)


308
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 308

optional :since_time, String

#sortSymbol, ...

Sort the selected replies before applying limit.



314
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 314

optional :sort, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Sort }

#sourceString?

Match the source application.

Parameters:

  • (String)

Returns:

  • (String, nil)


320
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 320

optional :source, String

#to_userString?

Filter replies sent to a username.

Parameters:

  • (String)

Returns:

  • (String, nil)


326
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 326

optional :to_user, String

#until_dateDate?

End date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil)


332
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 332

optional :until_date, Date

#until_timeString?

Unix timestamp - return replies posted before this time

Parameters:

  • (String)

Returns:

  • (String, nil)


338
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 338

optional :until_time, String

#urlString?

URL substring or domain filter.

Parameters:

  • (String)

Returns:

  • (String, nil)


344
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 344

optional :url, String

#verified_onlyBoolean?

Only return tweets from verified authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil)


350
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 350

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

#withinString?

Set the radius for the near filter.

Parameters:

  • (String)

Returns:

  • (String, nil)


356
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 356

optional :within, String

#within_timeString?

Match Tweets inside a recent time window.

Parameters:

  • (String)

Returns:

  • (String, nil)


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

optional :within_time, String

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 495

Instance Method Details

#to_hash{

Returns:

  • ({)


375
# File 'sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs', line 375

def to_hash: -> {