Quickstart

00 Before you begin

You'll need a StochLab account on the Quant tier or above, plus an active API key. Keys are scoped per-environment — never ship a live-trading key to the browser. Generate and rotate keys from the dashboard.

• A secret key, formatted sk_live_… (or sk_test_… for the paper-trading sandbox).
• The Python (pip install stochlab) or Node (npm i @stochlab/sdk) SDK, or any HTTP client.
• A funded sub-account — the sandbox seeds $1,000,000 in paper capital automatically.

01 Authenticate

Authentication uses a bearer token passed in the Authorization header. Pair it with an X-SL-Account header to target a specific sub-account, and an idempotency key on every write so retried requests never double-fill. Pick your language below — all three snippets hit the same signed endpoint.

# Verify your key and fetch the authenticated account
curl https://api.stochlab.io/v1/account \
  -H "Authorization: Bearer sk_live_3aF9k2Qx7Lp0wRtZ8nVbY" \
  -H "X-SL-Account: acct_8Hq2Rd" \
  -H "Accept: application/json"

from stochlab import StochLab

client = StochLab(
    api_key="sk_live_3aF9k2Qx7Lp0wRtZ8nVbY",
    account="acct_8Hq2Rd",
)

account = client.account.retrieve()
print(account.equity, account.buying_power)
# → 1042885.12  3128655.36

import { StochLab } from "@stochlab/sdk";

const client = new StochLab({
  apiKey: process.env.STOCHLAB_KEY,   // sk_live_…
  account: "acct_8Hq2Rd",
});

const account = await client.account.retrieve();
console.log(account.equity, account.buyingPower);

02 Deploy a strategy

Strategies are immutable, versioned bundles of entry/exit logic, risk limits, and the venues they're allowed to trade. Deploying compiles your config, runs a 12-month walk-forward smoke-backtest, and — if it clears your guardrails — arms the strategy on the live engine. Compose the logic visually in the Strategy Builder or POST it directly.

Request

{
  "name": "momentum-breakout-eth",
  "pattern": "bull_flag",
  "universe": ["ETH-PERP", "SOL-PERP"],
  "timeframe": "5m",
  "capital_usd": 250000,
  "sonar": {
    "min_confidence": 0.72,
    "veto_on_regime_flip": true
  },
  "risk": {
    "max_drawdown_pct": 8.0,
    "max_leverage": 3,
    "per_trade_bps": 35
  },
  "execution": {
    "venue": "colo-ny4",
    "order_type": "post_only",
    "slippage_bps_cap": 2
  }
}

Response — 201 Created

{
  "id": "strat_Qf7m2Kd9Lx",
  "name": "momentum-breakout-eth",
  "status": "armed",
  "version": 1,
  "smoke_backtest": {
    "sharpe": 2.41,
    "max_drawdown_pct": 6.3,
    "win_rate": 0.586,
    "trades": 1284
  },
  "sonar_attached": true,
  "created_at": "2026-06-14T08:31:07Z",
  "dashboard_url": "https://app.stochlab.io/s/strat_Qf7m2Kd9Lx"
}

Body parameters

03 Stream Sonar AI signals

Sonar AI publishes a continuous feed of predicted price paths, regime classifications, and order-flow imbalance over a single multiplexed WebSocket. Each signal carries a confidence score and a forward horizon — the same strand that rides above the realized price in your equity curves. Authenticate the socket with the same bearer token, then subscribe to the channels you care about.

Connect & subscribe

const ws = new WebSocket("wss://stream.stochlab.io/v1/sonar");

ws.onopen = () => {
  ws.send(JSON.stringify({
    op: "auth",
    token: "sk_live_3aF9k2Qx7Lp0wRtZ8nVbY",
  }));
  ws.send(JSON.stringify({
    op: "subscribe",
    channels: ["sonar.signal", "sonar.orderflow"],
    symbols: ["ETH-PERP"],
  }));
};

ws.onmessage = (e) => {
  const msg = JSON.parse(e.data);
  if (msg.channel === "sonar.signal") route(msg);
};

Sample signal frame

{
  "channel": "sonar.signal",
  "symbol": "ETH-PERP",
  "ts": "2026-06-14T08:42:19.118Z",
  "signal": "long",
  "confidence": 0.814,
  "horizon_ms": 90000,
  "predicted_move_bps": 47,
  "regime": "trending_up",
  "orderflow_imbalance": 0.63,
  "model": "sonar-v4.3-perp",
  "latency_us": 38
}

Pipe the frame straight into a deployed strategy by matching on confidence and regime, or react in your own process. Frames are delivered at-least-once and stamped with a monotonic ts; de-duplicate on ts + symbol if you fan out across workers.

04 Core endpoints

The most-used routes against https://api.stochlab.io/v1. Every endpoint returns JSON, supports cursor pagination, and is rate-limited per the table in the next section. Full reference, including error codes and webhook payloads, lives in the API section.

05 Rate limits & latency

Limits are applied per API key on a sliding window. WebSocket frames are exempt from the REST budget. Exceeding a limit returns 429 with a Retry-After header; the SDKs back off and retry automatically.