Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
2 changes: 1 addition & 1 deletion docs/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/backtesting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/live.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/market_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading