.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Finance::Quote::CurrencyRates::OpenExchange 3pm" .TH Finance::Quote::CurrencyRates::OpenExchange 3pm "2021-03-19" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Finance::Quote::CurrencyRates::OpenExchange \- Obtain currency rates from https://openexchangerates.org .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Finance::Quote; \& \& $q = Finance::Quote\->new(currency_rates => {order => [\*(AqOpenExchange\*(Aq], \& openexchange => {API_KEY => ...}}); \& \& $value = $q\->currency(\*(Aq18.99 EUR\*(Aq, \*(AqUSD\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module fetches currency rates from https://openexchangerates.org and provides data to Finance::Quote to convert the first argument to the equivalent value in the currency indicated by the second argument. .PP This module caches the currency rates for the lifetime of the quoter object, unless 'cache => 0' is included in the 'openexchange' options hash. .SH "API_KEY" .IX Header "API_KEY" https://openexchangerates.org requires users to register and obtain an \s-1API\s0 key. .PP The \s-1API\s0 key must be set by providing a 'openexchange' hash inside the \&'currency_rates' hash to Finance::Quote\->new as in the above example. .SH "Terms & Conditions" .IX Header "Terms & Conditions" Use of https://openexchangerates.org is governed by any terms & conditions of that site. .PP Finance::Quote is released under the \s-1GNU\s0 General Public License, version 2, which explicitly carries a \*(L"No Warranty\*(R" clause.