@stonksjs/finviz

Unofficial finviz API

• Features
• Installation
• Usage
  • Available Screener Filters
  • Quote Response Schema
• API

Features

• Get detailed company financial data
• Use the URL from a custom finviz screener fetch the results in node

Installation

npm install --save @stonksjs/finviz
Copy

Usage

import finviz from '@stonksjs/finviz';

// get company financial data
const data = await finviz.getQuote('MSFT');

// get results from a pre-defined finviz screener
const symbols = await finviz.getScreener('Top Gainers');
Copy

Available Screener Filters

• 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

Quote Response Schema

The response schema for the getQuote function is as follows:

type Quote = {
  index: string;
  pE: number;
  epsTtm: number;
  insiderOwn: string;
  shsOutstand: string;
  perfWeek: string;
  marketCap: string;
  forwardPE: number;
  epsNextY: string;
  insiderTrans: string;
  shsFloat: string;
  perfMonth: string;
  income: string;
  peg: number;
  epsNextQ: number;
  instOwn: string;
  shortFloatRatio: string;
  perfQuarter: string;
  sales: string;
  pS: number;
  epsThisY: string;
  instTrans: string;
  shortInterest: string;
  perfHalfY: string;
  bookSh: number;
  pB: number;
  roa: string;
  targetPrice: number;
  perfYear: string;
  cashSh: number;
  pC: number;
  epsNext5Y: string;
  roe: string;
  '52WRange': string;
  perfYtd: string;
  dividend: string;
  pFcf: number;
  epsPast5Y: string;
  roi: string;
  '52WHigh': string;
  beta: number;
  quickRatio: number;
  salesPast5Y: string;
  grossMargin: string;
  '52WLow': string;
  atr: number;
  employees: number;
  currentRatio: number;
  salesQQ: string;
  operMargin: string;
  rsi14: number;
  volatility: string;
  optionable: string;
  debtEq: number;
  epsQQ: string;
  profitMargin: string;
  relVolume: number;
  prevClose: number;
  shortable: string;
  ltDebtEq: number;
  earnings: string;
  payout: string;
  avgVolume: string;
  price: number;
  recom: number;
  sma20: string;
  sma50: string;
  sma200: string;
  volume: number;
  change: string;
};
Copy

API

Full API docs can be found at docs/modules