tvwb_demo.webm

📀 实时演示 🖥

现在有一个实时演示可以在 http://tvwb.robswc.me 上访问。
欢迎去看看，或者向它发送一些 webhook！

在 Discord 上获取支持

是什么 🔬

Tradingview-webhooks-bot (TVWB) 是一个基于 Python 的小型框架，允许你使用来自 Tradingview 的 webhooks 的数据来扩展或实现自己的逻辑。TVWB 并不是一个交易库，而是一个用于构建自定义交易逻辑的框架。

怎么做 🏗

TVWB 本质上是一组组件，其中 Web 应用程序充当 GUI。TVWB 在设计时考虑了事件驱动架构，为你提供了扩展或实现自定义逻辑所需的构建模块。 TVWB 使用 Flask 来处理 webhooks，并为你提供了一个简单的 API 来与数据交互。

快速入门 📘

Docker Compose 命令

docker-compose run app start

安装

• Docker（推荐）
• 手动安装

托管

• 部署
  • 云（推荐）
  • 本地

---

请确保你在 src 目录下。运行以下命令时，如果你是手动安装的。
如果你使用的是 Docker， 请通过 docker-compose run app shell 启动 tvwb.py shell（在项目根目录下），并省略命令中的 python3 tvwb.py 部分。

---

创建一个动作

python3 tvwb.py action:create NewAction --register

这会创建一个动作，并自动将其注册到应用中。在此处了解更多关于注册的信息。

注意，动作和事件名称应始终使用帕斯卡命名法。

你也可以查看一些“预制”的社区动作！

将动作链接到事件

python3 tvwb.py action:link NewAction WebhookReceived

这会将动作链接到 WebhookReceived 事件。当应用接收到 webhook 时，就会触发 WebhookReceived 事件，目前这是唯一的默认事件。

编辑动作

导航到 src/components/actions/NewAction.py，编辑 run 方法。你会看到类似下面的代码。 你可以删除“自定义运行方法”的注释，并替换为自己的逻辑。以下是访问 webhook 数据的一个示例。

class NewAction(Action):
    def __init__(self):
        super().__init__()

    def run(self, *args, **kwargs):
        super().run(*args, **kwargs)  # 这是必需的
        """
        自定义运行方法。在这里添加你的自定义逻辑。
        """
        data = self.validate_data()  # 始终通过调用此方法从 webhook 获取数据！
        print('来自 webhook 的数据：', data)

运行应用

python3 tvwb.py start

发送 webhook

导航到 http://localhost:5000。确保你看到 WebhookReceived 事件。点击“详情”展开事件框。 找到“Key”字段并记下其值。这就是你用来向应用发送 webhook 的密钥。复制下面的 JSON 数据，将“YOUR_KEY_HERE”替换为你刚才复制的密钥。

{
    "key": "YOUR_KEY_HERE",
    "message": "我是一个 webhook!"
}

key 字段是必需的，因为它既用于验证 webhook，也告诉应用应该触发哪个事件。除此之外，你可以发送任何你想发送的数据。这些数据将通过 validate_data() 方法供你的动作使用。（参见上文，编辑动作）

在 Tradingview 上，使用上述 JSON 数据创建一个新的 webhook，并将其发送到 http://ipaddr:5000/webhook。你应该会在控制台看到来自 webhook 的数据打印出来。

常见问题解答

那我到底该如何进行交易呢？

要真正提交交易，你需要使用像 ccxt 这样的库来进行加密货币交易。对于其他经纪商，通常也有 SDK 或 API 可用。一般的流程大致如下：webhook 信号 -> TVWB（这里使用 ccxt）-> 经纪商。你的交易提交将在自定义动作的 run 方法中完成。

tvwb.py shell

你可以使用 tvwb.py shell 命令打开一个带有应用上下文的 Python shell。这样你就可以在不每次都输入 python3 tvwb.py 的情况下与应用进行交互。

在 Windows/Mac 上运行 Docker？

感谢 @khamarr3524 指出，在 Windows 或 Mac 上运行 Docker 时存在一些差异。我已经添加了针对不同操作系统的 docker-compose.yml 文件来适应这些差异。现在应该可以顺利运行各自操作系统对应的 docker-compose.yml 文件了！

