Class: XTwitterScraper::Models::RadarItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/radar_item.rb,
sig/x_twitter_scraper/models/radar_item.rbs

Defined Under Namespace

Modules: Category, Source Classes: Metadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:, category:, created_at:, language:, metadata:, published_at:, region:, score:, source:, source_id:, title:, description: nil, image_url: nil, url: nil) ⇒ Object

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

Trending topic with score, category, source, region, language, and source-specific metadata.

Parameters:

  • id (String) —

    Radar item identifier.

  • category (Symbol, XTwitterScraper::Models::RadarItem::Category)
  • created_at (Time)
  • language (String) —

    BCP-47 language code. und means the source did not identify a language.

  • metadata (XTwitterScraper::Models::RadarItem::Metadata) —

    Source-specific fields. Shape varies per source:

  • published_at (Time)
  • region (String)
  • score (Float)
  • source (Symbol, XTwitterScraper::Models::RadarItem::Source)
  • source_id (String) —

    Source-specific identifier used for deduplication.

  • title (String)
  • description (String) (defaults to: nil)
  • image_url (String) (defaults to: nil) —

    Source image. Startup growth items return the logo here.

  • url (String) (defaults to: nil) 



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

Instance Attribute Details

#category ⇒ Symbol, XTwitterScraper::Models::RadarItem::Category

Parameters:

  • value (XTwitterScraper::Models::RadarItem::category)

Returns:



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

required :category, enum: -> { XTwitterScraper::RadarItem::Category }

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


24
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 24

required :created_at, Time, api_name: :createdAt

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :description, String

#id ⇒ String

Radar item identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 14

required :id, String

#image_url ⇒ String?

Source image. Startup growth items return the logo here.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :image_url, String, api_name: :imageUrl

#language ⇒ String

BCP-47 language code. und means the source did not identify a language.

Parameters:

  • value (String)

Returns:

  • (String) 


30
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 30

required :language, String

#metadata ⇒ XTwitterScraper::Models::RadarItem::Metadata

Source-specific fields. Shape varies per source:

  • reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?, sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?, numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?, postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?, editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?, isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?, isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. score is Reddit's public net score. Exact public upvote and downvote counts are not available. Estimated counts derive from the public score and upvote ratio, which Reddit may fuzz. Comment bodies are not included. Current items combine public listing discovery with server-rendered post data and use sourceFormat: html; json and rss remain for legacy rows.
  • github: { starsToday: number }
  • hacker_news: { points: number, numberComments: number }
  • google_trends: { approxTraffic: number }
  • polymarket: { volume24hr: number }
  • wikipedia: { views: number }
  • trustmrr: { mrr, growthPercent, last30Days, total, customers, activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?, foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?, multiple?, paymentProvider?, profitMarginLast30Days?, rank?, revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup growth source, xHandle is the founder's X username without @. The rank field is the source's revenue rank. Result order represents reported 30-day revenue-growth rank.

Parameters:

  • value (XTwitterScraper::RadarItem::Metadata)

Returns:



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

required :metadata, -> { XTwitterScraper::RadarItem::Metadata }

#published_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


67
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 67

required :published_at, Time, api_name: :publishedAt

#region ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


72
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 72

required :region, String

#score ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


77
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 77

required :score, Float

#source ⇒ Symbol, XTwitterScraper::Models::RadarItem::Source

Parameters:

  • value (XTwitterScraper::Models::RadarItem::source)

Returns:



82
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 82

required :source, enum: -> { XTwitterScraper::RadarItem::Source }

#source_id ⇒ String

Source-specific identifier used for deduplication.

Parameters:

  • value (String)

Returns:

  • (String) 


88
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 88

required :source_id, String, api_name: :sourceId

#title ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :title, String

#url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


109
 
# File 'lib/x_twitter_scraper/models/radar_item.rb', line 109

optional :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/radar_item.rb', line 159

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/x_twitter_scraper/models/radar_item.rbs', line 77

def to_hash: -> {