From 6d5d1b4e3806a53a630316cd71307e2444f33630 Mon Sep 17 00:00:00 2001 From: Manuel Polo Date: Thu, 22 Oct 2026 22:47:03 +0000 Subject: [PATCH] docs: link the API guides on www.qtsurfer.com The links to the API guides pointed to qtsurfer.github.io/docs/*.html, a site that no longer exists. They now point to the same guides on www.qtsurfer.com/docs/developers/api. --- README.md | 4 ++-- docs/auth.md | 2 +- docs/backtesting.md | 2 +- docs/datasets.md | 2 +- docs/live.md | 2 +- docs/market_data.md | 2 +- docs/strategy.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 151a358..101ff19 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,9 @@ The README is an entry point; the source documentation follows the API's functio | Authentication | [docs/auth.md](docs/auth.md) | | Exchanges, instruments, and downloads | [docs/market_data.md](docs/market_data.md) | | Backtests, parameter sweeps, and equity curves | [docs/backtesting.md](docs/backtesting.md) | -| Equity-curve format and transforms | [API guide](https://qtsurfer.github.io/docs/equity_curves.html) | +| Equity-curve format and transforms | [API guide](https://www.qtsurfer.com/docs/developers/api/equity_curves) | | Strategies and validation | [docs/strategy.md](docs/strategy.md) | -| Writing Java strategy source | [API guide](https://qtsurfer.github.io/docs/strategy_coding.html) | +| Writing Java strategy source | [API guide](https://www.qtsurfer.com/docs/developers/api/strategy_coding) | | Dataset uploads and external imports | [docs/datasets.md](docs/datasets.md) | | Account limits and storage usage | [docs/account.md](docs/account.md) | | Live execution, WebSocket signals, paper simulation, and retained signals | [docs/live.md](docs/live.md) | diff --git a/docs/auth.md b/docs/auth.md index 706521f..8ca63d8 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -71,7 +71,7 @@ This entry point does not exchange an API key or refresh the supplied token. resource names to action lists, for example `{"backtests":["read","write","execute"], "exchanges":["read"]}`. Names are lower case; a key with no scopes has `{}`. Scopes are reported but the API does not yet reject an operation for a missing scope. Do not infer enforcement from -the presence of this map. See the [API auth guide](https://qtsurfer.github.io/docs/auth.html) for +the presence of this map. See the [API auth guide](https://www.qtsurfer.com/docs/developers/api/auth) for resource and action definitions. Custom token stores must preserve the nested map when serializing `AuthTokenResponse`. If an old diff --git a/docs/backtesting.md b/docs/backtesting.md index 2c33239..faf597b 100644 --- a/docs/backtesting.md +++ b/docs/backtesting.md @@ -92,7 +92,7 @@ Read the returned curve according to `curve.getMeta().getOutMode()`, not the req platform may select a compact representation. `ARRAY` supplies `getPoints()`; `SHORT` supplies parallel `getTimestamps()` and `getEquities()` lists. The complete shared contract — transforms, differential decoding, metadata, and the meaning of equity — is in the API's [equity-curve -guide](https://qtsurfer.github.io/docs/equity_curves.html). +guide](https://www.qtsurfer.com/docs/developers/api/equity_curves). Sweep rows retain curves only when requested. Configure retention with `EquityCurveRequest` and read a retained trial with `getSweepRunEquityCurve`: diff --git a/docs/datasets.md b/docs/datasets.md index 9300f30..d77a9e1 100644 --- a/docs/datasets.md +++ b/docs/datasets.md @@ -103,7 +103,7 @@ whose query parameters are credentials. CSV uploads must have a header and `timestamp` and `close` columns. Parquet uploads are accepted as-is. Timestamp format and cadence are discovered at ingest. A ready dataset's `dataUrl` and `dataFormat` identify the stored downloadable representation; inspect `dataFormat` rather than -assuming it matches the uploaded file. See the API's [dataset format reference](https://qtsurfer.github.io/docs/datasets.html) +assuming it matches the uploaded file. See the API's [dataset format reference](https://www.qtsurfer.com/docs/developers/api/datasets) for the optional columns and validation rules. ## Wait for ingest diff --git a/docs/live.md b/docs/live.md index 8f2a38e..df96d96 100644 --- a/docs/live.md +++ b/docs/live.md @@ -130,7 +130,7 @@ snapshot.getAccounts().forEach(account -> System.out.printf( sets both buy/sell rates unless overridden; `feeLeg` defaults to `RECEIVED` (`QUOTE` and `BASE` are also accepted); `percentAmountToLock` defaults to the strategy setting or 10% of remaining free balance; `output` defaults to `SEPARATE`. Each quote currency gets a separate account. When `output` -is `MIX`, paper events are also written into retained signals. See the [API paper-trading guide](https://qtsurfer.github.io/docs/live_paper.html) +is `MIX`, paper events are also written into retained signals. See the [API paper-trading guide](https://www.qtsurfer.com/docs/developers/api/live_paper) for economics, account semantics, and signal event shapes. The authenticated session exposes the same methods and retries once on `401`: diff --git a/docs/market_data.md b/docs/market_data.md index 9e20726..38a86c5 100644 --- a/docs/market_data.md +++ b/docs/market_data.md @@ -2,7 +2,7 @@ Examples assume an authenticated `QTSurfer qts`; see [auth.md](auth.md) for setup and token ownership. -This SDK guide mirrors the API's [market-data guide](https://qtsurfer.github.io/docs/market_data.html). +This SDK guide mirrors the API's [market-data guide](https://www.qtsurfer.com/docs/developers/api/market_data). The SDK returns domain values for catalogue reads and streams downloads without buffering them. ## Discover exchanges and instruments diff --git a/docs/strategy.md b/docs/strategy.md index aee854b..173f239 100644 --- a/docs/strategy.md +++ b/docs/strategy.md @@ -4,7 +4,7 @@ Examples assume an authenticated `QTSurfer qts`; see [auth.md](auth.md) for setu This guide covers registering and validating source through the SDK. For the Java strategy itself — indicators, `emitBuy`/`emitSell`, information signals, order configuration, and chart metadata — -use the API's [Coding Java strategies](https://qtsurfer.github.io/docs/strategy_coding.html) guide. +use the API's [Coding Java strategies](https://www.qtsurfer.com/docs/developers/api/strategy_coding) guide. For agent-assisted authoring, install the maintained [`qtsurfer-java-strategy`](https://github.com/QTSurfer/strategy-skills) skill.