tradingview-screener

ActiveRecord-style Ruby client for TradingView's scanner API.

Inspired by shner-elmo/TradingView-Screener, but designed like Rails ORM relations — not a Python port.

This is an unofficial client and is not affiliated with or endorsed by TradingView. The scanner endpoints are not a guaranteed public API and may change without notice.

Gem name uses hyphens (tradingview-screener); the require path and module use underscores:

require "tradingview_screener"
# also works: require "tradingview/screener"  # Bundler default for hyphen gems
TradingviewScreener::Stock

If Bundler does not load it automatically, set:

gem "tradingview-screener", require: "tradingview_screener"

Install

Ruby 3.1 or newer is required.

From a local path

# Gemfile
gem "tradingview-screener", path: "../tradingview-screener"

From RubyGems

# Gemfile
gem "tradingview-screener", "~> 0.2"

gem install tradingview-screener

SOCKS proxies are optional. If you need them:

gem "socksify", "~> 1.7"

Quick start

require "tradingview_screener"

rows = TradingviewScreener::Stock
  .where(close: 10..300)
  .where(volume: TradingviewScreener::Predicates.gt(1_000_000))
  .where(TradingviewScreener::Stock[:close].gt(TradingviewScreener::Stock[:SMA20]))
  .order(volume: :desc)
  .limit(20)
  .to_a

rows.first["ticker"]  # => "NASDAQ:NVDA"

ORM-shaped API

ActiveRecord	tradingview-screener
Model.where(a: 1)	Stock.where(is_primary: true)
where(price: 10..20)	where(close: 10..300)
where(status: %w[a b])	where(type: %w[stock fund])
order(created_at: :desc)	order(premarket_volume: :desc)
limit / offset	same
select(:id, :name)	select("name", "close")
scope :active, -> { ... }	same
default_scope	same
all / to_a / count / pluck / first	same
relation is immutable chain	same

Operators

where(volume: TradingviewScreener::Predicates.gt(1_000_000))
where(market_cap_basic: TradingviewScreener::Predicates.gte(1_000_000_000))
where(ATRP: TradingviewScreener::Predicates.lt(6))

# Arel-like nodes
where(TradingviewScreener::Stock[:close].gt(TradingviewScreener::Stock[:SMA20]))
where(TradingviewScreener::Stock[:typespecs].has(["common"]))

Scopes

class MyScreen < TradingviewScreener::Base
  market "america"
  default_scope { where(is_primary: true) }

  scope :liquid, -> {
    where("AvgValue.Traded_10d" => TradingviewScreener::Predicates.gt(50_000_000))
  }
  scope :wide_atr, -> {
    where(ATRP: TradingviewScreener::Predicates.gt(1))
      .where(ATRP: TradingviewScreener::Predicates.lt(6))
  }
end

MyScreen.liquid.wide_atr.order(volume: :desc).limit(50).load

Built-in momentum scopes

TradingviewScreener::Stock.momentum_trend_long.to_a
TradingviewScreener::Stock.momentum_trend_short.ids
TradingviewScreener::Stock.momentum_scalping_long.to_a
TradingviewScreener::Stock.open_range_breakout_short.ids

Saved screener URL / screen_data

rel = TradingviewScreener::Stock.from_screener_url(
  "https://www.tradingview.com/screener/YOUR_SCREEN_ID/",
  cookies: {
    "sessionid" => ENV.fetch("TRADINGVIEW_SESSIONID"),
    "sessionid_sign" => ENV.fetch("TRADINGVIEW_SESSIONID_SIGN")
  }
)
rel.to_a

Cookies / proxy

TradingviewScreener::Stock.momentum_trend_long.load(
  cookies: {
    "sessionid" => ENV.fetch("TRADINGVIEW_SESSIONID"),
    "sessionid_sign" => ENV.fetch("TRADINGVIEW_SESSIONID_SIGN")
  },
  proxy: "http://user:pass@127.0.0.1:7890"
)

Debugging

rel = TradingviewScreener::Stock
  .where(TradingviewScreener::Stock[:close].gt(TradingviewScreener::Stock[:SMA20]))
  .limit(10)

puts rel.to_sql      # JSON payload sent to scanner
puts rel.scanner_url

Development

bundle install
bundle exec rspec
bundle exec rake build   # => pkg/tradingview-screener-0.2.0.gem
gem build tradingview-screener.gemspec --strict

Before publishing, verify that the version is not already in use and inspect the package:

gem build tradingview-screener.gemspec --strict
gem contents --show-install-dir tradingview-screener # after installing the built gem
gem push tradingview-screener-0.2.0.gem

RubyGems MFA is required for releases. Source code and issue tracking are available on GitHub.

License

MIT