Skip to content

Commit

Permalink
Give instructions for AlphaVantage use
Browse files Browse the repository at this point in the history
I may move to a different API eventually, but for now it's worth
documenting how this works.
  • Loading branch information
DavidCain committed Jan 6, 2024
1 parent 6c75d76 commit f4d9717
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ With that information supplied, the tool will:
contribution amount has been fully allocated to all funds)
5. Output the optimal contributions

## Fetching quotes from 3rd party APIs
I'm using the AlphaVantage free API. To use it, make sure that:

1. `ALPHAVANTAGE_API_KEY` is an available env var. ([Get an API key][av-api-key] first)
2. `update_prices = true` is set in `[gnucash]` within `config.toml`

When configured, this ensures that the latest stock prices per fund
are incorporated into the allocation recommendations.


# Background - target asset allocation
[Asset allocation][asset_allocation] is the process of reconciling one's risk
Expand Down Expand Up @@ -187,6 +196,7 @@ This project is very much a work in progress. Some key outstanding tasks:
[lazy_portfolio]: https://www.bogleheads.org/wiki/Lazy_portfolios#Three_fund_lazy_portfolios
[tax_loss_harvesting]: https://www.bogleheads.org/wiki/Tax_loss_harvesting
[tax_efficient_placement]: https://www.bogleheads.org/wiki/Tax-efficient_fund_placement
[av-api-key]: https://www.alphavantage.co/support/#api-key


[img-gnucash-interface]: https://github.com/DavidCain/stay-the-course/blob/master/images/gnucash_interface.png

0 comments on commit f4d9717

Please sign in to comment.