monitor_binance_spot_rest_docs

A simple monitoring tool that checks for changes in Binance Spot REST API documentation (rest-api.md) and logs differences over time. Optionally, it can send change notifications to a Discord channel via webhook.

---

Features

• Detects changes in rest-api.md
• Logs changes in standard git diff format (easy to read in VS Code or any diff viewer)
• Optional Discord notifications when changes are detected
• Minimal dependencies (just git, bash, curl, python3)

---

How It Works

On each run, the script:

1. Fetches the latest Binance Spot REST API docs.
2. Compares rest-api.md against the latest origin/master.
3. Logs whether changes were detected into changes.diff.
4. Optionally sends messages to Discord if a webhook is configured.
5. Updates the local copy of rest-api.md for the next run.

---

Installation

Clone this repository:

git clone https://github.com/yourusername/monitor_binance_spot_rest_docs.git
cd monitor_binance_spot_rest_docs
chmod +x monitor.sh

---

Usage

Run the script manually:

./monitor.sh

Output will be stored in changes.diff (next to the repo).

---

Environment

The script optionally uses a Discord webhook to send notifications:

• Environment variable: MONITOR_BINANCE_SPOT_REST_DOCS_DISCORD_WEBHOOK Set this to your Discord Webhook URL if you want notifications.

• Example:

  export MONITOR_BINANCE_SPOT_REST_DOCS_DISCORD_WEBHOOK="https://discord.com/api/webhooks/XXXX/XXXX"

• Persistence: To make the variable available in every session, add it to your shell configuration file (e.g., ~/.bashrc, ~/.zshrc):

  echo 'export MONITOR_BINANCE_SPOT_REST_DOCS_DISCORD_WEBHOOK="https://discord.com/api/webhooks/XXXX/XXXX"' >> ~/.bashrc
  source ~/.bashrc

• OS Compatibility: Tested on Unix-like systems (Linux, macOS). Requires:

  • bash
  • git
  • curl (only if using Discord notifications)
  • python3 (for JSON escaping of messages)

---

Automation

You can run this script on a schedule with cron:

crontab -e

Example (run every day at 10:00):

0 10 * * * /path/to/monitor_binance_spot_rest_docs/monitor.sh

Logs will continue to append to changes.diff.

---

Example Output

When no changes:

2025-09-07 15:12:42 🟢 No changes in rest-api.md

When changes detected:

2025-09-07 15:12:42 🔴 Changes detected in rest-api.md
diff --git a/rest-api.md b/rest-api.md
index 0f0d65a..3fccc67 100644
--- a/rest-api.md
+++ b/rest-api.md
@@ -139,7 +139,7 @@ Sample Payload below:

 ### General Info on Limits
-* SECOND => S
+* SECONS => S

---

Help & Test Modes

The script supports additional options:

./monitor.sh --help
./monitor.sh --check-deps
./monitor.sh --test-log
./monitor.sh --test-discord

• --help → Show usage and options
• --check-deps Check that all required dependencies are installed and exit
• --test-log → Write a test entry to the log file
• --test-discord → Send a test message to Discord (if webhook is set)

---

Requirements

• bash
• git
• curl (only required if using Discord notifications)
• python3

---

License

MIT