x-twitter-scraper 0.4.2 → 0.4.4

data/rbi/x_twitter_scraper/resources/x/profile.rbi

@@ -34,15 +34,15 @@ module XTwitterScraper
         sig do
           params(
             account: String,
-            file: XTwitterScraper::Internal::FileInput,
+            url: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::ProfileUpdateAvatarResponse)
         end
         def update_avatar(
-          # X account (@username or ID) for avatar update
+          # X account (@username or ID) receiving avatar from URL
           account:,
-          # Avatar image (max 716KB)
-          file:,
+          # HTTPS URL to the avatar image to download
+          url:,
           request_options: {}
         )
         end
@@ -51,15 +51,15 @@ module XTwitterScraper
         sig do
           params(
             account: String,
-            file: XTwitterScraper::Internal::FileInput,
+            url: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::ProfileUpdateBannerResponse)
         end
         def update_banner(
-          # X account (@username or ID) for banner update
+          # X account (@username or ID) receiving banner from URL
           account:,
-          # Banner image (max 2MB)
-          file:,
+          # HTTPS URL to the banner image to download
+          url:,
           request_options: {}
         )
         end

data/rbi/x_twitter_scraper/resources/x/tweets.rbi

@@ -16,29 +16,33 @@ module XTwitterScraper
         sig do
           params(
             account: String,
-            text: String,
             attachment_url: String,
             community_id: String,
             is_note_tweet: T::Boolean,
-            media_ids: T::Array[String],
+            media: T::Array[String],
             reply_to_tweet_id: String,
+            text: String,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::Models::X::TweetCreateResponse)
         end
         def create(
           # X account (@username or account ID)
           account:,
-          text:,
           attachment_url: nil,
           community_id: nil,
           is_note_tweet: nil,
-          media_ids: nil,
+          # Array of public media URLs to attach. Supports up to 4 images or exactly 1 MP4
+          # video up to 100 MB. Each URL must be publicly reachable. Attached media adds 2
+          # credits per started MB across all files.
+          media: nil,
           reply_to_tweet_id: nil,
+          # Tweet text (optional when media is provided)
+          text: nil,
           request_options: {}
         )
         end
 
-        # Look up tweet
+        # Get tweet with full text, author, metrics and media
         sig do
           params(
             id: String,
@@ -46,7 +50,7 @@ module XTwitterScraper
           ).returns(XTwitterScraper::Models::X::TweetRetrieveResponse)
         end
         def retrieve(
-          # Tweet ID
+          # Numeric tweet ID, 15-20 digits
           id,
           request_options: {}
         )
@@ -83,11 +87,12 @@ module XTwitterScraper
         )
         end
 
-        # Get users who liked a tweet
+        # List users who liked a tweet
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedUsers)
         end
@@ -96,64 +101,242 @@ module XTwitterScraper
           id,
           # Pagination cursor for favoriters
           cursor: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
+          page_size: nil,
           request_options: {}
         )
         end
 
