@qtsurfer/api-client 0.6.0 → 0.8.0

package/src/generated/sdk.gen.ts

@@ -1,21 +1,82 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { AuthenticateData, AuthenticateResponse, AuthenticateError, ListExchangesData, ListExchangesResponse, ListInstrumentsData, ListInstrumentsResponse, ListInstrumentsError, ListSegmentInstrumentsData, ListSegmentInstrumentsResponse, ListSegmentInstrumentsError, DownloadTickersData, DownloadTickersResponse, DownloadTickersError, DownloadKlinesData, DownloadKlinesResponse, DownloadKlinesError, CompileStrategyData, CompileStrategyResponse, CompileStrategyError, GetStrategyData, GetStrategyResponse, GetStrategyError, PrepareBacktestData, PrepareBacktestResponse, PrepareBacktestError, GetPrepareStatusData, GetPrepareStatusResponse, GetPrepareStatusError, ExecuteSweepData, ExecuteSweepResponse, ExecuteSweepError, CancelSweepData, CancelSweepResponse, CancelSweepError, GetSweepResultData, GetSweepResultResponse, GetSweepResultError, ExecuteBacktestData, ExecuteBacktestResponse, ExecuteBacktestError, CancelBacktestData, CancelBacktestResponse, CancelBacktestError, GetBacktestResultData, GetBacktestResultResponse, GetBacktestResultError } from './types.gen';
-import { client as _heyApiClient } from './client.gen';
+import type {
+  Options as ClientOptions,
+  TDataShape,
+  Client,
+} from "@hey-api/client-fetch";
+import type {
+  AuthenticateData,
+  AuthenticateResponse,
+  AuthenticateError,
+  ListExchangesData,
+  ListExchangesResponse,
+  ListInstrumentsData,
+  ListInstrumentsResponse,
+  ListInstrumentsError,
+  ListSegmentInstrumentsData,
+  ListSegmentInstrumentsResponse,
+  ListSegmentInstrumentsError,
+  DownloadTickersData,
+  DownloadTickersResponse,
+  DownloadTickersError,
+  DownloadKlinesData,
+  DownloadKlinesResponse,
+  DownloadKlinesError,
+  CompileStrategyData,
+  CompileStrategyResponse,
+  CompileStrategyError,
+  ValidateStrategyData,
+  ValidateStrategyResponse,
+  ValidateStrategyError,
+  GetStrategyData,
+  GetStrategyResponse,
+  GetStrategyError,
+  PrepareBacktestData,
+  PrepareBacktestResponse,
+  PrepareBacktestError,
+  GetPrepareStatusData,
+  GetPrepareStatusResponse,
+  GetPrepareStatusError,
+  ExecuteSweepData,
+  ExecuteSweepResponse,
+  ExecuteSweepError,
+  CancelSweepData,
+  CancelSweepResponse,
+  CancelSweepError,
+  GetSweepResultData,
+  GetSweepResultResponse,
+  GetSweepResultError,
+  GetSweepSensitivityData,
+  GetSweepSensitivityResponse,
+  GetSweepSensitivityError,
+  ExecuteBacktestData,
+  ExecuteBacktestResponse,
+  ExecuteBacktestError,
+  CancelBacktestData,
+  CancelBacktestResponse,
+  CancelBacktestError,
+  GetBacktestResultData,
+  GetBacktestResultResponse,
+  GetBacktestResultError,
+} from "./types.gen";
+import { client as _heyApiClient } from "./client.gen";
 
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
-    /**
-     * You can provide a client instance returned by `createClient()` instead of
-     * individual options. This might be also useful if you want to implement a
-     * custom client.
-     */
-    client?: Client;
-    /**
-     * You can pass arbitrary values through the `meta` object. This can be
-     * used to access values that aren't defined as part of the SDK function.
-     */
-    meta?: Record<string, unknown>;
+export type Options<
+  TData extends TDataShape = TDataShape,
+  ThrowOnError extends boolean = boolean
+> = ClientOptions<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
 };
 
 /**
@@ -30,27 +91,39 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  * before expiry (or on a `401` response) by calling this endpoint again.
  *
  */
