samgozman / finvizor

Get finviz data

finvizor

Get full financial data from finviz!

Installation

Install package from NPM

npm install finvizor

Features

The main differences and advantages in comparison with similar NPM modules are the more convenient presentation of the data returned by the function.

Object Keys

Object keys have been redesigned to make them look meaningful and readable. No more string keys in NPM modules! Camel case is used in key names only where it is needed. For instance 'P/E' => 'pe', 'Target price' => 'targetPrice' etc.

All keys (and there are more than 80 of them) have short descriptions taken from the official site.

Object Values

All numeric key values are presented as numerical values, rather than strings as default. Boolean values, ranges and the date of earnings are also parsed separately. All this is done so that the data from the site can be used in your code for calculations right out of the box!

Usage

Use finvizor in async functions

const finvizor = require('finvizor')

const main = async () => {
  const stock = await finvizor.stock('AAPL')
  console.log(stock)
}

main()

Returns

await finvizor.stock('AAPL')

{
  ticker: 'AAPL',
  name: 'Apple Inc.',
  site: 'http://www.apple.com',
  exchange: 'NASD',
  sector: 'Technology',
  industry: 'Consumer Electronics',
  country: 'USA',
  index: 'DJIA S&P500',
  pe: 36.53,
  eps: 3.7,
  insiderOwn: 0.07,
  shsOutstand: 16940000000,
  ...
  earnings: { date: 1611694800000, marketTime: 'AMC' },
  payout: 21.6,
  avgVolume: 103190000,
  price: 134.24,
  recom: 2,
  sma20: -0.92,
  sma50: 2.49,
  sma200: 21.89,
  volume: 5659762,
  change: -0.66,
  insidersDeals: [
    {
      insiderTrading: 'Williams Jeffrey E',
      insiderTradingLink: 'https://finviz.com/insidertrading.ashx?oc=1496686&tc=7',
      relationship: 'COO',
      date: 'Apr 05',
      transaction: 'Sale',
      cost: '125.74',
      shares: '133,867',
      value: '16,832,437',
      sharesTotal: '489,490',
      secForm4: 'Apr 05 06:36 PM',
      secForm4Link: 'http://www.sec.gov/Archives/edgar/data/320193/000032019321000046/xslF345X03/wf-form4_161766207883637.xml'
    }
    ...
  ]
}

finvizor's Issues

TypeError: Cannot read properties of undefined (reading 'replace')

Since 2023-04-19 the library stop working with the following error:
Error: TypeError: Cannot read properties of undefined (reading 'replace')
at C:\Users\angel\Development\mpro-notify\stocks\node_modules\finvizor\lib\quote.js:126:27
at step (C:\Users\angel\Development\mpro-notify\stocks\node_modules\finvizor\lib\quote.js:33:23)
at Object.next (C:\Users\angel\Development\mpro-notify\stocks\node_modules\finvizor\lib\quote.js:14:53)
at fulfilled (C:\Users\angel\Development\mpro-notify\stocks\node_modules\finvizor\lib\quote.js:5:58)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

finvizor library version 1.1.2

Fix typo for recommendation attribute

[bug] Fix main elements mismatch

"name": "",
"exchange": "MicrosoftCorporation",
"country": "",
"site": "screener.ashx?v=111&f=sec_technology",

Finvizor no longer parsing the ticker information correctly

Starting today, the finvizor is query the ticker correctly, however, it no longer maps some properties in the response, the most obvious one would be the symbol, the attached file shows today's answer from AMD query.
example.txt

Fix for new site schema

Insiders trades bug

[bug] Update finviz schema

https://github.com/samgozman/finvizor/actions/runs/6617376477

Quote proccessing failed with "TypeError: Cannot read properties of undefined (reading 'split')"

Starting last monday, Finvizor is unable to process the quote information correctly and it is failing with the following error:
ERROR Error: TypeError: Cannot read properties of undefined (reading 'split') at Object.getStock (/var/task/node_modules/finvizor/lib/quote.js:82:15)