NAME

CryptoCurrency::Catalog - Catalog of cryptocurrencies

VERSION

This document describes version 20180308.1.0 of CryptoCurrency::Catalog (from Perl distribution CryptoCurrency-Catalog), released on 2018-03-08.

SYNOPSIS

 use CryptoCurrency::Catalog;

 my $cat = CryptoCurrency::Catalog->new;

 my $record = $cat->by_code("ETH");          # => { code=>"ETH", name=>"Ethereum", safename=>"ethereum" }
 my $record = $cat->by_ticker("eth");        # alias for by_code(), lowercase also works
 my $record = $cat->by_name("Ethereum");     # note: case-sensitive
 my $record = $cat->by_safename("ethereum");
 my $record = $cat->by_slug("Ethereum");     # alias for by_safename(), mixed case also works

 my @codes = $cat->all_codes(); # => ("BTC", "ETH", ...)

 my @data = $cat->all_data; # => ({code=>"BTC", name=>"Bitcoin", safename=>"bitcoin"}, {...}, ...)

DESCRIPTION

This class attempts to provide a list/catalog of cryptocurrencies. The main source for this catalog is the Cryptocurrency Market Capitalizations website (https://coinmarketcap.com/, or CMC for short).

CMC does not provide unique codes nor unique names, only unique "safenames" (slugs). Whenever there is a clash, this catalog modifies the clashing code and/or unique name to make code and name to be unique again (usually the coin/token with the smaller market cap "loses" the name).

There is no guarantee that the code/name/safename of old/unlisted coins or tokens will not be reused.

METHODS

new

by_code

by_ticker

Alias for "by_code".

by_name

by_safename

by_slug

Alias for "by_safename".

all_codes

all_data

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/CryptoCurrency-Catalog.

SOURCE

Source repository is at https://github.com/perlancar/perl-CryptoCurrency-Catalog.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=CryptoCurrency-Catalog

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

CryptoExchange::Catalog

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.

cpanm CryptoCurrency::Catalog

perl -MCPAN -e shell
install CryptoCurrency::Catalog