-export const authenticate = <ThrowOnError extends boolean = false>(options?: Options<AuthenticateData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).post<AuthenticateResponse, AuthenticateError, ThrowOnError>({
-        security: [
-            {
-                name: 'X-API-Key',
-                type: 'apiKey'
-            }
-        ],
-        url: '/auth/token',
-        ...options
-    });
+export const authenticate = <ThrowOnError extends boolean = false>(
+  options?: Options<AuthenticateData, ThrowOnError>
+) => {
+  return (options?.client ?? _heyApiClient).post<
+    AuthenticateResponse,
+    AuthenticateError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        name: "X-API-Key",
+        type: "apiKey",
+      },
+    ],
+    url: "/auth/token",
+    ...options,
+  });
 };
 
 /**
  * List the available exchanges
  */
-export const listExchanges = <ThrowOnError extends boolean = false>(options?: Options<ListExchangesData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).get<ListExchangesResponse, unknown, ThrowOnError>({
-        url: '/exchanges',
-        ...options
-    });
+export const listExchanges = <ThrowOnError extends boolean = false>(
+  options?: Options<ListExchangesData, ThrowOnError>
+) => {
+  return (options?.client ?? _heyApiClient).get<
+    ListExchangesResponse,
+    unknown,
+    ThrowOnError
+  >({
+    url: "/exchanges",
+    ...options,
+  });
 };
 
 /**
@@ -61,11 +134,17 @@ export const listExchanges = <ThrowOnError extends boolean = false>(options?: Op
  * `spot` / `futures` segment-discovery links.
  *
  */
