@qtsurfer/api-client 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -153,6 +153,34 @@ type Exchange = {
  * Managed exchange data sources available for backtesting.
  */
 type DataSourceType = 'ticker';
+type PrepareRequest = {
+    instrument: Instrument;
+    /**
+     * Start date for the preparation process. Supports the following formats:
+     * - ISO-8601 (e.g. 2024-12-14T23:59:59Z)
+     * - ISO DATE (e.g. 2024-12-14)
+     * - BASIC ISO DATE (e.g., 20241214)
+     *
+     */
+    from: string;
+    /**
+     * End date for the preparation process. Supports the following formats:
+     * - ISO-8601 (e.g. 2024-12-14T23:59:59Z)
+     * - ISO DATE (e.g. 2024-12-14)
+     * - BASIC ISO DATE (e.g., 20241214)
+     *
+     */
+    to: string;
+    /**
+     * Output bar cadence for the prepared range. Defaults to the publisher's
+     * native cadence (`1s`); coarser cadences are produced on demand via
+     * resampling and stored alongside the native blob in cache. Coarser-than-
+     * source values must be exact multiples of the source cadence — invalid
+     * labels return `400`.
+     *
+     */
+    cadence?: '1s' | '5s' | '1m' | '5m' | '15m' | '1h' | '4h' | '1d';
+};
 /**
  * Information about a single job
  */
@@ -245,6 +273,123 @@ type PrepareJobState = JobState & {
         rationale?: 'pending_conversion' | 'low_activity' | 'unknown';
     }>;
 };
+/**
+ * A numeric range or an explicit list of values for one strategy property.
+ */
+type SweepAxis = {
+    from: number;
+    to: number;
+    step: number;
+} | {
+    values: Array<number | boolean>;
+};
+type SweepSpecRequest = {
+    sampler?: 'grid' | 'random' | 'lhs';
+    /**
+     * Reproducibility seed. If omitted, the server generates one with Java's
+     * `L64X128MixRandom` generator and returns the effective value. The range
+     * is limited to JavaScript-safe integers so generated clients can replay it exactly.
+     *
+     */
+    seed?: number;
+    /**
+     * Number of samples for `random` and `lhs`; ignored by `grid`.
+     */
+    samples?: number;
+    objective?: 'sharpe' | 'sortino' | 'pnl' | 'maxdd';
+    params: {
+        [key: string]: SweepAxis;
+    };
+};
+type SweepBaseConfig = {
+    initialFunding?: number;
+    feeRate?: number;
+    buyFeeRate?: number;
+    sellFeeRate?: number;
+    feeLeg?: 'RECEIVED' | 'QUOTE' | 'BASE';
+    percentAmountToLock?: number;
+};
+type ExecuteSweepRequest = {
+    strategyId: StrategyId;
+    sweep: SweepSpecRequest;
+    baseConfig?: SweepBaseConfig;
+    /**
+     * Store signals for every trial. Keep false for normal sweeps.
+     */
+    storeSignals?: boolean;
+    /**
+     * Requested horizontal shard count; 0 or omitted selects automatically.
+     */
+    shards?: number;
+    /**
+     * Trials below this trade count are flagged but remain in the results.
+     */
+    minTradeFloor?: number;
+};
+type ExecuteSweepAccepted = {
+    sweepId: string;
+    requestId: string;
+    totalRuns: number;
+    shards: number;
+    /**
+     * Effective seed used to expand the sweep.
+     */
+    seed: number;
+    /**
+     * False when an identical sweep already exists and was not enqueued again.
+     */
+    queued: boolean;
+};
+type SweepProgress = {
+    done: number;
+    total: number;
+    aborted: number;
+    shardCount: number;
+    pendingShards: number;
+};
+type SweepRunRow = {
+    /**
+     * Deterministic zero-based expansion index, stable across shards and ranking.
+     */
+    runIx: number;
+    /**
+     * Present only in the `ranked` view.
+     */
+    rank?: number;
+    params: {
+        [key: string]: unknown;
+    };
+    sharpe: number;
+    sortino: number;
+    /**
+     * Absolute net PnL in the output currency.
+     */
+    pnl: number;
+    pnlPct: number;
+    cagr: number;
+    maxDdPct: number;
+    trades: number;
+    winRate: number;
+    belowTradeFloor: boolean;
+    aborted: boolean;
+    runtimeMs: number;
+};
+type ExecuteSweepResult = {
+    sweepId: string;
+    status: 'RUNNING' | 'COMPLETED' | 'PARTIAL' | 'CANCELLED';
+    objective: 'sharpe' | 'sortino' | 'pnl' | 'maxdd';
+    order: 'ranked' | 'natural';
+    progress: SweepProgress;
+    /**
+     * Total result rows currently available.
+     */
+    leaderboardSize: number;
+    /**
+     * True only when the ranked view exceeds its display limit.
+     */
+    truncated: boolean;
+    leaderboard: Array<SweepRunRow>;
+};
 /**
  * Response returned by async endpoints (`202 Accepted`). The `jobId` is deterministic for the
  * same input parameters — repeated calls with identical params return the same id.
@@ -400,13 +545,13 @@ type AuthTokenError = {
      */
     message: string;
 };
