Screener API
Predefined YH screeners such as day gainers, day losers and most actives, ranked and paginated, up to 250 members per call.
GET/ws/screeners/v1/finance/screener/predefined/saved
Request
curl -H "x-api-key: $KEY" \
"https://api.stockdataapi.com/ws/screeners/v1/finance/screener/predefined/saved?scrIds=day_gainers&count=25"Send your key in the x-api-key header. Try it in the browser with your own key.
Parameters
scrIdsquerystringrequired
Predefined screener id:
day_gainers, day_losers, most_actives, undervalued_growth_stocks, growth_technology_stocks and others. Only the first of a comma list is used.countqueryinteger
Members to return, 1–250.
Default:
25startqueryinteger
Offset into the ranked members, 0–10,000.
Default:
0Behavior
- An id the source does not know answers 200 with an empty
result, and is not asked about again for an hour. - Also served at
/v1/finance/screener/predefined/saved.
Example response
{
"finance": {
"result": [
{
"id": "day_gainers",
"title": "Day Gainers",
"canonicalName": "DAY_GAINERS",
"description": "Stocks ordered by percent change with respect to the previous close",
"criteriaMeta": { "size": 25, "sortField": "percentchange" },
"quotes": [
{
"symbol": "SMCI",
"shortName": "Super Micro Computer, Inc.",
"exchange": "NMS",
"quoteType": "EQUITY",
"regularMarketPrice": { "raw": 48.91, "fmt": "48.91" },
"regularMarketChangePercent": { "raw": 12.4, "fmt": "12.40%" }
}
],
"count": 25,
"total": 100,
"start": 0
}
],
"error": null
}
}jsonRelated endpoints
Every plan includes this endpoint.
Create your free key