Skip to content

README.md

Latest commit

 

History

History
132 lines (92 loc) · 5.83 KB

README.md

File metadata and controls

132 lines (92 loc) · 5.83 KB
TradeClaw logo

TradeClaw

Open-source AI trading signals. Every trade verified.

Stars License: MIT Demo

Track Record · Live Demo · API Docs · Pricing

TradeClaw generates BUY/SELL signals using multi-timeframe technical analysis (RSI, MACD, EMA, Bollinger Bands, Stochastic, Supertrend). Every signal is recorded in a Postgres database and published on the track record — wins and losses, no cherry-picking.

Free vs Pro

Free Pro ($29/mo)
Symbols 3 (BTC, ETH, XAU) All pairs
Signal delay 15 min Real-time
Take-profit levels TP1 only TP1 + TP2 + TP3
Signal history 24 hours Full archive
Telegram alerts Public channel (delayed) Private channel (instant)
Track record Full access Full access
Self-host Yes Yes

Start free at tradeclaw.win/dashboard. Upgrade anytime at tradeclaw.win/pricing.

Self-hosting vs. TradeClaw Pro (hosted)

TradeClaw is MIT-licensed. You can fork, self-host, and run the entire signal framework for free — the free-tier signal engine (classic TA, RSI + EMA + MACD confluence), backtester, dashboard, paper trading, and public Telegram broadcaster are all in this repo.

The hosted version at tradeclaw.win adds features that activate only when the deploy holds the matching credentials:

Feature Unlocked by env var Who has it
Real-time premium signals (MTF confluence, curated) PREMIUM_SIGNAL_SOURCE_URL + PREMIUM_SIGNAL_SOURCE_KEY tradeclaw.win only
Stripe checkout + tier upgrade on webhook STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET Per-deploy
Private Pro Telegram group + invite on subscribe TELEGRAM_PRO_GROUP_ID + Pro bot token tradeclaw.win only
Telegram auto-broadcast of free symbols TELEGRAM_CHANNEL_ID + bot token Per-deploy

Without these, self-hosters get the free-tier experience — which is the same signal engine the founders trade against real capital. No code is withheld. What is withheld is the curated premium signal feed and the payment plumbing. Those are operational, not algorithmic.

If you want to run your own paid tier on top of this code: set your own Stripe keys, run your own premium signal generator, and point PREMIUM_SIGNAL_SOURCE_URL at it. The HTTP contract is minimal — GET <url> returning { signals: TradingSignal[] } with a Bearer Authorization header using PREMIUM_SIGNAL_SOURCE_KEY. Returns [] (and the hosted deploy keeps working with the DB-backed premium_signals table) if the remote is down.

Self-host with Docker Compose

git clone https://github.com/naimkatiman/tradeclaw
cd tradeclaw
cp .env.example .env   # edit DATABASE_URL + Telegram tokens
docker compose up -d

Open http://localhost:3000.

Requires PostgreSQL. Run migrations from apps/web/migrations/ in order.

Architecture

apps/web/           Next.js app (dashboard, API routes, signal engine)
packages/strategies/ Backtest comparison framework (not in live signal path)
scripts/            Local dev tools (scanner-engine.py — local only)

Signal flow:

API request → getTrackedSignals() → generateSignalsFromTA()
  → ta-engine.ts (RSI, MACD, EMA, BB, Stoch, Supertrend)
  → recordSignalsAsync() → signal_history table
  → /track-record page

Signals are generated as a side effect of API requests — no external scheduler. The TA engine runs inside the Next.js process.

Strategy Presets

Five entry strategies, switchable via SIGNAL_ENGINE_PRESET:

Preset Logic
classic RSI + MACD + EMA scoring — no regime filter
regime-aware Classic filtered by HMM regime
hmm-top3 Regime-aware, top 3 by confidence — production default
vwap-ema-bb Mean-reversion at BB extremes with VWAP + EMA
full-risk HMM top-3 with risk-weighted allocation

Compare presets in the backtest UI with side-by-side metrics and equity curves.

API

# Get current signals (free tier — 3 symbols, 15-min delay)
curl https://tradeclaw.win/api/signals

# Get track record stats
curl https://tradeclaw.win/api/strategy-breakdown

Pro subscribers get real-time access to all endpoints with full depth.

Environment Variables

Variable Required Description
DATABASE_URL Yes PostgreSQL connection string
MARKET_DATA_HUB_URL Yes Market data proxy URL
TELEGRAM_BOT_TOKEN No Telegram bot for alerts
TELEGRAM_CHANNEL_ID No Private channel (Pro alerts)
TELEGRAM_PUBLIC_CHANNEL_ID No Public channel (delayed free alerts)
STRIPE_SECRET_KEY No Stripe for Pro subscriptions
STRIPE_PRO_PRICE_ID No Stripe price ID for Pro tier
CRON_SECRET Yes Auth for /api/cron/* endpoints
SIGNAL_ENGINE_PRESET No Strategy preset (default: hmm-top3)

Contributing

See CONTRIBUTING.md and good first issues.

MIT License · tradeclaw.win