@qtsurfer/api-client 0.10.0 → 0.12.0

package/src/generated/sdk.gen.ts

@@ -58,6 +58,9 @@ import type {
   GetSweepSensitivityData,
   GetSweepSensitivityResponse,
   GetSweepSensitivityError,
+  GetSweepRunEquityCurveData,
+  GetSweepRunEquityCurveResponse,
+  GetSweepRunEquityCurveError,
   ExecuteBacktestData,
   ExecuteBacktestResponse,
   ExecuteBacktestError,
@@ -67,6 +70,23 @@ import type {
   GetBacktestResultData,
   GetBacktestResultResponse,
   GetBacktestResultError,
+  ListDatasetsData,
+  ListDatasetsResponse,
+  CreateDatasetData,
+  CreateDatasetResponse,
+  CreateDatasetError,
+  DeleteDatasetData,
+  DeleteDatasetResponse,
+  DeleteDatasetError,
+  GetDatasetData,
+  GetDatasetResponse,
+  GetDatasetError,
+  FinalizeDatasetUploadData,
+  FinalizeDatasetUploadResponse,
+  FinalizeDatasetUploadError,
+  GetDatasetUploadData,
+  GetDatasetUploadResponse,
+  GetDatasetUploadError,
 } from "./types.gen";
 import { client as _heyApiClient } from "./client.gen";
 
@@ -299,6 +319,10 @@ export const listStrategies = <ThrowOnError extends boolean = false>(
  * different means are two strategies, because deciding otherwise would mean deciding program
  * equivalence.
  *
+ * The response also lists `declaredProperties` — the sweep/execute param keys this strategy
+ * is known to accept, so a caller can catch a typo'd key before submitting a sweep instead of
+ * only learning it from a rejected one. See `DeclaredProperty`: best-effort, not exhaustive.
+ *
  */
 export const compileStrategy = <ThrowOnError extends boolean = false>(
   options: Options<CompileStrategyData, ThrowOnError>
@@ -456,6 +480,11 @@ export const getStrategyCode = <ThrowOnError extends boolean = false>(
  * The same params always return the same `jobId` (idempotent). Repeated calls with identical
  * params do not enqueue duplicate work — they reuse the existing job.
  *
+ * **`exchangeId: user` is reserved for your own uploaded data.** Instead of a managed
+ * exchange, it prepares from a dataset you created via `POST /datasets` (see the **Dataset**
+ * endpoints) — send `datasetId` in place of `instrument`. See `PrepareRequest` below for the
+ * two request shapes.
+ *
  */
 export const prepareBacktest = <ThrowOnError extends boolean = false>(
   options: Options<PrepareBacktestData, ThrowOnError>
@@ -485,6 +514,9 @@ export const prepareBacktest = <ThrowOnError extends boolean = false>(
  * Retrieves the current state of the prepare job identified by `jobId`.
  * Poll until `status` is `Completed`, `Failed`, or `Aborted`.
  *
+ * For a dataset prepare (`exchangeId: user`), coverage is reported against the dataset's own
+ * cadence grid instead of hours — see `cadence`/`gaps`/`largestGapSteps` on `PrepareJobState`.
+ *
  */
 export const getPrepareStatus = <ThrowOnError extends boolean = false>(
   options: Options<GetPrepareStatusData, ThrowOnError>
@@ -664,6 +696,41 @@ export const getSweepSensitivity = <ThrowOnError extends boolean = false>(
   });
 };
 
+/**
+ * Get one sweep trial's equity curve
+ * The resource a leaderboard row's `equityCurve.url` points at — only reachable when that
+ * trial's curve was actually selected (`equityCurve.mode: topN` or `topPct` on the sweep
+ * submission, and this trial ranked among the winners). Returns the exact same
+ * `{points|timestamps+equities, meta}` shape a plain backtest's inline `equityCurve` carries.
+ *
+ * Query params reshape the response the same way a plain backtest's `equityCurve` options do.
+ * A param genuinely absent from the query string falls back to the `equityCurve` transform
+ * preference the sweep was submitted with — a param
+ * present but malformed does not fall back, it degrades the same way it always has. Above a
+ * server-side size threshold, the shape is forced regardless of either — `meta.outMode` in
+ * the response, not the query string or the submitted default, is the source of truth for
+ * what shape actually came back.
+ *
+ */
+export const getSweepRunEquityCurve = <ThrowOnError extends boolean = false>(
+  options: Options<GetSweepRunEquityCurveData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetSweepRunEquityCurveResponse,
+    GetSweepRunEquityCurveError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}/runs/{runIx}/equityCurve",
+    ...options,
+  });
+};
+
 /**
  * Execute a compiled strategy against a prepared dataset
  * Enqueues an execute task that runs the strategy identified by `strategyId` over the data
@@ -673,8 +740,12 @@ export const getSweepSensitivity = <ThrowOnError extends boolean = false>(
  * Returns immediately with a `jobId`; poll `GET /backtest/{exchangeId}/{type}/execute/{jobId}`
  * for the result.
  *
- * The same params (same `prepareJobId`, `strategyId`, `storeSignals`) always return the same
- * `jobId` (idempotent).
+ * The same params (same `prepareJobId`, `strategyId`, `storeSignals`, `equityCurve`) always
+ * return the same `jobId` (idempotent) — a request that omits `equityCurve` dedupes exactly
+ * as it did before that field existed.
+ *
+ * Works unchanged for a dataset-backed prepare (`exchangeId: user`) — the request body is
+ * identical either way, since the instrument and range are recovered from `prepareJobId`.
  *
  */
 export const executeBacktest = <ThrowOnError extends boolean = false>(
@@ -755,3 +826,172 @@ export const getBacktestResult = <ThrowOnError extends boolean = false>(
     ...options,
   });
 };
+
+/**
+ * List your datasets
+ * Every dataset you have created and not deleted, most recently created first. Never a `404`
+ * — an empty array if you have none, same convention as `GET /strategies`.
+ *
+ */
+export const listDatasets = <ThrowOnError extends boolean = false>(
+  options?: Options<ListDatasetsData, ThrowOnError>
+) => {
+  return (options?.client ?? _heyApiClient).get<
+    ListDatasetsResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets",
+    ...options,
+  });
+};
+
+/**
+ * Create a dataset and get a URL to upload it to
+ * Creates a dataset AND its first upload session in one call — a presigned URL your client
+ * PUTs the file to directly, no API credentials involved in that PUT. Call
+ * `POST /datasets/{datasetId}/uploads/{uploadId}/finalize` once the upload completes to kick
+ * off ingest.
+ *
+ * v1 is ticker data only — `type` is not a request field, it is always `"ticker"` in the
+ * response. `instrument` must be a plain spot pair (`BASE/QUOTE`, exactly one `/`); derivative
+ * forms (e.g. `BTC/USDT:USDT`) are rejected.
+ *
+ * **Upload format.** A CSV with a header row. Required columns: `timestamp` (ISO-8601, or
+ * numeric epoch seconds/millis/micros — detected from the first row, then enforced for every
+ * later row), `close`. Optional columns: `open`, `high`, `low`, `volume`, `quoteVolume`,
+ * `bid`, `bidSize`, `ask`, `askSize`. Cadence and timestamp unit are discovered from the data,
+ * not declared.
+ *
+ */
+export const createDataset = <ThrowOnError extends boolean = false>(
+  options: Options<CreateDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    CreateDatasetResponse,
+    CreateDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
+};
+
+/**
+ * Delete a dataset
+ * Soft-delete — the dataset stops appearing in `GET /datasets`/`GET /datasets/{datasetId}` and
+ * can no longer be prepared from, but its object data is reclaimed later rather than purged
+ * inline, so a backtest already running against one of its versions is not disrupted.
+ *
+ */
+export const deleteDataset = <ThrowOnError extends boolean = false>(
+  options: Options<DeleteDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).delete<
+    DeleteDatasetResponse,
+    DeleteDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}",
+    ...options,
+  });
+};
+
+/**
+ * Get a dataset by id
+ * Detail for one dataset, plus a self link.
+ */
+export const getDataset = <ThrowOnError extends boolean = false>(
+  options: Options<GetDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetDatasetResponse,
+    GetDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}",
+    ...options,
+  });
+};
+
+/**
+ * Finalize an uploaded file and start ingest
+ * Call once the file has been PUT to the `upload.url` from `POST /datasets`. Enqueues ingest
+ * and returns immediately; poll
+ * `GET /datasets/{datasetId}/uploads/{uploadId}` for the result.
+ *
+ * Idempotent — a repeat finalize of the same upload returns the same `jobId` rather than
+ * enqueueing a second ingest.
+ *
+ */
+export const finalizeDatasetUpload = <ThrowOnError extends boolean = false>(
+  options: Options<FinalizeDatasetUploadData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    FinalizeDatasetUploadResponse,
+    FinalizeDatasetUploadError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}/uploads/{uploadId}/finalize",
+    ...options,
+  });
+};
+
+/**
+ * Get the state of an upload/ingest
+ * Poll after `POST .../finalize` until `status` is `ready` or `failed`. Also reports
+ * `uploading` (finalize not called yet, but the file was PUT) before you finalize at all.
+ *
+ */
+export const getDatasetUpload = <ThrowOnError extends boolean = false>(
+  options: Options<GetDatasetUploadData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetDatasetUploadResponse,
+    GetDatasetUploadError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}/uploads/{uploadId}",
+    ...options,
+  });
+};