我还能在哪里获得帮助？

目前维基仍在建设中。不过你仍然可以在那里找到一些有用的信息。如果需要更多帮助，可以在 Twitter 上私信我，或者加入 Discord。我会尽力尽快回复你！

TradingView Webhooks Bot 快速上手指南

TradingView Webhooks Bot (TVWB) 是一个基于 Python 的轻量级框架，旨在接收 TradingView 的 webhook 信号，并允许开发者扩展或实现自定义的交易逻辑。它本身不是交易库，而是构建交易策略的基础设施。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS 或 Windows (需安装 Docker Desktop)。
• 核心依赖：
  • Docker & Docker Compose（强烈推荐）：最简便的部署方式，自动处理所有依赖。
  • 或者 Python 3.8+：如果选择手动安装，需自行管理虚拟环境和依赖包。
• 网络环境：服务器需具备公网 IP 或通过内网穿透工具暴露端口，以便 TradingView 能够访问 webhook 接口。

提示：国内用户若拉取 Docker 镜像缓慢，建议配置阿里云、腾讯云或网易云等国内 Docker 镜像加速器。

安装步骤

推荐使用 Docker Compose 进行一键部署。

1. 克隆项目代码

   git clone https://github.com/robswc/tradingview-webhooks-bot.git
   cd tradingview-webhooks-bot
   

2. 启动服务 在项目根目录下运行以下命令启动应用：

   docker-compose run app start
   

   注：如果是首次运行，Docker 会自动下载所需镜像并构建环境。

   手动安装用户：请参考官方 Wiki 中的 Manual Installation 章节，安装 Python 依赖后进入 src 目录运行 python3 tvwb.py start。

基本使用

以下是创建一个简单动作（Action）并接收 webhook 信号的完整流程。

1. 创建自定义动作

我们需要创建一个脚本来定义收到信号后要执行的操作（例如打印日志、调用交易所 API 等）。

在项目根目录（Docker 用户）或 src 目录（手动安装用户）执行：

# Docker 用户请先进入 shell: docker-compose run app shell
# 然后执行以下命令（手动安装用户直接运行，需加 python3 tvwb.py 前缀）
python3 tvwb.py action:create MyTradeStrategy --register

注意：动作名称必须使用大驼峰命名法 (PascalCase)，如 MyTradeStrategy。

2. 关联事件

将创建的动作绑定到 WebhookReceived 事件上，这样当收到 webhook 时就会触发该动作。

python3 tvwb.py action:link MyTradeStrategy WebhookReceived

3. 编写交易逻辑

编辑生成的文件 src/components/actions/MyTradeStrategy.py，在 run 方法中填入你的逻辑。

class MyTradeStrategy(Action):
    def __init__(self):
        super().__init__()

    def run(self, *args, **kwargs):
        super().run(*args, **kwargs)  # 此行必须保留
        """
        在此处添加自定义逻辑
        """
        # 获取并验证 webhook 数据
        data = self.validate_data()
        
        # 示例：打印接收到的数据
        print('收到交易信号:', data)
        
        # TODO: 在此处集成 ccxt 或其他 broker SDK 执行实际下单操作

4. 运行应用

启动服务监听端口（默认 5000）：

python3 tvwb.py start

5. 发送测试信号

1. 浏览器访问 http://localhost:5000。
2. 找到 WebhookReceived 事件卡片，点击 "details" 展开。
3. 复制显示的 Key 值（用于身份验证）。
4. 构造如下 JSON 数据（将 YOUR_KEY_HERE 替换为刚才复制的 Key）：

{
    "key": "YOUR_KEY_HERE",
    "message": "Test signal from TradingView"
}

5. 在 TradingView 中配置：
   • 创建一个新的 Alert（警报）。
   • Webhook URL 填写：http://<你的服务器 IP>:5000/webhook
   • Message 内容填写上述 JSON 数据。
   • 触发警报后，查看终端控制台，应能看到 "收到交易信号..." 的输出。

至此，您已成功搭建并运行了第一个 webhook 响应逻辑。接下来您可以在 run 方法中集成 ccxt 等库来实现真实的自动交易。