@qtsurfer/api-client 0.16.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -2
- package/dist/index.d.ts +742 -21
- package/dist/index.js +123 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +578 -7
- package/src/generated/sdk.gen.ts +355 -8
- package/src/generated/types.gen.ts +648 -12
package/README.md
CHANGED
|
@@ -68,13 +68,15 @@ pluggable token stores so callers don't reinvent that plumbing.
|
|
|
68
68
|
|
|
69
69
|
All operations are exported as standalone functions; every operation accepts an `Options` object and returns `{ data, error, response }`.
|
|
70
70
|
|
|
71
|
-
The table is exhaustive: `src/generated/` is produced from the OpenAPI spec, so **all
|
|
72
|
-
the spec declares are exported. The rows below describe **spec version 0.
|
|
71
|
+
The table is exhaustive: `src/generated/` is produced from the OpenAPI spec, so **all 41 operations**
|
|
72
|
+
the spec declares are exported. The rows below describe **spec version 0.126.1**, which is versioned
|
|
73
73
|
independently of this package.
|
|
74
74
|
|
|
75
75
|
| Function | Method | Path | Purpose |
|
|
76
76
|
| -------- | ------ | ---- | ------- |
|
|
77
77
|
| `authenticate` | POST | `/auth/token` | Exchange an API key for a short-lived JWT |
|
|
78
|
+
| `getAccount` | GET | `/account` | Read the authenticated account tier and limits |
|
|
79
|
+
| `getAccountUsage` | GET | `/account/usage` | Read current resource and storage use |
|
|
78
80
|
| `listExchanges` | GET | `/exchanges` | List the available exchanges |
|
|
79
81
|
| `listInstruments` | GET | `/exchange/{exchangeId}/instruments` | List an exchange's instruments (default spot segment) |
|
|
80
82
|
| `listSegmentInstruments` | GET | `/exchange/{exchangeId}/{segment}/instruments` | List an exchange segment's instruments |
|
|
@@ -105,6 +107,14 @@ independently of this package.
|
|
|
105
107
|
| `getDatasetUpload` | GET | `/datasets/{datasetId}/uploads/{uploadId}` | Get an upload's ingestion state |
|
|
106
108
|
| `importDataset` | POST | `/datasets/imports` | Create a dataset by importing external history |
|
|
107
109
|
| `getDatasetImport` | GET | `/datasets/{datasetId}/imports/{importId}` | Get an import's fetch and ingestion state |
|
|
110
|
+
| `startLive` | POST | `/strategy/{strategyId}/live` | Start a compiled strategy on a live feed |
|
|
111
|
+
| `getLive` | GET | `/strategy/{strategyId}/live` | Read a strategy's current or most recent live run |
|
|
112
|
+
| `stopLive` | DELETE | `/strategy/{strategyId}/live` | Request a strategy's active live run to stop |
|
|
113
|
+
| `listPublicLive` | GET | `/live/public` | Page publicly visible live runs |
|
|
114
|
+
| `updateLive` | PATCH | `/live/{runId}` | Change a run's visibility, name, or description |
|
|
115
|
+
| `updateLiveParams` | PUT | `/live/{runId}/params` | Change parameters while a run stays active |
|
|
116
|
+
| `getLiveRunSignals` | GET | `/live/{runId}/signals` | Page retained signals, optionally by time or instrument |
|
|
117
|
+
| `mintLiveConnectionToken` | POST | `/live/token` | Mint a short-lived Centrifugo connection token |
|
|
108
118
|
|
|
109
119
|
All generated types (`Exchange`, `InstrumentDetail`, `BacktestJobResult`, `PrepareJobState`, `ResultMap`, etc.) are re-exported from the root.
|
|
110
120
|
|