Reference
Stock Screener
/v2/reference/screenerFilter securities by financial metrics, profile attributes, valuation multiples, stability ratios, ESG scores, and more. All query conditions are combined with AND. Results include the requested metric values alongside each security's symbol, name, and ISIN.
Included in: Growth.
Authentication
Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide
Parameters
This route takes no path or query parameters.
Try it
POST /v2/reference/screener
Sent only to api.bavest.co for this request; not stored.
Request body
queryarray of ScreenerFilterItemrequiredList of filter conditions. All conditions are combined with AND logic. Each item specifies a metric, comparison operator, and threshold value.
metricstringrequiredShort name for a screener metric. Choose a value from the metric enum.
debtRatiois total liabilities / total assets;debtToEquityRatiois total liabilities / total equity and can be negative for negative equity. These use total liabilities, unlikedebt_to_assetsanddebt_to_equityin financials.metrics, which use total debt;debt_to_equityis null for negative equity.One of
namesymbolisinstockExchangeemployeeTotalmarketCapitalizationcountrybetaindustrysectorpriceisReitretainedEarningstotalAssetscurrentAssetsfixedAssetstotalCurrentLiabilitiestotalNonCurrentLiabilitieslongTermDebttotalLiabilitiestotalEquityliabilitiesAndEquityoperatingCashFlowinvestingCashFlowfinancingCashFlowcapitalExpenditurefreeCashFlownetIncomeAfterTaxestotalRevenuegrossIncomeebitpretaxIncomeebitdaepsstockPriceshareOutstandingcdpenvironmentScoregovernanceScoresocialScoretotalESGScoredividendPerSharedividendPerShareAnnual5DayPriceReturnDaily13WeekPriceReturnDaily26WeekPriceReturnDaily52WeekPriceReturnDailyroaRfybookValuePerShareAnnualcashFlowPerShareAnnualdividendYield5YdividendGrowthRate5YepsGrowth3YepsGrowth5YcapitalSpendingGrowth5YcurrentEv/freeCashFlowAnnualcurrentEv/freeCashFlowTTMrevenueEmployeeAnnualrevenueEmployeeTTMrevenueGrowth3YrevenuePerShareAnnualrevenuePerShareTTMrevenueShareGrowth5YpayoutRatioAnnualpayoutRatioTTMperformancepriceEarningsRatiopriceBookRatiopriceCashflowRatiopriceSalesRatioev/ebitdaev/ebitev/fcfevev/revenuepropertyPlantEquipmentev/salesequityRatiodebtRatiodebtToEquityRatiodynamicLeveragecataRatiocurrentRatiofixedAssetIntensityppeRatioassetCoverage1assetCoverage2cashRatioquickRatioreturnOnEquitysalesReturnebitMarginebitdaMargincapitalTurnoverassetsReturnfundamentalScoretotalScoresentimentScoreExample
returnOnEquityoperatorstringrequiredComparison operator. Use
eqfor exact string matches (e.g., sector, country). Numeric operators (lt,gt,gte,lte) for numeric fields.One of
ltgtgtelteeqExample
gtevaluenumber | string | booleanrequiredThe value to compare against. Use a number for numeric metrics, a string for text fields (sector, country, industry, name, symbol) and a boolean for flags (
isReit, with operatoreq).Example
10
sortarray of ScreenerSortItemOptional list of sort criteria applied in order. When omitted, the default result ordering is used.
metricstringrequiredShort name for a screener metric. Choose a value from the metric enum.
debtRatiois total liabilities / total assets;debtToEquityRatiois total liabilities / total equity and can be negative for negative equity. These use total liabilities, unlikedebt_to_assetsanddebt_to_equityin financials.metrics, which use total debt;debt_to_equityis null for negative equity.One of
namesymbolisinstockExchangeemployeeTotalmarketCapitalizationcountrybetaindustrysectorpriceisReitretainedEarningstotalAssetscurrentAssetsfixedAssetstotalCurrentLiabilitiestotalNonCurrentLiabilitieslongTermDebttotalLiabilitiestotalEquityliabilitiesAndEquityoperatingCashFlowinvestingCashFlowfinancingCashFlowcapitalExpenditurefreeCashFlownetIncomeAfterTaxestotalRevenuegrossIncomeebitpretaxIncomeebitdaepsstockPriceshareOutstandingcdpenvironmentScoregovernanceScoresocialScoretotalESGScoredividendPerSharedividendPerShareAnnual5DayPriceReturnDaily13WeekPriceReturnDaily26WeekPriceReturnDaily52WeekPriceReturnDailyroaRfybookValuePerShareAnnualcashFlowPerShareAnnualdividendYield5YdividendGrowthRate5YepsGrowth3YepsGrowth5YcapitalSpendingGrowth5YcurrentEv/freeCashFlowAnnualcurrentEv/freeCashFlowTTMrevenueEmployeeAnnualrevenueEmployeeTTMrevenueGrowth3YrevenuePerShareAnnualrevenuePerShareTTMrevenueShareGrowth5YpayoutRatioAnnualpayoutRatioTTMperformancepriceEarningsRatiopriceBookRatiopriceCashflowRatiopriceSalesRatioev/ebitdaev/ebitev/fcfevev/revenuepropertyPlantEquipmentev/salesequityRatiodebtRatiodebtToEquityRatiodynamicLeveragecataRatiocurrentRatiofixedAssetIntensityppeRatioassetCoverage1assetCoverage2cashRatioquickRatioreturnOnEquitysalesReturnebitMarginebitdaMargincapitalTurnoverassetsReturnfundamentalScoretotalScoresentimentScoreExample
returnOnEquityorderstringrequiredSort direction.
One of
ascdescExample
desc
offsetintegerPagination offset (number of results to skip).
Example
0limitintegerMaximum number of results to return.
Example
10currencystringTarget currency for value conversion. When set, monetary metric values are converted to this currency.
Example
EUR
Response 200
Successful response · application/json
dataarray of ScreenerResultsymbolstringrequiredTicker symbol.
Example
AAPLnamestringrequiredCompany name.
Example
Apple IncisinstringrequiredISIN identifier.
Example
US0378331005
metaResponseMetaResponse metadata for paginated endpoints. Offset pagination returns
page/pageSize/totalPages/totalCount; cursor pagination returnspageSize/hasMore/nextCursorandtotalCountonly when known.timeintegerServer-side processing time in milliseconds
Example
17parametersobjectEcho of the request parameters the endpoint resolved
pageintegerCurrent page number (offset pagination)
Example
1pageSizeintegerNumber of results per page
Example
50totalPagesintegerTotal number of pages (offset pagination)
Example
2totalCountintegerTotal number of results across all pages
Example
100hasMorebooleanWhether more results follow (cursor pagination)
nextCursorstring | nullCursor for the next page (cursor pagination), null on the last page
Errors
- 400Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
- 401Missing or invalid API key.
- 404Resource not found.
- 429Rate limit exceeded. Retry after the `Retry-After` header interval.
- 500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
- 502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
- 504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
- defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.

