@qtsurfer/api-client 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -409,7 +409,7 @@ type BacktestJobResult = {
     state: JobState;
 };
 /**
- * Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below.
+ * Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below. `notices` carries what the run had to say about itself, and is absent when it had nothing.
  */
 type ResultMap = {
     /**
@@ -421,13 +421,36 @@ type ResultMap = {
      */
     iops?: number;
     /**
-     * Identifier of the compiled strategy that produced this result
+     * **Not the `strategyId` you compiled with** — this is the execution context id,
+     * `strategy:<user>:<strategyId>`. The compiled strategy's id is the last `:`-separated
+     * segment; that, not this whole string, is what `GET /strategy/{strategyId}` takes.
+     *
+     * Take the segment after the last `:` rather than counting from the front: the shape has
+     * changed once already and callers that indexed a fixed position broke on it.
+     *
      */
     strategyId: string;
     /**
      * The instrument (currency pair) that was backtested
      */
     instrument: string;
+    /**
+     * Diagnostics the engine raised over this run, each with `provenance: execute`.
+     *
+     * **Absent means nothing was raised.** This is the one surface where silence is a real
+     * answer: the run happened, over your data, start to finish, and the engine found nothing
+     * worth saying. That is not true of the compile path, where an empty list only means a
+     * short synthetic series reached nothing — see `GET /strategy/{strategyId}`.
+     *
+     * Notices are raised on failed and aborted runs too, and those are the ones most worth
+     * reading: a run that produced no trades often did so for a reason stated here.
+     *
+     */
+    notices?: Array<Notice>;
+    /**
+     * How many notices were dropped past the cap of 50. Absent when none were. A large value usually means one fault repeating per instrument or per parameter vector rather than 50 distinct problems.
+     */
+    noticesTruncated?: number;
     /**
      * Total profit and loss in the output currency
      */
@@ -507,9 +530,110 @@ type EquityPoint = {
     equity: number;
 };
 /**
- * Unique identifier for a compiled strategy
+ * Unique identifier for a compiled strategy, derived from the source itself: the same code
+ * always yields the same id, for every caller, whatever its formatting. See
+ * `POST /strategy` for exactly which rewrites preserve it and which do not.
+ *
  */
 type StrategyId = string;
+/**
+ * A diagnostic the engine raised while the strategy ran. Advisory: it describes something worth
+ * knowing about how the strategy is wired, not necessarily an error.
+ *
+ */
+type Notice = {
+    /**
+     * Severity as the engine classified it.
+     */
+    level: string;
+    /**
+     * Stable identifier for the kind of finding; safe to match on.
+     */
+    code: string;
+    /**
+     * Human-readable explanation.
+     */
+    message: string;
+    /**
+     * Where it came from, which matters because the two silences differ: an empty list from a
+     * real run (`execute`) is a clean bill of health, while an empty list from
+     * `compile-dry-run` is only a lower bound over a bounded synthetic series.
+     *
+     */
+    provenance?: 'execute' | 'compile-dry-run';
+};
+/**
+ * What is known about a registered strategy: that it compiled, and what validating it found.
+ *
+ * **`validation: passed` does not mean the strategy is correct.** It means the class loaded and
+ * survived the first event of a short synthetic run — a floor, not a guarantee. When
+ * `dryRunIncomplete` is true it is a lower floor still, because the run did not finish.
+ *
+ */
+type StrategyState = {
+    strategyId: StrategyId;
+    /**
+     * * `not_validated` — registered, never checked. `POST /strategy/{strategyId}/validate`
+     * checks it.
+     * * `pending` — a check was asked for and has not answered yet.
+     * * `passed` — the class loaded and survived its first event.
+     * * `failed` — it did not; `detail` says how.
+     *
+     */
+    validation: 'not_validated' | 'pending' | 'passed' | 'failed';
+    /**
+     * When the live compilation was produced.
+     */
+    compiledAt?: string;
+    /**
+     * The market data a strategy needs, read off the compiled class rather than off anything
+     * you sent — `TickerStrategy`, `KlineStrategy` and `FundingRateStrategy` each declare one,
+     * and a `MultiSourceStrategy` declares a set.
+     *
+     * **Absent is not "needs nothing".** A strategy always needs market data, so an absent
+     * field never means an empty requirement — it means the platform could not establish the
+     * answer without constructing your strategy, which it will not do to fill in a field.
+     * That happens for a `MultiSourceStrategy`, for a class that overrides
+     * `getMarketDataSource()`, and for anything registered before this field existed;
+     * re-registering the source fills it in.
+     *
+     */
+    requiredSources?: Array<'Ticker' | 'KLine' | 'FundingRate'>;
+    /**
+     * When the verdict was recorded. Absent until there is one.
+     */
+    validatedAt?: string;
+    /**
+     * Why validation failed, or why a queued check has not reported. Present on `failed`, and
+     * alongside `validationStalled`.
+     *
+     */
+    detail?: string;
+    /**
+     * What the run surfaced. An empty or absent list is not a clean bill of health when
+     * `dryRunIncomplete` is true — see that field.
+     *
+     */
+    notices?: Array<Notice>;
+    /**
+     * How many notices were dropped past the cap. Absent when none were.
+     */
+    noticesTruncated?: number;
+    /**
+     * The check did not finish its budget — it ran out of time, was refused because the
+     * platform was already holding too many unfinishable runs, or hit a failure attributable to
+     * the synthetic instrument rather than to your strategy. The verdict stands as far as it
+     * went; it simply reached less than a full run would.
+     *
+     */
+    dryRunIncomplete?: boolean;
+    /**
+     * A queued check has not reported for far longer than one takes. Nothing is disproved about
+     * the strategy — the check has not run. Stop waiting and re-request it later.
+     *
+     */
+    validationStalled?: boolean;
+};
 type AuthTokenResponse = {
     /**
      * Short-lived HS256 JWT. Send as `Authorization: Bearer <token>` on all other endpoints.
@@ -757,70 +881,89 @@ type CompileStrategyData = {
      * Raw strategy Java source code
      */
     body: string;
-    headers?: {
-        /**
-         * When `true`, compile asynchronously and return `202` with a `jobId`.
-         */
-        'X-Compile-Async'?: boolean;
-    };
     path?: never;
     query?: never;
     url: '/strategy';
 };
 type CompileStrategyErrors = {
     /**
-     * Invalid strategy (compilation error)
+     * The source is not valid Java; the message carries the compiler diagnostics. Nothing is
+     * registered, so there is no id to look up afterwards.
+     *
      */
     400: ResponseError;
+    /**
+     * Too many compilations in flight. Retry later.
+     */
+    429: ResponseError;
 };
 type CompileStrategyError = CompileStrategyErrors[keyof CompileStrategyErrors];
 type CompileStrategyResponses = {
     /**
-     * Strategy compiled successfully (sync mode)
+     * Compiled and registered
      */
     200: {
         strategyId: StrategyId;
     };
+};
+type CompileStrategyResponse = CompileStrategyResponses[keyof CompileStrategyResponses];
+type ValidateStrategyData = {
+    body?: never;
+    path: {
+        /**
+         * The id returned by `POST /strategy`
+         */
+        strategyId: StrategyId;
+    };
+    query?: never;
+    url: '/strategy/{strategyId}/validate';
+};
+type ValidateStrategyErrors = {
     /**
-     * Compile task accepted (async mode — set `X-Compile-Async: true`)
+     * No such registered strategy for this user
      */
-    202: AcceptedJob;
+    404: ResponseError;
 };
-type CompileStrategyResponse = CompileStrategyResponses[keyof CompileStrategyResponses];
+type ValidateStrategyError = ValidateStrategyErrors[keyof ValidateStrategyErrors];
+type ValidateStrategyResponses = {
+    /**
+     * Already validated; the recorded verdict, unchanged
+     */
+    200: StrategyState;
+    /**
+     * Validation queued. Not a terminal outcome — poll `GET /strategy/{strategyId}` until
+     * `validation` leaves `pending`.
+     *
+     */
+    202: {
+        strategyId: StrategyId;
+        validation: 'pending';
+    };
+};
+type ValidateStrategyResponse = ValidateStrategyResponses[keyof ValidateStrategyResponses];
 type GetStrategyData = {
     body?: never;
     path: {
         /**
-         * The id returned by `POST /strategy` (sync) or the `jobId` returned in async mode
+         * The id returned by `POST /strategy`
          */
-        strategyId: string;
+        strategyId: StrategyId;
     };
     query?: never;
     url: '/strategy/{strategyId}';
 };
 type GetStrategyErrors = {
     /**
-     * Strategy compile job not found
+     * No such registered strategy for this user
      */
     404: ResponseError;
 };
 type GetStrategyError = GetStrategyErrors[keyof GetStrategyErrors];
 type GetStrategyResponses = {
     /**
-     * Strategy compile state
+     * Strategy state
      */
-    200: {
-        /**
-         * Compile job id (only set in async mode)
-         */
-        jobId?: string;
-        status: 'New' | 'Started' | 'Completed' | 'Aborted' | 'Failed';
-        strategyId?: StrategyId;
-        /**
-         * Compilation error messages when `status` is `Failed`
-         */
-        statusDetail?: string | null;
-    };
+    200: StrategyState;
 };
 type GetStrategyResponse = GetStrategyResponses[keyof GetStrategyResponses];
 type PrepareBacktestData = {
@@ -1231,29 +1374,58 @@ declare const downloadTickers: <ThrowOnError extends boolean = false>(options: O
  */
 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
- * 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`.
+ *
+ * **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.
+ *
+ */
+declare const compileStrategy: <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
+    strategyId: StrategyId;
+}, ResponseError, ThrowOnError>;
+/**
+ * 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`.
  *
- * The `strategyId` is deterministic: the same source for the same user always produces the
- * same id.
+ * Recompiling supersedes a verdict, which makes this callable again — the old answer described
+ * bytecode that is no longer what would run.
  *
  */
-declare const compileStrategy: <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CompileStrategyResponse, ResponseError, ThrowOnError>;
+declare const validateStrategy: <ThrowOnError extends boolean = false>(options: Options<ValidateStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidateStrategyResponse, ResponseError, ThrowOnError>;
 /**
- * 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.
+ * 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.
  *
  */
-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>;
+declare const getStrategy: <ThrowOnError extends boolean = false>(options: Options<GetStrategyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<StrategyState, ResponseError, ThrowOnError>;
 /**
  * Prepare backtest data
  * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;
@@ -1335,4 +1507,4 @@ declare const getBacktestResult: <ThrowOnError extends boolean = false>(options:
 
 declare const client: _hey_api_client_fetch.Client;
 
-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 };
+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 Notice, type Options, type PrepareBacktestData, type PrepareBacktestError, type PrepareBacktestErrors, type PrepareBacktestResponse, type PrepareBacktestResponses, type PrepareJobState, type PrepareRequest, type ResponseError, type ResultMap, type StrategyId, type StrategyState, type SweepAxis, type SweepBaseConfig, type SweepProgress, type SweepRunRow, type SweepSpecRequest, type ValidateStrategyData, type ValidateStrategyError, type ValidateStrategyErrors, type ValidateStrategyResponse, type ValidateStrategyResponses, authenticate, cancelBacktest, cancelSweep, client, compileStrategy, downloadKlines, downloadTickers, executeBacktest, executeSweep, getBacktestResult, getPrepareStatus, getStrategy, getSweepResult, listExchanges, listInstruments, listSegmentInstruments, prepareBacktest, validateStrategy };

package/dist/index.js

@@ -64,6 +64,18 @@ var compileStrategy = (options) => {
     }
   });
 };
+var validateStrategy = (options) => {
+  return (options.client ?? client).post({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http"
+      }
+    ],
+    url: "/strategy/{strategyId}/validate",
+    ...options
+  });
+};
 var getStrategy = (options) => {
   return (options.client ?? client).get({
     security: [
@@ -201,6 +213,7 @@ export {
   listExchanges,
   listInstruments,
   listSegmentInstruments,
-  prepareBacktest
+  prepareBacktest,
+  validateStrategy
 };
 //# 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 { 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 * A `202` means the result is not readable yet — keep polling. It is never a terminal\n * outcome, and it carries no `state`, so a poll loop that stops on a terminal status will\n * not stop on it.\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;AAYO,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":[]}
+{"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, ValidateStrategyData, ValidateStrategyResponse, ValidateStrategyError, 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 and register a strategy\n * Compiles raw strategy source and registers it, returning its `strategyId`.\n *\n * **This answers one question: is the source valid Java.** It compiles, registers, and hands\n * back the id — nothing more. Whether the class can actually run is\n * `POST /strategy/{strategyId}/validate`, and everything known about a strategy, validation\n * included, is read from `GET /strategy/{strategyId}`. One place to ask, so there is no second\n * answer to keep in step.\n *\n * The `strategyId` is derived from what the code *means*, not from how it is written. Adding a\n * comment, inserting a blank line, re-indenting, reordering imports, or moving a method around\n * all return the **same** id — you have not created a second strategy. Renaming a variable,\n * changing an identifier's case, reordering fields, or reordering statements inside a method\n * return a **different** one.\n *\n * Two rules follow, and they are worth designing around:\n *\n * - re-submitting a strategy you have only reformatted is free, and gives you back the id you\n * already had, along with any validation already recorded against it;\n * - the id says nothing about *behaviour*. Two sources that compute the same thing by\n * different means are two strategies, because deciding otherwise would mean deciding program\n * equivalence.\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 * Check that a registered strategy can actually run\n * Instantiates the compiled class and drives it through a bounded synthetic series, so a wiring\n * fault surfaces here instead of at your first backtest. The verdict — pass or fail, plus any\n * engine notices — is recorded and served from `GET /strategy/{strategyId}`.\n *\n * **Idempotent.** If a verdict already exists for the current compilation it comes straight\n * back with `200` and nothing is queued. Otherwise the check is queued and this returns `202`;\n * poll `GET /strategy/{strategyId}` until `validation` is `passed` or `failed`.\n *\n * Recompiling supersedes a verdict, which makes this callable again — the old answer described\n * bytecode that is no longer what would run.\n *\n */\nexport const validateStrategy = <ThrowOnError extends boolean = false>(options: Options<ValidateStrategyData, ThrowOnError>) => {\n    return (options.client ?? _heyApiClient).post<ValidateStrategyResponse, ValidateStrategyError, ThrowOnError>({\n        security: [\n            {\n                scheme: 'bearer',\n                type: 'http'\n            }\n        ],\n        url: '/strategy/{strategyId}/validate',\n        ...options\n    });\n};\n\n/**\n * Get a strategy by id, including its validation state\n * Reports that the strategy is registered — implied by a `200` at all — and what validating it\n * found.\n *\n * A `404` means one thing: no such registered strategy for this user. It is never a stale or\n * expired answer; registration and verdict are stored durably, not cached.\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 * A `202` means the result is not readable yet — keep polling. It is never a terminal\n * outcome, and it carries no `state`, so a poll loop that stops on a terminal status will\n * not stop on it.\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;AA2BO,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;AAgBO,IAAM,mBAAmB,CAAuC,YAAyD;AAC5H,UAAQ,QAAQ,UAAU,QAAe,KAAoE;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;AAWO,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;AAYO,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.6.0",
+  "version": "0.7.0",
   "description": "Auto-generated TypeScript API client for the QTSurfer API (from OpenAPI 3.1 spec)",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,7 +22,11 @@
     "generate": "openapi-ts",
     "build": "tsup",
     "lint": "tsc --noEmit",
-    "prepublishOnly": "npm run build"
+    "docs": "typedoc",
+    "prepublishOnly": "npm run build",
+    "changeset": "changeset",
+    "changeset:version": "changeset version",
+    "changeset:publish": "changeset publish"
   },
   "repository": {
     "type": "git",
@@ -47,8 +51,11 @@
     "access": "public"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.6.0",
+    "@changesets/cli": "^2.31.1",
     "@hey-api/openapi-ts": "^0.66",
     "tsup": "^8.5.1",
+    "typedoc": "^0.28.20",
     "typescript": "^5.8.0"
   },
   "dependencies": {

package/src/generated/schemas.gen.ts

@@ -783,7 +783,7 @@ export const BacktestJobResultSchema = {
 
 export const ResultMapSchema = {
     type: 'object',
-    description: 'Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below.',
+    description: 'Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below. `notices` carries what the run had to say about itself, and is absent when it had nothing.',
     required: ['strategyId', 'instrument'],
     properties: {
         hostName: {
@@ -799,14 +799,41 @@ export const ResultMapSchema = {
         },
         strategyId: {
             type: 'string',
-            description: 'Identifier of the compiled strategy that produced this result',
-            example: 'strategy:00000000-0000-0000-0000-000000000000:ticker:2iyvtenlzh9dabqtxn7nbv'
+            description: `**Not the \`strategyId\` you compiled with** — this is the execution context id,
+\`strategy:<user>:<strategyId>\`. The compiled strategy's id is the last \`:\`-separated
+segment; that, not this whole string, is what \`GET /strategy/{strategyId}\` takes.
+
+Take the segment after the last \`:\` rather than counting from the front: the shape has
+changed once already and callers that indexed a fixed position broke on it.
+`,
+            example: 'strategy:00000000-0000-0000-0000-000000000000:2iyvtenlzh9dabqtxn7nbv'
         },
         instrument: {
             type: 'string',
             description: 'The instrument (currency pair) that was backtested',
             example: 'BTC/USDT'
         },
+        notices: {
+            type: 'array',
+            description: `Diagnostics the engine raised over this run, each with \`provenance: execute\`.
+
+**Absent means nothing was raised.** This is the one surface where silence is a real
+answer: the run happened, over your data, start to finish, and the engine found nothing
+worth saying. That is not true of the compile path, where an empty list only means a
+short synthetic series reached nothing — see \`GET /strategy/{strategyId}\`.
+
+Notices are raised on failed and aborted runs too, and those are the ones most worth
+reading: a run that produced no trades often did so for a reason stated here.
+`,
+            items: {
+                '$ref': '#/components/schemas/Notice'
+            }
+        },
+        noticesTruncated: {
+            type: 'integer',
+            description: 'How many notices were dropped past the cap of 50. Absent when none were. A large value usually means one fault repeating per instrument or per parameter vector rather than 50 distinct problems.',
+            example: 3
+        },
         pnlTotal: {
             type: 'number',
             format: 'double',
@@ -939,11 +966,153 @@ export const EquityPointSchema = {
 } as const;
 
 export const strategyIdSchema = {
-    description: 'Unique identifier for a compiled strategy',
+    description: `Unique identifier for a compiled strategy, derived from the source itself: the same code
+always yields the same id, for every caller, whatever its formatting. See
+\`POST /strategy\` for exactly which rewrites preserve it and which do not.
+`,
     type: 'string',
     example: '6bsh31ikwkuivhtgcoa6s4'
 } as const;
 
+export const NoticeSchema = {
+    type: 'object',
+    description: `A diagnostic the engine raised while the strategy ran. Advisory: it describes something worth
+knowing about how the strategy is wired, not necessarily an error.
+`,
+    required: ['level', 'code', 'message'],
+    properties: {
+        level: {
+            type: 'string',
+            description: 'Severity as the engine classified it.',
+            example: 'WARN'
+        },
+        code: {
+            type: 'string',
+            description: 'Stable identifier for the kind of finding; safe to match on.',
+            example: 'indicator.bar-data-on-ticker-path'
+        },
+        message: {
+            type: 'string',
+            description: 'Human-readable explanation.',
+            example: 'Indicator requires bar data but is on the ticker path'
+        },
+        provenance: {
+            type: 'string',
+            enum: ['execute', 'compile-dry-run'],
+            description: `Where it came from, which matters because the two silences differ: an empty list from a
+real run (\`execute\`) is a clean bill of health, while an empty list from
+\`compile-dry-run\` is only a lower bound over a bounded synthetic series.
+`,
+            example: 'compile-dry-run'
+        }
+    }
+} as const;
+
+export const StrategyStateSchema = {
+    type: 'object',
+    description: `What is known about a registered strategy: that it compiled, and what validating it found.
+
+**\`validation: passed\` does not mean the strategy is correct.** It means the class loaded and
+survived the first event of a short synthetic run — a floor, not a guarantee. When
+\`dryRunIncomplete\` is true it is a lower floor still, because the run did not finish.
+`,
+    required: ['strategyId', 'validation'],
+    properties: {
+        strategyId: {
+            '$ref': '#/components/schemas/strategyId'
+        },
+        validation: {
+            type: 'string',
+            enum: ['not_validated', 'pending', 'passed', 'failed'],
+            description: `* \`not_validated\` — registered, never checked. \`POST /strategy/{strategyId}/validate\`
+  checks it.
+* \`pending\` — a check was asked for and has not answered yet.
+* \`passed\` — the class loaded and survived its first event.
+* \`failed\` — it did not; \`detail\` says how.
+`,
+            example: 'passed'
+        },
+        compiledAt: {
+            type: 'string',
+            format: 'date-time',
+            description: 'When the live compilation was produced.'
+        },
+        requiredSources: {
+            type: 'array',
+            description: `The market data a strategy needs, read off the compiled class rather than off anything
+you sent — \`TickerStrategy\`, \`KlineStrategy\` and \`FundingRateStrategy\` each declare one,
+and a \`MultiSourceStrategy\` declares a set.
+
+**Absent is not "needs nothing".** A strategy always needs market data, so an absent
+field never means an empty requirement — it means the platform could not establish the
+answer without constructing your strategy, which it will not do to fill in a field.
+That happens for a \`MultiSourceStrategy\`, for a class that overrides
+\`getMarketDataSource()\`, and for anything registered before this field existed;
+re-registering the source fills it in.
+`,
+            items: {
+                type: 'string',
+                enum: ['Ticker', 'KLine', 'FundingRate']
+            },
+            example: ['Ticker']
+        },
+        validatedAt: {
+            type: 'string',
+            format: 'date-time',
+            description: 'When the verdict was recorded. Absent until there is one.'
+        },
+        detail: {
+            type: 'string',
+            description: `Why validation failed, or why a queued check has not reported. Present on \`failed\`, and
+alongside \`validationStalled\`.
+`
+        },
+        notices: {
+            type: 'array',
+            description: `What the run surfaced. An empty or absent list is not a clean bill of health when
+\`dryRunIncomplete\` is true — see that field.
+`,
+            items: {
+                '$ref': '#/components/schemas/Notice'
+            }
+        },
+        noticesTruncated: {
+            type: 'integer',
+            description: 'How many notices were dropped past the cap. Absent when none were.',
+            example: 3
+        },
+        dryRunIncomplete: {
+            type: 'boolean',
+            description: `The check did not finish its budget — it ran out of time, was refused because the
+platform was already holding too many unfinishable runs, or hit a failure attributable to
+the synthetic instrument rather than to your strategy. The verdict stands as far as it
+went; it simply reached less than a full run would.
+`
+        },
+        validationStalled: {
+            type: 'boolean',
+            description: `A queued check has not reported for far longer than one takes. Nothing is disproved about
+the strategy — the check has not run. Stop waiting and re-request it later.
+`
+        }
+    },
+    example: {
+        strategyId: '6bsh31ikwkuivhtgcoa6s4',
+        validation: 'passed',
+        compiledAt: '2026-08-04T16:23:04Z',
+        requiredSources: ['Ticker'],
+        validatedAt: '2026-08-04T16:24:11Z',
+        notices: [
+            {
+                level: 'WARN',
+                code: 'indicator.bar-data-on-ticker-path',
+                message: 'Indicator requires bar data but is on the ticker path',
+                provenance: 'compile-dry-run'
+            }
+        ]
+    }
+} as const;
+
 export const AuthTokenResponseSchema = {
     type: 'object',
     required: ['access_token', 'token_type', 'expires_in', 'tier'],

package/src/generated/sdk.gen.ts

@@ -1,7 +1,7 @@
 // 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 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, 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> & {
@@ -142,14 +142,28 @@ export const downloadKlines = <ThrowOnError extends boolean = false>(options: Op
 };
 
 /**
- * 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>) => {
@@ -171,9 +185,39 @@ export const compileStrategy = <ThrowOnError extends boolean = false>(options: O
 };
 
 /**
- * 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 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>) => {

package/src/generated/types.gen.ts

@@ -432,7 +432,7 @@ export type BacktestJobResult = {
 };
 
 /**
- * Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below.
+ * Execution result map. Always includes core fields (hostName, iops, strategyId, instrument). Yield metrics (pnlTotal, pnlTotalPercent, totalTrades, winRate, equityCurve, etc.) are present when the strategy emitted at least one trade. When signal storage is enabled, includes signal fields described below. `notices` carries what the run had to say about itself, and is absent when it had nothing.
  */
 export type ResultMap = {
     /**
@@ -444,13 +444,36 @@ export type ResultMap = {
      */
     iops?: number;
     /**
-     * Identifier of the compiled strategy that produced this result
+     * **Not the `strategyId` you compiled with** — this is the execution context id,
+     * `strategy:<user>:<strategyId>`. The compiled strategy's id is the last `:`-separated
+     * segment; that, not this whole string, is what `GET /strategy/{strategyId}` takes.
+     *
+     * Take the segment after the last `:` rather than counting from the front: the shape has
+     * changed once already and callers that indexed a fixed position broke on it.
+     *
      */
     strategyId: string;
     /**
      * The instrument (currency pair) that was backtested
      */
     instrument: string;
+    /**
+     * Diagnostics the engine raised over this run, each with `provenance: execute`.
+     *
+     * **Absent means nothing was raised.** This is the one surface where silence is a real
+     * answer: the run happened, over your data, start to finish, and the engine found nothing
+     * worth saying. That is not true of the compile path, where an empty list only means a
+     * short synthetic series reached nothing — see `GET /strategy/{strategyId}`.
+     *
+     * Notices are raised on failed and aborted runs too, and those are the ones most worth
+     * reading: a run that produced no trades often did so for a reason stated here.
+     *
+     */
+    notices?: Array<Notice>;
+    /**
+     * How many notices were dropped past the cap of 50. Absent when none were. A large value usually means one fault repeating per instrument or per parameter vector rather than 50 distinct problems.
+     */
+    noticesTruncated?: number;
     /**
      * Total profit and loss in the output currency
      */
@@ -532,10 +555,113 @@ export type EquityPoint = {
 };
 
 /**
- * Unique identifier for a compiled strategy
+ * Unique identifier for a compiled strategy, derived from the source itself: the same code
+ * always yields the same id, for every caller, whatever its formatting. See
+ * `POST /strategy` for exactly which rewrites preserve it and which do not.
+ *
  */
 export type StrategyId = string;
 
+/**
+ * A diagnostic the engine raised while the strategy ran. Advisory: it describes something worth
+ * knowing about how the strategy is wired, not necessarily an error.
+ *
+ */
+export type Notice = {
+    /**
+     * Severity as the engine classified it.
+     */
+    level: string;
+    /**
+     * Stable identifier for the kind of finding; safe to match on.
+     */
+    code: string;
+    /**
+     * Human-readable explanation.
+     */
+    message: string;
+    /**
+     * Where it came from, which matters because the two silences differ: an empty list from a
+     * real run (`execute`) is a clean bill of health, while an empty list from
+     * `compile-dry-run` is only a lower bound over a bounded synthetic series.
+     *
+     */
+    provenance?: 'execute' | 'compile-dry-run';
+};
+
+/**
+ * What is known about a registered strategy: that it compiled, and what validating it found.
+ *
+ * **`validation: passed` does not mean the strategy is correct.** It means the class loaded and
+ * survived the first event of a short synthetic run — a floor, not a guarantee. When
+ * `dryRunIncomplete` is true it is a lower floor still, because the run did not finish.
+ *
+ */
+export type StrategyState = {
+    strategyId: StrategyId;
+    /**
+     * * `not_validated` — registered, never checked. `POST /strategy/{strategyId}/validate`
+     * checks it.
+     * * `pending` — a check was asked for and has not answered yet.
+     * * `passed` — the class loaded and survived its first event.
+     * * `failed` — it did not; `detail` says how.
+     *
+     */
+    validation: 'not_validated' | 'pending' | 'passed' | 'failed';
+    /**
+     * When the live compilation was produced.
+     */
+    compiledAt?: string;
+    /**
+     * The market data a strategy needs, read off the compiled class rather than off anything
+     * you sent — `TickerStrategy`, `KlineStrategy` and `FundingRateStrategy` each declare one,
+     * and a `MultiSourceStrategy` declares a set.
+     *
+     * **Absent is not "needs nothing".** A strategy always needs market data, so an absent
+     * field never means an empty requirement — it means the platform could not establish the
+     * answer without constructing your strategy, which it will not do to fill in a field.
+     * That happens for a `MultiSourceStrategy`, for a class that overrides
+     * `getMarketDataSource()`, and for anything registered before this field existed;
+     * re-registering the source fills it in.
+     *
+     */
+    requiredSources?: Array<'Ticker' | 'KLine' | 'FundingRate'>;
+    /**
+     * When the verdict was recorded. Absent until there is one.
+     */
+    validatedAt?: string;
+    /**
+     * Why validation failed, or why a queued check has not reported. Present on `failed`, and
+     * alongside `validationStalled`.
+     *
+     */
+    detail?: string;
+    /**
+     * What the run surfaced. An empty or absent list is not a clean bill of health when
+     * `dryRunIncomplete` is true — see that field.
+     *
+     */
+    notices?: Array<Notice>;
+    /**
+     * How many notices were dropped past the cap. Absent when none were.
+     */
+    noticesTruncated?: number;
+    /**
+     * The check did not finish its budget — it ran out of time, was refused because the
+     * platform was already holding too many unfinishable runs, or hit a failure attributable to
+     * the synthetic instrument rather than to your strategy. The verdict stands as far as it
+     * went; it simply reached less than a full run would.
+     *
+     */
+    dryRunIncomplete?: boolean;
+    /**
+     * A queued check has not reported for far longer than one takes. Nothing is disproved about
+     * the strategy — the check has not run. Stop waiting and re-request it later.
+     *
+     */
+    validationStalled?: boolean;
+};
+
 export type AuthTokenResponse = {
     /**
      * Short-lived HS256 JWT. Send as `Authorization: Bearer <token>` on all other endpoints.
@@ -813,12 +939,6 @@ export type CompileStrategyData = {
      * Raw strategy Java source code
      */
     body: string;
-    headers?: {
-        /**
-         * When `true`, compile asynchronously and return `202` with a `jobId`.
-         */
-        'X-Compile-Async'?: boolean;
-    };
     path?: never;
     query?: never;
     url: '/strategy';
@@ -826,35 +946,76 @@ export type CompileStrategyData = {
 
 export type CompileStrategyErrors = {
     /**
-     * Invalid strategy (compilation error)
+     * The source is not valid Java; the message carries the compiler diagnostics. Nothing is
+     * registered, so there is no id to look up afterwards.
+     *
      */
     400: ResponseError;
+    /**
+     * Too many compilations in flight. Retry later.
+     */
+    429: ResponseError;
 };
 
 export type CompileStrategyError = CompileStrategyErrors[keyof CompileStrategyErrors];
 
 export type CompileStrategyResponses = {
     /**
-     * Strategy compiled successfully (sync mode)
+     * Compiled and registered
      */
     200: {
         strategyId: StrategyId;
     };
+};
+
+export type CompileStrategyResponse = CompileStrategyResponses[keyof CompileStrategyResponses];
+
+export type ValidateStrategyData = {
+    body?: never;
+    path: {
+        /**
+         * The id returned by `POST /strategy`
+         */
+        strategyId: StrategyId;
+    };
+    query?: never;
+    url: '/strategy/{strategyId}/validate';
+};
+
+export type ValidateStrategyErrors = {
     /**
-     * Compile task accepted (async mode — set `X-Compile-Async: true`)
+     * No such registered strategy for this user
      */
-    202: AcceptedJob;
+    404: ResponseError;
 };
 
-export type CompileStrategyResponse = CompileStrategyResponses[keyof CompileStrategyResponses];
+export type ValidateStrategyError = ValidateStrategyErrors[keyof ValidateStrategyErrors];
+
+export type ValidateStrategyResponses = {
+    /**
+     * Already validated; the recorded verdict, unchanged
+     */
+    200: StrategyState;
+    /**
+     * Validation queued. Not a terminal outcome — poll `GET /strategy/{strategyId}` until
+     * `validation` leaves `pending`.
+     *
+     */
+    202: {
+        strategyId: StrategyId;
+        validation: 'pending';
+    };
+};
+
+export type ValidateStrategyResponse = ValidateStrategyResponses[keyof ValidateStrategyResponses];
 
 export type GetStrategyData = {
     body?: never;
     path: {
         /**
-         * The id returned by `POST /strategy` (sync) or the `jobId` returned in async mode
+         * The id returned by `POST /strategy`
          */
-        strategyId: string;
+        strategyId: StrategyId;
     };
     query?: never;
     url: '/strategy/{strategyId}';
@@ -862,7 +1023,7 @@ export type GetStrategyData = {
 
 export type GetStrategyErrors = {
     /**
-     * Strategy compile job not found
+     * No such registered strategy for this user
      */
     404: ResponseError;
 };
@@ -871,20 +1032,9 @@ export type GetStrategyError = GetStrategyErrors[keyof GetStrategyErrors];
 
 export type GetStrategyResponses = {
     /**
-     * Strategy compile state
+     * Strategy state
      */
-    200: {
-        /**
-         * Compile job id (only set in async mode)
-         */
-        jobId?: string;
-        status: 'New' | 'Started' | 'Completed' | 'Aborted' | 'Failed';
-        strategyId?: StrategyId;
-        /**
-         * Compilation error messages when `status` is `Failed`
-         */
-        statusDetail?: string | null;
-    };
+    200: StrategyState;
 };
 
 export type GetStrategyResponse = GetStrategyResponses[keyof GetStrategyResponses];