cryptocmd


Namecryptocmd JSON
Version 0.6.4 PyPI version JSON
download
home_pagehttps://github.com/guptarohit/cryptoCMD
SummaryCryptocurrency historical market price data scrapper.
upload_time2023-10-13 19:36:34
maintainer
docs_urlNone
authorRohit Gupta
requires_python>=3.7,<4.0
licenseBSD-3-Clause
keywords cryptocurrency cryptocurrency historical data coinmarketcap dataset historical cryptocurrency prices
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. -*-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


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/guptarohit/cryptoCMD",
    "name": "cryptocmd",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "cryptocurrency,cryptocurrency historical data,coinmarketcap,dataset,historical cryptocurrency prices",
    "author": "Rohit Gupta",
    "author_email": "rohitgtech+git@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/94/03/9ec9c6184920626060ea91f75fd88e60946d25c6eb6968443d70905a48ff/cryptocmd-0.6.4.tar.gz",
    "platform": null,
    "description": ".. -*-restructuredtext-*-\n\ncryptoCMD: cryptoCurrency Market Data\n======================================\n\n.. image:: https://img.shields.io/pypi/v/cryptoCMD.svg\n    :target: https://pypi.python.org/pypi/cryptoCMD\n\n.. image:: https://github.com/guptarohit/cryptoCMD/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/guptarohit/cryptoCMD/actions/workflows/ci.yml\n\n.. image:: https://img.shields.io/pypi/l/cryptoCMD.svg\n    :target: https://github.com/guptarohit/cryptoCMD/blob/master/LICENSE\n\n.. image:: https://pepy.tech/badge/cryptoCMD\n    :target: https://pepy.tech/project/cryptoCMD\n    :alt: Downloads\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/ambv/black\n    :alt: Code style: black\n\n.. image:: https://img.shields.io/github/sponsors/guptarohit?color=%23FF5733\n    :target: https://github.com/sponsors/guptarohit\n    :alt: GitHub Sponsors\n\nCryptocurrency historical market price data scraper written in Python.\n\n\nInstallation\n------------\n\n::\n\n    $ pip install cryptocmd\n\nto install from the latest source use following command\n\n::\n\n    $ pip install git+git://github.com/guptarohit/cryptoCMD.git\n\n\nUsage\n------\n=====================\nCoinMarketCap Scraper\n=====================\n\nFollowing methods are available to get data in multiple formats from https://coinmarketcap.com\n\nTo get all time historical data of a cryptocurrency\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n    from cryptocmd import CmcScraper\n\n    # initialise scraper without time interval\n    scraper = CmcScraper(\"XRP\")\n\n    # get raw data as list of list\n    headers, data = scraper.get_data()\n\n    # get data in a json format\n    xrp_json_data = scraper.get_data(\"json\")\n\n    # export the data as csv file, you can also pass optional `name` parameter\n    scraper.export(\"csv\", name=\"xrp_all_time\")\n\n    # Pandas dataFrame for the same data\n    df = scraper.get_dataframe()\n\nTo get data of a cryptocurrency which have same coin code as others\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n    from cryptocmd import CmcScraper\n\n    # initialise scraper with coin name as well\n    scraper = CmcScraper(coin_code=\"sol\", coin_name=\"solana\")\n\n    # get raw data as list of list\n    headers, data = scraper.get_data()\n\n    # get data in a json format\n    solana_json_data = scraper.get_data(\"json\")\n\n    # export the data as csv file, you can also pass optional `name` parameter\n    scraper.export(\"csv\", name=\"solana_all_time\")\n\n    # Pandas dataFrame for the same data\n    df = scraper.get_dataframe()\n\nTo get data of a cryptocurrency for some days\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n    from cryptocmd import CmcScraper\n\n    # initialise scraper with time interval\n    scraper = CmcScraper(\"XRP\", \"15-10-2017\", \"25-10-2017\")\n\n    # get raw data as list of list\n    headers, data = scraper.get_data()\n\n    # get data in a json format\n    json_data = scraper.get_data(\"json\")\n\n    # export the data to csv\n    scraper.export(\"csv\")\n\n    # get dataframe for the data\n    df = scraper.get_dataframe()\n\n\nFollowing are the columns of the data\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n``Date, Open, High, Low, Close, Volume, Market Cap, Time Open, Time High, Time Low, Time Close``\n\n\nAcknowledgements\n----------------\nThe data is being scrapped from `coinmarketcap <https://coinmarketcap.com>`_ :v: and it's `free <https://coinmarketcap.com/faq/>`_ to use. :tada:\n\n\nContributing\n------------\n\nFeel free to make a pull request! :octocat:\n\nIf you found this useful, I'd appreciate your consideration in the below. \u2728\u2615\n\n.. 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\n    :target: https://www.buymeacoffee.com/rohitgupta\n    :alt: Buy Me A Coffee\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Cryptocurrency historical market price data scrapper.",
    "version": "0.6.4",
    "project_urls": {
        "Homepage": "https://github.com/guptarohit/cryptoCMD",
        "Repository": "https://github.com/guptarohit/cryptoCMD"
    },
    "split_keywords": [
        "cryptocurrency",
        "cryptocurrency historical data",
        "coinmarketcap",
        "dataset",
        "historical cryptocurrency prices"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d660ecf5636cd124e089033cede8d39d4ef842f5445ddf4ead19d49f5757be74",
                "md5": "6f917658b6d80864112d66c0015fdc89",
                "sha256": "f0608b3404f49de91a3b0f78e57d0f603102acc77ef12d8e6bb298948eabda60"
            },
            "downloads": -1,
            "filename": "cryptocmd-0.6.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f917658b6d80864112d66c0015fdc89",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 9141,
            "upload_time": "2023-10-13T19:36:33",
            "upload_time_iso_8601": "2023-10-13T19:36:33.275087Z",
            "url": "https://files.pythonhosted.org/packages/d6/60/ecf5636cd124e089033cede8d39d4ef842f5445ddf4ead19d49f5757be74/cryptocmd-0.6.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94039ec9c6184920626060ea91f75fd88e60946d25c6eb6968443d70905a48ff",
                "md5": "3a7cde09cc9a5377811d55bb11d0d07a",
                "sha256": "9c3e91914a40b8f654d7e3c2f7ca2ec187f2678689d57696b93fad3c5382ba87"
            },
            "downloads": -1,
            "filename": "cryptocmd-0.6.4.tar.gz",
            "has_sig": false,
            "md5_digest": "3a7cde09cc9a5377811d55bb11d0d07a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 6984,
            "upload_time": "2023-10-13T19:36:34",
            "upload_time_iso_8601": "2023-10-13T19:36:34.921657Z",
            "url": "https://files.pythonhosted.org/packages/94/03/9ec9c6184920626060ea91f75fd88e60946d25c6eb6968443d70905a48ff/cryptocmd-0.6.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-13 19:36:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "guptarohit",
    "github_project": "cryptoCMD",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cryptocmd"
}
        
Elapsed time: 0.22075s