Class: XTwitterScraper::Resources::X

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/x.rb,
lib/x_twitter_scraper/resources/x/dm.rb,
lib/x_twitter_scraper/resources/x/lists.rb,
lib/x_twitter_scraper/resources/x/media.rb,
lib/x_twitter_scraper/resources/x/users.rb,
lib/x_twitter_scraper/resources/x/tweets.rb,
lib/x_twitter_scraper/resources/x/profile.rb,
lib/x_twitter_scraper/resources/x/accounts.rb,
lib/x_twitter_scraper/resources/x/bookmarks.rb,
lib/x_twitter_scraper/resources/x/followers.rb,
lib/x_twitter_scraper/resources/x/communities.rb,
lib/x_twitter_scraper/resources/x/tweets/like.rb,
lib/x_twitter_scraper/resources/x/users/follow.rb,
lib/x_twitter_scraper/resources/x/write_actions.rb,
lib/x_twitter_scraper/resources/x/tweets/retweet.rb,
lib/x_twitter_scraper/resources/x/communities/join.rb,
lib/x_twitter_scraper/resources/x/communities/tweets.rb,
lib/x_twitter_scraper/resources/x/account_connection_challenges.rb,
sig/x_twitter_scraper/resources/x.rbs,
sig/x_twitter_scraper/resources/x/dm.rbs,
sig/x_twitter_scraper/resources/x/lists.rbs,
sig/x_twitter_scraper/resources/x/media.rbs,
sig/x_twitter_scraper/resources/x/users.rbs,
sig/x_twitter_scraper/resources/x/tweets.rbs,
sig/x_twitter_scraper/resources/x/profile.rbs,
sig/x_twitter_scraper/resources/x/accounts.rbs,
sig/x_twitter_scraper/resources/x/bookmarks.rbs,
sig/x_twitter_scraper/resources/x/followers.rbs,
sig/x_twitter_scraper/resources/x/communities.rbs,
sig/x_twitter_scraper/resources/x/tweets/like.rbs,
sig/x_twitter_scraper/resources/x/users/follow.rbs,
sig/x_twitter_scraper/resources/x/write_actions.rbs,
sig/x_twitter_scraper/resources/x/tweets/retweet.rbs,
sig/x_twitter_scraper/resources/x/communities/join.rbs,
sig/x_twitter_scraper/resources/x/communities/tweets.rbs,
sig/x_twitter_scraper/resources/x/account_connection_challenges.rbs

Defined Under Namespace

Classes: AccountConnectionChallenges, Accounts, Bookmarks, Communities, Dm, Followers, Lists, Media, Profile, Tweets, Users, WriteActions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ X

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

Parameters:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 152

def initialize(client:)
  @client = client
  @write_actions = XTwitterScraper::Resources::X::WriteActions.new(client: client)
  @tweets = XTwitterScraper::Resources::X::Tweets.new(client: client)
  @users = XTwitterScraper::Resources::X::Users.new(client: client)
  @followers = XTwitterScraper::Resources::X::Followers.new(client: client)
  @dm = XTwitterScraper::Resources::X::Dm.new(client: client)
  @media = XTwitterScraper::Resources::X::Media.new(client: client)
  @profile = XTwitterScraper::Resources::X::Profile.new(client: client)
  @communities = XTwitterScraper::Resources::X::Communities.new(client: client)
  @accounts = XTwitterScraper::Resources::X::Accounts.new(client: client)
  @account_connection_challenges =
    XTwitterScraper::Resources::X::AccountConnectionChallenges.new(client: client)
  @bookmarks = XTwitterScraper::Resources::X::Bookmarks.new(client: client)
  @lists = XTwitterScraper::Resources::X::Lists.new(client: client)
end

Instance Attribute Details

#account_connection_challenges ⇒ XTwitterScraper::Resources::X::AccountConnectionChallenges (readonly)

Connected X account management

Returns:



40
41
42
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 40

def 
  @account_connection_challenges
end

#accounts ⇒ XTwitterScraper::Resources::X::Accounts (readonly)

Connected X account management

Returns:



36
37
38
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 36

def accounts
  @accounts
end

