ScreenerRequest.md

ScreenerRequest

Properties

Name	Type	Description	Notes
search_query	str	A textual search term.	[optional]
exchange_ids	list[int]	The ids of the exchanges to use.	[optional]
sector_ids	list[int]	The ids of the sectors to use.	[optional]
industry_ids	list[int]	The ids of the industries to use.	[optional]
market_cap_min	float	The minimum market capitalization.	[optional]
market_cap_max	float	The maximum market capitalization.	[optional]
beta_min	float	The minimum price beta for a 5 year period calculated monthly.	[optional]
beta_max	float	The maximum price beta for a 5 year period calculated monthly.	[optional]
forward_dividend_min	float	The minimum current dividend value.	[optional]
forward_dividend_max	float	The maximum current dividend value.	[optional]
forward_dividend_yield_min	float	The minimum current dividend percentage.	[optional]
forward_dividend_yield_max	float	The maximum current dividend percentage.	[optional]
short_ratio_min	float	The minimum short ratio.	[optional]
short_ratio_max	float	The maximum short ratio.	[optional]
shares_short_percentage_min	float	The minimum percentage of shares short.	[optional]
shares_short_percentage_max	float	The maximum percentage of shares short.	[optional]
shares_short_previous_month_percentage_min	float	The minimum percentage of shares short on the last month.	[optional]
shares_short_previous_month_percentage_max	float	The maximum percentage of shares short on the last month.	[optional]
analyst_recommendation_min	Recommendation		[optional]
analyst_recommendation_max	Recommendation		[optional]
performance_one_day_min	float	The minimum stock price percentage change in the last day.	[optional]
performance_one_day_max	float	The maximum stock price percentage change in the last day.	[optional]
performance_one_week_min	float	The minimum stock price percentage change in the last week.	[optional]
performance_one_week_max	float	The maximum stock price percentage change in the last week.	[optional]
performance_two_weeks_min	float	The minimum stock price percentage change in the last two weeks.	[optional]
performance_two_weeks_max	float	The maximum stock price percentage change in the last two weeks.	[optional]
performance_one_month_min	float	The minimum stock price percentage change in the last month.	[optional]
performance_one_month_max	float	The maximum stock price percentage change in the last month.	[optional]
performance_three_months_min	float	The minimum stock price percentage change in the last three months.	[optional]
performance_three_months_max	float	The maximum stock price percentage change in the last three months.	[optional]
performance_one_year_min	float	The minimum stock price percentage change in the last year.	[optional]
performance_one_year_max	float	The maximum stock price percentage change in the last year.	[optional]
performance_three_years_min	float	The minimum stock price percentage change in the last three years.	[optional]
performance_three_years_max	float	The maximum stock price percentage change in the last three years.	[optional]
performance_five_years_min	float	The minimum stock price percentage change in the last five years.	[optional]
performance_five_years_max	float	The maximum stock price percentage change in the last five years.	[optional]
performance_ten_years_min	float	The minimum stock price percentage change in the last ten years.	[optional]
performance_ten_years_max	float	The maximum stock price percentage change in the last ten years.	[optional]
performance_twenty_years_min	float	The minimum stock price percentage change in the last twenty years.	[optional]
performance_twenty_years_max	float	The maximum stock price percentage change in the last twenty years.	[optional]
eps_growth_one_year_min	float	The minimum EPS growth in the last year.	[optional]
eps_growth_one_year_max	float	The maximum EPS growth in the last year.	[optional]
eps_growth_two_years_min	float	The minimum EPS growth in the last two years. This value is annualized.	[optional]
eps_growth_two_years_max	float	The maximum EPS growth in the last two years. This value is annualized.	[optional]
eps_growth_three_years_min	float	The minimum EPS growth in the last three years. This value is annualized.	[optional]
eps_growth_three_years_max	float	The maximum EPS growth in the last three years. This value is annualized.	[optional]
eps_growth_five_years_min	float	The minimum EPS growth in the last five years. This value is annualized.	[optional]
eps_growth_five_years_max	float	The maximum EPS growth in the last five years. This value is annualized.	[optional]
eps_growth_ten_years_min	float	The minimum EPS growth in the last ten years. This value is annualized.	[optional]
eps_growth_ten_years_max	float	The maximum EPS growth in the last ten years. This value is annualized.	[optional]
eps_growth_twenty_years_min	float	The minimum EPS growth in the last twenty years. This value is annualized.	[optional]
eps_growth_twenty_years_max	float	The maximum EPS growth in the last twenty years. This value is annualized.	[optional]
pe_min	float	The minimum price to earnings value.	[optional]
pe_max	float	The maximum price to earnings value.	[optional]
peg_min	float	The minimum price to earnings to growth value.	[optional]
peg_max	float	The maximum price to earnings to growth value.	[optional]
price_fcf_min	float	The minimum price to free cash flow value.	[optional]
price_fcf_max	float	The maximum price to free cash flow value.	[optional]
book_value_per_share_min	float	The minimum book value per share.	[optional]
book_value_per_share_max	float	The maximum book value per share.	[optional]
price_book_value_per_share_min	float	The minimum price to book value.	[optional]
price_book_value_per_share_max	float	The maximum price to book value.	[optional]
payout_min	float	The minimum payout ratio (as percentage).	[optional]
payout_max	float	The maximum payout ratio (as percentage).	[optional]
debt_to_equity_min	float	The minimum debt to equity ratio (as percentage).	[optional]
debt_to_equity_max	float	The maximum debt to equity ratio (as percentage).	[optional]
gross_margin_min	float	The minimum gross margin (as percentage).	[optional]
gross_margin_max	float	The maximum gross margin (as percentage).	[optional]
operating_margin_min	float	The minimum operating margin (as percentage).	[optional]
operating_margin_max	float	The maximum operating margin (as percentage).	[optional]
profit_margin_min	float	The minimum profit margin (as percentage).	[optional]
profit_margin_max	float	The maximum profit margin (as percentage).	[optional]
price_to_sales_min	float	The minimum price to sales ratio.	[optional]
price_to_sales_max	float	The maximum price to sales ratio.	[optional]
buybacks_three_months_min	float	The minimum percentage of shares bought back in the last 3 months. Negative values represent dilution of shares.	[optional]
buybacks_three_months_max	float	The maximum percentage of shares bought back in the last 3 months. Negative values represent dilution of shares.	[optional]
buybacks_six_months_min	float	The minimum percentage of shares bought back in the last 6 months. Negative values represent dilution of shares.	[optional]
buybacks_six_months_max	float		[optional]
buybacks_one_year_min	float	The minimum percentage of shares bought back in the last year. Negative values represent dilution of shares.	[optional]
buybacks_one_year_max	float	The maximum percentage of shares bought back in the last year. Negative values represent dilution of shares.	[optional]
buybacks_two_years_min	float	The minimum percentage of shares bought back in the last 2 years. Negative values represent dilution of shares.	[optional]
buybacks_two_years_max	float	The maximum percentage of shares bought back in the last 2 years. Negative values represent dilution of shares.	[optional]
buybacks_three_years_min	float	The minimum percentage of shares bought back in the last 3 years. Negative values represent dilution of shares.	[optional]
buybacks_three_years_max	float	The maximum percentage of shares bought back in the last 3 years. Negative values represent dilution of shares.	[optional]
buybacks_five_years_min	float	The minimum percentage of shares bought back in the last 5 years. Negative values represent dilution of shares.	[optional]
buybacks_five_years_max	float	The maximum percentage of shares bought back in the last 5 years. Negative values represent dilution of shares.	[optional]
buybacks_ten_years_min	float	The minimum percentage of shares bought back in the last 10 years. Negative values represent dilution of shares.	[optional]
buybacks_ten_years_max	float	The maximum percentage of shares bought back in the last 10 years. Negative values represent dilution of shares.	[optional]
buybacks_twenty_years_min	float	The minimum percentage of shares bought back in the last 20 years. Negative values represent dilution of shares.	[optional]
buybacks_twenty_years_max	float	The maximum percentage of shares bought back in the last 20 years. Negative values represent dilution of shares.	[optional]
potential_upside	float	The upside potential according to the analysts' target price consensus (as percentage). I.e. If the stock price is $100 and the analysts' target price consensus is $150 then the potential upside is 50%.	[optional]

[Back to Model list] [Back to API list] [Back to README]