.. --restructuredtext--
cryptoCMD: cryptoCurrency Market Data
.. image:: https://img.shields.io/pypi/v/cryptoCMD.svg
:target: https://pypi.python.org/pypi/cryptoCMD
.. image:: https://github.com/guptarohit/cryptoCMD/actions/workflows/ci.yml/badge.svg
:target: https://github.com/guptarohit/cryptoCMD/actions/workflows/ci.yml
.. image:: https://img.shields.io/pypi/l/cryptoCMD.svg
:target: https://github.com/guptarohit/cryptoCMD/blob/master/LICENSE
.. image:: https://pepy.tech/badge/cryptoCMD
:target: https://pepy.tech/project/cryptoCMD
:alt: Downloads
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Code style: black
.. image:: https://img.shields.io/github/sponsors/guptarohit?color=%23FF5733
:target: https://github.com/sponsors/guptarohit
:alt: GitHub Sponsors
Cryptocurrency historical market price data scraper written in Python.
Installation
::
$ pip install cryptocmd
to install from the latest source use following command
::
$ pip install git+git://github.com/guptarohit/cryptoCMD.git
Usage
=====================
CoinMarketCap Scraper
Following methods are available to get data in multiple formats from https://coinmarketcap.com
To get all time historical data of a cryptocurrency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
from cryptocmd import CmcScraper
# initialise scraper without time interval
scraper = CmcScraper("XRP")
# get raw data as list of list
headers, data = scraper.get_data()
# get data in a json format
xrp_json_data = scraper.get_data("json")
# export the data as csv file, you can also pass optional `name` parameter
scraper.export("csv", name="xrp_all_time")
# Pandas dataFrame for the same data
df = scraper.get_dataframe()
To get data of a cryptocurrency which have same coin code as others
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
from cryptocmd import CmcScraper
# initialise scraper with coin name as well
scraper = CmcScraper(coin_code="sol", coin_name="solana")
# get raw data as list of list
headers, data = scraper.get_data()
# get data in a json format
solana_json_data = scraper.get_data("json")
# export the data as csv file, you can also pass optional `name` parameter
scraper.export("csv", name="solana_all_time")
# Pandas dataFrame for the same data
df = scraper.get_dataframe()
To get data of a cryptocurrency for some days
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
from cryptocmd import CmcScraper
# initialise scraper with time interval
scraper = CmcScraper("XRP", "15-10-2017", "25-10-2017")
# get raw data as list of list
headers, data = scraper.get_data()
# get data in a json format
json_data = scraper.get_data("json")
# export the data to csv
scraper.export("csv")
# get dataframe for the data
df = scraper.get_dataframe()
Following are the columns of the data
"""""""""""""""""""""""""""""""""""""
Date, Open, High, Low, Close, Volume, Market Cap, Time Open, Time High, Time Low, Time Close
Acknowledgements
The data is being scrapped from coinmarketcap <https://coinmarketcap.com>
_ :v: and it's free <https://coinmarketcap.com/faq/>
_ to use. :tada:
Contributing
Feel free to make a pull request! :octocat:
If you found this useful, I'd appreciate your consideration in the below. ✨☕
.. image:: https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=rohitgupta&button_colour=5F7FFF&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00
:target: https://www.buymeacoffee.com/rohitgupta
:alt: Buy Me A Coffee