v2

latestOpenAPI 3.1.02026-07-26512050.1 KB
screener

Screen Stocks

Screen stocks by fundamental metrics.

Scans all ~264 traded companies. Use {metric}_gt and {metric}_lt query params to filter (e.g. ?pl_lt=15&roe_gt=10&dividend_yield_gt=5).

get/api/v1/screener/

Query parameters

sectorstring nullable

Filter by sector

Filter by sector

sortstring

Metric to sort by

Metric to sort by

orderstring

Sort order: asc or desc

Sort order: asc or desc

limitinteger

Results per page

Results per page

offsetinteger

Pagination offset

Pagination offset

formatstring

Response format: json or csv

Response format: json or csv

Response

Successful Response

{"stackTrail":"paths:/api/v1/screener/:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}