prikhi / hledger-stockquotes Goto Github PK

This can just print the commodities that we would fetch from the API.

Default it to something like prices.journal if not passed as an argument.
Or something like <input-filename>.prices.journal

From @simonmichael:

I wondered how it would be to handle args like:

hledger-stockquotes [ COMM ... | not:COMM ... ]

where no args means all the commodities in the journal (except AUTO, for now); negative args (beginning with not:) excludes those commodities; positive args selects only those commodities; and a mix of positives and negatives is an error.

Currently, the start/end dates are based on the entry dates in the journal file. Start is the earliest entry's date, end is the last entry's date.

Add a new flag to set the start/end dates to the first day of the earliest year and the last day of the latest year, respectively.

Need some way to specify the cryptomarket & which currencies should hit this route instead of the stock route.

https://www.alphavantage.co/documentation/#currency-daily

After #4 we can specify some options via both CLI flags and Env Vars.

We should also support YAML configs for all CLI flags. Maybe at ~/.config/stockquotes/config.yml.

Hi @prikhi, thanks for this nice command. I'd like to list it with the other third-party addons (iadd, interest) and have hledger-install.sh install it. To make it more user ready, I'll file a few wishlist issues here if that's ok ?

Some examples, as complete and reproducible as possible, will be a big help for users getting started. I had some trouble getting it to work when run as hledger stockquotes; hledger-stockquotes is working better. My biggest question at the moment is which commodities can be fetched. Could you explain the failures below - unsupported commodities, wrong symbols, rate limit exceeded, flaky api, or... ?

~/src/hledger$ cat commodities.journal 
commodity USD 0.00
commodity EUR 0.00
commodity GBP 0.00

commodity AAPL 0.00
commodity TSLA 0.00

commodity ADA 0.000000
commodity BTC 0.00000000
commodity ETH 0.000000
~/src/hledger$ hledger-stockquotes -f commodities.journal -n
Error Fetching Symbol `ADA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `BTC`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `EUR`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `GBP`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"

I tried it again respecting the rate limit (pretty slow!). This time it fetched TSLA:

~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `GBP`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Waiting 60 seconds to respect API rate limits.
Error Fetching Symbol `ADA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `BTC`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `EUR`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"

I commented out all but AAPL and TSLA and saw intermittent failures:

~/src/hledger$ hledger-stockquotes -f commodities.journal 
~/src/hledger$ hledger-stockquotes -f commodities.journal 
~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `AAPL`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `AAPL`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `AAPL`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
~/src/hledger$ hledger-stockquotes -f commodities.journal 
Error Fetching Symbol `AAPL`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
Error Fetching Symbol `TSLA`: JsonHttpException "Error in $: key \"Time Series (Daily)\" not found"
~/src/hledger$ hledger-stockquotes -f commodities.journal 
~/src/hledger$ hledger-stockquotes -f commodities.journal 

Is their rate limiting really strict, is yours not entirely effective, or is it not a rate limit issue ? Might there be more error details that could be reported ?

From @simonmichael:

Some way to alias commodity symbols, since we don't all use the standard ticker symbols.

Maybe for when the config file is done(#6):

commodity-aliases:
  <journal-commodity>: <ticker-symbol>

E.g.,:

commodity-aliases:
  RETIRE: VFFVX

#14 added aliases to the config file, we should also figure out a format for passing them in as CLI options & through environmental variables.

Maybe allow multiple CLI flags like --some-flag JOURNAL_CURRENCY:ALPHAVANTAGE_TICKER to assemble the list, maybe a similar alias format deliminated with semicolons for the env var like SOME_VAR="JCUR1:ATICKER1;JCUR2:ATICKER2"

After implementing #10, we could pull the USD->Target exchange rates per-day & convert all prices into any FOREX-support currency.

Instead of a binary on/off value for limiting the API requests, replace the -n flag with a flag that lets you set the requests per minute(with a default value of 5).

Add an optional argument list to the CLI options, allowing users to pass a list of currencies the program should not hit the API for.

Support reading of the LEDGER_FILE env var for the input file, and an ALPHAVANTAGE_KEY var for the API key.

Support reading a config file at ~/.config/stockquotes/config.yml or something for specifying the default values.

Support appending only new prices to a file, instead of overwriting the entire file.

We'll need some way to denote that a currency should hit the FX route instead of the stock route(add flag, implement config file?).

https://www.alphavantage.co/documentation/#fx-daily