finviz-screener
Version:
FinViz screener library for Node.js
616 lines (327 loc) • 92.7 kB
Markdown
# API Docs
## Index
* [FinVizScreener](#FinVizScreener)
* [Type Definitions](#TypeDefinitions)
<br><a name="FinVizScreener"></a>
## FinVizScreener
* [FinVizScreener](#FinVizScreener)
* [new FinVizScreener(options)](#new_FinVizScreener_new)
* [fv.options](#FinVizScreener+options) : [<code>Options</code>](#Options)
* [fv.scan()](#FinVizScreener+scan) ⇒ <code>Promise.<Array.<string>></code>
* [fv.exchange(filter)](#FinVizScreener+exchange) ⇒ <code>this</code>
* [fv.index(filter)](#FinVizScreener+index) ⇒ <code>this</code>
* [fv.sector(filter)](#FinVizScreener+sector) ⇒ <code>this</code>
* [fv.industry(filter)](#FinVizScreener+industry) ⇒ <code>this</code>
* [fv.country(filter)](#FinVizScreener+country) ⇒ <code>this</code>
* [fv.marketCap(filter)](#FinVizScreener+marketCap) ⇒ <code>this</code>
* [fv.pe(filter)](#FinVizScreener+pe) ⇒ <code>this</code>
* [fv.forwardPe(filter)](#FinVizScreener+forwardPe) ⇒ <code>this</code>
* [fv.peg(filter)](#FinVizScreener+peg) ⇒ <code>this</code>
* [fv.ps(filter)](#FinVizScreener+ps) ⇒ <code>this</code>
* [fv.pb(filter)](#FinVizScreener+pb) ⇒ <code>this</code>
* [fv.priceCash(filter)](#FinVizScreener+priceCash) ⇒ <code>this</code>
* [fv.priceFreeCashFlow(filter)](#FinVizScreener+priceFreeCashFlow) ⇒ <code>this</code>
* [fv.epsGrowththisYear(filter)](#FinVizScreener+epsGrowththisYear) ⇒ <code>this</code>
* [fv.epsGrowthnextYear(filter)](#FinVizScreener+epsGrowthnextYear) ⇒ <code>this</code>
* [fv.epsGrowthpast5Years(filter)](#FinVizScreener+epsGrowthpast5Years) ⇒ <code>this</code>
* [fv.epsGrowthnext5Years(filter)](#FinVizScreener+epsGrowthnext5Years) ⇒ <code>this</code>
* [fv.salesGrowthpast5Years(filter)](#FinVizScreener+salesGrowthpast5Years) ⇒ <code>this</code>
* [fv.epsGrowthqtrOverQtr(filter)](#FinVizScreener+epsGrowthqtrOverQtr) ⇒ <code>this</code>
* [fv.salesGrowthqtrOverQtr(filter)](#FinVizScreener+salesGrowthqtrOverQtr) ⇒ <code>this</code>
* [fv.dividendYield(filter)](#FinVizScreener+dividendYield) ⇒ <code>this</code>
* [fv.returnOnAssets(filter)](#FinVizScreener+returnOnAssets) ⇒ <code>this</code>
* [fv.returnOnEquity(filter)](#FinVizScreener+returnOnEquity) ⇒ <code>this</code>
* [fv.returnOnInvestment(filter)](#FinVizScreener+returnOnInvestment) ⇒ <code>this</code>
* [fv.currentRatio(filter)](#FinVizScreener+currentRatio) ⇒ <code>this</code>
* [fv.quickRatio(filter)](#FinVizScreener+quickRatio) ⇒ <code>this</code>
* [fv.ltDebtEquity(filter)](#FinVizScreener+ltDebtEquity) ⇒ <code>this</code>
* [fv.debtEquity(filter)](#FinVizScreener+debtEquity) ⇒ <code>this</code>
* [fv.grossMargin(filter)](#FinVizScreener+grossMargin) ⇒ <code>this</code>
* [fv.operatingMargin(filter)](#FinVizScreener+operatingMargin) ⇒ <code>this</code>
* [fv.netProfitMargin(filter)](#FinVizScreener+netProfitMargin) ⇒ <code>this</code>
* [fv.payoutRatio(filter)](#FinVizScreener+payoutRatio) ⇒ <code>this</code>
* [fv.insiderOwnership(filter)](#FinVizScreener+insiderOwnership) ⇒ <code>this</code>
* [fv.insiderTransactions(filter)](#FinVizScreener+insiderTransactions) ⇒ <code>this</code>
* [fv.institutionalOwnership(filter)](#FinVizScreener+institutionalOwnership) ⇒ <code>this</code>
* [fv.institutionalTransactions(filter)](#FinVizScreener+institutionalTransactions) ⇒ <code>this</code>
* [fv.floatShort(filter)](#FinVizScreener+floatShort) ⇒ <code>this</code>
* [fv.analystRecom(filter)](#FinVizScreener+analystRecom) ⇒ <code>this</code>
* [fv.optionShort(filter)](#FinVizScreener+optionShort) ⇒ <code>this</code>
* [fv.earningsDate(filter)](#FinVizScreener+earningsDate) ⇒ <code>this</code>
* [fv.performance(filter)](#FinVizScreener+performance) ⇒ <code>this</code>
* [fv.performance2(filter)](#FinVizScreener+performance2) ⇒ <code>this</code>
* [fv.volatility(filter)](#FinVizScreener+volatility) ⇒ <code>this</code>
* [fv.rsi14(filter)](#FinVizScreener+rsi14) ⇒ <code>this</code>
* [fv.gap(filter)](#FinVizScreener+gap) ⇒ <code>this</code>
* [fv.twentyDaySimpleMovingAverage(filter)](#FinVizScreener+twentyDaySimpleMovingAverage) ⇒ <code>this</code>
* [fv.fiftyDaySimpleMovingAverage(filter)](#FinVizScreener+fiftyDaySimpleMovingAverage) ⇒ <code>this</code>
* [fv.twoHundredDaySimpleMovingAverage(filter)](#FinVizScreener+twoHundredDaySimpleMovingAverage) ⇒ <code>this</code>
* [fv.change(filter)](#FinVizScreener+change) ⇒ <code>this</code>
* [fv.changeFromOpen(filter)](#FinVizScreener+changeFromOpen) ⇒ <code>this</code>
* [fv.twentyDayHighLow(filter)](#FinVizScreener+twentyDayHighLow) ⇒ <code>this</code>
* [fv.fiftyDayHighLow(filter)](#FinVizScreener+fiftyDayHighLow) ⇒ <code>this</code>
* [fv.fiftyTwoWeekHighLow(filter)](#FinVizScreener+fiftyTwoWeekHighLow) ⇒ <code>this</code>
* [fv.pattern(filter)](#FinVizScreener+pattern) ⇒ <code>this</code>
* [fv.candlestick(filter)](#FinVizScreener+candlestick) ⇒ <code>this</code>
* [fv.beta(filter)](#FinVizScreener+beta) ⇒ <code>this</code>
* [fv.averageTrueRange(filter)](#FinVizScreener+averageTrueRange) ⇒ <code>this</code>
* [fv.averageVolume(filter)](#FinVizScreener+averageVolume) ⇒ <code>this</code>
* [fv.relativeVolume(filter)](#FinVizScreener+relativeVolume) ⇒ <code>this</code>
* [fv.currentVolume(filter)](#FinVizScreener+currentVolume) ⇒ <code>this</code>
* [fv.price(filter)](#FinVizScreener+price) ⇒ <code>this</code>
* [fv.targetPrice(filter)](#FinVizScreener+targetPrice) ⇒ <code>this</code>
* [fv.ipoDate(filter)](#FinVizScreener+ipoDate) ⇒ <code>this</code>
* [fv.sharesOutstanding(filter)](#FinVizScreener+sharesOutstanding) ⇒ <code>this</code>
* [fv.float(filter)](#FinVizScreener+float) ⇒ <code>this</code>
* [fv.signal(signal)](#FinVizScreener+signal) ⇒ <code>this</code>
<br><a name="new_FinVizScreener_new"></a>
### new FinVizScreener(options)
**Arguments**
- **options ([<code>Options</code>](#Options))** : Options
**Example**
```js
const fv = new FinVizScreener()
const tickers = await fv
.averageVolume('Over 2M')
.sector('Technology')
.price('Over $50')
.scan()
console.log(tickers) //=> ['AAPL', 'MSFT', 'IBM', ... ]
```
<br><a name="FinVizScreener+options"></a>
### fv.options : [<code>Options</code>](#Options)
Client instance options
<br><a name="FinVizScreener+scan"></a>
### fv.scan() ⇒ <code>Promise.<Array.<string>></code>
Scan for stocks.
**Returns**
- **<code>Promise.<Array.<string>></code>** : List of stock tickers
<br><a name="FinVizScreener+exchange"></a>
### fv.exchange(filter) ⇒ <code>this</code>
Stock Exchange at which a stock is listed.
**Arguments**
- **filter (<code>'AMEX'</code> | <code>'NASDAQ'</code> | <code>'NYSE'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+index"></a>
### fv.index(filter) ⇒ <code>this</code>
A major index membership of a stock.
**Arguments**
- **filter (<code>'S&P 500'</code> | <code>'DJIA'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+sector"></a>
### fv.sector(filter) ⇒ <code>this</code>
The sector which a stock belongs to.
**Arguments**
- **filter (<code>'Basic Materials'</code> | <code>'Communication Services'</code> | <code>'Consumer Cyclical'</code> | <code>'Consumer Defensive'</code> | <code>'Energy'</code> | <code>'Financial'</code> | <code>'Healthcare'</code> | <code>'Industrials'</code> | <code>'Real Estate'</code> | <code>'Technology'</code> | <code>'Utilities'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+industry"></a>
### fv.industry(filter) ⇒ <code>this</code>
The industry which a stock belongs to.
**Arguments**
- **filter (<code>'Stocks only (ex-Funds)'</code> | <code>'Exchange Traded Fund'</code> | <code>'Advertising Agencies'</code> | <code>'Aerospace & Defense'</code> | <code>'Agricultural Inputs'</code> | <code>'Airlines'</code> | <code>'Airports & Air Services'</code> | <code>'Aluminum'</code> | <code>'Apparel Manufacturing'</code> | <code>'Apparel Retail'</code> | <code>'Asset Management'</code> | <code>'Auto Manufacturers'</code> | <code>'Auto Parts'</code> | <code>'Auto & Truck Dealerships'</code> | <code>'Banks - Diversified'</code> | <code>'Banks - Regional'</code> | <code>'Beverages - Brewers'</code> | <code>'Beverages - Non-Alcoholic'</code> | <code>'Beverages - Wineries & Distilleries'</code> | <code>'Biotechnology'</code> | <code>'Broadcasting'</code> | <code>'Building Materials'</code> | <code>'Building Products & Equipment'</code> | <code>'Business Equipment & Supplies'</code> | <code>'Capital Markets'</code> | <code>'Chemicals'</code> | <code>'Closed-End Fund - Debt'</code> | <code>'Closed-End Fund - Equity'</code> | <code>'Closed-End Fund - Foreign'</code> | <code>'Coking Coal'</code> | <code>'Communication Equipment'</code> | <code>'Computer Hardware'</code> | <code>'Confectioners'</code> | <code>'Conglomerates'</code> | <code>'Consulting Services'</code> | <code>'Consumer Electronics'</code> | <code>'Copper'</code> | <code>'Credit Services'</code> | <code>'Department Stores'</code> | <code>'Diagnostics & Research'</code> | <code>'Discount Stores'</code> | <code>'Drug Manufacturers - General'</code> | <code>'Drug Manufacturers - Specialty & Generic'</code> | <code>'Education & Training Services'</code> | <code>'Electrical Equipment & Parts'</code> | <code>'Electronic Components'</code> | <code>'Electronic Gaming & Multimedia'</code> | <code>'Electronics & Computer Distribution'</code> | <code>'Engineering & Construction'</code> | <code>'Entertainment'</code> | <code>'Exchange Traded Fund'</code> | <code>'Farm & Heavy Construction Machinery'</code> | <code>'Farm Products'</code> | <code>'Financial Conglomerates'</code> | <code>'Financial Data & Stock Exchanges'</code> | <code>'Food Distribution'</code> | <code>'Footwear & Accessories'</code> | <code>'Furnishings, Fixtures & Appliances'</code> | <code>'Gambling'</code> | <code>'Gold'</code> | <code>'Grocery Stores'</code> | <code>'Healthcare Plans'</code> | <code>'Health Information Services'</code> | <code>'Home Improvement Retail'</code> | <code>'Household & Personal Products'</code> | <code>'Industrial Distribution'</code> | <code>'Information Technology Services'</code> | <code>'Infrastructure Operations'</code> | <code>'Insurance Brokers'</code> | <code>'Insurance - Diversified'</code> | <code>'Insurance - Life'</code> | <code>'Insurance - Property & Casualty'</code> | <code>'Insurance - Reinsurance'</code> | <code>'Insurance - Specialty'</code> | <code>'Integrated Freight & Logistics'</code> | <code>'Internet Content & Information'</code> | <code>'Internet Retail'</code> | <code>'Leisure'</code> | <code>'Lodging'</code> | <code>'Lumber & Wood Production'</code> | <code>'Luxury Goods'</code> | <code>'Marine Shipping'</code> | <code>'Medical Care Facilities'</code> | <code>'Medical Devices'</code> | <code>'Medical Distribution'</code> | <code>'Medical Instruments & Supplies'</code> | <code>'Metal Fabrication'</code> | <code>'Mortgage Finance'</code> | <code>'Oil & Gas Drilling'</code> | <code>'Oil & Gas E&P'</code> | <code>'Oil & Gas Equipment & Services'</code> | <code>'Oil & Gas Integrated'</code> | <code>'Oil & Gas Midstream'</code> | <code>'Oil & Gas Refining & Marketing'</code> | <code>'Other Industrial Metals & Mining'</code> | <code>'Other Precious Metals & Mining'</code> | <code>'Packaged Foods'</code> | <code>'Packaging & Containers'</code> | <code>'Paper & Paper Products'</code> | <code>'Personal Services'</code> | <code>'Pharmaceutical Retailers'</code> | <code>'Pollution & Treatment Controls'</code> | <code>'Publishing'</code> | <code>'Railroads'</code> | <code>'Real Estate - Development'</code> | <code>'Real Estate - Diversified'</code> | <code>'Real Estate Services'</code> | <code>'Recreational Vehicles'</code> | <code>'REIT - Diversified'</code> | <code>'REIT - Healthcare Facilities'</code> | <code>'REIT - Hotel & Motel'</code> | <code>'REIT - Industrial'</code> | <code>'REIT - Mortgage'</code> | <code>'REIT - Office'</code> | <code>'REIT - Residential'</code> | <code>'REIT - Retail'</code> | <code>'REIT - Specialty'</code> | <code>'Rental & Leasing Services'</code> | <code>'Residential Construction'</code> | <code>'Resorts & Casinos'</code> | <code>'Restaurants'</code> | <code>'Scientific & Technical Instruments'</code> | <code>'Security & Protection Services'</code> | <code>'Semiconductor Equipment & Materials'</code> | <code>'Semiconductors'</code> | <code>'Shell Companies'</code> | <code>'Silver'</code> | <code>'Software - Application'</code> | <code>'Software - Infrastructure'</code> | <code>'Solar'</code> | <code>'Specialty Business Services'</code> | <code>'Specialty Chemicals'</code> | <code>'Specialty Industrial Machinery'</code> | <code>'Specialty Retail'</code> | <code>'Staffing & Employment Services'</code> | <code>'Steel'</code> | <code>'Telecom Services'</code> | <code>'Textile Manufacturing'</code> | <code>'Thermal Coal'</code> | <code>'Tobacco'</code> | <code>'Tools & Accessories'</code> | <code>'Travel Services'</code> | <code>'Trucking'</code> | <code>'Uranium'</code> | <code>'Utilities - Diversified'</code> | <code>'Utilities - Independent Power Producers'</code> | <code>'Utilities - Regulated Electric'</code> | <code>'Utilities - Regulated Gas'</code> | <code>'Utilities - Regulated Water'</code> | <code>'Utilities - Renewable'</code> | <code>'Waste Management'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+country"></a>
### fv.country(filter) ⇒ <code>this</code>
The country where company of selected stock is based.
**Arguments**
- **filter (<code>'USA'</code> | <code>'Foreign (ex-USA)'</code> | <code>'Asia'</code> | <code>'Europe'</code> | <code>'Latin America'</code> | <code>'BRIC'</code> | <code>'Argentina'</code> | <code>'Australia'</code> | <code>'Bahamas'</code> | <code>'Belgium'</code> | <code>'BeNeLux'</code> | <code>'Bermuda'</code> | <code>'Brazil'</code> | <code>'Canada'</code> | <code>'Cayman Islands'</code> | <code>'Chile'</code> | <code>'China'</code> | <code>'China & Hong Kong'</code> | <code>'Colombia'</code> | <code>'Cyprus'</code> | <code>'Denmark'</code> | <code>'Finland'</code> | <code>'France'</code> | <code>'Germany'</code> | <code>'Greece'</code> | <code>'Hong Kong'</code> | <code>'Hungary'</code> | <code>'Iceland'</code> | <code>'India'</code> | <code>'Indonesia'</code> | <code>'Ireland'</code> | <code>'Israel'</code> | <code>'Italy'</code> | <code>'Japan'</code> | <code>'Kazakhstan'</code> | <code>'Luxembourg'</code> | <code>'Malaysia'</code> | <code>'Malta'</code> | <code>'Mexico'</code> | <code>'Monaco'</code> | <code>'Netherlands'</code> | <code>'New Zealand'</code> | <code>'Norway'</code> | <code>'Panama'</code> | <code>'Peru'</code> | <code>'Philippines'</code> | <code>'Portugal'</code> | <code>'Russia'</code> | <code>'Singapore'</code> | <code>'South Africa'</code> | <code>'South Korea'</code> | <code>'Spain'</code> | <code>'Sweden'</code> | <code>'Switzerland'</code> | <code>'Taiwan'</code> | <code>'Turkey'</code> | <code>'United Arab Emirates'</code> | <code>'United Kingdom'</code> | <code>'Uruguay'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+marketCap"></a>
### fv.marketCap(filter) ⇒ <code>this</code>
Equals The total dollar market value of all of a company's outstanding shares.
**Arguments**
- **filter (<code>'Mega ($200bln and more)'</code> | <code>'Large ($10bln to $200bln)'</code> | <code>'Mid ($2bln to $10bln)'</code> | <code>'Small ($300mln to $2bln)'</code> | <code>'Micro ($50mln to $300mln)'</code> | <code>'Nano (under $50mln)'</code> | <code>'+Large (over $10bln)'</code> | <code>'+Mid (over $2bln)'</code> | <code>'+Small (over $300mln)'</code> | <code>'+Micro (over $50mln)'</code> | <code>'-Large (under $200bln)'</code> | <code>'-Mid (under $10bln)'</code> | <code>'-Small (under $2bln)'</code> | <code>'-Micro (under $300mln)'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+pe"></a>
### fv.pe(filter) ⇒ <code>this</code>
A valuation ratio of a company's current share price compared to its per-share earnings (ttm).
**Arguments**
- **filter (<code>'Low (<15)'</code> | <code>'Profitable (>0)'</code> | <code>'High (>50)'</code> | <code>'Under 5'</code> | <code>'Under 10'</code> | <code>'Under 15'</code> | <code>'Under 20'</code> | <code>'Under 25'</code> | <code>'Under 30'</code> | <code>'Under 35'</code> | <code>'Under 40'</code> | <code>'Under 45'</code> | <code>'Under 50'</code> | <code>'Over 5'</code> | <code>'Over 10'</code> | <code>'Over 15'</code> | <code>'Over 20'</code> | <code>'Over 25'</code> | <code>'Over 30'</code> | <code>'Over 35'</code> | <code>'Over 40'</code> | <code>'Over 45'</code> | <code>'Over 50'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+forwardPe"></a>
### fv.forwardPe(filter) ⇒ <code>this</code>
A measure of the price-to-earnings ratio using forecasted earnings for the P/E calculation. Value for next fiscal year.
**Arguments**
- **filter (<code>'Low (<15)'</code> | <code>'Profitable (>0)'</code> | <code>'High (>50)'</code> | <code>'Under 5'</code> | <code>'Under 10'</code> | <code>'Under 15'</code> | <code>'Under 20'</code> | <code>'Under 25'</code> | <code>'Under 30'</code> | <code>'Under 35'</code> | <code>'Under 40'</code> | <code>'Under 45'</code> | <code>'Under 50'</code> | <code>'Over 5'</code> | <code>'Over 10'</code> | <code>'Over 15'</code> | <code>'Over 20'</code> | <code>'Over 25'</code> | <code>'Over 30'</code> | <code>'Over 35'</code> | <code>'Over 40'</code> | <code>'Over 45'</code> | <code>'Over 50'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+peg"></a>
### fv.peg(filter) ⇒ <code>this</code>
A ratio used to determine a stock's value while taking into account earnings growth.
**Arguments**
- **filter (<code>'Low (<1)'</code> | <code>'High (>2)'</code> | <code>'Under 1'</code> | <code>'Under 2'</code> | <code>'Under 3'</code> | <code>'Over 1'</code> | <code>'Over 2'</code> | <code>'Over 3'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+ps"></a>
### fv.ps(filter) ⇒ <code>this</code>
P/S number reflects the value placed on sales by the market. It is calculated by dividing the current closing price of the stock by the dollar-sales value per share.
**Arguments**
- **filter (<code>'Low (<1)'</code> | <code>'High (>10)'</code> | <code>'Under 1'</code> | <code>'Under 2'</code> | <code>'Under 3'</code> | <code>'Under 4'</code> | <code>'Under 5'</code> | <code>'Under 6'</code> | <code>'Under 7'</code> | <code>'Under 8'</code> | <code>'Under 9'</code> | <code>'Under 10'</code> | <code>'Over 1'</code> | <code>'Over 2'</code> | <code>'Over 3'</code> | <code>'Over 4'</code> | <code>'Over 5'</code> | <code>'Over 6'</code> | <code>'Over 7'</code> | <code>'Over 8'</code> | <code>'Over 9'</code> | <code>'Over 10'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+pb"></a>
### fv.pb(filter) ⇒ <code>this</code>
A ratio used to compare a stock's market value to its book value. It is calculated by dividing the current closing price of the stock by the latest quarter's book value per share.
**Arguments**
- **filter (<code>'Low (<1)'</code> | <code>'High (>5)'</code> | <code>'Under 1'</code> | <code>'Under 2'</code> | <code>'Under 3'</code> | <code>'Under 4'</code> | <code>'Under 5'</code> | <code>'Under 6'</code> | <code>'Under 7'</code> | <code>'Under 8'</code> | <code>'Under 9'</code> | <code>'Under 10'</code> | <code>'Over 1'</code> | <code>'Over 2'</code> | <code>'Over 3'</code> | <code>'Over 4'</code> | <code>'Over 5'</code> | <code>'Over 6'</code> | <code>'Over 7'</code> | <code>'Over 8'</code> | <code>'Over 9'</code> | <code>'Over 10'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+priceCash"></a>
### fv.priceCash(filter) ⇒ <code>this</code>
A ratio used to compare a stock's market value to its cash assets. It is calculated by dividing the current closing price of the stock by the latest quarter's cash per share.
**Arguments**
- **filter (<code>'Low (<3)'</code> | <code>'High (>50)'</code> | <code>'Under 1'</code> | <code>'Under 2'</code> | <code>'Under 3'</code> | <code>'Under 4'</code> | <code>'Under 5'</code> | <code>'Under 6'</code> | <code>'Under 7'</code> | <code>'Under 8'</code> | <code>'Under 9'</code> | <code>'Under 10'</code> | <code>'Over 1'</code> | <code>'Over 2'</code> | <code>'Over 3'</code> | <code>'Over 4'</code> | <code>'Over 5'</code> | <code>'Over 6'</code> | <code>'Over 7'</code> | <code>'Over 8'</code> | <code>'Over 9'</code> | <code>'Over 10'</code> | <code>'Over 20'</code> | <code>'Over 30'</code> | <code>'Over 40'</code> | <code>'Over 50'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+priceFreeCashFlow"></a>
### fv.priceFreeCashFlow(filter) ⇒ <code>this</code>
A valuation metric that compares a company's market price to its level of annual free cash flow.
**Arguments**
- **filter (<code>'Low (<15)'</code> | <code>'High (>50)'</code> | <code>'Under 5'</code> | <code>'Under 10'</code> | <code>'Under 15'</code> | <code>'Under 20'</code> | <code>'Under 25'</code> | <code>'Under 30'</code> | <code>'Under 35'</code> | <code>'Under 40'</code> | <code>'Under 45'</code> | <code>'Under 50'</code> | <code>'Under 60'</code> | <code>'Under 70'</code> | <code>'Under 80'</code> | <code>'Under 90'</code> | <code>'Under 100'</code> | <code>'Over 5'</code> | <code>'Over 10'</code> | <code>'Over 15'</code> | <code>'Over 20'</code> | <code>'Over 25'</code> | <code>'Over 30'</code> | <code>'Over 35'</code> | <code>'Over 40'</code> | <code>'Over 45'</code> | <code>'Over 50'</code> | <code>'Over 60'</code> | <code>'Over 70'</code> | <code>'Over 80'</code> | <code>'Over 90'</code> | <code>'Over 100'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+epsGrowththisYear"></a>
### fv.epsGrowththisYear(filter) ⇒ <code>this</code>
EPS is the portion of a company's profit allocated to each outstanding share of common stock. EPS serves as an indicator of a company's profitability. Value for current fiscal year.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+epsGrowthnextYear"></a>
### fv.epsGrowthnextYear(filter) ⇒ <code>this</code>
EPS is the portion of a company's profit allocated to each outstanding share of common stock. EPS serves as an indicator of a company's profitability. Estimate for next fiscal year.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+epsGrowthpast5Years"></a>
### fv.epsGrowthpast5Years(filter) ⇒ <code>this</code>
EPS is the portion of a company's profit allocated to each outstanding share of common stock. EPS serves as an indicator of a company's profitability. Annual growth over past 5 years.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+epsGrowthnext5Years"></a>
### fv.epsGrowthnext5Years(filter) ⇒ <code>this</code>
EPS is the portion of a company's profit allocated to each outstanding share of common stock. EPS serves as an indicator of a company's profitability. Long term annual growth estimate.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (<10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+salesGrowthpast5Years"></a>
### fv.salesGrowthpast5Years(filter) ⇒ <code>this</code>
Annual growth over past 5 years.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+epsGrowthqtrOverQtr"></a>
### fv.epsGrowthqtrOverQtr(filter) ⇒ <code>this</code>
EPS is the portion of a company's profit allocated to each outstanding share of common stock. EPS serves as an indicator of a company's profitability. Quarter over quarter growth.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+salesGrowthqtrOverQtr"></a>
### fv.salesGrowthqtrOverQtr(filter) ⇒ <code>this</code>
Quarter over quarter growth.
**Arguments**
- **filter (<code>'Negative (<0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Positive Low (0-10%)'</code> | <code>'High (>25%)'</code> | <code>'Under 5%'</code> | <code>'Under 10%'</code> | <code>'Under 15%'</code> | <code>'Under 20%'</code> | <code>'Under 25%'</code> | <code>'Under 30%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+dividendYield"></a>
### fv.dividendYield(filter) ⇒ <code>this</code>
The dividend yield equals the annual dividend per share divided by the stock’s price. This measurement tells what percentage return a company pays out to shareholders in the form of dividends.
**Arguments**
- **filter (<code>'None (0%)'</code> | <code>'Positive (>0%)'</code> | <code>'High (>5%)'</code> | <code>'Very High (>10%)'</code> | <code>'Over 1%'</code> | <code>'Over 2%'</code> | <code>'Over 3%'</code> | <code>'Over 4%'</code> | <code>'Over 5%'</code> | <code>'Over 6%'</code> | <code>'Over 7%'</code> | <code>'Over 8%'</code> | <code>'Over 9%'</code> | <code>'Over 10%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+returnOnAssets"></a>
### fv.returnOnAssets(filter) ⇒ <code>this</code>
An indicator of how profitable a company is relative to its total assets. ROA gives an idea as to how efficient management is at using its assets to generate earnings. Calculated by dividing a company's annual earnings by its total assets, ROA is displayed as a percentage.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'Very Positive (>15%)'</code> | <code>'Very Negative (<-15%)'</code> | <code>'Under -50%'</code> | <code>'Under -45%'</code> | <code>'Under -40%'</code> | <code>'Under -35%'</code> | <code>'Under -30%'</code> | <code>'Under -25%'</code> | <code>'Under -20%'</code> | <code>'Under -15%'</code> | <code>'Under -10%'</code> | <code>'Under -5%'</code> | <code>'Over +5%'</code> | <code>'Over +10%'</code> | <code>'Over +15%'</code> | <code>'Over +20%'</code> | <code>'Over +25%'</code> | <code>'Over +30%'</code> | <code>'Over +35%'</code> | <code>'Over +40%'</code> | <code>'Over +45%'</code> | <code>'Over +50%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+returnOnEquity"></a>
### fv.returnOnEquity(filter) ⇒ <code>this</code>
A measure of a corporation's profitability that reveals how much profit a company generates with the money shareholders have invested. Calculated as Net Income / Shareholder's Equity.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'Very Positive (>30%)'</code> | <code>'Very Negative (<-15%)'</code> | <code>'Under -50%'</code> | <code>'Under -45%'</code> | <code>'Under -40%'</code> | <code>'Under -35%'</code> | <code>'Under -30%'</code> | <code>'Under -25%'</code> | <code>'Under -20%'</code> | <code>'Under -15%'</code> | <code>'Under -10%'</code> | <code>'Under -5%'</code> | <code>'Over +5%'</code> | <code>'Over +10%'</code> | <code>'Over +15%'</code> | <code>'Over +20%'</code> | <code>'Over +25%'</code> | <code>'Over +30%'</code> | <code>'Over +35%'</code> | <code>'Over +40%'</code> | <code>'Over +45%'</code> | <code>'Over +50%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+returnOnInvestment"></a>
### fv.returnOnInvestment(filter) ⇒ <code>this</code>
Performance measure used to evaluate the efficiency of an investment or to compare the efficiency of a number of different investments. To calculate ROI, the benefit (return) of an investment is divided by the cost of the investment: (Gain from Investment - Cost of Investment) / Cost of Investment.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'Very Positive (>25%)'</code> | <code>'Very Negative (<-10%)'</code> | <code>'Under -50%'</code> | <code>'Under -45%'</code> | <code>'Under -40%'</code> | <code>'Under -35%'</code> | <code>'Under -30%'</code> | <code>'Under -25%'</code> | <code>'Under -20%'</code> | <code>'Under -15%'</code> | <code>'Under -10%'</code> | <code>'Under -5%'</code> | <code>'Over +5%'</code> | <code>'Over +10%'</code> | <code>'Over +15%'</code> | <code>'Over +20%'</code> | <code>'Over +25%'</code> | <code>'Over +30%'</code> | <code>'Over +35%'</code> | <code>'Over +40%'</code> | <code>'Over +45%'</code> | <code>'Over +50%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+currentRatio"></a>
### fv.currentRatio(filter) ⇒ <code>this</code>
A liquidity ratio that measures a company's ability to pay short-term obligations. Calculated as Current Assets / Current Liabilities.
**Arguments**
- **filter (<code>'High (>3)'</code> | <code>'Low (<1)'</code> | <code>'Under 1'</code> | <code>'Under 0.5'</code> | <code>'Over 0.5'</code> | <code>'Over 1'</code> | <code>'Over 1.5'</code> | <code>'Over 2'</code> | <code>'Over 3'</code> | <code>'Over 4'</code> | <code>'Over 5'</code> | <code>'Over 10'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+quickRatio"></a>
### fv.quickRatio(filter) ⇒ <code>this</code>
An indicator of a company's short-term liquidity. The quick ratio measures a company's ability to meet its short-term obligations with its most liquid assets. The higher the quick ratio, the better the position of the company. Calculated as (Current Assets - Inventories) / Current Liabilities.
**Arguments**
- **filter (<code>'High (>3)'</code> | <code>'Low (<0.5)'</code> | <code>'Under 1'</code> | <code>'Under 0.5'</code> | <code>'Over 0.5'</code> | <code>'Over 1'</code> | <code>'Over 1.5'</code> | <code>'Over 2'</code> | <code>'Over 3'</code> | <code>'Over 4'</code> | <code>'Over 5'</code> | <code>'Over 10'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+ltDebtEquity"></a>
### fv.ltDebtEquity(filter) ⇒ <code>this</code>
A measure of a company's financial leverage calculated by dividing its long term debt by stockholders' equity. It indicates what proportion of equity and debt the company is using to finance its assets.
**Arguments**
- **filter (<code>'High (>0.5)'</code> | <code>'Low (<0.1)'</code> | <code>'Under 1'</code> | <code>'Under 0.9'</code> | <code>'Under 0.8'</code> | <code>'Under 0.7'</code> | <code>'Under 0.6'</code> | <code>'Under 0.5'</code> | <code>'Under 0.4'</code> | <code>'Under 0.3'</code> | <code>'Under 0.2'</code> | <code>'Under 0.1'</code> | <code>'Over 0.1'</code> | <code>'Over 0.2'</code> | <code>'Over 0.3'</code> | <code>'Over 0.4'</code> | <code>'Over 0.5'</code> | <code>'Over 0.6'</code> | <code>'Over 0.7'</code> | <code>'Over 0.8'</code> | <code>'Over 0.9'</code> | <code>'Over 1'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+debtEquity"></a>
### fv.debtEquity(filter) ⇒ <code>this</code>
A measure of a company's financial leverage calculated by dividing its liabilities by stockholders' equity. It indicates what proportion of equity and debt the company is using to finance its assets.
**Arguments**
- **filter (<code>'High (>0.5)'</code> | <code>'Low (<0.1)'</code> | <code>'Under 1'</code> | <code>'Under 0.9'</code> | <code>'Under 0.8'</code> | <code>'Under 0.7'</code> | <code>'Under 0.6'</code> | <code>'Under 0.5'</code> | <code>'Under 0.4'</code> | <code>'Under 0.3'</code> | <code>'Under 0.2'</code> | <code>'Under 0.1'</code> | <code>'Over 0.1'</code> | <code>'Over 0.2'</code> | <code>'Over 0.3'</code> | <code>'Over 0.4'</code> | <code>'Over 0.5'</code> | <code>'Over 0.6'</code> | <code>'Over 0.7'</code> | <code>'Over 0.8'</code> | <code>'Over 0.9'</code> | <code>'Over 1'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+grossMargin"></a>
### fv.grossMargin(filter) ⇒ <code>this</code>
A company's total sales revenue minus its cost of goods sold, divided by the total sales revenue, expressed as a percentage. The gross margin represents the percent of total sales revenue that the company retains after incurring the direct costs associated with producing the goods and services sold by a company. The higher the percentage, the more the company retains on each dollar of sales to service its other costs and obligations.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'High (>50%)'</code> | <code>'Under 90%'</code> | <code>'Under 80%'</code> | <code>'Under 70%'</code> | <code>'Under 60%'</code> | <code>'Under 50%'</code> | <code>'Under 45%'</code> | <code>'Under 40%'</code> | <code>'Under 35%'</code> | <code>'Under 30%'</code> | <code>'Under 25%'</code> | <code>'Under 20%'</code> | <code>'Under 15%'</code> | <code>'Under 10%'</code> | <code>'Under 5%'</code> | <code>'Under 0%'</code> | <code>'Under -10%'</code> | <code>'Under -20%'</code> | <code>'Under -30%'</code> | <code>'Under -50%'</code> | <code>'Under -70%'</code> | <code>'Under -100%'</code> | <code>'Over 0%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code> | <code>'Over 35%'</code> | <code>'Over 40%'</code> | <code>'Over 45%'</code> | <code>'Over 50%'</code> | <code>'Over 60%'</code> | <code>'Over 70%'</code> | <code>'Over 80%'</code> | <code>'Over 90%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+operatingMargin"></a>
### fv.operatingMargin(filter) ⇒ <code>this</code>
Operating margin is a measurement of what proportion of a company's revenue is left over after paying for variable costs of production such as wages, raw materials, etc. A healthy operating margin is required for a company to be able to pay for its fixed costs, such as interest on debt. Calculated as Operating Income / Net Sales.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'Very Negative (<-20%)'</code> | <code>'High (>25%)'</code> | <code>'Under 90%'</code> | <code>'Under 80%'</code> | <code>'Under 70%'</code> | <code>'Under 60%'</code> | <code>'Under 50%'</code> | <code>'Under 45%'</code> | <code>'Under 40%'</code> | <code>'Under 35%'</code> | <code>'Under 30%'</code> | <code>'Under 25%'</code> | <code>'Under 20%'</code> | <code>'Under 15%'</code> | <code>'Under 10%'</code> | <code>'Under 5%'</code> | <code>'Under 0%'</code> | <code>'Under -10%'</code> | <code>'Under -20%'</code> | <code>'Under -30%'</code> | <code>'Under -50%'</code> | <code>'Under -70%'</code> | <code>'Under -100%'</code> | <code>'Over 0%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code> | <code>'Over 35%'</code> | <code>'Over 40%'</code> | <code>'Over 45%'</code> | <code>'Over 50%'</code> | <code>'Over 60%'</code> | <code>'Over 70%'</code> | <code>'Over 80%'</code> | <code>'Over 90%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+netProfitMargin"></a>
### fv.netProfitMargin(filter) ⇒ <code>this</code>
A ratio of profitability calculated as net income divided by revenues, or net profits divided by sales. It measures how much out of every dollar of sales a company actually keeps in earnings.
**Arguments**
- **filter (<code>'Positive (>0%)'</code> | <code>'Negative (<0%)'</code> | <code>'Very Negative (<-20%)'</code> | <code>'High (>20%)'</code> | <code>'Under 90%'</code> | <code>'Under 80%'</code> | <code>'Under 70%'</code> | <code>'Under 60%'</code> | <code>'Under 50%'</code> | <code>'Under 45%'</code> | <code>'Under 40%'</code> | <code>'Under 35%'</code> | <code>'Under 30%'</code> | <code>'Under 25%'</code> | <code>'Under 20%'</code> | <code>'Under 15%'</code> | <code>'Under 10%'</code> | <code>'Under 5%'</code> | <code>'Under 0%'</code> | <code>'Under -10%'</code> | <code>'Under -20%'</code> | <code>'Under -30%'</code> | <code>'Under -50%'</code> | <code>'Under -70%'</code> | <code>'Under -100%'</code> | <code>'Over 0%'</code> | <code>'Over 5%'</code> | <code>'Over 10%'</code> | <code>'Over 15%'</code> | <code>'Over 20%'</code> | <code>'Over 25%'</code> | <code>'Over 30%'</code> | <code>'Over 35%'</code> | <code>'Over 40%'</code> | <code>'Over 45%'</code> | <code>'Over 50%'</code> | <code>'Over 60%'</code> | <code>'Over 70%'</code> | <code>'Over 80%'</code> | <code>'Over 90%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+payoutRatio"></a>
### fv.payoutRatio(filter) ⇒ <code>this</code>
The percentage of earnings paid to shareholders in dividends.
**Arguments**
- **filter (<code>'None (0%)'</code> | <code>'Positive (>0%)'</code> | <code>'Low (<20%)'</code> | <code>'High (>50%)'</code> | <code>'Over 0%'</code> | <code>'Over 10%'</code> | <code>'Over 20%'</code> | <code>'Over 30%'</code> | <code>'Over 40%'</code> | <code>'Over 50%'</code> | <code>'Over 60%'</code> | <code>'Over 70%'</code> | <code>'Over 80%'</code> | <code>'Over 90%'</code> | <code>'Over 100%'</code> | <code>'Under 10%'</code> | <code>'Under 20%'</code> | <code>'Under 30%'</code> | <code>'Under 40%'</code> | <code>'Under 50%'</code> | <code>'Under 60%'</code> | <code>'Under 70%'</code> | <code>'Under 80%'</code> | <code>'Under 90%'</code> | <code>'Under 100%'</code>)** : Filter
**Returns**
- **<code>this</code>** : this
<br><a name="FinVizScreener+insiderOwnership"></a>
### fv.insiderOwnership(filter) ⇒ <code>this</code>
Level to which a company is owned by its own management.
**Arguments**
- **filter (<code>'Low (<5%)'</code> | <code>'High (>30%)'</code> | <code>'Very High (>50%)'</code> | <code>'Over 10%'</code> | <code>'Over 20%'</code> | <code>'Over 30%'</code> | <code>'Over 40%'</code> | <code>'Over 50%'</code> | <code>'Over 60%'</code> | <code>'Over 70%'</code> | <code>'Over 80%'</code>