-        # Get quote tweets of a tweet
+        # List quote tweets of a tweet
         sig do
           params(
             id: String,
+            any_words: String,
+            cashtags: String,
+            conversation_id: String,
             cursor: String,
+            exact_phrase: String,
+            exclude_words: String,
+            from_user: String,
+            hashtags: String,
             include_replies: T::Boolean,
+            in_reply_to_tweet_id: String,
+            language: String,
+            media_type:
+              XTwitterScraper::X::TweetGetQuotesParams::MediaType::OrSymbol,
+            mentioning: String,
+            min_faves: Integer,
+            min_quotes: Integer,
+            min_replies: Integer,
+            min_retweets: Integer,
+            page_size: Integer,
+            quotes: XTwitterScraper::X::TweetGetQuotesParams::Quotes::OrSymbol,
+            quotes_of_tweet_id: String,
+            replies:
+              XTwitterScraper::X::TweetGetQuotesParams::Replies::OrSymbol,
+            retweets:
+              XTwitterScraper::X::TweetGetQuotesParams::Retweets::OrSymbol,
+            retweets_of_tweet_id: String,
+            since_date: Date,
             since_time: String,
+            to_user: String,
+            until_date: Date,
             until_time: String,
+            url: String,
+            verified_only: T::Boolean,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedTweets)
         end
         def get_quotes(
-          # Tweet ID to get quotes
+          # Numeric tweet ID to get quotes, 15-20 digits
           id,
+          # Words or quoted phrases where any one can match. Separate with spaces, commas,
+          # or lines.
+          any_words: nil,
+          # Cashtags separated by spaces, commas, or lines.
+          cashtags: nil,
+          # Conversation ID filter.
+          conversation_id: nil,
           # Pagination cursor for quote tweets
           cursor: nil,
+          # Exact phrase to match.
+          exact_phrase: nil,
+          # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+          exclude_words: nil,
+          # Filter by author username.
+          from_user: nil,
+          # Hashtags separated by spaces, commas, or lines.
+          hashtags: nil,
           # Include reply quotes (default false)
           include_replies: nil,
+          # Only replies to this tweet ID.
+          in_reply_to_tweet_id: nil,
+          # Language code filter, e.g. en or tr.
+          language: nil,
+          # Filter by media type.
+          media_type: nil,
+          # Filter tweets mentioning a username.
+          mentioning: nil,
+          # Minimum likes threshold.
+          min_faves: nil,
+          # Minimum quote count threshold.
+          min_quotes: nil,
+          # Minimum replies threshold.
+          min_replies: nil,
+          # Minimum retweets threshold.
+          min_retweets: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
+          # Quote mode.
+          quotes: nil,
+          # Only quotes of this tweet ID.
+          quotes_of_tweet_id: nil,
+          # Reply mode.
+          replies: nil,
+          # Retweet mode.
+          retweets: nil,
+          # Only retweets of this tweet ID.
+          retweets_of_tweet_id: nil,
+          # Start date in YYYY-MM-DD format.
+          since_date: nil,
           # Unix timestamp - return quotes posted after this time
           since_time: nil,
+          # Filter replies sent to a username.
+          to_user: nil,
+          # End date in YYYY-MM-DD format.
+          until_date: nil,
           # Unix timestamp - return quotes posted before this time
           until_time: nil,
+          # URL substring or domain filter.
+          url: nil,
+          # Only return tweets from verified authors.
+          verified_only: nil,
           request_options: {}
         )
         end
 