-export const listInstruments = <ThrowOnError extends boolean = false>(options: Options<ListInstrumentsData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<ListInstrumentsResponse, ListInstrumentsError, ThrowOnError>({
-        url: '/exchange/{exchangeId}/instruments',
-        ...options
-    });
+export const listInstruments = <ThrowOnError extends boolean = false>(
+  options: Options<ListInstrumentsData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    ListInstrumentsResponse,
+    ListInstrumentsError,
+    ThrowOnError
+  >({
+    url: "/exchange/{exchangeId}/instruments",
+    ...options,
+  });
 };
 
 /**
@@ -76,11 +155,17 @@ export const listInstruments = <ThrowOnError extends boolean = false>(options: O
  * `GET /exchange/{exchangeId}/instruments` (spot).
  *
  */
-export const listSegmentInstruments = <ThrowOnError extends boolean = false>(options: Options<ListSegmentInstrumentsData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<ListSegmentInstrumentsResponse, ListSegmentInstrumentsError, ThrowOnError>({
-        url: '/exchange/{exchangeId}/{segment}/instruments',
-        ...options
-    });
+export const listSegmentInstruments = <ThrowOnError extends boolean = false>(
+  options: Options<ListSegmentInstrumentsData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    ListSegmentInstrumentsResponse,
+    ListSegmentInstrumentsError,
+    ThrowOnError
+  >({
+    url: "/exchange/{exchangeId}/{segment}/instruments",
+    ...options,
+  });
 };
 
 /**
@@ -115,11 +200,17 @@ export const listSegmentInstruments = <ThrowOnError extends boolean = false>(opt
  * descriptive filename).
  *
  */
-export const downloadTickers = <ThrowOnError extends boolean = false>(options: Options<DownloadTickersData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<DownloadTickersResponse, DownloadTickersError, ThrowOnError>({
-        url: '/exchange/{exchangeId}/tickers/{base}/{quote}',
-        ...options
-    });
+export const downloadTickers = <ThrowOnError extends boolean = false>(
+  options: Options<DownloadTickersData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    DownloadTickersResponse,
+    DownloadTickersError,
+    ThrowOnError
+  >({
+    url: "/exchange/{exchangeId}/tickers/{base}/{quote}",
+    ...options,
+  });
 };
 
 /**
@@ -134,59 +225,127 @@ export const downloadTickers = <ThrowOnError extends boolean = false>(options: O
  * per-tick payload would be too large for the window of interest.
  *
  */
-export const downloadKlines = <ThrowOnError extends boolean = false>(options: Options<DownloadKlinesData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<DownloadKlinesResponse, DownloadKlinesError, ThrowOnError>({
-        url: '/exchange/{exchangeId}/klines/{base}/{quote}',
-        ...options
-    });
+export const downloadKlines = <ThrowOnError extends boolean = false>(
+  options: Options<DownloadKlinesData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    DownloadKlinesResponse,
+    DownloadKlinesError,
+    ThrowOnError
+  >({
+    url: "/exchange/{exchangeId}/klines/{base}/{quote}",
+    ...options,
+  });
 };
 
 /**
- * Compile a strategy from source code
- * Submits raw strategy source for compilation. By default the call is synchronous and returns
- * the `strategyId` once compilation succeeds. Set the header `X-Compile-Async: true` to enqueue
- * the compile task and return immediately with a `jobId` — poll
- * `GET /strategy/{strategyId}` to check status.
+ * Compile and register a strategy
+ * Compiles raw strategy source and registers it, returning its `strategyId`.
  *
- * The `strategyId` is deterministic: the same source for the same user always produces the
- * same id.
+ * **This answers one question: is the source valid Java.** It compiles, registers, and hands
+ * back the id — nothing more. Whether the class can actually run is
+ * `POST /strategy/{strategyId}/validate`, and everything known about a strategy, validation
+ * included, is read from `GET /strategy/{strategyId}`. One place to ask, so there is no second
+ * answer to keep in step.
+ *
+ * The `strategyId` is derived from what the code *means*, not from how it is written. Adding a
+ * comment, inserting a blank line, re-indenting, reordering imports, or moving a method around
+ * all return the **same** id — you have not created a second strategy. Renaming a variable,
+ * changing an identifier's case, reordering fields, or reordering statements inside a method
+ * return a **different** one.
+ *
+ * Two rules follow, and they are worth designing around:
+ *
+ * - re-submitting a strategy you have only reformatted is free, and gives you back the id you
+ * already had, along with any validation already recorded against it;
+ * - the id says nothing about *behaviour*. Two sources that compute the same thing by
+ * different means are two strategies, because deciding otherwise would mean deciding program
+ * equivalence.
  *
  */
-export const compileStrategy = <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<CompileStrategyResponse, CompileStrategyError, ThrowOnError>({
-        bodySerializer: null,
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/strategy',
-        ...options,
-        headers: {
-            'Content-Type': 'text/plain',
-            ...options?.headers
-        }
-    });
+export const compileStrategy = <ThrowOnError extends boolean = false>(
+  options: Options<CompileStrategyData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    CompileStrategyResponse,
+    CompileStrategyError,
+    ThrowOnError
+  >({
+    bodySerializer: null,
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategy",
+    ...options,
+    headers: {
+      "Content-Type": "text/plain",
+      ...options?.headers,
+    },
+  });
 };
 
 /**
- * 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.
+ * Check that a registered strategy can actually run
+ * Instantiates the compiled class and drives it through a bounded synthetic series, so a wiring
+ * fault surfaces here instead of at your first backtest. The verdict — pass or fail, plus any
+ * engine notices — is recorded and served from `GET /strategy/{strategyId}`.
+ *
+ * **Idempotent.** If a verdict already exists for the current compilation it comes straight
+ * back with `200` and nothing is queued. Otherwise the check is queued and this returns `202`;
+ * poll `GET /strategy/{strategyId}` until `validation` is `passed` or `failed`.
+ *
+ * Recompiling supersedes a verdict, which makes this callable again — the old answer described
+ * bytecode that is no longer what would run.
  *
  */
-export const getStrategy = <ThrowOnError extends boolean = false>(options: Options<GetStrategyData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetStrategyResponse, GetStrategyError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/strategy/{strategyId}',
-        ...options
-    });
+export const validateStrategy = <ThrowOnError extends boolean = false>(
+  options: Options<ValidateStrategyData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    ValidateStrategyResponse,
+    ValidateStrategyError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategy/{strategyId}/validate",
+    ...options,
+  });
+};
+
+/**
+ * Get a strategy by id, including its validation state
+ * Reports that the strategy is registered — implied by a `200` at all — and what validating it
+ * found.
+ *
+ * A `404` means one thing: no such registered strategy for this user. It is never a stale or
+ * expired answer; registration and verdict are stored durably, not cached.
+ *
+ */
+export const getStrategy = <ThrowOnError extends boolean = false>(
+  options: Options<GetStrategyData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetStrategyResponse,
+    GetStrategyError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategy/{strategyId}",
+    ...options,
+  });
 };
 
 /**
@@ -198,21 +357,27 @@ export const getStrategy = <ThrowOnError extends boolean = false>(options: Optio
  * params do not enqueue duplicate work — they reuse the existing job.
  *
  */
