Screener
Screen instruments.
ModelsExpand Collapse
ScreenerFilter { field, operator, value }
A single filter criterion for the screener.
field: string
Field to filter on (e.g., "market_cap", "sector", "price")
operator: string
Comparison operator (e.g., "eq", "gte", "lte", "in")
value: unknown
Filter value
ScreenerItem { buy_ratings, hold_ratings, price, 50 more }
An instrument returned by the screener
buy_ratings: number
The count of buy analyst ratings
hold_ratings: number
The count of hold analyst ratings
price: string
The latest price for the instrument
security_id: string
The identifier for the instrument
The source of the security identifier
sell_ratings: number
The count of sell analyst ratings
strong_buy_ratings: number
The count of strong buy analyst ratings
strong_sell_ratings: number
The count of strong sell analyst ratings
symbol: string
The trading symbol for the instrument
total_ratings: number
The total count of analyst ratings
consensus_price_target?: string | null
The consensus analyst price target
consensus_price_target_high?: string | null
The highest analyst price target
consensus_price_target_low?: string | null
The lowest analyst price target
The consensus analyst rating
country_of_issue?: string | null
The ISO country code of the instrument's issue
description?: string | null
A detailed description of the instrument or company
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
gap_from_52w_high_pct?: string | null
Percent gap from 52-week high to previous day close (negative = below high)
gap_from_52w_low_pct?: string | null
Percent gap from 52-week low to previous day close (positive = above low)
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
market_cap?: string | null
The total market capitalization
month_avg_volume?: string | null
The average trading volume over the past month
name?: string | null
The full name of the instrument or its issuer
one_month_ago_close?: string | null
The closing price approximately one month ago
one_month_ago_open?: string | null
The opening price approximately one month ago
one_month_change_pct?: string | null
Percent change from one month ago close to previous day close
one_week_ago_close?: string | null
The closing price approximately one week ago
one_week_ago_open?: string | null
The opening price approximately one week ago
one_week_change_pct?: string | null
Percent change from one week ago close to previous day close
one_year_ago_close?: string | null
The closing price approximately one year ago
one_year_ago_open?: string | null
The opening price approximately one year ago
one_year_change_pct?: string | null
Percent change from one year ago close to previous day close
percent_change?: string | null
The percent change from previous close to current price
prev_day_close?: string | null
The previous day's closing price
sector?: string | null
The business sector of the instrument's issuer
security_type?: string | null
The type of security
six_month_change_pct?: string | null
Percent change from six months ago close to previous day close
six_months_ago_close?: string | null
The closing price approximately six months ago
six_months_ago_open?: string | null
The opening price approximately six months ago
three_month_change_pct?: string | null
Percent change from three months ago close to previous day close
three_months_ago_close?: string | null
The closing price approximately three months ago
three_months_ago_open?: string | null
The opening price approximately three months ago
ttm_debt_to_equity?: string | null
The TTM debt-to-equity ratio
ttm_dividend_yield?: string | null
The TTM dividend yield percent
ttm_earnings_per_share?: string | null
The TTM earnings per share
ttm_price_to_earnings?: string | null
The TTM price-to-earnings ratio
venue?: string | null
The MIC code of the primary listing venue
volume?: string | null
The latest trading volume for the instrument
week_avg_volume?: string | null
The average trading volume over the past week
year_to_date_open?: string | null
The opening price on the first trading day of the current year
ytd_change_pct?: string | null
Percent change from year-to-date open to previous day close
buy_ratings: number
The count of buy analyst ratings
hold_ratings: number
The count of hold analyst ratings
price: string
The latest price for the instrument
security_id: string
The identifier for the instrument
The source of the security identifier
sell_ratings: number
The count of sell analyst ratings
strong_buy_ratings: number
The count of strong buy analyst ratings
strong_sell_ratings: number
The count of strong sell analyst ratings
symbol: string
The trading symbol for the instrument
total_ratings: number
The total count of analyst ratings
consensus_price_target?: string | null
The consensus analyst price target
consensus_price_target_high?: string | null
The highest analyst price target
consensus_price_target_low?: string | null
The lowest analyst price target
The consensus analyst rating
country_of_issue?: string | null
The ISO country code of the instrument's issue
description?: string | null
A detailed description of the instrument or company
fifty_two_week_high?: string | null
The highest price over the last 52 weeks
fifty_two_week_low?: string | null
The lowest price over the last 52 weeks
gap_from_52w_high_pct?: string | null
Percent gap from 52-week high to previous day close (negative = below high)
gap_from_52w_low_pct?: string | null
Percent gap from 52-week low to previous day close (positive = above low)
industry?: string | null
The specific industry of the instrument's issuer
list_date?: string | null
The date the instrument was first listed
market_cap?: string | null
The total market capitalization
month_avg_volume?: string | null
The average trading volume over the past month
name?: string | null
The full name of the instrument or its issuer
one_month_ago_close?: string | null
The closing price approximately one month ago
one_month_ago_open?: string | null
The opening price approximately one month ago
one_month_change_pct?: string | null
Percent change from one month ago close to previous day close
one_week_ago_close?: string | null
The closing price approximately one week ago
one_week_ago_open?: string | null
The opening price approximately one week ago
one_week_change_pct?: string | null
Percent change from one week ago close to previous day close
one_year_ago_close?: string | null
The closing price approximately one year ago
one_year_ago_open?: string | null
The opening price approximately one year ago
one_year_change_pct?: string | null
Percent change from one year ago close to previous day close
percent_change?: string | null
The percent change from previous close to current price
prev_day_close?: string | null
The previous day's closing price
sector?: string | null
The business sector of the instrument's issuer
security_type?: string | null
The type of security
six_month_change_pct?: string | null
Percent change from six months ago close to previous day close
six_months_ago_close?: string | null
The closing price approximately six months ago
six_months_ago_open?: string | null
The opening price approximately six months ago
three_month_change_pct?: string | null
Percent change from three months ago close to previous day close
three_months_ago_close?: string | null
The closing price approximately three months ago
three_months_ago_open?: string | null
The opening price approximately three months ago
ttm_debt_to_equity?: string | null
The TTM debt-to-equity ratio
ttm_dividend_yield?: string | null
The TTM dividend yield percent
ttm_earnings_per_share?: string | null
The TTM earnings per share
ttm_price_to_earnings?: string | null
The TTM price-to-earnings ratio
venue?: string | null
The MIC code of the primary listing venue
volume?: string | null
The latest trading volume for the instrument
week_avg_volume?: string | null
The average trading volume over the past week
year_to_date_open?: string | null
The opening price on the first trading day of the current year
ytd_change_pct?: string | null
Percent change from year-to-date open to previous day close