Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python API wrapper and scraper for coinmarketcappy data

Project description

https://img.shields.io/badge/Made%20with-Python-1f425f.svg https://img.shields.io/pypi/v/coinmarketcappy.svg https://img.shields.io/pypi/l/coinmarketcappy.svg https://img.shields.io/pypi/pyversions/coinmarketcappy.svg

Installation

To install coinmarketcappy, simply use pip:

$ pip install coinmarketcappy

or install directly from source to include latest changes:

$ pip install git+https://github.com/saporitigianni/coinmarketcappy.git

or clone and then install:

$ git clone https://github.com/saporitigianni/coinmarketcappy.git
$ cd coinmarketcappy
$ python3 setup.py install

Usage

Every method supports the arguments ‘out_file’ and ‘wformat’ to save the information to a file. If ‘out_file’ is present then the info will be saved to that file. Use absolute path unless you want to save locally. If ‘wformat’ is not specified, it will default to ‘json’ (‘csv’ also supported)

All methods except for available_snaps and historical_snapshots also support the ‘epoch’ parameter. If True it will return all times as epochs, if False it will return them as date and time (e.g. ‘2018-05-01 00:19:31’)

To get Historical Snapshots (taken every Sunday since 20130428) or Global Charts data:

import coinmarketcappy as cmc

# Get all available historical snapshots to choose from
# or visit https://coinmarketcap.com/historical/
dates = cmc.available_snaps()

# Retrieve info for the last 10 snapshots
snaps = cmc.historical_snapshots(dates[-10:])

# Percentage of Market Capitalization (Dominance)
dom = cmc.dominance()

# Total Market Capitalization
cap = cmc.total_market_cap()

# Total Market Capitalization (Excluding Bitcoin)
cap = cmc.total_market_cap(exclude_btc=True)

To get tickers and simple global data:

import coinmarketcappy as cmc

# Get a list of all tickers organized by rank
tickers = cmc.get_tickers()

# Get a specific ticker (by its name not symbol. e.g. bitcoin, ethereum,... not btc, eth)
ticker = cmc.get_ticker(name='bitcoin')

# Get ticker's historical data (also by its name)
temp = cmc.get_ticker_historical(name='bitcoin')

# Get global data in ERU
glob = cmc.get_global_data(convert='eur')

Acknowledgements

This data is being sourced either from the coinmarketcap API or is being scraped from coinmarketcap.com. Its free to use so please respect their rate limit. :octocat:

Contributing

Please read the CONTRIBUTING document before making changes that you would like adopted in the code.

Code of Conduct

Everyone interacting in the coinmarketcappy project’s codebase, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

Buy me a coffee?

ETH 0xaD1F09626b9B8e701D5f0F4a237193Df73d3C445
BTC 199zsVqCusefv8yjdYQhUQZmLCyh75dqNV
LTC LUBqs7VxC43ttPsQuM1jaZFmshKTAU1Rs9

Project details


Download files

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

Files for coinmarketcappy, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size coinmarketcappy-1.2.0.tar.gz (10.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page