Superior Trade Suite v2

Start or stop a deployment via PUT /v2/deployment/{id}/status. Action 'start' begins the bot (live if credentials stored, paper if not). Action 'stop' halts the bot — platform automatically cancels all open orders and closes all positions on Hyperliquid before stopping. Returns {id, status, previous_status}. WRITE operation — requires Steward confirmation before starting. Errors: 401, 404.

Create a new backtest via POST /v2/backtesting. Submits strategy code and trading configuration. Timerange is auto-selected by the API (picks suitable duration based on timeframe, starting from earliest available candle data). Returns {id, status: 'pending', message}. Must call SuperiorTrade_StartBacktest to begin execution. Response 201. Errors: 400 validation_failed (check details array), 400 invalid_code, 400 limit_exceeded (max 10 — delete completed/failed backtests first via DELETE /v2/backtesting/{id}), 401.

Create a trading bot deployment via POST /v2/deployment. Returns {id, config, code, name, replicas, status: 'pending', deployment_name, created_at}. Without credentials the bot runs in dry-run/paper mode. WRITE operation — requires Steward confirmation. Errors: 400 validation_failed, 400 invalid_code, 400 limit_exceeded (max 10), 401.

Cancel (if running) and delete a backtest via DELETE /v2/backtesting/{id}. Permanent removal. Returns {message: 'Backtest deleted'}. WRITE operation — requires Steward confirmation. Errors: 401, 404.

Delete a deployment via DELETE /v2/deployment/{id}. Closes all positions and orders on Hyperliquid before deleting. Returns {message: 'Deployment deleted'}. Deleting stopped deployments may return 500 — safe to ignore. Permanent removal. WRITE operation — requires Steward confirmation. Errors: 401, 404.

Close all open orders and liquidate all positions for a deployment via POST /v2/deployment/{id}/exit. Deployment MUST be stopped first (use SuperiorTrade_ControlDeployment stop). Returns {id, status, orders_cancelled, positions_closed}. WRITE operation — requires Steward confirmation. Errors: 400 invalid_request (deployment still running or credentials missing), 401, 404.

Retrieve full backtest details via GET /v2/backtesting/{id}. Returns id, config, code, status, results, result_url (signed URL valid 7 days for detailed trade JSON), started_at, completed_at, job_name, created_at, updated_at. All timestamps UTC ISO8601. Always download result_url for comprehensive analysis. Errors: 401, 404.

Check whether historical candle data is available for a given exchange + pair + timeframe via GET /v2/backtesting-data/{exchange}?pair={pair}&timeframe={timeframe}. Used by DEX-style exchanges (e.g., Aerodrome) where data coverage is not pre-known. Returns {available: boolean, pair, timeframe, from (ISO8601 UTC, earliest candle), to (ISO8601 UTC, latest candle), candles: integer (count available)}. Always call this BEFORE SuperiorTrade_CreateBacktest for Aerodrome — if available is false or candles is below the strategy's startup_candle_count, abort and inform the Steward. Public-style endpoint but still gated by x-api-key. Errors: 400 unsupported_exchange (exchange enum not recognized), 400 invalid_pair, 400 invalid_timeframe, 401, 404 no_data.

Poll backtest status via GET /v2/backtesting/{id}/status. Returns {id, status, results}. Status values: 'pending', 'running', 'completed', 'failed'. results is null while running — use SuperiorTrade_GetBacktest for full details including result_url. Poll every ~10 seconds; typical completion 1-10 minutes. Errors: 401, 404.

View credential info for a deployment via GET /v2/deployment/{id}/credentials. Does NOT return private keys. Returns {id, credentials_status, exchange, wallet_address, wallet_source ('main_trading_wallet'|'provided'), wallet_type ('main_wallet'|'agent_wallet'), agent_wallet_address}. If missing: {credentials_status: 'missing'}. wallet_type indicates whether the returned wallet_address is a main_wallet or agent_wallet. Auto-resolved credentials (wallet_source 'main_trading_wallet') can return wallet_type 'agent_wallet' — this is the signing wallet, NOT the funded main wallet. If wallet_type is 'agent_wallet', the funded main wallet address is not available via this endpoint — ask the Steward for their main wallet address from their dashboard at https://account.superior.trade. The agent wallet having $0 is normal. For balance checks, always use the MAIN wallet address (not the agent wallet). Errors: 401, 404.

Retrieve full deployment details via GET /v2/deployment/{id}. Returns id, config, code, name, replicas, status, pods (name/status/restarts), credentials_status ('stored'|'missing'), exchange, deployment_name, namespace, created_at, updated_at. All timestamps UTC. Errors: 401, 404.

Poll deployment status via GET /v2/deployment/{id}/status. Returns {id, status, replicas, available_replicas, pods}. Status values: 'pending', 'running', 'stopped'. Errors: 401, 404.

Retrieve logs for a backtest or deployment via GET /v2/backtesting/{id}/logs or GET /v2/deployment/{id}/logs. Returns {items: [{timestamp, message, severity}], nextCursor}. All timestamps UTC. Heartbeat messages are normal. Errors: 401, 404.

List all backtests via GET /v2/backtesting. Returns {items, nextCursor}. Pass cursor query param to paginate. Errors: 401.

List all deployments via GET /v2/deployment. Returns {items, nextCursor}. Pass cursor query param to paginate. Errors: 401.

Start a pending backtest via PUT /v2/backtesting/{id}/status with {action: 'start'}. Only 'start' is supported — to cancel, use SuperiorTrade_DeleteBacktest instead. Returns {id, status: 'running', previous_status, job_name}. Errors: 401, 404.

Store exchange credentials for a deployment via POST /v2/deployment/{id}/credentials. Enables live trading. Server resolves wallet automatically — do NOT send private_key (API rejects it). Input wallet_address is optional — if provided, specifies which wallet to use (ownership validated server-side); if omitted, server assigns the user's platform-managed main wallet. Response returns {id, credentials_status: 'stored', exchange, wallet_address, wallet_source, agent_wallet_address, updated_at}. IMPORTANT: wallet_address in the RESPONSE is the signing wallet (agent wallet) that signs trades — it does NOT need its own funds, it trades against the main wallet's balance. Do NOT confuse response wallet_address (agent/signing wallet) with the main wallet (where funds live). IDEMPOTENT — won't overwrite existing credentials. Credential update procedure: (1) stop deployment, (2) delete deployment, (3) create new deployment with same config/code, (4) store new credentials. WRITE operation — requires Steward confirmation with real-money warning. Errors: 400 invalid_request (if private_key sent), 400 invalid_wallet_address, 400 duplicate_wallet_address, 400 unsupported_exchange, 400 no_wallet_available, 403 wallet_not_owned, 401, 500 server_misconfigured.