easy-equities

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

EasyEquities.js

A Node.js package for programatically interacting with Easy Equities. Currently, Easy Equities does not have a documented public API so a combination of scraping and calls to the Easy
Equities backend needs to be implemented in order to access account data programmatically. This package provides the functionality to do so.


Explore the docs »




View Demo
·
Report Bug
·
Request Feature

About The Project

Easy Equities is a low-cost investment platform available in South Africa. Many beginner and experienced investors use the platform because of its simple interface and low barrier to begin investing. However, Easy Equities has not made a documented API available to the public to access account data programatically. This Node.js implements a combination of web scraping and calls to the Easy Equities backend to enable developers to access their account data programatically.

With this package, you can implement automated balance checking, portfolio tracking, custom notification, backtesting, etc. Eventually many of these features will form part of the package but currently, the functionality exists for you to create these features on your own.

(back to top)

$3

* Node.js
* Axios
* Cheerio
* JQuery

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

$3

* Node v18.13.0

$3

1. Set up an account on Easy Equities and save your username and password.
2. Clone the repo
``sh
git clone https://github.com/Samuel-Sendzul/easy-equities.git
`
3. Install NPM packages
`sh
npm install --legacy-peer-deps
`

(back to top)

Usage

Here is an example of how to fetch all investment accounts associated with an Easy Equities account:


`javascript
var easyequities = require('easyequities')

async function getMyHoldings(username, password) {
// Login to EasyEquities. This will store the session token returned from EasyEquities in the auth module
const token = await easyequities.auth.login(username, password)

// Query holdings by account ID
const holdings = await easyequities.accounts.holdings()

console.log(holdings)

}

getMyHoldings("someUsername", "s3cr3tPassword")

`

(back to top)

Roadmap

- [ ] Make it possible to query accounts by name OR by account ID.
- [ ] Add features to track the historic value of a portfolio. This should be done through wallet snapshots daily.
- [ ] Add a feature to perform a simple backtest on a long-only portfolio strategy.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt` for more information.

(back to top)

Contact

Samuel Sendzul - @samuel_sendzul - samuel.sendzul@gmail.com

Project Link: https://github.com/Samuel-Sendzul/easy-equities

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/Samuel-Sendzul/easy-equities.svg?style=for-the-badge
[contributors-url]: https://github.com/Samuel-Sendzul/easy-equities/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Samuel-Sendzul/easy-equities.svg?style=for-the-badge
[forks-url]: https://github.com/Samuel-Sendzul/easy-equities/network/members
[stars-shield]: https://img.shields.io/github/stars/Samuel-Sendzul/easy-equities.svg?style=for-the-badge
[stars-url]: https://github.com/Samuel-Sendzul/easy-equities/stargazers
[issues-shield]: https://img.shields.io/github/issues/Samuel-Sendzul/easy-equities.svg?style=for-the-badge
[issues-url]: https://github.com/Samuel-Sendzul/easy-equities/issues
[license-shield]: https://img.shields.io/github/license/Samuel-Sendzul/easy-equities.svg?style=for-the-badge
[license-url]: https://github.com/Samuel-Sendzul/easy-equities/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/samuel-sendzul