Screener Endpoints

The Screener Endpoints provide powerful tools for filtering and searching companies based on various financial metrics, market data, and company characteristics. Perfect for finding investment opportunities, conducting market research, or building custom stock filters.

Available Methods

MethodEndpointDescription
GETstable/company-screenerScreen companies based on customizable financial criteria
GETstable/available-exchangesGet list of available stock exchanges for screening
GETstable/available-sectorsGet list of available business sectors for screening
GETstable/available-industriesGet list of available industries for screening
GETstable/available-countriesGet list of available countries for screening

Get Company Screener

Screen companies based on customizable financial criteria. This endpoint allows you to filter and search for companies based on various financial metrics, market data, and company characteristics.

TypeScriptTypeScript
ParameterTypeDescription
marketCapMoreThannumberoptionalMinimum market capitalization
marketCapLowerThannumberoptionalMaximum market capitalization
priceMoreThannumberoptionalMinimum stock price
priceLowerThannumberoptionalMaximum stock price
betaMoreThannumberoptionalMinimum beta value
betaLowerThannumberoptionalMaximum beta value
volumeMoreThannumberoptionalMinimum trading volume
volumeLowerThannumberoptionalMaximum trading volume
dividendMoreThannumberoptionalMinimum dividend yield
dividendLowerThannumberoptionalMaximum dividend yield
isEtfbooleanoptionalFilter for ETFs only
isActivelyTradingbooleanoptionalFilter for actively trading stocks
sectorstringoptionalFilter by specific sector
industrystringoptionalFilter by specific industry
countrystringoptionalFilter by specific country
exchangestringoptionalFilter by specific exchange
limitnumberoptionalMaximum number of results to return

Example Response

TypeScriptTypeScript

Get Available Exchanges

Retrieve all supported stock exchanges that can be used as filters in the company screener.

TypeScriptTypeScript

Example Response

TypeScriptTypeScript

Get Available Sectors

Retrieve all supported business sectors that can be used as filters in the company screener.

TypeScriptTypeScript

Example Response

TypeScriptTypeScript

Get Available Industries

Retrieve all supported industries that can be used as filters in the company screener. Provides more granular filtering than sectors.

TypeScriptTypeScript

Example Response

TypeScriptTypeScript

Get Available Countries

Retrieve all supported countries that can be used as filters in the company screener.

TypeScriptTypeScript

Example Response

TypeScriptTypeScript

Data Types

Screener

TypeScriptTypeScript

AvailableExchanges

TypeScriptTypeScript

AvailableSectors

TypeScriptTypeScript

AvailableIndustries

TypeScriptTypeScript

AvailableCountries

TypeScriptTypeScript

ScreenerParams

TypeScriptTypeScript

Error Handling

All screener endpoints return a standardized response format with error handling:

TypeScriptTypeScript

When an error occurs, the response will include:

  • success: false
  • data: null
  • error: string - Description of the error

Rate Limits

Screener endpoints are subject to the same rate limits as other FMP API endpoints. Please refer to your subscription plan for specific limits.

Examples

Basic Company Screening

TypeScriptTypeScript

Dynamic Filtering

TypeScriptTypeScript

Multi-Criteria Analysis

TypeScriptTypeScript

Sector Analysis

TypeScriptTypeScript

Portfolio Screening

TypeScriptTypeScript