-type AuthData = {
+type AuthenticateData = {
     body?: never;
     path?: never;
     query?: never;
     url: '/auth/token';
 };
-type AuthErrors = {
+type AuthenticateErrors = {
     /**
      * API key is invalid, revoked, or expired.
      */
@@ -416,28 +561,28 @@ type AuthErrors = {
      */
     429: unknown;
 };
-type AuthError = AuthErrors[keyof AuthErrors];
-type AuthResponses = {
+type AuthenticateError = AuthenticateErrors[keyof AuthenticateErrors];
+type AuthenticateResponses = {
     /**
      * API key accepted; JWT returned.
      */
     200: AuthTokenResponse;
 };
-type AuthResponse = AuthResponses[keyof AuthResponses];
-type GetExchangesData = {
+type AuthenticateResponse = AuthenticateResponses[keyof AuthenticateResponses];
+type ListExchangesData = {
     body?: never;
     path?: never;
     query?: never;
     url: '/exchanges';
 };
-type GetExchangesResponses = {
+type ListExchangesResponses = {
     /**
      * A JSON array of Exchanges
      */
     200: Array<Exchange>;
 };
-type GetExchangesResponse = GetExchangesResponses[keyof GetExchangesResponses];
-type GetInstrumentsData = {
+type ListExchangesResponse = ListExchangesResponses[keyof ListExchangesResponses];
+type ListInstrumentsData = {
     body?: never;
     path: {
         /**
@@ -448,21 +593,21 @@ type GetInstrumentsData = {
     query?: never;
     url: '/exchange/{exchangeId}/instruments';
 };
-type GetInstrumentsErrors = {
+type ListInstrumentsErrors = {
     /**
      * Exchange not found or instrument catalog not available
      */
     404: ResponseError;
 };
-type GetInstrumentsError = GetInstrumentsErrors[keyof GetInstrumentsErrors];
-type GetInstrumentsResponses = {
+type ListInstrumentsError = ListInstrumentsErrors[keyof ListInstrumentsErrors];
+type ListInstrumentsResponses = {
     /**
      * The default (spot) segment's instruments in `data`, `meta`, and HAL `_links` (self + spot/futures segment discovery)
      */
     200: InstrumentListResponse;
 };
-type GetInstrumentsResponse = GetInstrumentsResponses[keyof GetInstrumentsResponses];
-type GetSegmentInstrumentsData = {
+type ListInstrumentsResponse = ListInstrumentsResponses[keyof ListInstrumentsResponses];
+type ListSegmentInstrumentsData = {
     body?: never;
     path: {
         /**
@@ -477,21 +622,21 @@ type GetSegmentInstrumentsData = {
     query?: never;
     url: '/exchange/{exchangeId}/{segment}/instruments';
 };
-type GetSegmentInstrumentsErrors = {
+type ListSegmentInstrumentsErrors = {
     /**
      * Exchange, segment, or instrument catalog not found
      */
     404: ResponseError;
 };
-type GetSegmentInstrumentsError = GetSegmentInstrumentsErrors[keyof GetSegmentInstrumentsErrors];
-type GetSegmentInstrumentsResponses = {
+type ListSegmentInstrumentsError = ListSegmentInstrumentsErrors[keyof ListSegmentInstrumentsErrors];
+type ListSegmentInstrumentsResponses = {
     /**
      * An object with a `data` array of instrument details (each with per-data-type coverage) and a `meta` block
      */
     200: InstrumentListResponse;
 };
-type GetSegmentInstrumentsResponse = GetSegmentInstrumentsResponses[keyof GetSegmentInstrumentsResponses];
-type GetExchangeTickersHourData = {
+type ListSegmentInstrumentsResponse = ListSegmentInstrumentsResponses[keyof ListSegmentInstrumentsResponses];
+type DownloadTickersData = {
     body?: never;
     path: {
         /**
@@ -524,7 +669,7 @@ type GetExchangeTickersHourData = {
     };
     url: '/exchange/{exchangeId}/tickers/{base}/{quote}';
 };
-type GetExchangeTickersHourErrors = {
+type DownloadTickersErrors = {
     /**
      * Missing or malformed parameters (e.g. `hour` not `YYYY-MM-DDTHH`).
      */
@@ -538,8 +683,8 @@ type GetExchangeTickersHourErrors = {
      */
     500: ResponseError;
 };
-type GetExchangeTickersHourError = GetExchangeTickersHourErrors[keyof GetExchangeTickersHourErrors];
-type GetExchangeTickersHourResponses = {
+type DownloadTickersError = DownloadTickersErrors[keyof DownloadTickersErrors];
+type DownloadTickersResponses = {
     /**
      * One hour of tickers for the instrument. `Content-Type` is
      * `application/vnd.lastra` by default or
@@ -549,8 +694,8 @@ type GetExchangeTickersHourResponses = {
      */
     200: Blob | File;
 };
-type GetExchangeTickersHourResponse = GetExchangeTickersHourResponses[keyof GetExchangeTickersHourResponses];
-type GetExchangeKlinesHourData = {
+type DownloadTickersResponse = DownloadTickersResponses[keyof DownloadTickersResponses];
+type DownloadKlinesData = {
     body?: never;
     path: {
         /**
@@ -582,7 +727,7 @@ type GetExchangeKlinesHourData = {
     };
     url: '/exchange/{exchangeId}/klines/{base}/{quote}';
 };
-type GetExchangeKlinesHourErrors = {
+type DownloadKlinesErrors = {
     /**
      * Missing or malformed parameters (e.g. `hour` not `YYYY-MM-DDTHH`).
      */
@@ -596,8 +741,8 @@ type GetExchangeKlinesHourErrors = {
      */
     500: ResponseError;
 };
-type GetExchangeKlinesHourError = GetExchangeKlinesHourErrors[keyof GetExchangeKlinesHourErrors];
-type GetExchangeKlinesHourResponses = {
+type DownloadKlinesError = DownloadKlinesErrors[keyof DownloadKlinesErrors];
+type DownloadKlinesResponses = {
     /**
      * One hour of klines for the instrument. `Content-Type` is
      * `application/vnd.lastra` by default or
@@ -606,8 +751,8 @@ type GetExchangeKlinesHourResponses = {
      */
     200: Blob | File;
 };
-type GetExchangeKlinesHourResponse = GetExchangeKlinesHourResponses[keyof GetExchangeKlinesHourResponses];
-type PostStrategyData = {
+type DownloadKlinesResponse = DownloadKlinesResponses[keyof DownloadKlinesResponses];
+type CompileStrategyData = {
     /**
      * Raw strategy Java source code
      */
@@ -622,14 +767,14 @@ type PostStrategyData = {
     query?: never;
     url: '/strategy';
 };
-type PostStrategyErrors = {
+type CompileStrategyErrors = {
     /**
      * Invalid strategy (compilation error)
      */
     400: ResponseError;
 };
-type PostStrategyError = PostStrategyErrors[keyof PostStrategyErrors];
-type PostStrategyResponses = {
+type CompileStrategyError = CompileStrategyErrors[keyof CompileStrategyErrors];
+type CompileStrategyResponses = {
     /**
      * Strategy compiled successfully (sync mode)
      */
@@ -641,8 +786,8 @@ type PostStrategyResponses = {
      */
     202: AcceptedJob;
 };
-type PostStrategyResponse = PostStrategyResponses[keyof PostStrategyResponses];
-type GetStrategyStatusData = {
+type CompileStrategyResponse = CompileStrategyResponses[keyof CompileStrategyResponses];
+type GetStrategyData = {
     body?: never;
     path: {
         /**
@@ -653,14 +798,14 @@ type GetStrategyStatusData = {
     query?: never;
     url: '/strategy/{strategyId}';
 };
-type GetStrategyStatusErrors = {
+type GetStrategyErrors = {
     /**
      * Strategy compile job not found
      */
     404: ResponseError;
 };
-type GetStrategyStatusError = GetStrategyStatusErrors[keyof GetStrategyStatusErrors];
-type GetStrategyStatusResponses = {
+type GetStrategyError = GetStrategyErrors[keyof GetStrategyErrors];
+type GetStrategyResponses = {
     /**
      * Strategy compile state
      */
@@ -677,39 +822,12 @@ type GetStrategyStatusResponses = {
         statusDetail?: string | null;
     };
 };
-type GetStrategyStatusResponse = GetStrategyStatusResponses[keyof GetStrategyStatusResponses];
-type PrepareBacktestingData = {
+type GetStrategyResponse = GetStrategyResponses[keyof GetStrategyResponses];
+type PrepareBacktestData = {
     /**
      * The required data to prepare a backtesting
      */
-    body: {
-        instrument: Instrument;
-        /**
-         * Start date for the preparation process. Supports the following formats:
-         * - ISO-8601 (e.g. 2024-12-14T23:59:59Z)
-         * - ISO DATE (e.g. 2024-12-14)
-         * - BASIC ISO DATE (e.g., 20241214)
-         *
-         */
-        from: string;
-        /**
-         * End date for the preparation process. Supports the following formats:
-         * - ISO-8601 (e.g. 2024-12-14T23:59:59Z)
-         * - ISO DATE (e.g. 2024-12-14)
-         * - BASIC ISO DATE (e.g., 20241214)
-         *
-         */
-        to: string;
-        /**
-         * Output bar cadence for the prepared range. Defaults to the publisher's
-         * native cadence (`1s`); coarser cadences are produced on demand via
-         * resampling and stored alongside the native blob in cache. Coarser-than-
-         * source values must be exact multiples of the source cadence — invalid
-         * labels return `400`.
-         *
-         */
-        cadence?: '1s' | '5s' | '1m' | '5m' | '15m' | '1h' | '4h' | '1d';
-    };
+    body: PrepareRequest;
     path: {
         /**
          * ID of the exchange to prepare the backtesting for
@@ -723,7 +841,7 @@ type PrepareBacktestingData = {
     query?: never;
     url: '/backtest/{exchangeId}/{type}/prepare';
 };
-type PrepareBacktestingErrors = {
+type PrepareBacktestErrors = {
     /**
      * Invalid request or parameters. Also returned when `from` is older than the configured
      * lookback window or `to` is in the future.
@@ -741,15 +859,15 @@ type PrepareBacktestingErrors = {
      */
     429: ResponseError;
 };
-type PrepareBacktestingError = PrepareBacktestingErrors[keyof PrepareBacktestingErrors];
-type PrepareBacktestingResponses = {
+type PrepareBacktestError = PrepareBacktestErrors[keyof PrepareBacktestErrors];
+type PrepareBacktestResponses = {
     /**
      * Prepare task accepted (queued for processing)
      */
     202: AcceptedJob;
 };
-type PrepareBacktestingResponse = PrepareBacktestingResponses[keyof PrepareBacktestingResponses];
-type GetPreparationStatusData = {
+type PrepareBacktestResponse = PrepareBacktestResponses[keyof PrepareBacktestResponses];
+type GetPrepareStatusData = {
     body?: never;
     path: {
         /**
@@ -768,7 +886,7 @@ type GetPreparationStatusData = {
     query?: never;
     url: '/backtest/{exchangeId}/{type}/prepare/{jobId}';
 };
-type GetPreparationStatusErrors = {
+type GetPrepareStatusErrors = {
     /**
      * Invalid request or parameters
      */
@@ -778,15 +896,109 @@ type GetPreparationStatusErrors = {
      */
     404: ResponseError;
 };
-type GetPreparationStatusError = GetPreparationStatusErrors[keyof GetPreparationStatusErrors];
-type GetPreparationStatusResponses = {
+type GetPrepareStatusError = GetPrepareStatusErrors[keyof GetPrepareStatusErrors];
+type GetPrepareStatusResponses = {
     /**
      * Current prepare job state
      */
     200: PrepareJobState;
 };
-type GetPreparationStatusResponse = GetPreparationStatusResponses[keyof GetPreparationStatusResponses];
-type ExecuteBacktestingData = {
+type GetPrepareStatusResponse = GetPrepareStatusResponses[keyof GetPrepareStatusResponses];
+type ExecuteSweepData = {
+    body: ExecuteSweepRequest;
+    path: {
+        exchangeId: string;
+        type: DataSourceType;
+        /**
+         * Job ID returned by `POST /backtest/{exchangeId}/{type}/prepare`.
+         */
+        requestId: string;
+    };
+    query?: never;
+    url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}';
+};
+type ExecuteSweepErrors = {
+    /**
+     * Invalid sweep specification or the expanded grid exceeds the server limit.
+     */
+    400: ResponseError;
+    /**
+     * Prepared request not found or expired.
+     */
+    404: ResponseError;
+    /**
+     * Sweep queue or user concurrency limit reached.
+     */
+    429: ResponseError;
+};
+type ExecuteSweepError = ExecuteSweepErrors[keyof ExecuteSweepErrors];
+type ExecuteSweepResponses = {
+    /**
+     * Sweep accepted. The effective seed is returned for reproducibility.
+     */
+    202: ExecuteSweepAccepted;
+};
+type ExecuteSweepResponse = ExecuteSweepResponses[keyof ExecuteSweepResponses];
+type CancelSweepData = {
+    body?: never;
+    path: {
+        exchangeId: string;
+        type: DataSourceType;
+        requestId: string;
+        sweepId: string;
+    };
+    query?: never;
+    url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}';
+};
+type CancelSweepErrors = {
+    /**
+     * Sweep not found.
+     */
+    404: ResponseError;
+};
+type CancelSweepError = CancelSweepErrors[keyof CancelSweepErrors];
+type CancelSweepResponses = {
+    /**
+     * Cancellation requested.
+     */
+    200: {
+        status: 'cancelling';
+        sweepId: string;
+    };
+};
+type CancelSweepResponse = CancelSweepResponses[keyof CancelSweepResponses];
+type GetSweepResultData = {
+    body?: never;
+    path: {
+        exchangeId: string;
+        type: DataSourceType;
+        requestId: string;
+        sweepId: string;
+    };
+    query?: {
+        objective?: 'sharpe' | 'sortino' | 'pnl' | 'maxdd';
+        /**
+         * `natural` is stable materialisation order; `ranked` is the display view.
+         */
+        order?: 'ranked' | 'natural';
+    };
+    url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}';
+};
+type GetSweepResultErrors = {
+    /**
+     * Sweep not found or expired.
+     */
+    404: ResponseError;
+};
+type GetSweepResultError = GetSweepResultErrors[keyof GetSweepResultErrors];
+type GetSweepResultResponses = {
+    /**
+     * Current sweep snapshot and all currently available result rows for the selected view.
+     */
+    200: ExecuteSweepResult;
+};
+type GetSweepResultResponse = GetSweepResultResponses[keyof GetSweepResultResponses];
+type ExecuteBacktestData = {
     /**
      * Execute task parameters
      */
@@ -816,7 +1028,7 @@ type ExecuteBacktestingData = {
     query?: never;
     url: '/backtest/{exchangeId}/{type}/execute';
 };
-type ExecuteBacktestingErrors = {
+type ExecuteBacktestErrors = {
     /**
      * Invalid request or parameters
      */
@@ -830,15 +1042,15 @@ type ExecuteBacktestingErrors = {
      */
     429: ResponseError;
 };
-type ExecuteBacktestingError = ExecuteBacktestingErrors[keyof ExecuteBacktestingErrors];
-type ExecuteBacktestingResponses = {
+type ExecuteBacktestError = ExecuteBacktestErrors[keyof ExecuteBacktestErrors];
+type ExecuteBacktestResponses = {
     /**
      * Execute task accepted (queued for processing)
      */
     202: AcceptedJob;
 };
-type ExecuteBacktestingResponse = ExecuteBacktestingResponses[keyof ExecuteBacktestingResponses];
-type CancelExecutionData = {
+type ExecuteBacktestResponse = ExecuteBacktestResponses[keyof ExecuteBacktestResponses];
+type CancelBacktestData = {
     body?: never;
     path: {
         exchangeId: string;
@@ -851,14 +1063,14 @@ type CancelExecutionData = {
     query?: never;
     url: '/backtest/{exchangeId}/{type}/execute/{jobId}';
 };
-type CancelExecutionErrors = {
+type CancelBacktestErrors = {
     /**
      * Execution not found
      */
     404: ResponseError;
 };
-type CancelExecutionError = CancelExecutionErrors[keyof CancelExecutionErrors];
-type CancelExecutionResponses = {
+type CancelBacktestError = CancelBacktestErrors[keyof CancelBacktestErrors];
+type CancelBacktestResponses = {
     /**
      * Cancellation request accepted
      */
@@ -867,8 +1079,8 @@ type CancelExecutionResponses = {
         jobId?: string;
     };
 };
-type CancelExecutionResponse = CancelExecutionResponses[keyof CancelExecutionResponses];
-type GetExecutionResultData = {
+type CancelBacktestResponse = CancelBacktestResponses[keyof CancelBacktestResponses];
+type GetBacktestResultData = {
     body?: never;
     path: {
         /**
@@ -887,7 +1099,7 @@ type GetExecutionResultData = {
     query?: never;
     url: '/backtest/{exchangeId}/{type}/execute/{jobId}';
 };
-type GetExecutionResultErrors = {
+type GetBacktestResultErrors = {
     /**
      * Invalid request or parameters
      */
@@ -897,14 +1109,29 @@ type GetExecutionResultErrors = {
      */
     404: ResponseError;
 };
-type GetExecutionResultError = GetExecutionResultErrors[keyof GetExecutionResultErrors];
-type GetExecutionResultResponses = {
+type GetBacktestResultError = GetBacktestResultErrors[keyof GetBacktestResultErrors];
+type GetBacktestResultResponses = {
     /**
      * Backtesting execution result
      */
     200: BacktestJobResult;
+    /**
+     * The job is known but its result is not readable yet — keep polling.
+     *
+     * Returned in two situations, both of which mean "ask again", never "you are done":
+     * the job has not produced its result yet, or the job reached a terminal status while
+     * its stored result could not be read back. The response body is an empty object: it
+     * deliberately carries no `state`, so a client cannot mistake it for a finished result.
+     *
+     * Treat any `202` as a signal to continue the poll loop under your existing timeout.
+     * Never treat it as a terminal outcome.
+     *
+     */
+    202: {
+        [key: string]: never;
+    };
 };
-type GetExecutionResultResponse = GetExecutionResultResponses[keyof GetExecutionResultResponses];
+type GetBacktestResultResponse = GetBacktestResultResponses[keyof GetBacktestResultResponses];
 type ClientOptions = {
     baseUrl: 'https://api.staging.qtsurfer.com/v1' | 'https://api.qtsurfer.com/v1' | (string & {});
 };
@@ -934,29 +1161,29 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
  * before expiry (or on a `401` response) by calling this endpoint again.
  *
  */
-declare const auth: <ThrowOnError extends boolean = false>(options?: Options<AuthData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AuthTokenResponse, unknown, ThrowOnError>;
+declare const authenticate: <ThrowOnError extends boolean = false>(options?: Options<AuthenticateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AuthTokenResponse, unknown, ThrowOnError>;
 /**
- * Get a list of available exchanges
+ * List the available exchanges
  */
-declare const getExchanges: <ThrowOnError extends boolean = false>(options?: Options<GetExchangesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Exchange[], unknown, ThrowOnError>;
+declare const listExchanges: <ThrowOnError extends boolean = false>(options?: Options<ListExchangesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Exchange[], unknown, ThrowOnError>;
 /**
- * Get an exchange's instruments (default spot segment)
+ * List an exchange's instruments (default spot segment)
  * "Give me binance instruments" — returns the exchange's DEFAULT segment (`spot`)
  * in `data`, each instrument with per-data-type coverage and market info. `meta`
  * confirms the served `segment` (`spot`); HAL `_links` carry `self` plus the
  * `spot` / `futures` segment-discovery links.
  *
  */
-declare const getInstruments: <ThrowOnError extends boolean = false>(options: Options<GetInstrumentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstrumentListResponse, ResponseError, ThrowOnError>;
+declare const listInstruments: <ThrowOnError extends boolean = false>(options: Options<ListInstrumentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstrumentListResponse, ResponseError, ThrowOnError>;
 /**
- * Get the instruments for a specific exchange segment
+ * List an exchange segment's instruments
  * Returns the instruments for one market segment of the exchange, each with
  * per-data-type coverage and market info. HAL `_links` carry `self` plus the
  * `spot` / `futures` segment-discovery links; the default-segment shortcut is
  * `GET /exchange/{exchangeId}/instruments` (spot).
  *
  */
-declare const getSegmentInstruments: <ThrowOnError extends boolean = false>(options: Options<GetSegmentInstrumentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstrumentListResponse, ResponseError, ThrowOnError>;
+declare const listSegmentInstruments: <ThrowOnError extends boolean = false>(options: Options<ListSegmentInstrumentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InstrumentListResponse, ResponseError, ThrowOnError>;
 /**
  * Download one hour of tickers for an instrument as a Lastra segment
  * Serves exactly one hour of raw ticker data for the given instrument on the
@@ -989,7 +1216,7 @@ declare const getSegmentInstruments: <ThrowOnError extends boolean = false>(opti
  * descriptive filename).
  *
  */
-declare const getExchangeTickersHour: <ThrowOnError extends boolean = false>(options: Options<GetExchangeTickersHourData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, ResponseError, ThrowOnError>;
+declare const downloadTickers: <ThrowOnError extends boolean = false>(options: Options<DownloadTickersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, ResponseError, ThrowOnError>;
 /**
  * Download one hour of klines for an instrument as a Lastra segment
  * Same shape and semantics as `/exchange/{exchangeId}/tickers/{base}/{quote}`,
@@ -1002,7 +1229,7 @@ declare const getExchangeTickersHour: <ThrowOnError extends boolean = false>(opt
  * per-tick payload would be too large for the window of interest.
  *
  */
-declare const getExchangeKlinesHour: <ThrowOnError extends boolean = false>(options: Options<GetExchangeKlinesHourData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, ResponseError, ThrowOnError>;
+declare const downloadKlines: <ThrowOnError extends boolean = false>(options: Options<DownloadKlinesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, ResponseError, ThrowOnError>;
 /**
  * Compile a strategy from source code
  * Submits raw strategy source for compilation. By default the call is synchronous and returns
@@ -1014,21 +1241,21 @@ declare const getExchangeKlinesHour: <ThrowOnError extends boolean = false>(opti
  * same id.
  *
  */
-declare const postStrategy: <ThrowOnError extends boolean = false>(options: Options<PostStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PostStrategyResponse, ResponseError, ThrowOnError>;
+declare const compileStrategy: <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CompileStrategyResponse, ResponseError, ThrowOnError>;
 /**
- * Get the status of an async compile task
+ * Get a strategy by id, including its compile status
  * Polls the status of a strategy compilation. Useful when the strategy was submitted with
  * `X-Compile-Async: true`. Returns the resolved `strategyId` once compilation completes.
  *
  */
-declare const getStrategyStatus: <ThrowOnError extends boolean = false>(options: Options<GetStrategyStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
+declare const getStrategy: <ThrowOnError extends boolean = false>(options: Options<GetStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
     jobId?: string;
     status: "New" | "Started" | "Completed" | "Aborted" | "Failed";
     strategyId?: StrategyId;
     statusDetail?: string | null;
 }, ResponseError, ThrowOnError>;
 /**
- * Prepare backtesting data
+ * Prepare backtest data
  * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;
  * poll `GET /backtest/{exchangeId}/{type}/prepare/{jobId}` for completion.
  *
@@ -1036,14 +1263,38 @@ declare const getStrategyStatus: <ThrowOnError extends boolean = false>(options:
  * params do not enqueue duplicate work — they reuse the existing job.
  *
  */
-declare const prepareBacktesting: <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AcceptedJob, ResponseError, ThrowOnError>;
+declare const prepareBacktest: <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AcceptedJob, ResponseError, ThrowOnError>;
 /**
  * Get the status of a prepare job
  * Retrieves the current state of the prepare job identified by `jobId`.
  * Poll until `status` is `Completed`, `Failed`, or `Aborted`.
  *
  */
-declare const getPreparationStatus: <ThrowOnError extends boolean = false>(options: Options<GetPreparationStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PrepareJobState, ResponseError, ThrowOnError>;
+declare const getPrepareStatus: <ThrowOnError extends boolean = false>(options: Options<GetPrepareStatusData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PrepareJobState, ResponseError, ThrowOnError>;
+/**
+ * Execute a parameter sweep over prepared data
+ * Runs a parameter matrix over the single immutable dataset identified by `requestId`.
+ * The backend expands and executes the matrix internally; clients poll the returned
+ * `sweepId` for incremental results.
+ *
+ */
+declare const executeSweep: <ThrowOnError extends boolean = false>(options: Options<ExecuteSweepData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ExecuteSweepAccepted, ResponseError, ThrowOnError>;
+/**
+ * Cancel a running parameter sweep
+ * Requests cancellation between parameter vectors. Completed rows remain readable.
+ */
+declare const cancelSweep: <ThrowOnError extends boolean = false>(options: Options<CancelSweepData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
+    status: "cancelling";
+    sweepId: string;
+}, ResponseError, ThrowOnError>;
+/**
+ * Get sweep progress and results
+ * Returns incremental sweep progress. The default `ranked` view sorts and may truncate the
+ * display leaderboard. `order=natural` returns every available row, untruncated, ordered by
+ * deterministic `runIx`; use that view when materialising durable trial rows.
+ *
+ */
+declare const getSweepResult: <ThrowOnError extends boolean = false>(options: Options<GetSweepResultData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ExecuteSweepResult, ResponseError, ThrowOnError>;
 /**
  * Execute a compiled strategy against a prepared dataset
  * Enqueues an execute task that runs the strategy identified by `strategyId` over the data
@@ -1057,7 +1308,7 @@ declare const getPreparationStatus: <ThrowOnError extends boolean = false>(optio
  * `jobId` (idempotent).
  *
  */
-declare const executeBacktesting: <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AcceptedJob, ResponseError, ThrowOnError>;
+declare const executeBacktest: <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AcceptedJob, ResponseError, ThrowOnError>;
 /**
  * Cancel a running backtest execution
  * Requests cancellation of the specified execution. The execution
@@ -1066,7 +1317,7 @@ declare const executeBacktesting: <ThrowOnError extends boolean = false>(options
  * to confirm the final status.
  *
  */
-declare const cancelExecution: <ThrowOnError extends boolean = false>(options: Options<CancelExecutionData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
+declare const cancelBacktest: <ThrowOnError extends boolean = false>(options: Options<CancelBacktestData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
     status?: "cancelling";
     jobId?: string;
 }, ResponseError, ThrowOnError>;
@@ -1075,9 +1326,13 @@ declare const cancelExecution: <ThrowOnError extends boolean = false>(options: O
  * Retrieves the current state and results of the execute job identified by `jobId`.
  * Poll until `state.status` is `Completed`, `Failed`, or `Aborted`.
  *
+ * A `202` means the result is not readable yet — keep polling. It is never a terminal
+ * outcome, and it carries no `state`, so a poll loop that stops on a terminal status will
+ * not stop on it.
+ *
  */
-declare const getExecutionResult: <ThrowOnError extends boolean = false>(options: Options<GetExecutionResultData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BacktestJobResult, ResponseError, ThrowOnError>;
+declare const getBacktestResult: <ThrowOnError extends boolean = false>(options: Options<GetBacktestResultData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBacktestResultResponse, ResponseError, ThrowOnError>;
 
 declare const client: _hey_api_client_fetch.Client;
 
-export { type AcceptedJob, type AuthData, type AuthError, type AuthErrors, type AuthResponse, type AuthResponses, type AuthTokenError, type AuthTokenResponse, type BacktestJobResult, type CancelExecutionData, type CancelExecutionError, type CancelExecutionErrors, type CancelExecutionResponse, type CancelExecutionResponses, type ClientOptions, type CoverageWindow, type DataSourceType, type EquityPoint, type Exchange, type ExecuteBacktestingData, type ExecuteBacktestingError, type ExecuteBacktestingErrors, type ExecuteBacktestingResponse, type ExecuteBacktestingResponses, type GetExchangeKlinesHourData, type GetExchangeKlinesHourError, type GetExchangeKlinesHourErrors, type GetExchangeKlinesHourResponse, type GetExchangeKlinesHourResponses, type GetExchangeTickersHourData, type GetExchangeTickersHourError, type GetExchangeTickersHourErrors, type GetExchangeTickersHourResponse, type GetExchangeTickersHourResponses, type GetExchangesData, type GetExchangesResponse, type GetExchangesResponses, type GetExecutionResultData, type GetExecutionResultError, type GetExecutionResultErrors, type GetExecutionResultResponse, type GetExecutionResultResponses, type GetInstrumentsData, type GetInstrumentsError, type GetInstrumentsErrors, type GetInstrumentsResponse, type GetInstrumentsResponses, type GetPreparationStatusData, type GetPreparationStatusError, type GetPreparationStatusErrors, type GetPreparationStatusResponse, type GetPreparationStatusResponses, type GetSegmentInstrumentsData, type GetSegmentInstrumentsError, type GetSegmentInstrumentsErrors, type GetSegmentInstrumentsResponse, type GetSegmentInstrumentsResponses, type GetStrategyStatusData, type GetStrategyStatusError, type GetStrategyStatusErrors, type GetStrategyStatusResponse, type GetStrategyStatusResponses, type HalLink, type Instrument, type InstrumentCoverage, type InstrumentDetail, type InstrumentLinks, type InstrumentListMeta, type InstrumentListResponse, type JobState, type Options, type PostStrategyData, type PostStrategyError, type PostStrategyErrors, type PostStrategyResponse, type PostStrategyResponses, type PrepareBacktestingData, type PrepareBacktestingError, type PrepareBacktestingErrors, type PrepareBacktestingResponse, type PrepareBacktestingResponses, type PrepareJobState, type ResponseError, type ResultMap, type StrategyId, auth, cancelExecution, client, executeBacktesting, getExchangeKlinesHour, getExchangeTickersHour, getExchanges, getExecutionResult, getInstruments, getPreparationStatus, getSegmentInstruments, getStrategyStatus, postStrategy, prepareBacktesting };
+export { type AcceptedJob, type AuthTokenError, type AuthTokenResponse, type AuthenticateData, type AuthenticateError, type AuthenticateErrors, type AuthenticateResponse, type AuthenticateResponses, type BacktestJobResult, type CancelBacktestData, type CancelBacktestError, type CancelBacktestErrors, type CancelBacktestResponse, type CancelBacktestResponses, type CancelSweepData, type CancelSweepError, type CancelSweepErrors, type CancelSweepResponse, type CancelSweepResponses, type ClientOptions, type CompileStrategyData, type CompileStrategyError, type CompileStrategyErrors, type CompileStrategyResponse, type CompileStrategyResponses, type CoverageWindow, type DataSourceType, type DownloadKlinesData, type DownloadKlinesError, type DownloadKlinesErrors, type DownloadKlinesResponse, type DownloadKlinesResponses, type DownloadTickersData, type DownloadTickersError, type DownloadTickersErrors, type DownloadTickersResponse, type DownloadTickersResponses, type EquityPoint, type Exchange, type ExecuteBacktestData, type ExecuteBacktestError, type ExecuteBacktestErrors, type ExecuteBacktestResponse, type ExecuteBacktestResponses, type ExecuteSweepAccepted, type ExecuteSweepData, type ExecuteSweepError, type ExecuteSweepErrors, type ExecuteSweepRequest, type ExecuteSweepResponse, type ExecuteSweepResponses, type ExecuteSweepResult, type GetBacktestResultData, type GetBacktestResultError, type GetBacktestResultErrors, type GetBacktestResultResponse, type GetBacktestResultResponses, type GetPrepareStatusData, type GetPrepareStatusError, type GetPrepareStatusErrors, type GetPrepareStatusResponse, type GetPrepareStatusResponses, type GetStrategyData, type GetStrategyError, type GetStrategyErrors, type GetStrategyResponse, type GetStrategyResponses, type GetSweepResultData, type GetSweepResultError, type GetSweepResultErrors, type GetSweepResultResponse, type GetSweepResultResponses, type HalLink, type Instrument, type InstrumentCoverage, type InstrumentDetail, type InstrumentLinks, type InstrumentListMeta, type InstrumentListResponse, type JobState, type ListExchangesData, type ListExchangesResponse, type ListExchangesResponses, type ListInstrumentsData, type ListInstrumentsError, type ListInstrumentsErrors, type ListInstrumentsResponse, type ListInstrumentsResponses, type ListSegmentInstrumentsData, type ListSegmentInstrumentsError, type ListSegmentInstrumentsErrors, type ListSegmentInstrumentsResponse, type ListSegmentInstrumentsResponses, type Options, type PrepareBacktestData, type PrepareBacktestError, type PrepareBacktestErrors, type PrepareBacktestResponse, type PrepareBacktestResponses, type PrepareJobState, type PrepareRequest, type ResponseError, type ResultMap, type StrategyId, type SweepAxis, type SweepBaseConfig, type SweepProgress, type SweepRunRow, type SweepSpecRequest, authenticate, cancelBacktest, cancelSweep, client, compileStrategy, downloadKlines, downloadTickers, executeBacktest, executeSweep, getBacktestResult, getPrepareStatus, getStrategy, getSweepResult, listExchanges, listInstruments, listSegmentInstruments, prepareBacktest };