Skip to main content

API Reference

TRADEOS.tech exposes a REST API for programmatic access to system state, performance data, and control operations. The API is available at the same host as the dashboard.

Authentication​

All API requests require a Bearer token:

Authorization: Bearer YOUR_API_TOKEN

Your API token can be found in Settings → API Access in the dashboard.

Base URL​

https://your-tradeos-instance/api/v1

Core Endpoints​

System Health​

GET /health

Returns the current health status of all system components.

Response:

{
  "status": "healthy",
  "components": {
    "signal_engine": "healthy",
    "execution": "healthy",
    "ingestion": "healthy",
    "risk_monitor": "healthy",
    "database": "healthy"
  },
  "timestamp": "2026-03-10T12:00:00Z"
}

Positions​

GET /positions

Returns all current open positions.

Response:

{
  "positions": [
    {
      "symbol": "BTC-PERP",
      "side": "long",
      "size": 0.1,
      "entry_price": 85000.00,
      "current_price": 86200.00,
      "unrealized_pnl": 120.00,
      "pnl_pct": 1.41,
      "opened_at": "2026-03-10T09:15:00Z",
      "stop_loss": 83200.00,
      "signal_id": "sig_abc123"
    }
  ],
  "total_unrealized_pnl": 120.00,
  "total_exposure": 8620.00
}

Performance Summary​

GET /performance/summary

Returns daily and cumulative performance metrics.

Response:

{
  "equity": 105234.50,
  "high_water_mark": 105234.50,
  "drawdown_pct": 0.0,
  "today_pnl": 1234.50,
  "today_pnl_pct": 1.19,
  "total_return_pct": 5.23,
  "win_rate_30d": 0.62,
  "sharpe_ratio_30d": 1.84
}

Trade History​

GET /trades?limit=50&from=2026-03-01&to=2026-03-10

Returns trade history with P&L and execution details.

Risk Status​

GET /risk/status

Returns current risk metrics and circuit breaker state.

Response:

{
  "drawdown_pct": 2.1,
  "drawdown_gate_active": false,
  "drawdown_breaker_active": false,
  "daily_loss_pct": 0.8,
  "circuit_breakers": {
    "infrastructure": "closed",
    "ingestion_lag": "closed",
    "system_health": "closed"
  },
  "dead_mans_switch": "armed"
}

Control Operations​

POST /trading/pause
POST /trading/resume
POST /trading/flatten-all

Control trading state programmatically. All control operations require a confirmation token passed in the request body.

Webhooks​

TRADEOS.tech can push events to a webhook URL for real-time notifications. See Webhooks for configuration. Bot-platform delivery sessions for 3Commas and Cryptohopper use the same signal-access delivery boundary with platform-specific renderers. See Bot Platform Distribution.

Rate Limits​

The API enforces rate limits to prevent abuse:

  • Read endpoints: 60 requests/minute
  • Control endpoints: 10 requests/minute

Rate limit headers are included in all responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1741608000