Authorizations
Query Parameters
Select a predefined screening strategy to filter stocks
aggressive_small_caps
, conservative_foreign_funds
, day_gainers
, day_losers
, growth_technology_stocks
, high_yield_bond
, most_actives
, most_shorted_stocks
, portfolio_anchors
, small_cap_gainers
, solid_large_growth_funds
, solid_midcap_growth_funds
, top_mutual_funds
, undervalued_growth_stocks
, undervalued_large_caps
"day_gainers"
"most_actives"
"growth_technology_stocks"
Maximum number of stocks to return in the response
1 <= x <= 100
10
25
50
100
Geographic market region to filter stocks
"US"
"GB"
"CA"
"AU"
"DE"
Language preference for localized content
"en-US"
"en-GB"
"fr-FR"
"de-DE"
"es-ES"
Response
Screener results retrieved successfully
Complete response structure for stock screening requests
Indicates successful API response
List of stocks that match the specified screening criteria
[
{
"symbol": "AAPL",
"shortName": "Apple Inc.",
"regularMarketPrice": 185.64,
"regularMarketChange": 2.15,
"regularMarketChangePercent": 1.17
}
]
ISO 8601 timestamp of the response
Information about result pagination and total counts
Optional success message
Optional metadata including pagination, statistics, and additional context