zaczero / cbbi

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

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 9 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, check out this video.

Visit our website

Bookmark it and receive latest CBBI updates.

• CBBI.info

Script Demo

Docker Usage

To use the CBBI script with Docker, run the following command:

docker run --rm --pull=always zaczero/cbbi --help
docker run --rm --pull=always zaczero/cbbi

Manual Usage

To use the CBBI script without Docker, follow these two simple steps:

1. Install nix

Before you jump in, make sure to install the ❄️ Nix package manager. It's your shortcut to seamless dependency management and reproducible environment setup. It will save you lots of time and spare you from unnecessary stress.

2. Run the application

nix-shell --run "python main.py --help"

or with using interactive shell

nix-shell
python main.py --help

Metrics

The current CBBI version (November 2022) 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

Environment Variables

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

To use this feature, create a file called .env in the project's root directory, and add environment variables in the following format:

VARIABLE_NAME=value

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).

Example usage

• GLASSNODE_API_KEY=REPLACE_ME

TELEGRAM_TOKEN, TELEGRAM_CHAT_ID

Define both variables to receive Telegram notifications about metric errors that occur during the execution.

Example usage

• TELEGRAM_TOKEN=REPLACE_ME
• TELEGRAM_CHAT_ID=123456

Footer

Contact me

https://monicz.dev/#get-in-touch

License

This project is licensed under the GNU Affero General Public License v3.0.

The complete license text can be accessed in the repository at LICENSE.

cbbi's Issues

At what time is the API getting updated?

Hello,

Great work with this project. Around what time is the API getting updated? For a trading bot I'm trying to use the metrics from the API. I pull the data around 00:05 CET and it is giving nans for the new day.
Thanks in advance.

Response problem!

Hi my friend. Thanks for your effort but i've a problem for a few days.

New json url address is: https://www.lookintobitcoin.com/django_plotly_dash/app/unrealised_profit_loss/_dash-update-component

But i can't this url execute directly on browser and i get "Server Error (500)".

However i can execute it with browser developer tools. How can i get it with Python code?

Thanks.

Missing requirements.txt

I noticed the readme says to pip install -r requirements.txt, but there is no requirements.txt. Instead, I believe it is pipenv now.

500 error

Hi there,

the website https://www.lookintobitcoin.com/django_plotly_dash/app/rhodl_ratio/_dash-update-component is not working, having 500 error.
maybe need to have a mirrors or exception handling for these cases.

Regards,

RHOLD and RR not calibrated.

Due to alpha decay these two indicators suffered the most and seem inconsistent. Is it possible a small calibration?

An Error Occured!

Hi Kamil,

Is this a LIB issue? Last week the script was running with no hiccups. I have just tried to run main.py and it keeps retrying but returning always these lines.

:: Retrying in 10 seconds...
Fetching daily Google Trends: 100%|███████████████████████████████████████████████████| 57/57 [00:00<00:00, 211.09it/s]
Error: An error occurred!
Traceback (most recent call last):
File "D:\OneDrive\Work (Current)\ValueUnbanking\CBBI-main\main.py", line 146, in run_and_retry
run(json_file, charts_file)
File "D:\OneDrive\Work (Current)\ValueUnbanking\CBBI-main\main.py", line 78, in run
df_bitcoin[metric.name] = metric.calculate(df_bitcoin_org.copy(), ax)
File "D:\OneDrive\Work (Current)\ValueUnbanking\CBBI-main\metrics\rhodl_ratio.py", line 60, in calculate
df = df.merge(_fetch_df(), on='Date', how='left')
File "D:\OneDrive\Work (Current)\ValueUnbanking\CBBI-main\metrics\rhodl_ratio.py", line 36, in _fetch_df
response.raise_for_status()
File "C:\Python39\lib\site-packages\requests\models.py", line 953, in raise_for_status
raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 500 Server Error: Internal Server Error for url: https://www.lookintobitcoin.com/django_plotly_dash/app/rhodl_ratio/_dash-update-component

Calculation method changed?

First of all, thanks for creating this index. I've been following it for a while and check it daily. Yesterday I saw the CBBI score was 9, but when I checked it today it's suddenly at 14? Also all the historic values have changed, so I wonder what was changed in the algorithm and why?

Other indicators

Hi Kamil!

Thank you so much for this amazing project. I was wondering whether you are planning to include all other indicators from lookintobitcoi.com.

Keep up the amazing work! :)