Binance API 合約交易通知

這是一個 Python 專案，用於監控您的幣安 (Binance) 合約帳戶，並在您有關注的交易對有未平倉位時，透過 Discord Webhook 發送通知。

主要功能

• 倉位監控: 自動檢查您在 config.yaml 中設定的關注清單 (watchlist) 中的交易對。
• 即時通知: 當監控的交易對有未平倉位時，發送詳細的倉位資訊到您指定的 Discord 頻道。
• 詳細資訊: 通知內容包含交易對、倉位大小、槓桿倍數、開倉價格、當前價格以及未實現盈虧。
• 自訂設定: 透過 config.yaml 輕鬆配置您的關注清單和通知顏色。
• 自動化: 內建 GitHub Actions 工作流程，可以設定為手動觸發，方便部署和自動執行。

如何使用

1. 環境準備

• 確認您已安裝 Python 3.10 或更高版本。
• 擁有一個幣安帳戶並生成 API Key 和 API Secret。
• 擁有一個 Discord 帳戶並設定好 Webhook URL。

2. 安裝步驟

1. 複製專案庫

   git clone https://github.com/jhskrt/binance_api_notifier.git
   cd binance_api_notifier

2. 安裝依賴套件

   pip install -r requirements.txt

3. 環境設定

1. 建立 .env 檔案 在專案根目錄下建立一個名為 .env 的檔案，並填入您的幣安 API 和 Discord Webhook 資訊：

   DISCORD_WEBHOOK_URL="YOUR_DISCORD_WEBHOOK_URL"
   API_KEY="YOUR_BINANCE_API_KEY"
   API_SECRET="YOUR_BINANCE_API_SECRET"
   

2. 修改 config.yaml 您可以根據需求修改 config.yaml 檔案：

   • watchlist: 加入您想監控的合約交易對 (例如 BTCUSDT, ETHUSDT)。
   • colors: 自訂盈虧通知的顏色。

   trading:
     watchlist:
       - BTCUSDT
       - ETHUSDT
       - SOLUSDT

4. 執行程式

完成以上設定後，您可以直接執行主程式：

python main.py

程式會檢查您的倉位，並在有符合條件的倉位時發送通知。

使用 GitHub Actions 自動化

本專案已包含一個 GitHub Actions 工作流程 (.github/workflows/daily_notifier.yml)，讓您可以輕鬆地在 GitHub 上自動執行此腳本。

1. 設定 Secrets 在您的 GitHub Repository 中，前往 Settings > Secrets and variables > Actions，並新增以下 secrets：

   • API_KEY: 您的幣安 API Key。
   • API_SECRET: 您的幣安 API Secret。
   • DISCORD_WEBHOOK_URL: 您的 Discord Webhook URL。

2. 手動觸發 您可以到 Actions 頁面，選擇 notifier 工作流程，並手動點擊 Run workflow 來執行。

注意事項

• 請妥善保管您的 API Key 和 Secret，不要將它們公開或提交到公共儲存庫。

授權

本專案採用 MIT 授權。詳情請見 LICENSE 檔案。