-        # Get replies to a tweet
+        # List replies to a tweet
         sig do
           params(
             id: String,
+            any_words: String,
+            cashtags: String,
+            conversation_id: String,
             cursor: String,
+            exact_phrase: String,
+            exclude_words: String,
+            from_user: String,
+            hashtags: String,
+            in_reply_to_tweet_id: String,
+            language: String,
+            media_type:
+              XTwitterScraper::X::TweetGetRepliesParams::MediaType::OrSymbol,
+            mentioning: String,
+            min_faves: Integer,
+            min_quotes: Integer,
+            min_replies: Integer,
+            min_retweets: Integer,
+            page_size: Integer,
+            quotes: XTwitterScraper::X::TweetGetRepliesParams::Quotes::OrSymbol,
+            quotes_of_tweet_id: String,
+            replies:
+              XTwitterScraper::X::TweetGetRepliesParams::Replies::OrSymbol,
+            retweets:
+              XTwitterScraper::X::TweetGetRepliesParams::Retweets::OrSymbol,
+            retweets_of_tweet_id: String,
+            since_date: Date,
             since_time: String,
+            to_user: String,
+            until_date: Date,
             until_time: String,
+            url: String,
+            verified_only: T::Boolean,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedTweets)
         end
         def get_replies(
           # Tweet ID to get replies
           id,
+          # Words or quoted phrases where any one can match. Separate with spaces, commas,
+          # or lines.
+          any_words: nil,
+          # Cashtags separated by spaces, commas, or lines.
+          cashtags: nil,
+          # Conversation ID filter.
+          conversation_id: nil,
           # Pagination cursor for tweet replies
           cursor: nil,
+          # Exact phrase to match.
+          exact_phrase: nil,
+          # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+          exclude_words: nil,
+          # Filter by author username.
+          from_user: nil,
+          # Hashtags separated by spaces, commas, or lines.
+          hashtags: nil,
+          # Only replies to this tweet ID.
+          in_reply_to_tweet_id: nil,
+          # Language code filter, e.g. en or tr.
+          language: nil,
+          # Filter by media type.
+          media_type: nil,
+          # Filter tweets mentioning a username.
+          mentioning: nil,
+          # Minimum likes threshold.
+          min_faves: nil,
+          # Minimum quote count threshold.
+          min_quotes: nil,
+          # Minimum replies threshold.
+          min_replies: nil,
+          # Minimum retweets threshold.
+          min_retweets: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
+          # Quote mode.
+          quotes: nil,
+          # Only quotes of this tweet ID.
+          quotes_of_tweet_id: nil,
+          # Reply mode.
+          replies: nil,
+          # Retweet mode.
+          retweets: nil,
+          # Only retweets of this tweet ID.
+          retweets_of_tweet_id: nil,
+          # Start date in YYYY-MM-DD format.
+          since_date: nil,
           # Unix timestamp - return replies posted after this time
           since_time: nil,
+          # Filter replies sent to a username.
+          to_user: nil,
+          # End date in YYYY-MM-DD format.
+          until_date: nil,
           # Unix timestamp - return replies posted before this time
           until_time: nil,
+          # URL substring or domain filter.
+          url: nil,
+          # Only return tweets from verified authors.
+          verified_only: nil,
           request_options: {}
         )
         end
 
-        # Get users who retweeted a tweet
+        # List users who retweeted a tweet
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedUsers)
         end
@@ -162,15 +345,21 @@ module XTwitterScraper
           id,
           # Pagination cursor for retweeters
           cursor: nil,
+          # Maximum user profiles requested from this page (20-200, default 200). The
+          # response can contain fewer profiles because the source returned fewer or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true. The deprecated limit and count aliases remain accepted.
+          page_size: nil,
           request_options: {}
         )
         end
 
-        # Get thread context for a tweet
+        # Get full conversation thread for a tweet
         sig do
           params(
             id: String,
             cursor: String,
+            page_size: Integer,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedTweets)
         end
@@ -179,36 +368,140 @@ module XTwitterScraper
           id,
           # Pagination cursor for thread tweets
           cursor: nil,
+          # Maximum items requested from this page (1-100, default 20). The response can
+          # contain fewer items because the source returned fewer, filters removed items, or
+          # remaining credits cover fewer results. Keep requesting next_cursor while
+          # has_next_page is true, even when a page is empty. The deprecated limit and count
+          # aliases remain accepted.
+          page_size: nil,
           request_options: {}
         )
         end
 
