TradingView-Webhook-Bot/README.md

88 wiersze
6.3 KiB
Markdown
Czysty Zwykły widok Historia

2021-03-14 08:24:07 +00:00
<p align="center"><a href="https://github.com/fabston/TradingView-Webhook-Bot" target="_blank"><img src="https://raw.githubusercontent.com/fabston/TradingView-Webhook-Bot/master/assets/logo.png"></a></p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
<p align="center">
<a href="https://www.python.org/downloads/release/python-380/"><img src="https://img.shields.io/badge/python-3.8-blue.svg?style=plastic" alt="Python version"></a>
2021-03-14 08:24:07 +00:00
<a href="https://github.com/fabston/TradingView-Webhook-Bot/blob/master/LICENSE"><img src="https://img.shields.io/github/license/fabston/TradingView-Webhook-Bot?style=plastic" alt="GitHub license"></a>
<a href="https://github.com/fabston/TradingView-Webhook-Bot/issues"><img src="https://img.shields.io/github/issues/fabston/TradingView-Webhook-Bot?style=plastic" alt="GitHub issues"></a>
<a href="https://github.com/fabston/TradingView-Webhook-Bot/pulls"><img src="https://img.shields.io/github/issues-pr/fabston/TradingView-Webhook-Bot?style=plastic" alt="GitHub pull requests"></a>
<br /><a href="https://github.com/fabston/TradingView-Webhook-Bot/stargazers"><img src="https://img.shields.io/github/stars/fabston/TradingView-Webhook-Bot?style=social" alt="GitHub stars"></a>
<a href="https://github.com/fabston/TradingView-Webhook-Bot/network/members"><img src="https://img.shields.io/github/forks/fabston/TradingView-Webhook-Bot?style=social" alt="GitHub forks"></a>
<a href="https://github.com/fabston/TradingView-Webhook-Bot/watchers"><img src="https://img.shields.io/github/watchers/fabston/TradingView-Webhook-Bot?style=social" alt="GitHub watchers"></a>
2020-07-04 07:38:38 +00:00
</p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
<p align="center">
<a href="#about">About</a>
<a href="#features">Features</a>
<a href="#installation">Installation</a>
<a href="#images">Images</a>
<a href="#how-can-i-help">Help</a>
</p>
2020-04-21 14:29:54 +00:00
2020-07-04 07:38:38 +00:00
## About
The **TradingView Webhook Bot** ⚙️ listens to [TradingView](https://tradingview.com) alerts via [webhooks](https://www.tradingview.com/support/solutions/43000529348-i-want-to-know-more-about-webhooks/) using [flask](https://flask.palletsprojects.com/en/1.1.x/).
2021-04-10 20:19:11 +00:00
All alerts can be instantly sent to Telegram, Discord, Twitter and/or Email.
2020-07-04 07:38:38 +00:00
2021-04-10 20:19:11 +00:00
## [Webhook Alerts](https://webhookalerts.com) 🔥
I am running my own Webhook Alerts Service. No setup and hosting required!
Send all your alerts to Telegram, Discord, Slack & Twitter along with a **full screenshot of the chart** complete with your indicators.
Find out more at [WebhookAlerts.com](https://webhookalerts.com). Got a question? Let me know!
---
2020-12-04 12:34:56 +00:00
2020-07-04 07:38:38 +00:00
## Features
- Telegram Support using the [Python Telegram](https://github.com/python-telegram-bot/python-telegram-bot) libary
- Discord Support using [webhooks](https://support.discord.com/hc/de/articles/228383668-Webhooks-verwenden)
2021-02-05 17:27:05 +00:00
- Slack Support using [webhooks](https://api.slack.com/messaging/webhooks)
2020-07-11 08:08:51 +00:00
- Twitter Support using the [tweepy](https://github.com/tweepy/tweepy) libary
2020-07-04 07:38:38 +00:00
- Email Support using [smtplib](https://docs.python.org/3/library/smtplib.html)
2021-03-14 08:24:07 +00:00
- Alert channels can be enabled or disabled in [`config.py`](https://github.com/fabston/TradingView-Webhook-Bot/blob/master/config.py)
- Dynamically send alerts to different Telegram and/or Discord channels
2020-07-04 07:38:38 +00:00
- TradingView `{{close}}`, `{{exchange}}` etc. variables support. Read more [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/)
2021-06-22 12:34:31 +00:00
> 💡 Got a feature idea? Open an [issue](https://github.com/fabston/TradingView-Webhook-Bot/issues/new?assignees=&labels=enhancement&template=feature-request---.md) and I might implement it.
2020-07-11 08:08:51 +00:00
2020-07-04 07:38:38 +00:00
## Installation
2021-03-14 08:24:07 +00:00
> ⚠️ Best to run the bot on a VPS. I can recommend <a href="https://fabston.dev/hetzner" title="Get €20 in cloud credits">Hetzner</a>'s CX11 VPS for 2.89€/month.
1. Clone this repository `git clone https://github.com/fabston/TradingView-Webhook-Bot.git`
2020-07-11 08:08:51 +00:00
1. Create your virtual environment `python3 -m venv TradingView-Webhook-Bot`
1. Activate it `source TradingView-Webhook-Bot/bin/activate && cd TradingView-Webhook-Bot`
2020-07-11 08:08:51 +00:00
1. Install all requirements `pip install -r requirements.txt`
2021-03-14 08:24:07 +00:00
1. Edit and update [`config.py`](https://github.com/fabston/TradingView-Webhook-Bot/blob/master/config.py)
1. Setup TradingView alerts. An example alert message would be:
2021-02-05 16:25:38 +00:00
```json
2021-02-05 17:27:05 +00:00
{
"key": "9T2q394M92",
"telegram": "-1001277977502",
"discord": "789842341870960670/BFeBBrCt-w2Z9RJ2wlH6TWUjM5bJuC29aJaJ5OQv9sE6zCKY_AlOxxFwRURkgEl852s3",
"slack": "T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
"msg": "Long *#{{ticker}}* at `{{close}}`"
}
```
2021-03-14 08:24:07 +00:00
- `key` is mandatory! It has to match with `sec_key` in [`config.py`](https://github.com/fabston/TradingView-Webhook-Bot/blob/master/config.py). It's an extra security measurement to ensure nobody else is executing your alerts
2021-02-05 17:27:05 +00:00
- `telegram`, `discord`, `slack` is optional. If it is not set it will fall back to the config.py settings
- `msg` can be anything. Markdown for [Telegram](https://core.telegram.org/api/entities) and [Discord](https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-) is supported as well
- TradingViews variables like `{{close}}`, `{{exchange}}` etc. work too. More can be found [here](https://www.tradingview.com/blog/en/introducing-variables-in-alerts-14880/)
2020-07-16 07:09:36 +00:00
- Your webhook url would be `http://<YOUR-IP>/webhook`
1. If you use a firewall be sure to open the corresponding port
1. Run the bot with `python main.py`
2021-03-14 08:24:07 +00:00
1. [PM2](https://github.com/fabston/TradingView-Webhook-Bot/issues/28#issuecomment-766301062) can help you in running the app in the background / on system boot.
2020-04-21 14:29:54 +00:00
*It is recommended to run flask on a different port like 8080. It is then necessary to forward port 80 to 8080.*
2020-04-21 17:43:52 +00:00
## Images
2020-07-04 07:38:38 +00:00
![Webhook Bot](https://i.imgur.com/vZA42cc.png)
2020-07-04 07:38:38 +00:00
## How can I help?
2021-06-15 21:23:49 +00:00
All kinds of contributions are welcome 🙌! The most basic way to show your support is to `⭐️ star` the project, or raise [`🐞 issues`](https://github.com/fabston/TradingView-Webhook-Bot/issues/new/choose). You can also support this project by becoming a [sponsor on GitHub](https://github.com/sponsors/fabston) to ensure this journey continues indefinitely! 🚀
2020-11-18 08:20:43 +00:00
2020-12-05 12:20:12 +00:00
***
<p align="center">
2021-03-14 08:24:07 +00:00
<a href="https://www.buymeacoffee.com/fabston"><img alt="Buy Me A Coffee" title="☕️" src="https://raw.githubusercontent.com/fabston/TradingView-Webhook-Bot/master/assets/bmac.png" width=200px></a>
2021-02-05 16:25:38 +00:00
</p>