FMP Node API Documentation
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
| Method | Endpoint | Description |
|---|---|---|
| GET | stable/company-screener | Screen companies based on customizable financial criteria |
| GET | stable/available-exchanges | Get list of available stock exchanges for screening |
| GET | stable/available-sectors | Get list of available business sectors for screening |
| GET | stable/available-industries | Get list of available industries for screening |
| GET | stable/available-countries | Get 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.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| marketCapMoreThan | number | No | Minimum market capitalization |
| marketCapLowerThan | number | No | Maximum market capitalization |
| priceMoreThan | number | No | Minimum stock price |
| priceLowerThan | number | No | Maximum stock price |
| betaMoreThan | number | No | Minimum beta value |
| betaLowerThan | number | No | Maximum beta value |
| volumeMoreThan | number | No | Minimum trading volume |
| volumeLowerThan | number | No | Maximum trading volume |
| dividendMoreThan | number | No | Minimum dividend yield |
| dividendLowerThan | number | No | Maximum dividend yield |
| isEtf | boolean | No | Filter for ETFs only |
| isActivelyTrading | boolean | No | Filter for actively trading stocks |
| sector | string | No | Filter by specific sector |
| industry | string | No | Filter by specific industry |
| country | string | No | Filter by specific country |
| exchange | string | No | Filter by specific exchange |
| limit | number | No | Maximum number of results to return |
Example Response
Get Available Exchanges
Retrieve all supported stock exchanges that can be used as filters in the company screener.
Example Response
Get Available Sectors
Retrieve all supported business sectors that can be used as filters in the company screener.
Example Response
Get Available Industries
Retrieve all supported industries that can be used as filters in the company screener. Provides more granular filtering than sectors.
Example Response
Get Available Countries
Retrieve all supported countries that can be used as filters in the company screener.
Example Response
Data Types
Screener
AvailableExchanges
AvailableSectors
AvailableIndustries
AvailableCountries
ScreenerParams
Error Handling
All screener endpoints return a standardized response format with error handling:
When an error occurs, the response will include:
success: falsedata: nullerror: 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
Dynamic Filtering
Multi-Criteria Analysis
Sector Analysis
Portfolio Screening
Documentation
Quotes
Information
Resources
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
| Method | Endpoint | Description |
|---|---|---|
| GET | stable/company-screener | Screen companies based on customizable financial criteria |
| GET | stable/available-exchanges | Get list of available stock exchanges for screening |
| GET | stable/available-sectors | Get list of available business sectors for screening |
| GET | stable/available-industries | Get list of available industries for screening |
| GET | stable/available-countries | Get 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.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| marketCapMoreThan | number | No | Minimum market capitalization |
| marketCapLowerThan | number | No | Maximum market capitalization |
| priceMoreThan | number | No | Minimum stock price |
| priceLowerThan | number | No | Maximum stock price |
| betaMoreThan | number | No | Minimum beta value |
| betaLowerThan | number | No | Maximum beta value |
| volumeMoreThan | number | No | Minimum trading volume |
| volumeLowerThan | number | No | Maximum trading volume |
| dividendMoreThan | number | No | Minimum dividend yield |
| dividendLowerThan | number | No | Maximum dividend yield |
| isEtf | boolean | No | Filter for ETFs only |
| isActivelyTrading | boolean | No | Filter for actively trading stocks |
| sector | string | No | Filter by specific sector |
| industry | string | No | Filter by specific industry |
| country | string | No | Filter by specific country |
| exchange | string | No | Filter by specific exchange |
| limit | number | No | Maximum number of results to return |
Example Response
Get Available Exchanges
Retrieve all supported stock exchanges that can be used as filters in the company screener.
Example Response
Get Available Sectors
Retrieve all supported business sectors that can be used as filters in the company screener.
Example Response
Get Available Industries
Retrieve all supported industries that can be used as filters in the company screener. Provides more granular filtering than sectors.
Example Response
Get Available Countries
Retrieve all supported countries that can be used as filters in the company screener.
Example Response
Data Types
Screener
AvailableExchanges
AvailableSectors
AvailableIndustries
AvailableCountries
ScreenerParams
Error Handling
All screener endpoints return a standardized response format with error handling:
When an error occurs, the response will include:
success: falsedata: nullerror: 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.