NAME
Finance::Currency::Convert::KlikBCA - Convert currency using KlikBCA
VERSION
This document describes version 0.12 of Finance::Currency::Convert::KlikBCA (from Perl distribution Finance-Currency-Convert-KlikBCA), released on 2016-07-22.
SYNOPSIS
use Finance::Currency::Convert::KlikBCA qw(convert_currency);
printf "1 USD = Rp %.0f\n", convert_currency(1, 'USD', 'IDR');DESCRIPTION
FUNCTIONS
convert_currency($amount, $from, $to) => NUM
Currently can only handle conversion *to* IDR. Dies if given other currency.
Will warn if failed getting currencies from the webpage.
Currency rate is not cached (retrieved from the website every time). Employ your own caching.
Currently uses the Bank Notes rate.
Will return undef if no conversion rate is available for the requested currency.
Use get_currencies(), which actually retrieves and scrapes the source web page, if you need the more complete result.
convert_currency($n, $from, $to, $which) -> any
Convert currency using KlikBCA.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
$from* => str
$n* => float
$to* => str
$which => str (default: "avg_er")
Select which rate to use (default is average buy+sell for e-Rate).
{buy,sell,avg}_{bn,er,ttc}.
Return value: (any)
get_currencies() -> [status, msg, result, meta]
Extract data from KlikBCA/BCA page.
This function is not exported by default, but exportable.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Will return a hash containing key currencies.
The currencies is a hash with currency symbols as keys and prices as values.
Tha values is a hash with these keys: buy_bn and sell_bn (Bank Note buy/sell rates), buy_er and sell_er (e-Rate buy/sell rates), buy_ttc and sell_ttc (Telegraphic Transfer Counter buy/sell rates).
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Finance-Currency-Convert-KlikBCA.
SOURCE
Source repository is at https://github.com/perlancar/perl-Finance-Currency-Convert-KlikBCA.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Finance-Currency-Convert-KlikBCA
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.