App::CryptoCurrencyUtils - CLI utilities related to cryptocurrencies
This document describes version 0.011 of App::CryptoCurrencyUtils (from Perl distribution App-CryptoCurrencyUtils), released on 2018-03-08.
This distribution contains the following CLI utilities:
coin-cmc-summary
global-cmc-summary
grep-coin
grep-exchange
list-cmc-coins
list-coins
list-exchanges
open-coin-cmc
open-coin-mno
open-exchange-cmc
Usage:
coin_cmc_summary(%args) -> [status, msg, result, meta]
Get coin's CMC (coinmarketcap.com) summary.
Currently retrieves https://api.coinmarketcap.com/v1/ticker/<coin-id>/ and return the data in a table.
If no coins are specified, will return global data.
This function is not exported.
Arguments ('*' denotes required arguments):
coins => array[cryptocurrency::code_or_name]
convert => str
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)
global_cmc_summary(%args) -> [status, msg, result, meta]
Get global CMC (coinmarketcap.com) summary.
Currently retrieves https://api.coinmarketcap.com/v1/ticker/<coin-id>/ and
list_cmc_coins() -> [status, msg, result, meta]
List of all coins listed on coinmarketcap.com (CMC) along with their marketcaps, ranks, etc.
This utility basically parses https://coinmarketcap.com/all/views/all/ into table data.
No arguments.
list_coins(%args) -> [status, msg, result, meta]
List cryptocurrency coins.
This utility lists coins from CryptoCurrency::Catalog, which in turn gets its list from https://coinmarketcap.com/.
codes => true
Only list codes.
names => true
Only list names.
safenames => true
Only list safenames.
list_exchanges() -> [status, msg, result, meta]
List cryptocurrency exchanges.
This utility lists cryptocurrency exchanges from CryptoExchange::Catalog, which in turn gets its list from https://coinmarketcap.com/.
open_coin_cmc(%args) -> [status, msg, result, meta]
Open coin's CMC (coinmarketcap.com) currency page in the browser.
coins* => array[cryptocurrency::code_or_name]
open_coin_mno(%args) -> [status, msg, result, meta]
Open coin's MNO (masternodes.online) currency page in the browser.
Currently does not perform any translation between CMC -> MNO currency code if there is a difference.
open_exchange_cmc(%args) -> [status, msg, result, meta]
Open exchange's CMC (coinmarketcap.com) exchange page in the browser.
exchanges* => array[cryptoexchange::name]
Please visit the project's homepage at https://metacpan.org/release/App-CryptoCurrencyUtils.
Source repository is at https://github.com/perlancar/perl-App-CryptoCurrencyUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-CryptoCurrencyUtils
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2018 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.
To install App::CryptoCurrencyUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::CryptoCurrencyUtils
CPAN shell
perl -MCPAN -e shell install App::CryptoCurrencyUtils
For more information on module installation, please visit the detailed CPAN module installation guide.