# API Docs
## Index
* [FinVizScreener](#FinVizScreener)
* [Type Definitions](#TypeDefinitions)
## FinVizScreener
* [FinVizScreener](#FinVizScreener)
* [new FinVizScreener(options)](#new_FinVizScreener_new)
* [fv.options](#FinVizScreener+options) : [Options](#Options)
* [fv.scan()](#FinVizScreener+scan) ⇒ Promise.<Array.<string>>
* [fv.exchange(filter)](#FinVizScreener+exchange) ⇒ this
* [fv.index(filter)](#FinVizScreener+index) ⇒ this
* [fv.sector(filter)](#FinVizScreener+sector) ⇒ this
* [fv.industry(filter)](#FinVizScreener+industry) ⇒ this
* [fv.country(filter)](#FinVizScreener+country) ⇒ this
* [fv.marketCap(filter)](#FinVizScreener+marketCap) ⇒ this
* [fv.pe(filter)](#FinVizScreener+pe) ⇒ this
* [fv.forwardPe(filter)](#FinVizScreener+forwardPe) ⇒ this
* [fv.peg(filter)](#FinVizScreener+peg) ⇒ this
* [fv.ps(filter)](#FinVizScreener+ps) ⇒ this
* [fv.pb(filter)](#FinVizScreener+pb) ⇒ this
* [fv.priceCash(filter)](#FinVizScreener+priceCash) ⇒ this
* [fv.priceFreeCashFlow(filter)](#FinVizScreener+priceFreeCashFlow) ⇒ this
* [fv.epsGrowththisYear(filter)](#FinVizScreener+epsGrowththisYear) ⇒ this
* [fv.epsGrowthnextYear(filter)](#FinVizScreener+epsGrowthnextYear) ⇒ this
* [fv.epsGrowthpast5Years(filter)](#FinVizScreener+epsGrowthpast5Years) ⇒ this
* [fv.epsGrowthnext5Years(filter)](#FinVizScreener+epsGrowthnext5Years) ⇒ this
* [fv.salesGrowthpast5Years(filter)](#FinVizScreener+salesGrowthpast5Years) ⇒ this
* [fv.epsGrowthqtrOverQtr(filter)](#FinVizScreener+epsGrowthqtrOverQtr) ⇒ this
* [fv.salesGrowthqtrOverQtr(filter)](#FinVizScreener+salesGrowthqtrOverQtr) ⇒ this
* [fv.dividendYield(filter)](#FinVizScreener+dividendYield) ⇒ this
* [fv.returnOnAssets(filter)](#FinVizScreener+returnOnAssets) ⇒ this
* [fv.returnOnEquity(filter)](#FinVizScreener+returnOnEquity) ⇒ this
* [fv.returnOnInvestment(filter)](#FinVizScreener+returnOnInvestment) ⇒ this
* [fv.currentRatio(filter)](#FinVizScreener+currentRatio) ⇒ this
* [fv.quickRatio(filter)](#FinVizScreener+quickRatio) ⇒ this
* [fv.ltDebtEquity(filter)](#FinVizScreener+ltDebtEquity) ⇒ this
* [fv.debtEquity(filter)](#FinVizScreener+debtEquity) ⇒ this
* [fv.grossMargin(filter)](#FinVizScreener+grossMargin) ⇒ this
* [fv.operatingMargin(filter)](#FinVizScreener+operatingMargin) ⇒ this
* [fv.netProfitMargin(filter)](#FinVizScreener+netProfitMargin) ⇒ this
* [fv.payoutRatio(filter)](#FinVizScreener+payoutRatio) ⇒ this
* [fv.insiderOwnership(filter)](#FinVizScreener+insiderOwnership) ⇒ this
* [fv.insiderTransactions(filter)](#FinVizScreener+insiderTransactions) ⇒ this
* [fv.institutionalOwnership(filter)](#FinVizScreener+institutionalOwnership) ⇒ this
* [fv.institutionalTransactions(filter)](#FinVizScreener+institutionalTransactions) ⇒ this
* [fv.floatShort(filter)](#FinVizScreener+floatShort) ⇒ this
* [fv.analystRecom(filter)](#FinVizScreener+analystRecom) ⇒ this
* [fv.optionShort(filter)](#FinVizScreener+optionShort) ⇒ this
* [fv.earningsDate(filter)](#FinVizScreener+earningsDate) ⇒ this
* [fv.performance(filter)](#FinVizScreener+performance) ⇒ this
* [fv.performance2(filter)](#FinVizScreener+performance2) ⇒ this
* [fv.volatility(filter)](#FinVizScreener+volatility) ⇒ this
* [fv.rsi14(filter)](#FinVizScreener+rsi14) ⇒ this
* [fv.gap(filter)](#FinVizScreener+gap) ⇒ this
* [fv.twentyDaySimpleMovingAverage(filter)](#FinVizScreener+twentyDaySimpleMovingAverage) ⇒ this
* [fv.fiftyDaySimpleMovingAverage(filter)](#FinVizScreener+fiftyDaySimpleMovingAverage) ⇒ this
* [fv.twoHundredDaySimpleMovingAverage(filter)](#FinVizScreener+twoHundredDaySimpleMovingAverage) ⇒ this
* [fv.change(filter)](#FinVizScreener+change) ⇒ this
* [fv.changeFromOpen(filter)](#FinVizScreener+changeFromOpen) ⇒ this
* [fv.twentyDayHighLow(filter)](#FinVizScreener+twentyDayHighLow) ⇒ this
* [fv.fiftyDayHighLow(filter)](#FinVizScreener+fiftyDayHighLow) ⇒ this
* [fv.fiftyTwoWeekHighLow(filter)](#FinVizScreener+fiftyTwoWeekHighLow) ⇒ this
* [fv.pattern(filter)](#FinVizScreener+pattern) ⇒ this
* [fv.candlestick(filter)](#FinVizScreener+candlestick) ⇒ this
* [fv.beta(filter)](#FinVizScreener+beta) ⇒ this
* [fv.averageTrueRange(filter)](#FinVizScreener+averageTrueRange) ⇒ this
* [fv.averageVolume(filter)](#FinVizScreener+averageVolume) ⇒ this
* [fv.relativeVolume(filter)](#FinVizScreener+relativeVolume) ⇒ this
* [fv.currentVolume(filter)](#FinVizScreener+currentVolume) ⇒ this
* [fv.price(filter)](#FinVizScreener+price) ⇒ this
* [fv.targetPrice(filter)](#FinVizScreener+targetPrice) ⇒ this
* [fv.ipoDate(filter)](#FinVizScreener+ipoDate) ⇒ this
* [fv.sharesOutstanding(filter)](#FinVizScreener+sharesOutstanding) ⇒ this
* [fv.float(filter)](#FinVizScreener+float) ⇒ this
* [fv.signal(signal)](#FinVizScreener+signal) ⇒ this
### new FinVizScreener(options)
**Arguments**
- **options ([Options](#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', ... ]
```
### fv.options : [Options](#Options)
Client instance options
### fv.scan() ⇒ Promise.<Array.<string>>
Scan for stocks.
**Returns**
- **Promise.<Array.<string>>** : List of stock tickers
### fv.exchange(filter) ⇒ this
Stock Exchange at which a stock is listed.
**Arguments**
- **filter ('AMEX' | 'NASDAQ' | 'NYSE')** : Filter
**Returns**
- **this** : this
### fv.index(filter) ⇒ this
A major index membership of a stock.
**Arguments**
- **filter ('S&P 500' | 'DJIA')** : Filter
**Returns**
- **this** : this
### fv.sector(filter) ⇒ this
The sector which a stock belongs to.
**Arguments**
- **filter ('Basic Materials' | 'Communication Services' | 'Consumer Cyclical' | 'Consumer Defensive' | 'Energy' | 'Financial' | 'Healthcare' | 'Industrials' | 'Real Estate' | 'Technology' | 'Utilities')** : Filter
**Returns**
- **this** : this
### fv.industry(filter) ⇒ this
The industry which a stock belongs to.
**Arguments**
- **filter ('Stocks only (ex-Funds)' | 'Exchange Traded Fund' | 'Advertising Agencies' | 'Aerospace & Defense' | 'Agricultural Inputs' | 'Airlines' | 'Airports & Air Services' | 'Aluminum' | 'Apparel Manufacturing' | 'Apparel Retail' | 'Asset Management' | 'Auto Manufacturers' | 'Auto Parts' | 'Auto & Truck Dealerships' | 'Banks - Diversified' | 'Banks - Regional' | 'Beverages - Brewers' | 'Beverages - Non-Alcoholic' | 'Beverages - Wineries & Distilleries' | 'Biotechnology' | 'Broadcasting' | 'Building Materials' | 'Building Products & Equipment' | 'Business Equipment & Supplies' | 'Capital Markets' | 'Chemicals' | 'Closed-End Fund - Debt' | 'Closed-End Fund - Equity' | 'Closed-End Fund - Foreign' | 'Coking Coal' | 'Communication Equipment' | 'Computer Hardware' | 'Confectioners' | 'Conglomerates' | 'Consulting Services' | 'Consumer Electronics' | 'Copper' | 'Credit Services' | 'Department Stores' | 'Diagnostics & Research' | 'Discount Stores' | 'Drug Manufacturers - General' | 'Drug Manufacturers - Specialty & Generic' | 'Education & Training Services' | 'Electrical Equipment & Parts' | 'Electronic Components' | 'Electronic Gaming & Multimedia' | 'Electronics & Computer Distribution' | 'Engineering & Construction' | 'Entertainment' | 'Exchange Traded Fund' | 'Farm & Heavy Construction Machinery' | 'Farm Products' | 'Financial Conglomerates' | 'Financial Data & Stock Exchanges' | 'Food Distribution' | 'Footwear & Accessories' | 'Furnishings, Fixtures & Appliances' | 'Gambling' | 'Gold' | 'Grocery Stores' | 'Healthcare Plans' | 'Health Information Services' | 'Home Improvement Retail' | 'Household & Personal Products' | 'Industrial Distribution' | 'Information Technology Services' | 'Infrastructure Operations' | 'Insurance Brokers' | 'Insurance - Diversified' | 'Insurance - Life' | 'Insurance - Property & Casualty' | 'Insurance - Reinsurance' | 'Insurance - Specialty' | 'Integrated Freight & Logistics' | 'Internet Content & Information' | 'Internet Retail' | 'Leisure' | 'Lodging' | 'Lumber & Wood Production' | 'Luxury Goods' | 'Marine Shipping' | 'Medical Care Facilities' | 'Medical Devices' | 'Medical Distribution' | 'Medical Instruments & Supplies' | 'Metal Fabrication' | 'Mortgage Finance' | 'Oil & Gas Drilling' | 'Oil & Gas E&P' | 'Oil & Gas Equipment & Services' | 'Oil & Gas Integrated' | 'Oil & Gas Midstream' | 'Oil & Gas Refining & Marketing' | 'Other Industrial Metals & Mining' | 'Other Precious Metals & Mining' | 'Packaged Foods' | 'Packaging & Containers' | 'Paper & Paper Products' | 'Personal Services' | 'Pharmaceutical Retailers' | 'Pollution & Treatment Controls' | 'Publishing' | 'Railroads' | 'Real Estate - Development' | 'Real Estate - Diversified' | 'Real Estate Services' | 'Recreational Vehicles' | 'REIT - Diversified' | 'REIT - Healthcare Facilities' | 'REIT - Hotel & Motel' | 'REIT - Industrial' | 'REIT - Mortgage' | 'REIT - Office' | 'REIT - Residential' | 'REIT - Retail' | 'REIT - Specialty' | 'Rental & Leasing Services' | 'Residential Construction' | 'Resorts & Casinos' | 'Restaurants' | 'Scientific & Technical Instruments' | 'Security & Protection Services' | 'Semiconductor Equipment & Materials' | 'Semiconductors' | 'Shell Companies' | 'Silver' | 'Software - Application' | 'Software - Infrastructure' | 'Solar' | 'Specialty Business Services' | 'Specialty Chemicals' | 'Specialty Industrial Machinery' | 'Specialty Retail' | 'Staffing & Employment Services' | 'Steel' | 'Telecom Services' | 'Textile Manufacturing' | 'Thermal Coal' | 'Tobacco' | 'Tools & Accessories' | 'Travel Services' | 'Trucking' | 'Uranium' | 'Utilities - Diversified' | 'Utilities - Independent Power Producers' | 'Utilities - Regulated Electric' | 'Utilities - Regulated Gas' | 'Utilities - Regulated Water' | 'Utilities - Renewable' | 'Waste Management')** : Filter
**Returns**
- **this** : this
### fv.country(filter) ⇒ this
The country where company of selected stock is based.
**Arguments**
- **filter ('USA' | 'Foreign (ex-USA)' | 'Asia' | 'Europe' | 'Latin America' | 'BRIC' | 'Argentina' | 'Australia' | 'Bahamas' | 'Belgium' | 'BeNeLux' | 'Bermuda' | 'Brazil' | 'Canada' | 'Cayman Islands' | 'Chile' | 'China' | 'China & Hong Kong' | 'Colombia' | 'Cyprus' | 'Denmark' | 'Finland' | 'France' | 'Germany' | 'Greece' | 'Hong Kong' | 'Hungary' | 'Iceland' | 'India' | 'Indonesia' | 'Ireland' | 'Israel' | 'Italy' | 'Japan' | 'Kazakhstan' | 'Luxembourg' | 'Malaysia' | 'Malta' | 'Mexico' | 'Monaco' | 'Netherlands' | 'New Zealand' | 'Norway' | 'Panama' | 'Peru' | 'Philippines' | 'Portugal' | 'Russia' | 'Singapore' | 'South Africa' | 'South Korea' | 'Spain' | 'Sweden' | 'Switzerland' | 'Taiwan' | 'Turkey' | 'United Arab Emirates' | 'United Kingdom' | 'Uruguay')** : Filter
**Returns**
- **this** : this
### fv.marketCap(filter) ⇒ this
Equals The total dollar market value of all of a company's outstanding shares.
**Arguments**
- **filter ('Mega ($200bln and more)' | 'Large ($10bln to $200bln)' | 'Mid ($2bln to $10bln)' | 'Small ($300mln to $2bln)' | 'Micro ($50mln to $300mln)' | 'Nano (under $50mln)' | '+Large (over $10bln)' | '+Mid (over $2bln)' | '+Small (over $300mln)' | '+Micro (over $50mln)' | '-Large (under $200bln)' | '-Mid (under $10bln)' | '-Small (under $2bln)' | '-Micro (under $300mln)')** : Filter
**Returns**
- **this** : this
### fv.pe(filter) ⇒ this
A valuation ratio of a company's current share price compared to its per-share earnings (ttm).
**Arguments**
- **filter ('Low (<15)' | 'Profitable (>0)' | 'High (>50)' | 'Under 5' | 'Under 10' | 'Under 15' | 'Under 20' | 'Under 25' | 'Under 30' | 'Under 35' | 'Under 40' | 'Under 45' | 'Under 50' | 'Over 5' | 'Over 10' | 'Over 15' | 'Over 20' | 'Over 25' | 'Over 30' | 'Over 35' | 'Over 40' | 'Over 45' | 'Over 50')** : Filter
**Returns**
- **this** : this
### fv.forwardPe(filter) ⇒ this
A measure of the price-to-earnings ratio using forecasted earnings for the P/E calculation. Value for next fiscal year.
**Arguments**
- **filter ('Low (<15)' | 'Profitable (>0)' | 'High (>50)' | 'Under 5' | 'Under 10' | 'Under 15' | 'Under 20' | 'Under 25' | 'Under 30' | 'Under 35' | 'Under 40' | 'Under 45' | 'Under 50' | 'Over 5' | 'Over 10' | 'Over 15' | 'Over 20' | 'Over 25' | 'Over 30' | 'Over 35' | 'Over 40' | 'Over 45' | 'Over 50')** : Filter
**Returns**
- **this** : this
### fv.peg(filter) ⇒ this
A ratio used to determine a stock's value while taking into account earnings growth.
**Arguments**
- **filter ('Low (<1)' | 'High (>2)' | 'Under 1' | 'Under 2' | 'Under 3' | 'Over 1' | 'Over 2' | 'Over 3')** : Filter
**Returns**
- **this** : this
### fv.ps(filter) ⇒ this
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 ('Low (<1)' | 'High (>10)' | 'Under 1' | 'Under 2' | 'Under 3' | 'Under 4' | 'Under 5' | 'Under 6' | 'Under 7' | 'Under 8' | 'Under 9' | 'Under 10' | 'Over 1' | 'Over 2' | 'Over 3' | 'Over 4' | 'Over 5' | 'Over 6' | 'Over 7' | 'Over 8' | 'Over 9' | 'Over 10')** : Filter
**Returns**
- **this** : this
### fv.pb(filter) ⇒ this
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 ('Low (<1)' | 'High (>5)' | 'Under 1' | 'Under 2' | 'Under 3' | 'Under 4' | 'Under 5' | 'Under 6' | 'Under 7' | 'Under 8' | 'Under 9' | 'Under 10' | 'Over 1' | 'Over 2' | 'Over 3' | 'Over 4' | 'Over 5' | 'Over 6' | 'Over 7' | 'Over 8' | 'Over 9' | 'Over 10')** : Filter
**Returns**
- **this** : this
### fv.priceCash(filter) ⇒ this
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 ('Low (<3)' | 'High (>50)' | 'Under 1' | 'Under 2' | 'Under 3' | 'Under 4' | 'Under 5' | 'Under 6' | 'Under 7' | 'Under 8' | 'Under 9' | 'Under 10' | 'Over 1' | 'Over 2' | 'Over 3' | 'Over 4' | 'Over 5' | 'Over 6' | 'Over 7' | 'Over 8' | 'Over 9' | 'Over 10' | 'Over 20' | 'Over 30' | 'Over 40' | 'Over 50')** : Filter
**Returns**
- **this** : this
### fv.priceFreeCashFlow(filter) ⇒ this
A valuation metric that compares a company's market price to its level of annual free cash flow.
**Arguments**
- **filter ('Low (<15)' | 'High (>50)' | 'Under 5' | 'Under 10' | 'Under 15' | 'Under 20' | 'Under 25' | 'Under 30' | 'Under 35' | 'Under 40' | 'Under 45' | 'Under 50' | 'Under 60' | 'Under 70' | 'Under 80' | 'Under 90' | 'Under 100' | 'Over 5' | 'Over 10' | 'Over 15' | 'Over 20' | 'Over 25' | 'Over 30' | 'Over 35' | 'Over 40' | 'Over 45' | 'Over 50' | 'Over 60' | 'Over 70' | 'Over 80' | 'Over 90' | 'Over 100')** : Filter
**Returns**
- **this** : this
### fv.epsGrowththisYear(filter) ⇒ this
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 ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.epsGrowthnextYear(filter) ⇒ this
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 ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.epsGrowthpast5Years(filter) ⇒ this
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 ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.epsGrowthnext5Years(filter) ⇒ this
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 ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (<10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.salesGrowthpast5Years(filter) ⇒ this
Annual growth over past 5 years.
**Arguments**
- **filter ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.epsGrowthqtrOverQtr(filter) ⇒ this
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 ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.salesGrowthqtrOverQtr(filter) ⇒ this
Quarter over quarter growth.
**Arguments**
- **filter ('Negative (<0%)' | 'Positive (>0%)' | 'Positive Low (0-10%)' | 'High (>25%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.dividendYield(filter) ⇒ this
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 ('None (0%)' | 'Positive (>0%)' | 'High (>5%)' | 'Very High (>10%)' | 'Over 1%' | 'Over 2%' | 'Over 3%' | 'Over 4%' | 'Over 5%' | 'Over 6%' | 'Over 7%' | 'Over 8%' | 'Over 9%' | 'Over 10%')** : Filter
**Returns**
- **this** : this
### fv.returnOnAssets(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'Very Positive (>15%)' | 'Very Negative (<-15%)' | 'Under -50%' | 'Under -45%' | 'Under -40%' | 'Under -35%' | 'Under -30%' | 'Under -25%' | 'Under -20%' | 'Under -15%' | 'Under -10%' | 'Under -5%' | 'Over +5%' | 'Over +10%' | 'Over +15%' | 'Over +20%' | 'Over +25%' | 'Over +30%' | 'Over +35%' | 'Over +40%' | 'Over +45%' | 'Over +50%')** : Filter
**Returns**
- **this** : this
### fv.returnOnEquity(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'Very Positive (>30%)' | 'Very Negative (<-15%)' | 'Under -50%' | 'Under -45%' | 'Under -40%' | 'Under -35%' | 'Under -30%' | 'Under -25%' | 'Under -20%' | 'Under -15%' | 'Under -10%' | 'Under -5%' | 'Over +5%' | 'Over +10%' | 'Over +15%' | 'Over +20%' | 'Over +25%' | 'Over +30%' | 'Over +35%' | 'Over +40%' | 'Over +45%' | 'Over +50%')** : Filter
**Returns**
- **this** : this
### fv.returnOnInvestment(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'Very Positive (>25%)' | 'Very Negative (<-10%)' | 'Under -50%' | 'Under -45%' | 'Under -40%' | 'Under -35%' | 'Under -30%' | 'Under -25%' | 'Under -20%' | 'Under -15%' | 'Under -10%' | 'Under -5%' | 'Over +5%' | 'Over +10%' | 'Over +15%' | 'Over +20%' | 'Over +25%' | 'Over +30%' | 'Over +35%' | 'Over +40%' | 'Over +45%' | 'Over +50%')** : Filter
**Returns**
- **this** : this
### fv.currentRatio(filter) ⇒ this
A liquidity ratio that measures a company's ability to pay short-term obligations. Calculated as Current Assets / Current Liabilities.
**Arguments**
- **filter ('High (>3)' | 'Low (<1)' | 'Under 1' | 'Under 0.5' | 'Over 0.5' | 'Over 1' | 'Over 1.5' | 'Over 2' | 'Over 3' | 'Over 4' | 'Over 5' | 'Over 10')** : Filter
**Returns**
- **this** : this
### fv.quickRatio(filter) ⇒ this
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 ('High (>3)' | 'Low (<0.5)' | 'Under 1' | 'Under 0.5' | 'Over 0.5' | 'Over 1' | 'Over 1.5' | 'Over 2' | 'Over 3' | 'Over 4' | 'Over 5' | 'Over 10')** : Filter
**Returns**
- **this** : this
### fv.ltDebtEquity(filter) ⇒ this
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 ('High (>0.5)' | 'Low (<0.1)' | 'Under 1' | 'Under 0.9' | 'Under 0.8' | 'Under 0.7' | 'Under 0.6' | 'Under 0.5' | 'Under 0.4' | 'Under 0.3' | 'Under 0.2' | 'Under 0.1' | 'Over 0.1' | 'Over 0.2' | 'Over 0.3' | 'Over 0.4' | 'Over 0.5' | 'Over 0.6' | 'Over 0.7' | 'Over 0.8' | 'Over 0.9' | 'Over 1')** : Filter
**Returns**
- **this** : this
### fv.debtEquity(filter) ⇒ this
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 ('High (>0.5)' | 'Low (<0.1)' | 'Under 1' | 'Under 0.9' | 'Under 0.8' | 'Under 0.7' | 'Under 0.6' | 'Under 0.5' | 'Under 0.4' | 'Under 0.3' | 'Under 0.2' | 'Under 0.1' | 'Over 0.1' | 'Over 0.2' | 'Over 0.3' | 'Over 0.4' | 'Over 0.5' | 'Over 0.6' | 'Over 0.7' | 'Over 0.8' | 'Over 0.9' | 'Over 1')** : Filter
**Returns**
- **this** : this
### fv.grossMargin(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'High (>50%)' | 'Under 90%' | 'Under 80%' | 'Under 70%' | 'Under 60%' | 'Under 50%' | 'Under 45%' | 'Under 40%' | 'Under 35%' | 'Under 30%' | 'Under 25%' | 'Under 20%' | 'Under 15%' | 'Under 10%' | 'Under 5%' | 'Under 0%' | 'Under -10%' | 'Under -20%' | 'Under -30%' | 'Under -50%' | 'Under -70%' | 'Under -100%' | 'Over 0%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%' | 'Over 35%' | 'Over 40%' | 'Over 45%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%')** : Filter
**Returns**
- **this** : this
### fv.operatingMargin(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'Very Negative (<-20%)' | 'High (>25%)' | 'Under 90%' | 'Under 80%' | 'Under 70%' | 'Under 60%' | 'Under 50%' | 'Under 45%' | 'Under 40%' | 'Under 35%' | 'Under 30%' | 'Under 25%' | 'Under 20%' | 'Under 15%' | 'Under 10%' | 'Under 5%' | 'Under 0%' | 'Under -10%' | 'Under -20%' | 'Under -30%' | 'Under -50%' | 'Under -70%' | 'Under -100%' | 'Over 0%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%' | 'Over 35%' | 'Over 40%' | 'Over 45%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%')** : Filter
**Returns**
- **this** : this
### fv.netProfitMargin(filter) ⇒ this
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 ('Positive (>0%)' | 'Negative (<0%)' | 'Very Negative (<-20%)' | 'High (>20%)' | 'Under 90%' | 'Under 80%' | 'Under 70%' | 'Under 60%' | 'Under 50%' | 'Under 45%' | 'Under 40%' | 'Under 35%' | 'Under 30%' | 'Under 25%' | 'Under 20%' | 'Under 15%' | 'Under 10%' | 'Under 5%' | 'Under 0%' | 'Under -10%' | 'Under -20%' | 'Under -30%' | 'Under -50%' | 'Under -70%' | 'Under -100%' | 'Over 0%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%' | 'Over 35%' | 'Over 40%' | 'Over 45%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%')** : Filter
**Returns**
- **this** : this
### fv.payoutRatio(filter) ⇒ this
The percentage of earnings paid to shareholders in dividends.
**Arguments**
- **filter ('None (0%)' | 'Positive (>0%)' | 'Low (<20%)' | 'High (>50%)' | 'Over 0%' | 'Over 10%' | 'Over 20%' | 'Over 30%' | 'Over 40%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%' | 'Over 100%' | 'Under 10%' | 'Under 20%' | 'Under 30%' | 'Under 40%' | 'Under 50%' | 'Under 60%' | 'Under 70%' | 'Under 80%' | 'Under 90%' | 'Under 100%')** : Filter
**Returns**
- **this** : this
### fv.insiderOwnership(filter) ⇒ this
Level to which a company is owned by its own management.
**Arguments**
- **filter ('Low (<5%)' | 'High (>30%)' | 'Very High (>50%)' | 'Over 10%' | 'Over 20%' | 'Over 30%' | 'Over 40%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%')** : Filter
**Returns**
- **this** : this
### fv.insiderTransactions(filter) ⇒ this
A company's shares being purchased or sold by its own management. Value represents 6-month percentual change in total insider ownership.
**Arguments**
- **filter ('Very Negative (<20%)' | 'Negative (<0%)' | 'Positive (>0%)' | 'Very Positive (>20%)' | 'Under -90%' | 'Under -80%' | 'Under -70%' | 'Under -60%' | 'Under -50%' | 'Under -45%' | 'Under -40%' | 'Under -35%' | 'Under -30%' | 'Under -25%' | 'Under -20%' | 'Under -15%' | 'Under -10%' | 'Under -5%' | 'Over +5%' | 'Over +10%' | 'Over +15%' | 'Over +20%' | 'Over +25%' | 'Over +30%' | 'Over +35%' | 'Over +40%' | 'Over +45%' | 'Over +50%' | 'Over +60%' | 'Over +70%' | 'Over +80%' | 'Over +90%')** : Filter
**Returns**
- **this** : this
### fv.institutionalOwnership(filter) ⇒ this
Level to which a company is owned by financial institutions.
**Arguments**
- **filter ('Low (<5%)' | 'High (>90%)' | 'Under 90%' | 'Under 80%' | 'Under 70%' | 'Under 60%' | 'Under 50%' | 'Under 40%' | 'Under 30%' | 'Under 20%' | 'Under 10%' | 'Over 10%' | 'Over 20%' | 'Over 30%' | 'Over 40%' | 'Over 50%' | 'Over 60%' | 'Over 70%' | 'Over 80%' | 'Over 90%')** : Filter
**Returns**
- **this** : this
### fv.institutionalTransactions(filter) ⇒ this
A company's shares being purchased or sold by financial institutions. Value represents 3-month change in institutional ownership.
**Arguments**
- **filter ('Very Negative (<20%)' | 'Negative (<0%)' | 'Positive (>0%)' | 'Very Positive (>20%)' | 'Under -50%' | 'Under -45%' | 'Under -40%' | 'Under -35%' | 'Under -30%' | 'Under -25%' | 'Under -20%' | 'Under -15%' | 'Under -10%' | 'Under -5%' | 'Over +5%' | 'Over +10%' | 'Over +15%' | 'Over +20%' | 'Over +25%' | 'Over +30%' | 'Over +35%' | 'Over +40%' | 'Over +45%' | 'Over +50%')** : Filter
**Returns**
- **this** : this
### fv.floatShort(filter) ⇒ this
The amount of short-selling transactions of given stock.
**Arguments**
- **filter ('Low (<5%)' | 'High (>20%)' | 'Under 5%' | 'Under 10%' | 'Under 15%' | 'Under 20%' | 'Under 25%' | 'Under 30%' | 'Over 5%' | 'Over 10%' | 'Over 15%' | 'Over 20%' | 'Over 25%' | 'Over 30%')** : Filter
**Returns**
- **this** : this
### fv.analystRecom(filter) ⇒ this
An outlook of a stock-market analyst on a stock.
**Arguments**
- **filter ('Strong Buy (1)' | 'Buy or better' | 'Buy' | 'Hold or better' | 'Hold' | 'Hold or worse' | 'Sell' | 'Sell or worse' | 'Strong Sell (5)')** : Filter
**Returns**
- **this** : this
### fv.optionShort(filter) ⇒ this
Stocks with options and/or available to sell short.
**Arguments**
- **filter ('Optionable' | 'Shortable' | 'Optionable and shortable')** : Filter
**Returns**
- **this** : this
### fv.earningsDate(filter) ⇒ this
Date when company reports earnings
**Arguments**
- **filter ('Today' | 'Today Before Market Open' | 'Today After Market Close' | 'Tomorrow' | 'Tomorrow Before Market Open' | 'Tomorrow After Market Close' | 'Yesterday' | 'Yesterday Before Market Open' | 'Yesterday After Market Close' | 'Next 5 Days' | 'Previous 5 Days' | 'This Week' | 'Next Week' | 'Previous Week' | 'This Month')** : Filter
**Returns**
- **this** : this
### fv.performance(filter) ⇒ this
Rate of return for a given stock.
**Arguments**
- **filter ('Today Up' | 'Today Down' | 'Today -15%' | 'Today -10%' | 'Today -5%' | 'Today +5%' | 'Today +10%' | 'Today +15%' | 'Week -30%' | 'Week -20%' | 'Week -10%' | 'Week Down' | 'Week Up' | 'Week +10%' | 'Week +20%' | 'Week +30%' | 'Month -50%' | 'Month -30%' | 'Month -20%' | 'Month -10%' | 'Month Down' | 'Month Up' | 'Month +10%' | 'Month +20%' | 'Month +30%' | 'Month +50%' | 'Quarter -50%' | 'Quarter -30%' | 'Quarter -20%' | 'Quarter -10%' | 'Quarter Down' | 'Quarter Up' | 'Quarter +10%' | 'Quarter +20%' | 'Quarter +30%' | 'Quarter +50%' | 'Half -75%' | 'Half -50%' | 'Half -30%' | 'Half -20%' | 'Half -10%' | 'Half Down' | 'Half Up' | 'Half +10%' | 'Half +20%' | 'Half +30%' | 'Half +50%' | 'Half +100%' | 'Year -75%' | 'Year -50%' | 'Year -30%' | 'Year -20%' | 'Year -10%' | 'Year Down' | 'Year Up' | 'Year +10%' | 'Year +20%' | 'Year +30%' | 'Year +50%' | 'Year +100%' | 'Year +200%' | 'Year +300%' | 'Year +500%' | 'YTD -75%' | 'YTD -50%' | 'YTD -30%' | 'YTD -20%' | 'YTD -10%' | 'YTD -5%' | 'YTD Down' | 'YTD Up' | 'YTD +5%' | 'YTD +10%' | 'YTD +20%' | 'YTD +30%' | 'YTD +50%' | 'YTD +100%')** : Filter
**Returns**
- **this** : this
### fv.performance2(filter) ⇒ this
Rate of return for a given stock.
**Arguments**
- **filter ('Today Up' | 'Today Down' | 'Today -15%' | 'Today -10%' | 'Today -5%' | 'Today +5%' | 'Today +10%' | 'Today +15%' | 'Week -30%' | 'Week -20%' | 'Week -10%' | 'Week Down' | 'Week Up' | 'Week +10%' | 'Week +20%' | 'Week +30%' | 'Month -50%' | 'Month -30%' | 'Month -20%' | 'Month -10%' | 'Month Down' | 'Month Up' | 'Month +10%' | 'Month +20%' | 'Month +30%' | 'Month +50%' | 'Quarter -50%' | 'Quarter -30%' | 'Quarter -20%' | 'Quarter -10%' | 'Quarter Down' | 'Quarter Up' | 'Quarter +10%' | 'Quarter +20%' | 'Quarter +30%' | 'Quarter +50%' | 'Half -75%' | 'Half -50%' | 'Half -30%' | 'Half -20%' | 'Half -10%' | 'Half Down' | 'Half Up' | 'Half +10%' | 'Half +20%' | 'Half +30%' | 'Half +50%' | 'Half +100%' | 'Year -75%' | 'Year -50%' | 'Year -30%' | 'Year -20%' | 'Year -10%' | 'Year Down' | 'Year Up' | 'Year +10%' | 'Year +20%' | 'Year +30%' | 'Year +50%' | 'Year +100%' | 'Year +200%' | 'Year +300%' | 'Year +500%' | 'YTD -75%' | 'YTD -50%' | 'YTD -30%' | 'YTD -20%' | 'YTD -10%' | 'YTD -5%' | 'YTD Down' | 'YTD Up' | 'YTD +5%' | 'YTD +10%' | 'YTD +20%' | 'YTD +30%' | 'YTD +50%' | 'YTD +100%')** : Filter
**Returns**
- **this** : this
### fv.volatility(filter) ⇒ this
A statistical measure of the dispersion of returns for a given stock. Represents average daily high/low trading range.
**Arguments**
- **filter ('Week - Over 3%' | 'Week - Over 4%' | 'Week - Over 5%' | 'Week - Over 6%' | 'Week - Over 7%' | 'Week - Over 8%' | 'Week - Over 9%' | 'Week - Over 10%' | 'Week - Over 12%' | 'Week - Over 15%' | 'Month - Over 2%' | 'Month - Over 3%' | 'Month - Over 4%' | 'Month - Over 5%' | 'Month - Over 6%' | 'Month - Over 7%' | 'Month - Over 8%' | 'Month - Over 9%' | 'Month - Over 10%' | 'Month - Over 12%' | 'Month - Over 15%')** : Filter
**Returns**
- **this** : this
### fv.rsi14(filter) ⇒ this
The Relative Strength Index (RSI) is a technical analysis oscillator showing price strength by comparing upward and downward close-to-close movements.
**Arguments**
- **filter ('Overbought (90)' | 'Overbought (80)' | 'Overbought (70)' | 'Overbought (60)' | 'Oversold (40)' | 'Oversold (30)' | 'Oversold (20)' | 'Oversold (10)' | 'Not Overbought (<60)' | 'Not Overbought (<50)' | 'Not Oversold (>50)' | 'Not Oversold (>40)')** : Filter
**Returns**
- **this** : this
### fv.gap(filter) ⇒ this
The difference between yesterday's closing price and today's opening price.
**Arguments**
- **filter ('Up' | 'Up 0%' | 'Up 1%' | 'Up 2%' | 'Up 3%' | 'Up 4%' | 'Up 5%' | 'Up 6%' | 'Up 7%' | 'Up 8%' | 'Up 9%' | 'Up 10%' | 'Up 15%' | 'Up 20%' | 'Down' | 'Down 0%' | 'Down 1%' | 'Down 2%' | 'Down 3%' | 'Down 4%' | 'Down 5%' | 'Down 6%' | 'Down 7%' | 'Down 8%' | 'Down 9%' | 'Down 10%' | 'Down 15%' | 'Down 20%')** : Filter
**Returns**
- **this** : this
### fv.twentyDaySimpleMovingAverage(filter) ⇒ this
20-Day simple moving average of closing price is the mean of the previous 20 days' closing prices.
**Arguments**
- **filter ('Price below SMA20' | 'Price 10% below SMA20' | 'Price 20% below SMA20' | 'Price 30% below SMA20' | 'Price 40% below SMA20' | 'Price 50% below SMA20' | 'Price above SMA20' | 'Price 10% above SMA20' | 'Price 20% above SMA20' | 'Price 30% above SMA20' | 'Price 40% above SMA20' | 'Price 50% above SMA20' | 'Price crossed SMA20' | 'Price crossed SMA20 above' | 'Price crossed SMA20 below' | 'SMA20 crossed SMA50' | 'SMA20 crossed SMA50 above' | 'SMA20 crossed SMA50 below' | 'SMA20 crossed SMA200' | 'SMA20 crossed SMA200 above' | 'SMA20 crossed SMA200 below' | 'SMA20 above SMA50' | 'SMA20 below SMA50' | 'SMA20 above SMA200' | 'SMA20 below SMA200')** : Filter
**Returns**
- **this** : this
### fv.fiftyDaySimpleMovingAverage(filter) ⇒ this
50-Day simple moving average of closing price is the mean of the previous 50 days' closing prices.
**Arguments**
- **filter ('Price below SMA50' | 'Price 10% below SMA50' | 'Price 20% below SMA50' | 'Price 30% below SMA50' | 'Price 40% below SMA50' | 'Price 50% below SMA50' | 'Price above SMA50' | 'Price 10% above SMA50' | 'Price 20% above SMA50' | 'Price 30% above SMA50' | 'Price 40% above SMA50' | 'Price 50% above SMA50' | 'Price crossed SMA50' | 'Price crossed SMA50 above' | 'Price crossed SMA50 below' | 'SMA50 crossed SMA20' | 'SMA50 crossed SMA20 above' | 'SMA50 crossed SMA20 below' | 'SMA50 crossed SMA200' | 'SMA50 crossed SMA200 above' | 'SMA50 crossed SMA200 below' | 'SMA50 above SMA20' | 'SMA50 below SMA20' | 'SMA50 above SMA200' | 'SMA50 below SMA200')** : Filter
**Returns**
- **this** : this
### fv.twoHundredDaySimpleMovingAverage(filter) ⇒ this
200-Day simple moving average of closing price is the mean of the previous 200 days' closing prices.
**Arguments**
- **filter ('Price below SMA200' | 'Price 10% below SMA200' | 'Price 20% below SMA200' | 'Price 30% below SMA200' | 'Price 40% below SMA200' | 'Price 50% below SMA200' | 'Price 60% below SMA200' | 'Price 70% below SMA200' | 'Price 80% below SMA200' | 'Price 90% below SMA200' | 'Price above SMA200' | 'Price 10% above SMA200' | 'Price 20% above SMA200' | 'Price 30% above SMA200' | 'Price 40% above SMA200' | 'Price 50% above SMA200' | 'Price 60% above SMA200' | 'Price 70% above SMA200' | 'Price 80% above SMA200' | 'Price 90% above SMA200' | 'Price 100% above SMA200' | 'Price crossed SMA200' | 'Price crossed SMA200 above' | 'Price crossed SMA200 below' | 'SMA200 crossed SMA20' | 'SMA200 crossed SMA20 above' | 'SMA200 crossed SMA20 below' | 'SMA200 crossed SMA50' | 'SMA200 crossed SMA50 above' | 'SMA200 crossed SMA50 below' | 'SMA200 above SMA20' | 'SMA200 below SMA20' | 'SMA200 above SMA50' | 'SMA200 below SMA50')** : Filter
**Returns**
- **this** : this
### fv.change(filter) ⇒ this
The difference between previous's close price and today's last price.
**Arguments**
- **filter ('Up' | 'Up 1%' | 'Up 2%' | 'Up 3%' | 'Up 4%' | 'Up 5%' | 'Up 6%' | 'Up 7%' | 'Up 8%' | 'Up 9%' | 'Up 10%' | 'Up 15%' | 'Up 20%' | 'Down' | 'Down 1%' | 'Down 2%' | 'Down 3%' | 'Down 4%' | 'Down 5%' | 'Down 6%' | 'Down 7%' | 'Down 8%' | 'Down 9%' | 'Down 10%' | 'Down 15%' | 'Down 20%')** : Filter
**Returns**
- **this** : this
### fv.changeFromOpen(filter) ⇒ this
The difference between today's open price and today's last price.
**Arguments**
- **filter ('Up' | 'Up 1%' | 'Up 2%' | 'Up 3%' | 'Up 4%' | 'Up 5%' | 'Up 6%' | 'Up 7%' | 'Up 8%' | 'Up 9%' | 'Up 10%' | 'Up 15%' | 'Up 20%' | 'Down' | 'Down 1%' | 'Down 2%' | 'Down 3%' | 'Down 4%' | 'Down 5%' | 'Down 6%' | 'Down 7%' | 'Down 8%' | 'Down 9%' | 'Down 10%' | 'Down 15%' | 'Down 20%')** : Filter
**Returns**
- **this** : this
### fv.twentyDayHighLow(filter) ⇒ this
Maximum/minimum of previous 20 days' highs/lows.
**Arguments**
- **filter ('New High' | 'New Low' | '5% or more below High' | '10% or more below High' | '15% or more below High' | '20% or more below High' | '30% or more below High' | '40% or more below High' | '50% or more below High' | '0-3% below High' | '0-5% below High' | '0-10% below High' | '5% or more above Low' | '10% or more above Low' | '15% or more above Low' | '20% or more above Low' | '30% or more above Low' | '40% or more above Low' | '50% or more above Low' | '0-3% above Low' | '0-5% above Low' | '0-10% above Low')** : Filter
**Returns**
- **this** : this
### fv.fiftyDayHighLow(filter) ⇒ this
Maximum/minimum of previous 50 days' highs/lows.
**Arguments**
- **filter ('New High' | 'New Low' | '5% or more below High' | '10% or more below High' | '15% or more below High' | '20% or more below High' | '30% or more below High' | '40% or more below High' | '50% or more below High' | '0-3% below High' | '0-5% below High' | '0-10% below High' | '5% or more above Low' | '10% or more above Low' | '15% or more above Low' | '20% or more above Low' | '30% or more above Low' | '40% or more above Low' | '50% or more above Low' | '0-3% above Low' | '0-5% above Low' | '0-10% above Low')** : Filter
**Returns**
- **this** : this
### fv.fiftyTwoWeekHighLow(filter) ⇒ this
Maximum/minimum of previous 52 weeks' highs/lows.
**Arguments**
- **filter ('New High' | 'New Low' | '5% or more below High' | '10% or more below High' | '15% or more below High' | '20% or more below High' | '30% or more below High' | '40% or more below High' | '50% or more below High' | '60% or more below High' | '70% or more below High' | '80% or more below High' | '90% or more below High' | '0-3% below High' | '0-5% below High' | '0-10% below High' | '5% or more above Low' | '10% or more above Low' | '15% or more above Low' | '20% or more above Low' | '30% or more above Low' | '40% or more above Low' | '50% or more above Low' | '60% or more above Low' | '70% or more above Low' | '80% or more above Low' | '90% or more above Low' | '100% or more above Low' | '120% or more above Low' | '150% or more above Low' | '200% or more above Low' | '300% or more above Low' | '500% or more above Low' | '0-3% above Low' | '0-5% above Low' | '0-10% above Low')** : Filter
**Returns**
- **this** : this
### fv.pattern(filter) ⇒ this
A chart pattern is a distinct formation on a stock chart that creates a trading signal, or a sign of future price movements. Chartists use these patterns to identify current trends and trend reversals and to trigger buy and sell signals.
**Arguments**
- **filter ('Horizontal S/R' | 'Horizontal S/R (Strong)' | 'TL Resistance' | 'TL Resistance (Strong)' | 'TL Support' | 'TL Support (Strong)' | 'Wedge Up' | 'Wedge Up (Strong)' | 'Wedge Down' | 'Wedge Down (Strong)' | 'Triangle Ascending' | 'Triangle Ascending (Strong)' | 'Triangle Descending' | 'Triangle Descending (Strong)' | 'Wedge' | 'Wedge (Strong)' | 'Channel Up' | 'Channel Up (Strong)' | 'Channel Down' | 'Channel Down (Strong)' | 'Channel' | 'Channel (Strong)' | 'Double Top' | 'Double Bottom' | 'Multiple Top' | 'Multiple Bottom' | 'Head & Shoulders' | 'Head & Shoulders Inverse')** : Filter
**Returns**
- **this** : this
### fv.candlestick(filter) ⇒ this
Candlesticks are usually composed of the body (black or white), an upper and a lower shadow (wick). The wick illustrates the highest and lowest traded prices of a stock during the time interval represented. The body illustrates the opening and closing trades.
**Arguments**
- **filter ('Long Lower Shadow' | 'Long Upper Shadow' | 'Hammer' | 'Inverted Hammer' | 'Spinning Top White' | 'Spinning Top Black' | 'Doji' | 'Dragonfly Doji' | 'Gravestone Doji' | 'Marubozu White' | 'Marubozu Black')** : Filter
**Returns**
- **this** : this
### fv.beta(filter) ⇒ this
A measure of a stock’s price volatility relative to the market. An asset with a beta of 0 means that its price is not at all correlated with the market. A positive beta means that the asset generally follows the market. A negative beta shows that the asset inversely follows the market, decreases in value if the market goes up.
**Arguments**
- **filter ('Under 0' | 'Under 0.5' | 'Under 1' | 'Under 1.5' | 'Under 2' | 'Over 0' | 'Over 0.5' | 'Over 1' | 'Over 1.5' | 'Over 2' | 'Over 2.5' | 'Over 3' | 'Over 4' | '0 to 0.5' | '0 to 1' | '0.5 to 1' | '0.5 to 1.5' | '1 to 1.5' | '1 to 2')** : Filter
**Returns**
- **this** : this
### fv.averageTrueRange(filter) ⇒ this
A measure of stock volatility. The Average True Range is an exponential moving average (14-days) of the True Ranges. The range of a day's trading is high−low, True Range extends it to yesterday's closing price if it was outside of today's range, True Range = max(high,closeprev) − min(low,closeprev)
**Arguments**
- **filter ('Over 0.25' | 'Over 0.5' | 'Over 0.75' | 'Over 1' | 'Over 1.5' | 'Over 2' | 'Over 2.5' | 'Over 3' | 'Over 3.5' | 'Over 4' | 'Over 4.5' | 'Over 5' | 'Under 0.25' | 'Under 0.5' | 'Under 0.75' | 'Under 1' | 'Under 1.5' | 'Under 2' | 'Under 2.5' | 'Under 3' | 'Under 3.5' | 'Under 4' | 'Under 4.5' | 'Under 5')** : Filter
**Returns**
- **this** : this
### fv.averageVolume(filter) ⇒ this
The average number of shares traded in a security per day.
**Arguments**
- **filter ('Under 50K' | 'Under 100K' | 'Under 500K' | 'Under 750K' | 'Under 1M' | 'Over 50K' | 'Over 100K' | 'Over 200K' | 'Over 300K' | 'Over 400K' | 'Over 500K' | 'Over 750K' | 'Over 1M' | 'Over 2M' | '100K to 500K' | '100K to 1M' | '500K to 1M' | '500K to 10M')** : Filter
**Returns**
- **this** : this
### fv.relativeVolume(filter) ⇒ this
Ratio between current volume and 3-month average, intraday adjusted.
**Arguments**
- **filter ('Over 10' | 'Over 5' | 'Over 3' | 'Over 2' | 'Over 1.5' | 'Over 1' | 'Over 0.75' | 'Over 0.5' | 'Over 0.25' | 'Under 2' | 'Under 1.5' | 'Under 1' | 'Under 0.75' | 'Under 0.5' | 'Under 0.25' | 'Under 0.1')** : Filter
**Returns**
- **this** : this
### fv.currentVolume(filter) ⇒ this
Number of shares traded today.
**Arguments**
- **filter ('Under 50K' | 'Under 100K' | 'Under 500K' | 'Under 750K' | 'Under 1M' | 'Over 0' | 'Over 50K' | 'Over 100K' | 'Over 200K' | 'Over 300K' | 'Over 400K' | 'Over 500K' | 'Over 750K' | 'Over 1M' | 'Over 2M' | 'Over 5M' | 'Over 10M' | 'Over 20M')** : Filter
**Returns**
- **this** : this
### fv.price(filter) ⇒ this
The current stock price.
**Arguments**
- **filter ('Under $1' | 'Under $2' | 'Under $3' | 'Under $4' | 'Under $5' | 'Under $7' | 'Under $10' | 'Under $15' | 'Under $20' | 'Under $30' | 'Under $40' | 'Under $50' | 'Over $1' | 'Over $2' | 'Over $3' | 'Over $4' | 'Over $5' | 'Over $7' | 'Over $10' | 'Over $15' | 'Over $20' | 'Over $30' | 'Over $40' | 'Over $50' | 'Over $60' | 'Over $70' | 'Over $80' | 'Over $90' | 'Over $100' | '$1 to $5' | '$1 to $10' | '$1 to $20' | '$5 to $10' | '$5 to $20' | '$5 to $50' | '$10 to $20' | '$10 to $50' | '$20 to $50' | '$50 to $100')** : Filter
**Returns**
- **this** : this
### fv.targetPrice(filter) ⇒ this
Analysts' mean target price.
**Arguments**
- **filter ('50% Above Price' | '40% Above Price' | '30% Above Price' | '20% Above Price' | '10% Above Price' | '5% Above Price' | 'Above Price' | 'Below Price' | '5% Below Price' | '10% Below Price' | '20% Below Price' | '30% Below Price' | '40% Below Price' | '50% Below Price')** : Filter
**Returns**
- **this** : this
### fv.ipoDate(filter) ⇒ this
Date when company had an IPO.
**Arguments**
- **filter ('Today' | 'Yesterday' | 'In the last week' | 'In the last month' | 'In the last quarter' | 'In the last year' | 'In the last 2 years' | 'In the last 3 years' | 'In the last 5 years' | 'More than a year ago' | 'More than 5 years ago' | 'More than 10 years ago' | 'More than 15 years ago' | 'More than 20 years ago' | 'More than 25 years ago')** : Filter
**Returns**
- **this** : this
### fv.sharesOutstanding(filter) ⇒ this
Shares outstanding represent the total number of shares issued by a corporation and held by its shareholders.
**Arguments**
- **filter ('Under 1M' | 'Under 5M' | 'Under 10M' | 'Under 20M' | 'Under 50M' | 'Under 100M' | 'Over 1M' | 'Over 2M' | 'Over 5M' | 'Over 10M' | 'Over 20M' | 'Over 50M' | 'Over 100M' | 'Over 200M' | 'Over 500M' | 'Over 1000M')** : Filter
**Returns**
- **this** : this
### fv.float(filter) ⇒ this
Float is the number of stock shares that are available for trading to the public. This doesn't include shares held by insiders.
**Arguments**
- **filter ('Under 1M' | 'Under 5M' | 'Under 10M' | 'Under 20M' | 'Under 50M' | 'Under 100M' | 'Over 1M' | 'Over 2M' | 'Over 5M' | 'Over 10M' | 'Over 20M' | 'Over 50M' | 'Over 100M' | 'Over 200M' | 'Over 500M' | 'Over 1000M')** : Filter
**Returns**
- **this** : this
### fv.signal(signal) ⇒ this
TA Signal
**Arguments**
- **signal ('Top Gainers' | 'Top Losers' | 'New High' | 'New Low' | 'Most Volatile' | 'Most Active' | 'Unusual Volume' | 'Overbought' | 'Oversold' | 'Downgrades' | 'Upgrades' | 'Earnings Before' | 'Earnings After' | 'Recent Insider Buying' | 'Recent Insider Selling' | 'Major News' | 'Horizontal S/R' | 'TL Resistance' | 'TL Support' | 'Wedge Up' | 'Wedge Down' | 'Triangle Ascending' | 'Triangle Descending' | 'Wedge' | 'Channel Up' | 'Channel Down' | 'Channel' | 'Double Top' | 'Double Bottom' | 'Multiple Top' | 'Multiple Bottom' | 'Head & Shoulders' | 'Head & Shoulders Inverse')** : TA signal
**Returns**
- **this** : this
## Type Definitions
## Options : object
**Properties**
- **pageLimit (number)** : Maximum number of pages to fetch. Set to `0` to disable. Default is 1
- **requestTimeout (number)** : Number of milliseconds to wait between requests. Default is 1000