mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 21:42:22 +00:00

Files

jmaslek 4fe45fae1a Merge pull request #318 from jmaslek/crypto_test

Add docstring to crypto + add test

2021-04-09 09:23:02 -04:00

__init__.py

2021-03-26 14:32:01 -04:00

coin_api.py

rename vars

2021-04-07 10:47:42 -04:00

crypto_controller.py

2021-04-07 01:35:53 +01:00

crypto_helper.py

2021-04-08 08:40:21 -04:00

README.md

2021-03-30 11:24:51 -04:00

Cryptocurrency

This page gives an overview of the ability to load cryptocurrency data.

Current crypto data is Powered by CoinGecko API.
This is an awesome service that currently requires no API Key!

Current functionality is aimed to be similar to loading a stock ticker.

load

Load a given coin vs a given currency:

usage: load [-c --coin] [-d --days] [--vs]

-c/--coin The coin you wish to load. This can either be the symbol or the name. load -c btc and load -c bitcoin will load. The -c flag is optional, the above is equivalent to load btc.
-d/--days The number of days to look. Defaults to 30 days. As per the API: Minutely data will be used for duration within 1 day, Hourly data will be used for duration between 1 day and 90 days, Daily data will be used for duration above 90 days.
--vs The currency to look against. Defaults to "usd".

Currently only retrieves price, not volume or MarketCap.

Example doge/eur for the past day:

load -c doge -d 1 --vs eur

Plot the loaded crypto data.

usage: view

After loading the above 1 day dogecoin/eur. Running view plots the data: