@totalis/hip4-client 0.0.0-stage → 0.73.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/CHANGELOG.md +1903 -0
- package/LICENSE +202 -0
- package/README.md +143 -2
- package/dist/api-keys.d.ts +118 -0
- package/dist/api-keys.js +104 -0
- package/dist/audience-contract.d.ts +52 -0
- package/dist/audience-contract.js +1 -0
- package/dist/base.d.ts +41 -0
- package/dist/base.js +60 -0
- package/dist/client.d.ts +16 -0
- package/dist/client.js +15 -0
- package/dist/controller.d.ts +53 -0
- package/dist/controller.js +63 -0
- package/dist/errors.d.ts +3 -0
- package/dist/errors.js +3 -0
- package/dist/flow-errors.d.ts +62 -0
- package/dist/flow-errors.js +70 -0
- package/dist/generated/account-read.d.ts +2015 -0
- package/dist/generated/account-read.js +1 -0
- package/dist/generated/api-keys.d.ts +1303 -0
- package/dist/generated/api-keys.js +1 -0
- package/dist/generated/browse.d.ts +965 -0
- package/dist/generated/browse.js +1 -0
- package/dist/generated/client.d.ts +104 -0
- package/dist/generated/client.js +1 -0
- package/dist/generated/errors.d.ts +467 -0
- package/dist/generated/errors.js +1792 -0
- package/dist/generated/maker.d.ts +47 -0
- package/dist/generated/maker.js +1 -0
- package/dist/generated/openapi.d.ts +10867 -0
- package/dist/generated/openapi.js +1 -0
- package/dist/generated/operator.d.ts +7 -0
- package/dist/generated/operator.js +1 -0
- package/dist/generated/realtime.d.ts +1486 -0
- package/dist/generated/realtime.js +1 -0
- package/dist/generated/vault-abi.d.ts +49 -0
- package/dist/generated/vault-abi.js +70 -0
- package/dist/generated/version.d.ts +24 -0
- package/dist/generated/version.js +183 -0
- package/dist/hypercore.d.ts +111 -0
- package/dist/hypercore.js +132 -0
- package/dist/maker.d.ts +206 -0
- package/dist/maker.js +608 -0
- package/dist/money.d.ts +59 -0
- package/dist/money.js +66 -0
- package/dist/operator.d.ts +4 -0
- package/dist/operator.js +4 -0
- package/dist/pagination.d.ts +20 -0
- package/dist/pagination.js +27 -0
- package/dist/partner.d.ts +71 -0
- package/dist/partner.js +66 -0
- package/dist/realtime.d.ts +19 -0
- package/dist/realtime.js +10 -0
- package/dist/request.d.ts +115 -0
- package/dist/request.js +190 -0
- package/dist/signer.d.ts +51 -0
- package/dist/signer.js +90 -0
- package/dist/stream.d.ts +142 -0
- package/dist/stream.js +331 -0
- package/dist/totalis.d.ts +719 -0
- package/dist/totalis.js +1251 -0
- package/dist/typed-data.d.ts +330 -0
- package/dist/typed-data.js +340 -0
- package/dist/ui.d.ts +54 -0
- package/dist/ui.js +77 -0
- package/dist/wallet-session.d.ts +52 -0
- package/dist/wallet-session.js +63 -0
- package/examples/browser-wallet.html +69 -0
- package/examples/browser-wallet.mjs +57 -0
- package/examples/node-bot.mjs +57 -0
- package/examples/onboard.mjs +132 -0
- package/examples/partner-frontend.mjs +44 -0
- package/examples/partner-server.mjs +22 -0
- package/package.json +105 -4
|
@@ -0,0 +1,2015 @@
|
|
|
1
|
+
export type paths = {
|
|
2
|
+
readonly "/v1/makers/{maker_id}/quotes": {
|
|
3
|
+
readonly parameters: {
|
|
4
|
+
readonly query?: never;
|
|
5
|
+
readonly header?: never;
|
|
6
|
+
readonly path?: never;
|
|
7
|
+
readonly cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/** @description Up to 50 current entry quotes for this maker, newest first, for its dashboard. Display fields only; never includes signatures. Partial list, not lifetime quote statistics. */
|
|
10
|
+
readonly get: operations["getMakerQuotes"];
|
|
11
|
+
readonly put?: never;
|
|
12
|
+
readonly post?: never;
|
|
13
|
+
readonly delete?: never;
|
|
14
|
+
readonly options?: never;
|
|
15
|
+
readonly head?: never;
|
|
16
|
+
readonly patch?: never;
|
|
17
|
+
readonly trace?: never;
|
|
18
|
+
};
|
|
19
|
+
readonly "/v1/me/maker": {
|
|
20
|
+
readonly parameters: {
|
|
21
|
+
readonly query?: never;
|
|
22
|
+
readonly header?: never;
|
|
23
|
+
readonly path?: never;
|
|
24
|
+
readonly cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
/** @description Resolve the authenticated account canonical wallet and single admitted maker. Owner dashboard authority derives from verified wallet linkage and current indexed controller evidence, without an expiring dashboard grant. GET performs no provisioning or financial action. */
|
|
27
|
+
readonly get: operations["getOwnMaker"];
|
|
28
|
+
readonly put?: never;
|
|
29
|
+
readonly post?: never;
|
|
30
|
+
readonly delete?: never;
|
|
31
|
+
readonly options?: never;
|
|
32
|
+
readonly head?: never;
|
|
33
|
+
readonly patch?: never;
|
|
34
|
+
readonly trace?: never;
|
|
35
|
+
};
|
|
36
|
+
readonly "/v1/me/controlled-makers": {
|
|
37
|
+
readonly parameters: {
|
|
38
|
+
readonly query?: never;
|
|
39
|
+
readonly header?: never;
|
|
40
|
+
readonly path?: never;
|
|
41
|
+
readonly cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
/** @description Discover maker vaults controlled by the authenticated participant linked wallets. Does not grant dashboard or transport access. Requires current indexed ownership. */
|
|
44
|
+
readonly get: operations["listControlledMakers"];
|
|
45
|
+
readonly put?: never;
|
|
46
|
+
readonly post?: never;
|
|
47
|
+
readonly delete?: never;
|
|
48
|
+
readonly options?: never;
|
|
49
|
+
readonly head?: never;
|
|
50
|
+
readonly patch?: never;
|
|
51
|
+
readonly trace?: never;
|
|
52
|
+
};
|
|
53
|
+
readonly "/v1/me/pnl": {
|
|
54
|
+
readonly parameters: {
|
|
55
|
+
readonly query?: never;
|
|
56
|
+
readonly header?: never;
|
|
57
|
+
readonly path?: never;
|
|
58
|
+
readonly cookie?: never;
|
|
59
|
+
};
|
|
60
|
+
/** @description Cumulative trading P&L of the account Portfolio shows, as a series for one range, computed on read. Core positions count realized cash plus held shares at their per-share value at each point; open Combos count nothing until their economic close. The credential selects the account and deployment. */
|
|
61
|
+
readonly get: operations["getAccountPnl"];
|
|
62
|
+
readonly put?: never;
|
|
63
|
+
readonly post?: never;
|
|
64
|
+
readonly delete?: never;
|
|
65
|
+
readonly options?: never;
|
|
66
|
+
readonly head?: never;
|
|
67
|
+
readonly patch?: never;
|
|
68
|
+
readonly trace?: never;
|
|
69
|
+
};
|
|
70
|
+
readonly "/v1/me/activity": {
|
|
71
|
+
readonly parameters: {
|
|
72
|
+
readonly query?: never;
|
|
73
|
+
readonly header?: never;
|
|
74
|
+
readonly path?: never;
|
|
75
|
+
readonly cookie?: never;
|
|
76
|
+
};
|
|
77
|
+
/** @description Durable scoped activity of the credential's account (a maker key reads its maker's) from qualified chain evidence and operations. The credential selects the account and deployment; requires current authorization. Returns 503 while the activity producer is disabled or source coverage is unavailable. */
|
|
78
|
+
readonly get: operations["listAccountActivity"];
|
|
79
|
+
readonly put?: never;
|
|
80
|
+
readonly post?: never;
|
|
81
|
+
readonly delete?: never;
|
|
82
|
+
readonly options?: never;
|
|
83
|
+
readonly head?: never;
|
|
84
|
+
readonly patch?: never;
|
|
85
|
+
readonly trace?: never;
|
|
86
|
+
};
|
|
87
|
+
readonly "/v1/me/activity/{activity_id}": {
|
|
88
|
+
readonly parameters: {
|
|
89
|
+
readonly query?: never;
|
|
90
|
+
readonly header?: never;
|
|
91
|
+
readonly path?: never;
|
|
92
|
+
readonly cookie?: never;
|
|
93
|
+
};
|
|
94
|
+
/** @description Durable scoped activity from qualified chain evidence and operations. The credential selects the deployment; requires current authorization. Returns 503 while the activity producer is disabled or source coverage is unavailable. */
|
|
95
|
+
readonly get: operations["getAccountActivity"];
|
|
96
|
+
readonly put?: never;
|
|
97
|
+
readonly post?: never;
|
|
98
|
+
readonly delete?: never;
|
|
99
|
+
readonly options?: never;
|
|
100
|
+
readonly head?: never;
|
|
101
|
+
readonly patch?: never;
|
|
102
|
+
readonly trace?: never;
|
|
103
|
+
};
|
|
104
|
+
readonly "/v1/makers/{maker_id}/capital": {
|
|
105
|
+
readonly parameters: {
|
|
106
|
+
readonly query?: never;
|
|
107
|
+
readonly header?: never;
|
|
108
|
+
readonly path?: never;
|
|
109
|
+
readonly cookie?: never;
|
|
110
|
+
};
|
|
111
|
+
/** @description This maker's vault capital, reservations and action availability, reconciled against committed vault state. The credential selects the deployment. Access is checked against the credential's current permissions on every request. */
|
|
112
|
+
readonly get: operations["getMakerCapital"];
|
|
113
|
+
readonly put?: never;
|
|
114
|
+
readonly post?: never;
|
|
115
|
+
readonly delete?: never;
|
|
116
|
+
readonly options?: never;
|
|
117
|
+
readonly head?: never;
|
|
118
|
+
readonly patch?: never;
|
|
119
|
+
readonly trace?: never;
|
|
120
|
+
};
|
|
121
|
+
readonly "/v1/makers/{maker_id}/activity": {
|
|
122
|
+
readonly parameters: {
|
|
123
|
+
readonly query?: never;
|
|
124
|
+
readonly header?: never;
|
|
125
|
+
readonly path?: never;
|
|
126
|
+
readonly cookie?: never;
|
|
127
|
+
};
|
|
128
|
+
/** @description Durable scoped activity from qualified chain evidence and operations. The credential selects the deployment; requires current authorization. Returns 503 while the activity producer is disabled or source coverage is unavailable. */
|
|
129
|
+
readonly get: operations["listMakerActivity"];
|
|
130
|
+
readonly put?: never;
|
|
131
|
+
readonly post?: never;
|
|
132
|
+
readonly delete?: never;
|
|
133
|
+
readonly options?: never;
|
|
134
|
+
readonly head?: never;
|
|
135
|
+
readonly patch?: never;
|
|
136
|
+
readonly trace?: never;
|
|
137
|
+
};
|
|
138
|
+
readonly "/v1/makers/{maker_id}/activity/{activity_id}": {
|
|
139
|
+
readonly parameters: {
|
|
140
|
+
readonly query?: never;
|
|
141
|
+
readonly header?: never;
|
|
142
|
+
readonly path?: never;
|
|
143
|
+
readonly cookie?: never;
|
|
144
|
+
};
|
|
145
|
+
/** @description Durable scoped activity from qualified chain evidence and operations. The credential selects the deployment; requires current authorization. Returns 503 while the activity producer is disabled or source coverage is unavailable. */
|
|
146
|
+
readonly get: operations["getMakerActivity"];
|
|
147
|
+
readonly put?: never;
|
|
148
|
+
readonly post?: never;
|
|
149
|
+
readonly delete?: never;
|
|
150
|
+
readonly options?: never;
|
|
151
|
+
readonly head?: never;
|
|
152
|
+
readonly patch?: never;
|
|
153
|
+
readonly trace?: never;
|
|
154
|
+
};
|
|
155
|
+
readonly "/v1/makers/{maker_id}/positions": {
|
|
156
|
+
readonly parameters: {
|
|
157
|
+
readonly query?: never;
|
|
158
|
+
readonly header?: never;
|
|
159
|
+
readonly path?: never;
|
|
160
|
+
readonly cookie?: never;
|
|
161
|
+
};
|
|
162
|
+
/** @description Positions this maker wrote, reconciled against committed vault state. The credential selects the deployment. Access is checked against the credential's current permissions on every request. */
|
|
163
|
+
readonly get: operations["listMakerPositions"];
|
|
164
|
+
readonly put?: never;
|
|
165
|
+
readonly post?: never;
|
|
166
|
+
readonly delete?: never;
|
|
167
|
+
readonly options?: never;
|
|
168
|
+
readonly head?: never;
|
|
169
|
+
readonly patch?: never;
|
|
170
|
+
readonly trace?: never;
|
|
171
|
+
};
|
|
172
|
+
readonly "/v1/me/positions": {
|
|
173
|
+
readonly parameters: {
|
|
174
|
+
readonly query?: never;
|
|
175
|
+
readonly header?: never;
|
|
176
|
+
readonly path?: never;
|
|
177
|
+
readonly cookie?: never;
|
|
178
|
+
};
|
|
179
|
+
/** @description Positions of the credential's account, reconciled against committed vault state: the positions a personal credential holds, or the positions a maker key's maker wrote. The credential selects the account and deployment. Access is checked against the credential's current permissions on every request. */
|
|
180
|
+
readonly get: operations["listAccountPositions"];
|
|
181
|
+
readonly put?: never;
|
|
182
|
+
readonly post?: never;
|
|
183
|
+
readonly delete?: never;
|
|
184
|
+
readonly options?: never;
|
|
185
|
+
readonly head?: never;
|
|
186
|
+
readonly patch?: never;
|
|
187
|
+
readonly trace?: never;
|
|
188
|
+
};
|
|
189
|
+
readonly "/v1/me/positions/{position_id}": {
|
|
190
|
+
readonly parameters: {
|
|
191
|
+
readonly query?: never;
|
|
192
|
+
readonly header?: never;
|
|
193
|
+
readonly path?: never;
|
|
194
|
+
readonly cookie?: never;
|
|
195
|
+
};
|
|
196
|
+
/** @description One position of the credential's account (held, or written by a maker key's maker) by position ID, reconciled against committed vault state. The credential selects the account and deployment. Access is checked against the credential's current permissions on every request. */
|
|
197
|
+
readonly get: operations["getAccountPosition"];
|
|
198
|
+
readonly put?: never;
|
|
199
|
+
readonly post?: never;
|
|
200
|
+
readonly delete?: never;
|
|
201
|
+
readonly options?: never;
|
|
202
|
+
readonly head?: never;
|
|
203
|
+
readonly patch?: never;
|
|
204
|
+
readonly trace?: never;
|
|
205
|
+
};
|
|
206
|
+
readonly "/v1/makers/{maker_id}/positions/{position_id}": {
|
|
207
|
+
readonly parameters: {
|
|
208
|
+
readonly query?: never;
|
|
209
|
+
readonly header?: never;
|
|
210
|
+
readonly path?: never;
|
|
211
|
+
readonly cookie?: never;
|
|
212
|
+
};
|
|
213
|
+
/** @description One position this maker wrote, by position ID, reconciled against committed vault state. The credential selects the deployment. Access is checked against the credential's current permissions on every request. */
|
|
214
|
+
readonly get: operations["getMakerPosition"];
|
|
215
|
+
readonly put?: never;
|
|
216
|
+
readonly post?: never;
|
|
217
|
+
readonly delete?: never;
|
|
218
|
+
readonly options?: never;
|
|
219
|
+
readonly head?: never;
|
|
220
|
+
readonly patch?: never;
|
|
221
|
+
readonly trace?: never;
|
|
222
|
+
};
|
|
223
|
+
readonly "/v1/makers/{maker_id}/performance": {
|
|
224
|
+
readonly parameters: {
|
|
225
|
+
readonly query?: never;
|
|
226
|
+
readonly header?: never;
|
|
227
|
+
readonly path?: never;
|
|
228
|
+
readonly cookie?: never;
|
|
229
|
+
};
|
|
230
|
+
/** @description Performance of this maker per period. Complete periods aggregate the positions that closed economically in them; incomplete periods return unavailable metrics. Gas stays unavailable until the payer of every transaction receipt is attributed. The credential selects the deployment, and access is checked against its current permissions on every request. The maker is always the one named in the path, never inferred from the caller's account. */
|
|
231
|
+
readonly get: operations["getMakerPerformance"];
|
|
232
|
+
readonly put?: never;
|
|
233
|
+
readonly post?: never;
|
|
234
|
+
readonly delete?: never;
|
|
235
|
+
readonly options?: never;
|
|
236
|
+
readonly head?: never;
|
|
237
|
+
readonly patch?: never;
|
|
238
|
+
readonly trace?: never;
|
|
239
|
+
};
|
|
240
|
+
readonly "/v1/makers/{maker_id}/quote-history": {
|
|
241
|
+
readonly parameters: {
|
|
242
|
+
readonly query?: never;
|
|
243
|
+
readonly header?: never;
|
|
244
|
+
readonly path?: never;
|
|
245
|
+
readonly cookie?: never;
|
|
246
|
+
};
|
|
247
|
+
/** @description Every quote this maker published in a period, not only live ones, newest first, with each quote's status now and the period's fill rate. Display fields only; never signatures. Statuses map the venue's own states: an acceptance, the maker's answer and the trade's chain outcome decide first, then the quote's book state, then its RFQ. A decline carries no reason, since the maker's answer records none. */
|
|
248
|
+
readonly get: operations["listMakerQuoteHistory"];
|
|
249
|
+
readonly put?: never;
|
|
250
|
+
readonly post?: never;
|
|
251
|
+
readonly delete?: never;
|
|
252
|
+
readonly options?: never;
|
|
253
|
+
readonly head?: never;
|
|
254
|
+
readonly patch?: never;
|
|
255
|
+
readonly trace?: never;
|
|
256
|
+
};
|
|
257
|
+
readonly "/v1/makers/{maker_id}/exposure": {
|
|
258
|
+
readonly parameters: {
|
|
259
|
+
readonly query?: never;
|
|
260
|
+
readonly header?: never;
|
|
261
|
+
readonly path?: never;
|
|
262
|
+
readonly cookie?: never;
|
|
263
|
+
};
|
|
264
|
+
/** @description This maker's open book by outcome at the vault projection checkpoint: per outcome its YES and NO exposure, gross and net, worst case and what offsetting saves, and what awaits settlement; book totals count each ticket once. Legs resolve as a position's do. Dashboard sessions only, like positions. */
|
|
265
|
+
readonly get: operations["getMakerExposure"];
|
|
266
|
+
readonly put?: never;
|
|
267
|
+
readonly post?: never;
|
|
268
|
+
readonly delete?: never;
|
|
269
|
+
readonly options?: never;
|
|
270
|
+
readonly head?: never;
|
|
271
|
+
readonly patch?: never;
|
|
272
|
+
readonly trace?: never;
|
|
273
|
+
};
|
|
274
|
+
readonly "/v1/makers/{maker_id}/telemetry": {
|
|
275
|
+
readonly parameters: {
|
|
276
|
+
readonly query?: never;
|
|
277
|
+
readonly header?: never;
|
|
278
|
+
readonly path?: never;
|
|
279
|
+
readonly cookie?: never;
|
|
280
|
+
};
|
|
281
|
+
/** @description Optional maker-reported capacity. Missing integration is unavailable; expired or revoked publisher observations are stale. Never financial authority. */
|
|
282
|
+
readonly get: operations["getMakerTelemetry"];
|
|
283
|
+
readonly put?: never;
|
|
284
|
+
readonly post?: never;
|
|
285
|
+
readonly delete?: never;
|
|
286
|
+
readonly options?: never;
|
|
287
|
+
readonly head?: never;
|
|
288
|
+
readonly patch?: never;
|
|
289
|
+
readonly trace?: never;
|
|
290
|
+
};
|
|
291
|
+
};
|
|
292
|
+
export type webhooks = Record<string, never>;
|
|
293
|
+
export type components = {
|
|
294
|
+
schemas: {
|
|
295
|
+
readonly Amount: string;
|
|
296
|
+
readonly SignedAmount: string;
|
|
297
|
+
/** Format: date-time */
|
|
298
|
+
readonly Timestamp: string;
|
|
299
|
+
readonly Address: string;
|
|
300
|
+
readonly Digest: string;
|
|
301
|
+
readonly Scope: {
|
|
302
|
+
/** @description EVM chain ID of the deployment, as a decimal string. */
|
|
303
|
+
readonly chain_id: string;
|
|
304
|
+
/** @description Lowercase vault contract address of the deployment. */
|
|
305
|
+
readonly vault: components["schemas"]["LowercaseNonZeroAddress"];
|
|
306
|
+
/** @description Account or maker whose data the read returns. */
|
|
307
|
+
readonly subject: {
|
|
308
|
+
/**
|
|
309
|
+
* @description ACCOUNT for a personal account read.
|
|
310
|
+
* @constant
|
|
311
|
+
*/
|
|
312
|
+
readonly kind: "ACCOUNT";
|
|
313
|
+
/** @description Participant ID of the authenticated account. */
|
|
314
|
+
readonly account_id: string;
|
|
315
|
+
/** @description Lowercase linked wallet address whose personal history and positions are read. */
|
|
316
|
+
readonly wallet: components["schemas"]["LowercaseNonZeroAddress"];
|
|
317
|
+
} | {
|
|
318
|
+
/**
|
|
319
|
+
* @description MAKER for a maker read.
|
|
320
|
+
* @constant
|
|
321
|
+
*/
|
|
322
|
+
readonly kind: "MAKER";
|
|
323
|
+
/** @description On-chain maker ID whose data is read, as a decimal string; equals maker_id in the path. */
|
|
324
|
+
readonly maker_id: components["schemas"]["NonZeroUInt64String"];
|
|
325
|
+
};
|
|
326
|
+
};
|
|
327
|
+
/** @description Freshness of the read. Pages of one list share the snapshot bound into their cursor. */
|
|
328
|
+
readonly ReadContext: {
|
|
329
|
+
/** @description RFC3339 observation time of the oldest source this read used. */
|
|
330
|
+
readonly as_of: components["schemas"]["Timestamp"];
|
|
331
|
+
/**
|
|
332
|
+
* @description Freshness of the whole read. CURRENT: every source is fresh and reconciled. STALE: a source lags or has not reconciled, such as a catching-up projection, a pending reorg rescan or a period not fully covered; amounts may be displayed with their age but never authorize an action. UNAVAILABLE: a required source could not be read, so the amounts it backs are null.
|
|
333
|
+
* @enum {string}
|
|
334
|
+
*/
|
|
335
|
+
readonly status: "CURRENT" | "STALE" | "UNAVAILABLE";
|
|
336
|
+
};
|
|
337
|
+
/** @description Signed amount in atomic USDC (6 decimals, "1000000" = 1 USDC); null when it could not be established, never zero in its place. */
|
|
338
|
+
readonly Metric: components["schemas"]["SignedAmount"] | null;
|
|
339
|
+
readonly Effect: {
|
|
340
|
+
/** @description Asset the delta is denominated in. */
|
|
341
|
+
readonly asset: components["schemas"]["Asset"];
|
|
342
|
+
/**
|
|
343
|
+
* @description Balance lane the delta applies to: WALLET, CORE_SPOT, CORE_MARGIN, VAULT_USER (the account's vault balance), MAKER_VAULT, STAKE_ESCROW, PAYABLE, REQUIREMENT, RESERVATION, IN_TRANSIT, REALIZED_PNL or FEE.
|
|
344
|
+
* @enum {string}
|
|
345
|
+
*/
|
|
346
|
+
readonly bucket: "WALLET" | "CORE_SPOT" | "CORE_MARGIN" | "VAULT_USER" | "MAKER_VAULT" | "STAKE_ESCROW" | "PAYABLE" | "REQUIREMENT" | "RESERVATION" | "IN_TRANSIT" | "REALIZED_PNL" | "FEE";
|
|
347
|
+
/** @description Signed change to the bucket in atomic units of asset, e.g. "1000000" = 1 USDC on HyperEVM (6 decimals) and "100000000" = 1 USDC on HyperCore (8 decimals). Lane deltas are not summable income. */
|
|
348
|
+
readonly delta: components["schemas"]["SignedAmount"];
|
|
349
|
+
/**
|
|
350
|
+
* @description Economic meaning: EXTERNAL_CAPITAL (deposit or withdrawal across the subject boundary), INTERNAL_TRANSFER (move between the subject's own lanes), TRADE, FEE, HOLD (reservation) or CORRECTION (reorg reversal).
|
|
351
|
+
* @enum {string}
|
|
352
|
+
*/
|
|
353
|
+
readonly classification: "EXTERNAL_CAPITAL" | "INTERNAL_TRANSFER" | "TRADE" | "FEE" | "HOLD" | "CORRECTION";
|
|
354
|
+
};
|
|
355
|
+
/** @enum {string} */
|
|
356
|
+
readonly ActivityKind: "DEPOSIT" | "WITHDRAWAL" | "INTERNAL_TRANSFER" | "ACCEPT" | "CASHOUT" | "POSITION_TRANSFER" | "SETTLEMENT" | "CLAIM" | "FILL" | "ORDER" | "CREDIT" | "CONVERSION" | "FUNDING" | "FEE" | "CORRECTION" | "REFUND";
|
|
357
|
+
readonly Activity: {
|
|
358
|
+
/** @description Stable activity identifier (64 lowercase hex characters), unchanged across revisions and replays. */
|
|
359
|
+
readonly activity_id: string;
|
|
360
|
+
/** @description Revision of this activity view, as a decimal string; increases when the activity is revised. */
|
|
361
|
+
readonly revision: string;
|
|
362
|
+
/** @description Commit-visible publication sequence of the activity's vault, as a decimal string. Lists order each vault's activity by sequence, then activity_id, descending; an account that has activity in more than one vault (after a vault redeploy) gets them merged, most recently recorded first. */
|
|
363
|
+
readonly sequence: string;
|
|
364
|
+
/** @description Business type of the activity, e.g. DEPOSIT, ACCEPT, SETTLEMENT, CLAIM, or CORRECTION for a reorg reversal. */
|
|
365
|
+
readonly kind: components["schemas"]["ActivityKind"];
|
|
366
|
+
/**
|
|
367
|
+
* @description PENDING: in progress; UNKNOWN: outcome not yet known; COMMITTED: final at its source; FAILED or REVERTED: took no effect and moves no committed cash; CORRECTED: a correction entry reversing superseded activity.
|
|
368
|
+
* @enum {string}
|
|
369
|
+
*/
|
|
370
|
+
readonly status: "PENDING" | "UNKNOWN" | "COMMITTED" | "FAILED" | "REVERTED" | "CORRECTED";
|
|
371
|
+
/** @description RFC3339 evidence time; for workflow entries, the operation's creation time, which later revisions keep. Null when the occurrence time is uncertain, such as an order with no retained placement time. */
|
|
372
|
+
readonly occurred_at: string | null;
|
|
373
|
+
/**
|
|
374
|
+
* Format: date-time
|
|
375
|
+
* @description RFC3339 time the activity was recorded (ingest order).
|
|
376
|
+
*/
|
|
377
|
+
readonly recorded_at: string;
|
|
378
|
+
/** @description Totalis operation IDs linked to the activity; empty when none. */
|
|
379
|
+
readonly operation_ids: readonly string[];
|
|
380
|
+
/** @description Position IDs (bytes32 hex) the activity concerns; empty when none. */
|
|
381
|
+
readonly position_ids: readonly string[];
|
|
382
|
+
/** @description Activity IDs this correction reverses; empty unless kind is CORRECTION. */
|
|
383
|
+
readonly supersedes: readonly string[];
|
|
384
|
+
/** @description HyperEVM transactions that back the activity, in evidence order; empty for HyperCore and venue-only records. */
|
|
385
|
+
readonly transaction_hashes: readonly components["schemas"]["Digest"][];
|
|
386
|
+
/** @description Balance effects for the scoped subject, each in its own asset; empty only for ORDER and POSITION_TRANSFER, which move no cash. */
|
|
387
|
+
readonly effects: readonly components["schemas"]["Effect"][];
|
|
388
|
+
/** @description Trade details for FILL, CONVERSION and CREDIT; null for every other kind and for entries recorded before trade details were retained. A CREDIT is an outcome settlement: it sells all size shares of side at price, what one share of that side paid at settlement, so the gross payout is size times price before the fee effect. */
|
|
389
|
+
readonly fill: components["schemas"]["Fill"] | null;
|
|
390
|
+
/** @description Address of the other party when known, such as a deposit's payer; null otherwise. */
|
|
391
|
+
readonly counterparty: string | null;
|
|
392
|
+
/** @description Machine-readable display code, e.g. DEPOSIT, WALLET_VAULT_TRANSFER, MAKER_WITHDRAW_REQUESTED or REORG_REVERSAL; defaults to the kind. */
|
|
393
|
+
readonly description_code: string;
|
|
394
|
+
} & (unknown & unknown & unknown & unknown & unknown);
|
|
395
|
+
readonly ActivityList: {
|
|
396
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
397
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
398
|
+
/** @description Activities on this page, ordered by sequence, then activity_id, descending, within each vault; several vaults' activities are merged, most recently recorded first. */
|
|
399
|
+
readonly items: readonly components["schemas"]["Activity"][];
|
|
400
|
+
/** @description Opaque cursor for the next page, bound to this response's snapshot; null on the last page. Send it back unchanged as cursor. */
|
|
401
|
+
readonly next_cursor: components["schemas"]["NextCursor"];
|
|
402
|
+
/** @description True when another page exists; true exactly when next_cursor is non-null. */
|
|
403
|
+
readonly has_more: boolean;
|
|
404
|
+
};
|
|
405
|
+
readonly ActivityDetail: {
|
|
406
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
407
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
408
|
+
/** @description The requested activity. */
|
|
409
|
+
readonly activity: components["schemas"]["Activity"];
|
|
410
|
+
};
|
|
411
|
+
/** @enum {string} */
|
|
412
|
+
readonly Permission: "READ_CAPITAL" | "READ_POSITIONS" | "READ_ACTIVITY" | "READ_PERFORMANCE" | "READ_TELEMETRY";
|
|
413
|
+
readonly MakerAccess: {
|
|
414
|
+
/** @description On-chain maker ID this access applies to, as a decimal string. */
|
|
415
|
+
readonly maker_id: components["schemas"]["NonZeroUInt64String"];
|
|
416
|
+
/** @description Maker controller (owner) address the access was verified against. */
|
|
417
|
+
readonly owner: components["schemas"]["LowercaseNonZeroAddress"];
|
|
418
|
+
/** @description Maker controller epoch at verification, as a decimal string; a controller change invalidates access derived from an earlier epoch. */
|
|
419
|
+
readonly owner_version: string;
|
|
420
|
+
/** @description Revision of the owner's wallet link, as a decimal string. It changes when the wallet is unlinked and relinked, which expires cursors bound to the old revision. */
|
|
421
|
+
readonly access_revision: string;
|
|
422
|
+
/** @description Read permissions held. They never authorize signing or spending. */
|
|
423
|
+
readonly permissions: readonly components["schemas"]["Permission"][];
|
|
424
|
+
};
|
|
425
|
+
/** @description A venue admission reservation on the maker vault. */
|
|
426
|
+
readonly Reservation: {
|
|
427
|
+
/** @description Stable reservation identifier. */
|
|
428
|
+
readonly reservation_id: string;
|
|
429
|
+
/** @description Operations holding this reservation. */
|
|
430
|
+
readonly operation_ids: readonly string[];
|
|
431
|
+
/** @description Reserved amount in atomic USDC (6 decimals, "1000000" = 1 USDC). */
|
|
432
|
+
readonly value: components["schemas"]["Amount"];
|
|
433
|
+
/**
|
|
434
|
+
* @description ACTIVE: held and not yet reflected on-chain; UNKNOWN: outcome unknown, still counted as held.
|
|
435
|
+
* @enum {string}
|
|
436
|
+
*/
|
|
437
|
+
readonly status: "ACTIVE" | "UNKNOWN";
|
|
438
|
+
};
|
|
439
|
+
readonly ActionAvailability: {
|
|
440
|
+
/**
|
|
441
|
+
* @description Action this decision covers: MAKER_WITHDRAW or MAKER_QUOTE.
|
|
442
|
+
* @enum {string}
|
|
443
|
+
*/
|
|
444
|
+
readonly action: "MAKER_WITHDRAW" | "MAKER_QUOTE";
|
|
445
|
+
/** @description Funding route the decision covers, e.g. MAKER_VAULT. */
|
|
446
|
+
readonly route: string;
|
|
447
|
+
/** @description Amount available for this action and route in atomic USDC (6 decimals, "1000000" = 1 USDC); null with blockers when unavailable. */
|
|
448
|
+
readonly available: components["schemas"]["UnsignedMetric"];
|
|
449
|
+
/** @description Machine-readable codes blocking the action, e.g. MAKER_WITHDRAW_PENDING or RECONCILIATION_MISMATCH; at least one when available is null. */
|
|
450
|
+
readonly blockers: readonly string[];
|
|
451
|
+
};
|
|
452
|
+
/** @description Maker capital lanes and derived collateral, in atomic USDC (6 decimals, "1000000" = 1 USDC). Amounts are null when unavailable; context.status is their freshness. */
|
|
453
|
+
readonly MakerCapital: {
|
|
454
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
455
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
456
|
+
/** @description Maker owner (its controller) from the same indexed vault row as the lanes. */
|
|
457
|
+
readonly owner: components["schemas"]["LowercaseNonZeroAddress"];
|
|
458
|
+
/** @description Maker signer (its quote signer) from the same indexed vault row as the lanes. The zero address means the maker was opened without one and cannot quote. */
|
|
459
|
+
readonly signer: string;
|
|
460
|
+
/** @description Maker vault lane V from the vault contract, including escrow and payables. */
|
|
461
|
+
readonly vault_gross: components["schemas"]["UnsignedMetric"];
|
|
462
|
+
/** @description Bettor net stakes escrowed in this maker's open tickets (E). */
|
|
463
|
+
readonly stake_escrow: components["schemas"]["UnsignedMetric"];
|
|
464
|
+
/** @description Settled winnings owed to ticket holders and not yet claimed (P). */
|
|
465
|
+
readonly payable_owed: components["schemas"]["UnsignedMetric"];
|
|
466
|
+
/** @description Original open maker exposure G: payout minus net stake summed over open tickets. */
|
|
467
|
+
readonly gross_open: components["schemas"]["UnsignedMetric"];
|
|
468
|
+
/** @description Maker discount lane D from the vault contract, which offsets gross_open in the requirement. */
|
|
469
|
+
readonly discount: components["schemas"]["UnsignedMetric"];
|
|
470
|
+
/** @description Collateral requirement R = max(G - min(D, G), ceil(G * floor_bps / 10000)) under the pinned release; null when floor_bps is null or an input is null. */
|
|
471
|
+
readonly requirement: components["schemas"]["UnsignedMetric"];
|
|
472
|
+
/** @description Collateral headroom F = max(V - E - P - R, 0). Not a guarantee of quote acceptance. */
|
|
473
|
+
readonly free_collateral: components["schemas"]["UnsignedMetric"];
|
|
474
|
+
/** @description Signed C = V - E - P. Excludes open-ticket valuation; not equity or NAV. */
|
|
475
|
+
readonly capital_net_of_senior_liabilities: components["schemas"]["Metric"];
|
|
476
|
+
/** @description Admission reservations H the venue holds for this maker that are not yet reflected on-chain; the sum of reservations. */
|
|
477
|
+
readonly pending_commitments: components["schemas"]["UnsignedMetric"];
|
|
478
|
+
/** @description max(F - H, 0): free collateral after unreflected commitments. Not private bot capacity. */
|
|
479
|
+
readonly free_after_pending: components["schemas"]["UnsignedMetric"];
|
|
480
|
+
/** @description Requirement floor K in basis points from the pinned release; null when the on-chain comparison mismatches, which makes requirement UNAVAILABLE. */
|
|
481
|
+
readonly floor_bps: number | null;
|
|
482
|
+
/** @description SHA-256 of the exact pinned artifact that names this deployment's chain and vault: the release artifact on chain 999, the environment's deployment manifest on 998. A client compares it with its own pinned artifact to bind the read to its deployment. */
|
|
483
|
+
readonly deployment_digest: string;
|
|
484
|
+
/** @description Decisions for MAKER_WITHDRAW and MAKER_QUOTE on the MAKER_VAULT route. MAKER_WITHDRAW is the amount a new withdrawal request may ask for: free_after_pending, so it never takes collateral from fills already admitted. The vault re-checks free collateral when the request executes after its delay; it is null with MAKER_WITHDRAW_PENDING while a request is live, or with a reconciliation blocker. MAKER_QUOTE is always null with one blocker, because quoting capacity depends on state only the maker's bot holds, such as its other live quotes. PRIVATE_QUOTE_CAPACITY_UNAVAILABLE means only that Totalis cannot compute that amount; it does not mean quoting is off, and the maker can keep quoting. A reconciliation blocker replaces it while the vault read and venue records disagree. */
|
|
485
|
+
readonly actions: readonly components["schemas"]["ActionAvailability"][];
|
|
486
|
+
/** @description Venue reservations on MAKER_VAULT that make up pending_commitments. */
|
|
487
|
+
readonly reservations: readonly components["schemas"]["Reservation"][];
|
|
488
|
+
} & unknown;
|
|
489
|
+
readonly Leg: {
|
|
490
|
+
/** @description HIP-4 outcome ID of the leg, as a decimal string. */
|
|
491
|
+
readonly outcome_id: components["schemas"]["UInt32String"];
|
|
492
|
+
/**
|
|
493
|
+
* @description Outcome side the position holds, YES or NO.
|
|
494
|
+
* @enum {string}
|
|
495
|
+
*/
|
|
496
|
+
readonly side: "YES" | "NO";
|
|
497
|
+
/**
|
|
498
|
+
* @description RESOLVED: the outcome has a final result.
|
|
499
|
+
* @constant
|
|
500
|
+
*/
|
|
501
|
+
readonly status: "RESOLVED";
|
|
502
|
+
/** @description Selected-side result factor over result_denominator: 100000000 is a full win, 0 a loss, values between are fractional. */
|
|
503
|
+
readonly result_numerator: string;
|
|
504
|
+
/**
|
|
505
|
+
* @description Always 100000000, the pinned grading scale.
|
|
506
|
+
* @constant
|
|
507
|
+
*/
|
|
508
|
+
readonly result_denominator: "100000000";
|
|
509
|
+
} | {
|
|
510
|
+
/** @description HIP-4 outcome ID of the leg, as a decimal string. */
|
|
511
|
+
readonly outcome_id: components["schemas"]["UInt32String"];
|
|
512
|
+
/**
|
|
513
|
+
* @description Outcome side the position holds, YES or NO.
|
|
514
|
+
* @enum {string}
|
|
515
|
+
*/
|
|
516
|
+
readonly side: "YES" | "NO";
|
|
517
|
+
/**
|
|
518
|
+
* @description UNRESOLVED: result still pending; UNAVAILABLE: historical result evidence is missing.
|
|
519
|
+
* @enum {unknown}
|
|
520
|
+
*/
|
|
521
|
+
readonly status: "UNRESOLVED" | "UNAVAILABLE";
|
|
522
|
+
/** @description Null until the leg has a known result. */
|
|
523
|
+
readonly result_numerator: null;
|
|
524
|
+
/** @description Null until the leg has a known result. */
|
|
525
|
+
readonly result_denominator: null;
|
|
526
|
+
};
|
|
527
|
+
readonly Position: {
|
|
528
|
+
/** @description Position ID: the contract's ticketId (bytes32 hex). A ticketId is the EIP-712 digest of its quote under its vault's domain, so it names one position across every vault. */
|
|
529
|
+
readonly position_id: string;
|
|
530
|
+
/** @description Lowercase vault contract address the position is on. An account's positions span every vault the deployment has served: the active one, one running off and closed ones. */
|
|
531
|
+
readonly vault_address: components["schemas"]["LowercaseNonZeroAddress"];
|
|
532
|
+
/** @description Whether the position's vault takes a cash-out. Only the active vault does; a position on a vault running off cannot be cashed out (`STATE_CONFLICT`) and pays out automatically when it settles. Whether this position can be cashed out now also depends on its status. */
|
|
533
|
+
readonly cashout_available: boolean;
|
|
534
|
+
/** @description Maker that wrote the position, as a decimal string. */
|
|
535
|
+
readonly maker_id: components["schemas"]["NonZeroUInt64String"];
|
|
536
|
+
/** @description Current position owner wallet (lowercase). */
|
|
537
|
+
readonly owner: components["schemas"]["LowercaseNonZeroAddress"];
|
|
538
|
+
/**
|
|
539
|
+
* @description OPEN: not yet known eligible for settlement; AWAITING_SETTLEMENT: every leg resolved, or the payout with every unresolved leg counted as a win already rounds down to zero, but no settlement observed; SETTLED_UNCLAIMED: settled with profit still unclaimed; CLOSED: closed by zero-profit settlement, final claim or sell-back.
|
|
540
|
+
* @enum {string}
|
|
541
|
+
*/
|
|
542
|
+
readonly status: "OPEN" | "AWAITING_SETTLEMENT" | "SETTLED_UNCLAIMED" | "CLOSED";
|
|
543
|
+
/** @description Profit fee in basis points, fixed when the position opened. The holder claims unclaimed_profit minus unclaimed_profit * fee_bps / 10000. */
|
|
544
|
+
readonly fee_bps: number;
|
|
545
|
+
/**
|
|
546
|
+
* @description How a CLOSED position closed: CLAIM (final claim of winnings) or SELL_BACK (bought back by the maker). Null otherwise, including direct zero-profit settlement closes and closes without retained evidence.
|
|
547
|
+
* @enum {string|null}
|
|
548
|
+
*/
|
|
549
|
+
readonly close_reason: "CLAIM" | "SELL_BACK" | null;
|
|
550
|
+
/** @description Stake after the taker entry fee. */
|
|
551
|
+
readonly net_stake: components["schemas"]["UnsignedMetric"];
|
|
552
|
+
/** @description What the current owner paid for the whole position: the price of the latest transfer to them, or the gross stake with the entry fee if they have held it since opening. Settlement, claims and sell-back don't change it. Null when retained chain history has a gap that could hide a transfer. P&L compares it with what the owner gets back, settlement_payout or cashout_price, less the profit fee of fee_bps on the amount above net_stake, whatever the owner paid. */
|
|
553
|
+
readonly acquisition_cost: components["schemas"]["UnsignedMetric"];
|
|
554
|
+
/** @description Payout if every leg wins, as the maker signed it in the quote; the maker's initial exposure is payout minus net_stake. */
|
|
555
|
+
readonly payout: components["schemas"]["UnsignedMetric"];
|
|
556
|
+
/** @description Settlement payout observed on-chain; null before settlement and for sold-back positions. */
|
|
557
|
+
readonly settlement_payout: components["schemas"]["UnsignedMetric"];
|
|
558
|
+
/** @description Gross profit still claimable; "0" unless SETTLED_UNCLAIMED. The holder receives unclaimed_profit minus unclaimed_profit * fee_bps / 10000. */
|
|
559
|
+
readonly unclaimed_profit: components["schemas"]["UnsignedMetric"];
|
|
560
|
+
/** @description Cash-out price paid when the position was sold back; null unless close_reason is SELL_BACK. */
|
|
561
|
+
readonly cashout_price: components["schemas"]["UnsignedMetric"];
|
|
562
|
+
/** @description Position legs in ascending outcome_id order, with each leg's resolution. */
|
|
563
|
+
readonly legs: readonly components["schemas"]["Leg"][];
|
|
564
|
+
/**
|
|
565
|
+
* Format: date-time
|
|
566
|
+
* @description RFC3339 time of the position's opening event; lists order by it, newest first.
|
|
567
|
+
*/
|
|
568
|
+
readonly created_at: string;
|
|
569
|
+
/**
|
|
570
|
+
* Format: date-time
|
|
571
|
+
* @description RFC3339 time of the position's latest lifecycle event.
|
|
572
|
+
*/
|
|
573
|
+
readonly updated_at: string;
|
|
574
|
+
/**
|
|
575
|
+
* @description Settlement result: LOSS (zero payout), PARTIAL (payout below net stake), WIN (payout at or above net stake) or EARLY_LOST (lost before every leg resolved). Null before settlement, for sell-backs, or when historical evidence is missing.
|
|
576
|
+
* @enum {string|null}
|
|
577
|
+
*/
|
|
578
|
+
readonly settlement_kind: "LOSS" | "PARTIAL" | "WIN" | "EARLY_LOST" | null;
|
|
579
|
+
/** @description The maker's signed P&L on this position once it closed economically: net_stake minus settlement_payout, or minus cashout_price for a sell-back; positive when the maker won. The same amount performance recognizes, so fees the owner paid never enter it. Null while OPEN or AWAITING_SETTLEMENT and when the close amount is unavailable. */
|
|
580
|
+
readonly maker_pnl: components["schemas"]["Metric"];
|
|
581
|
+
/**
|
|
582
|
+
* @description Sign of maker_pnl: WON (positive), LOST (negative) or EVEN (zero); null exactly when maker_pnl is null.
|
|
583
|
+
* @enum {string|null}
|
|
584
|
+
*/
|
|
585
|
+
readonly maker_result: "WON" | "LOST" | "EVEN" | null;
|
|
586
|
+
/** @description Fees the vault took on this position so far, all paid by its owners and none by the maker: the taker entry fee at opening plus the profit fee withheld from each claim and from a sell-back. Null when retained history has a gap that could hide one. */
|
|
587
|
+
readonly protocol_fees: components["schemas"]["UnsignedMetric"];
|
|
588
|
+
} & (unknown & unknown & unknown & unknown & unknown & unknown & unknown & unknown);
|
|
589
|
+
readonly PositionList: {
|
|
590
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
591
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
592
|
+
/** @description Positions on this page, newest created_at first, then position_id descending. */
|
|
593
|
+
readonly items: readonly components["schemas"]["Position"][];
|
|
594
|
+
/** @description Opaque cursor for the next page, bound to this response's snapshot; null on the last page. Send it back unchanged as cursor. */
|
|
595
|
+
readonly next_cursor: components["schemas"]["NextCursor"];
|
|
596
|
+
/** @description True when another page exists; true exactly when next_cursor is non-null. */
|
|
597
|
+
readonly has_more: boolean;
|
|
598
|
+
/** @description Exact number of positions in the whole filtered snapshot (not just this page), as a decimal string. */
|
|
599
|
+
readonly total_count: string;
|
|
600
|
+
};
|
|
601
|
+
readonly PositionDetail: {
|
|
602
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
603
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
604
|
+
/** @description The requested position. */
|
|
605
|
+
readonly position: components["schemas"]["Position"];
|
|
606
|
+
};
|
|
607
|
+
/** @description Maker realized performance for a period. Every period aggregate is null unless the whole period is covered by reconciled history. */
|
|
608
|
+
readonly Performance: {
|
|
609
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
610
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
611
|
+
/**
|
|
612
|
+
* Format: date-time
|
|
613
|
+
* @description Inclusive RFC3339 start of the requested period, echoed from the query.
|
|
614
|
+
*/
|
|
615
|
+
readonly from: string;
|
|
616
|
+
/**
|
|
617
|
+
* Format: date-time
|
|
618
|
+
* @description Exclusive RFC3339 end of the requested period, echoed from the query.
|
|
619
|
+
*/
|
|
620
|
+
readonly through: string;
|
|
621
|
+
/**
|
|
622
|
+
* @description P&L recognition rule: realized at economic close (settlement or sell-back), version 1. Claims do not recognize P&L again.
|
|
623
|
+
* @constant
|
|
624
|
+
*/
|
|
625
|
+
readonly recognition: "REALIZED_AT_ECONOMIC_CLOSE_V1";
|
|
626
|
+
/**
|
|
627
|
+
* Format: date-time
|
|
628
|
+
* @description Earliest from this maker's periods can start at and still be complete: the later of where retained vault history and venue workflows begin, or the maker's opening block if later still. Request from=history_from for an all-time period. Null while vault history is unavailable.
|
|
629
|
+
*/
|
|
630
|
+
readonly history_from: string | null;
|
|
631
|
+
/** @description Tickets economically closed in the period, as a decimal string; null when settled_net_stake is null. */
|
|
632
|
+
readonly closed_ticket_count: string | null;
|
|
633
|
+
/** @description Closes in the period the maker won (positive maker P&L), as a decimal string; null exactly when closed_ticket_count is null. */
|
|
634
|
+
readonly won_ticket_count: string | null;
|
|
635
|
+
/** @description Closes in the period the maker lost (negative maker P&L), as a decimal string; null exactly when closed_ticket_count is null. */
|
|
636
|
+
readonly lost_ticket_count: string | null;
|
|
637
|
+
/** @description Closes in the period with zero maker P&L, as a decimal string; null exactly when closed_ticket_count is null. Won, lost and even add up to closed_ticket_count. */
|
|
638
|
+
readonly even_ticket_count: string | null;
|
|
639
|
+
/** @description Net stake released by economic closes in the period. */
|
|
640
|
+
readonly settled_net_stake: components["schemas"]["UnsignedMetric"];
|
|
641
|
+
/** @description Signed maker trading P&L from closes in the period (net stake minus effective payout). */
|
|
642
|
+
readonly gross_trading_pnl: components["schemas"]["Metric"];
|
|
643
|
+
/** @description Sum of the maker P&L of the period's closes the maker won (each positive), so never negative. gross_winning_pnl + gross_losing_pnl = gross_trading_pnl; profit factor is gross_winning_pnl / -gross_losing_pnl. */
|
|
644
|
+
readonly gross_winning_pnl: components["schemas"]["Metric"];
|
|
645
|
+
/** @description Sum of the maker P&L of the period's closes the maker lost (each negative), so never positive. */
|
|
646
|
+
readonly gross_losing_pnl: components["schemas"]["Metric"];
|
|
647
|
+
/** @description Fees the maker paid in the period. Taker fees are not maker expenses. */
|
|
648
|
+
readonly attributed_fees: components["schemas"]["UnsignedMetric"];
|
|
649
|
+
/** @description Signed gross_trading_pnl minus attributed_fees. */
|
|
650
|
+
readonly net_trading_pnl: components["schemas"]["Metric"];
|
|
651
|
+
/** @description Deposits into the maker vault in the period; never P&L. */
|
|
652
|
+
readonly external_inflows: components["schemas"]["UnsignedMetric"];
|
|
653
|
+
/** @description Executed maker withdrawals in the period; never P&L. */
|
|
654
|
+
readonly external_outflows: components["schemas"]["UnsignedMetric"];
|
|
655
|
+
/** @description Cumulative net realized P&L at UTC day boundaries within the requested interval, from the same revision as totals, in atomic USDC (6 decimals, "1000000" = 1 USDC): the opening zero point at from, one point per UTC day with closes or maker-paid fees, then through if no day ends there. Each point carries the closes since the previous one, so a day with closes is told apart from the synthetic endpoints. Empty when net_trading_pnl is null. */
|
|
656
|
+
readonly series?: readonly {
|
|
657
|
+
/**
|
|
658
|
+
* Format: date-time
|
|
659
|
+
* @description Point time: from for the opening zero point, then the end of each UTC day with closes (capped at through), then through.
|
|
660
|
+
*/
|
|
661
|
+
readonly at: string;
|
|
662
|
+
/** @description Cumulative signed net trading P&L from from up to at, in atomic USDC (6 decimals, "1000000" = 1 USDC). */
|
|
663
|
+
readonly net_trading_pnl: string;
|
|
664
|
+
/** @description Closes since the previous point, as a decimal string: the day's closes for a day point ("0" only on a day whose maker-paid fees moved P&L); "0" for the opening point and for a through point added after the last such day. */
|
|
665
|
+
readonly closed_ticket_count: string;
|
|
666
|
+
/** @description Net trading P&L of those closes: net_trading_pnl minus the previous point's. A day point with closes is a real close day even when this is "0". */
|
|
667
|
+
readonly net_trading_pnl_change: string;
|
|
668
|
+
}[];
|
|
669
|
+
} & (unknown & unknown & unknown);
|
|
670
|
+
readonly TelemetryData: {
|
|
671
|
+
readonly publisher_id: string;
|
|
672
|
+
readonly sequence: string;
|
|
673
|
+
/** Format: date-time */
|
|
674
|
+
readonly observed_at: string;
|
|
675
|
+
/** Format: date-time */
|
|
676
|
+
readonly expires_at: string;
|
|
677
|
+
/** @constant */
|
|
678
|
+
readonly product: "OUTCOME_TICKET";
|
|
679
|
+
readonly risk_scope: string;
|
|
680
|
+
readonly risk_revision: string;
|
|
681
|
+
/** @description Quoting capacity the maker reported, in atomic USDC (6 decimals, "1000000" = 1 USDC); null when it reported none. */
|
|
682
|
+
readonly quoting_capacity: components["schemas"]["UnsignedMetric"];
|
|
683
|
+
/** @enum {string} */
|
|
684
|
+
readonly bot_status: "QUOTING" | "PAUSED" | "DEGRADED" | "STOPPED";
|
|
685
|
+
readonly reason: string | null;
|
|
686
|
+
};
|
|
687
|
+
readonly Telemetry: {
|
|
688
|
+
/** @description Freshness of this read: the oldest source observation and one status for every amount in the response. */
|
|
689
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
690
|
+
readonly telemetry: ({
|
|
691
|
+
/** @enum {string} */
|
|
692
|
+
readonly status: "CURRENT" | "STALE";
|
|
693
|
+
readonly data: components["schemas"]["TelemetryData"];
|
|
694
|
+
readonly reason: string | null;
|
|
695
|
+
} & unknown) | {
|
|
696
|
+
/** @constant */
|
|
697
|
+
readonly status: "UNAVAILABLE";
|
|
698
|
+
readonly data: null;
|
|
699
|
+
readonly reason: string;
|
|
700
|
+
};
|
|
701
|
+
};
|
|
702
|
+
/** @description Account reads that changed: refetch the named resources for the scope. */
|
|
703
|
+
readonly Invalidation: {
|
|
704
|
+
/**
|
|
705
|
+
* @description Account-read contract version of the invalidation; always "1".
|
|
706
|
+
* @constant
|
|
707
|
+
*/
|
|
708
|
+
readonly contract_version: "1";
|
|
709
|
+
/** @description Account or maker scope whose reads changed; the same scope the subscriptionResponse's account_reads names when the subscription set account_reads. */
|
|
710
|
+
readonly scope: components["schemas"]["Scope"];
|
|
711
|
+
/** @description Revision of the changed reads, as a decimal string; a higher revision supersedes a lower one. */
|
|
712
|
+
readonly revision: string;
|
|
713
|
+
/** @description Account reads to refetch. */
|
|
714
|
+
readonly resources: readonly ("BALANCES" | "CAPITAL" | "ACTIVITY" | "POSITIONS" | "PERFORMANCE" | "TELEMETRY" | "QUOTES" | "ACCESS")[];
|
|
715
|
+
/** @description Stream cursor of the change; persist it like an event cursor. */
|
|
716
|
+
readonly cursor: components["schemas"]["Cursor"];
|
|
717
|
+
};
|
|
718
|
+
readonly ReadSubscription: {
|
|
719
|
+
/**
|
|
720
|
+
* @description Account-read contract version of the subscription; always "1".
|
|
721
|
+
* @constant
|
|
722
|
+
*/
|
|
723
|
+
readonly contract_version: "1";
|
|
724
|
+
/** @description Account or maker scope the server derived from the credential for this stream. */
|
|
725
|
+
readonly scope: components["schemas"]["Scope"];
|
|
726
|
+
/** @description Stream cursor the client asked to resume after; null when it started without one. */
|
|
727
|
+
readonly cursor: components["schemas"]["Cursor"] | null;
|
|
728
|
+
};
|
|
729
|
+
/** @description Non-negative amount in atomic USDC (6 decimals, "1000000" = 1 USDC); null when it could not be established, never zero in its place. */
|
|
730
|
+
readonly UnsignedMetric: components["schemas"]["Amount"] | null;
|
|
731
|
+
/** Format: uint64-decimal */
|
|
732
|
+
readonly UInt64String: string;
|
|
733
|
+
readonly NonZeroUInt64String: components["schemas"]["UInt64String"] & unknown;
|
|
734
|
+
readonly DashboardQuotes: {
|
|
735
|
+
/** Format: date-time */
|
|
736
|
+
readonly generated_at: string;
|
|
737
|
+
readonly quotes: readonly {
|
|
738
|
+
/** Format: uuid */
|
|
739
|
+
readonly rfq_id: string;
|
|
740
|
+
/** @description Bettor stake in atomic USDC (6 decimals), before taker fees. */
|
|
741
|
+
readonly stake: string;
|
|
742
|
+
/** @description Stake less the quote's taker fee, floor(stake * taker_fee_bps / 10000), in atomic USDC (6 decimals): what the vault escrows if the quote fills. Payout minus net_stake is the maker's risk. */
|
|
743
|
+
readonly net_stake: string;
|
|
744
|
+
/** @description Signed potential bettor payout in atomic USDC (6 decimals). */
|
|
745
|
+
readonly payout: string;
|
|
746
|
+
/** @description Quote expiry as Unix epoch seconds. */
|
|
747
|
+
readonly expiry: string;
|
|
748
|
+
readonly legs: number;
|
|
749
|
+
}[];
|
|
750
|
+
};
|
|
751
|
+
/**
|
|
752
|
+
* @description Stable HTTP error code. Each code has one HTTP status and one retry value.
|
|
753
|
+
* @enum {string}
|
|
754
|
+
*/
|
|
755
|
+
readonly ErrorCode: "INVALID_REQUEST" | "INVALID_QUERY" | "INVALID_CURSOR" | "INVALID_IDEMPOTENCY_KEY" | "ORIGIN_REQUIRED" | "SUBPROTOCOL_REQUIRED" | "UNSUPPORTED_BROWSE_CONTRACT" | "UNAUTHENTICATED" | "FORBIDDEN" | "ORIGIN_NOT_ALLOWED" | "ACCESS_REQUIRED" | "SIGN_IN_REQUIRED" | "NOT_FOUND" | "IDENTITY_NOT_FOUND" | "QUOTE_NOT_FOUND" | "INVITE_CODE_NOT_FOUND" | "IDEMPOTENCY_KEY_REUSED" | "STATE_CONFLICT" | "INVITE_CODE_EXHAUSTED" | "STALE_CURSOR" | "CURSOR_EXPIRED" | "CURSOR_RESET" | "RECURRING_DEFINITION_CONFLICT" | "EMBEDDED_WALLET_CONFLICT" | "SECRET_UNAVAILABLE" | "ROTATION_IN_PROGRESS" | "TELEMETRY_CONFLICT" | "RFQ_NOT_CANCELLABLE" | "RFQ_NOT_OPEN" | "RFQ_GENERATION_STALE" | "RFQ_GENERATION_IN_FLIGHT" | "QUOTE_EXPIRED" | "QUOTE_CANCELLED" | "QUOTE_REPLACED" | "QUOTE_SIGNER_CHANGED" | "QUOTE_CAPACITY_EXCEEDED" | "CORE_ACCOUNT_NOT_READY" | "CORE_ACCOUNT_ACTIVATION_REQUIRED" | "CORE_EXIT_ABANDONED" | "CORE_MOVE_IN_FLIGHT" | "ACCEPTANCE_IN_FLIGHT" | "USERNAME_TAKEN" | "USERNAME_ALREADY_SET" | "USERNAME_REQUIRED" | "INVALID_SIGNATURE" | "WALLET_CONTRACT_UNSUPPORTED" | "WRONG_AUTHORITY" | "KEY_LIMIT_REACHED" | "USERNAME_NOT_ALLOWED" | "FOLLOW_SELF" | "FOLLOW_LIMIT_REACHED" | "RATE_LIMITED" | "CONNECTION_LIMIT" | "RFQ_INTENT_LIMIT" | "QUOTE_EXPOSURE_LIMIT" | "DEPENDENCY_STALE" | "AUTHORIZATION_UNAVAILABLE" | "SOURCE_UNAVAILABLE" | "CONTRACT_UNAVAILABLE" | "MARKET_DATA_UNAVAILABLE" | "BROWSE_UNAVAILABLE" | "FINANCIAL_ACTIONS_DISABLED" | "CORE_EXIT_UNAVAILABLE" | "COLLATERAL_REDUCTION_UNAVAILABLE" | "SPONSORSHIP_UNAVAILABLE" | "CONTRACT_SIGNATURE_OVERLOADED" | "QUOTE_EXPOSURE_STALE" | "COMBO_AUTOMATIC_DISABLED" | "GAS_PRICE_ABOVE_CEILING" | "EMBEDDED_WALLET_UNAVAILABLE" | "CONNECTION_DRAIN";
|
|
756
|
+
readonly FieldViolation: {
|
|
757
|
+
/**
|
|
758
|
+
* @description REQUIRED: the input is missing. INVALID: it is present but malformed or out of range. UNEXPECTED: the input is not accepted here.
|
|
759
|
+
* @enum {string}
|
|
760
|
+
*/
|
|
761
|
+
readonly code: "REQUIRED" | "INVALID" | "UNEXPECTED";
|
|
762
|
+
/** @description JSON pointer into the body, or into the query parameters as one flat object for requests without a body, for example /legs/0/stake or /limit. */
|
|
763
|
+
readonly field: string;
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* @description NEVER: stop. BACKOFF: resend the same request with the same Idempotency-Key after Retry-After. REFRESH: re-read state, then send a new request with a new Idempotency-Key.
|
|
767
|
+
* @enum {string}
|
|
768
|
+
*/
|
|
769
|
+
readonly Retry: "NEVER" | "BACKOFF" | "REFRESH";
|
|
770
|
+
readonly ErrorDetail: {
|
|
771
|
+
/** @description Stable registered code; branch on this, not on message or status. */
|
|
772
|
+
readonly code: components["schemas"]["ErrorCode"];
|
|
773
|
+
/** @description Each invalid input by JSON pointer; empty when the error is not about a specific input. */
|
|
774
|
+
readonly field_violations: readonly components["schemas"]["FieldViolation"][];
|
|
775
|
+
/** @description Human-readable; may change without notice. */
|
|
776
|
+
readonly message: string;
|
|
777
|
+
/**
|
|
778
|
+
* Format: uuid
|
|
779
|
+
* @description UUIDv7 of this request, also returned in the X-Request-ID header. Quote it when reporting a problem.
|
|
780
|
+
*/
|
|
781
|
+
readonly request_id: string;
|
|
782
|
+
/** @description What the caller should do next; fixed by the registry for each code. */
|
|
783
|
+
readonly retry: components["schemas"]["Retry"];
|
|
784
|
+
};
|
|
785
|
+
readonly Error: {
|
|
786
|
+
/** @description The one error this request failed with. */
|
|
787
|
+
readonly error: components["schemas"]["ErrorDetail"];
|
|
788
|
+
};
|
|
789
|
+
readonly LowercaseNonZeroAddress: string;
|
|
790
|
+
readonly OwnMaker: {
|
|
791
|
+
/**
|
|
792
|
+
* @description Account-read contract version; always "1" for this response shape.
|
|
793
|
+
* @constant
|
|
794
|
+
*/
|
|
795
|
+
readonly contract_version: "1";
|
|
796
|
+
/** @description EVM chain ID of the deployment the credential is bound to, as a decimal string (999 on HyperEVM Mainnet). */
|
|
797
|
+
readonly chain_id: string;
|
|
798
|
+
/** @description Lowercase address of the vault contract of the credential's deployment. */
|
|
799
|
+
readonly vault: components["schemas"]["LowercaseNonZeroAddress"];
|
|
800
|
+
/**
|
|
801
|
+
* Format: date-time
|
|
802
|
+
* @description RFC3339 UTC time the server built this response.
|
|
803
|
+
*/
|
|
804
|
+
readonly generated_at: string;
|
|
805
|
+
/** @description Maker ownership state of the caller's account, derived from its linked wallet and indexed on-chain controller evidence. */
|
|
806
|
+
readonly ownership: {
|
|
807
|
+
/**
|
|
808
|
+
* @description NOT_CREATED: the account's wallet controls no maker; WALLET_REQUIRED: the account has no single qualifying linked wallet; OWNERSHIP_CONFLICT: several candidate wallets, or the maker's current controller no longer matches; READY: the maker is admitted and current; PENDING: the maker profile awaits admission; RESTRICTED: the maker profile is restricted or closed; SETUP_REQUIRED: a maker controlled by the wallet exists on-chain but has no admitted profile yet.
|
|
809
|
+
* @enum {string}
|
|
810
|
+
*/
|
|
811
|
+
readonly state: "NOT_CREATED" | "WALLET_REQUIRED" | "OWNERSHIP_CONFLICT" | "READY" | "PENDING" | "RESTRICTED" | "SETUP_REQUIRED";
|
|
812
|
+
/** @description Linked wallet that controls (owns) the maker; absent when the account has no single qualifying linked wallet. */
|
|
813
|
+
readonly owner?: components["schemas"]["LowercaseNonZeroAddress"];
|
|
814
|
+
/** @description The admitted maker and the caller's owner access to it; null unless state is READY, PENDING or RESTRICTED. */
|
|
815
|
+
readonly maker: components["schemas"]["MakerAccess"] | null;
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
/**
|
|
819
|
+
* @description Maximum items in one page. A page may hold fewer, even none, while has_more is true.
|
|
820
|
+
* @default 50
|
|
821
|
+
*/
|
|
822
|
+
readonly PageLimit: number;
|
|
823
|
+
/** @description Opaque list cursor. Send a previous response's next_cursor back unchanged; never build or parse one. */
|
|
824
|
+
readonly PageCursor: string;
|
|
825
|
+
/** Format: eip55-address */
|
|
826
|
+
readonly "$defs-Address": string;
|
|
827
|
+
/** @description Opaque cursor for the next page, or null when has_more is false. */
|
|
828
|
+
readonly NextCursor: string | null;
|
|
829
|
+
readonly ControlledMakerList: {
|
|
830
|
+
/**
|
|
831
|
+
* @description Account-read contract version; always "1" for this response shape.
|
|
832
|
+
* @constant
|
|
833
|
+
*/
|
|
834
|
+
readonly contract_version: "1";
|
|
835
|
+
/** @description EVM chain ID of the deployment the credential is bound to, as a decimal string (999 on HyperEVM Mainnet). */
|
|
836
|
+
readonly chain_id: string;
|
|
837
|
+
/** @description Lowercase address of the vault contract of the credential's deployment. */
|
|
838
|
+
readonly vault: components["schemas"]["LowercaseNonZeroAddress"];
|
|
839
|
+
/** @description Makers in this vault whose on-chain controller is one of the caller's linked wallets, in ascending maker_id order. Discovery only; grants no access. */
|
|
840
|
+
readonly items: readonly {
|
|
841
|
+
/** @description On-chain maker ID in the vault, as a decimal string. */
|
|
842
|
+
readonly maker_id: components["schemas"]["NonZeroUInt64String"];
|
|
843
|
+
/** @description Maker controller (owner) address; one of the caller's linked wallets. */
|
|
844
|
+
readonly owner: components["schemas"]["LowercaseNonZeroAddress"];
|
|
845
|
+
/** @description Address currently authorized to sign the maker's quotes. */
|
|
846
|
+
readonly signer: components["schemas"]["$defs-Address"];
|
|
847
|
+
}[];
|
|
848
|
+
/** @description Opaque cursor for the next page; null on the last page. Send it back unchanged as cursor. */
|
|
849
|
+
readonly next_cursor: components["schemas"]["NextCursor"];
|
|
850
|
+
/** @description True when another page exists; true exactly when next_cursor is non-null. */
|
|
851
|
+
readonly has_more: boolean;
|
|
852
|
+
/**
|
|
853
|
+
* Format: date-time
|
|
854
|
+
* @description RFC3339 UTC time the server built this response.
|
|
855
|
+
*/
|
|
856
|
+
readonly generated_at: string;
|
|
857
|
+
};
|
|
858
|
+
/** @description Cumulative trading P&L of the account Portfolio shows, computed on read: Core trading plus Combos closed in the deployment's vault. Points are cumulative since tracked_since, not rebased: a window's change is its last point minus its first. Deposits, withdrawals and moves between Core and the vault never move it. */
|
|
859
|
+
readonly PnL: {
|
|
860
|
+
/**
|
|
861
|
+
* @description The requested range, echoed.
|
|
862
|
+
* @enum {string}
|
|
863
|
+
*/
|
|
864
|
+
readonly range: "1D" | "1W" | "1M" | "ALL";
|
|
865
|
+
/** @description Where P&L starts: the later of the start of the account's recorded Core history and 2026-10-09T00:00:00Z, the first whole day of stored values; P&L is cumulative from here. It does not prove that history is complete: a fill gap, an unbridged cash gap or holdings the history cannot reproduce make the read UNAVAILABLE with tracked_since still set. Null while the wallet is not yet observed, with no points and a STALE context. */
|
|
866
|
+
readonly tracked_since: components["schemas"]["Timestamp"] | null;
|
|
867
|
+
/** @description Ascending instants: the window start (never before tracked_since), every round UTC step boundary inside it (1D every 15 minutes, 1W every hour, 1M every 6 hours, ALL an adaptive step of at most 200 points), then the read time valued at live marks. */
|
|
868
|
+
readonly points: readonly {
|
|
869
|
+
/** @description Point time. */
|
|
870
|
+
readonly at: components["schemas"]["Timestamp"];
|
|
871
|
+
/** @description Cumulative P&L from tracked_since up to at, in atomic USDC (6 decimals, "1000000" = 1 USDC), rounded once, half away from zero. Null when a share held at at has no known value, when at precedes the first known value of shares held at tracked_since (every earlier point is null), or when the read is UNAVAILABLE; null is never zero. */
|
|
872
|
+
readonly pnl: components["schemas"]["SignedAmount"] | null;
|
|
873
|
+
}[];
|
|
874
|
+
/** @description Freshness of this read. as_of is the valuation instant, the last point's at: it values the history at that instant's marks, and STALE says a source lags. UNAVAILABLE nulls every point. */
|
|
875
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
876
|
+
};
|
|
877
|
+
/** @description Asset an effect moves. Deltas of different assets are different units and are never summed or compared. */
|
|
878
|
+
readonly Asset: {
|
|
879
|
+
/** @description Stable asset identifier. HyperEVM tokens use CAIP-19 `eip155:<chain_id>/erc20:<lowercase address>`; HyperCore spot tokens use `hypercore:<mainnet|testnet>/token:<spotMeta tokenId>`. */
|
|
880
|
+
readonly asset_id: string;
|
|
881
|
+
/** @description Display symbol, e.g. USDC or HYPE. Not an identity (HyperEVM USDC and HyperCore USDC share it), but USDC is one dollar per whole unit on either chain. */
|
|
882
|
+
readonly symbol: string;
|
|
883
|
+
/** @description Scale of the asset's atomic unit: 6 for HyperEVM USDC, 8 for HyperCore USDC and HYPE. */
|
|
884
|
+
readonly decimals: number;
|
|
885
|
+
};
|
|
886
|
+
readonly UInt32String: string;
|
|
887
|
+
/** @enum {string} */
|
|
888
|
+
readonly Side: "YES" | "NO";
|
|
889
|
+
/** @description The traded leg of a HyperCore fill, conversion or settlement credit. Cash and fees stay in effects. */
|
|
890
|
+
readonly Fill: {
|
|
891
|
+
/** @description HIP-4 outcome ID traded, as a decimal string. */
|
|
892
|
+
readonly outcome_id: components["schemas"]["UInt32String"];
|
|
893
|
+
/** @description Outcome side traded, YES or NO. */
|
|
894
|
+
readonly side: components["schemas"]["Side"];
|
|
895
|
+
/**
|
|
896
|
+
* @description BUY or SELL of side, as Hyperliquid reported it; always SELL for a settlement credit.
|
|
897
|
+
* @enum {string}
|
|
898
|
+
*/
|
|
899
|
+
readonly direction: "BUY" | "SELL";
|
|
900
|
+
/** @description Shares filled, as an exact decimal string with no trailing zeros. */
|
|
901
|
+
readonly size: string;
|
|
902
|
+
/** @description Price per share in USDC, as an exact decimal string with no trailing zeros; 0 is possible for a conversion leg or a losing settlement. */
|
|
903
|
+
readonly price: string;
|
|
904
|
+
/** @description Hyperliquid order ID, as a decimal string. */
|
|
905
|
+
readonly oid: components["schemas"]["UInt64String"];
|
|
906
|
+
/** @description Hyperliquid trade ID, as a decimal string. */
|
|
907
|
+
readonly tid: components["schemas"]["NonZeroUInt64String"];
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* @description Where the quote stands now. OPEN: live and acceptable. AWAITING_CONFIRMATION: the taker accepted it and the maker has not answered within its two-second deadline yet. ACCEPTED: the maker confirmed and the trade is queued or on its way to chain. FILLED: the trade committed on chain. FAILED: the trade reverted or expired unexecuted. DECLINED: the maker declined the acceptance. TIMED_OUT: the maker did not answer the acceptance in time. CANCELLED: the maker withdrew the quote. REPLACED: the maker's newer quote on the same RFQ replaced it. EXPIRED: it or its RFQ lapsed unaccepted. NOT_SELECTED: the RFQ's taker accepted another quote first. RFQ_CANCELLED: the taker cancelled or replaced the RFQ.
|
|
911
|
+
* @enum {string}
|
|
912
|
+
*/
|
|
913
|
+
readonly QuoteHistoryStatus: "OPEN" | "AWAITING_CONFIRMATION" | "ACCEPTED" | "FILLED" | "FAILED" | "DECLINED" | "TIMED_OUT" | "CANCELLED" | "REPLACED" | "EXPIRED" | "NOT_SELECTED" | "RFQ_CANCELLED";
|
|
914
|
+
/** @description Fill rate of the period's quotes; status filters do not apply to it. */
|
|
915
|
+
readonly QuoteFillRate: {
|
|
916
|
+
/** @description Quotes the maker published in the period (of the requested kind), every replacement counted, whatever their status. */
|
|
917
|
+
readonly submitted_count: string;
|
|
918
|
+
/** @description Of those, quotes whose trade committed on chain (status FILLED). */
|
|
919
|
+
readonly filled_count: string;
|
|
920
|
+
/** @description floor(filled_count * 10000 / submitted_count) in basis points; null when submitted_count is 0. */
|
|
921
|
+
readonly fill_rate_bps: string | null;
|
|
922
|
+
};
|
|
923
|
+
/** @description One quote the maker published, display fields only; never a signature. A decline carries no reason: the maker's answer records none. */
|
|
924
|
+
readonly QuoteHistoryItem: {
|
|
925
|
+
/** @description Quote ID: the digest the maker signs on confirmation (bytes32 hex). */
|
|
926
|
+
readonly quote_id: string;
|
|
927
|
+
/**
|
|
928
|
+
* Format: uuid
|
|
929
|
+
* @description RFQ the quote answered.
|
|
930
|
+
*/
|
|
931
|
+
readonly rfq_id: string;
|
|
932
|
+
/**
|
|
933
|
+
* @description ENTRY opens a position; CASHOUT buys one back (SELL_BACK) or buys it (TRANSFER).
|
|
934
|
+
* @enum {string}
|
|
935
|
+
*/
|
|
936
|
+
readonly kind: "ENTRY" | "CASHOUT";
|
|
937
|
+
/**
|
|
938
|
+
* @description For a CASHOUT quote, SELL_BACK when the position's own maker buys it back, TRANSFER when another maker buys it; null for ENTRY.
|
|
939
|
+
* @enum {string|null}
|
|
940
|
+
*/
|
|
941
|
+
readonly cashout_kind: "SELL_BACK" | "TRANSFER" | null;
|
|
942
|
+
/** @description Where the quote stands now. OPEN, AWAITING_CONFIRMATION and ACCEPTED can still change; every other status is final. FILLED is the only status in which the quote traded. */
|
|
943
|
+
readonly status: components["schemas"]["QuoteHistoryStatus"];
|
|
944
|
+
/**
|
|
945
|
+
* Format: date-time
|
|
946
|
+
* @description When the venue admitted the quote; lists order by it, newest first.
|
|
947
|
+
*/
|
|
948
|
+
readonly submitted_at: string;
|
|
949
|
+
/**
|
|
950
|
+
* Format: date-time
|
|
951
|
+
* @description The quote's own expiry.
|
|
952
|
+
*/
|
|
953
|
+
readonly expires_at: string;
|
|
954
|
+
/**
|
|
955
|
+
* Format: date-time
|
|
956
|
+
* @description When the taker accepted the quote; null if no taker did.
|
|
957
|
+
*/
|
|
958
|
+
readonly accepted_at: string | null;
|
|
959
|
+
/**
|
|
960
|
+
* Format: date-time
|
|
961
|
+
* @description When the quote reached its status: the trade's chain receipt for FILLED and FAILED, the confirmation deadline for TIMED_OUT, the winning selection for NOT_SELECTED, the earlier of the quote's and the RFQ's expiry for EXPIRED. Null while OPEN, AWAITING_CONFIRMATION or ACCEPTED, and for DECLINED, CANCELLED, REPLACED and RFQ_CANCELLED, whose time the venue does not record.
|
|
962
|
+
*/
|
|
963
|
+
readonly resolved_at: string | null;
|
|
964
|
+
/** @description The trade's operation once the maker confirmed; null otherwise. */
|
|
965
|
+
readonly operation_id: string | null;
|
|
966
|
+
/** @description For ENTRY, the position the quote opened once FILLED (its quote_id); for CASHOUT, the position being cashed out; null otherwise. */
|
|
967
|
+
readonly position_id: string | null;
|
|
968
|
+
/** @description An ENTRY quote's legs in the RFQ's order; null for CASHOUT. */
|
|
969
|
+
readonly legs: readonly {
|
|
970
|
+
/** @description HIP-4 outcome ID of the leg. */
|
|
971
|
+
readonly outcome_id: components["schemas"]["UInt32String"];
|
|
972
|
+
/**
|
|
973
|
+
* @description Side the taker would hold.
|
|
974
|
+
* @enum {string}
|
|
975
|
+
*/
|
|
976
|
+
readonly side: "YES" | "NO";
|
|
977
|
+
}[] | null;
|
|
978
|
+
/** @description ENTRY: the taker's gross stake, before the entry fee. Null for CASHOUT. The quoted odds are payout / stake. */
|
|
979
|
+
readonly stake: components["schemas"]["UnsignedMetric"];
|
|
980
|
+
/** @description ENTRY: stake less the taker entry fee floor(stake * taker_fee_bps / 10000), what the vault escrows. Null for CASHOUT, or when the quote's fee was never admitted. */
|
|
981
|
+
readonly net_stake: components["schemas"]["UnsignedMetric"];
|
|
982
|
+
/** @description ENTRY: what the taker receives if every leg wins. Null for CASHOUT. */
|
|
983
|
+
readonly payout: components["schemas"]["UnsignedMetric"];
|
|
984
|
+
/** @description ENTRY: what the maker stands to pay, payout minus net_stake. Null when net_stake is. */
|
|
985
|
+
readonly maker_risk: components["schemas"]["UnsignedMetric"];
|
|
986
|
+
/** @description CASHOUT: the price offered for the whole position. Null for ENTRY. */
|
|
987
|
+
readonly price: components["schemas"]["UnsignedMetric"];
|
|
988
|
+
} & (unknown & unknown & unknown & unknown);
|
|
989
|
+
/** @description Every quote the maker published in a period, not only live ones, with the period's fill rate. */
|
|
990
|
+
readonly QuoteHistory: {
|
|
991
|
+
/** @description Freshness of this read. Quotes are venue rows read now; FILLED and FAILED follow the vault projection, so as_of is its checkpoint and status is STALE while it lags. */
|
|
992
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
993
|
+
/**
|
|
994
|
+
* Format: date-time
|
|
995
|
+
* @description Inclusive RFC3339 start of the period on submitted_at, echoed from the query.
|
|
996
|
+
*/
|
|
997
|
+
readonly from: string;
|
|
998
|
+
/**
|
|
999
|
+
* Format: date-time
|
|
1000
|
+
* @description Exclusive RFC3339 end of the period, echoed from the query.
|
|
1001
|
+
*/
|
|
1002
|
+
readonly through: string;
|
|
1003
|
+
/** @description The period's fill rate, on a list's first page (no cursor); null on later pages. */
|
|
1004
|
+
readonly fill_rate: components["schemas"]["QuoteFillRate"] | null;
|
|
1005
|
+
/** @description Quotes on this page, newest submitted_at first. Each status is read when the page is. */
|
|
1006
|
+
readonly items: readonly components["schemas"]["QuoteHistoryItem"][];
|
|
1007
|
+
/** @description Opaque cursor for the next page; null on the last page. Send it back unchanged as cursor with the same filters. */
|
|
1008
|
+
readonly next_cursor: components["schemas"]["NextCursor"];
|
|
1009
|
+
/** @description True exactly when next_cursor is non-null. A status-filtered page reads at most 1,000 quotes, so it may hold fewer items than limit, even none, while has_more is true. */
|
|
1010
|
+
readonly has_more: boolean;
|
|
1011
|
+
};
|
|
1012
|
+
/** @description The maker's exposure on one outcome. A multi-leg ticket counts under every outcome it touches, so outcome amounts do not add up to the book's. */
|
|
1013
|
+
readonly OutcomeExposure: {
|
|
1014
|
+
/** @description HIP-4 outcome ID. */
|
|
1015
|
+
readonly outcome_id: components["schemas"]["UInt32String"];
|
|
1016
|
+
/** @description Open tickets with an unresolved leg on this outcome. */
|
|
1017
|
+
readonly open_ticket_count: string;
|
|
1018
|
+
/** @description Sum of the worst-case maker cost of open tickets whose unresolved leg on this outcome is YES. */
|
|
1019
|
+
readonly yes_exposure: components["schemas"]["Amount"];
|
|
1020
|
+
/** @description The same for tickets whose leg on this outcome is NO. */
|
|
1021
|
+
readonly no_exposure: components["schemas"]["Amount"];
|
|
1022
|
+
/** @description yes_exposure + no_exposure: the outcome's exposure with no offsetting. */
|
|
1023
|
+
readonly gross_exposure: components["schemas"]["Amount"];
|
|
1024
|
+
/** @description yes_exposure - no_exposure: positive when the maker is exposed to YES. */
|
|
1025
|
+
readonly net_exposure: components["schemas"]["SignedAmount"];
|
|
1026
|
+
/** @description max(yes_exposure, no_exposure): the most the outcome's tickets can cost the maker, whatever its result, since a result of v pays at most v x YES + (1 - v) x NO. */
|
|
1027
|
+
readonly worst_case: components["schemas"]["Amount"];
|
|
1028
|
+
/** @description min(yes_exposure, no_exposure) = gross_exposure - worst_case: what offsetting sides save on this outcome. */
|
|
1029
|
+
readonly netting_savings: components["schemas"]["Amount"];
|
|
1030
|
+
/** @description Tickets on this outcome eligible for settlement but not yet settled. */
|
|
1031
|
+
readonly awaiting_ticket_count: string;
|
|
1032
|
+
/** @description Their exact maker cost, max(floor(payout x factors) - net stake, 0) each. */
|
|
1033
|
+
readonly awaiting_settlement: components["schemas"]["Amount"];
|
|
1034
|
+
};
|
|
1035
|
+
/** @description The maker's open book by outcome at the vault projection checkpoint. Amounts are exact atomic USDC. */
|
|
1036
|
+
readonly Exposure: {
|
|
1037
|
+
/** @description Freshness of this read: the projection checkpoint and the live outcome read. STALE while either lags, while a live outcome read failed (its legs count as unresolved), or when the open book does not add up to the maker's gross lane. */
|
|
1038
|
+
readonly context: components["schemas"]["ReadContext"];
|
|
1039
|
+
/** @description Open tickets not yet eligible for settlement. */
|
|
1040
|
+
readonly open_ticket_count: string;
|
|
1041
|
+
/** @description Sum of each such ticket's worst-case maker cost, W = ceil(max(payout x resolved factors - net stake, 0)), each ticket once, with no offsetting. Netting across outcomes and Combos is the vault discount on the capital read. */
|
|
1042
|
+
readonly gross_exposure: components["schemas"]["Amount"];
|
|
1043
|
+
/** @description Open tickets whose every leg has resolved, or whose payout already floors to zero, but which have not settled. */
|
|
1044
|
+
readonly awaiting_ticket_count: string;
|
|
1045
|
+
/** @description What those tickets will cost the maker when they settle, each once. */
|
|
1046
|
+
readonly awaiting_settlement: components["schemas"]["Amount"];
|
|
1047
|
+
/** @description Every outcome with an unresolved leg of an open ticket or a leg of a ticket awaiting settlement, ascending outcome_id. */
|
|
1048
|
+
readonly outcomes: readonly components["schemas"]["OutcomeExposure"][];
|
|
1049
|
+
};
|
|
1050
|
+
readonly Cursor: {
|
|
1051
|
+
/**
|
|
1052
|
+
* Format: uuid
|
|
1053
|
+
* @description Identifier of the delivery stream journal this cursor belongs to.
|
|
1054
|
+
*/
|
|
1055
|
+
readonly stream_id: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* Format: uuid
|
|
1058
|
+
* @description Journal generation; a restore or reset starts a new generation, and sequences from different generations are never compared.
|
|
1059
|
+
*/
|
|
1060
|
+
readonly generation_id: string;
|
|
1061
|
+
/** @description Decimal position within the generation. It strictly increases but can skip numbers in a filtered view. */
|
|
1062
|
+
readonly sequence: string;
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
responses: {
|
|
1066
|
+
/** @description Error; `code` is one of the operation's x-totalis-errors in openapi.json */
|
|
1067
|
+
readonly Error: {
|
|
1068
|
+
headers: {
|
|
1069
|
+
readonly [name: string]: unknown;
|
|
1070
|
+
};
|
|
1071
|
+
content: {
|
|
1072
|
+
readonly "application/json": components["schemas"]["Error"];
|
|
1073
|
+
};
|
|
1074
|
+
};
|
|
1075
|
+
/** @description Quota exhausted; resend after Retry-After */
|
|
1076
|
+
readonly RateLimited: {
|
|
1077
|
+
headers: {
|
|
1078
|
+
readonly "Retry-After": components["headers"]["RetryAfter"];
|
|
1079
|
+
readonly [name: string]: unknown;
|
|
1080
|
+
};
|
|
1081
|
+
content: {
|
|
1082
|
+
readonly "application/json": components["schemas"]["Error"];
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
/** @description Source or authority unavailable; resend after Retry-After */
|
|
1086
|
+
readonly Unavailable: {
|
|
1087
|
+
headers: {
|
|
1088
|
+
readonly "Retry-After": components["headers"]["RetryAfter"];
|
|
1089
|
+
readonly [name: string]: unknown;
|
|
1090
|
+
};
|
|
1091
|
+
content: {
|
|
1092
|
+
readonly "application/json": components["schemas"]["Error"];
|
|
1093
|
+
};
|
|
1094
|
+
};
|
|
1095
|
+
};
|
|
1096
|
+
parameters: {
|
|
1097
|
+
/**
|
|
1098
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1099
|
+
* @example 50
|
|
1100
|
+
*/
|
|
1101
|
+
readonly Limit: components["schemas"]["PageLimit"];
|
|
1102
|
+
/**
|
|
1103
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1104
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1105
|
+
*/
|
|
1106
|
+
readonly Cursor: components["schemas"]["PageCursor"];
|
|
1107
|
+
/**
|
|
1108
|
+
* @description Return only activities of this kind.
|
|
1109
|
+
* @example DEPOSIT
|
|
1110
|
+
*/
|
|
1111
|
+
readonly ActivityKindQueryOptional: components["schemas"]["ActivityKind"];
|
|
1112
|
+
/**
|
|
1113
|
+
* @description Return only activities with this status. A status-filtered page is a display view, never a balance or P&L basis.
|
|
1114
|
+
* @example COMMITTED
|
|
1115
|
+
*/
|
|
1116
|
+
readonly ActivityStatusQueryOptional: "PENDING" | "UNKNOWN" | "COMMITTED" | "FAILED" | "REVERTED" | "CORRECTED";
|
|
1117
|
+
/**
|
|
1118
|
+
* @description Inclusive RFC3339 lower bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1119
|
+
* @example 2026-09-01T00:00:00Z
|
|
1120
|
+
*/
|
|
1121
|
+
readonly FromQueryOptional: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* @description Exclusive RFC3339 upper bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1124
|
+
* @example 2026-09-26T00:00:00Z
|
|
1125
|
+
*/
|
|
1126
|
+
readonly ThroughQueryOptional: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* @description Return only activities that reference this position ID (lowercase bytes32 hex).
|
|
1129
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1130
|
+
*/
|
|
1131
|
+
readonly PositionIdQueryOptional: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* @description Activity ID from a list item's activity_id (64 lowercase hex characters).
|
|
1134
|
+
* @example 9d4c2b1a0f8e7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e
|
|
1135
|
+
*/
|
|
1136
|
+
readonly ActivityIdPathRequired: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1139
|
+
* @example 7
|
|
1140
|
+
*/
|
|
1141
|
+
readonly MakerIdPathRequired: components["schemas"]["NonZeroUInt64String"];
|
|
1142
|
+
/**
|
|
1143
|
+
* @description Inclusive RFC3339 start of the period on submitted_at.
|
|
1144
|
+
* @example 2026-09-17T00:00:00Z
|
|
1145
|
+
*/
|
|
1146
|
+
readonly QuoteHistoryFromQueryRequired: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* @description Exclusive RFC3339 end of the period; must be after from.
|
|
1149
|
+
* @example 2026-09-18T00:00:00Z
|
|
1150
|
+
*/
|
|
1151
|
+
readonly QuoteHistoryThroughQueryRequired: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* @description Return only quotes with this status. The fill rate ignores it.
|
|
1154
|
+
* @example FILLED
|
|
1155
|
+
*/
|
|
1156
|
+
readonly QuoteHistoryStatusQueryOptional: components["schemas"]["QuoteHistoryStatus"];
|
|
1157
|
+
/**
|
|
1158
|
+
* @description Return, and compute the fill rate over, only quotes of this kind.
|
|
1159
|
+
* @example ENTRY
|
|
1160
|
+
*/
|
|
1161
|
+
readonly QuoteKindQueryOptional: "ENTRY" | "CASHOUT";
|
|
1162
|
+
/**
|
|
1163
|
+
* @description Return only positions the maker closed with this result: WON, LOST or EVEN (see maker_result).
|
|
1164
|
+
* @example LOST
|
|
1165
|
+
*/
|
|
1166
|
+
readonly PositionMakerResultQueryOptional: "WON" | "LOST" | "EVEN";
|
|
1167
|
+
/**
|
|
1168
|
+
* @description Return only positions with this lifecycle status.
|
|
1169
|
+
* @example OPEN
|
|
1170
|
+
*/
|
|
1171
|
+
readonly PositionStatusQueryOptional: "OPEN" | "AWAITING_SETTLEMENT" | "SETTLED_UNCLAIMED" | "CLOSED";
|
|
1172
|
+
/**
|
|
1173
|
+
* @description Position ID: the contract's ticketId (lowercase bytes32 hex).
|
|
1174
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1175
|
+
*/
|
|
1176
|
+
readonly PositionIdPathRequired: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* @description Inclusive RFC3339 start of the performance period.
|
|
1179
|
+
* @example 2026-09-01T00:00:00Z
|
|
1180
|
+
*/
|
|
1181
|
+
readonly FromQueryRequired: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* @description Exclusive RFC3339 end of the performance period; must be after from.
|
|
1184
|
+
* @example 2026-09-26T00:00:00Z
|
|
1185
|
+
*/
|
|
1186
|
+
readonly ThroughQueryRequired: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* @description Window of the series: 1D, 1W, 1M (default) or ALL since tracking began.
|
|
1189
|
+
* @example 1D
|
|
1190
|
+
*/
|
|
1191
|
+
readonly PnlRangeQueryOptional: "1D" | "1W" | "1M" | "ALL";
|
|
1192
|
+
/**
|
|
1193
|
+
* @description Return only activities with evidence from this source: HYPEREVM (EVM logs), HYPERCORE (Hyperliquid ledger) or VENUE (Totalis workflows).
|
|
1194
|
+
* @example HYPEREVM
|
|
1195
|
+
*/
|
|
1196
|
+
readonly ActivityVenueQueryOptional: "HYPEREVM" | "HYPERCORE" | "VENUE";
|
|
1197
|
+
};
|
|
1198
|
+
requestBodies: never;
|
|
1199
|
+
headers: {
|
|
1200
|
+
/** @description Seconds to wait before resending the same request */
|
|
1201
|
+
readonly RetryAfter: number;
|
|
1202
|
+
/** @description Always `no-store`; account data must not be cached. */
|
|
1203
|
+
readonly CacheControl: "no-store";
|
|
1204
|
+
/** @description The response varies by the Authorization header, so shared caches must not reuse it across credentials. */
|
|
1205
|
+
readonly Vary: string;
|
|
1206
|
+
};
|
|
1207
|
+
pathItems: never;
|
|
1208
|
+
};
|
|
1209
|
+
export type $defs = Record<string, never>;
|
|
1210
|
+
export interface operations {
|
|
1211
|
+
readonly getMakerQuotes: {
|
|
1212
|
+
readonly parameters: {
|
|
1213
|
+
readonly query?: never;
|
|
1214
|
+
readonly header?: {
|
|
1215
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1216
|
+
readonly Origin?: string;
|
|
1217
|
+
};
|
|
1218
|
+
readonly path: {
|
|
1219
|
+
/**
|
|
1220
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1221
|
+
* @example 7
|
|
1222
|
+
*/
|
|
1223
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1224
|
+
};
|
|
1225
|
+
readonly cookie?: never;
|
|
1226
|
+
};
|
|
1227
|
+
readonly requestBody?: never;
|
|
1228
|
+
readonly responses: {
|
|
1229
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1230
|
+
readonly 200: {
|
|
1231
|
+
headers: {
|
|
1232
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1233
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1234
|
+
readonly [name: string]: unknown;
|
|
1235
|
+
};
|
|
1236
|
+
content: {
|
|
1237
|
+
readonly "application/json": components["schemas"]["DashboardQuotes"];
|
|
1238
|
+
};
|
|
1239
|
+
};
|
|
1240
|
+
readonly 400: components["responses"]["Error"];
|
|
1241
|
+
readonly 401: components["responses"]["Error"];
|
|
1242
|
+
readonly 403: components["responses"]["Error"];
|
|
1243
|
+
readonly 404: components["responses"]["Error"];
|
|
1244
|
+
readonly 409: components["responses"]["Error"];
|
|
1245
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1246
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1247
|
+
};
|
|
1248
|
+
};
|
|
1249
|
+
readonly getOwnMaker: {
|
|
1250
|
+
readonly parameters: {
|
|
1251
|
+
readonly query?: never;
|
|
1252
|
+
readonly header?: {
|
|
1253
|
+
readonly Origin?: string;
|
|
1254
|
+
};
|
|
1255
|
+
readonly path?: never;
|
|
1256
|
+
readonly cookie?: never;
|
|
1257
|
+
};
|
|
1258
|
+
readonly requestBody?: never;
|
|
1259
|
+
readonly responses: {
|
|
1260
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1261
|
+
readonly 200: {
|
|
1262
|
+
headers: {
|
|
1263
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1264
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1265
|
+
readonly [name: string]: unknown;
|
|
1266
|
+
};
|
|
1267
|
+
content: {
|
|
1268
|
+
readonly "application/json": components["schemas"]["OwnMaker"];
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
readonly 400: components["responses"]["Error"];
|
|
1272
|
+
readonly 401: components["responses"]["Error"];
|
|
1273
|
+
readonly 403: components["responses"]["Error"];
|
|
1274
|
+
readonly 404: components["responses"]["Error"];
|
|
1275
|
+
readonly 409: components["responses"]["Error"];
|
|
1276
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1277
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1278
|
+
};
|
|
1279
|
+
};
|
|
1280
|
+
readonly listControlledMakers: {
|
|
1281
|
+
readonly parameters: {
|
|
1282
|
+
readonly query?: {
|
|
1283
|
+
/**
|
|
1284
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1285
|
+
* @example 50
|
|
1286
|
+
*/
|
|
1287
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1288
|
+
/**
|
|
1289
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1290
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1291
|
+
*/
|
|
1292
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1293
|
+
};
|
|
1294
|
+
readonly header?: {
|
|
1295
|
+
readonly Origin?: string;
|
|
1296
|
+
};
|
|
1297
|
+
readonly path?: never;
|
|
1298
|
+
readonly cookie?: never;
|
|
1299
|
+
};
|
|
1300
|
+
readonly requestBody?: never;
|
|
1301
|
+
readonly responses: {
|
|
1302
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1303
|
+
readonly 200: {
|
|
1304
|
+
headers: {
|
|
1305
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1306
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1307
|
+
readonly [name: string]: unknown;
|
|
1308
|
+
};
|
|
1309
|
+
content: {
|
|
1310
|
+
readonly "application/json": components["schemas"]["ControlledMakerList"];
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
readonly 400: components["responses"]["Error"];
|
|
1314
|
+
readonly 401: components["responses"]["Error"];
|
|
1315
|
+
readonly 403: components["responses"]["Error"];
|
|
1316
|
+
readonly 404: components["responses"]["Error"];
|
|
1317
|
+
readonly 409: components["responses"]["Error"];
|
|
1318
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1319
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1320
|
+
};
|
|
1321
|
+
};
|
|
1322
|
+
readonly getAccountPnl: {
|
|
1323
|
+
readonly parameters: {
|
|
1324
|
+
readonly query?: {
|
|
1325
|
+
/**
|
|
1326
|
+
* @description Window of the series: 1D, 1W, 1M (default) or ALL since tracking began.
|
|
1327
|
+
* @example 1D
|
|
1328
|
+
*/
|
|
1329
|
+
readonly range?: components["parameters"]["PnlRangeQueryOptional"];
|
|
1330
|
+
};
|
|
1331
|
+
readonly header?: {
|
|
1332
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1333
|
+
readonly Origin?: string;
|
|
1334
|
+
};
|
|
1335
|
+
readonly path?: never;
|
|
1336
|
+
readonly cookie?: never;
|
|
1337
|
+
};
|
|
1338
|
+
readonly requestBody?: never;
|
|
1339
|
+
readonly responses: {
|
|
1340
|
+
/** @description Scoped read with one freshness status; points are cumulative atomic USDC strings or null. No shared caching. */
|
|
1341
|
+
readonly 200: {
|
|
1342
|
+
headers: {
|
|
1343
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1344
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1345
|
+
readonly [name: string]: unknown;
|
|
1346
|
+
};
|
|
1347
|
+
content: {
|
|
1348
|
+
readonly "application/json": components["schemas"]["PnL"];
|
|
1349
|
+
};
|
|
1350
|
+
};
|
|
1351
|
+
readonly 400: components["responses"]["Error"];
|
|
1352
|
+
readonly 401: components["responses"]["Error"];
|
|
1353
|
+
readonly 403: components["responses"]["Error"];
|
|
1354
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1355
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1356
|
+
};
|
|
1357
|
+
};
|
|
1358
|
+
readonly listAccountActivity: {
|
|
1359
|
+
readonly parameters: {
|
|
1360
|
+
readonly query?: {
|
|
1361
|
+
/**
|
|
1362
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1363
|
+
* @example 50
|
|
1364
|
+
*/
|
|
1365
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1366
|
+
/**
|
|
1367
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1368
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1369
|
+
*/
|
|
1370
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1371
|
+
/**
|
|
1372
|
+
* @description Return only activities of this kind.
|
|
1373
|
+
* @example DEPOSIT
|
|
1374
|
+
*/
|
|
1375
|
+
readonly kind?: components["parameters"]["ActivityKindQueryOptional"];
|
|
1376
|
+
/**
|
|
1377
|
+
* @description Return only activities with this status. A status-filtered page is a display view, never a balance or P&L basis.
|
|
1378
|
+
* @example COMMITTED
|
|
1379
|
+
*/
|
|
1380
|
+
readonly status?: components["parameters"]["ActivityStatusQueryOptional"];
|
|
1381
|
+
/**
|
|
1382
|
+
* @description Inclusive RFC3339 lower bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1383
|
+
* @example 2026-09-01T00:00:00Z
|
|
1384
|
+
*/
|
|
1385
|
+
readonly from?: components["parameters"]["FromQueryOptional"];
|
|
1386
|
+
/**
|
|
1387
|
+
* @description Exclusive RFC3339 upper bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1388
|
+
* @example 2026-09-26T00:00:00Z
|
|
1389
|
+
*/
|
|
1390
|
+
readonly through?: components["parameters"]["ThroughQueryOptional"];
|
|
1391
|
+
/**
|
|
1392
|
+
* @description Return only activities that reference this position ID (lowercase bytes32 hex).
|
|
1393
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1394
|
+
*/
|
|
1395
|
+
readonly position_id?: components["parameters"]["PositionIdQueryOptional"];
|
|
1396
|
+
/**
|
|
1397
|
+
* @description Return only activities with evidence from this source: HYPEREVM (EVM logs), HYPERCORE (Hyperliquid ledger) or VENUE (Totalis workflows).
|
|
1398
|
+
* @example HYPEREVM
|
|
1399
|
+
*/
|
|
1400
|
+
readonly venue?: components["parameters"]["ActivityVenueQueryOptional"];
|
|
1401
|
+
};
|
|
1402
|
+
readonly header?: {
|
|
1403
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1404
|
+
readonly Origin?: string;
|
|
1405
|
+
};
|
|
1406
|
+
readonly path?: never;
|
|
1407
|
+
readonly cookie?: never;
|
|
1408
|
+
};
|
|
1409
|
+
readonly requestBody?: never;
|
|
1410
|
+
readonly responses: {
|
|
1411
|
+
/** @description Scoped read with one freshness status; effect deltas are atomic units of each effect's asset; other amounts are atomic USDC strings or null. No shared caching. */
|
|
1412
|
+
readonly 200: {
|
|
1413
|
+
headers: {
|
|
1414
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1415
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1416
|
+
readonly [name: string]: unknown;
|
|
1417
|
+
};
|
|
1418
|
+
content: {
|
|
1419
|
+
readonly "application/json": components["schemas"]["ActivityList"];
|
|
1420
|
+
};
|
|
1421
|
+
};
|
|
1422
|
+
readonly 400: components["responses"]["Error"];
|
|
1423
|
+
readonly 401: components["responses"]["Error"];
|
|
1424
|
+
readonly 403: components["responses"]["Error"];
|
|
1425
|
+
readonly 404: components["responses"]["Error"];
|
|
1426
|
+
readonly 409: components["responses"]["Error"];
|
|
1427
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1428
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1429
|
+
};
|
|
1430
|
+
};
|
|
1431
|
+
readonly getAccountActivity: {
|
|
1432
|
+
readonly parameters: {
|
|
1433
|
+
readonly query?: never;
|
|
1434
|
+
readonly header?: {
|
|
1435
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1436
|
+
readonly Origin?: string;
|
|
1437
|
+
};
|
|
1438
|
+
readonly path: {
|
|
1439
|
+
/**
|
|
1440
|
+
* @description Activity ID from a list item's activity_id (64 lowercase hex characters).
|
|
1441
|
+
* @example 9d4c2b1a0f8e7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e
|
|
1442
|
+
*/
|
|
1443
|
+
readonly activity_id: components["parameters"]["ActivityIdPathRequired"];
|
|
1444
|
+
};
|
|
1445
|
+
readonly cookie?: never;
|
|
1446
|
+
};
|
|
1447
|
+
readonly requestBody?: never;
|
|
1448
|
+
readonly responses: {
|
|
1449
|
+
/** @description Scoped read with one freshness status; effect deltas are atomic units of each effect's asset; other amounts are atomic USDC strings or null. No shared caching. */
|
|
1450
|
+
readonly 200: {
|
|
1451
|
+
headers: {
|
|
1452
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1453
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1454
|
+
readonly [name: string]: unknown;
|
|
1455
|
+
};
|
|
1456
|
+
content: {
|
|
1457
|
+
readonly "application/json": components["schemas"]["ActivityDetail"];
|
|
1458
|
+
};
|
|
1459
|
+
};
|
|
1460
|
+
readonly 400: components["responses"]["Error"];
|
|
1461
|
+
readonly 401: components["responses"]["Error"];
|
|
1462
|
+
readonly 403: components["responses"]["Error"];
|
|
1463
|
+
readonly 404: components["responses"]["Error"];
|
|
1464
|
+
readonly 409: components["responses"]["Error"];
|
|
1465
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1466
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1467
|
+
};
|
|
1468
|
+
};
|
|
1469
|
+
readonly getMakerCapital: {
|
|
1470
|
+
readonly parameters: {
|
|
1471
|
+
readonly query?: never;
|
|
1472
|
+
readonly header?: {
|
|
1473
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1474
|
+
readonly Origin?: string;
|
|
1475
|
+
};
|
|
1476
|
+
readonly path: {
|
|
1477
|
+
/**
|
|
1478
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1479
|
+
* @example 7
|
|
1480
|
+
*/
|
|
1481
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1482
|
+
};
|
|
1483
|
+
readonly cookie?: never;
|
|
1484
|
+
};
|
|
1485
|
+
readonly requestBody?: never;
|
|
1486
|
+
readonly responses: {
|
|
1487
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1488
|
+
readonly 200: {
|
|
1489
|
+
headers: {
|
|
1490
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1491
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1492
|
+
readonly [name: string]: unknown;
|
|
1493
|
+
};
|
|
1494
|
+
content: {
|
|
1495
|
+
readonly "application/json": components["schemas"]["MakerCapital"];
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
readonly 400: components["responses"]["Error"];
|
|
1499
|
+
readonly 401: components["responses"]["Error"];
|
|
1500
|
+
readonly 403: components["responses"]["Error"];
|
|
1501
|
+
readonly 404: components["responses"]["Error"];
|
|
1502
|
+
readonly 409: components["responses"]["Error"];
|
|
1503
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1504
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1505
|
+
};
|
|
1506
|
+
};
|
|
1507
|
+
readonly listMakerActivity: {
|
|
1508
|
+
readonly parameters: {
|
|
1509
|
+
readonly query?: {
|
|
1510
|
+
/**
|
|
1511
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1512
|
+
* @example 50
|
|
1513
|
+
*/
|
|
1514
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1515
|
+
/**
|
|
1516
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1517
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1518
|
+
*/
|
|
1519
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1520
|
+
/**
|
|
1521
|
+
* @description Return only activities of this kind.
|
|
1522
|
+
* @example DEPOSIT
|
|
1523
|
+
*/
|
|
1524
|
+
readonly kind?: components["parameters"]["ActivityKindQueryOptional"];
|
|
1525
|
+
/**
|
|
1526
|
+
* @description Return only activities with this status. A status-filtered page is a display view, never a balance or P&L basis.
|
|
1527
|
+
* @example COMMITTED
|
|
1528
|
+
*/
|
|
1529
|
+
readonly status?: components["parameters"]["ActivityStatusQueryOptional"];
|
|
1530
|
+
/**
|
|
1531
|
+
* @description Inclusive RFC3339 lower bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1532
|
+
* @example 2026-09-01T00:00:00Z
|
|
1533
|
+
*/
|
|
1534
|
+
readonly from?: components["parameters"]["FromQueryOptional"];
|
|
1535
|
+
/**
|
|
1536
|
+
* @description Exclusive RFC3339 upper bound on occurred_at (recorded_at for workflow entries without one). Chain activity whose occurrence time is unknown is always included.
|
|
1537
|
+
* @example 2026-09-26T00:00:00Z
|
|
1538
|
+
*/
|
|
1539
|
+
readonly through?: components["parameters"]["ThroughQueryOptional"];
|
|
1540
|
+
/**
|
|
1541
|
+
* @description Return only activities that reference this position ID (lowercase bytes32 hex).
|
|
1542
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1543
|
+
*/
|
|
1544
|
+
readonly position_id?: components["parameters"]["PositionIdQueryOptional"];
|
|
1545
|
+
/**
|
|
1546
|
+
* @description Return only activities with evidence from this source: HYPEREVM (EVM logs), HYPERCORE (Hyperliquid ledger) or VENUE (Totalis workflows).
|
|
1547
|
+
* @example HYPEREVM
|
|
1548
|
+
*/
|
|
1549
|
+
readonly venue?: components["parameters"]["ActivityVenueQueryOptional"];
|
|
1550
|
+
};
|
|
1551
|
+
readonly header?: {
|
|
1552
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1553
|
+
readonly Origin?: string;
|
|
1554
|
+
};
|
|
1555
|
+
readonly path: {
|
|
1556
|
+
/**
|
|
1557
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1558
|
+
* @example 7
|
|
1559
|
+
*/
|
|
1560
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1561
|
+
};
|
|
1562
|
+
readonly cookie?: never;
|
|
1563
|
+
};
|
|
1564
|
+
readonly requestBody?: never;
|
|
1565
|
+
readonly responses: {
|
|
1566
|
+
/** @description Scoped read with one freshness status; effect deltas are atomic units of each effect's asset; other amounts are atomic USDC strings or null. No shared caching. */
|
|
1567
|
+
readonly 200: {
|
|
1568
|
+
headers: {
|
|
1569
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1570
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1571
|
+
readonly [name: string]: unknown;
|
|
1572
|
+
};
|
|
1573
|
+
content: {
|
|
1574
|
+
readonly "application/json": components["schemas"]["ActivityList"];
|
|
1575
|
+
};
|
|
1576
|
+
};
|
|
1577
|
+
readonly 400: components["responses"]["Error"];
|
|
1578
|
+
readonly 401: components["responses"]["Error"];
|
|
1579
|
+
readonly 403: components["responses"]["Error"];
|
|
1580
|
+
readonly 404: components["responses"]["Error"];
|
|
1581
|
+
readonly 409: components["responses"]["Error"];
|
|
1582
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1583
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1584
|
+
};
|
|
1585
|
+
};
|
|
1586
|
+
readonly getMakerActivity: {
|
|
1587
|
+
readonly parameters: {
|
|
1588
|
+
readonly query?: never;
|
|
1589
|
+
readonly header?: {
|
|
1590
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1591
|
+
readonly Origin?: string;
|
|
1592
|
+
};
|
|
1593
|
+
readonly path: {
|
|
1594
|
+
/**
|
|
1595
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1596
|
+
* @example 7
|
|
1597
|
+
*/
|
|
1598
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1599
|
+
/**
|
|
1600
|
+
* @description Activity ID from a list item's activity_id (64 lowercase hex characters).
|
|
1601
|
+
* @example 9d4c2b1a0f8e7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e
|
|
1602
|
+
*/
|
|
1603
|
+
readonly activity_id: components["parameters"]["ActivityIdPathRequired"];
|
|
1604
|
+
};
|
|
1605
|
+
readonly cookie?: never;
|
|
1606
|
+
};
|
|
1607
|
+
readonly requestBody?: never;
|
|
1608
|
+
readonly responses: {
|
|
1609
|
+
/** @description Scoped read with one freshness status; effect deltas are atomic units of each effect's asset; other amounts are atomic USDC strings or null. No shared caching. */
|
|
1610
|
+
readonly 200: {
|
|
1611
|
+
headers: {
|
|
1612
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1613
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1614
|
+
readonly [name: string]: unknown;
|
|
1615
|
+
};
|
|
1616
|
+
content: {
|
|
1617
|
+
readonly "application/json": components["schemas"]["ActivityDetail"];
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
readonly 400: components["responses"]["Error"];
|
|
1621
|
+
readonly 401: components["responses"]["Error"];
|
|
1622
|
+
readonly 403: components["responses"]["Error"];
|
|
1623
|
+
readonly 404: components["responses"]["Error"];
|
|
1624
|
+
readonly 409: components["responses"]["Error"];
|
|
1625
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1626
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1627
|
+
};
|
|
1628
|
+
};
|
|
1629
|
+
readonly listMakerPositions: {
|
|
1630
|
+
readonly parameters: {
|
|
1631
|
+
readonly query?: {
|
|
1632
|
+
/**
|
|
1633
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1634
|
+
* @example 50
|
|
1635
|
+
*/
|
|
1636
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1637
|
+
/**
|
|
1638
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1639
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1640
|
+
*/
|
|
1641
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1642
|
+
/**
|
|
1643
|
+
* @description Return only positions with this lifecycle status.
|
|
1644
|
+
* @example OPEN
|
|
1645
|
+
*/
|
|
1646
|
+
readonly status?: components["parameters"]["PositionStatusQueryOptional"];
|
|
1647
|
+
/**
|
|
1648
|
+
* @description Return only positions the maker closed with this result: WON, LOST or EVEN (see maker_result).
|
|
1649
|
+
* @example LOST
|
|
1650
|
+
*/
|
|
1651
|
+
readonly maker_result?: components["parameters"]["PositionMakerResultQueryOptional"];
|
|
1652
|
+
};
|
|
1653
|
+
readonly header?: {
|
|
1654
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1655
|
+
readonly Origin?: string;
|
|
1656
|
+
};
|
|
1657
|
+
readonly path: {
|
|
1658
|
+
/**
|
|
1659
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1660
|
+
* @example 7
|
|
1661
|
+
*/
|
|
1662
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1663
|
+
};
|
|
1664
|
+
readonly cookie?: never;
|
|
1665
|
+
};
|
|
1666
|
+
readonly requestBody?: never;
|
|
1667
|
+
readonly responses: {
|
|
1668
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1669
|
+
readonly 200: {
|
|
1670
|
+
headers: {
|
|
1671
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1672
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1673
|
+
readonly [name: string]: unknown;
|
|
1674
|
+
};
|
|
1675
|
+
content: {
|
|
1676
|
+
readonly "application/json": components["schemas"]["PositionList"];
|
|
1677
|
+
};
|
|
1678
|
+
};
|
|
1679
|
+
readonly 400: components["responses"]["Error"];
|
|
1680
|
+
readonly 401: components["responses"]["Error"];
|
|
1681
|
+
readonly 403: components["responses"]["Error"];
|
|
1682
|
+
readonly 404: components["responses"]["Error"];
|
|
1683
|
+
readonly 409: components["responses"]["Error"];
|
|
1684
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1685
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1686
|
+
};
|
|
1687
|
+
};
|
|
1688
|
+
readonly listAccountPositions: {
|
|
1689
|
+
readonly parameters: {
|
|
1690
|
+
readonly query?: {
|
|
1691
|
+
/**
|
|
1692
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1693
|
+
* @example 50
|
|
1694
|
+
*/
|
|
1695
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1696
|
+
/**
|
|
1697
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1698
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1699
|
+
*/
|
|
1700
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1701
|
+
/**
|
|
1702
|
+
* @description Return only positions with this lifecycle status.
|
|
1703
|
+
* @example OPEN
|
|
1704
|
+
*/
|
|
1705
|
+
readonly status?: components["parameters"]["PositionStatusQueryOptional"];
|
|
1706
|
+
/**
|
|
1707
|
+
* @description Return only positions the maker closed with this result: WON, LOST or EVEN (see maker_result).
|
|
1708
|
+
* @example LOST
|
|
1709
|
+
*/
|
|
1710
|
+
readonly maker_result?: components["parameters"]["PositionMakerResultQueryOptional"];
|
|
1711
|
+
};
|
|
1712
|
+
readonly header?: {
|
|
1713
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1714
|
+
readonly Origin?: string;
|
|
1715
|
+
};
|
|
1716
|
+
readonly path?: never;
|
|
1717
|
+
readonly cookie?: never;
|
|
1718
|
+
};
|
|
1719
|
+
readonly requestBody?: never;
|
|
1720
|
+
readonly responses: {
|
|
1721
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1722
|
+
readonly 200: {
|
|
1723
|
+
headers: {
|
|
1724
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1725
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1726
|
+
readonly [name: string]: unknown;
|
|
1727
|
+
};
|
|
1728
|
+
content: {
|
|
1729
|
+
readonly "application/json": components["schemas"]["PositionList"];
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
readonly 400: components["responses"]["Error"];
|
|
1733
|
+
readonly 401: components["responses"]["Error"];
|
|
1734
|
+
readonly 403: components["responses"]["Error"];
|
|
1735
|
+
readonly 404: components["responses"]["Error"];
|
|
1736
|
+
readonly 409: components["responses"]["Error"];
|
|
1737
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1738
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1739
|
+
};
|
|
1740
|
+
};
|
|
1741
|
+
readonly getAccountPosition: {
|
|
1742
|
+
readonly parameters: {
|
|
1743
|
+
readonly query?: never;
|
|
1744
|
+
readonly header?: {
|
|
1745
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1746
|
+
readonly Origin?: string;
|
|
1747
|
+
};
|
|
1748
|
+
readonly path: {
|
|
1749
|
+
/**
|
|
1750
|
+
* @description Position ID: the contract's ticketId (lowercase bytes32 hex).
|
|
1751
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1752
|
+
*/
|
|
1753
|
+
readonly position_id: components["parameters"]["PositionIdPathRequired"];
|
|
1754
|
+
};
|
|
1755
|
+
readonly cookie?: never;
|
|
1756
|
+
};
|
|
1757
|
+
readonly requestBody?: never;
|
|
1758
|
+
readonly responses: {
|
|
1759
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1760
|
+
readonly 200: {
|
|
1761
|
+
headers: {
|
|
1762
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1763
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1764
|
+
readonly [name: string]: unknown;
|
|
1765
|
+
};
|
|
1766
|
+
content: {
|
|
1767
|
+
readonly "application/json": components["schemas"]["PositionDetail"];
|
|
1768
|
+
};
|
|
1769
|
+
};
|
|
1770
|
+
readonly 400: components["responses"]["Error"];
|
|
1771
|
+
readonly 401: components["responses"]["Error"];
|
|
1772
|
+
readonly 403: components["responses"]["Error"];
|
|
1773
|
+
readonly 404: components["responses"]["Error"];
|
|
1774
|
+
readonly 409: components["responses"]["Error"];
|
|
1775
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1776
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1777
|
+
};
|
|
1778
|
+
};
|
|
1779
|
+
readonly getMakerPosition: {
|
|
1780
|
+
readonly parameters: {
|
|
1781
|
+
readonly query?: never;
|
|
1782
|
+
readonly header?: {
|
|
1783
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1784
|
+
readonly Origin?: string;
|
|
1785
|
+
};
|
|
1786
|
+
readonly path: {
|
|
1787
|
+
/**
|
|
1788
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1789
|
+
* @example 7
|
|
1790
|
+
*/
|
|
1791
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1792
|
+
/**
|
|
1793
|
+
* @description Position ID: the contract's ticketId (lowercase bytes32 hex).
|
|
1794
|
+
* @example 0x5e0f6a2b8c4d1e3f7a9b0c2d4e6f8a1b3c5d7e9f0a2b4c6d8e0f1a3b5c7d9e1f
|
|
1795
|
+
*/
|
|
1796
|
+
readonly position_id: components["parameters"]["PositionIdPathRequired"];
|
|
1797
|
+
};
|
|
1798
|
+
readonly cookie?: never;
|
|
1799
|
+
};
|
|
1800
|
+
readonly requestBody?: never;
|
|
1801
|
+
readonly responses: {
|
|
1802
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1803
|
+
readonly 200: {
|
|
1804
|
+
headers: {
|
|
1805
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1806
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1807
|
+
readonly [name: string]: unknown;
|
|
1808
|
+
};
|
|
1809
|
+
content: {
|
|
1810
|
+
readonly "application/json": components["schemas"]["PositionDetail"];
|
|
1811
|
+
};
|
|
1812
|
+
};
|
|
1813
|
+
readonly 400: components["responses"]["Error"];
|
|
1814
|
+
readonly 401: components["responses"]["Error"];
|
|
1815
|
+
readonly 403: components["responses"]["Error"];
|
|
1816
|
+
readonly 404: components["responses"]["Error"];
|
|
1817
|
+
readonly 409: components["responses"]["Error"];
|
|
1818
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1819
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1820
|
+
};
|
|
1821
|
+
};
|
|
1822
|
+
readonly getMakerPerformance: {
|
|
1823
|
+
readonly parameters: {
|
|
1824
|
+
readonly query: {
|
|
1825
|
+
/**
|
|
1826
|
+
* @description Inclusive RFC3339 start of the performance period.
|
|
1827
|
+
* @example 2026-09-01T00:00:00Z
|
|
1828
|
+
*/
|
|
1829
|
+
readonly from: components["parameters"]["FromQueryRequired"];
|
|
1830
|
+
/**
|
|
1831
|
+
* @description Exclusive RFC3339 end of the performance period; must be after from.
|
|
1832
|
+
* @example 2026-09-26T00:00:00Z
|
|
1833
|
+
*/
|
|
1834
|
+
readonly through: components["parameters"]["ThroughQueryRequired"];
|
|
1835
|
+
};
|
|
1836
|
+
readonly header?: {
|
|
1837
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1838
|
+
readonly Origin?: string;
|
|
1839
|
+
};
|
|
1840
|
+
readonly path: {
|
|
1841
|
+
/**
|
|
1842
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1843
|
+
* @example 7
|
|
1844
|
+
*/
|
|
1845
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1846
|
+
};
|
|
1847
|
+
readonly cookie?: never;
|
|
1848
|
+
};
|
|
1849
|
+
readonly requestBody?: never;
|
|
1850
|
+
readonly responses: {
|
|
1851
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1852
|
+
readonly 200: {
|
|
1853
|
+
headers: {
|
|
1854
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1855
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1856
|
+
readonly [name: string]: unknown;
|
|
1857
|
+
};
|
|
1858
|
+
content: {
|
|
1859
|
+
readonly "application/json": components["schemas"]["Performance"];
|
|
1860
|
+
};
|
|
1861
|
+
};
|
|
1862
|
+
readonly 400: components["responses"]["Error"];
|
|
1863
|
+
readonly 401: components["responses"]["Error"];
|
|
1864
|
+
readonly 403: components["responses"]["Error"];
|
|
1865
|
+
readonly 404: components["responses"]["Error"];
|
|
1866
|
+
readonly 409: components["responses"]["Error"];
|
|
1867
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1868
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1869
|
+
};
|
|
1870
|
+
};
|
|
1871
|
+
readonly listMakerQuoteHistory: {
|
|
1872
|
+
readonly parameters: {
|
|
1873
|
+
readonly query: {
|
|
1874
|
+
/**
|
|
1875
|
+
* @description Inclusive RFC3339 start of the period on submitted_at.
|
|
1876
|
+
* @example 2026-09-17T00:00:00Z
|
|
1877
|
+
*/
|
|
1878
|
+
readonly from: components["parameters"]["QuoteHistoryFromQueryRequired"];
|
|
1879
|
+
/**
|
|
1880
|
+
* @description Exclusive RFC3339 end of the period; must be after from.
|
|
1881
|
+
* @example 2026-09-18T00:00:00Z
|
|
1882
|
+
*/
|
|
1883
|
+
readonly through: components["parameters"]["QuoteHistoryThroughQueryRequired"];
|
|
1884
|
+
/**
|
|
1885
|
+
* @description Return only quotes with this status. The fill rate ignores it.
|
|
1886
|
+
* @example FILLED
|
|
1887
|
+
*/
|
|
1888
|
+
readonly status?: components["parameters"]["QuoteHistoryStatusQueryOptional"];
|
|
1889
|
+
/**
|
|
1890
|
+
* @description Return, and compute the fill rate over, only quotes of this kind.
|
|
1891
|
+
* @example ENTRY
|
|
1892
|
+
*/
|
|
1893
|
+
readonly kind?: components["parameters"]["QuoteKindQueryOptional"];
|
|
1894
|
+
/**
|
|
1895
|
+
* @description Maximum items per page, 1 to 200; defaults to 50. A page may hold fewer, even none, while has_more is true.
|
|
1896
|
+
* @example 50
|
|
1897
|
+
*/
|
|
1898
|
+
readonly limit?: components["parameters"]["Limit"];
|
|
1899
|
+
/**
|
|
1900
|
+
* @description Omit for the first page; then send the previous response's next_cursor unchanged.
|
|
1901
|
+
* @example eyJzIjoiMDE5OTg0YzItN2UwMC03MDAwLThhMDAtMDAwMDAwMDAwMDAxIiwicSI6MTg0MiwiaSI6IjlkNGMyYjFhIn0
|
|
1902
|
+
*/
|
|
1903
|
+
readonly cursor?: components["parameters"]["Cursor"];
|
|
1904
|
+
};
|
|
1905
|
+
readonly header?: {
|
|
1906
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1907
|
+
readonly Origin?: string;
|
|
1908
|
+
};
|
|
1909
|
+
readonly path: {
|
|
1910
|
+
/**
|
|
1911
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1912
|
+
* @example 7
|
|
1913
|
+
*/
|
|
1914
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1915
|
+
};
|
|
1916
|
+
readonly cookie?: never;
|
|
1917
|
+
};
|
|
1918
|
+
readonly requestBody?: never;
|
|
1919
|
+
readonly responses: {
|
|
1920
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings. No shared caching. */
|
|
1921
|
+
readonly 200: {
|
|
1922
|
+
headers: {
|
|
1923
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1924
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1925
|
+
readonly [name: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
content: {
|
|
1928
|
+
readonly "application/json": components["schemas"]["QuoteHistory"];
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
readonly 400: components["responses"]["Error"];
|
|
1932
|
+
readonly 401: components["responses"]["Error"];
|
|
1933
|
+
readonly 403: components["responses"]["Error"];
|
|
1934
|
+
readonly 404: components["responses"]["Error"];
|
|
1935
|
+
readonly 409: components["responses"]["Error"];
|
|
1936
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1937
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1938
|
+
};
|
|
1939
|
+
};
|
|
1940
|
+
readonly getMakerExposure: {
|
|
1941
|
+
readonly parameters: {
|
|
1942
|
+
readonly query?: never;
|
|
1943
|
+
readonly header?: {
|
|
1944
|
+
/** @description Required for browser sessions; API keys do not require an Origin. */
|
|
1945
|
+
readonly Origin?: string;
|
|
1946
|
+
};
|
|
1947
|
+
readonly path: {
|
|
1948
|
+
/**
|
|
1949
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1950
|
+
* @example 7
|
|
1951
|
+
*/
|
|
1952
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1953
|
+
};
|
|
1954
|
+
readonly cookie?: never;
|
|
1955
|
+
};
|
|
1956
|
+
readonly requestBody?: never;
|
|
1957
|
+
readonly responses: {
|
|
1958
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings. No shared caching. */
|
|
1959
|
+
readonly 200: {
|
|
1960
|
+
headers: {
|
|
1961
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1962
|
+
readonly Vary: components["headers"]["Vary"];
|
|
1963
|
+
readonly [name: string]: unknown;
|
|
1964
|
+
};
|
|
1965
|
+
content: {
|
|
1966
|
+
readonly "application/json": components["schemas"]["Exposure"];
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
readonly 400: components["responses"]["Error"];
|
|
1970
|
+
readonly 401: components["responses"]["Error"];
|
|
1971
|
+
readonly 403: components["responses"]["Error"];
|
|
1972
|
+
readonly 404: components["responses"]["Error"];
|
|
1973
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
1974
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
1975
|
+
};
|
|
1976
|
+
};
|
|
1977
|
+
readonly getMakerTelemetry: {
|
|
1978
|
+
readonly parameters: {
|
|
1979
|
+
readonly query?: never;
|
|
1980
|
+
readonly header?: {
|
|
1981
|
+
/** @description Required for browser sessions; scoped maker API keys do not require Origin. */
|
|
1982
|
+
readonly Origin?: string;
|
|
1983
|
+
};
|
|
1984
|
+
readonly path: {
|
|
1985
|
+
/**
|
|
1986
|
+
* @description On-chain maker ID, as a decimal string. An API key may only name the maker it is bound to; other makers return 404.
|
|
1987
|
+
* @example 7
|
|
1988
|
+
*/
|
|
1989
|
+
readonly maker_id: components["parameters"]["MakerIdPathRequired"];
|
|
1990
|
+
};
|
|
1991
|
+
readonly cookie?: never;
|
|
1992
|
+
};
|
|
1993
|
+
readonly requestBody?: never;
|
|
1994
|
+
readonly responses: {
|
|
1995
|
+
/** @description Scoped read with one freshness status; amounts are atomic USDC strings or null. No shared caching. */
|
|
1996
|
+
readonly 200: {
|
|
1997
|
+
headers: {
|
|
1998
|
+
readonly "Cache-Control": components["headers"]["CacheControl"];
|
|
1999
|
+
readonly Vary: components["headers"]["Vary"];
|
|
2000
|
+
readonly [name: string]: unknown;
|
|
2001
|
+
};
|
|
2002
|
+
content: {
|
|
2003
|
+
readonly "application/json": components["schemas"]["Telemetry"];
|
|
2004
|
+
};
|
|
2005
|
+
};
|
|
2006
|
+
readonly 400: components["responses"]["Error"];
|
|
2007
|
+
readonly 401: components["responses"]["Error"];
|
|
2008
|
+
readonly 403: components["responses"]["Error"];
|
|
2009
|
+
readonly 404: components["responses"]["Error"];
|
|
2010
|
+
readonly 409: components["responses"]["Error"];
|
|
2011
|
+
readonly 429: components["responses"]["RateLimited"];
|
|
2012
|
+
readonly 503: components["responses"]["Unavailable"];
|
|
2013
|
+
};
|
|
2014
|
+
};
|
|
2015
|
+
}
|