-        # Search tweets
+        # Search tweets by query, Tweet ID, X status URL, or account date window
         sig do
           params(
             q: String,
+            advanced_query: String,
+            any_words: String,
+            bounding_box: String,
+            cashtags: String,
+            conversation_id: String,
             cursor: String,
+            exact_phrase: String,
+            exclude_words: String,
+            from_user: String,
+            hashtags: String,
+            in_reply_to_tweet_id: String,
+            language: String,
             limit: Integer,
+            list_id: String,
+            media_type:
+              XTwitterScraper::X::TweetSearchParams::MediaType::OrSymbol,
+            mentioning: String,
+            min_faves: Integer,
+            min_quotes: Integer,
+            min_replies: Integer,
+            min_retweets: Integer,
+            place: String,
+            place_country: String,
+            point_radius: String,
             query_type:
               XTwitterScraper::X::TweetSearchParams::QueryType::OrSymbol,
+            quotes: XTwitterScraper::X::TweetSearchParams::Quotes::OrSymbol,
+            quotes_of_tweet_id: String,
+            replies: XTwitterScraper::X::TweetSearchParams::Replies::OrSymbol,
+            retweets: XTwitterScraper::X::TweetSearchParams::Retweets::OrSymbol,
+            retweets_of_tweet_id: String,
+            since_date: Date,
             since_time: String,
+            to_user: String,
+            until_date: Date,
             until_time: String,
+            url: String,
+            verified_only: T::Boolean,
             request_options: XTwitterScraper::RequestOptions::OrHash
           ).returns(XTwitterScraper::PaginatedTweets)
         end
         def search(
           # Search query (keywords,
           q:,
+          # Raw advanced search query appended as-is.
+          advanced_query: nil,
+          # Words or quoted phrases where any one can match. Separate with spaces, commas,
+          # or lines.
+          any_words: nil,
+          # Geo bounding box, e.g. -74.1 40.6 -73.9 40.8.
+          bounding_box: nil,
+          # Cashtags separated by spaces, commas, or lines.
+          cashtags: nil,
+          # Conversation ID filter.
+          conversation_id: nil,
           # Pagination cursor from previous response
           cursor: nil,
+          # Exact phrase to match.
+          exact_phrase: nil,
+          # Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+          exclude_words: nil,
+          # Filter by author username.
+          from_user: nil,
+          # Hashtags separated by spaces, commas, or lines.
+          hashtags: nil,
+          # Only replies to this tweet ID.
+          in_reply_to_tweet_id: nil,
+          # Language code filter, e.g. en or tr.
+          language: nil,
           # Max tweets to return (server paginates internally). Omit for single page (~20).
+          # This is an upper bound for paid authenticated calls: remaining credits can
+          # reduce the returned page size, and zero affordable results returns 402
+          # insufficient_credits.
           limit: nil,
-          # Sort order — Latest (chronological) or Top (engagement-ranked)
+          # Search within a list ID.
+          list_id: nil,
+          # Filter by media type.
+          media_type: nil,
+          # Filter tweets mentioning a username.
+          mentioning: nil,
+          # Minimum likes threshold.
+          min_faves: nil,
+          # Minimum quote count threshold.
+          min_quotes: nil,
+          # Minimum replies threshold.
+          min_replies: nil,
+          # Minimum retweets threshold.
+          min_retweets: nil,
+          # Search within a place ID.
+          place: nil,
+          # Search within a country code.
+          place_country: nil,
+          # Geo point radius, e.g. -73.99 40.73 25mi.
+          point_radius: nil,
+          # Sort order - Latest (chronological) or Top (engagement-ranked)
           query_type: nil,
-          # ISO 8601 timestamp — only return tweets after this time
+          # Quote mode.
+          quotes: nil,
+          # Only quotes of this tweet ID.
+          quotes_of_tweet_id: nil,
+          # Reply mode.
+          replies: nil,
+          # Retweet mode.
+          retweets: nil,
+          # Only retweets of this tweet ID.
+          retweets_of_tweet_id: nil,
+          # Start date in YYYY-MM-DD format.
+          since_date: nil,
+          # ISO 8601 timestamp - only return tweets after this time
           since_time: nil,
-          # ISO 8601 timestamp — only return tweets before this time
+          # Filter replies sent to a username.
+          to_user: nil,
+          # End date in YYYY-MM-DD format.
+          until_date: nil,
+          # ISO 8601 timestamp - only return tweets before this time
           until_time: nil,
+          # URL substring or domain filter.
+          url: nil,
+          # Only return tweets from verified authors.
+          verified_only: nil,
           request_options: {}
         )
         end