#bookmarks ⇒ XTwitterScraper::Resources::X::Bookmarks (readonly)

Look up, search, and analyze individual tweets

Returns:



44
45
46
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 44

def bookmarks
  @bookmarks
end

#communities ⇒ XTwitterScraper::Resources::X::Communities (readonly)

Returns:



32
33
34
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 32

def communities
  @communities
end

#dm ⇒ XTwitterScraper::Resources::X::Dm (readonly)

Returns:



21
22
23
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 21

def dm
  @dm
end

#followers ⇒ XTwitterScraper::Resources::X::Followers (readonly)

Look up, search, and explore user profiles and relationships

Returns:



18
19
20
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 18

def followers
  @followers
end

#lists ⇒ XTwitterScraper::Resources::X::Lists (readonly)

X List followers, members, and tweets

Returns:



48
49
50
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 48

def lists
  @lists
end

#media ⇒ XTwitterScraper::Resources::X::Media (readonly)

Media upload and download

Returns:



25
26
27
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 25

def media
  @media
end

#profile ⇒ XTwitterScraper::Resources::X::Profile (readonly)

X write actions (tweets, likes, follows, DMs)

Returns:



29
30
31
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 29

def profile
  @profile
end

#tweets ⇒ XTwitterScraper::Resources::X::Tweets (readonly)

Returns:



11
12
13
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 11

def tweets
  @tweets
end

#users ⇒ XTwitterScraper::Resources::X::Users (readonly)

Returns:



14
15
16
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 14

def users
  @users
end

#write_actions ⇒ XTwitterScraper::Resources::X::WriteActions (readonly)

X write actions (tweets, likes, follows, DMs)

Returns:



8
9
10
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 8

def write_actions
  @write_actions
end

Instance Method Details

#get_article(tweet_id, request_options: {}) ⇒ XTwitterScraper::Models::XGetArticleResponse

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

Retrieve the full content of an X Article (long-form post) by numeric tweet ID. Returns article_not_found when the tweet is valid but is not an X Article.

Parameters:

  • tweet_id (String) —

    Numeric tweet ID of the article, 15-20 digits. If you have a tweet URL, use the

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

Returns:

See Also:



65
66
67
68
69
70
71
72
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 65

def get_article(tweet_id, params = {})
  @client.request(
    method: :get,
    path: ["x/articles/%1$s", tweet_id],
    model: XTwitterScraper::Models::XGetArticleResponse,
    options: params[:request_options]
  )
end

#get_home_timeline(cursor: nil, seen_tweet_ids: nil, request_options: {}) ⇒ XTwitterScraper::Models::PaginatedTweets

Get home timeline

Parameters:

  • cursor (String) —

    Pagination cursor for timeline

  • seen_tweet_ids (String) —

    Comma-separated tweet IDs to exclude from results. Empty entries are ignored.

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

Returns:

See Also:



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 87

def get_home_timeline(params = {})
  parsed, options = XTwitterScraper::XGetHomeTimelineParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "x/timeline",
    query: query.transform_keys(seen_tweet_ids: "seenTweetIds"),
    model: XTwitterScraper::PaginatedTweets,
    options: options
  )
end

#get_notifications(cursor: nil, type: nil, request_options: {}) ⇒ XTwitterScraper::Models::XGetNotificationsResponse

Get notifications

Parameters:

Returns:

See Also:



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 112

def get_notifications(params = {})
  parsed, options = XTwitterScraper::XGetNotificationsParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "x/notifications",
    query: query,
    model: XTwitterScraper::Models::XGetNotificationsResponse,
    options: options
  )
end

#get_trends(count: nil, woeid: nil, request_options: {}) ⇒ XTwitterScraper::Models::XGetTrendsResponse

Get trending hashtags and topics from X by region

Parameters:

  • count (Integer) —

    Number of trending topics to return (1-50, default 30)

  • woeid (Integer) —

    Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)

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

Returns:

See Also:



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/x_twitter_scraper/resources/x.rb', line 137

def get_trends(params = {})
  parsed, options = XTwitterScraper::XGetTrendsParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "x/trends",
    query: query,
    model: XTwitterScraper::Models::XGetTrendsResponse,
    options: options
  )
end