https://github.com/brucewind/fear-and-greed-index-alarm

A notification reminder for indicating when the CNN Fear and Greed Index is out of range.
https://github.com/brucewind/fear-and-greed-index-alarm

crawler fear-and-greed fear-greed-index investment sctock stock-market us-stock-market

Last synced: about 2 months ago
JSON representation

A notification reminder for indicating when the CNN Fear and Greed Index is out of range.

• Host: GitHub
• URL: https://github.com/brucewind/fear-and-greed-index-alarm
• Owner: BruceWind
• License: other
• Created: 2023-11-14T02:25:20.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-29T07:52:02.000Z (5 months ago)
• Last Synced: 2024-08-29T09:05:24.575Z (5 months ago)
• Topics: crawler, fear-and-greed, fear-greed-index, investment, sctock, stock-market, us-stock-market
• Language: JavaScript
• Homepage:
• Size: 362 KB
• Stars: 5
• Watchers: 1
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[中文](/README_zh.md)

# Fear-And-Greed Index Alarm

The FearNGreed Index Alarm is an open-source repository that allows you to fetch CNN Fear and Greed Index every morning using GitHub Actions. This index serves as an indicator of market sentiment. The repository includes a script that checks whether the fetched index value is above or below a specified threshold. If it exceeds the defined range, an exception is raised within the GitHub Actions workflow. You will receive an email notification from github.

In case of out of range, you can see the error like this:



You can also see today status: [![Today Status](https://github.com/BruceWind/fear-and-greed-index-alarm/actions/workflows/daily-cron-action.yml/badge.svg)](https://github.com/BruceWind/fear-and-greed-index-alarm/actions/workflows/daily-cron-action.yml)

## Setup

To set up the FearNGreed Index Alarm, follow these steps:

1. Make sure you have a GitHub account. If not, create one at [https://github.com](https://github.com).

2. Fork this repository by clicking the "Fork" button in the top-right corner of this page.

3. In your forked repository, go to the "Settings" tab.

4. Under "Repository name", click on "Secrets".

5. Click on "New repository secret" and add the following secrets:

   - `FNG_MIN`: The minimum threshold value for the Fear and Greed Index.

   - `FNG_MAX`: The maximum threshold value for the Fear and Greed Index.

   Make sure to provide the appropriate values for these secrets.

6. Once you have added the secrets, the FearNGreed Index Alarm will be able to access them during the GitHub Actions workflow.

## Notification

Once you have set up the FearNGreed Index Alarm and added the necessary secrets, the workflow will automatically run according to the schedule. If the fetched Fear and Greed Index value exceeds the defined range, a notification will be triggered. You can customize the notification settings based on your preferences and requirements.

## Advertisement

If you want to use a AI stock watch service and notification service, or don't know how to use tech indicators, I recommand you to access [www.investmentstrategy365.com](https://www.investmentstrategy365.com).

You can see our past advices in this link: [www.investmentstrategy365.com/monitor?history=1](https://www.investmentstrategy365.com/monitor?history=1).