mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
60da4bd7bf
AlphaVantage API Key is needed for all currency quotes and stock quotes with source 'alphavantage' or 'vanguard' or multi sources that include 'alphavantage'
243 lines
7.3 KiB
Plaintext
Executable File
243 lines
7.3 KiB
Plaintext
Executable File
#!@PERL@ -w
|
|
#
|
|
# Copyright (C) 2003, David Hampton <hampton@employees.org>
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
# 02110-1301, USA.
|
|
#
|
|
|
|
use strict;
|
|
|
|
sub check_modules {
|
|
my @modules = qw(Finance::Quote);
|
|
my @missing;
|
|
|
|
foreach my $mod (@modules) {
|
|
if (eval "require $mod") {
|
|
$mod->import();
|
|
}
|
|
else {
|
|
push (@missing, $mod);
|
|
}
|
|
}
|
|
|
|
return unless @missing;
|
|
|
|
print STDERR "$0 cannot find all the Perl modules needed to run.\n";
|
|
print STDERR "You need to install the following Perl modules:\n";
|
|
foreach my $mod (@missing) {
|
|
print STDERR " ".$mod."\n";
|
|
}
|
|
print STDERR "Use your system's package manager to install them,\n";
|
|
print STDERR "or run 'gnc-fq-update' as root.\n";
|
|
|
|
exit 1;
|
|
}
|
|
|
|
sub report {
|
|
my($itemname, $qh, $verbose) = @_;
|
|
my ($symbol, $date, $currency, $last, $nav, $price, $timezone, $keyname);
|
|
my($gccanuse, $gcshoulduse) = (1, 1);
|
|
|
|
# Sanity check returned results
|
|
if ((keys %$qh) < 1) {
|
|
printf("No results found for stock $itemname.\n");
|
|
return;
|
|
} else {
|
|
my ($stock, $attribute, %seen, $first);
|
|
|
|
foreach $keyname (sort keys %$qh) {
|
|
($stock, $attribute) = split('\034', $keyname);
|
|
last if $stock eq $itemname;
|
|
$first = $stock if !defined $first;
|
|
$seen{$stock} = 1;
|
|
}
|
|
|
|
if ($stock ne $itemname) {
|
|
printf "\nNo results found for stock $itemname, but results were returned for\n";
|
|
printf "the stock(s) %s. ", join(", ", keys(%seen));
|
|
printf "Printing data for the first stock returned.\n\n";
|
|
|
|
# Print stats for the first stock returned.
|
|
$itemname = $first;
|
|
}
|
|
}
|
|
|
|
# Parse the quote fields and put warnings where necessary.
|
|
if (defined($$qh{$itemname, "symbol"})) {
|
|
$symbol = $$qh{$itemname, "symbol"};
|
|
} else {
|
|
$symbol = "$itemname (deduced)";
|
|
$gccanuse = 0;
|
|
}
|
|
if (defined($$qh{$itemname, "date"})) {
|
|
$date = $$qh{$itemname, "date"};
|
|
} else {
|
|
$date = "** missing **";
|
|
$gcshoulduse = 0;
|
|
}
|
|
if (defined($$qh{$itemname, "currency"})) {
|
|
$currency = $$qh{$itemname, "currency"};
|
|
} else {
|
|
$currency = "** missing **";
|
|
$gccanuse = 0;
|
|
}
|
|
if ((!defined($$qh{$itemname, "last"})) &&
|
|
(!defined($$qh{$itemname, "nav" })) &&
|
|
(!defined($$qh{$itemname, "price"}))) {
|
|
$$qh{$itemname, "last"} = "**missing**";
|
|
$$qh{$itemname, "nav"} = "**missing**";
|
|
$$qh{$itemname, "price"} = "**missing**";
|
|
$gccanuse = 0;
|
|
}
|
|
$last = defined($$qh{$itemname, "last"})
|
|
? $$qh{$itemname, "last"} : "";
|
|
$nav = defined($$qh{$itemname, "nav"})
|
|
? $$qh{$itemname, "nav"} : "";
|
|
$price = defined($$qh{$itemname, "price"})
|
|
? $$qh{$itemname, "price"} : "";
|
|
$timezone = defined($$qh{$itemname, "timezone"})
|
|
? $$qh{$itemname, "timezone"} : "";
|
|
|
|
# Dump gnucash recognized fields
|
|
printf "Finance::Quote fields Gnucash uses:\n";
|
|
printf " symbol: %-20s <=== required\n", $symbol;
|
|
printf " date: %-20s <=== recommended\n", $date;
|
|
printf " currency: %-20s <=== required\n", $currency;
|
|
printf " last: %-20s <=\\ \n", $last;
|
|
printf " nav: %-20s <=== one of these\n", $nav;
|
|
printf " price: %-20s <=/ \n", $price;
|
|
printf " timezone: %-20s <=== optional\n", $timezone;
|
|
|
|
# Report failure
|
|
if ($gccanuse == 0) {
|
|
printf "\n** This stock quote cannot be used by GnuCash!\n\n";
|
|
} elsif ($gcshoulduse == 0) {
|
|
printf "\n** This quote will have today's date, which might be incorrect.\n";
|
|
printf " GnuCash will use it, but you might prefer that it doesn't.\n\n";
|
|
}
|
|
# Dump all fields if requested
|
|
if ($verbose) {
|
|
printf "\nAll fields returned by Finance::Quote for stock $itemname\n\n";
|
|
printf "%-10s %10s %s\n", "stock", "field", "value";
|
|
printf "%-10s %10s %s\n", "-----", "-----", "-----";
|
|
foreach $keyname (sort keys %$qh) {
|
|
my ($stock, $key) = split('\034', $keyname);
|
|
printf "%-10s %10s: %s\n", $stock, $key, $$qh{$stock, $key};
|
|
}
|
|
print "\n";
|
|
}
|
|
}
|
|
|
|
sub chk_api_key {
|
|
my $exch = $_[0];
|
|
my $url = " https://wiki.gnucash.org/wiki/Online_Quotes#Source_Alphavantage.2C_US\n";
|
|
if (($exch eq "currency") || ($exch eq "alphavantage")
|
|
|| ($exch eq "vanguard")) {
|
|
die "ERROR: ALPHAVANTAGE_API_KEY *must* be set for currency quotes and \n" .
|
|
" stock quotes with source 'alphavantage' or 'vanguard'; see\n" . $url
|
|
unless (defined ($ENV{'ALPHAVANTAGE_API_KEY'}));
|
|
}
|
|
if (($exch eq "canada") || ($exch eq "nasdaq")
|
|
|| ($exch eq "nyse") || ($exch eq "usa")) {
|
|
printf("WARNING: Multiple Source '%s' will not be able to use alphavantage " .
|
|
"unless ALPHAVANTAGE_API_KEY is set; see\n%s", $exch, $url)
|
|
unless (defined ($ENV{'ALPHAVANTAGE_API_KEY'}));
|
|
}
|
|
}
|
|
|
|
############## end of functions - start mainline #########################
|
|
|
|
# Check for and load non-standard modules
|
|
check_modules ();
|
|
|
|
my $q = Finance::Quote->new;
|
|
$q->timeout(60);
|
|
|
|
if ($#ARGV < 1) {
|
|
my @sources = $q->sources();
|
|
printf "\nUsage: $0 [-v] <quote-source> <stock> [<stock> ...]\n\n";
|
|
printf "-v: verbose\n";
|
|
printf "Available sources are: \n %s\n\n", join(' ', @sources);
|
|
exit 0;
|
|
}
|
|
|
|
my $verbose = 0;
|
|
if ($ARGV[0] eq "-v") {
|
|
$verbose = 1;
|
|
shift;
|
|
}
|
|
|
|
my $exchange = shift;
|
|
chk_api_key ($exchange);
|
|
if ($exchange eq "currency") {
|
|
my $from = shift;
|
|
while ($#ARGV >= 0) {
|
|
my $to = shift;
|
|
my $result = $q->currency($from, $to);
|
|
# Sometimes quotes are available in only one direction.
|
|
# If we didn't get the one we wanted try the reverse quote
|
|
unless (defined($result)) {
|
|
my $inv_res = $q->currency($to, $from);
|
|
if (defined($inv_res)) {
|
|
my $tmp = $to;
|
|
$to = $from;
|
|
$from = $tmp;
|
|
$result = $inv_res;
|
|
}
|
|
}
|
|
if (defined($result)) {
|
|
printf "1 $from = $result $to\n";
|
|
} else {
|
|
printf "1 $from = <unknown> $to\n";
|
|
}
|
|
}
|
|
} else {
|
|
while ($#ARGV >= 0) {
|
|
my $stock = shift;
|
|
my %quotes = $q->fetch($exchange, $stock);
|
|
report($stock, \%quotes, $verbose);
|
|
if ($#ARGV >= 0) {
|
|
printf "=====\n\n";
|
|
}
|
|
}
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
gnc-fq-dump - Print out data from the F::Q module
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
Currency Exchange Rates
|
|
gnc-fq-dump currency USD AUD
|
|
gnc-fq-dump [-v] yahoo_json USDEUR=X
|
|
Stock Quotes
|
|
gnc-fq-dump [-v] alphavantage CSCO JNPR
|
|
gnc-fq-dump [-v] alphavantage BAESY.PK
|
|
gnc-fq-dump [-v] yahoo_json CBA.AX
|
|
gnc-fq-dump [-v] europe 48406.PA 13000.PA
|
|
gnc-fq-dump [-v] vwd 632034
|
|
gnc-fq-dump [-v] ftportfolios FKYGTX
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This program obtains information from Finance::Quote about any
|
|
specified stock, and then dumps it to the screen in annotated form.
|
|
This will allow someone to see what is returned, and whether it
|
|
provides all the information needed by Gnucash.
|
|
|
|
=cut
|