Nascent Political Miscreant
    Have ideas to improve npm?Join in the discussion! »

    @stonksjs/finviz

    1.0.1 • Public • Published

    @stonksjs/finviz

    Stock screener and company data from finviz

    npm (scoped)

    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

    Usage

    const finviz = require('@stonksjs/finviz');
     
    // get company financial data
    const data = await finviz.quote('MSFT');
    // see below for example response object
     
    // get results from a custom finviz screener
    const symbols = await finviz.screener(
      'https://finviz.com/screener.ashx?v=111&s=ta_topgainers',
    );
    // ['AAPL', 'MSFT', 'TSLA', ...]

    API

    Example

    const finviz = require('@stonksjs/finviz');

    finviz.quote(symbol) ⇒ Promise

    Get detailed company financial data

    Kind: static method of @stonksjs/finviz Returns: Promise - resolves to a plain object, rejects with an Error Fulfil: object - company financial data Reject: Error See: Response schema

    Param Type Description
    symbol string ticker symbol of the company

    Example

    const data = await finviz.quote('MSFT'); // {Promise<object>}

    finviz.screener(url) ⇒ Promise

    Get ticker symbols from the results of a custom finviz screener

    Kind: static method of @stonksjs/finviz Returns: Promise - resolves to an array of strings, rejects with an Error Fulfil: string[] - array of ticker symbols for each row of results Reject: Error

    Param Type Description
    url string the url from the screener page you want to query

    Example

    const symbols = await finviz.screener(
      'https://finviz.com/screener.ashx?v=111&s=ta_topgainers',
    ); // {Promise<string[]>}

    Response schema

    // pulled from https://finviz.com/quote.ashx?t=AACG
    {
      index: '',
      pE: '',
      epsTtm: '',
      insiderOwn: '',
      shsOutstand: '',
      perfWeek: '',
      marketCap: '',
      forwardPE: '',
      epsNextY: '',
      insiderTrans: '',
      shsFloat: '',
      perfMonth: '',
      income: '',
      peg: '',
      epsNextQ: '',
      instOwn: '',
      shortFloat: '',
      perfQuarter: '',
      sales: '',
      pS: '',
      epsThisY: '',
      instTrans: '',
      shortRatio: '',
      perfHalfY: '',
      bookSh: '',
      pB: '',
      roa: '',
      targetPrice: '',
      perfYear: '',
      cashSh: '',
      pC: '',
      epsNext5Y: '',
      roe: '',
      '52WRange': '',
      perfYtd: '',
      dividend: '',
      pFcf: '',
      epsPast5Y: '',
      roi: '',
      '52WHigh': '',
      beta: '',
      quickRatio: '',
      salesPast5Y: '',
      grossMargin: '',
      '52WLow': '',
      atr: '',
      employees: '',
      currentRatio: '',
      salesQQ: '',
      operMargin: '',
      rsi14: '',
      volatility: '',
      optionable: '',
      debtEq: '',
      epsQQ: '',
      profitMargin: '',
      relVolume: '',
      prevClose: '',
      shortable: '',
      ltDebtEq: '',
      earnings: '',
      payout: '',
      avgVolume: '',
      price: '',
      recom: '',
      sma20: '',
      sma50: '',
      sma200: '',
      volume: '',
      change: ''
    }

    Keywords

    none

    Install

    npm i @stonksjs/finviz

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    ISC

    Unpacked Size

    10 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar