Skip to main content

Wrapper for CryptoCompare.com

Project description

Python3 Wrapper to query cryptocurrency prices (and more) using the CryptoCompare API.

Installation

sudo pip3 install cryptocompare

Usage

Import

import cryptocompare

Methods

Coin List

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.

Price

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 Price

# pass either datetime or time instance
cryptocompare.get_historical_price('XMR', timestamp=datetime.datetime(2017,6,6))
# or
cryptocompare.get_historical_price('XMR', 'EUR', datetime.datetime(2017,6,6))

# {'XMR': {'EUR': 43.05}}

Day

cryptocompare.get_historical_price_day('BTC', curr='EUR')

Hour

cryptocompare.get_historical_price_hour('BTC', curr='EUR')

Average

cryptocompare.get_avg('BTC', 'EUR', '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

cryptocompare.get_exchanges()

Credit

Thanks to CryptoCompare for providing this service and building a community around everything crypto related.

Tipjar

If you like this and/or use it in a project, show some love:

BTC: 1JJMk3QmcyTjPsvFpKUhgvPNd3KcWCKc86

ETH: 0xe3c951a953f56d0ec88800386281e88ea9bef630

…or head over to https://www.cryptocompare.com and tip CryptoCompare.

Disclaimer

This is a hobby project, no guarantees. If you find bugs, open an issue. If you want additional features, open an issue or create a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cryptocompare-0.6.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file cryptocompare-0.6.tar.gz.

File metadata

  • Download URL: cryptocompare-0.6.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for cryptocompare-0.6.tar.gz
Algorithm Hash digest
SHA256 18b7fccd0b74193d6d75fb129029185f8b3a6d51631edb833202212889022142
MD5 2c939af35a9adc4c99176f1e605d40d2
BLAKE2b-256 9e4ba4ca2d0ec643651d88e199d600fc462e85c2980dd2ad75f51fb5296506e1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page