nielse63
@stonksjs/stock-screener
Pre-defined industry standard stock screeners from Finviz
Installation
npm install --save @stonksjs/stock-screenerUsage
import stockScreener from '@stonksjs/stock-screener';
// the object of key/value pairs of finviz stock screeners
const { filters } = stockScreener;
console.log(filters);
// get the latest available filters
const filters = await stockScreener.getFilters();
console.log(filters);
// get results from "Top Gainers" screener
const symbols = await stockScreener.getTopGainers();
console.log(symbols);Available Screener Filters
- Top Gainers:
TOP_GAINERS - Top Losers:
TOP_LOSERS - New High:
NEW_HIGH - New Low:
NEW_LOW - Most Volatile:
MOST_VOLATILE - Most Active:
MOST_ACTIVE - Unusual Volume:
UNUSUAL_VOLUME - Overbought:
OVERBOUGHT - Oversold:
OVERSOLD - Downgrades:
DOWNGRADES - Upgrades:
UPGRADES - Earnings Before:
EARNINGS_BEFORE - Earnings After:
EARNINGS_AFTER - Recent Insider Buying:
RECENT_INSIDER_BUYING - Recent Insider Selling:
RECENT_INSIDER_SELLING - Major News:
MAJOR_NEWS - Horizontal S/R:
HORIZONTAL_S_R - TL Resistance:
TL_RESISTANCE - TL Support:
TL_SUPPORT - Wedge Up:
WEDGE_UP - Wedge Down:
WEDGE_DOWN - Triangle Ascending:
TRIANGLE_ASCENDING - Triangle Descending:
TRIANGLE_DESCENDING - Wedge:
WEDGE - Channel Up:
CHANNEL_UP - Channel Down:
CHANNEL_DOWN - Channel:
CHANNEL - Double Top:
DOUBLE_TOP - Double Bottom:
DOUBLE_BOTTOM - Multiple Top:
MULTIPLE_TOP - Multiple Bottom:
MULTIPLE_BOTTOM - Head & Shoulders:
HEAD_SHOULDERS - Head & Shoulders Inverse:
HEAD_SHOULDERS_INVERSE
API
Full API docs can be found at
docs/modules