All Classes and Interfaces
Class
Description
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
Response returned by async endpoints (`202 Accepted`).
Your identity and tier limits.
HAL `_links` for `GET /account`
Your live usage of the shared storage pool `GET /account`'s `maxTotalStorageBytes` caps.
HAL `_links` for `GET /account/usage`
Configuration and utility class for API clients.
API response returned by API call.
Error envelope returned by `POST /auth/token` when the API key is rejected.
Machine-readable error reason.
AuthTokenResponse
Subscription tier this token was issued for.
Always `Bearer`.
Backtest job result.
CancelBacktest200Response
Gets or Sets status
CancelSweep200Response
Gets or Sets status
CompileStrategy200Response
The time range of available data for a single data type
CreateDatasetRequest
A dataset's own metadata — not its data.
* `ready` — `currentVersionId` is set; `from`/`to`/`cadence`/`bytes`/`rows`/`gaps`/ `largestGapSteps` describe it.
`currentVersionId`'s own timestamp unit (see `DatasetVersion.timestampUnit`) — decode the `timestamp` column of `dataUrl`'s file accordingly.
`ticker` for an upload or a `dex` import with no `cadence` requested (native per-trade data).
The metadata available immediately after creating a dataset, plus its first upload session — the presigned URL to PUT the file to.
Always `ticker` in v1.
The response to `POST /datasets/imports` — the dataset now exists, and its fetch has started.
Always `fetching` in this response — the fetch has only just started.
The `dex` source's own fields — required when `type` is `dex`.
Which on-chain DEX protocol `contract` implements.
Which chain the pool/pair lives on.
Uniswap version the pool/pair contract implements.
`POST /datasets/imports`'s request body.
Optional.
The source to fetch from.
Progress of one import, from fetching through ingest.
* `fetching` — reading from the source; nothing staged yet.
An upload session — an id plus the presigned URL to PUT the raw file to.
Progress of one upload, from staged through ingest.
* `uploading` — the file was PUT to the presigned URL, but `finalize` has not been called yet.
A presigned destination for uploading a raw dataset file directly to storage.
One successfully ingested upload.
Which format `dataUrl` is actually in — check this rather than assuming it matches how you uploaded it.
The unit the `timestamp` column was uploaded in — ISO-8601, or the epoch band its numeric values fell in (seconds, millis, or micros).
A `Dataset` plus a self link.
Which format `dataUrl` is actually in — check this rather than assuming it matches how you uploaded it.
* `ready` — `currentVersionId` is set; `from`/`to`/`cadence`/`bytes`/`rows`/`gaps`/ `largestGapSteps` describe it.
`currentVersionId`'s own timestamp unit (see `DatasetVersion.timestampUnit`) — decode the `timestamp` column of `dataUrl`'s file accordingly.
`ticker` for an upload or a `dex` import with no `cadence` requested (native per-trade data).
DatasetWithLinksAllOfLinks
DatasetWithLinksAllOfLinksSelf
Managed exchange data sources available for backtesting.
One property name `POST /strategy` could establish without constructing the strategy — either declared with `@StrategyProperty` on the compiled source, or one of the small set of base properties every strategy carries (`amnt`, `enabled`, `multiEntry`, ...).
DeleteDataset200Response
Gets or Sets deleted
DeleteStrategy200Response
Gets or Sets deleted
What the transform pipeline actually did, computed from the observed outcome — never a copy of what was requested.
Requested equity-curve transform, applied server-side in a fixed pipeline order: `resample` (point count) then `differential` (encoding) then `outMode` (JSON shape) — each stage assumes the previous one already ran.
JSON shape for an equity curve's points.
Selection (`mode`/`n`/`maxPct`) plus the transform preference (`resample`/`differential`/`outMode`) applied by `GET .../equityCurve` whenever ITS OWN query params are absent, for a curve this sweep retained.
Which trials keep their per-point equity curve.
An equity curve, shaped per `meta.outMode`: `points` when `ARRAY`, `timestamps` + `equities` (parallel arrays) when `SHORT`.
Single sample of the running equity at a yield event.
Exchange service provider
ExecuteBacktestRequest
ExecuteSweepAccepted
ExecuteSweepRequest
ExecuteSweepResult
Gets or Sets objective
Gets or Sets order
Which ordering was actually applied, which is not always the one requested: a sweep with no stored parameter grid cannot be plateau-ranked and falls back to `raw`.
The sweep's own status vocabulary — not the same set `state.status` below uses.
FinalizeDatasetUpload202Response
GetStrategyCode200Response
A HAL link object (Hypertext Application Language)
Time coverage of available data for this instrument, per data type
Exchange instrument with per-data-type coverage and market info
HAL `_links` — segment discovery for the instruments listing
Metadata describing the instruments listing
The market segment served in `data`
HAL-style response envelope for the instruments listing
Information about a single job
Current status of the job.
ListDatasets200Response
ListStrategies200Response
LiveConnectionToken
LiveListResponse
LiveParamsUpdateResult
A live run's full state, as returned by starting, reading, or stopping it through its strategy.
What you last asked for.
A new run always starts `SANDBOX` — a trial run compared against a second execution for agreement — and moves to `LIVE` once it passes.
Gets or Sets visibility
A run's state as returned by `PATCH /live/{runId}` — narrower than `LiveRun` (no `strategyId`, `params`, or `desired`), since this endpoint is addressed by `runId` alone.
Gets or Sets stage
Gets or Sets visibility
A run as it appears in `GET /live` — one of your own, narrower than `LiveRun` (no `params`, `paramsVersion`, `relay`, or `gate`), since listing stays cheap regardless of how many runs you have.
What you last asked for.
A new run always starts `SANDBOX` — a trial run compared against a second execution for agreement — and moves to `LIVE` once it passes.
Gets or Sets visibility
One signal, in the same shape the real-time signal channel delivers.
The stage the run was in when this signal was produced.
Gets or Sets type
LiveSignalInstrument
Present only for a `hint`.
One page of a run's recorded signals, oldest first.
One market feed a live run consumes.
Both `ticker` and `kline` connect to the lightest (fastest) cadence available for the exchange — today, 1 tick/second on every supported exchange.
A diagnostic the engine raised while the strategy ran.
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.
State of a single-instrument prepare job — the `JobState` shape plus a coverage summary.
Current status of the job.
PrepareJobStateAllOfHoursWithoutData
Why the hour has no data.
Two shapes, chosen by the `exchangeId` path segment.
Present only when another page exists.
PublicLiveListResponse
PublicLiveNextLink
A run as it appears in `GET /live/public` — never reveals who owns it or which strategy it runs.
General response error
Execution result map.
Upload status.
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
StartLiveRequest
A `public` run appears in `GET /live/public` and its signal channel accepts subscriptions from anyone, not only you.
HAL `_links` for a strategy — present on a full `StrategyState` body (`GET /strategy/{strategyId}`, and `POST /strategy/{strategyId}/validate`'s already-validated `200`), absent from that same endpoint's `202` — a deliberately partial stub carrying only what is known before a check has even started.
What is known about a registered strategy: that it compiled, and what validating it found.
Gets or Sets requiredSources
* `not_validated` — registered, never checked.
One entry from `GET /strategies` — the same provenance a full `StrategyState` carries (`compiledAt`, `requiredSources`), without its validation state, so listing stays cheap regardless of how many strategies you have registered.
SweepAxisOneOf
SweepAxisOneOf1
SweepBaseConfig
Gets or Sets feeLeg
The surface for one pair of axes, with all others collapsed away.
SweepHeatmapCell
One axis, with every other axis collapsed away.
How the objective behaved at one value of one axis.
How far along a sweep is, and — when the sweep is still running — enough to tell a healthy one from a stuck one.
SweepRunRow
Sensitivity aggregates over a sweep's stored rows.
Gets or Sets objective
Gets or Sets status
SweepSpecRequest
Gets or Sets objective
Gets or Sets sampler
UpdateLiveParamsRequest
UpdateLiveRequest
Gets or Sets visibility
Echo of the accepted walk-forward configuration, present only when the submit carried one.
What one fold concluded.
Opt in to walk-forward validation.
Present only on a sweep submitted with `walkForward`, and present from acceptance onward — its presence, not its contents, is what identifies a walk-forward sweep.