<img src="https://raw.githubusercontent.com/nielse63/stonksjs/main/docs/assets/logo.svg" align="right" width="100" />

stonksjs

Reliable algotrading utilities written in node

• Features
  • Goals
• Usage
• Development
  • Setup
  • Testing
  • Release
• Contributing
• Roadmap

Features

• Custom screeners from finviz, msn, and finscreener
• Detailed ticker fundamentals
• Module and CommonJS compatible
• Light-weight - few to no dependencies

Goals

What stonksjs is:

The primary objective of this project are:

• To provide a collection of reliable algotrading utilities written in typescript/node
• Take some of the guess-work out of the stock research process by using industry-tested, predefined screeners
• Provide more data-points for a given instrument than most packages currently available
• Enable algotrading programmers with diversified assets - not just the hottest options rumors on r/wallstreetbets

What stonksjs is not:

• stonksjs is not a roboadvisor or professional trading app - this is just a fun little side project
• stonksjs is not an unofficial API for Robinhood or any other brokerage. If that's what you're looking for, I'd recommend algotrader
• stonksjs is not a backtesting tool, although that might get added to the roadmap soon

Usage

Installation, usage, and API docs can be found in each scoped package directory.

| Name | Description | Version | | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | | @stonksjs/core | Single point of entry for all stonksjs packages | | | @stonksjs/quote | Detailed, real-time stock quote data | | | @stonksjs/finviz | Unofficial finviz API | | | @stonksjs/stock-screener | Pre-defined industry standard stock screeners from MSN Money | |

Development

Setup

Prerequisites

This project requires node v16.20.1.

Installation

Clone the repo and install the dependencies:

git clone http://github.com/nielse63/stonksjs.git
cd stonksjs
nvm use
npm ci

Testing

Tests are run using jest, and can be run by executing:

npm test

# run with coverage
npm test -- --coverage

Release

To release a new version, run:

npm run release

This executes lerna publish behind the scenes, and you'll be prompted with a few questions before the package is deployed.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Roadmap

All new features and changes are being tracked in GitHub under the projects and issues tabs of this repo.