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/

Request

Base URL
https://usebolsai.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/usebolsai/apis/bolsai/docs/api/v1/screener/get.ts
A function with typed inputs. Its response is checked against the schema.

sectorstring nullable

Filter by sector

sortstring

Metric to sort by

orderstring

Sort order: asc or desc

limitinteger

Results per page

offsetinteger

Pagination offset

formatstring

Response format: json or csv

Successful Response

unknown required

No recorded changes to this operation across all 14 revisions of this API.