Class: XTwitterScraper::Resources::Radar

Inherits:

Object

• Object
• XTwitterScraper::Resources::Radar

Defined in:

lib/x_twitter_scraper/resources/radar.rb,
sig/x_twitter_scraper/resources/radar.rbs

Overview

AI tweet composition, drafts, writing styles, and radar

Instance Method Summary

• #initialize(client:) ⇒ Radar constructor private

  A new instance of Radar.

• #retrieve_trending_topics(after: nil, category: nil, hours: nil, limit: nil, region: nil, source: nil, request_options: {}) ⇒ XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse

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

Constructor Details

#initialize(client:) ⇒ Radar

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

Parameters:

• client (XTwitterScraper::Client)
• client: (XTwitterScraper::Client)

# File 'lib/x_twitter_scraper/resources/radar.rb', line 46

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_trending_topics(after: nil, category: nil, hours: nil, limit: nil, region: nil, source: nil, request_options: {}) ⇒ XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse

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

Get trending topics from curated sources

Parameters:

• after (String) —

  Cursor for pagination (from prior response nextCursor).

• category (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Category) —

  Filter by category.

• hours (Integer) —

  Lookback window in hours (1-72, default 6).

• limit (Integer) —

  Number of items to return (1-100, default 50).

• region (String) —

  Region filter. Use global or a region code such as US, GB, TR, or ES.

• source (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source) —

  Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, t

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

Returns:

• (XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse)

See Also:

• Models::RadarRetrieveTrendingTopicsParams

# File 'lib/x_twitter_scraper/resources/radar.rb', line 31

def retrieve_trending_topics(params = {})
  parsed, options = XTwitterScraper::RadarRetrieveTrendingTopicsParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "radar",
    query: query,
    model: XTwitterScraper::Models::RadarRetrieveTrendingTopicsResponse,
    options: options
  )
end