Skip to main content

Get Strategy

Retrieve a single strategy by ID, including its current params, status, and runtime stats.

Endpoint

GET /v1/strategies/{id}

Weight: 1 Authentication: Required (signed) — see Authentication.

Request

Path parameter: id — the strategy identifier (e.g. strat_8f2a1b).

No query parameters or body.

Response

{
"id": "strat_8f2a1b",
"name": "BTC grid 1h",
"template_id": "tpl_grid",
"params": {
"grid_levels": 8,
"upper_price": "72000",
"lower_price": "60000",
"rebalance_threshold": "0.02"
},
"symbols": ["BTCUSDT"],
"timeframe": "1h",
"capital": "10000.00",
"leverage": 3,
"status": "deployed",
"deployed_at": "2026-04-29T08:00:00Z",
"created_at": "2026-04-28T15:30:00Z",
"updated_at": "2026-04-29T08:00:00Z",
"stats": {
"open_positions": 2,
"total_pnl": "184.32",
"total_trades": 47,
"win_rate": "0.638"
}
}

Response fields

FieldTypeDescription
idstringStrategy identifier, format strat_<6-8 hex>.
namestringHuman-readable label.
template_idstringTemplate slug, e.g. tpl_grid.
paramsobjectTemplate-specific parameters. Schema depends on the template.
symbolsarray<string>Symbols the strategy trades.
timeframestringCandle interval, e.g. 1m, 1h, 1d.
capitalstringQuote-currency notional, decimal string.
leverageintegerLeverage multiplier, 1–20.
statusenumOne of draft, deployed, paused, stopped, error.
deployed_atstring|nullISO 8601 UTC timestamp of the most recent deploy, or null if never deployed.
created_atstringISO 8601 UTC creation time.
updated_atstringISO 8601 UTC last modification time.
statsobjectCumulative runtime statistics.
stats.open_positionsintegerNumber of currently open positions.
stats.total_pnlstringRealized + unrealized PnL in quote currency, decimal string.
stats.total_tradesintegerLifetime number of closed trades.
stats.win_ratestringFraction of winning trades, decimal string in [0, 1].

Errors

  • 404 NOT_FOUND — strategy does not exist or is not owned by the caller.

See Errors for the full list.

Example

curl "https://api.pipai.example/v1/strategies/strat_8f2a1b" \
-H "X-PipAI-API-Key: $API_KEY" \
-H "X-PipAI-Timestamp: $TS" \
-H "X-PipAI-Signature: $SIG"