Metadata-Version: 2.1
Name: cryptocompare
Version: 0.7.1
Summary: Wrapper for CryptoCompare.com
Home-page: https://github.com/lagerfeuer/cryptocompare
Author: lagerfeuer
Author-email: lukas.deutz@mailfence.com
License: MIT
Description: # cryptocompare ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/lagerfeuer/cryptocompare/Test/master) [![Coverage Status](https://coveralls.io/repos/github/lagerfeuer/cryptocompare/badge.svg?branch=master)](https://coveralls.io/github/lagerfeuer/cryptocompare?branch=master) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cryptocompare) [![PyPI version](https://badge.fury.io/py/cryptocompare.svg)](https://badge.fury.io/py/cryptocompare) [![Requirements Status](https://requires.io/github/lagerfeuer/cryptocompare/requirements.svg?branch=master)](https://requires.io/github/lagerfeuer/cryptocompare/requirements/?branch=master)
        
        
        Python3 wrapper to query cryptocurrency prices (and more) using the [CryptoCompare](https://min-api.cryptocompare.com/) API.
        
        
        ## Install
        ```sh
        pip3 install cryptocompare
        ```
        
        ## Usage
        
        ```python
        import cryptocompare
        ```
        
        ### Coin List
        
        ```python
        cryptocompare.get_coin_list(format=False)
        # ...
        # },
        # 'BTC': {
        #  'Id': '1182'
        #  'Url': '/coins/btc/overview'
        #  'ImageUrl': '/media/19633/btc.png'
        #  'Name': 'BTC'
        #  'CoinName': 'Bitcoin'
        #  'FullName': 'Bitcoin (BTC)'
        #  'Algorithm': 'SHA256'
        #  'ProofType': 'PoW'
        #  'FullyPremined': '0'
        #  'TotalCoinSupply': '21000000'
        #  'PreMinedValue': 'N/A'
        #  'TotalCoinsFreeFloat': 'N/A'
        #  'SortOrder': '1'
        # },
        # ...
        ```
        
        If `format` is `True`, the coin list is returned as Python list,
        containing only the abbreviations (like `BTC`).
        
        ### Price
        
        ```python
        cryptocompare.get_price('BTC')
        # or
        cryptocompare.get_price('BTC',curr='USD',full=True)
        # or
        cryptocompare.get_price(['BTC','ETH'],['EUR','GBP'])
        
        # {'BTC': {'EUR': 3709.04, 'GBP': 3354.78},
        #  'ETH': {'EUR': 258.1, 'GBP': 241.25}}
        ```
        
        ### Historical Prices
        
        ```python
        # pass either datetime or time instance
        cryptocompare.get_historical_price('XMR', timestamp=datetime.datetime(2017,6,6), exchange='CCCAGG')
        # or
        cryptocompare.get_historical_price('XMR', 'EUR', datetime.datetime(2017,6,6))
        
        # {'XMR': {'EUR': 43.05}}
        ```
        
        #### Day
        
        ```python
        cryptocompare.get_historical_price_day('BTC', curr='EUR')
        cryptocompare.get_historical_price_day('BTC', curr='EUR', limit=30)
        cryptocompare.get_historical_price_day('BTC', 'EUR', limit=24, exchange='CCCAGG', toTs=datetime.datetime(2019,6,6))
        # or
        cryptocompare.get_historical_price_day('BTC', 'EUR', limit=24, exchange='CCCAGG', toTs=datetime.datetime(1559815200))
        ```
        
        #### Hour
        
        ```python
        cryptocompare.get_historical_price_hour('BTC', curr='EUR')
        cryptocompare.get_historical_price_hour('BTC', curr='EUR', limit=24)
        cryptocompare.get_historical_price_hour('BTC', 'EUR', limit=24, exchange='CCCAGG')
        cryptocompare.get_historical_price_hour('BTC', 'EUR', limit=24, exchange='CCCAGG', toTs=datetime.datetime(2019,6,6,12))
        # or
        cryptocompare.get_historical_price_hour('BTC', 'EUR', limit=24, exchange='CCCAGG', toTs=datetime.datetime(1559815200))
        ```
        
        #### Minute
        
        ```python
        cryptocompare.get_historical_price_minute('BTC', curr='EUR')
        cryptocompare.get_historical_price_minute('BTC', curr='EUR', limit=1440)
        cryptocompare.get_historical_price_minute('BTC', 'EUR', limit=24, exchange='CCCAGG', toTs=datetime.datetime.now())
        ```
        
        ### Average
        
        ```python
        cryptocompare.get_avg('BTC', curr='EUR', exchange='Kraken')
        # {
        # 'MARKET': 'CUSTOMAGG',
        # 'FROMSYMBOL': 'BTC',
        # 'TOSYMBOL': 'EUR',
        # 'FLAGS': 0,
        # 'PRICE': 3610,
        # 'LASTUPDATE': 1503066719,
        # 'LASTVOLUME': 0.5,
        # 'LASTVOLUMETO': 1805,
        # 'LASTTRADEID': 1503066719.7584,
        # 'VOLUME24HOUR': 12614.509997469995,
        # 'VOLUME24HOURTO': 46397723.00499387,
        # 'OPEN24HOUR': 3847.9,
        # 'HIGH24HOUR': 3848.96,
        # 'LOW24HOUR': 3555,
        # 'LASTMARKET': 'Kraken',
        # 'CHANGE24HOUR': -237.9000000000001,
        # 'CHANGEPCT24HOUR': -6.182593102731363
        # }
        ```
        
        ### Exchanges
        
        ```python
        cryptocompare.get_exchanges()
        ```
        
        ### Pairs
        
        ```python
        cryptocompare.get_pairs()
        pairs = cryptocompare.get_pairs(exchange='Kraken')
        ```
        
        ## Developing
        
        Install the dev dependencies and run the tests:
        ```sh
        pip3 install -r requirements.txt
        python3 -m pytest
        ```
        
        ## Credit
        
        * The [CryptoCompare API](https://min-api.cryptocompare.com/).
        
        ## Disclaimer
        
        This is a hobby project, no guarantees.
        If you find bugs or want additional features,
        open an issue and/or create a pull request.
        
Keywords: crypto cryptocurrency wrapper cryptocompare
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
