Skip to main content
POST
/
api
/
tradingview
/
screener
/tradingview/screener
curl --request POST \
  --url https://api.anysite.io/api/tradingview/screener \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "region": "america",
  "sector": "Technology Services",
  "min_market_cap": 1,
  "max_market_cap": 1,
  "min_price": 1,
  "max_price": 1,
  "min_price_earnings": 123,
  "max_price_earnings": 123,
  "min_dividend_yield": 1,
  "sort_by": "market_cap",
  "sort_order": "desc"
}
'
[
  {
    "symbol": "<string>",
    "@type": "@trading_view_screener_stock",
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "close": 123,
    "change": 123,
    "change_abs": 123,
    "volume": 123,
    "market_cap": 123,
    "price_earnings_ttm": 123,
    "earnings_per_share_ttm": 123,
    "dividend_yield": 123,
    "sector": "<string>",
    "industry": "<string>",
    "country": "<string>",
    "exchange": "<string>",
    "currency": "<string>",
    "analyst_rating": "<string>",
    "technical_rating": 123,
    "type": "<string>",
    "typespecs": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Maximum number of instruments to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
region
enum<string>
default:america

Market region to screen

Available options:
america,
australia,
canada,
germany,
india,
uk
exchange
enum<string> | null

Filter by listing exchange

Available options:
NASDAQ,
NYSE,
AMEX,
OTC
sector
string | null

Filter by sector

Example:

"Technology Services"

analyst_rating
enum<string> | null

Filter by analyst rating

Available options:
StrongBuy,
Buy,
Neutral,
Sell,
StrongSell
min_market_cap
number | null

Minimum market capitalization

Required range: x >= 0
max_market_cap
number | null

Maximum market capitalization

Required range: x >= 0
min_price
number | null

Minimum last price

Required range: x >= 0
max_price
number | null

Maximum last price

Required range: x >= 0
min_price_earnings
number | null

Minimum trailing P/E ratio

max_price_earnings
number | null

Maximum trailing P/E ratio

min_dividend_yield
number | null

Minimum dividend yield percent

Required range: x >= 0
sort_by
enum<string>
default:market_cap

Field to sort by

Available options:
market_cap,
volume,
change,
price,
price_earnings,
dividend_yield
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

Successful Response

symbol
string
required
@type
string
default:@trading_view_screener_stock
name
string | null
description
string | null
image
string | null
close
number | null
change
number | null
change_abs
number | null
volume
number | null
market_cap
number | null
price_earnings_ttm
number | null
earnings_per_share_ttm
number | null
dividend_yield
number | null
sector
string | null
industry
string | null
country
string | null
exchange
string | null
currency
string | null
analyst_rating
string | null
technical_rating
number | null
type
string | null
typespecs
string[]