@qtsurfer/api-client
    Preparing search index...

    Type Alias LiveRun

    A live run's full state, as returned by starting, reading, or stopping it through its strategy.

    type LiveRun = {
        description?: string;
        desired: "RUNNING" | "STOPPED";
        gate?: { [key: string]: unknown };
        name?: string;
        params: { [key: string]: unknown };
        paramsVersion: number;
        reason?: string;
        relay: boolean;
        runId: string;
        sources: LiveSource[];
        stage: "SANDBOX" | "LIVE";
        startedAtMs: number;
        state: string;
        strategyId: StrategyId;
        visibility: "private" | "public";
    }
    Index
    description? desired gate? name? params paramsVersion reason? relay runId sources stage startedAtMs state strategyId visibility
    description?: string
    desired: "RUNNING" | "STOPPED"

    What you last asked for. state can lag this briefly after DELETE.

    gate?: { [key: string]: unknown }

    The sandbox trial's promotion verdict, once one exists. Shape is not yet stabilized as public API — treat as opaque diagnostics.

    name?: string
    params: { [key: string]: unknown }
    paramsVersion: number

    Increments on every accepted PUT .../params call, including one that resends the current values.

    reason?: string

    Present only when the run stopped because it exceeded its resource allowance.

    relay: boolean

    Whether this run's signals are being relayed over the WebSocket channel described in the "Live execution" guide, right now. This is the effective value — false on a sandbox run regardless of what was requested at start; matches the requested value once stage reaches live.

    runId: string

    This run's own id — its canonical identity for PATCH/PUT .../params and for GET /live/public.

    sources: LiveSource[]
    stage: "SANDBOX" | "LIVE"

    A new run always starts SANDBOX — a trial run compared against a second execution for agreement — and moves to LIVE once it passes.

    startedAtMs: number

    Epoch milliseconds.

    state: string

    STARTING until first observed running; otherwise the runner's own reported state (e.g. RUNNING).

    strategyId: StrategyId
    visibility: "private" | "public"

    Settings
    Member Visibility

    On This Page
    Properties