@qtsurfer/api-client 0.4.0 → 0.5.0

package/dist/index.js

@@ -5,7 +5,7 @@ var client = createClient(createConfig({
 }));
 
 // src/generated/sdk.gen.ts
-var auth = (options) => {
+var authenticate = (options) => {
   return (options?.client ?? client).post({
     security: [
       {
@@ -17,37 +17,37 @@ var auth = (options) => {
     ...options
   });
 };
-var getExchanges = (options) => {
+var listExchanges = (options) => {
   return (options?.client ?? client).get({
     url: "/exchanges",
     ...options
   });
 };
-var getInstruments = (options) => {
+var listInstruments = (options) => {
   return (options.client ?? client).get({
     url: "/exchange/{exchangeId}/instruments",
     ...options
   });
 };
-var getSegmentInstruments = (options) => {
+var listSegmentInstruments = (options) => {
   return (options.client ?? client).get({
     url: "/exchange/{exchangeId}/{segment}/instruments",
     ...options
   });
 };
-var getExchangeTickersHour = (options) => {
+var downloadTickers = (options) => {
   return (options.client ?? client).get({
     url: "/exchange/{exchangeId}/tickers/{base}/{quote}",
     ...options
   });
 };
-var getExchangeKlinesHour = (options) => {
+var downloadKlines = (options) => {
   return (options.client ?? client).get({
     url: "/exchange/{exchangeId}/klines/{base}/{quote}",
     ...options
   });
 };
-var postStrategy = (options) => {
+var compileStrategy = (options) => {
   return (options.client ?? client).post({
     bodySerializer: null,
     security: [
@@ -64,7 +64,7 @@ var postStrategy = (options) => {
     }
   });
 };
-var getStrategyStatus = (options) => {
+var getStrategy = (options) => {
   return (options.client ?? client).get({
     security: [
       {
@@ -76,7 +76,7 @@ var getStrategyStatus = (options) => {
     ...options
   });
 };
-var prepareBacktesting = (options) => {
+var prepareBacktest = (options) => {
   return (options.client ?? client).post({
     security: [
       {
@@ -92,7 +92,7 @@ var prepareBacktesting = (options) => {
     }
   });
 };
-var getPreparationStatus = (options) => {
+var getPrepareStatus = (options) => {
   return (options.client ?? client).get({
     security: [
       {
@@ -104,7 +104,47 @@ var getPreparationStatus = (options) => {
     ...options
   });
 };
-var executeBacktesting = (options) => {
+var executeSweep = (options) => {
+  return (options.client ?? client).post({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http"
+      }
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers
+    }
+  });
+};
+var cancelSweep = (options) => {
+  return (options.client ?? client).delete({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http"
+      }
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}",
+    ...options
+  });
+};
+var getSweepResult = (options) => {
+  return (options.client ?? client).get({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http"
+      }
+    ],
+    url: "/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}",
+    ...options
+  });
+};
+var executeBacktest = (options) => {
   return (options.client ?? client).post({
     security: [
       {
@@ -120,7 +160,7 @@ var executeBacktesting = (options) => {
     }
   });
 };
-var cancelExecution = (options) => {
+var cancelBacktest = (options) => {
   return (options.client ?? client).delete({
     security: [
       {
@@ -132,7 +172,7 @@ var cancelExecution = (options) => {
     ...options
   });
 };
-var getExecutionResult = (options) => {
+var getBacktestResult = (options) => {
   return (options.client ?? client).get({
     security: [
       {
@@ -145,19 +185,22 @@ var getExecutionResult = (options) => {
   });
 };
 export {
-  auth,
-  cancelExecution,
+  authenticate,
+  cancelBacktest,
+  cancelSweep,
   client,
-  executeBacktesting,
-  getExchangeKlinesHour,
-  getExchangeTickersHour,
-  getExchanges,
-  getExecutionResult,
-  getInstruments,
-  getPreparationStatus,
-  getSegmentInstruments,
-  getStrategyStatus,
-  postStrategy,
-  prepareBacktesting
+  compileStrategy,
+  downloadKlines,
+  downloadTickers,
+  executeBacktest,
+  executeSweep,
+  getBacktestResult,
+  getPrepareStatus,
+  getStrategy,
+  getSweepResult,
+  listExchanges,
+  listInstruments,
+  listSegmentInstruments,
+  prepareBacktest
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/generated/client.gen.ts","../src/generated/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { ClientOptions } from './types.gen';\nimport { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';\n\n/**\n * The `createClientConfig()` function will be called on client initialization\n * and the returned object will become the client's initial configuration.\n *\n * You may want to initialize your client this way instead of calling\n * `setConfig()`. This is useful for example if you're using Next.js\n * to ensure your client always has the correct values.\n */\nexport type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;\n\nexport const client = createClient(createConfig<ClientOptions>({\n    baseUrl: 'https://api.staging.qtsurfer.com/v1'\n}));","// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';\nimport type { AuthData, AuthResponse, AuthError, GetExchangesData, GetExchangesResponse, GetInstrumentsData, GetInstrumentsResponse, GetInstrumentsError, GetSegmentInstrumentsData, GetSegmentInstrumentsResponse, GetSegmentInstrumentsError, GetExchangeTickersHourData, GetExchangeTickersHourResponse, GetExchangeTickersHourError, GetExchangeKlinesHourData, GetExchangeKlinesHourResponse, GetExchangeKlinesHourError, PostStrategyData, PostStrategyResponse, PostStrategyError, GetStrategyStatusData, GetStrategyStatusResponse, GetStrategyStatusError, PrepareBacktestingData, PrepareBacktestingResponse, PrepareBacktestingError, GetPreparationStatusData, GetPreparationStatusResponse, GetPreparationStatusError, ExecuteBacktestingData, ExecuteBacktestingResponse, ExecuteBacktestingError, CancelExecutionData, CancelExecutionResponse, CancelExecutionError, GetExecutionResultData, GetExecutionResultResponse, GetExecutionResultError } from './types.gen';\nimport { client as _heyApiClient } from './client.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {\n    /**\n     * You can provide a client instance returned by `createClient()` instead of\n     * individual options. This might be also useful if you want to implement a\n     * custom client.\n     */\n    client?: Client;\n    /**\n     * You can pass arbitrary values through the `meta` object. This can be\n     * used to access values that aren't defined as part of the SDK function.\n     */\n    meta?: Record<string, unknown>;\n};\n\n/**\n * Exchange API key for a short-lived JWT\n * Exchanges a long-lived API key for a short-lived JWT used by every other\n * endpoint. This is the only endpoint that accepts an API key directly —\n * callers should obtain a JWT here, then send it as `Authorization: Bearer\n * <token>` to all other operations.\n *\n * The returned JWT carries the caller's subscription `tier` as a claim and\n * expires after `expires_in` seconds. Callers should refresh the token\n * before expiry (or on a `401` response) by calling this endpoint again.\n *\n */\nexport const auth = <ThrowOnError extends boolean = false>(options?: Options<AuthData, ThrowOnError>) => {\n    return (options?.client ?? _heyApiClient).post<AuthResponse, AuthError, ThrowOnError>({\n        security: [\n            {\n                name: 'X-API-Key',\n                type: 'apiKey'\n            }\n        ],\n        url: '/auth/token',\n        ...options\n    });\n};\n\n/**\n * Get a list of available exchanges\n */\nexport const getExchanges = <ThrowOnError extends boolean = false>(options?: Options<GetExchangesData, ThrowOnError>) => {\n    return (options?.client ?? _heyApiClient).get<GetExchangesResponse, unknown, ThrowOnError>({\n        url: '/exchanges',\n        ...options\n    });\n};\n\n/**\n * Get an exchange's instruments (default spot segment)\n * \"Give me binance instruments\" — returns the exchange's DEFAULT segment (`spot`)\n * in `data`, each instrument with per-data-type coverage and market info. `meta`\n * confirms the served `segment` (`spot`); HAL `_links` carry `self` plus the\n * `spot` / `futures` segment-discovery links.\n *\n */\nexport const getInstruments = <ThrowOnError extends boolean = false>(options: Options<GetInstrumentsData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetInstrumentsResponse, GetInstrumentsError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/instruments',\n        ...options\n    });\n};\n\n/**\n * Get the instruments for a specific exchange segment\n * Returns the instruments for one market segment of the exchange, each with\n * per-data-type coverage and market info. HAL `_links` carry `self` plus the\n * `spot` / `futures` segment-discovery links; the default-segment shortcut is\n * `GET /exchange/{exchangeId}/instruments` (spot).\n *\n */\nexport const getSegmentInstruments = <ThrowOnError extends boolean = false>(options: Options<GetSegmentInstrumentsData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetSegmentInstrumentsResponse, GetSegmentInstrumentsError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/{segment}/instruments',\n        ...options\n    });\n};\n\n/**\n * Download one hour of tickers for an instrument as a Lastra segment\n * Serves exactly one hour of raw ticker data for the given instrument on the\n * requested exchange. The payload is a native [Lastra](https://github.com/QTSurfer/lastra-java)\n * file — QTSurfer's columnar format for tick-precision timeseries — with\n * no JSON envelope.\n *\n * One segment = one hour, aligned to UTC. The `hour` query parameter selects\n * the segment and must match `YYYY-MM-DDTHH` (no minutes/seconds, no timezone\n * suffix). Example: `hour=2026-01-15T10` returns `h10.lastra` for\n * 2026-01-15, covering `[10:00:00Z, 11:00:00Z)`. Hours not yet available\n * return `404`.\n *\n * A `format=parquet` query parameter switches the response to on-the-fly\n * Parquet conversion via [lastra-convert](https://github.com/QTSurfer/lastra-convert)\n * for clients that don't yet read Lastra. Lastra is the primary format\n * and cheaper when the client can consume it.\n *\n * Clients:\n * - [lastra-java](https://github.com/QTSurfer/lastra-java) — reference\n * Java reader/writer with per-column codecs (ALP, Gorilla, delta-varint,\n * ZSTD) and CRC32 integrity.\n * - [lastra-ts](https://github.com/QTSurfer/lastra-ts) — TypeScript reader\n * (~4 kB bundle, browser + Node.js).\n * - [duckdb-lastra](https://github.com/QTSurfer/duckdb-lastra) — DuckDB\n * extension for ad-hoc SQL over Lastra files.\n * - [lastra-convert](https://github.com/QTSurfer/lastra-convert) — CLI + Java\n * API for converting to/from Parquet, Reef, and CSV.\n * - `curl -OJ` for offline dumps (the `Content-Disposition` header sets a\n * descriptive filename).\n *\n */\nexport const getExchangeTickersHour = <ThrowOnError extends boolean = false>(options: Options<GetExchangeTickersHourData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetExchangeTickersHourResponse, GetExchangeTickersHourError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/tickers/{base}/{quote}',\n        ...options\n    });\n};\n\n/**\n * Download one hour of klines for an instrument as a Lastra segment\n * Same shape and semantics as `/exchange/{exchangeId}/tickers/{base}/{quote}`,\n * but serves klines (aggregated bars) instead of raw ticks. One\n * [Lastra](https://github.com/QTSurfer/lastra-java) segment = one hour of\n * klines at the exchange's native kline cadence, aligned to UTC.\n *\n * Klines use the same columnar layout as tickers — readers that handle one\n * format read the other with the same code. Use this endpoint when a\n * per-tick payload would be too large for the window of interest.\n *\n */\nexport const getExchangeKlinesHour = <ThrowOnError extends boolean = false>(options: Options<GetExchangeKlinesHourData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetExchangeKlinesHourResponse, GetExchangeKlinesHourError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/klines/{base}/{quote}',\n        ...options\n    });\n};\n\n/**\n * Compile a strategy from source code\n * Submits raw strategy source for compilation. By default the call is synchronous and returns\n * the `strategyId` once compilation succeeds. Set the header `X-Compile-Async: true` to enqueue\n * the compile task and return immediately with a `jobId` — poll\n * `GET /strategy/{strategyId}` to check status.\n *\n * The `strategyId` is deterministic: the same source for the same user always produces the\n * same id.\n *\n */\nexport const postStrategy = <ThrowOnError extends boolean = false>(options: Options<PostStrategyData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<PostStrategyResponse, PostStrategyError, ThrowOnError>({\n        bodySerializer: null,\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/strategy',\n        ...options,\n        headers: {\n            'Content-Type': 'text/plain',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Get the status of an async compile task\n * Polls the status of a strategy compilation. Useful when the strategy was submitted with\n * `X-Compile-Async: true`. Returns the resolved `strategyId` once compilation completes.\n *\n */\nexport const getStrategyStatus = <ThrowOnError extends boolean = false>(options: Options<GetStrategyStatusData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetStrategyStatusResponse, GetStrategyStatusError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/strategy/{strategyId}',\n        ...options\n    });\n};\n\n/**\n * Prepare backtesting data\n * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;\n * poll `GET /backtest/{exchangeId}/{type}/prepare/{jobId}` for completion.\n *\n * The same params always return the same `jobId` (idempotent). Repeated calls with identical\n * params do not enqueue duplicate work — they reuse the existing job.\n *\n */\nexport const prepareBacktesting = <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestingData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<PrepareBacktestingResponse, PrepareBacktestingError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/prepare',\n        ...options,\n        headers: {\n            'Content-Type': 'application/json',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Get the status of a prepare job\n * Retrieves the current state of the prepare job identified by `jobId`.\n * Poll until `status` is `Completed`, `Failed`, or `Aborted`.\n *\n */\nexport const getPreparationStatus = <ThrowOnError extends boolean = false>(options: Options<GetPreparationStatusData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetPreparationStatusResponse, GetPreparationStatusError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/prepare/{jobId}',\n        ...options\n    });\n};\n\n/**\n * Execute a compiled strategy against a prepared dataset\n * Enqueues an execute task that runs the strategy identified by `strategyId` over the data\n * prepared by the prepare job identified by `prepareJobId`. The instrument and date range are\n * recovered from the prepare job — they do not need to be sent again.\n *\n * Returns immediately with a `jobId`; poll `GET /backtest/{exchangeId}/{type}/execute/{jobId}`\n * for the result.\n *\n * The same params (same `prepareJobId`, `strategyId`, `storeSignals`) always return the same\n * `jobId` (idempotent).\n *\n */\nexport const executeBacktesting = <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestingData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<ExecuteBacktestingResponse, ExecuteBacktestingError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute',\n        ...options,\n        headers: {\n            'Content-Type': 'application/json',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Cancel a running backtest execution\n * Requests cancellation of the specified execution. The execution\n * status will transition to `Aborted` once the cancellation is\n * processed. Cancellation is asynchronous — poll the GET endpoint\n * to confirm the final status.\n *\n */\nexport const cancelExecution = <ThrowOnError extends boolean = false>(options: Options<CancelExecutionData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).delete<CancelExecutionResponse, CancelExecutionError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',\n        ...options\n    });\n};\n\n/**\n * Get the result of a backtest execution job\n * Retrieves the current state and results of the execute job identified by `jobId`.\n * Poll until `state.status` is `Completed`, `Failed`, or `Aborted`.\n *\n */\nexport const getExecutionResult = <ThrowOnError extends boolean = false>(options: Options<GetExecutionResultData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetExecutionResultResponse, GetExecutionResultError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',\n        ...options\n    });\n};"],"mappings":";AAGA,SAAkE,cAAc,oBAAoB;AAY7F,IAAM,SAAS,aAAa,aAA4B;AAAA,EAC3D,SAAS;AACb,CAAC,CAAC;;;ACeK,IAAM,OAAO,CAAuC,YAA8C;AACrG,UAAQ,SAAS,UAAU,QAAe,KAA4C;AAAA,IAClF,UAAU;AAAA,MACN;AAAA,QACI,MAAM;AAAA,QACN,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAKO,IAAM,eAAe,CAAuC,YAAsD;AACrH,UAAQ,SAAS,UAAU,QAAe,IAAiD;AAAA,IACvF,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAUO,IAAM,iBAAiB,CAAuC,YAAuD;AACxH,UAAQ,QAAQ,UAAU,QAAe,IAA+D;AAAA,IACpG,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAUO,IAAM,wBAAwB,CAAuC,YAA8D;AACtI,UAAQ,QAAQ,UAAU,QAAe,IAA6E;AAAA,IAClH,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAkCO,IAAM,yBAAyB,CAAuC,YAA+D;AACxI,UAAQ,QAAQ,UAAU,QAAe,IAA+E;AAAA,IACpH,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAcO,IAAM,wBAAwB,CAAuC,YAA8D;AACtI,UAAQ,QAAQ,UAAU,QAAe,IAA6E;AAAA,IAClH,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAaO,IAAM,eAAe,CAAuC,YAAqD;AACpH,UAAQ,QAAQ,UAAU,QAAe,KAA4D;AAAA,IACjG,gBAAgB;AAAA,IAChB,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAQO,IAAM,oBAAoB,CAAuC,YAA0D;AAC9H,UAAQ,QAAQ,UAAU,QAAe,IAAqE;AAAA,IAC1G,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAWO,IAAM,qBAAqB,CAAuC,YAA2D;AAChI,UAAQ,QAAQ,UAAU,QAAe,KAAwE;AAAA,IAC7G,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAQO,IAAM,uBAAuB,CAAuC,YAA6D;AACpI,UAAQ,QAAQ,UAAU,QAAe,IAA2E;AAAA,IAChH,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAeO,IAAM,qBAAqB,CAAuC,YAA2D;AAChI,UAAQ,QAAQ,UAAU,QAAe,KAAwE;AAAA,IAC7G,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAUO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,OAAoE;AAAA,IACzG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAQO,IAAM,qBAAqB,CAAuC,YAA2D;AAChI,UAAQ,QAAQ,UAAU,QAAe,IAAuE;AAAA,IAC5G,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;","names":[]}
+{"version":3,"sources":["../src/generated/client.gen.ts","../src/generated/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { ClientOptions } from './types.gen';\nimport { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';\n\n/**\n * The `createClientConfig()` function will be called on client initialization\n * and the returned object will become the client's initial configuration.\n *\n * You may want to initialize your client this way instead of calling\n * `setConfig()`. This is useful for example if you're using Next.js\n * to ensure your client always has the correct values.\n */\nexport type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;\n\nexport const client = createClient(createConfig<ClientOptions>({\n    baseUrl: 'https://api.staging.qtsurfer.com/v1'\n}));","// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';\nimport 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';\nimport { client as _heyApiClient } from './client.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {\n    /**\n     * You can provide a client instance returned by `createClient()` instead of\n     * individual options. This might be also useful if you want to implement a\n     * custom client.\n     */\n    client?: Client;\n    /**\n     * You can pass arbitrary values through the `meta` object. This can be\n     * used to access values that aren't defined as part of the SDK function.\n     */\n    meta?: Record<string, unknown>;\n};\n\n/**\n * Exchange API key for a short-lived JWT\n * Exchanges a long-lived API key for a short-lived JWT used by every other\n * endpoint. This is the only endpoint that accepts an API key directly —\n * callers should obtain a JWT here, then send it as `Authorization: Bearer\n * <token>` to all other operations.\n *\n * The returned JWT carries the caller's subscription `tier` as a claim and\n * expires after `expires_in` seconds. Callers should refresh the token\n * before expiry (or on a `401` response) by calling this endpoint again.\n *\n */\nexport const authenticate = <ThrowOnError extends boolean = false>(options?: Options<AuthenticateData, ThrowOnError>) => {\n    return (options?.client ?? _heyApiClient).post<AuthenticateResponse, AuthenticateError, ThrowOnError>({\n        security: [\n            {\n                name: 'X-API-Key',\n                type: 'apiKey'\n            }\n        ],\n        url: '/auth/token',\n        ...options\n    });\n};\n\n/**\n * List the available exchanges\n */\nexport const listExchanges = <ThrowOnError extends boolean = false>(options?: Options<ListExchangesData, ThrowOnError>) => {\n    return (options?.client ?? _heyApiClient).get<ListExchangesResponse, unknown, ThrowOnError>({\n        url: '/exchanges',\n        ...options\n    });\n};\n\n/**\n * List an exchange's instruments (default spot segment)\n * \"Give me binance instruments\" — returns the exchange's DEFAULT segment (`spot`)\n * in `data`, each instrument with per-data-type coverage and market info. `meta`\n * confirms the served `segment` (`spot`); HAL `_links` carry `self` plus the\n * `spot` / `futures` segment-discovery links.\n *\n */\nexport const listInstruments = <ThrowOnError extends boolean = false>(options: Options<ListInstrumentsData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<ListInstrumentsResponse, ListInstrumentsError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/instruments',\n        ...options\n    });\n};\n\n/**\n * List an exchange segment's instruments\n * Returns the instruments for one market segment of the exchange, each with\n * per-data-type coverage and market info. HAL `_links` carry `self` plus the\n * `spot` / `futures` segment-discovery links; the default-segment shortcut is\n * `GET /exchange/{exchangeId}/instruments` (spot).\n *\n */\nexport const listSegmentInstruments = <ThrowOnError extends boolean = false>(options: Options<ListSegmentInstrumentsData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<ListSegmentInstrumentsResponse, ListSegmentInstrumentsError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/{segment}/instruments',\n        ...options\n    });\n};\n\n/**\n * Download one hour of tickers for an instrument as a Lastra segment\n * Serves exactly one hour of raw ticker data for the given instrument on the\n * requested exchange. The payload is a native [Lastra](https://github.com/QTSurfer/lastra-java)\n * file — QTSurfer's columnar format for tick-precision timeseries — with\n * no JSON envelope.\n *\n * One segment = one hour, aligned to UTC. The `hour` query parameter selects\n * the segment and must match `YYYY-MM-DDTHH` (no minutes/seconds, no timezone\n * suffix). Example: `hour=2026-01-15T10` returns `h10.lastra` for\n * 2026-01-15, covering `[10:00:00Z, 11:00:00Z)`. Hours not yet available\n * return `404`.\n *\n * A `format=parquet` query parameter switches the response to on-the-fly\n * Parquet conversion via [lastra-convert](https://github.com/QTSurfer/lastra-convert)\n * for clients that don't yet read Lastra. Lastra is the primary format\n * and cheaper when the client can consume it.\n *\n * Clients:\n * - [lastra-java](https://github.com/QTSurfer/lastra-java) — reference\n * Java reader/writer with per-column codecs (ALP, Gorilla, delta-varint,\n * ZSTD) and CRC32 integrity.\n * - [lastra-ts](https://github.com/QTSurfer/lastra-ts) — TypeScript reader\n * (~4 kB bundle, browser + Node.js).\n * - [duckdb-lastra](https://github.com/QTSurfer/duckdb-lastra) — DuckDB\n * extension for ad-hoc SQL over Lastra files.\n * - [lastra-convert](https://github.com/QTSurfer/lastra-convert) — CLI + Java\n * API for converting to/from Parquet, Reef, and CSV.\n * - `curl -OJ` for offline dumps (the `Content-Disposition` header sets a\n * descriptive filename).\n *\n */\nexport const downloadTickers = <ThrowOnError extends boolean = false>(options: Options<DownloadTickersData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<DownloadTickersResponse, DownloadTickersError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/tickers/{base}/{quote}',\n        ...options\n    });\n};\n\n/**\n * Download one hour of klines for an instrument as a Lastra segment\n * Same shape and semantics as `/exchange/{exchangeId}/tickers/{base}/{quote}`,\n * but serves klines (aggregated bars) instead of raw ticks. One\n * [Lastra](https://github.com/QTSurfer/lastra-java) segment = one hour of\n * klines at the exchange's native kline cadence, aligned to UTC.\n *\n * Klines use the same columnar layout as tickers — readers that handle one\n * format read the other with the same code. Use this endpoint when a\n * per-tick payload would be too large for the window of interest.\n *\n */\nexport const downloadKlines = <ThrowOnError extends boolean = false>(options: Options<DownloadKlinesData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<DownloadKlinesResponse, DownloadKlinesError, ThrowOnError>({\n        url: '/exchange/{exchangeId}/klines/{base}/{quote}',\n        ...options\n    });\n};\n\n/**\n * Compile a strategy from source code\n * Submits raw strategy source for compilation. By default the call is synchronous and returns\n * the `strategyId` once compilation succeeds. Set the header `X-Compile-Async: true` to enqueue\n * the compile task and return immediately with a `jobId` — poll\n * `GET /strategy/{strategyId}` to check status.\n *\n * The `strategyId` is deterministic: the same source for the same user always produces the\n * same id.\n *\n */\nexport const compileStrategy = <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<CompileStrategyResponse, CompileStrategyError, ThrowOnError>({\n        bodySerializer: null,\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/strategy',\n        ...options,\n        headers: {\n            'Content-Type': 'text/plain',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Get a strategy by id, including its compile status\n * Polls the status of a strategy compilation. Useful when the strategy was submitted with\n * `X-Compile-Async: true`. Returns the resolved `strategyId` once compilation completes.\n *\n */\nexport const getStrategy = <ThrowOnError extends boolean = false>(options: Options<GetStrategyData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetStrategyResponse, GetStrategyError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/strategy/{strategyId}',\n        ...options\n    });\n};\n\n/**\n * Prepare backtest data\n * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;\n * poll `GET /backtest/{exchangeId}/{type}/prepare/{jobId}` for completion.\n *\n * The same params always return the same `jobId` (idempotent). Repeated calls with identical\n * params do not enqueue duplicate work — they reuse the existing job.\n *\n */\nexport const prepareBacktest = <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<PrepareBacktestResponse, PrepareBacktestError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/prepare',\n        ...options,\n        headers: {\n            'Content-Type': 'application/json',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Get the status of a prepare job\n * Retrieves the current state of the prepare job identified by `jobId`.\n * Poll until `status` is `Completed`, `Failed`, or `Aborted`.\n *\n */\nexport const getPrepareStatus = <ThrowOnError extends boolean = false>(options: Options<GetPrepareStatusData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetPrepareStatusResponse, GetPrepareStatusError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/prepare/{jobId}',\n        ...options\n    });\n};\n\n/**\n * Execute a parameter sweep over prepared data\n * Runs a parameter matrix over the single immutable dataset identified by `requestId`.\n * The backend expands and executes the matrix internally; clients poll the returned\n * `sweepId` for incremental results.\n *\n */\nexport const executeSweep = <ThrowOnError extends boolean = false>(options: Options<ExecuteSweepData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<ExecuteSweepResponse, ExecuteSweepError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}',\n        ...options,\n        headers: {\n            'Content-Type': 'application/json',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Cancel a running parameter sweep\n * Requests cancellation between parameter vectors. Completed rows remain readable.\n */\nexport const cancelSweep = <ThrowOnError extends boolean = false>(options: Options<CancelSweepData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).delete<CancelSweepResponse, CancelSweepError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',\n        ...options\n    });\n};\n\n/**\n * Get sweep progress and results\n * Returns incremental sweep progress. The default `ranked` view sorts and may truncate the\n * display leaderboard. `order=natural` returns every available row, untruncated, ordered by\n * deterministic `runIx`; use that view when materialising durable trial rows.\n *\n */\nexport const getSweepResult = <ThrowOnError extends boolean = false>(options: Options<GetSweepResultData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetSweepResultResponse, GetSweepResultError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',\n        ...options\n    });\n};\n\n/**\n * Execute a compiled strategy against a prepared dataset\n * Enqueues an execute task that runs the strategy identified by `strategyId` over the data\n * prepared by the prepare job identified by `prepareJobId`. The instrument and date range are\n * recovered from the prepare job — they do not need to be sent again.\n *\n * Returns immediately with a `jobId`; poll `GET /backtest/{exchangeId}/{type}/execute/{jobId}`\n * for the result.\n *\n * The same params (same `prepareJobId`, `strategyId`, `storeSignals`) always return the same\n * `jobId` (idempotent).\n *\n */\nexport const executeBacktest = <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<ExecuteBacktestResponse, ExecuteBacktestError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute',\n        ...options,\n        headers: {\n            'Content-Type': 'application/json',\n            ...options?.headers\n        }\n    });\n};\n\n/**\n * Cancel a running backtest execution\n * Requests cancellation of the specified execution. The execution\n * status will transition to `Aborted` once the cancellation is\n * processed. Cancellation is asynchronous — poll the GET endpoint\n * to confirm the final status.\n *\n */\nexport const cancelBacktest = <ThrowOnError extends boolean = false>(options: Options<CancelBacktestData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).delete<CancelBacktestResponse, CancelBacktestError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',\n        ...options\n    });\n};\n\n/**\n * Get the result of a backtest execution job\n * Retrieves the current state and results of the execute job identified by `jobId`.\n * Poll until `state.status` is `Completed`, `Failed`, or `Aborted`.\n *\n */\nexport const getBacktestResult = <ThrowOnError extends boolean = false>(options: Options<GetBacktestResultData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).get<GetBacktestResultResponse, GetBacktestResultError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/backtest/{exchangeId}/{type}/execute/{jobId}',\n        ...options\n    });\n};"],"mappings":";AAGA,SAAkE,cAAc,oBAAoB;AAY7F,IAAM,SAAS,aAAa,aAA4B;AAAA,EAC3D,SAAS;AACb,CAAC,CAAC;;;ACeK,IAAM,eAAe,CAAuC,YAAsD;AACrH,UAAQ,SAAS,UAAU,QAAe,KAA4D;AAAA,IAClG,UAAU;AAAA,MACN;AAAA,QACI,MAAM;AAAA,QACN,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAKO,IAAM,gBAAgB,CAAuC,YAAuD;AACvH,UAAQ,SAAS,UAAU,QAAe,IAAkD;AAAA,IACxF,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAUO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,IAAiE;AAAA,IACtG,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAUO,IAAM,yBAAyB,CAAuC,YAA+D;AACxI,UAAQ,QAAQ,UAAU,QAAe,IAA+E;AAAA,IACpH,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAkCO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,IAAiE;AAAA,IACtG,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAcO,IAAM,iBAAiB,CAAuC,YAAuD;AACxH,UAAQ,QAAQ,UAAU,QAAe,IAA+D;AAAA,IACpG,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAaO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,KAAkE;AAAA,IACvG,gBAAgB;AAAA,IAChB,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAQO,IAAM,cAAc,CAAuC,YAAoD;AAClH,UAAQ,QAAQ,UAAU,QAAe,IAAyD;AAAA,IAC9F,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAWO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,KAAkE;AAAA,IACvG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAQO,IAAM,mBAAmB,CAAuC,YAAyD;AAC5H,UAAQ,QAAQ,UAAU,QAAe,IAAmE;AAAA,IACxG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AASO,IAAM,eAAe,CAAuC,YAAqD;AACpH,UAAQ,QAAQ,UAAU,QAAe,KAA4D;AAAA,IACjG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAMO,IAAM,cAAc,CAAuC,YAAoD;AAClH,UAAQ,QAAQ,UAAU,QAAe,OAA4D;AAAA,IACjG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AASO,IAAM,iBAAiB,CAAuC,YAAuD;AACxH,UAAQ,QAAQ,UAAU,QAAe,IAA+D;AAAA,IACpG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAeO,IAAM,kBAAkB,CAAuC,YAAwD;AAC1H,UAAQ,QAAQ,UAAU,QAAe,KAAkE;AAAA,IACvG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,IACH,SAAS;AAAA,MACL,gBAAgB;AAAA,MAChB,GAAG,SAAS;AAAA,IAChB;AAAA,EACJ,CAAC;AACL;AAUO,IAAM,iBAAiB,CAAuC,YAAuD;AACxH,UAAQ,QAAQ,UAAU,QAAe,OAAkE;AAAA,IACvG,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;AAQO,IAAM,oBAAoB,CAAuC,YAA0D;AAC9H,UAAQ,QAAQ,UAAU,QAAe,IAAqE;AAAA,IAC1G,UAAU;AAAA,MACN;AAAA,QACI,QAAQ;AAAA,QACR,MAAM;AAAA,MACV;AAAA,IACJ;AAAA,IACA,KAAK;AAAA,IACL,GAAG;AAAA,EACP,CAAC;AACL;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qtsurfer/api-client",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Auto-generated TypeScript API client for the QTSurfer API (from OpenAPI 3.1 spec)",
   "type": "module",
   "main": "./dist/index.js",

package/src/generated/schemas.gen.ts

@@ -237,6 +237,51 @@ export const DataSourceTypeSchema = {
     example: 'ticker'
 } as const;
 
+export const PrepareRequestSchema = {
+    type: 'object',
+    required: ['instrument', 'from', 'to'],
+    properties: {
+        instrument: {
+            '$ref': '#/components/schemas/Instrument'
+        },
+        from: {
+            type: 'string',
+            description: `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)
+`,
+            example: '2024-12-13T00:00:00Z'
+        },
+        to: {
+            type: 'string',
+            description: `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)
+`,
+            example: '2024-12-14'
+        },
+        cadence: {
+            type: 'string',
+            description: `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\`.
+`,
+            enum: ['1s', '5s', '1m', '5m', '15m', '1h', '4h', '1d'],
+            default: '1s'
+        }
+    },
+    example: {
+        instrument: 'BTC/USDT',
+        from: '2024-12-13T00:00:00Z',
+        to: '2024-12-14T00:00:00Z',
+        cadence: '1m'
+    }
+} as const;
+
 export const JobStateSchema = {
     type: 'object',
     description: 'Information about a single job',
@@ -370,6 +415,340 @@ instrument did not trade that hour. \`unknown\`: no data to classify by.
     ]
 } as const;
 
+export const SweepAxisSchema = {
+    description: 'A numeric range or an explicit list of values for one strategy property.',
+    oneOf: [
+        {
+            type: 'object',
+            required: ['from', 'to', 'step'],
+            additionalProperties: false,
+            properties: {
+                from: {
+                    type: 'number',
+                    format: 'double'
+                },
+                to: {
+                    type: 'number',
+                    format: 'double'
+                },
+                step: {
+                    type: 'number',
+                    format: 'double',
+                    exclusiveMinimum: 0
+                }
+            }
+        },
+        {
+            type: 'object',
+            required: ['values'],
+            additionalProperties: false,
+            properties: {
+                values: {
+                    type: 'array',
+                    minItems: 1,
+                    items: {
+                        oneOf: [
+                            {
+                                type: 'number'
+                            },
+                            {
+                                type: 'boolean'
+                            }
+                        ]
+                    }
+                }
+            }
+        }
+    ]
+} as const;
+
+export const SweepSpecRequestSchema = {
+    type: 'object',
+    required: ['params'],
+    properties: {
+        sampler: {
+            type: 'string',
+            enum: ['grid', 'random', 'lhs'],
+            default: 'grid'
+        },
+        seed: {
+            type: 'integer',
+            format: 'int64',
+            minimum: -9007199254740991,
+            maximum: 9007199254740991,
+            description: `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.
+`
+        },
+        samples: {
+            type: 'integer',
+            minimum: 1,
+            description: 'Number of samples for `random` and `lhs`; ignored by `grid`.'
+        },
+        objective: {
+            type: 'string',
+            enum: ['sharpe', 'sortino', 'pnl', 'maxdd'],
+            default: 'sharpe'
+        },
+        params: {
+            type: 'object',
+            minProperties: 1,
+            additionalProperties: {
+                '$ref': '#/components/schemas/SweepAxis'
+            }
+        }
+    },
+    example: {
+        sampler: 'lhs',
+        seed: 487221,
+        samples: 100,
+        objective: 'sharpe',
+        params: {
+            rsiPeriod: {
+                from: 7,
+                to: 28,
+                step: 1
+            },
+            useTrendFilter: {
+                values: [true, false]
+            }
+        }
+    }
+} as const;
+
+export const SweepBaseConfigSchema = {
+    type: 'object',
+    properties: {
+        initialFunding: {
+            type: 'number',
+            format: 'double',
+            exclusiveMinimum: 0,
+            default: 10000
+        },
+        feeRate: {
+            type: 'number',
+            format: 'double',
+            minimum: 0,
+            default: 0.001
+        },
+        buyFeeRate: {
+            type: 'number',
+            format: 'double',
+            minimum: 0
+        },
+        sellFeeRate: {
+            type: 'number',
+            format: 'double',
+            minimum: 0
+        },
+        feeLeg: {
+            type: 'string',
+            enum: ['RECEIVED', 'QUOTE', 'BASE'],
+            default: 'RECEIVED'
+        },
+        percentAmountToLock: {
+            type: 'number',
+            format: 'double',
+            exclusiveMinimum: 0,
+            maximum: 100
+        }
+    }
+} as const;
+
+export const ExecuteSweepRequestSchema = {
+    type: 'object',
+    required: ['strategyId', 'sweep'],
+    properties: {
+        strategyId: {
+            '$ref': '#/components/schemas/strategyId'
+        },
+        sweep: {
+            '$ref': '#/components/schemas/SweepSpecRequest'
+        },
+        baseConfig: {
+            '$ref': '#/components/schemas/SweepBaseConfig'
+        },
+        storeSignals: {
+            type: 'boolean',
+            default: false,
+            description: 'Store signals for every trial. Keep false for normal sweeps.'
+        },
+        shards: {
+            type: 'integer',
+            minimum: 0,
+            description: 'Requested horizontal shard count; 0 or omitted selects automatically.',
+            default: 0
+        },
+        minTradeFloor: {
+            type: 'integer',
+            minimum: 0,
+            default: 30,
+            description: 'Trials below this trade count are flagged but remain in the results.'
+        }
+    }
+} as const;
+
+export const ExecuteSweepAcceptedSchema = {
+    type: 'object',
+    required: ['sweepId', 'requestId', 'totalRuns', 'shards', 'seed', 'queued'],
+    properties: {
+        sweepId: {
+            type: 'string',
+            example: 'swp_95e47a7f0966ce11'
+        },
+        requestId: {
+            type: 'string'
+        },
+        totalRuns: {
+            type: 'integer',
+            minimum: 1
+        },
+        shards: {
+            type: 'integer',
+            minimum: 1
+        },
+        seed: {
+            type: 'integer',
+            format: 'int64',
+            minimum: -9007199254740991,
+            maximum: 9007199254740991,
+            description: 'Effective seed used to expand the sweep.'
+        },
+        queued: {
+            type: 'boolean',
+            description: 'False when an identical sweep already exists and was not enqueued again.'
+        }
+    }
+} as const;
+
+export const SweepProgressSchema = {
+    type: 'object',
+    required: ['done', 'total', 'aborted', 'shardCount', 'pendingShards'],
+    properties: {
+        done: {
+            type: 'integer',
+            format: 'int64'
+        },
+        total: {
+            type: 'integer'
+        },
+        aborted: {
+            type: 'integer',
+            format: 'int64'
+        },
+        shardCount: {
+            type: 'integer'
+        },
+        pendingShards: {
+            type: 'integer'
+        }
+    }
+} as const;
+
+export const SweepRunRowSchema = {
+    type: 'object',
+    required: ['runIx', 'params', 'sharpe', 'sortino', 'pnl', 'pnlPct', 'cagr', 'maxDdPct', 'trades', 'winRate', 'belowTradeFloor', 'aborted', 'runtimeMs'],
+    properties: {
+        runIx: {
+            type: 'integer',
+            minimum: 0,
+            description: 'Deterministic zero-based expansion index, stable across shards and ranking.'
+        },
+        rank: {
+            type: 'integer',
+            minimum: 1,
+            description: 'Present only in the `ranked` view.'
+        },
+        params: {
+            type: 'object',
+            additionalProperties: true
+        },
+        sharpe: {
+            type: 'number',
+            format: 'double'
+        },
+        sortino: {
+            type: 'number',
+            format: 'double'
+        },
+        pnl: {
+            type: 'number',
+            format: 'double',
+            description: 'Absolute net PnL in the output currency.'
+        },
+        pnlPct: {
+            type: 'number',
+            format: 'double'
+        },
+        cagr: {
+            type: 'number',
+            format: 'double'
+        },
+        maxDdPct: {
+            type: 'number',
+            format: 'double'
+        },
+        trades: {
+            type: 'integer',
+            format: 'int64'
+        },
+        winRate: {
+            type: 'number',
+            format: 'double'
+        },
+        belowTradeFloor: {
+            type: 'boolean'
+        },
+        aborted: {
+            type: 'boolean'
+        },
+        runtimeMs: {
+            type: 'integer',
+            format: 'int64'
+        }
+    }
+} as const;
+
+export const ExecuteSweepResultSchema = {
+    type: 'object',
+    required: ['sweepId', 'status', 'objective', 'order', 'progress', 'leaderboardSize', 'truncated', 'leaderboard'],
+    properties: {
+        sweepId: {
+            type: 'string'
+        },
+        status: {
+            type: 'string',
+            enum: ['RUNNING', 'COMPLETED', 'PARTIAL', 'CANCELLED']
+        },
+        objective: {
+            type: 'string',
+            enum: ['sharpe', 'sortino', 'pnl', 'maxdd']
+        },
+        order: {
+            type: 'string',
+            enum: ['ranked', 'natural']
+        },
+        progress: {
+            '$ref': '#/components/schemas/SweepProgress'
+        },
+        leaderboardSize: {
+            type: 'integer',
+            description: 'Total result rows currently available.'
+        },
+        truncated: {
+            type: 'boolean',
+            description: 'True only when the ranked view exceeds its display limit.'
+        },
+        leaderboard: {
+            type: 'array',
+            items: {
+                '$ref': '#/components/schemas/SweepRunRow'
+            }
+        }
+    }
+} as const;
+
 export const AcceptedJobSchema = {
     type: 'object',
     description: `Response returned by async endpoints (\`202 Accepted\`). The \`jobId\` is deterministic for the