zhoudaqing / CBBI

πŸ“Š The official Python implementation of the ColinTalksCrypto Bitcoin Bull Run Index (CBBI)

Home Page:https://cbbi.info

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ColinTalksCrypto Bitcoin Bull Run Index (CBBI)

The official Python implementation of the ColinTalksCrypto Bitcoin Bull Run Index (CBBI).

The CBBI is a Bitcoin index that utilizes advanced, real-time analysis of 11 metrics to help us understand what stage of the Bitcoin bull run and bear market cycles we are in. The CBBI is time-independent and price-independent. It simply indicates whether it believes we are approaching the top/bottom of a Bitcoin cycle.

If you want to learn more, watch this video.

Visit our website

Bookmark it to receive latest CBBI updates.

Check out this demo

asciicast

Usage

Recommended Python version: 3.9

Install pipenv

Pipenv: Python Dev Workflow for Humans

Install required packages

NOTE: The pipenv commands shall be executed within the project directory.

$ pipenv install

Execute the script

$ pipenv run python main.py --help
$ pipenv run python main.py

or

$ pipenv shell
$> python main.py --help
$> python main.py

Metrics

The current CBBI version (November 2021) includes the following metrics:

Name Link
Pi Cycle Top Indicator Visit page
RUPL/NUPL Chart Visit page
RHODL Ratio Visit page
Puell Multiple Visit page
2 Year Moving Average Visit page
Bitcoin Trolololo Trend Line Visit page
MVRV Z-Score Visit page
Reserve Risk Visit page
Woobull Top Cap vs CVDD Visit page
Halving-to-Peak Days Visit page
Google Trends for "Bitcoin" Visit page

Environment variables

This project supports .env files which provide a convenient way of setting environment variables.

GOOGLE_PROXY

Defines a requests-supported proxy string used during Google Trends metric calculation. If unset or empty, a direct connection will be made. May be used to resolve the Google returned a response with code 429 issue.

Example usage

GLASSNODE_API_KEY

Defines an API key to be used during GlassNode fallback requests. If unset or empty, a cache fallback will be used instead (via CBBI.info).

Footer

Contact

About

πŸ“Š The official Python implementation of the ColinTalksCrypto Bitcoin Bull Run Index (CBBI)

https://cbbi.info

License:GNU General Public License v3.0


Languages

Language:Python 94.5%Language:PHP 5.5%