Skip to content

Maintains BNZ YouWealth fund transactions in a Sharesight portfolio.

License

Notifications You must be signed in to change notification settings

adrianparker/YouWealthSight

Repository files navigation

YouWealthSight

Maintain BNZ YouWealth managed fund transactions in a Sharesight portfolio.

Project status

Work in progress. As at July 2019 all this program does is retrieve the latest YouWealth fund prices.

BNZ API Key

You will need your own BNZ Fund Unit Prices API Key to use this application. As at July 2019, I use the API Key that BNZ make available in the public source of their website. (Visit https://www.bnz.co.nz and view source)

BNZ YouWealth Account ID

TODO

Sharesight Client ID and Client Secret

You will need to ask Sharesight to grant you API access. When they do so, they'll provide the values to use within your Account settings in Sharesight.

Installation

Ensure you have node installed. (v10.16.0 is the version app is developed against, but anything modern should be fine). Clone the repo to a local directory. Change into that directory. Use npm to install the application.

git clone https://github.com/adrianparker/YouWealthSight.git
cd YouWealthSight
npm install

Usage

There are currently two modes for the application.

The first is a simple 'what are the latest prices' check. For this you just need to supply the BNZ API key to use. For example:

./YouWealthSight.js -k BNZ_APIKEY

The second (work in progress, not yet functional) will record your BNZ YouWealth account transactions in Sharesight. For this you will need to supply the BNZ API key to use, as well as your BNZ YouWealth account and Sharesight account details. For example:

./YouWealthSight.js -k BNZ_APIKEY -a YOUWEALTH_ACCOUNT_ID -c SHARESIGHT_CLIENT_ID -s SHARESIGHT_CLIENT_SECRET

Tests

To execute tests you will need to pass the BNZ API key to use, via parameter --api_key. For example:

npm test -- --api_key=APIKEY

Or you can pass --api_key=APIKEY to Mocha as an argument.

Contributing

Fire in a pull request by all means. Please adhere to Javascript Standard Style: https://standardjs.com/rules.html

Disclosure & Disclaimer

This project is not endorsed nor supported in any way by Bank of New Zealand. You should not rely on the fitness nor accuracy of anything related to this project, for any purpose. Caveat emptor and all that.

About

Maintains BNZ YouWealth fund transactions in a Sharesight portfolio.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published