Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nielse63/stonksjs

Reliable algotrading utilities written in node
https://github.com/nielse63/stonksjs

dividends finance finviz robinhood screener stocks

Last synced: about 2 months ago
JSON representation

Reliable algotrading utilities written in node

Host: GitHub
URL: https://github.com/nielse63/stonksjs
Owner: nielse63
License: isc
Created: 2020-04-04T06:08:01.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-11-11T12:24:44.000Z (about 1 year ago)
Last Synced: 2024-10-12T17:42:25.086Z (2 months ago)
Topics: dividends, finance, finviz, robinhood, screener, stocks
Language: TypeScript
Homepage: https://nielse63.github.io/stonksjs/
Size: 7.61 MB
Stars: 13
Watchers: 5
Forks: 4
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

# stonksjs

> Reliable algotrading utilities written in node

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nielse63/stonksjs?style=flat-square)

![CI Tests](https://github.com/nielse63/stonksjs/workflows/CI%20Tests/badge.svg)

![Coveralls github](https://img.shields.io/coveralls/github/nielse63/stonksjs?style=flat-square)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/nielse63/stonksjs?style=flat-square)

![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/nielse63/stonksjs?style=flat-square)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

- [Features](#features)

  - [Goals](#goals)

- [Usage](#usage)

- [Development](#development)

  - [Setup](#setup)

  - [Testing](#testing)

  - [Release](#release)

- [Contributing](#contributing)

- [Roadmap](#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](https://reddit.com/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](https://github.com/torreyleonard/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](https://github.com/nielse63/stonksjs/tree/main/packages/core)                     | Single point of entry for all stonksjs packages              | ![npm (scoped)](https://img.shields.io/npm/v/@stonksjs/core?color=brightgreen&style=flat-square)           |

| [@stonksjs/quote](https://github.com/nielse63/stonksjs/tree/main/packages/quote)                   | Detailed, real-time stock quote data                         | ![npm (scoped)](https://img.shields.io/npm/v/@stonksjs/quote?color=brightgreen&style=flat-square)          |

| [@stonksjs/finviz](https://github.com/nielse63/stonksjs/tree/main/packages/finviz)                 | Unofficial finviz API                                        | ![npm (scoped)](https://img.shields.io/npm/v/@stonksjs/finviz?color=brightgreen&style=flat-square)         |

| [@stonksjs/stock-screener](https://github.com/nielse63/stonksjs/tree/main/packages/stock-screener) | Pre-defined industry standard stock screeners from MSN Money | ![npm (scoped)](https://img.shields.io/npm/v/@stonksjs/stock-screener?color=brightgreen&style=flat-square) |

## Development

### Setup

#### Prerequisites

This project requires node `v16.20.1`.

#### Installation

Clone the repo and install the dependencies:

```bash

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:

```bash

npm test

# run with coverage

npm test -- --coverage

```

### Release

To release a new version, run:

```bash

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](https://github.com/nielse63/stonksjs/projects) and

[issues](https://github.com/nielse63/stonksjs/issues) tabs of this repo.