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

    Type Alias GetSweepResultData

    type GetSweepResultData = {
        body?: never;
        path: {
            exchangeId: string;
            requestId: string;
            sweepId: string;
            type: DataSourceType;
        };
        query?: {
            objective?: "sharpe"
            | "sortino"
            | "pnl"
            | "maxdd";
            order?: "ranked" | "natural";
            ranking?: "plateau" | "raw";
        };
        url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: {
        exchangeId: string;
        requestId: string;
        sweepId: string;
        type: DataSourceType;
    }

    Type Declaration

    • exchangeId: string
    • requestId: string

      The jobId returned by POST /backtest/{exchangeId}/{type}/prepare.

    • sweepId: string
    • type: DataSourceType
    query?: {
        objective?: "sharpe" | "sortino" | "pnl" | "maxdd";
        order?: "ranked" | "natural";
        ranking?: "plateau" | "raw";
    }

    Type Declaration

    • Optionalobjective?: "sharpe" | "sortino" | "pnl" | "maxdd"
    • Optionalorder?: "ranked" | "natural"

      natural is stable materialisation order; ranked is the display view.

    • Optionalranking?: "plateau" | "raw"

      How the ranked view is ordered. plateau prefers points whose neighbourhood also scores well; raw uses the objective alone. Ignored when order=natural, which is always ordered by runIx.

    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}"

    Settings
    Member Visibility

    On This Page
    Properties