📚 Documentation

Complete API Documentation

Everything you need to build, deploy, and scale automated trading bots

🚀 Quick Start Guides

Getting Started

Create your first bot in under 10 minutes

  • Sign up and verify your account
  • Connect your exchange API keys
  • Deploy your first bot
  • Monitor performance

Bot Configuration

Configure trading strategies and parameters

  • Choose Proven (461% CAGR) or Custom strategy
  • Set risk management parameters
  • Configure notification preferences
  • Set up auto-activation rules

Backtesting

Test strategies on historical data

  • Upload historical data
  • Run backtest with your parameters
  • Analyze results (equity curve, metrics)
  • Optimize with Monte Carlo & WFO

Live Trading

Deploy bots to production with real money

  • Start with paper trading (simulated)
  • Monitor bot performance real-time
  • Set up emergency stop triggers
  • Track P&L and analytics

📖 API Reference

Authentication

POST /api/v2/auth/login POST /api/v2/auth/refresh POST /api/v2/auth/logout

Bots

GET /api/bots POST /api/bots PUT /api/bots/{id} DELETE /api/bots/{id} POST /api/bots/deploy

Backtesting

POST /api/backtests GET /api/backtests/{id} GET /api/backtests/{id}/results

Analytics

GET /api/analytics/performance GET /api/analytics/trade-history GET /api/analytics/usage

🔧 Advanced Topics

  • API Key Management: Scoped keys with 9 permission levels
  • Webhook Integration: Real-time notifications to your systems
  • Multi-User Deployment: Deploy bots to multiple user accounts
  • Risk Management: Stop-loss, take-profit, and position sizing
  • Custom Strategies: Import Freqtrade strategies or build from scratch

💡 Best Practices

  • Always backtest before live trading
  • Start with paper trading to verify bot behavior
  • Set appropriate stop-loss levels
  • Monitor your bots daily (especially in volatile markets)
  • Use TEST environment before LIVE deployment
  • Keep API keys secure (never share or commit to git)