项目作者: knicola

项目描述 :
FinViz stock screener library for Node.js
高级语言: JavaScript
项目地址: git://github.com/knicola/finviz-screener.git
创建时间: 2021-08-18T18:07:54Z
项目社区:https://github.com/knicola/finviz-screener

开源协议:MIT License

下载


FinViz Screener Library for Node.js

Free, open-source Node.js client for the FinViz Stock Screener.

Installing

Using npm:

  1. $ npm install finviz-screener

Using yarn:

  1. $ yarn add finviz-screener

Usage

  1. // ES6
  2. import finviz from 'finviz-screener'
  1. // CommonJs
  2. const finviz = require('finviz-screener')
  1. const options = {
  2. // Maximum number of pages to fetch. Set to `0` to disable. Default is 1
  3. pageLimit: 1,
  4. // Number of milliseconds to wait between requests. Default is 1000
  5. requestTimeout: 1000,
  6. }
  7. const tickers = await finviz(options)
  8. .averageVolume('Over 2M')
  9. .sector('Technology')
  10. .price('Over $50')
  11. .scan()
  12. console.log(tickers) //=> ['AAPL', 'MSFT', 'IBM', ... ]

By default, the client will fetch only the first page of tickers (~1000 per page). To fetch more pages, increase the pageLimit option. Set pageLimit = 0 to fetch all available pages.

API

See docs/API.md file for the full list of available methods.

Development

This library is built using file generators. They do most of the heavy lifting around here by generating the “filter” methods and tests, the typescript definitions and the API documentation 🎉.

Any changes to this library, must be introduced to the file generators or the src/index.js and src/base.js files. Make sure to run npm run build and review the changes before submitting anything.

License

This project is open-sourced software licensed under the MIT license.