-export const prepareBacktest = <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<PrepareBacktestResponse, PrepareBacktestError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/prepare',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options?.headers
-        }
-    });
+export const prepareBacktest = <ThrowOnError extends boolean = false>(
+  options: Options<PrepareBacktestData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    PrepareBacktestResponse,
+    PrepareBacktestError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/prepare",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
 };
 
 /**
@@ -221,17 +386,23 @@ export const prepareBacktest = <ThrowOnError extends boolean = false>(options: O
  * Poll until `status` is `Completed`, `Failed`, or `Aborted`.
  *
  */
-export const getPrepareStatus = <ThrowOnError extends boolean = false>(options: Options<GetPrepareStatusData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetPrepareStatusResponse, GetPrepareStatusError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/prepare/{jobId}',
-        ...options
-    });
+export const getPrepareStatus = <ThrowOnError extends boolean = false>(
+  options: Options<GetPrepareStatusData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetPrepareStatusResponse,
+    GetPrepareStatusError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/prepare/{jobId}",
+    ...options,
+  });
 };
 
 /**
@@ -240,39 +411,62 @@ export const getPrepareStatus = <ThrowOnError extends boolean = false>(options:
  * The backend expands and executes the matrix internally; clients poll the returned
  * `sweepId` for incremental results.
  *
+ * Supplying `walkForward` runs the sweep in a different mode entirely. Instead of scoring
+ * every parameter vector once over the whole range, the data is split into F sequential
+ * folds; each fold optimizes the full grid on its own window and then scores only its winner
+ * on the window immediately after — data that winner was not chosen on. It answers a harder
+ * question than a leaderboard: not "which parameters won", but "does re-optimizing this
+ * periodically actually work". Omit the block and nothing changes, including the response.
+ *
+ * The cost is the reason it is opt-in rather than always on: F folds × N vectors, so a
+ * 4-fold run over a 500-point grid is 2004 backtests where the plain sweep is 500. The
+ * request is rejected when `folds × totalRuns` exceeds the server's sweep budget.
+ *
  */
-export const executeSweep = <ThrowOnError extends boolean = false>(options: Options<ExecuteSweepData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<ExecuteSweepResponse, ExecuteSweepError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options?.headers
-        }
-    });
+export const executeSweep = <ThrowOnError extends boolean = false>(
+  options: Options<ExecuteSweepData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    ExecuteSweepResponse,
+    ExecuteSweepError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
 };
 
 /**
  * Cancel a running parameter sweep
  * Requests cancellation between parameter vectors. Completed rows remain readable.
  */
-export const cancelSweep = <ThrowOnError extends boolean = false>(options: Options<CancelSweepData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).delete<CancelSweepResponse, CancelSweepError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',
-        ...options
-    });
+export const cancelSweep = <ThrowOnError extends boolean = false>(
+  options: Options<CancelSweepData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).delete<
+    CancelSweepResponse,
+    CancelSweepError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}",
+    ...options,
+  });
 };
 
 /**
@@ -281,18 +475,87 @@ export const cancelSweep = <ThrowOnError extends boolean = false>(options: Optio
  * display leaderboard. `order=natural` returns every available row, untruncated, ordered by
  * deterministic `runIx`; use that view when materialising durable trial rows.
  *
+ * The `ranked` view is ordered by **plateau score** by default, not by the raw objective. A
+ * plateau score is the objective of the worst run in a parameter point's immediate
+ * neighbourhood, so a point scores well only if the region around it also does — the highest
+ * raw score is frequently a spike that does not survive the parameters moving slightly. Pass
+ * `ranking=raw` for the unadjusted objective order.
+ *
+ * Rows in the `ranked` view carry `plateauScore` and `neighbourCount` when plateau ranking
+ * applied. Read them together: `neighbourCount: 0` means the point had no neighbours to
+ * compare against, so its plateau score is unevidenced rather than confirmed. Sweeps
+ * submitted before plateau ranking existed have no stored parameter grid to rebuild a
+ * neighbourhood from and are always ranked raw; the response's `ranking` field says which
+ * ordering was actually used.
+ *
+ * A sweep submitted with `walkForward` answers in a different shape, and the `walkForward`
+ * field on the response is what tells the two apart — it appears as soon as the sweep is
+ * accepted, before any fold has finished, so it is safe to branch on while polling. There
+ * the leaderboard is one row per completed fold: that fold's winner as it scored
+ * **out-of-sample**, with `runIx` carrying the fold index rather than a grid position. The
+ * in-sample runs behind those winners are not retained — they are an optimization's working
+ * set, and only the winner survives its fold. `ranking` is always `raw` and no plateau, DSR
+ * or PBO figure is reported: the out-of-sample scores are already the honest number, and
+ * layering a certification computed over F observations on top of them would overstate what
+ * was measured.
+ *
  */
