Documentation · API

API reference.

Integrate strategy management, backtesting, execution, positions, and exchange connectivity into your own tooling.

Base URL and authentication

All endpoints are served under /api. Authenticate with a bearer token issued by the platform. Never embed production credentials in client-side code; use a server-side integration or a scoped service account.

Authorization: Bearer <token>
Content-Type: application/json

Core resources

Strategies — create, update, start, stop, and inspect strategy configuration.
Backtests — submit a strategy and date range, then retrieve metrics, trades, and equity curve.
Orders — inspect order state, fills, and execution errors.
Positions — current exposure, entry price, unrealized PnL, and exchange sync state.
Exchanges — credential metadata and connection health. Secrets are never returned.

Example: strategy lifecycle

GET  /api/strategies
POST /api/strategies
POST /api/strategies/{id}/start
POST /api/strategies/{id}/stop

Example: backtest

POST /api/backtests
{
  "strategy_id": 123,
  "symbol": "BTC/USDT",
  "timeframe": "15m",
  "start_date": "2025-01-01",
  "end_date": "2025-12-31",
  "commission": 0.0005,
  "slippage": 0.0002
}

Errors and limits

Errors return a JSON body with a code and message. Respect HTTP 429 and Retry-After. Use idempotency keys for order creation where supported. The full OpenAPI schema is provided to licensed customers.