{"id":16529022,"url":"https://github.com/nielse63/stonksjs","last_synced_at":"2025-03-21T09:31:39.950Z","repository":{"id":40288077,"uuid":"252923138","full_name":"nielse63/stonksjs","owner":"nielse63","description":"Reliable algotrading utilities written in node","archived":false,"fork":false,"pushed_at":"2023-11-11T12:24:44.000Z","size":7984,"stargazers_count":15,"open_issues_count":7,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-01T04:51:12.386Z","etag":null,"topics":["dividends","finance","finviz","robinhood","screener","stocks"],"latest_commit_sha":null,"homepage":"https://nielse63.github.io/stonksjs/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nielse63.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-04T06:08:01.000Z","updated_at":"2025-02-23T14:10:16.000Z","dependencies_parsed_at":"2024-06-19T17:38:56.697Z","dependency_job_id":"2edce28a-b982-4989-8ed3-f511081697b9","html_url":"https://github.com/nielse63/stonksjs","commit_stats":{"total_commits":209,"total_committers":4,"mean_commits":52.25,"dds":"0.22488038277511957","last_synced_commit":"faa2fc991ec9652d0de30c4fe9b8e6b63dbcb9d3"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nielse63%2Fstonksjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nielse63%2Fstonksjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nielse63%2Fstonksjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nielse63%2Fstonksjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nielse63","download_url":"https://codeload.github.com/nielse63/stonksjs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244130278,"owners_count":20402753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dividends","finance","finviz","robinhood","screener","stocks"],"created_at":"2024-10-11T17:42:48.740Z","updated_at":"2025-03-21T09:31:39.573Z","avatar_url":"https://github.com/nielse63.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://raw.githubusercontent.com/nielse63/stonksjs/main/docs/assets/logo.svg\" align=\"right\" width=\"100\" /\u003e\n\n# stonksjs\n\n\u003e Reliable algotrading utilities written in node\n\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nielse63/stonksjs?style=flat-square)\n![CI Tests](https://github.com/nielse63/stonksjs/workflows/CI%20Tests/badge.svg)\n![Coveralls github](https://img.shields.io/coveralls/github/nielse63/stonksjs?style=flat-square)\n![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/nielse63/stonksjs?style=flat-square)\n![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/nielse63/stonksjs?style=flat-square)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\n- [Features](#features)\n  - [Goals](#goals)\n- [Usage](#usage)\n- [Development](#development)\n  - [Setup](#setup)\n  - [Testing](#testing)\n  - [Release](#release)\n- [Contributing](#contributing)\n- [Roadmap](#roadmap)\n\n## Features\n\n- Custom screeners from finviz, msn, and finscreener\n- Detailed ticker fundamentals\n- Module and CommonJS compatible\n- Light-weight - few to no dependencies\n\n### Goals\n\n**What stonksjs is:**\n\nThe primary objective of this project are:\n\n- To provide a collection of reliable algotrading utilities written in\n  typescript/node\n- Take some of the guess-work out of the stock research process by using\n  industry-tested, predefined screeners\n- Provide more data-points for a given instrument than most packages currently\n  available\n- Enable algotrading programmers with diversified assets - not just the hottest\n  options rumors on [r/wallstreetbets](https://reddit.com/r/wallstreetbets)\n\n**What stonksjs is not:**\n\n- stonksjs **is not** a roboadvisor or professional trading app - this is just a\n  fun little side project\n- stonksjs **is not** an unofficial API for Robinhood or any other brokerage. If\n  that's what you're looking for, I'd recommend\n  [algotrader](https://github.com/torreyleonard/algotrader)\n- stonksjs **is not** a backtesting tool, although that might get added to the\n  roadmap soon\n\n## Usage\n\nInstallation, usage, and API docs can be found in each scoped package directory.\n\n| Name                                                                                               | Description                                                  | Version                                                                                                    |\n| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |\n| [@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\u0026style=flat-square)           |\n| [@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\u0026style=flat-square)          |\n| [@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\u0026style=flat-square)         |\n| [@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\u0026style=flat-square) |\n\n## Development\n\n### Setup\n\n#### Prerequisites\n\nThis project requires node `v16.20.1`.\n\n#### Installation\n\nClone the repo and install the dependencies:\n\n```bash\ngit clone http://github.com/nielse63/stonksjs.git\ncd stonksjs\nnvm use\nnpm ci\n```\n\n### Testing\n\nTests are run using `jest`, and can be run by executing:\n\n```bash\nnpm test\n\n# run with coverage\nnpm test -- --coverage\n```\n\n### Release\n\nTo release a new version, run:\n\n```bash\nnpm run release\n```\n\nThis executes `lerna publish` behind the scenes, and you'll be prompted with a\nfew questions before the package is deployed.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## Roadmap\n\nAll new features and changes are being tracked in GitHub under the\n[projects](https://github.com/nielse63/stonksjs/projects) and\n[issues](https://github.com/nielse63/stonksjs/issues) tabs of this repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnielse63%2Fstonksjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnielse63%2Fstonksjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnielse63%2Fstonksjs/lists"}