-export const getSweepResult = <ThrowOnError extends boolean = false>(options: Options<GetSweepResultData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetSweepResultResponse, GetSweepResultError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',
-        ...options
-    });
+export const getSweepResult = <ThrowOnError extends boolean = false>(
+  options: Options<GetSweepResultData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetSweepResultResponse,
+    GetSweepResultError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}",
+    ...options,
+  });
+};
+
+/**
+ * Get sweep sensitivity surfaces
+ * How the objective moves as each parameter moves — the question a leaderboard cannot answer.
+ * A leaderboard says which point won; a sweep can spend its entire budget on an axis that
+ * never moved the objective at all, and showing only the top rows hides that completely.
+ *
+ * A **marginal** takes one axis and collapses every other one: for each value of that axis,
+ * it aggregates every run that used it, whatever the rest of the parameters were. A flat
+ * marginal means the axis is irrelevant over the range swept. `best`, `mean` and `worst` are
+ * all reported because them disagreeing is itself the signal — a value with a high `best` and
+ * a poor `mean` works only in specific company, which is an interaction between parameters
+ * and would be invisible behind a single number.
+ *
+ * A **heatmap** does the same over a pair of axes, where that interaction becomes visible
+ * directly.
+ *
+ * Served from the sweep's stored rows: no re-run, no engine call, and it works on a sweep
+ * still in flight — the aggregates then describe the runs finished so far. Aborted runs are
+ * excluded throughout, since a run that threw measured nothing and counting it as a bad
+ * outcome would invent evidence against a parameter value that was never really tested.
+ *
+ * This is a separate endpoint rather than extra fields on the result view because the
+ * two-dimensional half is quadratic in the axis count (N axes give N(N-1)/2 surfaces, each
+ * the product of two axes' value counts) and is not wanted on the poll that drives progress.
+ *
+ */
+export const getSweepSensitivity = <ThrowOnError extends boolean = false>(
+  options: Options<GetSweepSensitivityData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetSweepSensitivityResponse,
+    GetSweepSensitivityError,
+    ThrowOnError
+  >({
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}/sensitivity",
+    ...options,
+  });
 };
 
 /**
@@ -308,21 +571,27 @@ export const getSweepResult = <ThrowOnError extends boolean = false>(options: Op
  * `jobId` (idempotent).
  *
  */
-export const executeBacktest = <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<ExecuteBacktestResponse, ExecuteBacktestError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/execute',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options?.headers
-        }
-    });
+export const executeBacktest = <ThrowOnError extends boolean = false>(
+  options: Options<ExecuteBacktestData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    ExecuteBacktestResponse,
+    ExecuteBacktestError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/execute",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
 };
 
 /**
@@ -333,17 +602,23 @@ export const executeBacktest = <ThrowOnError extends boolean = false>(options: O
  * to confirm the final status.
  *
  */
-export const cancelBacktest = <ThrowOnError extends boolean = false>(options: Options<CancelBacktestData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).delete<CancelBacktestResponse, CancelBacktestError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',
-        ...options
-    });
+export const cancelBacktest = <ThrowOnError extends boolean = false>(
+  options: Options<CancelBacktestData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).delete<
+    CancelBacktestResponse,
+    CancelBacktestError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/execute/{jobId}",
+    ...options,
+  });
 };
 
 /**
@@ -356,15 +631,21 @@ export const cancelBacktest = <ThrowOnError extends boolean = false>(options: Op
  * not stop on it.
  *
  */
-export const getBacktestResult = <ThrowOnError extends boolean = false>(options: Options<GetBacktestResultData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetBacktestResultResponse, GetBacktestResultError, ThrowOnError>({
-        security: [
-            {
-                scheme: 'bearer',
-                type: 'http'
-            }
-        ],
-        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',
-        ...options
-    });
-};
+export const getBacktestResult = <ThrowOnError extends boolean = false>(
+  options: Options<GetBacktestResultData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetBacktestResultResponse,
+    GetBacktestResultError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/execute/{jobId}",
+    ...options,
+  });
+};