@lynx-crypto/kraken-api 0.1.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +274 -231
- package/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1776 -489
- package/dist/index.d.ts +1776 -489
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/package.json +35 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,42 @@
|
|
|
1
|
+
type KrakenRateLimitTier = 'starter' | 'intermediate' | 'pro';
|
|
2
|
+
interface KrakenRateLimitOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Enable Kraken-style throttling.
|
|
5
|
+
* - "auto" = default in-memory limiter
|
|
6
|
+
* - "off" = no throttling (caller handles it)
|
|
7
|
+
*/
|
|
8
|
+
mode?: 'auto' | 'off';
|
|
9
|
+
/**
|
|
10
|
+
* Verification tier approximation for REST counter sizing/decay.
|
|
11
|
+
* If unknown, default to "starter" (safest).
|
|
12
|
+
*/
|
|
13
|
+
tier?: KrakenRateLimitTier;
|
|
14
|
+
/**
|
|
15
|
+
* If true (default), apply automatic retries for rate limiting responses.
|
|
16
|
+
*/
|
|
17
|
+
retryOnRateLimit?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Max number of retries for rate limit responses.
|
|
20
|
+
* Default: 5
|
|
21
|
+
*/
|
|
22
|
+
maxRetries?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Optional custom cost function for REST endpoints.
|
|
25
|
+
* Return 2 for ledger/trade history calls, etc.
|
|
26
|
+
*/
|
|
27
|
+
restCostFn?: (path: string) => number;
|
|
28
|
+
/**
|
|
29
|
+
* Optional custom cost function for *trading* endpoints.
|
|
30
|
+
* These are on a separate limiter.
|
|
31
|
+
*/
|
|
32
|
+
tradingCostFn?: (path: string) => number;
|
|
33
|
+
}
|
|
34
|
+
interface Limiter {
|
|
35
|
+
schedule<T>(fn: () => Promise<T>, meta?: {
|
|
36
|
+
cost?: number;
|
|
37
|
+
}): Promise<T>;
|
|
38
|
+
}
|
|
39
|
+
|
|
1
40
|
interface KrakenApiResponse<T> {
|
|
2
41
|
error: string[];
|
|
3
42
|
result: T;
|
|
@@ -9,6 +48,19 @@ interface KrakenClientOptions {
|
|
|
9
48
|
apiKey?: string;
|
|
10
49
|
apiSecret?: string;
|
|
11
50
|
logger?: KrakenLogger;
|
|
51
|
+
/**
|
|
52
|
+
* Rate limiting configuration.
|
|
53
|
+
* Default: { mode: "auto", tier: "starter", retryOnRateLimit: true }
|
|
54
|
+
*/
|
|
55
|
+
rateLimit?: KrakenRateLimitOptions;
|
|
56
|
+
/**
|
|
57
|
+
* Optional custom limiter(s) if you want to centralize throttling.
|
|
58
|
+
* If provided, takes precedence over rateLimit.mode="auto".
|
|
59
|
+
*/
|
|
60
|
+
limiter?: {
|
|
61
|
+
rest?: Limiter;
|
|
62
|
+
trading?: Limiter;
|
|
63
|
+
};
|
|
12
64
|
}
|
|
13
65
|
interface KrakenLogger {
|
|
14
66
|
debug?(msg: string, meta?: unknown): void;
|
|
@@ -16,6 +68,8 @@ interface KrakenLogger {
|
|
|
16
68
|
warn?(msg: string, meta?: unknown): void;
|
|
17
69
|
error?(msg: string, meta?: unknown): void;
|
|
18
70
|
}
|
|
71
|
+
type KrakenWsTriggerReference = 'index' | 'last';
|
|
72
|
+
type KrakenWsPriceType = 'static' | 'pct' | 'quote';
|
|
19
73
|
|
|
20
74
|
/**
|
|
21
75
|
* Low-level REST base for Kraken clients.
|
|
@@ -30,6 +84,11 @@ declare abstract class KrakenRestBase {
|
|
|
30
84
|
protected readonly logger?: KrakenLogger;
|
|
31
85
|
private lastNonce?;
|
|
32
86
|
private lastMs;
|
|
87
|
+
private readonly restLimiter?;
|
|
88
|
+
private readonly tradingLimiter?;
|
|
89
|
+
private readonly rateLimitOptions;
|
|
90
|
+
private readonly restCostFn;
|
|
91
|
+
private readonly tradingCostFn;
|
|
33
92
|
constructor(options?: KrakenClientOptions);
|
|
34
93
|
/**
|
|
35
94
|
* Generate a strictly increasing nonce for private API calls.
|
|
@@ -75,16 +134,17 @@ declare abstract class KrakenRestBase {
|
|
|
75
134
|
* API-Sign = base64( HMAC_SHA512( path + SHA256(nonce + postData), base64_decode(apiSecret) ) )
|
|
76
135
|
*/
|
|
77
136
|
protected signPrivateRequest(path: string, nonce: string, postData: string): string;
|
|
137
|
+
private scheduleWithRetry;
|
|
78
138
|
}
|
|
79
139
|
|
|
80
|
-
interface KrakenServerTime {
|
|
140
|
+
interface KrakenServerTime$1 {
|
|
81
141
|
unixtime: number;
|
|
82
142
|
rfc1123: string;
|
|
83
143
|
}
|
|
84
144
|
|
|
85
|
-
type KrakenSystemStatus = 'online' | 'maintenance' | 'cancel_only' | 'post_only';
|
|
86
|
-
interface KrakenSystemStatusResult {
|
|
87
|
-
status: KrakenSystemStatus;
|
|
145
|
+
type KrakenSystemStatus$1 = 'online' | 'maintenance' | 'cancel_only' | 'post_only';
|
|
146
|
+
interface KrakenSystemStatusResult$1 {
|
|
147
|
+
status: KrakenSystemStatus$1;
|
|
88
148
|
/**
|
|
89
149
|
* Current timestamp in RFC3339 format
|
|
90
150
|
* e.g. "2025-12-10T04:18:32Z"
|
|
@@ -92,9 +152,9 @@ interface KrakenSystemStatusResult {
|
|
|
92
152
|
timestamp: string;
|
|
93
153
|
}
|
|
94
154
|
|
|
95
|
-
type KrakenAssetClass = 'currency' | 'tokenized_asset';
|
|
96
|
-
type KrakenAssetStatus = 'enabled' | 'deposit_only' | 'withdrawal_only' | 'funding_temporarily_disabled';
|
|
97
|
-
interface KrakenAssetInfo {
|
|
155
|
+
type KrakenAssetClass$1 = 'currency' | 'tokenized_asset';
|
|
156
|
+
type KrakenAssetStatus$1 = 'enabled' | 'deposit_only' | 'withdrawal_only' | 'funding_temporarily_disabled';
|
|
157
|
+
interface KrakenAssetInfo$1 {
|
|
98
158
|
/**
|
|
99
159
|
* Asset class (e.g. "currency" | "tokenized_asset")
|
|
100
160
|
*/
|
|
@@ -122,14 +182,14 @@ interface KrakenAssetInfo {
|
|
|
122
182
|
* - "withdrawal_only"
|
|
123
183
|
* - "funding_temporarily_disabled"
|
|
124
184
|
*/
|
|
125
|
-
status?: KrakenAssetStatus;
|
|
185
|
+
status?: KrakenAssetStatus$1;
|
|
126
186
|
}
|
|
127
187
|
/**
|
|
128
188
|
* Map of asset name -> info.
|
|
129
189
|
* e.g. { "XXBT": { ... }, "XETH": { ... } }
|
|
130
190
|
*/
|
|
131
|
-
type KrakenAssetInfoMap = Record<string, KrakenAssetInfo>;
|
|
132
|
-
interface KrakenGetAssetInfoParams {
|
|
191
|
+
type KrakenAssetInfoMap$1 = Record<string, KrakenAssetInfo$1>;
|
|
192
|
+
interface KrakenGetAssetInfoParams$1 {
|
|
133
193
|
/**
|
|
134
194
|
* Comma-delimited list of assets to get info on (optional).
|
|
135
195
|
* We accept string[] here and join internally.
|
|
@@ -139,12 +199,12 @@ interface KrakenGetAssetInfoParams {
|
|
|
139
199
|
* Filters the asset class to retrieve (optional).
|
|
140
200
|
* Default: "currency"
|
|
141
201
|
*/
|
|
142
|
-
aclass?: KrakenAssetClass;
|
|
202
|
+
aclass?: KrakenAssetClass$1;
|
|
143
203
|
}
|
|
144
204
|
|
|
145
|
-
type KrakenAssetPairStatus = 'online' | 'cancel_only' | 'post_only' | 'limit_only' | 'reduce_only';
|
|
146
|
-
type KrakenFeeScheduleEntry = [volume: number, percentFee: number];
|
|
147
|
-
interface KrakenAssetPair {
|
|
205
|
+
type KrakenAssetPairStatus$1 = 'online' | 'cancel_only' | 'post_only' | 'limit_only' | 'reduce_only';
|
|
206
|
+
type KrakenFeeScheduleEntry$1 = [volume: number, percentFee: number];
|
|
207
|
+
interface KrakenAssetPair$1 {
|
|
148
208
|
/** Alternate pair name (e.g. "XBTUSD") */
|
|
149
209
|
altname: string;
|
|
150
210
|
/** WebSocket pair name (if available) */
|
|
@@ -172,9 +232,9 @@ interface KrakenAssetPair {
|
|
|
172
232
|
/** Array of leverage amounts available when selling */
|
|
173
233
|
leverage_sell: number[];
|
|
174
234
|
/** Fee schedule array in [<volume>, <percent fee>] tuples */
|
|
175
|
-
fees: KrakenFeeScheduleEntry[];
|
|
235
|
+
fees: KrakenFeeScheduleEntry$1[];
|
|
176
236
|
/** Maker fee schedule array (if on maker/taker) */
|
|
177
|
-
fees_maker?: KrakenFeeScheduleEntry[];
|
|
237
|
+
fees_maker?: KrakenFeeScheduleEntry$1[];
|
|
178
238
|
/** Volume discount currency */
|
|
179
239
|
fee_volume_currency: string;
|
|
180
240
|
/** Margin call level */
|
|
@@ -188,16 +248,16 @@ interface KrakenAssetPair {
|
|
|
188
248
|
/** Minimum increment between valid price levels */
|
|
189
249
|
tick_size?: string;
|
|
190
250
|
/** Status of asset pair */
|
|
191
|
-
status?: KrakenAssetPairStatus;
|
|
251
|
+
status?: KrakenAssetPairStatus$1;
|
|
192
252
|
/** Maximum long margin position size (base currency) */
|
|
193
253
|
long_position_limit?: number;
|
|
194
254
|
/** Maximum short margin position size (base currency) */
|
|
195
255
|
short_position_limit?: number;
|
|
196
256
|
}
|
|
197
257
|
/** Map of pair name -> asset pair info */
|
|
198
|
-
type KrakenAssetPairMap = Record<string, KrakenAssetPair>;
|
|
199
|
-
type KrakenAssetPairInfoType = 'info' | 'leverage' | 'fees' | 'margin';
|
|
200
|
-
interface KrakenGetTradableAssetPairsParams {
|
|
258
|
+
type KrakenAssetPairMap$1 = Record<string, KrakenAssetPair$1>;
|
|
259
|
+
type KrakenAssetPairInfoType$1 = 'info' | 'leverage' | 'fees' | 'margin';
|
|
260
|
+
interface KrakenGetTradableAssetPairsParams$1 {
|
|
201
261
|
/**
|
|
202
262
|
* Asset pairs to get data for (e.g. ["BTC/USD", "ETH/BTC"]).
|
|
203
263
|
* If omitted, Kraken returns all pairs.
|
|
@@ -208,7 +268,7 @@ interface KrakenGetTradableAssetPairsParams {
|
|
|
208
268
|
* - "currency" = spot currency pairs
|
|
209
269
|
* - "tokenized_asset" = tokenized asset pairs (xstocks)
|
|
210
270
|
*/
|
|
211
|
-
aclass_base?: KrakenAssetClass;
|
|
271
|
+
aclass_base?: KrakenAssetClass$1;
|
|
212
272
|
/**
|
|
213
273
|
* Info to retrieve (default "info").
|
|
214
274
|
* - "info" = all info
|
|
@@ -216,7 +276,7 @@ interface KrakenGetTradableAssetPairsParams {
|
|
|
216
276
|
* - "fees" = fee schedule
|
|
217
277
|
* - "margin" = margin info
|
|
218
278
|
*/
|
|
219
|
-
info?: KrakenAssetPairInfoType;
|
|
279
|
+
info?: KrakenAssetPairInfoType$1;
|
|
220
280
|
/**
|
|
221
281
|
* Filter to only include pairs available in the provided country/region.
|
|
222
282
|
* ISO 3166-1 alpha-2 code (e.g. "CA", "GB").
|
|
@@ -229,7 +289,7 @@ interface KrakenGetTradableAssetPairsParams {
|
|
|
229
289
|
* - "forex" = standard spot / FX pairs
|
|
230
290
|
* - "tokenized_asset" = tokenized assets (xstocks)
|
|
231
291
|
*/
|
|
232
|
-
type KrakenTickerAssetClass = 'tokenized_asset' | 'forex';
|
|
292
|
+
type KrakenTickerAssetClass$1 = 'tokenized_asset' | 'forex';
|
|
233
293
|
/**
|
|
234
294
|
* Asset Ticker Info
|
|
235
295
|
*
|
|
@@ -244,7 +304,7 @@ type KrakenTickerAssetClass = 'tokenized_asset' | 'forex';
|
|
|
244
304
|
* - h: High [<today>, <last 24 hours>]
|
|
245
305
|
* - o: Today's opening price
|
|
246
306
|
*/
|
|
247
|
-
interface KrakenAssetTickerInfo {
|
|
307
|
+
interface KrakenAssetTickerInfo$1 {
|
|
248
308
|
a: [string, string, string];
|
|
249
309
|
b: [string, string, string];
|
|
250
310
|
c: [string, string];
|
|
@@ -259,8 +319,8 @@ interface KrakenAssetTickerInfo {
|
|
|
259
319
|
* Map of pair name -> ticker info
|
|
260
320
|
* e.g. { "XBTUSD": { ... }, "ETHUSD": { ... } }
|
|
261
321
|
*/
|
|
262
|
-
type KrakenTickerInfoMap = Record<string, KrakenAssetTickerInfo>;
|
|
263
|
-
interface KrakenGetTickerInformationParams {
|
|
322
|
+
type KrakenTickerInfoMap$1 = Record<string, KrakenAssetTickerInfo$1>;
|
|
323
|
+
interface KrakenGetTickerInformationParams$1 {
|
|
264
324
|
/**
|
|
265
325
|
* Asset pairs to get data for.
|
|
266
326
|
*
|
|
@@ -275,11 +335,11 @@ interface KrakenGetTickerInformationParams {
|
|
|
275
335
|
* Required when requesting tokenized pairs (xstocks).
|
|
276
336
|
* If provided without `pair`, all pairs for that class are returned.
|
|
277
337
|
*/
|
|
278
|
-
asset_class?: KrakenTickerAssetClass;
|
|
338
|
+
asset_class?: KrakenTickerAssetClass$1;
|
|
279
339
|
}
|
|
280
340
|
|
|
281
|
-
type KrakenOhlcInterval = 1 | 5 | 15 | 30 | 60 | 240 | 1440 | 10080 | 21600;
|
|
282
|
-
type KrakenOhlcEntry = [
|
|
341
|
+
type KrakenOhlcInterval$1 = 1 | 5 | 15 | 30 | 60 | 240 | 1440 | 10080 | 21600;
|
|
342
|
+
type KrakenOhlcEntry$1 = [
|
|
283
343
|
time: number,
|
|
284
344
|
open: string,
|
|
285
345
|
high: string,
|
|
@@ -289,14 +349,14 @@ type KrakenOhlcEntry = [
|
|
|
289
349
|
volume: string,
|
|
290
350
|
count: number
|
|
291
351
|
];
|
|
292
|
-
type KrakenOhlcMap = Record<string, KrakenOhlcEntry[]>;
|
|
293
|
-
interface KrakenOhlcResponse {
|
|
352
|
+
type KrakenOhlcMap$1 = Record<string, KrakenOhlcEntry$1[]>;
|
|
353
|
+
interface KrakenOhlcResponse$1 {
|
|
294
354
|
last: number;
|
|
295
|
-
ohlc: KrakenOhlcMap;
|
|
355
|
+
ohlc: KrakenOhlcMap$1;
|
|
296
356
|
}
|
|
297
|
-
interface KrakenGetOhlcDataParams {
|
|
357
|
+
interface KrakenGetOhlcDataParams$1 {
|
|
298
358
|
pair: string;
|
|
299
|
-
interval?: KrakenOhlcInterval;
|
|
359
|
+
interval?: KrakenOhlcInterval$1;
|
|
300
360
|
since?: number;
|
|
301
361
|
asset_class?: 'tokenized_asset';
|
|
302
362
|
}
|
|
@@ -305,18 +365,18 @@ interface KrakenGetOhlcDataParams {
|
|
|
305
365
|
* One level in the L2 order book:
|
|
306
366
|
* [<price>, <volume>, <timestamp>]
|
|
307
367
|
*/
|
|
308
|
-
type KrakenOrderBookLevel = [
|
|
368
|
+
type KrakenOrderBookLevel$1 = [
|
|
309
369
|
price: string,
|
|
310
370
|
volume: string,
|
|
311
371
|
timestamp: number
|
|
312
372
|
];
|
|
313
|
-
interface KrakenOrderBook {
|
|
314
|
-
asks: KrakenOrderBookLevel[];
|
|
315
|
-
bids: KrakenOrderBookLevel[];
|
|
373
|
+
interface KrakenOrderBook$1 {
|
|
374
|
+
asks: KrakenOrderBookLevel$1[];
|
|
375
|
+
bids: KrakenOrderBookLevel$1[];
|
|
316
376
|
}
|
|
317
377
|
/** Map of pair name -> order book */
|
|
318
|
-
type KrakenOrderBookMap = Record<string, KrakenOrderBook>;
|
|
319
|
-
interface KrakenGetOrderBookParams {
|
|
378
|
+
type KrakenOrderBookMap$1 = Record<string, KrakenOrderBook$1>;
|
|
379
|
+
interface KrakenGetOrderBookParams$1 {
|
|
320
380
|
/**
|
|
321
381
|
* Asset pair to get data for (required).
|
|
322
382
|
* e.g. "XBTUSD"
|
|
@@ -346,7 +406,7 @@ interface KrakenGetOrderBookParams {
|
|
|
346
406
|
* - misc -> string (flags)
|
|
347
407
|
* - tradeId -> string
|
|
348
408
|
*/
|
|
349
|
-
type KrakenTradeEntry = [
|
|
409
|
+
type KrakenTradeEntry$1 = [
|
|
350
410
|
price: string,
|
|
351
411
|
volume: string,
|
|
352
412
|
time: number,
|
|
@@ -355,18 +415,18 @@ type KrakenTradeEntry = [
|
|
|
355
415
|
miscellaneous: string,
|
|
356
416
|
tradeId: string
|
|
357
417
|
];
|
|
358
|
-
type KrakenTradesMap = Record<string, KrakenTradeEntry[]>;
|
|
418
|
+
type KrakenTradesMap$1 = Record<string, KrakenTradeEntry$1[]>;
|
|
359
419
|
/**
|
|
360
420
|
* Normalized trades response:
|
|
361
421
|
*
|
|
362
422
|
* - `last` is the ID to be used as `since` when polling.
|
|
363
423
|
* - `trades` is a map of pair -> trade entries.
|
|
364
424
|
*/
|
|
365
|
-
interface KrakenRecentTradesResponse {
|
|
425
|
+
interface KrakenRecentTradesResponse$1 {
|
|
366
426
|
last: string;
|
|
367
|
-
trades: KrakenTradesMap;
|
|
427
|
+
trades: KrakenTradesMap$1;
|
|
368
428
|
}
|
|
369
|
-
interface KrakenGetRecentTradesParams {
|
|
429
|
+
interface KrakenGetRecentTradesParams$1 {
|
|
370
430
|
/**
|
|
371
431
|
* Asset pair to get data for (required).
|
|
372
432
|
* e.g. "XBTUSD"
|
|
@@ -392,19 +452,19 @@ interface KrakenGetRecentTradesParams {
|
|
|
392
452
|
* Single spread entry:
|
|
393
453
|
* [int <time>, string <bid>, string <ask>]
|
|
394
454
|
*/
|
|
395
|
-
type KrakenSpreadEntry = [time: number, bid: string, ask: string];
|
|
396
|
-
type KrakenSpreadsMap = Record<string, KrakenSpreadEntry[]>;
|
|
455
|
+
type KrakenSpreadEntry$1 = [time: number, bid: string, ask: string];
|
|
456
|
+
type KrakenSpreadsMap$1 = Record<string, KrakenSpreadEntry$1[]>;
|
|
397
457
|
/**
|
|
398
458
|
* Normalized spreads response:
|
|
399
459
|
*
|
|
400
460
|
* - `last` is the ID to be used as `since` when polling.
|
|
401
461
|
* - `spreads` is a map of pair -> spread entries.
|
|
402
462
|
*/
|
|
403
|
-
interface KrakenRecentSpreadsResponse {
|
|
463
|
+
interface KrakenRecentSpreadsResponse$1 {
|
|
404
464
|
last: number;
|
|
405
|
-
spreads: KrakenSpreadsMap;
|
|
465
|
+
spreads: KrakenSpreadsMap$1;
|
|
406
466
|
}
|
|
407
|
-
interface KrakenGetRecentSpreadsParams {
|
|
467
|
+
interface KrakenGetRecentSpreadsParams$1 {
|
|
408
468
|
/**
|
|
409
469
|
* Asset pair to get data for (required).
|
|
410
470
|
* e.g. "XBTUSD"
|
|
@@ -432,7 +492,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
432
492
|
* const time = await kraken.marketData.getServerTime();
|
|
433
493
|
* console.log(time.rfc1123);
|
|
434
494
|
*/
|
|
435
|
-
getServerTime(): Promise<KrakenServerTime>;
|
|
495
|
+
getServerTime(): Promise<KrakenServerTime$1>;
|
|
436
496
|
/**
|
|
437
497
|
* Get the current system status or trading mode.
|
|
438
498
|
*
|
|
@@ -440,7 +500,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
440
500
|
* const status = await kraken.marketData.getSystemStatus();
|
|
441
501
|
* console.log(status.status, status.timestamp);
|
|
442
502
|
*/
|
|
443
|
-
getSystemStatus(): Promise<KrakenSystemStatusResult>;
|
|
503
|
+
getSystemStatus(): Promise<KrakenSystemStatusResult$1>;
|
|
444
504
|
/**
|
|
445
505
|
* Get information about assets available for deposit, withdrawal,
|
|
446
506
|
* trading and earn.
|
|
@@ -454,7 +514,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
454
514
|
* asset: ["XXBT", "XETH"],
|
|
455
515
|
* });
|
|
456
516
|
*/
|
|
457
|
-
getAssetInfo(params?: KrakenGetAssetInfoParams): Promise<KrakenAssetInfoMap>;
|
|
517
|
+
getAssetInfo(params?: KrakenGetAssetInfoParams$1): Promise<KrakenAssetInfoMap$1>;
|
|
458
518
|
/**
|
|
459
519
|
* Get tradable asset pairs and their configuration.
|
|
460
520
|
*
|
|
@@ -469,7 +529,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
469
529
|
* pair: ["XBTUSD", "ETHUSD"],
|
|
470
530
|
* });
|
|
471
531
|
*/
|
|
472
|
-
getTradableAssetPairs(params?: KrakenGetTradableAssetPairsParams): Promise<KrakenAssetPairMap>;
|
|
532
|
+
getTradableAssetPairs(params?: KrakenGetTradableAssetPairsParams$1): Promise<KrakenAssetPairMap$1>;
|
|
473
533
|
/**
|
|
474
534
|
* Get ticker information for one or more markets.
|
|
475
535
|
*
|
|
@@ -483,7 +543,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
483
543
|
* const xbtusd = tickers["XBTUSD"];
|
|
484
544
|
* console.log(xbtusd.c[0]); // last traded price
|
|
485
545
|
*/
|
|
486
|
-
getTickerInformation(params?: KrakenGetTickerInformationParams): Promise<KrakenTickerInfoMap>;
|
|
546
|
+
getTickerInformation(params?: KrakenGetTickerInformationParams$1): Promise<KrakenTickerInfoMap$1>;
|
|
487
547
|
/**
|
|
488
548
|
* Retrieve OHLC candles for a pair.
|
|
489
549
|
*
|
|
@@ -498,7 +558,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
498
558
|
* const candles = ohlc["XBTUSD"] ?? [];
|
|
499
559
|
* console.log("Next since:", last);
|
|
500
560
|
*/
|
|
501
|
-
getOhlcData(params: KrakenGetOhlcDataParams): Promise<KrakenOhlcResponse>;
|
|
561
|
+
getOhlcData(params: KrakenGetOhlcDataParams$1): Promise<KrakenOhlcResponse$1>;
|
|
502
562
|
/**
|
|
503
563
|
* Get level 2 (L2) order book for a pair.
|
|
504
564
|
*
|
|
@@ -512,7 +572,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
512
572
|
* const bestAsk = book?.asks[0];
|
|
513
573
|
* const bestBid = book?.bids[0];
|
|
514
574
|
*/
|
|
515
|
-
getOrderBook(params: KrakenGetOrderBookParams): Promise<KrakenOrderBookMap>;
|
|
575
|
+
getOrderBook(params: KrakenGetOrderBookParams$1): Promise<KrakenOrderBookMap$1>;
|
|
516
576
|
/**
|
|
517
577
|
* Get recent trades for a pair (up to 1000).
|
|
518
578
|
*
|
|
@@ -527,7 +587,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
527
587
|
* const trades = first.trades["XBTUSD"] ?? [];
|
|
528
588
|
* const nextSince = first.last;
|
|
529
589
|
*/
|
|
530
|
-
getRecentTrades(params: KrakenGetRecentTradesParams): Promise<KrakenRecentTradesResponse>;
|
|
590
|
+
getRecentTrades(params: KrakenGetRecentTradesParams$1): Promise<KrakenRecentTradesResponse$1>;
|
|
531
591
|
/**
|
|
532
592
|
* Get recent top-of-book spreads for a pair.
|
|
533
593
|
*
|
|
@@ -541,8 +601,43 @@ declare class KrakenSpotMarketDataApi {
|
|
|
541
601
|
* const spreads = first.spreads["XBTUSD"] ?? [];
|
|
542
602
|
* const nextSince = first.last;
|
|
543
603
|
*/
|
|
544
|
-
getRecentSpreads(params: KrakenGetRecentSpreadsParams): Promise<KrakenRecentSpreadsResponse>;
|
|
545
|
-
}
|
|
604
|
+
getRecentSpreads(params: KrakenGetRecentSpreadsParams$1): Promise<KrakenRecentSpreadsResponse$1>;
|
|
605
|
+
}
|
|
606
|
+
type KrakenServerTime = KrakenServerTime$1;
|
|
607
|
+
type KrakenSystemStatus = KrakenSystemStatus$1;
|
|
608
|
+
type KrakenSystemStatusResult = KrakenSystemStatusResult$1;
|
|
609
|
+
type KrakenAssetClass = KrakenAssetClass$1;
|
|
610
|
+
type KrakenAssetStatus = KrakenAssetStatus$1;
|
|
611
|
+
type KrakenAssetInfo = KrakenAssetInfo$1;
|
|
612
|
+
type KrakenAssetInfoMap = KrakenAssetInfoMap$1;
|
|
613
|
+
type KrakenGetAssetInfoParams = KrakenGetAssetInfoParams$1;
|
|
614
|
+
type KrakenAssetPairStatus = KrakenAssetPairStatus$1;
|
|
615
|
+
type KrakenFeeScheduleEntry = KrakenFeeScheduleEntry$1;
|
|
616
|
+
type KrakenAssetPair = KrakenAssetPair$1;
|
|
617
|
+
type KrakenAssetPairMap = KrakenAssetPairMap$1;
|
|
618
|
+
type KrakenAssetPairInfoType = KrakenAssetPairInfoType$1;
|
|
619
|
+
type KrakenGetTradableAssetPairsParams = KrakenGetTradableAssetPairsParams$1;
|
|
620
|
+
type KrakenTickerAssetClass = KrakenTickerAssetClass$1;
|
|
621
|
+
type KrakenAssetTickerInfo = KrakenAssetTickerInfo$1;
|
|
622
|
+
type KrakenTickerInfoMap = KrakenTickerInfoMap$1;
|
|
623
|
+
type KrakenGetTickerInformationParams = KrakenGetTickerInformationParams$1;
|
|
624
|
+
type KrakenOhlcInterval = KrakenOhlcInterval$1;
|
|
625
|
+
type KrakenOhlcEntry = KrakenOhlcEntry$1;
|
|
626
|
+
type KrakenOhlcMap = KrakenOhlcMap$1;
|
|
627
|
+
type KrakenOhlcResponse = KrakenOhlcResponse$1;
|
|
628
|
+
type KrakenGetOhlcDataParams = KrakenGetOhlcDataParams$1;
|
|
629
|
+
type KrakenOrderBookLevel = KrakenOrderBookLevel$1;
|
|
630
|
+
type KrakenOrderBook = KrakenOrderBook$1;
|
|
631
|
+
type KrakenOrderBookMap = KrakenOrderBookMap$1;
|
|
632
|
+
type KrakenGetOrderBookParams = KrakenGetOrderBookParams$1;
|
|
633
|
+
type KrakenTradeEntry = KrakenTradeEntry$1;
|
|
634
|
+
type KrakenTradesMap = KrakenTradesMap$1;
|
|
635
|
+
type KrakenRecentTradesResponse = KrakenRecentTradesResponse$1;
|
|
636
|
+
type KrakenGetRecentTradesParams = KrakenGetRecentTradesParams$1;
|
|
637
|
+
type KrakenSpreadEntry = KrakenSpreadEntry$1;
|
|
638
|
+
type KrakenSpreadsMap = KrakenSpreadsMap$1;
|
|
639
|
+
type KrakenRecentSpreadsResponse = KrakenRecentSpreadsResponse$1;
|
|
640
|
+
type KrakenGetRecentSpreadsParams = KrakenGetRecentSpreadsParams$1;
|
|
546
641
|
|
|
547
642
|
/**
|
|
548
643
|
* Rebase multiplier options for xstocks / tokenized assets.
|
|
@@ -550,7 +645,7 @@ declare class KrakenSpotMarketDataApi {
|
|
|
550
645
|
* - "rebased": Display in terms of underlying equity (default).
|
|
551
646
|
* - "base": Display in terms of SPV tokens.
|
|
552
647
|
*/
|
|
553
|
-
type KrakenRebaseMultiplier$
|
|
648
|
+
type KrakenRebaseMultiplier$2 = 'rebased' | 'base';
|
|
554
649
|
/**
|
|
555
650
|
* Account balance result:
|
|
556
651
|
* Map of asset symbol -> balance as string.
|
|
@@ -562,8 +657,8 @@ type KrakenRebaseMultiplier$1 = 'rebased' | 'base';
|
|
|
562
657
|
* "USDT.F": "50.0"
|
|
563
658
|
* }
|
|
564
659
|
*/
|
|
565
|
-
type KrakenAccountBalanceMap = Record<string, string>;
|
|
566
|
-
interface KrakenGetAccountBalanceParams {
|
|
660
|
+
type KrakenAccountBalanceMap$1 = Record<string, string>;
|
|
661
|
+
interface KrakenGetAccountBalanceParams$1 {
|
|
567
662
|
/**
|
|
568
663
|
* Optional parameter for viewing xstocks data.
|
|
569
664
|
*
|
|
@@ -572,7 +667,7 @@ interface KrakenGetAccountBalanceParams {
|
|
|
572
667
|
*
|
|
573
668
|
* Default on Kraken is "rebased" if omitted.
|
|
574
669
|
*/
|
|
575
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
670
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
576
671
|
}
|
|
577
672
|
|
|
578
673
|
/**
|
|
@@ -583,7 +678,7 @@ interface KrakenGetAccountBalanceParams {
|
|
|
583
678
|
* - credit_used : used credit amount
|
|
584
679
|
* - hold_trade : total held amount (e.g. open orders)
|
|
585
680
|
*/
|
|
586
|
-
interface KrakenExtendedBalanceEntry {
|
|
681
|
+
interface KrakenExtendedBalanceEntry$1 {
|
|
587
682
|
/** Total balance amount for an asset */
|
|
588
683
|
balance: string;
|
|
589
684
|
/** Total credit amount (only applicable if account has a credit line) */
|
|
@@ -594,8 +689,8 @@ interface KrakenExtendedBalanceEntry {
|
|
|
594
689
|
hold_trade: string;
|
|
595
690
|
}
|
|
596
691
|
/** Map of asset symbol -> extended balance info */
|
|
597
|
-
type KrakenExtendedBalanceMap = Record<string, KrakenExtendedBalanceEntry>;
|
|
598
|
-
interface KrakenGetExtendedBalanceParams {
|
|
692
|
+
type KrakenExtendedBalanceMap$1 = Record<string, KrakenExtendedBalanceEntry$1>;
|
|
693
|
+
interface KrakenGetExtendedBalanceParams$1 {
|
|
599
694
|
/**
|
|
600
695
|
* Optional parameter for viewing xstocks data.
|
|
601
696
|
*
|
|
@@ -604,13 +699,13 @@ interface KrakenGetExtendedBalanceParams {
|
|
|
604
699
|
*
|
|
605
700
|
* Default on Kraken is "rebased" if omitted.
|
|
606
701
|
*/
|
|
607
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
702
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
608
703
|
}
|
|
609
704
|
|
|
610
705
|
/**
|
|
611
706
|
* Credit line details for a specific asset.
|
|
612
707
|
*/
|
|
613
|
-
interface KrakenCreditLinesAssetEntry {
|
|
708
|
+
interface KrakenCreditLinesAssetEntry$1 {
|
|
614
709
|
/** Current balance for the asset */
|
|
615
710
|
balance: string;
|
|
616
711
|
/** Credit limit for the asset */
|
|
@@ -621,12 +716,12 @@ interface KrakenCreditLinesAssetEntry {
|
|
|
621
716
|
available_credit: string;
|
|
622
717
|
}
|
|
623
718
|
/** Map of asset symbol -> credit line details */
|
|
624
|
-
type KrakenCreditLinesAssetMap = Record<string, KrakenCreditLinesAssetEntry>;
|
|
719
|
+
type KrakenCreditLinesAssetMap$1 = Record<string, KrakenCreditLinesAssetEntry$1>;
|
|
625
720
|
/**
|
|
626
721
|
* Aggregate credit monitor metrics.
|
|
627
722
|
* All values are strings (or null) representing USD amounts/ratios.
|
|
628
723
|
*/
|
|
629
|
-
interface KrakenCreditLinesLimitsMonitor {
|
|
724
|
+
interface KrakenCreditLinesLimitsMonitor$1 {
|
|
630
725
|
/** Total credit across all assets represented in USD */
|
|
631
726
|
total_credit_usd?: string | null;
|
|
632
727
|
/** Total credit used across all assets represented in USD */
|
|
@@ -643,17 +738,17 @@ interface KrakenCreditLinesLimitsMonitor {
|
|
|
643
738
|
/**
|
|
644
739
|
* Full credit line details result.
|
|
645
740
|
*/
|
|
646
|
-
interface KrakenCreditLinesResult {
|
|
741
|
+
interface KrakenCreditLinesResult$1 {
|
|
647
742
|
/** Balances by asset */
|
|
648
|
-
asset_details: KrakenCreditLinesAssetMap;
|
|
743
|
+
asset_details: KrakenCreditLinesAssetMap$1;
|
|
649
744
|
/** Aggregate credit monitor info */
|
|
650
|
-
limits_monitor: KrakenCreditLinesLimitsMonitor;
|
|
745
|
+
limits_monitor: KrakenCreditLinesLimitsMonitor$1;
|
|
651
746
|
}
|
|
652
747
|
/**
|
|
653
748
|
* The API can return `null` if there are no credit lines configured.
|
|
654
749
|
*/
|
|
655
|
-
type KrakenCreditLinesResponse = KrakenCreditLinesResult | null;
|
|
656
|
-
interface KrakenGetCreditLinesParams {
|
|
750
|
+
type KrakenCreditLinesResponse$1 = KrakenCreditLinesResult$1 | null;
|
|
751
|
+
interface KrakenGetCreditLinesParams$1 {
|
|
657
752
|
/**
|
|
658
753
|
* Optional parameter for viewing xstocks data.
|
|
659
754
|
*
|
|
@@ -662,7 +757,7 @@ interface KrakenGetCreditLinesParams {
|
|
|
662
757
|
*
|
|
663
758
|
* Default on Kraken is "rebased" if omitted.
|
|
664
759
|
*/
|
|
665
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
760
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
666
761
|
}
|
|
667
762
|
|
|
668
763
|
/**
|
|
@@ -680,7 +775,7 @@ interface KrakenGetCreditLinesParams {
|
|
|
680
775
|
* - ml : Margin level = (equity / initial margin) * 100
|
|
681
776
|
* - uv : Unexecuted value of unfilled/partially filled orders
|
|
682
777
|
*/
|
|
683
|
-
interface KrakenTradeBalanceResult {
|
|
778
|
+
interface KrakenTradeBalanceResult$1 {
|
|
684
779
|
/** Equivalent balance (combined balance of all currencies) */
|
|
685
780
|
eb: string;
|
|
686
781
|
/** Trade balance (combined balance of all equity currencies) */
|
|
@@ -705,7 +800,7 @@ interface KrakenTradeBalanceResult {
|
|
|
705
800
|
/** Unexecuted value: value of unfilled and partially filled orders */
|
|
706
801
|
uv: string;
|
|
707
802
|
}
|
|
708
|
-
interface KrakenGetTradeBalanceParams {
|
|
803
|
+
interface KrakenGetTradeBalanceParams$1 {
|
|
709
804
|
/**
|
|
710
805
|
* Base asset used to determine balance.
|
|
711
806
|
* Default on Kraken is "ZUSD" if omitted.
|
|
@@ -719,20 +814,20 @@ interface KrakenGetTradeBalanceParams {
|
|
|
719
814
|
*
|
|
720
815
|
* Default on Kraken is "rebased" if omitted.
|
|
721
816
|
*/
|
|
722
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
817
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
723
818
|
}
|
|
724
819
|
|
|
725
|
-
type KrakenOrderStatus = 'pending' | 'open' | 'closed' | 'canceled' | 'expired';
|
|
726
|
-
type KrakenOrderSide = 'buy' | 'sell';
|
|
727
|
-
type KrakenOrderType = 'market' | 'limit' | 'iceberg' | 'stop-loss' | 'take-profit' | 'stop-loss-limit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
|
|
728
|
-
type KrakenOrderTrigger = 'last' | 'index';
|
|
729
|
-
interface KrakenOpenOrderDescription {
|
|
820
|
+
type KrakenOrderStatus$1 = 'pending' | 'open' | 'closed' | 'canceled' | 'expired';
|
|
821
|
+
type KrakenOrderSide$1 = 'buy' | 'sell';
|
|
822
|
+
type KrakenOrderType$1 = 'market' | 'limit' | 'iceberg' | 'stop-loss' | 'take-profit' | 'stop-loss-limit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
|
|
823
|
+
type KrakenOrderTrigger$1 = 'last' | 'index';
|
|
824
|
+
interface KrakenOpenOrderDescription$1 {
|
|
730
825
|
/** Asset pair (e.g. "XBTUSD") */
|
|
731
826
|
pair: string;
|
|
732
827
|
/** Type of order: "buy" or "sell" */
|
|
733
|
-
type: KrakenOrderSide;
|
|
828
|
+
type: KrakenOrderSide$1;
|
|
734
829
|
/** Execution model of the order (market, limit, stop-loss, etc.) */
|
|
735
|
-
ordertype: KrakenOrderType;
|
|
830
|
+
ordertype: KrakenOrderType$1;
|
|
736
831
|
/** Primary price */
|
|
737
832
|
price: string;
|
|
738
833
|
/** Secondary price (if applicable) */
|
|
@@ -751,7 +846,7 @@ interface KrakenOpenOrderDescription {
|
|
|
751
846
|
* - Some fields are optional or nullable depending on order type.
|
|
752
847
|
* - `margin` is documented as boolean; we keep it boolean | string for safety.
|
|
753
848
|
*/
|
|
754
|
-
interface KrakenOpenOrder {
|
|
849
|
+
interface KrakenOpenOrder$1 {
|
|
755
850
|
/** Referral order transaction ID that created this order (nullable) */
|
|
756
851
|
refid?: string | null;
|
|
757
852
|
/** Optional numeric client identifier */
|
|
@@ -759,7 +854,7 @@ interface KrakenOpenOrder {
|
|
|
759
854
|
/** Optional alphanumeric client order ID */
|
|
760
855
|
cl_ord_id?: string | null;
|
|
761
856
|
/** Status of order */
|
|
762
|
-
status: KrakenOrderStatus;
|
|
857
|
+
status: KrakenOrderStatus$1;
|
|
763
858
|
/** Unix timestamp when order was placed */
|
|
764
859
|
opentm: number;
|
|
765
860
|
/** Unix timestamp of order start time (or 0 if not set) */
|
|
@@ -767,7 +862,7 @@ interface KrakenOpenOrder {
|
|
|
767
862
|
/** Unix timestamp of order end time (or 0 if not set) */
|
|
768
863
|
expiretm: number;
|
|
769
864
|
/** Order description info */
|
|
770
|
-
descr: KrakenOpenOrderDescription;
|
|
865
|
+
descr: KrakenOpenOrderDescription$1;
|
|
771
866
|
/** Volume of order (base currency) */
|
|
772
867
|
vol: string;
|
|
773
868
|
/** Volume executed (base currency) */
|
|
@@ -789,7 +884,7 @@ interface KrakenOpenOrder {
|
|
|
789
884
|
* Price signal used to trigger stop/take-profit orders.
|
|
790
885
|
* If not set, "last" is implied.
|
|
791
886
|
*/
|
|
792
|
-
trigger?: KrakenOrderTrigger;
|
|
887
|
+
trigger?: KrakenOrderTrigger$1;
|
|
793
888
|
/**
|
|
794
889
|
* Indicates if the order is funded on margin.
|
|
795
890
|
* (Docs show boolean; keeping union in case of API quirks.)
|
|
@@ -813,11 +908,11 @@ interface KrakenOpenOrder {
|
|
|
813
908
|
sender_sub_id?: string | null;
|
|
814
909
|
}
|
|
815
910
|
/** Map of order ID -> open order */
|
|
816
|
-
type KrakenOpenOrdersMap = Record<string, KrakenOpenOrder>;
|
|
817
|
-
interface KrakenOpenOrdersResult {
|
|
818
|
-
open: KrakenOpenOrdersMap;
|
|
911
|
+
type KrakenOpenOrdersMap$1 = Record<string, KrakenOpenOrder$1>;
|
|
912
|
+
interface KrakenOpenOrdersResult$1 {
|
|
913
|
+
open: KrakenOpenOrdersMap$1;
|
|
819
914
|
}
|
|
820
|
-
interface KrakenGetOpenOrdersParams {
|
|
915
|
+
interface KrakenGetOpenOrdersParams$1 {
|
|
821
916
|
/**
|
|
822
917
|
* Whether or not to include trades related to position in output.
|
|
823
918
|
* Default on Kraken is false.
|
|
@@ -839,7 +934,7 @@ interface KrakenGetOpenOrdersParams {
|
|
|
839
934
|
*
|
|
840
935
|
* Default on Kraken is "rebased" if omitted.
|
|
841
936
|
*/
|
|
842
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
937
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
843
938
|
}
|
|
844
939
|
|
|
845
940
|
/**
|
|
@@ -849,7 +944,7 @@ interface KrakenGetOpenOrdersParams {
|
|
|
849
944
|
* - closetm: Unix timestamp when order was closed
|
|
850
945
|
* - reason : Additional info on status (if any)
|
|
851
946
|
*/
|
|
852
|
-
interface KrakenClosedOrder {
|
|
947
|
+
interface KrakenClosedOrder$1 {
|
|
853
948
|
/** Referral order transaction ID that created this order (nullable) */
|
|
854
949
|
refid?: string | null;
|
|
855
950
|
/** Optional numeric client identifier */
|
|
@@ -857,7 +952,7 @@ interface KrakenClosedOrder {
|
|
|
857
952
|
/** Optional alphanumeric client order ID */
|
|
858
953
|
cl_ord_id?: string | null;
|
|
859
954
|
/** Status of order (pending, open, closed, canceled, expired) */
|
|
860
|
-
status: KrakenOrderStatus;
|
|
955
|
+
status: KrakenOrderStatus$1;
|
|
861
956
|
/** Unix timestamp when order was placed */
|
|
862
957
|
opentm: number;
|
|
863
958
|
/** Unix timestamp of order start time (or 0 if not set) */
|
|
@@ -865,7 +960,7 @@ interface KrakenClosedOrder {
|
|
|
865
960
|
/** Unix timestamp of order end time (or 0 if not set) */
|
|
866
961
|
expiretm: number;
|
|
867
962
|
/** Order description info */
|
|
868
|
-
descr: KrakenOpenOrderDescription;
|
|
963
|
+
descr: KrakenOpenOrderDescription$1;
|
|
869
964
|
/** Volume of order (base currency) */
|
|
870
965
|
vol: string;
|
|
871
966
|
/** Volume executed (base currency) */
|
|
@@ -887,7 +982,7 @@ interface KrakenClosedOrder {
|
|
|
887
982
|
* Price signal used to trigger stop/take-profit orders.
|
|
888
983
|
* If not set, "last" is implied.
|
|
889
984
|
*/
|
|
890
|
-
trigger?: KrakenOrderTrigger;
|
|
985
|
+
trigger?: KrakenOrderTrigger$1;
|
|
891
986
|
/**
|
|
892
987
|
* Indicates if the order is funded on margin.
|
|
893
988
|
* (Docs show boolean; keep union in case of API quirks.)
|
|
@@ -916,18 +1011,18 @@ interface KrakenClosedOrder {
|
|
|
916
1011
|
reason?: string;
|
|
917
1012
|
}
|
|
918
1013
|
/** Map of txid -> closed order */
|
|
919
|
-
type KrakenClosedOrdersMap = Record<string, KrakenClosedOrder>;
|
|
920
|
-
interface KrakenClosedOrdersResult {
|
|
1014
|
+
type KrakenClosedOrdersMap$1 = Record<string, KrakenClosedOrder$1>;
|
|
1015
|
+
interface KrakenClosedOrdersResult$1 {
|
|
921
1016
|
/** Closed orders keyed by transaction ID */
|
|
922
|
-
closed: KrakenClosedOrdersMap;
|
|
1017
|
+
closed: KrakenClosedOrdersMap$1;
|
|
923
1018
|
/**
|
|
924
1019
|
* Amount of available order info matching criteria.
|
|
925
1020
|
* Used with `ofs` for pagination.
|
|
926
1021
|
*/
|
|
927
1022
|
count: number;
|
|
928
1023
|
}
|
|
929
|
-
type KrakenClosedOrdersCloseTime = 'open' | 'close' | 'both';
|
|
930
|
-
interface KrakenGetClosedOrdersParams {
|
|
1024
|
+
type KrakenClosedOrdersCloseTime$1 = 'open' | 'close' | 'both';
|
|
1025
|
+
interface KrakenGetClosedOrdersParams$1 {
|
|
931
1026
|
/**
|
|
932
1027
|
* Whether or not to include trades related to position in output.
|
|
933
1028
|
* Default on Kraken is false.
|
|
@@ -962,7 +1057,7 @@ interface KrakenGetClosedOrdersParams {
|
|
|
962
1057
|
*
|
|
963
1058
|
* Default on Kraken is "both".
|
|
964
1059
|
*/
|
|
965
|
-
closetime?: KrakenClosedOrdersCloseTime;
|
|
1060
|
+
closetime?: KrakenClosedOrdersCloseTime$1;
|
|
966
1061
|
/**
|
|
967
1062
|
* Whether or not to consolidate trades by individual taker trades.
|
|
968
1063
|
* Default on Kraken is true.
|
|
@@ -982,7 +1077,7 @@ interface KrakenGetClosedOrdersParams {
|
|
|
982
1077
|
*
|
|
983
1078
|
* Default on Kraken is "rebased" if omitted.
|
|
984
1079
|
*/
|
|
985
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1080
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
986
1081
|
}
|
|
987
1082
|
|
|
988
1083
|
/**
|
|
@@ -992,7 +1087,7 @@ interface KrakenGetClosedOrdersParams {
|
|
|
992
1087
|
* open or closed orders depending on txid/status, so `closetm`/`reason`
|
|
993
1088
|
* are optional.
|
|
994
1089
|
*/
|
|
995
|
-
interface KrakenQueriedOrder {
|
|
1090
|
+
interface KrakenQueriedOrder$1 {
|
|
996
1091
|
/** Referral order transaction ID that created this order (nullable) */
|
|
997
1092
|
refid?: string | null;
|
|
998
1093
|
/** Optional numeric, client identifier associated with one or more orders */
|
|
@@ -1000,7 +1095,7 @@ interface KrakenQueriedOrder {
|
|
|
1000
1095
|
/** Optional alphanumeric, client identifier associated with the order */
|
|
1001
1096
|
cl_ord_id?: string | null;
|
|
1002
1097
|
/** Status of order (pending, open, closed, canceled, expired) */
|
|
1003
|
-
status: KrakenOrderStatus;
|
|
1098
|
+
status: KrakenOrderStatus$1;
|
|
1004
1099
|
/** Unix timestamp of when order was placed */
|
|
1005
1100
|
opentm: number;
|
|
1006
1101
|
/** Unix timestamp of order start time (or 0 if not set) */
|
|
@@ -1008,7 +1103,7 @@ interface KrakenQueriedOrder {
|
|
|
1008
1103
|
/** Unix timestamp of order end time (or 0 if not set) */
|
|
1009
1104
|
expiretm: number;
|
|
1010
1105
|
/** Order description info */
|
|
1011
|
-
descr: KrakenOpenOrderDescription;
|
|
1106
|
+
descr: KrakenOpenOrderDescription$1;
|
|
1012
1107
|
/** Volume of order (base currency) */
|
|
1013
1108
|
vol: string;
|
|
1014
1109
|
/** Volume executed (base currency) */
|
|
@@ -1030,7 +1125,7 @@ interface KrakenQueriedOrder {
|
|
|
1030
1125
|
* Price signal used to trigger stop/take-profit orders.
|
|
1031
1126
|
* If not set, "last" is implied.
|
|
1032
1127
|
*/
|
|
1033
|
-
trigger?: KrakenOrderTrigger;
|
|
1128
|
+
trigger?: KrakenOrderTrigger$1;
|
|
1034
1129
|
/**
|
|
1035
1130
|
* Indicates if the order is funded on margin.
|
|
1036
1131
|
* (Docs show boolean; union kept for API quirks.)
|
|
@@ -1059,8 +1154,8 @@ interface KrakenQueriedOrder {
|
|
|
1059
1154
|
reason?: string;
|
|
1060
1155
|
}
|
|
1061
1156
|
/** Map of txid -> queried order */
|
|
1062
|
-
type KrakenQueriedOrdersMap = Record<string, KrakenQueriedOrder>;
|
|
1063
|
-
interface KrakenGetOrdersInfoParams {
|
|
1157
|
+
type KrakenQueriedOrdersMap$1 = Record<string, KrakenQueriedOrder$1>;
|
|
1158
|
+
interface KrakenGetOrdersInfoParams$1 {
|
|
1064
1159
|
/**
|
|
1065
1160
|
* Whether or not to include trades related to position in output.
|
|
1066
1161
|
* Default on Kraken is false.
|
|
@@ -1088,17 +1183,17 @@ interface KrakenGetOrdersInfoParams {
|
|
|
1088
1183
|
*
|
|
1089
1184
|
* Default on Kraken is "rebased" if omitted.
|
|
1090
1185
|
*/
|
|
1091
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1186
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1092
1187
|
}
|
|
1093
1188
|
|
|
1094
|
-
type KrakenOrderAmendType = 'original' | 'user' | 'restated';
|
|
1189
|
+
type KrakenOrderAmendType$1 = 'original' | 'user' | 'restated';
|
|
1095
1190
|
/**
|
|
1096
1191
|
* Single amend entry in the audit trail.
|
|
1097
1192
|
*
|
|
1098
1193
|
* The first entry contains the original order parameters
|
|
1099
1194
|
* and has amend_type of "original".
|
|
1100
1195
|
*/
|
|
1101
|
-
interface KrakenOrderAmendEntry {
|
|
1196
|
+
interface KrakenOrderAmendEntry$1 {
|
|
1102
1197
|
/** Kraken amend identifier */
|
|
1103
1198
|
amend_id: string;
|
|
1104
1199
|
/**
|
|
@@ -1107,7 +1202,7 @@ interface KrakenOrderAmendEntry {
|
|
|
1107
1202
|
* - "user": user requested amendment
|
|
1108
1203
|
* - "restated": engine order maintenance amendment
|
|
1109
1204
|
*/
|
|
1110
|
-
amend_type: KrakenOrderAmendType;
|
|
1205
|
+
amend_type: KrakenOrderAmendType$1;
|
|
1111
1206
|
/** Order quantity in terms of the base asset */
|
|
1112
1207
|
order_qty: string;
|
|
1113
1208
|
/** Quantity shown in the book for iceberg orders */
|
|
@@ -1128,7 +1223,7 @@ interface KrakenOrderAmendEntry {
|
|
|
1128
1223
|
/**
|
|
1129
1224
|
* Full amend history result for an order.
|
|
1130
1225
|
*/
|
|
1131
|
-
interface KrakenOrderAmendsResult {
|
|
1226
|
+
interface KrakenOrderAmendsResult$1 {
|
|
1132
1227
|
/**
|
|
1133
1228
|
* Total count of new and amend transactions
|
|
1134
1229
|
* (includes the original order entry).
|
|
@@ -1137,9 +1232,9 @@ interface KrakenOrderAmendsResult {
|
|
|
1137
1232
|
/**
|
|
1138
1233
|
* List of amend transactions ordered by ascending amend timestamp.
|
|
1139
1234
|
*/
|
|
1140
|
-
amends: KrakenOrderAmendEntry[];
|
|
1235
|
+
amends: KrakenOrderAmendEntry$1[];
|
|
1141
1236
|
}
|
|
1142
|
-
interface KrakenGetOrderAmendsParams {
|
|
1237
|
+
interface KrakenGetOrderAmendsParams$1 {
|
|
1143
1238
|
/**
|
|
1144
1239
|
* The Kraken order identifier for the amended order.
|
|
1145
1240
|
*/
|
|
@@ -1152,7 +1247,7 @@ interface KrakenGetOrderAmendsParams {
|
|
|
1152
1247
|
*
|
|
1153
1248
|
* Default on Kraken is "rebased" if omitted.
|
|
1154
1249
|
*/
|
|
1155
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1250
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1156
1251
|
}
|
|
1157
1252
|
|
|
1158
1253
|
/**
|
|
@@ -1164,11 +1259,11 @@ interface KrakenGetOrderAmendsParams {
|
|
|
1164
1259
|
* - "closing position" : closing trades
|
|
1165
1260
|
* - "no position" : trades not opening/closing positions
|
|
1166
1261
|
*/
|
|
1167
|
-
type KrakenTradeHistoryTypeFilter = 'all' | 'any position' | 'closed position' | 'closing position' | 'no position';
|
|
1262
|
+
type KrakenTradeHistoryTypeFilter$1 = 'all' | 'any position' | 'closed position' | 'closing position' | 'no position';
|
|
1168
1263
|
/**
|
|
1169
1264
|
* Trade info as returned by TradesHistory.
|
|
1170
1265
|
*/
|
|
1171
|
-
interface KrakenTradeHistoryEntry {
|
|
1266
|
+
interface KrakenTradeHistoryEntry$1 {
|
|
1172
1267
|
/** Order responsible for execution of trade */
|
|
1173
1268
|
ordertxid: string;
|
|
1174
1269
|
/** Position responsible for execution of trade */
|
|
@@ -1178,9 +1273,9 @@ interface KrakenTradeHistoryEntry {
|
|
|
1178
1273
|
/** Unix timestamp of trade */
|
|
1179
1274
|
time: number;
|
|
1180
1275
|
/** Type of order (buy/sell) */
|
|
1181
|
-
type: KrakenOrderSide;
|
|
1276
|
+
type: KrakenOrderSide$1;
|
|
1182
1277
|
/** Order type (market, limit, etc.) */
|
|
1183
|
-
ordertype: KrakenOrderType;
|
|
1278
|
+
ordertype: KrakenOrderType$1;
|
|
1184
1279
|
/** Average price order was executed at (quote currency) */
|
|
1185
1280
|
price: string;
|
|
1186
1281
|
/** Total cost of order (quote currency) */
|
|
@@ -1251,22 +1346,22 @@ interface KrakenTradeHistoryEntry {
|
|
|
1251
1346
|
trades?: string[];
|
|
1252
1347
|
}
|
|
1253
1348
|
/** Map of trade ID (string key) -> trade entry */
|
|
1254
|
-
type KrakenTradeHistoryMap = Record<string, KrakenTradeHistoryEntry>;
|
|
1255
|
-
interface KrakenTradesHistoryResult {
|
|
1349
|
+
type KrakenTradeHistoryMap$1 = Record<string, KrakenTradeHistoryEntry$1>;
|
|
1350
|
+
interface KrakenTradesHistoryResult$1 {
|
|
1256
1351
|
/**
|
|
1257
1352
|
* Amount of available trades matching criteria.
|
|
1258
1353
|
* Used with `ofs` for pagination.
|
|
1259
1354
|
*/
|
|
1260
1355
|
count: number;
|
|
1261
1356
|
/** Trades keyed by internal trade ID */
|
|
1262
|
-
trades: KrakenTradeHistoryMap;
|
|
1357
|
+
trades: KrakenTradeHistoryMap$1;
|
|
1263
1358
|
}
|
|
1264
|
-
interface KrakenGetTradesHistoryParams {
|
|
1359
|
+
interface KrakenGetTradesHistoryParams$1 {
|
|
1265
1360
|
/**
|
|
1266
1361
|
* Type of trade filter.
|
|
1267
1362
|
* Default on Kraken is "all".
|
|
1268
1363
|
*/
|
|
1269
|
-
type?: KrakenTradeHistoryTypeFilter;
|
|
1364
|
+
type?: KrakenTradeHistoryTypeFilter$1;
|
|
1270
1365
|
/**
|
|
1271
1366
|
* Whether or not to include trades related to position in output.
|
|
1272
1367
|
* Default on Kraken is false.
|
|
@@ -1304,12 +1399,12 @@ interface KrakenGetTradesHistoryParams {
|
|
|
1304
1399
|
*
|
|
1305
1400
|
* Default on Kraken is "rebased" if omitted.
|
|
1306
1401
|
*/
|
|
1307
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1402
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1308
1403
|
}
|
|
1309
1404
|
|
|
1310
1405
|
/** Map of txid -> trade entry (same shape as TradesHistory) */
|
|
1311
|
-
type KrakenQueriedTradesMap = Record<string, KrakenTradeHistoryEntry>;
|
|
1312
|
-
interface KrakenGetTradesInfoParams {
|
|
1406
|
+
type KrakenQueriedTradesMap$1 = Record<string, KrakenTradeHistoryEntry$1>;
|
|
1407
|
+
interface KrakenGetTradesInfoParams$1 {
|
|
1313
1408
|
/**
|
|
1314
1409
|
* Comma-delimited list of transaction IDs to query info about,
|
|
1315
1410
|
* or an array of IDs (will be joined).
|
|
@@ -1329,32 +1424,32 @@ interface KrakenGetTradesInfoParams {
|
|
|
1329
1424
|
*
|
|
1330
1425
|
* Default on Kraken is "rebased" if omitted.
|
|
1331
1426
|
*/
|
|
1332
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1427
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1333
1428
|
}
|
|
1334
1429
|
|
|
1335
1430
|
/**
|
|
1336
1431
|
* Currently the only documented posstatus is "open",
|
|
1337
1432
|
* but keeping it as a string union in case Kraken extends it.
|
|
1338
1433
|
*/
|
|
1339
|
-
type KrakenPositionStatus = 'open';
|
|
1434
|
+
type KrakenPositionStatus$1 = 'open';
|
|
1340
1435
|
/**
|
|
1341
1436
|
* Single open margin position.
|
|
1342
1437
|
*
|
|
1343
1438
|
* If `docalcs=true`, `value` and `net` will be populated.
|
|
1344
1439
|
*/
|
|
1345
|
-
interface KrakenOpenPosition {
|
|
1440
|
+
interface KrakenOpenPosition$1 {
|
|
1346
1441
|
/** Order ID responsible for the position */
|
|
1347
1442
|
ordertxid: string;
|
|
1348
1443
|
/** Position status (currently only "open") */
|
|
1349
|
-
posstatus: KrakenPositionStatus;
|
|
1444
|
+
posstatus: KrakenPositionStatus$1;
|
|
1350
1445
|
/** Asset pair */
|
|
1351
1446
|
pair: string;
|
|
1352
1447
|
/** Unix timestamp of trade that opened the position */
|
|
1353
1448
|
time: number;
|
|
1354
1449
|
/** Direction (buy/sell) of position */
|
|
1355
|
-
type: KrakenOrderSide;
|
|
1450
|
+
type: KrakenOrderSide$1;
|
|
1356
1451
|
/** Order type used to open position */
|
|
1357
|
-
ordertype: KrakenOrderType;
|
|
1452
|
+
ordertype: KrakenOrderType$1;
|
|
1358
1453
|
/** Opening cost of position (quote currency) */
|
|
1359
1454
|
cost: string;
|
|
1360
1455
|
/** Opening fee of position (quote currency) */
|
|
@@ -1385,13 +1480,13 @@ interface KrakenOpenPosition {
|
|
|
1385
1480
|
oflags: string;
|
|
1386
1481
|
}
|
|
1387
1482
|
/** Map of position txid -> open position details */
|
|
1388
|
-
type KrakenOpenPositionsMap = Record<string, KrakenOpenPosition>;
|
|
1483
|
+
type KrakenOpenPositionsMap$1 = Record<string, KrakenOpenPosition$1>;
|
|
1389
1484
|
/**
|
|
1390
1485
|
* Consolidation mode.
|
|
1391
1486
|
* Currently only "market" is documented.
|
|
1392
1487
|
*/
|
|
1393
|
-
type KrakenOpenPositionsConsolidationMode = 'market';
|
|
1394
|
-
interface KrakenGetOpenPositionsParams {
|
|
1488
|
+
type KrakenOpenPositionsConsolidationMode$1 = 'market';
|
|
1489
|
+
interface KrakenGetOpenPositionsParams$1 {
|
|
1395
1490
|
/**
|
|
1396
1491
|
* Comma-delimited list of txids to limit output to,
|
|
1397
1492
|
* or an array of txids. Optional: if omitted, returns all.
|
|
@@ -1406,7 +1501,7 @@ interface KrakenGetOpenPositionsParams {
|
|
|
1406
1501
|
* Consolidate positions by market/pair.
|
|
1407
1502
|
* Currently only "market" is supported.
|
|
1408
1503
|
*/
|
|
1409
|
-
consolidation?: KrakenOpenPositionsConsolidationMode;
|
|
1504
|
+
consolidation?: KrakenOpenPositionsConsolidationMode$1;
|
|
1410
1505
|
/**
|
|
1411
1506
|
* Optional parameter for viewing xstocks data.
|
|
1412
1507
|
*
|
|
@@ -1415,28 +1510,28 @@ interface KrakenGetOpenPositionsParams {
|
|
|
1415
1510
|
*
|
|
1416
1511
|
* Default on Kraken is "rebased" if omitted.
|
|
1417
1512
|
*/
|
|
1418
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1513
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1419
1514
|
}
|
|
1420
1515
|
|
|
1421
1516
|
/**
|
|
1422
1517
|
* Ledger type filter for LedgersInfo.
|
|
1423
1518
|
*/
|
|
1424
|
-
type KrakenLedgerTypeFilter = 'all' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'credit' | 'settled' | 'staking' | 'dividend' | 'sale' | 'nft_rebate';
|
|
1519
|
+
type KrakenLedgerTypeFilter$1 = 'all' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'credit' | 'settled' | 'staking' | 'dividend' | 'sale' | 'nft_rebate';
|
|
1425
1520
|
/**
|
|
1426
1521
|
* Actual ledger entry type as returned by the API.
|
|
1427
1522
|
* (This can be larger than the filter set.)
|
|
1428
1523
|
*/
|
|
1429
|
-
type KrakenLedgerEntryType = 'none' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'spend' | 'receive' | 'settled' | 'credit' | 'staking' | 'reward' | 'dividend' | 'sale' | 'conversion' | 'nfttrade' | 'nftcreatorfee' | 'nftrebate' | 'custodytransfer';
|
|
1524
|
+
type KrakenLedgerEntryType$1 = 'none' | 'trade' | 'deposit' | 'withdrawal' | 'transfer' | 'margin' | 'adjustment' | 'rollover' | 'spend' | 'receive' | 'settled' | 'credit' | 'staking' | 'reward' | 'dividend' | 'sale' | 'conversion' | 'nfttrade' | 'nftcreatorfee' | 'nftrebate' | 'custodytransfer';
|
|
1430
1525
|
/**
|
|
1431
1526
|
* Single ledger entry.
|
|
1432
1527
|
*/
|
|
1433
|
-
interface KrakenLedgerEntry {
|
|
1528
|
+
interface KrakenLedgerEntry$1 {
|
|
1434
1529
|
/** Reference ID of the parent transaction (trade, deposit, withdrawal, etc.) */
|
|
1435
1530
|
refid: string;
|
|
1436
1531
|
/** Unix timestamp of ledger entry */
|
|
1437
1532
|
time: number;
|
|
1438
1533
|
/** Type of ledger entry */
|
|
1439
|
-
type: KrakenLedgerEntryType;
|
|
1534
|
+
type: KrakenLedgerEntryType$1;
|
|
1440
1535
|
/** Additional info relating to the ledger entry type, where applicable */
|
|
1441
1536
|
subtype: string;
|
|
1442
1537
|
/** Asset class */
|
|
@@ -1451,17 +1546,17 @@ interface KrakenLedgerEntry {
|
|
|
1451
1546
|
balance: string;
|
|
1452
1547
|
}
|
|
1453
1548
|
/** Map of ledger ID -> ledger entry */
|
|
1454
|
-
type KrakenLedgerMap = Record<string, KrakenLedgerEntry>;
|
|
1455
|
-
interface KrakenLedgersInfoResult {
|
|
1549
|
+
type KrakenLedgerMap$1 = Record<string, KrakenLedgerEntry$1>;
|
|
1550
|
+
interface KrakenLedgersInfoResult$1 {
|
|
1456
1551
|
/** Ledger entries keyed by ledger ID */
|
|
1457
|
-
ledger: KrakenLedgerMap;
|
|
1552
|
+
ledger: KrakenLedgerMap$1;
|
|
1458
1553
|
/**
|
|
1459
1554
|
* Amount of available ledger info matching criteria.
|
|
1460
1555
|
* May be omitted if `without_count=true`.
|
|
1461
1556
|
*/
|
|
1462
1557
|
count?: number;
|
|
1463
1558
|
}
|
|
1464
|
-
interface KrakenGetLedgersInfoParams {
|
|
1559
|
+
interface KrakenGetLedgersInfoParams$1 {
|
|
1465
1560
|
/**
|
|
1466
1561
|
* Filter output by asset or list of assets.
|
|
1467
1562
|
* e.g. "ZUSD" or ["ZUSD", "XXBT", "USDT.F"].
|
|
@@ -1477,7 +1572,7 @@ interface KrakenGetLedgersInfoParams {
|
|
|
1477
1572
|
* Type of ledger entries to retrieve.
|
|
1478
1573
|
* Default on Kraken is "all".
|
|
1479
1574
|
*/
|
|
1480
|
-
type?: KrakenLedgerTypeFilter;
|
|
1575
|
+
type?: KrakenLedgerTypeFilter$1;
|
|
1481
1576
|
/**
|
|
1482
1577
|
* Starting unix timestamp or ledger ID of results (exclusive).
|
|
1483
1578
|
*/
|
|
@@ -1504,10 +1599,12 @@ interface KrakenGetLedgersInfoParams {
|
|
|
1504
1599
|
*
|
|
1505
1600
|
* Default on Kraken is "rebased" if omitted.
|
|
1506
1601
|
*/
|
|
1507
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1602
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1508
1603
|
}
|
|
1509
1604
|
|
|
1510
|
-
|
|
1605
|
+
/** Map of ledger ID -> ledger entry (same shape as LedgersInfo) */
|
|
1606
|
+
type KrakenQueriedLedgersMap$1 = KrakenLedgerMap$1;
|
|
1607
|
+
interface KrakenGetLedgersQueryParams$1 {
|
|
1511
1608
|
/**
|
|
1512
1609
|
* Comma-delimited list of ledger IDs to query info about (20 maximum),
|
|
1513
1610
|
* or an array of IDs (will be joined).
|
|
@@ -1526,13 +1623,13 @@ interface KrakenGetLedgersQueryParams {
|
|
|
1526
1623
|
*
|
|
1527
1624
|
* Default on Kraken is "rebased" if omitted.
|
|
1528
1625
|
*/
|
|
1529
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1626
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1530
1627
|
}
|
|
1531
1628
|
|
|
1532
1629
|
/**
|
|
1533
1630
|
* Fee tier info for a single pair (taker or maker side).
|
|
1534
1631
|
*/
|
|
1535
|
-
interface KrakenFeeTierInfo {
|
|
1632
|
+
interface KrakenFeeTierInfo$1 {
|
|
1536
1633
|
/** Current fee (in percent) */
|
|
1537
1634
|
fee: string;
|
|
1538
1635
|
/** Minimum fee for pair (if not fixed fee) */
|
|
@@ -1556,11 +1653,11 @@ interface KrakenFeeTierInfo {
|
|
|
1556
1653
|
next_volume: string | null;
|
|
1557
1654
|
}
|
|
1558
1655
|
/** Map of asset pair -> fee tier info */
|
|
1559
|
-
type KrakenTradeVolumeFeesMap = Record<string, KrakenFeeTierInfo>;
|
|
1656
|
+
type KrakenTradeVolumeFeesMap$1 = Record<string, KrakenFeeTierInfo$1>;
|
|
1560
1657
|
/**
|
|
1561
1658
|
* Trade volume + fee schedule result.
|
|
1562
1659
|
*/
|
|
1563
|
-
interface KrakenTradeVolumeResult {
|
|
1660
|
+
interface KrakenTradeVolumeResult$1 {
|
|
1564
1661
|
/**
|
|
1565
1662
|
* Fee volume currency (will always be USD according to docs).
|
|
1566
1663
|
*/
|
|
@@ -1574,15 +1671,15 @@ interface KrakenTradeVolumeResult {
|
|
|
1574
1671
|
* Taker fees applied for each pair included in the request.
|
|
1575
1672
|
* Default is missing / empty if no pairs were requested.
|
|
1576
1673
|
*/
|
|
1577
|
-
fees?: KrakenTradeVolumeFeesMap;
|
|
1674
|
+
fees?: KrakenTradeVolumeFeesMap$1;
|
|
1578
1675
|
/**
|
|
1579
1676
|
* Maker fees applied for each pair included in the request
|
|
1580
1677
|
* (only for maker/taker pairs).
|
|
1581
1678
|
* Default is missing / empty if no pairs were requested.
|
|
1582
1679
|
*/
|
|
1583
|
-
fees_maker?: KrakenTradeVolumeFeesMap;
|
|
1680
|
+
fees_maker?: KrakenTradeVolumeFeesMap$1;
|
|
1584
1681
|
}
|
|
1585
|
-
interface KrakenGetTradeVolumeParams {
|
|
1682
|
+
interface KrakenGetTradeVolumeParams$1 {
|
|
1586
1683
|
/**
|
|
1587
1684
|
* Comma-delimited list of asset pairs to get fee info on,
|
|
1588
1685
|
* or an array of pairs.
|
|
@@ -1598,23 +1695,23 @@ interface KrakenGetTradeVolumeParams {
|
|
|
1598
1695
|
*
|
|
1599
1696
|
* Default on Kraken is "rebased" if omitted.
|
|
1600
1697
|
*/
|
|
1601
|
-
rebase_multiplier?: KrakenRebaseMultiplier$
|
|
1698
|
+
rebase_multiplier?: KrakenRebaseMultiplier$2;
|
|
1602
1699
|
}
|
|
1603
1700
|
|
|
1604
|
-
type KrakenExportReportType = 'trades' | 'ledgers';
|
|
1605
|
-
type KrakenExportReportFormat = 'CSV' | 'TSV';
|
|
1606
|
-
interface KrakenRequestExportReportParams {
|
|
1701
|
+
type KrakenExportReportType$1 = 'trades' | 'ledgers';
|
|
1702
|
+
type KrakenExportReportFormat$1 = 'CSV' | 'TSV';
|
|
1703
|
+
interface KrakenRequestExportReportParams$1 {
|
|
1607
1704
|
/**
|
|
1608
1705
|
* Type of data to export.
|
|
1609
1706
|
* - "trades"
|
|
1610
1707
|
* - "ledgers"
|
|
1611
1708
|
*/
|
|
1612
|
-
report: KrakenExportReportType;
|
|
1709
|
+
report: KrakenExportReportType$1;
|
|
1613
1710
|
/**
|
|
1614
1711
|
* File format to export.
|
|
1615
1712
|
* Default on Kraken is "CSV" if omitted.
|
|
1616
1713
|
*/
|
|
1617
|
-
format?: KrakenExportReportFormat;
|
|
1714
|
+
format?: KrakenExportReportFormat$1;
|
|
1618
1715
|
/**
|
|
1619
1716
|
* Description for the export (required by API).
|
|
1620
1717
|
*/
|
|
@@ -1647,7 +1744,7 @@ interface KrakenRequestExportReportParams {
|
|
|
1647
1744
|
/**
|
|
1648
1745
|
* Response payload when requesting an export.
|
|
1649
1746
|
*/
|
|
1650
|
-
interface KrakenRequestExportReportResult {
|
|
1747
|
+
interface KrakenRequestExportReportResult$1 {
|
|
1651
1748
|
/** Report ID assigned by Kraken */
|
|
1652
1749
|
id: string;
|
|
1653
1750
|
}
|
|
@@ -1655,8 +1752,8 @@ interface KrakenRequestExportReportResult {
|
|
|
1655
1752
|
/**
|
|
1656
1753
|
* Status of a single export report.
|
|
1657
1754
|
*/
|
|
1658
|
-
type KrakenExportReportStatusState = 'Queued' | 'Processing' | 'Processed';
|
|
1659
|
-
interface KrakenExportReportStatus {
|
|
1755
|
+
type KrakenExportReportStatusState$1 = 'Queued' | 'Processing' | 'Processed';
|
|
1756
|
+
interface KrakenExportReportStatus$1 {
|
|
1660
1757
|
/** Report ID */
|
|
1661
1758
|
id: string;
|
|
1662
1759
|
/** Description provided when the export was requested */
|
|
@@ -1664,11 +1761,11 @@ interface KrakenExportReportStatus {
|
|
|
1664
1761
|
/** File format (CSV or TSV) */
|
|
1665
1762
|
format: string;
|
|
1666
1763
|
/** Report type ("trades" or "ledgers") */
|
|
1667
|
-
report: KrakenExportReportType;
|
|
1764
|
+
report: KrakenExportReportType$1;
|
|
1668
1765
|
/** Subtype (not well-documented; keep as string) */
|
|
1669
1766
|
subtype: string;
|
|
1670
1767
|
/** Status of the report */
|
|
1671
|
-
status: KrakenExportReportStatusState;
|
|
1768
|
+
status: KrakenExportReportStatusState$1;
|
|
1672
1769
|
/** Deprecated flags field */
|
|
1673
1770
|
flags?: string;
|
|
1674
1771
|
/** Comma-delimited list of fields included in the report */
|
|
@@ -1693,32 +1790,39 @@ interface KrakenExportReportStatus {
|
|
|
1693
1790
|
/**
|
|
1694
1791
|
* Request parameters for ExportStatus.
|
|
1695
1792
|
*/
|
|
1696
|
-
interface KrakenGetExportReportStatusParams {
|
|
1793
|
+
interface KrakenGetExportReportStatusParams$1 {
|
|
1697
1794
|
/**
|
|
1698
1795
|
* Type of reports to inquire about.
|
|
1699
1796
|
* - "trades"
|
|
1700
1797
|
* - "ledgers"
|
|
1701
1798
|
*/
|
|
1702
|
-
report: KrakenExportReportType;
|
|
1799
|
+
report: KrakenExportReportType$1;
|
|
1703
1800
|
}
|
|
1704
1801
|
|
|
1705
1802
|
/**
|
|
1706
1803
|
* Params for RetrieveExport.
|
|
1707
1804
|
*/
|
|
1708
|
-
interface KrakenRetrieveExportParams {
|
|
1805
|
+
interface KrakenRetrieveExportParams$1 {
|
|
1709
1806
|
/**
|
|
1710
1807
|
* Report ID to retrieve (from AddExport / ExportStatus).
|
|
1711
1808
|
*/
|
|
1712
1809
|
id: string;
|
|
1713
1810
|
}
|
|
1811
|
+
/**
|
|
1812
|
+
* Result of RetrieveExport.
|
|
1813
|
+
*
|
|
1814
|
+
* We return raw binary (ZIP archive). You can wrap/convert this to
|
|
1815
|
+
* Buffer, write to disk, etc., in your calling code.
|
|
1816
|
+
*/
|
|
1817
|
+
type KrakenRetrieveExportResult$1 = ArrayBuffer;
|
|
1714
1818
|
|
|
1715
1819
|
/**
|
|
1716
1820
|
* Operation to perform on the export report:
|
|
1717
1821
|
* - "cancel": for queued or processing reports
|
|
1718
1822
|
* - "delete": for already processed reports
|
|
1719
1823
|
*/
|
|
1720
|
-
type KrakenDeleteExportReportType = 'cancel' | 'delete';
|
|
1721
|
-
interface KrakenDeleteExportReportParams {
|
|
1824
|
+
type KrakenDeleteExportReportType$1 = 'cancel' | 'delete';
|
|
1825
|
+
interface KrakenDeleteExportReportParams$1 {
|
|
1722
1826
|
/**
|
|
1723
1827
|
* ID of report to delete or cancel.
|
|
1724
1828
|
*/
|
|
@@ -1728,9 +1832,9 @@ interface KrakenDeleteExportReportParams {
|
|
|
1728
1832
|
* - "cancel" for queued/processing reports
|
|
1729
1833
|
* - "delete" for processed reports
|
|
1730
1834
|
*/
|
|
1731
|
-
type: KrakenDeleteExportReportType;
|
|
1835
|
+
type: KrakenDeleteExportReportType$1;
|
|
1732
1836
|
}
|
|
1733
|
-
interface KrakenDeleteExportReportResult {
|
|
1837
|
+
interface KrakenDeleteExportReportResult$1 {
|
|
1734
1838
|
/**
|
|
1735
1839
|
* Whether deletion was successful.
|
|
1736
1840
|
* Only meaningful when `type = "delete"`.
|
|
@@ -1755,7 +1859,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1755
1859
|
* console.log("USD balance:", balances["ZUSD"]);
|
|
1756
1860
|
* console.log("BTC balance:", balances["XXBT"]);
|
|
1757
1861
|
*/
|
|
1758
|
-
getAccountBalance(params?: KrakenGetAccountBalanceParams): Promise<KrakenAccountBalanceMap>;
|
|
1862
|
+
getAccountBalance(params?: KrakenGetAccountBalanceParams$1): Promise<KrakenAccountBalanceMap$1>;
|
|
1759
1863
|
/**
|
|
1760
1864
|
* Retrieve extended balances for all assets, including credit and held amounts.
|
|
1761
1865
|
*
|
|
@@ -1772,7 +1876,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1772
1876
|
* Number(usd.credit_used) -
|
|
1773
1877
|
* Number(usd.hold_trade);
|
|
1774
1878
|
*/
|
|
1775
|
-
getExtendedBalance(params?: KrakenGetExtendedBalanceParams): Promise<KrakenExtendedBalanceMap>;
|
|
1879
|
+
getExtendedBalance(params?: KrakenGetExtendedBalanceParams$1): Promise<KrakenExtendedBalanceMap$1>;
|
|
1776
1880
|
/**
|
|
1777
1881
|
* Retrieve all credit line details for the account (if any).
|
|
1778
1882
|
*
|
|
@@ -1792,7 +1896,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1792
1896
|
* console.log("Total credit (USD):", monitor.total_credit_usd);
|
|
1793
1897
|
* }
|
|
1794
1898
|
*/
|
|
1795
|
-
getCreditLines(params?: KrakenGetCreditLinesParams): Promise<KrakenCreditLinesResponse>;
|
|
1899
|
+
getCreditLines(params?: KrakenGetCreditLinesParams$1): Promise<KrakenCreditLinesResponse$1>;
|
|
1796
1900
|
/**
|
|
1797
1901
|
* Retrieve a summary of collateral balances, margin position valuations,
|
|
1798
1902
|
* equity and margin level.
|
|
@@ -1804,7 +1908,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1804
1908
|
* console.log("Free margin (mf):", tb.mf);
|
|
1805
1909
|
* console.log("Margin level (ml):", tb.ml);
|
|
1806
1910
|
*/
|
|
1807
|
-
getTradeBalance(params?: KrakenGetTradeBalanceParams): Promise<KrakenTradeBalanceResult>;
|
|
1911
|
+
getTradeBalance(params?: KrakenGetTradeBalanceParams$1): Promise<KrakenTradeBalanceResult$1>;
|
|
1808
1912
|
/**
|
|
1809
1913
|
* Retrieve information about currently open orders.
|
|
1810
1914
|
*
|
|
@@ -1817,7 +1921,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1817
1921
|
* console.log(orderId, order.status, order.descr.order, order.vol, order.vol_exec);
|
|
1818
1922
|
* }
|
|
1819
1923
|
*/
|
|
1820
|
-
getOpenOrders(params?: KrakenGetOpenOrdersParams): Promise<KrakenOpenOrdersResult>;
|
|
1924
|
+
getOpenOrders(params?: KrakenGetOpenOrdersParams$1): Promise<KrakenOpenOrdersResult$1>;
|
|
1821
1925
|
/**
|
|
1822
1926
|
* Retrieve information about orders that have been closed
|
|
1823
1927
|
* (filled or cancelled). 50 results are returned at a time,
|
|
@@ -1840,7 +1944,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1840
1944
|
* );
|
|
1841
1945
|
* }
|
|
1842
1946
|
*/
|
|
1843
|
-
getClosedOrders(params?: KrakenGetClosedOrdersParams): Promise<KrakenClosedOrdersResult>;
|
|
1947
|
+
getClosedOrders(params?: KrakenGetClosedOrdersParams$1): Promise<KrakenClosedOrdersResult$1>;
|
|
1844
1948
|
/**
|
|
1845
1949
|
* Retrieve information about specific orders by txid.
|
|
1846
1950
|
*
|
|
@@ -1860,7 +1964,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1860
1964
|
* );
|
|
1861
1965
|
* }
|
|
1862
1966
|
*/
|
|
1863
|
-
queryOrdersInfo(params: KrakenGetOrdersInfoParams): Promise<KrakenQueriedOrdersMap>;
|
|
1967
|
+
queryOrdersInfo(params: KrakenGetOrdersInfoParams$1): Promise<KrakenQueriedOrdersMap$1>;
|
|
1864
1968
|
/**
|
|
1865
1969
|
* Retrieve the amend history (audit trail) for a specific order.
|
|
1866
1970
|
*
|
|
@@ -1882,7 +1986,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1882
1986
|
* );
|
|
1883
1987
|
* }
|
|
1884
1988
|
*/
|
|
1885
|
-
getOrderAmends(params: KrakenGetOrderAmendsParams): Promise<KrakenOrderAmendsResult>;
|
|
1989
|
+
getOrderAmends(params: KrakenGetOrderAmendsParams$1): Promise<KrakenOrderAmendsResult$1>;
|
|
1886
1990
|
/**
|
|
1887
1991
|
* Retrieve information about trades / fills.
|
|
1888
1992
|
* 50 results are returned at a time, most recent by default.
|
|
@@ -1906,7 +2010,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1906
2010
|
* );
|
|
1907
2011
|
* }
|
|
1908
2012
|
*/
|
|
1909
|
-
getTradesHistory(params?: KrakenGetTradesHistoryParams): Promise<KrakenTradesHistoryResult>;
|
|
2013
|
+
getTradesHistory(params?: KrakenGetTradesHistoryParams$1): Promise<KrakenTradesHistoryResult$1>;
|
|
1910
2014
|
/**
|
|
1911
2015
|
* Retrieve information about specific trades/fills by txid.
|
|
1912
2016
|
*
|
|
@@ -1927,7 +2031,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1927
2031
|
* );
|
|
1928
2032
|
* }
|
|
1929
2033
|
*/
|
|
1930
|
-
queryTradesInfo(params: KrakenGetTradesInfoParams): Promise<KrakenQueriedTradesMap>;
|
|
2034
|
+
queryTradesInfo(params: KrakenGetTradesInfoParams$1): Promise<KrakenQueriedTradesMap$1>;
|
|
1931
2035
|
/**
|
|
1932
2036
|
* Get information about open margin positions.
|
|
1933
2037
|
*
|
|
@@ -1948,7 +2052,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1948
2052
|
* );
|
|
1949
2053
|
* }
|
|
1950
2054
|
*/
|
|
1951
|
-
getOpenPositions(params?: KrakenGetOpenPositionsParams): Promise<KrakenOpenPositionsMap>;
|
|
2055
|
+
getOpenPositions(params?: KrakenGetOpenPositionsParams$1): Promise<KrakenOpenPositionsMap$1>;
|
|
1952
2056
|
/**
|
|
1953
2057
|
* Retrieve information about ledger entries.
|
|
1954
2058
|
* 50 results are returned at a time, most recent by default.
|
|
@@ -1972,7 +2076,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1972
2076
|
* );
|
|
1973
2077
|
* }
|
|
1974
2078
|
*/
|
|
1975
|
-
getLedgersInfo(params?: KrakenGetLedgersInfoParams): Promise<KrakenLedgersInfoResult>;
|
|
2079
|
+
getLedgersInfo(params?: KrakenGetLedgersInfoParams$1): Promise<KrakenLedgersInfoResult$1>;
|
|
1976
2080
|
/**
|
|
1977
2081
|
* Retrieve information about specific ledger entries by ID.
|
|
1978
2082
|
*
|
|
@@ -1992,7 +2096,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
1992
2096
|
* );
|
|
1993
2097
|
* }
|
|
1994
2098
|
*/
|
|
1995
|
-
queryLedgers(params: KrakenGetLedgersQueryParams): Promise<KrakenLedgerMap>;
|
|
2099
|
+
queryLedgers(params: KrakenGetLedgersQueryParams$1): Promise<KrakenLedgerMap$1>;
|
|
1996
2100
|
/**
|
|
1997
2101
|
* Get 30-day USD trading volume and resulting fee schedule.
|
|
1998
2102
|
*
|
|
@@ -2011,7 +2115,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
2011
2115
|
* console.log("XBTUSD taker fee:", xbtFees.fee);
|
|
2012
2116
|
* }
|
|
2013
2117
|
*/
|
|
2014
|
-
getTradeVolume(params?: KrakenGetTradeVolumeParams): Promise<KrakenTradeVolumeResult>;
|
|
2118
|
+
getTradeVolume(params?: KrakenGetTradeVolumeParams$1): Promise<KrakenTradeVolumeResult$1>;
|
|
2015
2119
|
/**
|
|
2016
2120
|
* Request an export report for trades or ledgers.
|
|
2017
2121
|
*
|
|
@@ -2031,7 +2135,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
2031
2135
|
*
|
|
2032
2136
|
* console.log("Export report ID:", id);
|
|
2033
2137
|
*/
|
|
2034
|
-
requestExportReport(params: KrakenRequestExportReportParams): Promise<KrakenRequestExportReportResult>;
|
|
2138
|
+
requestExportReport(params: KrakenRequestExportReportParams$1): Promise<KrakenRequestExportReportResult$1>;
|
|
2035
2139
|
/**
|
|
2036
2140
|
* Get status of requested export reports (trades or ledgers).
|
|
2037
2141
|
*
|
|
@@ -2050,7 +2154,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
2050
2154
|
* );
|
|
2051
2155
|
* }
|
|
2052
2156
|
*/
|
|
2053
|
-
getExportReportStatus(params: KrakenGetExportReportStatusParams): Promise<KrakenExportReportStatus[]>;
|
|
2157
|
+
getExportReportStatus(params: KrakenGetExportReportStatusParams$1): Promise<KrakenExportReportStatus$1[]>;
|
|
2054
2158
|
/**
|
|
2055
2159
|
* Retrieve a processed data export as a ZIP archive (binary).
|
|
2056
2160
|
*
|
|
@@ -2062,7 +2166,7 @@ declare class KrakenSpotAccountDataApi {
|
|
|
2062
2166
|
* // In Node, for example:
|
|
2063
2167
|
* // await fs.promises.writeFile("export.zip", Buffer.from(zipBytes));
|
|
2064
2168
|
*/
|
|
2065
|
-
retrieveExportReport(params: KrakenRetrieveExportParams): Promise<ArrayBuffer>;
|
|
2169
|
+
retrieveExportReport(params: KrakenRetrieveExportParams$1): Promise<ArrayBuffer>;
|
|
2066
2170
|
/**
|
|
2067
2171
|
* Delete or cancel an export report.
|
|
2068
2172
|
*
|
|
@@ -2077,11 +2181,82 @@ declare class KrakenSpotAccountDataApi {
|
|
|
2077
2181
|
*
|
|
2078
2182
|
* console.log("cancel success:", result.cancel);
|
|
2079
2183
|
*/
|
|
2080
|
-
deleteExportReport(params: KrakenDeleteExportReportParams): Promise<KrakenDeleteExportReportResult>;
|
|
2081
|
-
}
|
|
2184
|
+
deleteExportReport(params: KrakenDeleteExportReportParams$1): Promise<KrakenDeleteExportReportResult$1>;
|
|
2185
|
+
}
|
|
2186
|
+
type KrakenRebaseMultiplier$1 = KrakenRebaseMultiplier$2;
|
|
2187
|
+
type KrakenAccountBalanceMap = KrakenAccountBalanceMap$1;
|
|
2188
|
+
type KrakenGetAccountBalanceParams = KrakenGetAccountBalanceParams$1;
|
|
2189
|
+
type KrakenExtendedBalanceEntry = KrakenExtendedBalanceEntry$1;
|
|
2190
|
+
type KrakenExtendedBalanceMap = KrakenExtendedBalanceMap$1;
|
|
2191
|
+
type KrakenGetExtendedBalanceParams = KrakenGetExtendedBalanceParams$1;
|
|
2192
|
+
type KrakenCreditLinesAssetEntry = KrakenCreditLinesAssetEntry$1;
|
|
2193
|
+
type KrakenCreditLinesAssetMap = KrakenCreditLinesAssetMap$1;
|
|
2194
|
+
type KrakenCreditLinesLimitsMonitor = KrakenCreditLinesLimitsMonitor$1;
|
|
2195
|
+
type KrakenCreditLinesResult = KrakenCreditLinesResult$1;
|
|
2196
|
+
type KrakenCreditLinesResponse = KrakenCreditLinesResponse$1;
|
|
2197
|
+
type KrakenGetCreditLinesParams = KrakenGetCreditLinesParams$1;
|
|
2198
|
+
type KrakenTradeBalanceResult = KrakenTradeBalanceResult$1;
|
|
2199
|
+
type KrakenGetTradeBalanceParams = KrakenGetTradeBalanceParams$1;
|
|
2200
|
+
type KrakenOrderStatus = KrakenOrderStatus$1;
|
|
2201
|
+
type KrakenOrderSide = KrakenOrderSide$1;
|
|
2202
|
+
type KrakenOrderType = KrakenOrderType$1;
|
|
2203
|
+
type KrakenOrderTrigger = KrakenOrderTrigger$1;
|
|
2204
|
+
type KrakenOpenOrderDescription = KrakenOpenOrderDescription$1;
|
|
2205
|
+
type KrakenOpenOrder = KrakenOpenOrder$1;
|
|
2206
|
+
type KrakenOpenOrdersMap = KrakenOpenOrdersMap$1;
|
|
2207
|
+
type KrakenOpenOrdersResult = KrakenOpenOrdersResult$1;
|
|
2208
|
+
type KrakenGetOpenOrdersParams = KrakenGetOpenOrdersParams$1;
|
|
2209
|
+
type KrakenClosedOrder = KrakenClosedOrder$1;
|
|
2210
|
+
type KrakenClosedOrdersMap = KrakenClosedOrdersMap$1;
|
|
2211
|
+
type KrakenClosedOrdersResult = KrakenClosedOrdersResult$1;
|
|
2212
|
+
type KrakenClosedOrdersCloseTime = KrakenClosedOrdersCloseTime$1;
|
|
2213
|
+
type KrakenGetClosedOrdersParams = KrakenGetClosedOrdersParams$1;
|
|
2214
|
+
type KrakenQueriedOrder = KrakenQueriedOrder$1;
|
|
2215
|
+
type KrakenQueriedOrdersMap = KrakenQueriedOrdersMap$1;
|
|
2216
|
+
type KrakenGetOrdersInfoParams = KrakenGetOrdersInfoParams$1;
|
|
2217
|
+
type KrakenOrderAmendType = KrakenOrderAmendType$1;
|
|
2218
|
+
type KrakenOrderAmendEntry = KrakenOrderAmendEntry$1;
|
|
2219
|
+
type KrakenOrderAmendsResult = KrakenOrderAmendsResult$1;
|
|
2220
|
+
type KrakenGetOrderAmendsParams = KrakenGetOrderAmendsParams$1;
|
|
2221
|
+
type KrakenTradeHistoryTypeFilter = KrakenTradeHistoryTypeFilter$1;
|
|
2222
|
+
type KrakenTradeHistoryEntry = KrakenTradeHistoryEntry$1;
|
|
2223
|
+
type KrakenTradeHistoryMap = KrakenTradeHistoryMap$1;
|
|
2224
|
+
type KrakenTradesHistoryResult = KrakenTradesHistoryResult$1;
|
|
2225
|
+
type KrakenGetTradesHistoryParams = KrakenGetTradesHistoryParams$1;
|
|
2226
|
+
type KrakenQueriedTradesMap = KrakenQueriedTradesMap$1;
|
|
2227
|
+
type KrakenGetTradesInfoParams = KrakenGetTradesInfoParams$1;
|
|
2228
|
+
type KrakenPositionStatus = KrakenPositionStatus$1;
|
|
2229
|
+
type KrakenOpenPosition = KrakenOpenPosition$1;
|
|
2230
|
+
type KrakenOpenPositionsMap = KrakenOpenPositionsMap$1;
|
|
2231
|
+
type KrakenOpenPositionsConsolidationMode = KrakenOpenPositionsConsolidationMode$1;
|
|
2232
|
+
type KrakenGetOpenPositionsParams = KrakenGetOpenPositionsParams$1;
|
|
2233
|
+
type KrakenLedgerTypeFilter = KrakenLedgerTypeFilter$1;
|
|
2234
|
+
type KrakenLedgerEntryType = KrakenLedgerEntryType$1;
|
|
2235
|
+
type KrakenLedgerEntry = KrakenLedgerEntry$1;
|
|
2236
|
+
type KrakenLedgerMap = KrakenLedgerMap$1;
|
|
2237
|
+
type KrakenLedgersInfoResult = KrakenLedgersInfoResult$1;
|
|
2238
|
+
type KrakenGetLedgersInfoParams = KrakenGetLedgersInfoParams$1;
|
|
2239
|
+
type KrakenQueriedLedgersMap = KrakenQueriedLedgersMap$1;
|
|
2240
|
+
type KrakenGetLedgersQueryParams = KrakenGetLedgersQueryParams$1;
|
|
2241
|
+
type KrakenFeeTierInfo = KrakenFeeTierInfo$1;
|
|
2242
|
+
type KrakenTradeVolumeFeesMap = KrakenTradeVolumeFeesMap$1;
|
|
2243
|
+
type KrakenTradeVolumeResult = KrakenTradeVolumeResult$1;
|
|
2244
|
+
type KrakenGetTradeVolumeParams = KrakenGetTradeVolumeParams$1;
|
|
2245
|
+
type KrakenExportReportType = KrakenExportReportType$1;
|
|
2246
|
+
type KrakenExportReportFormat = KrakenExportReportFormat$1;
|
|
2247
|
+
type KrakenRequestExportReportParams = KrakenRequestExportReportParams$1;
|
|
2248
|
+
type KrakenRequestExportReportResult = KrakenRequestExportReportResult$1;
|
|
2249
|
+
type KrakenExportReportStatusState = KrakenExportReportStatusState$1;
|
|
2250
|
+
type KrakenExportReportStatus = KrakenExportReportStatus$1;
|
|
2251
|
+
type KrakenGetExportReportStatusParams = KrakenGetExportReportStatusParams$1;
|
|
2252
|
+
type KrakenRetrieveExportParams = KrakenRetrieveExportParams$1;
|
|
2253
|
+
type KrakenRetrieveExportResult = KrakenRetrieveExportResult$1;
|
|
2254
|
+
type KrakenDeleteExportReportType = KrakenDeleteExportReportType$1;
|
|
2255
|
+
type KrakenDeleteExportReportParams = KrakenDeleteExportReportParams$1;
|
|
2256
|
+
type KrakenDeleteExportReportResult = KrakenDeleteExportReportResult$1;
|
|
2082
2257
|
|
|
2083
|
-
type KrakenAddOrderTimeInForce = 'GTC' | 'IOC' | 'GTD';
|
|
2084
|
-
type KrakenAddOrderStpType = 'cancel-newest' | 'cancel-oldest' | 'cancel-both';
|
|
2258
|
+
type KrakenAddOrderTimeInForce$1 = 'GTC' | 'IOC' | 'GTD';
|
|
2259
|
+
type KrakenAddOrderStpType$1 = 'cancel-newest' | 'cancel-oldest' | 'cancel-both';
|
|
2085
2260
|
/**
|
|
2086
2261
|
* Conditional close order parameters.
|
|
2087
2262
|
*
|
|
@@ -2095,13 +2270,13 @@ interface KrakenAddOrderCloseParams {
|
|
|
2095
2270
|
* Conditional close order type.
|
|
2096
2271
|
* Docs list a subset, but we reuse KrakenOrderType for now.
|
|
2097
2272
|
*/
|
|
2098
|
-
ordertype: KrakenOrderType;
|
|
2273
|
+
ordertype: KrakenOrderType$1;
|
|
2099
2274
|
/** Conditional close order price */
|
|
2100
2275
|
price?: string;
|
|
2101
2276
|
/** Conditional close order secondary price */
|
|
2102
2277
|
price2?: string;
|
|
2103
2278
|
}
|
|
2104
|
-
interface KrakenAddOrderParams {
|
|
2279
|
+
interface KrakenAddOrderParams$1 {
|
|
2105
2280
|
/**
|
|
2106
2281
|
* Optional non-unique numeric identifier for grouping orders.
|
|
2107
2282
|
* Mutually exclusive with `cl_ord_id`.
|
|
@@ -2118,9 +2293,9 @@ interface KrakenAddOrderParams {
|
|
|
2118
2293
|
* Execution model of the order.
|
|
2119
2294
|
* e.g. "market", "limit", "stop-loss", etc.
|
|
2120
2295
|
*/
|
|
2121
|
-
ordertype: KrakenOrderType;
|
|
2296
|
+
ordertype: KrakenOrderType$1;
|
|
2122
2297
|
/** Order direction ("buy" / "sell") */
|
|
2123
|
-
type: KrakenOrderSide;
|
|
2298
|
+
type: KrakenOrderSide$1;
|
|
2124
2299
|
/**
|
|
2125
2300
|
* Order quantity in terms of the base asset.
|
|
2126
2301
|
*
|
|
@@ -2159,7 +2334,7 @@ interface KrakenAddOrderParams {
|
|
|
2159
2334
|
*
|
|
2160
2335
|
* Default on Kraken is "last".
|
|
2161
2336
|
*/
|
|
2162
|
-
trigger?: KrakenOrderTrigger;
|
|
2337
|
+
trigger?: KrakenOrderTrigger$1;
|
|
2163
2338
|
/**
|
|
2164
2339
|
* Amount of leverage desired (quote string, e.g. "5").
|
|
2165
2340
|
* Default is no leverage if omitted.
|
|
@@ -2176,7 +2351,7 @@ interface KrakenAddOrderParams {
|
|
|
2176
2351
|
* - "cancel-oldest"
|
|
2177
2352
|
* - "cancel-both"
|
|
2178
2353
|
*/
|
|
2179
|
-
stptype?: KrakenAddOrderStpType;
|
|
2354
|
+
stptype?: KrakenAddOrderStpType$1;
|
|
2180
2355
|
/**
|
|
2181
2356
|
* Comma-delimited list of order flags:
|
|
2182
2357
|
* - post, fcib, fciq, nompp, viqc
|
|
@@ -2188,7 +2363,7 @@ interface KrakenAddOrderParams {
|
|
|
2188
2363
|
* - IOC
|
|
2189
2364
|
* - GTD (must coincide with expiretm)
|
|
2190
2365
|
*/
|
|
2191
|
-
timeinforce?: KrakenAddOrderTimeInForce;
|
|
2366
|
+
timeinforce?: KrakenAddOrderTimeInForce$1;
|
|
2192
2367
|
/**
|
|
2193
2368
|
* Scheduled start time:
|
|
2194
2369
|
* - "0" now (default)
|
|
@@ -2220,15 +2395,15 @@ interface KrakenAddOrderParams {
|
|
|
2220
2395
|
*/
|
|
2221
2396
|
validate?: boolean;
|
|
2222
2397
|
}
|
|
2223
|
-
interface KrakenAddOrderDescription {
|
|
2398
|
+
interface KrakenAddOrderDescription$1 {
|
|
2224
2399
|
/** Order description text */
|
|
2225
2400
|
order: string;
|
|
2226
2401
|
/** Conditional close order description (if applicable) */
|
|
2227
2402
|
close?: string;
|
|
2228
2403
|
}
|
|
2229
|
-
interface KrakenAddOrderResult {
|
|
2404
|
+
interface KrakenAddOrderResult$1 {
|
|
2230
2405
|
/** Order description info */
|
|
2231
|
-
descr: KrakenAddOrderDescription;
|
|
2406
|
+
descr: KrakenAddOrderDescription$1;
|
|
2232
2407
|
/**
|
|
2233
2408
|
* Transaction IDs for the order (if it was added successfully).
|
|
2234
2409
|
*
|
|
@@ -2243,7 +2418,7 @@ interface KrakenAddOrderResult {
|
|
|
2243
2418
|
*
|
|
2244
2419
|
* Either `txid` or `cl_ord_id` is required.
|
|
2245
2420
|
*/
|
|
2246
|
-
interface KrakenAmendOrderParams {
|
|
2421
|
+
interface KrakenAmendOrderParams$1 {
|
|
2247
2422
|
/**
|
|
2248
2423
|
* The Kraken identifier for the order to be amended.
|
|
2249
2424
|
* Either `txid` or `cl_ord_id` is required.
|
|
@@ -2304,7 +2479,7 @@ interface KrakenAmendOrderParams {
|
|
|
2304
2479
|
/**
|
|
2305
2480
|
* Result payload for a successful amend.
|
|
2306
2481
|
*/
|
|
2307
|
-
interface KrakenAmendOrderResult {
|
|
2482
|
+
interface KrakenAmendOrderResult$1 {
|
|
2308
2483
|
/**
|
|
2309
2484
|
* The unique Kraken identifier generated for this amend
|
|
2310
2485
|
* transaction.
|
|
@@ -2320,7 +2495,7 @@ interface KrakenAmendOrderResult {
|
|
|
2320
2495
|
*
|
|
2321
2496
|
* Exactly one of these fields must be provided.
|
|
2322
2497
|
*/
|
|
2323
|
-
interface KrakenCancelOrderParams {
|
|
2498
|
+
interface KrakenCancelOrderParams$1 {
|
|
2324
2499
|
/**
|
|
2325
2500
|
* Kraken order identifier(s).
|
|
2326
2501
|
* Can be a single txid or an array which will be joined with commas.
|
|
@@ -2340,17 +2515,22 @@ interface KrakenCancelOrderParams {
|
|
|
2340
2515
|
/**
|
|
2341
2516
|
* Result payload for CancelOrder and CancelAll.
|
|
2342
2517
|
*/
|
|
2343
|
-
interface KrakenCancelOrderResult {
|
|
2518
|
+
interface KrakenCancelOrderResult$1 {
|
|
2344
2519
|
/** Number of orders cancelled */
|
|
2345
2520
|
count: number;
|
|
2346
2521
|
/** If true, orders are pending cancellation */
|
|
2347
2522
|
pending?: boolean;
|
|
2348
2523
|
}
|
|
2349
2524
|
|
|
2525
|
+
/**
|
|
2526
|
+
* Result of CancelAll. Shape is identical to CancelOrder.
|
|
2527
|
+
*/
|
|
2528
|
+
type KrakenCancelAllOrdersResult$1 = KrakenCancelOrderResult$1;
|
|
2529
|
+
|
|
2350
2530
|
/**
|
|
2351
2531
|
* Params for CancelAllOrdersAfter.
|
|
2352
2532
|
*/
|
|
2353
|
-
interface KrakenCancelAllOrdersAfterParams {
|
|
2533
|
+
interface KrakenCancelAllOrdersAfterParams$1 {
|
|
2354
2534
|
/**
|
|
2355
2535
|
* Duration (in seconds) to set/extend the timer.
|
|
2356
2536
|
* Must be < 86400.
|
|
@@ -2362,7 +2542,7 @@ interface KrakenCancelAllOrdersAfterParams {
|
|
|
2362
2542
|
/**
|
|
2363
2543
|
* Result payload for CancelAllOrdersAfter.
|
|
2364
2544
|
*/
|
|
2365
|
-
interface KrakenCancelAllOrdersAfterResult {
|
|
2545
|
+
interface KrakenCancelAllOrdersAfterResult$1 {
|
|
2366
2546
|
/**
|
|
2367
2547
|
* Timestamp (RFC3339) at which the request was received.
|
|
2368
2548
|
*/
|
|
@@ -2380,7 +2560,7 @@ interface KrakenCancelAllOrdersAfterResult {
|
|
|
2380
2560
|
/**
|
|
2381
2561
|
* Result of GetWebSocketsToken.
|
|
2382
2562
|
*/
|
|
2383
|
-
interface KrakenGetWebSocketsTokenResult {
|
|
2563
|
+
interface KrakenGetWebSocketsTokenResult$1 {
|
|
2384
2564
|
/**
|
|
2385
2565
|
* WebSockets token to authenticate private WS subscriptions.
|
|
2386
2566
|
*
|
|
@@ -2403,7 +2583,7 @@ interface KrakenGetWebSocketsTokenResult {
|
|
|
2403
2583
|
* - Pair / asset_class are top-level on the batch, not per order.
|
|
2404
2584
|
* - userref and cl_ord_id are mutually exclusive per order.
|
|
2405
2585
|
*/
|
|
2406
|
-
interface KrakenAddOrderBatchOrderParams {
|
|
2586
|
+
interface KrakenAddOrderBatchOrderParams$1 {
|
|
2407
2587
|
/**
|
|
2408
2588
|
* Optional non-unique numeric identifier for grouping orders.
|
|
2409
2589
|
* Mutually exclusive with `cl_ord_id`.
|
|
@@ -2415,9 +2595,9 @@ interface KrakenAddOrderBatchOrderParams {
|
|
|
2415
2595
|
*/
|
|
2416
2596
|
cl_ord_id?: string;
|
|
2417
2597
|
/** Execution model of the order. */
|
|
2418
|
-
ordertype: KrakenOrderType;
|
|
2598
|
+
ordertype: KrakenOrderType$1;
|
|
2419
2599
|
/** Order direction ("buy" / "sell"). */
|
|
2420
|
-
type: KrakenOrderSide;
|
|
2600
|
+
type: KrakenOrderSide$1;
|
|
2421
2601
|
/**
|
|
2422
2602
|
* Order quantity in base asset terms.
|
|
2423
2603
|
* Volume can be "0" for closing margin orders.
|
|
@@ -2444,7 +2624,7 @@ interface KrakenAddOrderBatchOrderParams {
|
|
|
2444
2624
|
* Trigger reference price for triggered orders.
|
|
2445
2625
|
* Default is "last" if omitted.
|
|
2446
2626
|
*/
|
|
2447
|
-
trigger?: KrakenOrderTrigger;
|
|
2627
|
+
trigger?: KrakenOrderTrigger$1;
|
|
2448
2628
|
/**
|
|
2449
2629
|
* Leverage amount as a string (e.g. "5").
|
|
2450
2630
|
* Default = none if omitted.
|
|
@@ -2458,7 +2638,7 @@ interface KrakenAddOrderBatchOrderParams {
|
|
|
2458
2638
|
* Self Trade Prevention mode.
|
|
2459
2639
|
* Default: "cancel-newest".
|
|
2460
2640
|
*/
|
|
2461
|
-
stptype?: KrakenAddOrderStpType;
|
|
2641
|
+
stptype?: KrakenAddOrderStpType$1;
|
|
2462
2642
|
/**
|
|
2463
2643
|
* Comma-delimited order flags:
|
|
2464
2644
|
* - post, fcib, fciq, nompp, viqc
|
|
@@ -2470,7 +2650,7 @@ interface KrakenAddOrderBatchOrderParams {
|
|
|
2470
2650
|
* - IOC
|
|
2471
2651
|
* - GTD
|
|
2472
2652
|
*/
|
|
2473
|
-
timeinforce?: KrakenAddOrderTimeInForce;
|
|
2653
|
+
timeinforce?: KrakenAddOrderTimeInForce$1;
|
|
2474
2654
|
/**
|
|
2475
2655
|
* Scheduled start time:
|
|
2476
2656
|
* - "0" now (default)
|
|
@@ -2491,12 +2671,12 @@ interface KrakenAddOrderBatchOrderParams {
|
|
|
2491
2671
|
*
|
|
2492
2672
|
* All orders must be for the same pair.
|
|
2493
2673
|
*/
|
|
2494
|
-
interface KrakenAddOrderBatchParams {
|
|
2674
|
+
interface KrakenAddOrderBatchParams$1 {
|
|
2495
2675
|
/**
|
|
2496
2676
|
* List of orders to place.
|
|
2497
2677
|
* Must contain between 2 and 15 orders.
|
|
2498
2678
|
*/
|
|
2499
|
-
orders: KrakenAddOrderBatchOrderParams[];
|
|
2679
|
+
orders: KrakenAddOrderBatchOrderParams$1[];
|
|
2500
2680
|
/**
|
|
2501
2681
|
* Asset pair id or altname (e.g. "XBTUSD").
|
|
2502
2682
|
* All orders in the batch will use this pair.
|
|
@@ -2523,7 +2703,7 @@ interface KrakenAddOrderBatchParams {
|
|
|
2523
2703
|
/**
|
|
2524
2704
|
* Description of an individual order in the batch result.
|
|
2525
2705
|
*/
|
|
2526
|
-
interface KrakenAddOrderBatchOrderDescription {
|
|
2706
|
+
interface KrakenAddOrderBatchOrderDescription$1 {
|
|
2527
2707
|
/** Order description text. */
|
|
2528
2708
|
order: string;
|
|
2529
2709
|
}
|
|
@@ -2534,8 +2714,8 @@ interface KrakenAddOrderBatchOrderDescription {
|
|
|
2534
2714
|
* - `error` is set if that individual order failed (while others may succeed).
|
|
2535
2715
|
* - `txid` is set if that individual order was accepted.
|
|
2536
2716
|
*/
|
|
2537
|
-
interface KrakenAddOrderBatchOrderResult {
|
|
2538
|
-
descr: KrakenAddOrderBatchOrderDescription;
|
|
2717
|
+
interface KrakenAddOrderBatchOrderResult$1 {
|
|
2718
|
+
descr: KrakenAddOrderBatchOrderDescription$1;
|
|
2539
2719
|
error?: string;
|
|
2540
2720
|
txid?: string;
|
|
2541
2721
|
}
|
|
@@ -2545,8 +2725,8 @@ interface KrakenAddOrderBatchOrderResult {
|
|
|
2545
2725
|
* The order of elements in `orders` matches the order
|
|
2546
2726
|
* of the `orders` array sent in the request.
|
|
2547
2727
|
*/
|
|
2548
|
-
interface KrakenAddOrderBatchResult {
|
|
2549
|
-
orders: KrakenAddOrderBatchOrderResult[];
|
|
2728
|
+
interface KrakenAddOrderBatchResult$1 {
|
|
2729
|
+
orders: KrakenAddOrderBatchOrderResult$1[];
|
|
2550
2730
|
}
|
|
2551
2731
|
|
|
2552
2732
|
/**
|
|
@@ -2555,7 +2735,7 @@ interface KrakenAddOrderBatchResult {
|
|
|
2555
2735
|
* The API uses the same `txid` field for both Kraken order ids
|
|
2556
2736
|
* and user references (integers).
|
|
2557
2737
|
*/
|
|
2558
|
-
interface KrakenCancelOrderBatchOrderRef {
|
|
2738
|
+
interface KrakenCancelOrderBatchOrderRef$1 {
|
|
2559
2739
|
/**
|
|
2560
2740
|
* Kraken order transaction ID (txid) OR user reference (userref).
|
|
2561
2741
|
*
|
|
@@ -2572,18 +2752,26 @@ interface KrakenCancelOrderBatchOrderRef {
|
|
|
2572
2752
|
*
|
|
2573
2753
|
* Total unique IDs across both must be <= 50.
|
|
2574
2754
|
*/
|
|
2575
|
-
interface KrakenCancelOrderBatchParams {
|
|
2755
|
+
interface KrakenCancelOrderBatchParams$1 {
|
|
2576
2756
|
/**
|
|
2577
2757
|
* Open order transaction IDs (txid) or user references (userref),
|
|
2578
2758
|
* up to a maximum of 50 total unique IDs/references.
|
|
2579
2759
|
*/
|
|
2580
|
-
orders?: KrakenCancelOrderBatchOrderRef[];
|
|
2760
|
+
orders?: KrakenCancelOrderBatchOrderRef$1[];
|
|
2581
2761
|
/**
|
|
2582
2762
|
* Client order identifiers, up to a maximum of 50 total
|
|
2583
2763
|
* unique IDs/references.
|
|
2584
2764
|
*/
|
|
2585
2765
|
clOrdIds?: string[];
|
|
2586
2766
|
}
|
|
2767
|
+
/**
|
|
2768
|
+
* Result payload for CancelOrderBatch.
|
|
2769
|
+
*
|
|
2770
|
+
* Kraken docs describe the same semantics as CancelOrder:
|
|
2771
|
+
* - `count`: number of orders cancelled
|
|
2772
|
+
* - `pending`: if true, cancels are still pending
|
|
2773
|
+
*/
|
|
2774
|
+
type KrakenCancelOrderBatchResult$1 = KrakenCancelOrderResult$1;
|
|
2587
2775
|
|
|
2588
2776
|
/**
|
|
2589
2777
|
* Parameters to edit an existing live order.
|
|
@@ -2596,7 +2784,7 @@ interface KrakenCancelOrderBatchParams {
|
|
|
2596
2784
|
* - queue position is NOT maintained
|
|
2597
2785
|
* - executions remain associated with original order
|
|
2598
2786
|
*/
|
|
2599
|
-
interface KrakenEditOrderParams {
|
|
2787
|
+
interface KrakenEditOrderParams$1 {
|
|
2600
2788
|
/**
|
|
2601
2789
|
* Original Order ID (txid) or userref of the original order.
|
|
2602
2790
|
*
|
|
@@ -2677,16 +2865,16 @@ interface KrakenEditOrderParams {
|
|
|
2677
2865
|
/**
|
|
2678
2866
|
* Description of the edited order.
|
|
2679
2867
|
*/
|
|
2680
|
-
interface KrakenEditOrderDescription {
|
|
2868
|
+
interface KrakenEditOrderDescription$1 {
|
|
2681
2869
|
/** Order description text */
|
|
2682
2870
|
order: string;
|
|
2683
2871
|
}
|
|
2684
2872
|
/**
|
|
2685
2873
|
* Result payload for EditOrder.
|
|
2686
2874
|
*/
|
|
2687
|
-
interface KrakenEditOrderResult {
|
|
2875
|
+
interface KrakenEditOrderResult$1 {
|
|
2688
2876
|
/** Description info of the new order */
|
|
2689
|
-
descr: KrakenEditOrderDescription;
|
|
2877
|
+
descr: KrakenEditOrderDescription$1;
|
|
2690
2878
|
/** New transaction ID (if edit succeeded and order created) */
|
|
2691
2879
|
txid?: string;
|
|
2692
2880
|
/** New userref if specified on the edit request */
|
|
@@ -2727,7 +2915,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2727
2915
|
*
|
|
2728
2916
|
* console.log(result.descr.order, result.txid);
|
|
2729
2917
|
*/
|
|
2730
|
-
addOrder(params: KrakenAddOrderParams): Promise<KrakenAddOrderResult>;
|
|
2918
|
+
addOrder(params: KrakenAddOrderParams$1): Promise<KrakenAddOrderResult$1>;
|
|
2731
2919
|
/**
|
|
2732
2920
|
* Amend an existing order in-place.
|
|
2733
2921
|
*
|
|
@@ -2741,7 +2929,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2741
2929
|
*
|
|
2742
2930
|
* console.log("Amend ID:", result.amend_id);
|
|
2743
2931
|
*/
|
|
2744
|
-
amendOrder(params: KrakenAmendOrderParams): Promise<KrakenAmendOrderResult>;
|
|
2932
|
+
amendOrder(params: KrakenAmendOrderParams$1): Promise<KrakenAmendOrderResult$1>;
|
|
2745
2933
|
/**
|
|
2746
2934
|
* Cancel open orders by txid, userref, or cl_ord_id.
|
|
2747
2935
|
*
|
|
@@ -2766,7 +2954,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2766
2954
|
* cl_ord_id: "arb-20240509-00010",
|
|
2767
2955
|
* });
|
|
2768
2956
|
*/
|
|
2769
|
-
cancelOrder(params: KrakenCancelOrderParams): Promise<KrakenCancelOrderResult>;
|
|
2957
|
+
cancelOrder(params: KrakenCancelOrderParams$1): Promise<KrakenCancelOrderResult$1>;
|
|
2770
2958
|
/**
|
|
2771
2959
|
* Cancel all open orders for this account.
|
|
2772
2960
|
*
|
|
@@ -2774,7 +2962,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2774
2962
|
* const res = await kraken.trading.cancelAllOrders();
|
|
2775
2963
|
* console.log("Cancelled count:", res.count, "pending:", res.pending);
|
|
2776
2964
|
*/
|
|
2777
|
-
cancelAllOrders(): Promise<KrakenCancelOrderResult>;
|
|
2965
|
+
cancelAllOrders(): Promise<KrakenCancelOrderResult$1>;
|
|
2778
2966
|
/**
|
|
2779
2967
|
* Set or extend the "Dead Man's Switch" timer that will
|
|
2780
2968
|
* cancel all open orders after `timeout` seconds.
|
|
@@ -2790,7 +2978,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2790
2978
|
* console.log("Current:", result.currentTime);
|
|
2791
2979
|
* console.log("Trigger:", result.triggerTime);
|
|
2792
2980
|
*/
|
|
2793
|
-
cancelAllOrdersAfter(params: KrakenCancelAllOrdersAfterParams): Promise<KrakenCancelAllOrdersAfterResult>;
|
|
2981
|
+
cancelAllOrdersAfter(params: KrakenCancelAllOrdersAfterParams$1): Promise<KrakenCancelAllOrdersAfterResult$1>;
|
|
2794
2982
|
/**
|
|
2795
2983
|
* Get a WebSockets authentication token for private WS API.
|
|
2796
2984
|
*
|
|
@@ -2803,7 +2991,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2803
2991
|
* const { token, expires } = await kraken.accountData.getWebSocketsToken();
|
|
2804
2992
|
* console.log("WS token:", token, "expires in:", expires, "seconds");
|
|
2805
2993
|
*/
|
|
2806
|
-
getWebSocketsToken(): Promise<KrakenGetWebSocketsTokenResult>;
|
|
2994
|
+
getWebSocketsToken(): Promise<KrakenGetWebSocketsTokenResult$1>;
|
|
2807
2995
|
/**
|
|
2808
2996
|
* Place a batch of orders (2–15) for a single pair.
|
|
2809
2997
|
*
|
|
@@ -2830,7 +3018,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2830
3018
|
* console.log(o.descr.order, o.txid, o.error);
|
|
2831
3019
|
* }
|
|
2832
3020
|
*/
|
|
2833
|
-
addOrderBatch(params: KrakenAddOrderBatchParams): Promise<KrakenAddOrderBatchResult>;
|
|
3021
|
+
addOrderBatch(params: KrakenAddOrderBatchParams$1): Promise<KrakenAddOrderBatchResult$1>;
|
|
2834
3022
|
/**
|
|
2835
3023
|
* Cancel multiple open orders by txid/userref or cl_ord_id.
|
|
2836
3024
|
*
|
|
@@ -2845,7 +3033,7 @@ declare class KrakenSpotTradingApi {
|
|
|
2845
3033
|
*
|
|
2846
3034
|
* console.log("Cancelled:", res.count, "pending:", res.pending);
|
|
2847
3035
|
*/
|
|
2848
|
-
cancelOrderBatch(params: KrakenCancelOrderBatchParams): Promise<KrakenCancelOrderResult>;
|
|
3036
|
+
cancelOrderBatch(params: KrakenCancelOrderBatchParams$1): Promise<KrakenCancelOrderResult$1>;
|
|
2849
3037
|
/**
|
|
2850
3038
|
* Edit an existing live order.
|
|
2851
3039
|
*
|
|
@@ -2871,13 +3059,37 @@ declare class KrakenSpotTradingApi {
|
|
|
2871
3059
|
*
|
|
2872
3060
|
* console.log("New txid:", res.txid, "original:", res.originaltxid);
|
|
2873
3061
|
*/
|
|
2874
|
-
editOrder(params: KrakenEditOrderParams): Promise<KrakenEditOrderResult>;
|
|
2875
|
-
}
|
|
3062
|
+
editOrder(params: KrakenEditOrderParams$1): Promise<KrakenEditOrderResult$1>;
|
|
3063
|
+
}
|
|
3064
|
+
type KrakenAddOrderParams = KrakenAddOrderParams$1;
|
|
3065
|
+
type KrakenAddOrderResult = KrakenAddOrderResult$1;
|
|
3066
|
+
type KrakenAddOrderDescription = KrakenAddOrderDescription$1;
|
|
3067
|
+
type KrakenAddOrderTimeInForce = KrakenAddOrderTimeInForce$1;
|
|
3068
|
+
type KrakenAddOrderStpType = KrakenAddOrderStpType$1;
|
|
3069
|
+
type KrakenAmendOrderParams = KrakenAmendOrderParams$1;
|
|
3070
|
+
type KrakenAmendOrderResult = KrakenAmendOrderResult$1;
|
|
3071
|
+
type KrakenCancelOrderParams = KrakenCancelOrderParams$1;
|
|
3072
|
+
type KrakenCancelOrderResult = KrakenCancelOrderResult$1;
|
|
3073
|
+
type KrakenCancelAllOrdersResult = KrakenCancelAllOrdersResult$1;
|
|
3074
|
+
type KrakenCancelAllOrdersAfterParams = KrakenCancelAllOrdersAfterParams$1;
|
|
3075
|
+
type KrakenCancelAllOrdersAfterResult = KrakenCancelAllOrdersAfterResult$1;
|
|
3076
|
+
type KrakenGetWebSocketsTokenResult = KrakenGetWebSocketsTokenResult$1;
|
|
3077
|
+
type KrakenAddOrderBatchOrderParams = KrakenAddOrderBatchOrderParams$1;
|
|
3078
|
+
type KrakenAddOrderBatchParams = KrakenAddOrderBatchParams$1;
|
|
3079
|
+
type KrakenAddOrderBatchOrderDescription = KrakenAddOrderBatchOrderDescription$1;
|
|
3080
|
+
type KrakenAddOrderBatchOrderResult = KrakenAddOrderBatchOrderResult$1;
|
|
3081
|
+
type KrakenAddOrderBatchResult = KrakenAddOrderBatchResult$1;
|
|
3082
|
+
type KrakenCancelOrderBatchOrderRef = KrakenCancelOrderBatchOrderRef$1;
|
|
3083
|
+
type KrakenCancelOrderBatchParams = KrakenCancelOrderBatchParams$1;
|
|
3084
|
+
type KrakenCancelOrderBatchResult = KrakenCancelOrderBatchResult$1;
|
|
3085
|
+
type KrakenEditOrderParams = KrakenEditOrderParams$1;
|
|
3086
|
+
type KrakenEditOrderResult = KrakenEditOrderResult$1;
|
|
3087
|
+
type KrakenEditOrderDescription = KrakenEditOrderDescription$1;
|
|
2876
3088
|
|
|
2877
3089
|
/**
|
|
2878
3090
|
* Parameters for GetDepositMethods.
|
|
2879
3091
|
*/
|
|
2880
|
-
interface KrakenGetDepositMethodsParams {
|
|
3092
|
+
interface KrakenGetDepositMethodsParams$1 {
|
|
2881
3093
|
asset: string;
|
|
2882
3094
|
aclass?: 'currency' | 'tokenized_asset';
|
|
2883
3095
|
rebase_multiplier?: 'rebased' | 'base';
|
|
@@ -2888,7 +3100,7 @@ interface KrakenGetDepositMethodsParams {
|
|
|
2888
3100
|
* Note: some keys use hyphens as in Kraken's API response
|
|
2889
3101
|
* and must be accessed with bracket notation.
|
|
2890
3102
|
*/
|
|
2891
|
-
interface KrakenDepositMethod {
|
|
3103
|
+
interface KrakenDepositMethod$1 {
|
|
2892
3104
|
method: string;
|
|
2893
3105
|
limit: string | boolean;
|
|
2894
3106
|
fee: string;
|
|
@@ -2900,12 +3112,12 @@ interface KrakenDepositMethod {
|
|
|
2900
3112
|
* KrakenRestBase.privatePost unwraps { error, result } and returns `result`,
|
|
2901
3113
|
* so this endpoint returns the array directly.
|
|
2902
3114
|
*/
|
|
2903
|
-
type KrakenGetDepositMethodsResult = KrakenDepositMethod[];
|
|
3115
|
+
type KrakenGetDepositMethodsResult$1 = KrakenDepositMethod$1[];
|
|
2904
3116
|
|
|
2905
3117
|
/**
|
|
2906
3118
|
* Parameters for GetDepositAddresses.
|
|
2907
3119
|
*/
|
|
2908
|
-
interface KrakenGetDepositAddressesParams {
|
|
3120
|
+
interface KrakenGetDepositAddressesParams$1 {
|
|
2909
3121
|
asset: string;
|
|
2910
3122
|
aclass?: 'currency' | 'tokenized_asset';
|
|
2911
3123
|
method: string;
|
|
@@ -2915,7 +3127,7 @@ interface KrakenGetDepositAddressesParams {
|
|
|
2915
3127
|
/**
|
|
2916
3128
|
* Single deposit address entry.
|
|
2917
3129
|
*/
|
|
2918
|
-
interface KrakenDepositAddress {
|
|
3130
|
+
interface KrakenDepositAddress$1 {
|
|
2919
3131
|
address: string;
|
|
2920
3132
|
expiretm: string;
|
|
2921
3133
|
new: boolean;
|
|
@@ -2927,10 +3139,10 @@ interface KrakenDepositAddress {
|
|
|
2927
3139
|
* KrakenRestBase.privatePost unwraps { error, result } and returns `result`,
|
|
2928
3140
|
* so this endpoint returns the array directly.
|
|
2929
3141
|
*/
|
|
2930
|
-
type KrakenGetDepositAddressesResult = KrakenDepositAddress[];
|
|
3142
|
+
type KrakenGetDepositAddressesResult$1 = KrakenDepositAddress$1[];
|
|
2931
3143
|
|
|
2932
3144
|
type KrakenRebaseMultiplier = 'rebased' | 'base';
|
|
2933
|
-
interface KrakenGetDepositStatusParams {
|
|
3145
|
+
interface KrakenGetDepositStatusParams$1 {
|
|
2934
3146
|
asset?: string;
|
|
2935
3147
|
aclass?: 'currency' | 'tokenized_asset';
|
|
2936
3148
|
method?: string;
|
|
@@ -2944,7 +3156,7 @@ interface KrakenGetDepositStatusParams {
|
|
|
2944
3156
|
limit?: number;
|
|
2945
3157
|
rebase_multiplier?: KrakenRebaseMultiplier;
|
|
2946
3158
|
}
|
|
2947
|
-
interface KrakenDepositStatusEntry {
|
|
3159
|
+
interface KrakenDepositStatusEntry$1 {
|
|
2948
3160
|
method: string;
|
|
2949
3161
|
aclass: string;
|
|
2950
3162
|
asset: string;
|
|
@@ -2959,28 +3171,28 @@ interface KrakenDepositStatusEntry {
|
|
|
2959
3171
|
originators?: string[];
|
|
2960
3172
|
}
|
|
2961
3173
|
|
|
2962
|
-
interface KrakenGetWithdrawMethodsParams {
|
|
3174
|
+
interface KrakenGetWithdrawMethodsParams$1 {
|
|
2963
3175
|
asset: string;
|
|
2964
3176
|
aclass?: 'currency' | 'tokenized_asset';
|
|
2965
3177
|
network?: string;
|
|
2966
3178
|
rebase_multiplier?: KrakenRebaseMultiplier;
|
|
2967
3179
|
}
|
|
2968
|
-
interface KrakenWithdrawMethod {
|
|
3180
|
+
interface KrakenWithdrawMethod$1 {
|
|
2969
3181
|
asset: string;
|
|
2970
3182
|
method: string;
|
|
2971
3183
|
network: string;
|
|
2972
3184
|
minimum: string;
|
|
2973
3185
|
}
|
|
2974
|
-
type KrakenGetWithdrawMethodsResult = KrakenWithdrawMethod[];
|
|
3186
|
+
type KrakenGetWithdrawMethodsResult$1 = KrakenWithdrawMethod$1[];
|
|
2975
3187
|
|
|
2976
|
-
interface KrakenGetWithdrawAddressesParams {
|
|
3188
|
+
interface KrakenGetWithdrawAddressesParams$1 {
|
|
2977
3189
|
asset: string;
|
|
2978
3190
|
aclass?: 'currency' | 'tokenized_asset';
|
|
2979
3191
|
method?: string;
|
|
2980
3192
|
key?: string;
|
|
2981
3193
|
verified?: boolean;
|
|
2982
3194
|
}
|
|
2983
|
-
interface KrakenWithdrawAddress {
|
|
3195
|
+
interface KrakenWithdrawAddress$1 {
|
|
2984
3196
|
address: string;
|
|
2985
3197
|
asset: string;
|
|
2986
3198
|
method: string;
|
|
@@ -2988,21 +3200,22 @@ interface KrakenWithdrawAddress {
|
|
|
2988
3200
|
tag?: string;
|
|
2989
3201
|
verified: boolean;
|
|
2990
3202
|
}
|
|
2991
|
-
type KrakenGetWithdrawAddressesResult = KrakenWithdrawAddress[];
|
|
3203
|
+
type KrakenGetWithdrawAddressesResult$1 = KrakenWithdrawAddress$1[];
|
|
2992
3204
|
|
|
2993
|
-
interface KrakenGetWithdrawInfoParams {
|
|
3205
|
+
interface KrakenGetWithdrawInfoParams$1 {
|
|
2994
3206
|
asset: string;
|
|
2995
3207
|
key: string;
|
|
2996
3208
|
amount: string | number;
|
|
2997
3209
|
}
|
|
2998
|
-
interface KrakenWithdrawInfo {
|
|
3210
|
+
interface KrakenWithdrawInfo$1 {
|
|
2999
3211
|
method: string;
|
|
3000
3212
|
limit: string;
|
|
3001
3213
|
amount: string;
|
|
3002
3214
|
fee: string;
|
|
3003
3215
|
}
|
|
3216
|
+
type KrakenGetWithdrawInfoResult$1 = KrakenWithdrawInfo$1;
|
|
3004
3217
|
|
|
3005
|
-
interface KrakenWithdrawFundsParams {
|
|
3218
|
+
interface KrakenWithdrawFundsParams$1 {
|
|
3006
3219
|
asset: string;
|
|
3007
3220
|
aclass?: 'currency' | 'tokenized_asset';
|
|
3008
3221
|
key: string;
|
|
@@ -3011,11 +3224,12 @@ interface KrakenWithdrawFundsParams {
|
|
|
3011
3224
|
max_fee?: string | number;
|
|
3012
3225
|
rebase_multiplier?: KrakenRebaseMultiplier;
|
|
3013
3226
|
}
|
|
3014
|
-
interface KrakenWithdrawFundsResult {
|
|
3227
|
+
interface KrakenWithdrawFundsResult$1 {
|
|
3015
3228
|
refid: string;
|
|
3016
3229
|
}
|
|
3230
|
+
type KrakenWithdrawFundsResponse = KrakenWithdrawFundsResult$1;
|
|
3017
3231
|
|
|
3018
|
-
interface KrakenGetWithdrawStatusParams {
|
|
3232
|
+
interface KrakenGetWithdrawStatusParams$1 {
|
|
3019
3233
|
/**
|
|
3020
3234
|
* Filter for specific asset being withdrawn (e.g. "USDT", "XBT").
|
|
3021
3235
|
*/
|
|
@@ -3065,7 +3279,7 @@ interface KrakenGetWithdrawStatusParams {
|
|
|
3065
3279
|
*/
|
|
3066
3280
|
rebase_multiplier?: KrakenRebaseMultiplier;
|
|
3067
3281
|
}
|
|
3068
|
-
interface KrakenWithdrawStatusEntry {
|
|
3282
|
+
interface KrakenWithdrawStatusEntry$1 {
|
|
3069
3283
|
/**
|
|
3070
3284
|
* Name of withdrawal method.
|
|
3071
3285
|
*/
|
|
@@ -3129,22 +3343,23 @@ interface KrakenWithdrawStatusEntry {
|
|
|
3129
3343
|
/**
|
|
3130
3344
|
* Kraken returns an array of withdrawal-status objects as `result`.
|
|
3131
3345
|
*/
|
|
3132
|
-
type KrakenGetWithdrawStatusResult = KrakenWithdrawStatusEntry[];
|
|
3346
|
+
type KrakenGetWithdrawStatusResult$1 = KrakenWithdrawStatusEntry$1[];
|
|
3133
3347
|
|
|
3134
|
-
interface KrakenWithdrawCancelParams {
|
|
3348
|
+
interface KrakenWithdrawCancelParams$1 {
|
|
3135
3349
|
asset: string;
|
|
3136
3350
|
refid: string;
|
|
3137
3351
|
}
|
|
3352
|
+
type KrakenWithdrawCancelResult$1 = boolean;
|
|
3138
3353
|
|
|
3139
3354
|
type KrakenWalletTransferSource = 'Spot Wallet';
|
|
3140
3355
|
type KrakenWalletTransferDestination = 'Futures Wallet';
|
|
3141
|
-
interface KrakenWalletTransferParams {
|
|
3356
|
+
interface KrakenWalletTransferParams$1 {
|
|
3142
3357
|
asset: string;
|
|
3143
3358
|
from: KrakenWalletTransferSource;
|
|
3144
3359
|
to: KrakenWalletTransferDestination;
|
|
3145
3360
|
amount: string | number;
|
|
3146
3361
|
}
|
|
3147
|
-
interface KrakenWalletTransferResult {
|
|
3362
|
+
interface KrakenWalletTransferResult$1 {
|
|
3148
3363
|
refid: string;
|
|
3149
3364
|
}
|
|
3150
3365
|
|
|
@@ -3176,7 +3391,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3176
3391
|
* }
|
|
3177
3392
|
* ```
|
|
3178
3393
|
*/
|
|
3179
|
-
getDepositMethods(params: KrakenGetDepositMethodsParams): Promise<KrakenGetDepositMethodsResult>;
|
|
3394
|
+
getDepositMethods(params: KrakenGetDepositMethodsParams$1): Promise<KrakenGetDepositMethodsResult$1>;
|
|
3180
3395
|
/**
|
|
3181
3396
|
* Retrieve (or generate) deposit addresses for a particular
|
|
3182
3397
|
* asset and deposit method.
|
|
@@ -3194,7 +3409,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3194
3409
|
* }
|
|
3195
3410
|
* ```
|
|
3196
3411
|
*/
|
|
3197
|
-
getDepositAddresses(params: KrakenGetDepositAddressesParams): Promise<KrakenGetDepositAddressesResult>;
|
|
3412
|
+
getDepositAddresses(params: KrakenGetDepositAddressesParams$1): Promise<KrakenGetDepositAddressesResult$1>;
|
|
3198
3413
|
/**
|
|
3199
3414
|
* Retrieve information about recent deposits.
|
|
3200
3415
|
* Results are sorted by recency. Use `cursor`, `start`, `end` and `limit`
|
|
@@ -3211,7 +3426,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3211
3426
|
* }
|
|
3212
3427
|
* ```
|
|
3213
3428
|
*/
|
|
3214
|
-
getDepositStatus(params?: KrakenGetDepositStatusParams): Promise<KrakenDepositStatusEntry[]>;
|
|
3429
|
+
getDepositStatus(params?: KrakenGetDepositStatusParams$1): Promise<KrakenDepositStatusEntry$1[]>;
|
|
3215
3430
|
/**
|
|
3216
3431
|
* Retrieve withdrawal methods available for a particular asset
|
|
3217
3432
|
* (and optionally network).
|
|
@@ -3228,7 +3443,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3228
3443
|
* }
|
|
3229
3444
|
* ```
|
|
3230
3445
|
*/
|
|
3231
|
-
getWithdrawMethods(params: KrakenGetWithdrawMethodsParams): Promise<KrakenGetWithdrawMethodsResult>;
|
|
3446
|
+
getWithdrawMethods(params: KrakenGetWithdrawMethodsParams$1): Promise<KrakenGetWithdrawMethodsResult$1>;
|
|
3232
3447
|
/**
|
|
3233
3448
|
* Retrieve withdrawal addresses available for the user.
|
|
3234
3449
|
*
|
|
@@ -3244,7 +3459,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3244
3459
|
* }
|
|
3245
3460
|
* ```
|
|
3246
3461
|
*/
|
|
3247
|
-
getWithdrawAddresses(params: KrakenGetWithdrawAddressesParams): Promise<KrakenGetWithdrawAddressesResult>;
|
|
3462
|
+
getWithdrawAddresses(params: KrakenGetWithdrawAddressesParams$1): Promise<KrakenGetWithdrawAddressesResult$1>;
|
|
3248
3463
|
/**
|
|
3249
3464
|
* Retrieve fee information about a potential withdrawal for a given
|
|
3250
3465
|
* asset, withdrawal key, and amount.
|
|
@@ -3265,7 +3480,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3265
3480
|
* );
|
|
3266
3481
|
* ```
|
|
3267
3482
|
*/
|
|
3268
|
-
getWithdrawInfo(params: KrakenGetWithdrawInfoParams): Promise<KrakenWithdrawInfo>;
|
|
3483
|
+
getWithdrawInfo(params: KrakenGetWithdrawInfoParams$1): Promise<KrakenWithdrawInfo$1>;
|
|
3269
3484
|
/**
|
|
3270
3485
|
* Make a withdrawal request.
|
|
3271
3486
|
*
|
|
@@ -3280,7 +3495,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3280
3495
|
* console.log("withdrawal refid:", res.refid);
|
|
3281
3496
|
* ```
|
|
3282
3497
|
*/
|
|
3283
|
-
withdrawFunds(params: KrakenWithdrawFundsParams): Promise<KrakenWithdrawFundsResult>;
|
|
3498
|
+
withdrawFunds(params: KrakenWithdrawFundsParams$1): Promise<KrakenWithdrawFundsResult$1>;
|
|
3284
3499
|
/**
|
|
3285
3500
|
* Retrieve information about recent withdrawals.
|
|
3286
3501
|
* Results are sorted by recency. Use `cursor`, `start`, `end` and `limit`
|
|
@@ -3298,7 +3513,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3298
3513
|
* }
|
|
3299
3514
|
* ```
|
|
3300
3515
|
*/
|
|
3301
|
-
getWithdrawStatus(params?: KrakenGetWithdrawStatusParams): Promise<KrakenGetWithdrawStatusResult>;
|
|
3516
|
+
getWithdrawStatus(params?: KrakenGetWithdrawStatusParams$1): Promise<KrakenGetWithdrawStatusResult$1>;
|
|
3302
3517
|
/**
|
|
3303
3518
|
* Request cancellation of a recently requested withdrawal, if it has
|
|
3304
3519
|
* not already been successfully processed.
|
|
@@ -3313,7 +3528,7 @@ declare class KrakenSpotFundingApi {
|
|
|
3313
3528
|
* console.log("cancellation success:", ok);
|
|
3314
3529
|
* ```
|
|
3315
3530
|
*/
|
|
3316
|
-
withdrawCancel(params: KrakenWithdrawCancelParams): Promise<boolean>;
|
|
3531
|
+
withdrawCancel(params: KrakenWithdrawCancelParams$1): Promise<boolean>;
|
|
3317
3532
|
/**
|
|
3318
3533
|
* Request a transfer from a Kraken spot wallet to a Kraken Futures wallet.
|
|
3319
3534
|
*
|
|
@@ -3329,10 +3544,36 @@ declare class KrakenSpotFundingApi {
|
|
|
3329
3544
|
* console.log("wallet transfer refid:", res.refid);
|
|
3330
3545
|
* ```
|
|
3331
3546
|
*/
|
|
3332
|
-
walletTransfer(params: KrakenWalletTransferParams): Promise<KrakenWalletTransferResult>;
|
|
3333
|
-
}
|
|
3547
|
+
walletTransfer(params: KrakenWalletTransferParams$1): Promise<KrakenWalletTransferResult$1>;
|
|
3548
|
+
}
|
|
3549
|
+
type KrakenGetDepositMethodsParams = KrakenGetDepositMethodsParams$1;
|
|
3550
|
+
type KrakenGetDepositMethodsResult = KrakenGetDepositMethodsResult$1;
|
|
3551
|
+
type KrakenDepositMethod = KrakenDepositMethod$1;
|
|
3552
|
+
type KrakenGetDepositAddressesParams = KrakenGetDepositAddressesParams$1;
|
|
3553
|
+
type KrakenGetDepositAddressesResult = KrakenGetDepositAddressesResult$1;
|
|
3554
|
+
type KrakenDepositAddress = KrakenDepositAddress$1;
|
|
3555
|
+
type KrakenGetDepositStatusParams = KrakenGetDepositStatusParams$1;
|
|
3556
|
+
type KrakenDepositStatusEntry = KrakenDepositStatusEntry$1;
|
|
3557
|
+
type KrakenGetWithdrawMethodsParams = KrakenGetWithdrawMethodsParams$1;
|
|
3558
|
+
type KrakenGetWithdrawMethodsResult = KrakenGetWithdrawMethodsResult$1;
|
|
3559
|
+
type KrakenWithdrawMethod = KrakenWithdrawMethod$1;
|
|
3560
|
+
type KrakenGetWithdrawAddressesParams = KrakenGetWithdrawAddressesParams$1;
|
|
3561
|
+
type KrakenGetWithdrawAddressesResult = KrakenGetWithdrawAddressesResult$1;
|
|
3562
|
+
type KrakenWithdrawAddress = KrakenWithdrawAddress$1;
|
|
3563
|
+
type KrakenGetWithdrawInfoParams = KrakenGetWithdrawInfoParams$1;
|
|
3564
|
+
type KrakenGetWithdrawInfoResult = KrakenGetWithdrawInfoResult$1;
|
|
3565
|
+
type KrakenWithdrawInfo = KrakenWithdrawInfo$1;
|
|
3566
|
+
type KrakenWithdrawFundsParams = KrakenWithdrawFundsParams$1;
|
|
3567
|
+
type KrakenWithdrawFundsResult = KrakenWithdrawFundsResponse;
|
|
3568
|
+
type KrakenGetWithdrawStatusParams = KrakenGetWithdrawStatusParams$1;
|
|
3569
|
+
type KrakenGetWithdrawStatusResult = KrakenGetWithdrawStatusResult$1;
|
|
3570
|
+
type KrakenWithdrawStatusEntry = KrakenWithdrawStatusEntry$1;
|
|
3571
|
+
type KrakenWithdrawCancelParams = KrakenWithdrawCancelParams$1;
|
|
3572
|
+
type KrakenWithdrawCancelResult = KrakenWithdrawCancelResult$1;
|
|
3573
|
+
type KrakenWalletTransferParams = KrakenWalletTransferParams$1;
|
|
3574
|
+
type KrakenWalletTransferResult = KrakenWalletTransferResult$1;
|
|
3334
3575
|
|
|
3335
|
-
interface KrakenCreateSubaccountParams {
|
|
3576
|
+
interface KrakenCreateSubaccountParams$1 {
|
|
3336
3577
|
/**
|
|
3337
3578
|
* Username for the subaccount.
|
|
3338
3579
|
*/
|
|
@@ -3342,9 +3583,13 @@ interface KrakenCreateSubaccountParams {
|
|
|
3342
3583
|
*/
|
|
3343
3584
|
email: string;
|
|
3344
3585
|
}
|
|
3586
|
+
/**
|
|
3587
|
+
* Whether subaccount creation was successful or not.
|
|
3588
|
+
*/
|
|
3589
|
+
type KrakenCreateSubaccountResult$1 = boolean;
|
|
3345
3590
|
|
|
3346
3591
|
type KrakenAccountTransferAssetClass = 'currency' | 'tokenized_asset';
|
|
3347
|
-
interface KrakenAccountTransferParams {
|
|
3592
|
+
interface KrakenAccountTransferParams$1 {
|
|
3348
3593
|
/**
|
|
3349
3594
|
* Asset being transferred (e.g. "USDT", "XBT").
|
|
3350
3595
|
*/
|
|
@@ -3368,7 +3613,7 @@ interface KrakenAccountTransferParams {
|
|
|
3368
3613
|
*/
|
|
3369
3614
|
to: string;
|
|
3370
3615
|
}
|
|
3371
|
-
interface KrakenAccountTransferResult {
|
|
3616
|
+
interface KrakenAccountTransferResult$1 {
|
|
3372
3617
|
/**
|
|
3373
3618
|
* Transfer ID.
|
|
3374
3619
|
*/
|
|
@@ -3402,7 +3647,7 @@ declare class KrakenSpotSubaccountsApi {
|
|
|
3402
3647
|
* console.log("subaccount created:", sub);
|
|
3403
3648
|
* ```
|
|
3404
3649
|
*/
|
|
3405
|
-
createSubaccount(params: KrakenCreateSubaccountParams): Promise<boolean>;
|
|
3650
|
+
createSubaccount(params: KrakenCreateSubaccountParams$1): Promise<boolean>;
|
|
3406
3651
|
/**
|
|
3407
3652
|
* Transfer funds between master and subaccounts.
|
|
3408
3653
|
*
|
|
@@ -3420,10 +3665,14 @@ declare class KrakenSpotSubaccountsApi {
|
|
|
3420
3665
|
* console.log(res.transfer_id, res.status);
|
|
3421
3666
|
* ```
|
|
3422
3667
|
*/
|
|
3423
|
-
accountTransfer(params: KrakenAccountTransferParams): Promise<KrakenAccountTransferResult>;
|
|
3668
|
+
accountTransfer(params: KrakenAccountTransferParams$1): Promise<KrakenAccountTransferResult$1>;
|
|
3424
3669
|
}
|
|
3670
|
+
type KrakenCreateSubaccountParams = KrakenCreateSubaccountParams$1;
|
|
3671
|
+
type KrakenCreateSubaccountResult = KrakenCreateSubaccountResult$1;
|
|
3672
|
+
type KrakenAccountTransferParams = KrakenAccountTransferParams$1;
|
|
3673
|
+
type KrakenAccountTransferResult = KrakenAccountTransferResult$1;
|
|
3425
3674
|
|
|
3426
|
-
interface KrakenEarnAllocateFundsParams {
|
|
3675
|
+
interface KrakenEarnAllocateFundsParams$1 {
|
|
3427
3676
|
/**
|
|
3428
3677
|
* The amount to allocate.
|
|
3429
3678
|
* Will be sent to Kraken as a string.
|
|
@@ -3442,9 +3691,9 @@ interface KrakenEarnAllocateFundsParams {
|
|
|
3442
3691
|
* NOTE: This endpoint is asynchronous. You must poll
|
|
3443
3692
|
* /0/private/Earn/AllocateStatus for the final status.
|
|
3444
3693
|
*/
|
|
3445
|
-
type KrakenEarnAllocateFundsResult = boolean | null;
|
|
3694
|
+
type KrakenEarnAllocateFundsResult$1 = boolean | null;
|
|
3446
3695
|
|
|
3447
|
-
interface KrakenEarnDeallocateFundsParams {
|
|
3696
|
+
interface KrakenEarnDeallocateFundsParams$1 {
|
|
3448
3697
|
/**
|
|
3449
3698
|
* The amount to deallocate.
|
|
3450
3699
|
* Will be sent to Kraken as a string.
|
|
@@ -3463,9 +3712,9 @@ interface KrakenEarnDeallocateFundsParams {
|
|
|
3463
3712
|
* /0/private/Earn/DeallocateStatus (and/or use Allocations)
|
|
3464
3713
|
* for the final status.
|
|
3465
3714
|
*/
|
|
3466
|
-
type KrakenEarnDeallocateFundsResult = boolean | null;
|
|
3715
|
+
type KrakenEarnDeallocateFundsResult$1 = boolean | null;
|
|
3467
3716
|
|
|
3468
|
-
interface KrakenEarnGetAllocationStatusParams {
|
|
3717
|
+
interface KrakenEarnGetAllocationStatusParams$1 {
|
|
3469
3718
|
/**
|
|
3470
3719
|
* ID of the earn strategy.
|
|
3471
3720
|
* Call /0/private/Earn/Strategies to list available strategies.
|
|
@@ -3475,7 +3724,7 @@ interface KrakenEarnGetAllocationStatusParams {
|
|
|
3475
3724
|
/**
|
|
3476
3725
|
* Status of async earn (de)allocation operation.
|
|
3477
3726
|
*/
|
|
3478
|
-
interface KrakenEarnAllocationStatus {
|
|
3727
|
+
interface KrakenEarnAllocationStatus$1 {
|
|
3479
3728
|
/**
|
|
3480
3729
|
* true if an operation is still in progress on the same strategy,
|
|
3481
3730
|
* false if it has successfully completed.
|
|
@@ -3487,9 +3736,9 @@ interface KrakenEarnAllocationStatus {
|
|
|
3487
3736
|
* - an object with `pending` when the endpoint returns normally
|
|
3488
3737
|
* - `null` if Kraken ever extends the schema that way (docs say "object|null")
|
|
3489
3738
|
*/
|
|
3490
|
-
type KrakenEarnGetAllocationStatusResult = KrakenEarnAllocationStatus | null;
|
|
3739
|
+
type KrakenEarnGetAllocationStatusResult$1 = KrakenEarnAllocationStatus$1 | null;
|
|
3491
3740
|
|
|
3492
|
-
interface KrakenEarnGetDeallocationStatusParams {
|
|
3741
|
+
interface KrakenEarnGetDeallocationStatusParams$1 {
|
|
3493
3742
|
/**
|
|
3494
3743
|
* ID of the earn strategy.
|
|
3495
3744
|
* Call /0/private/Earn/Strategies to list available strategies.
|
|
@@ -3501,22 +3750,22 @@ interface KrakenEarnGetDeallocationStatusParams {
|
|
|
3501
3750
|
*
|
|
3502
3751
|
* Same shape as AllocateStatus.
|
|
3503
3752
|
*/
|
|
3504
|
-
interface KrakenEarnDeallocationStatus {
|
|
3753
|
+
interface KrakenEarnDeallocationStatus$1 {
|
|
3505
3754
|
/**
|
|
3506
3755
|
* true if an operation is still in progress on the same strategy,
|
|
3507
3756
|
* false if it has successfully completed.
|
|
3508
3757
|
*/
|
|
3509
3758
|
pending: boolean;
|
|
3510
3759
|
}
|
|
3511
|
-
type KrakenEarnGetDeallocationStatusResult = KrakenEarnDeallocationStatus | null;
|
|
3760
|
+
type KrakenEarnGetDeallocationStatusResult$1 = KrakenEarnDeallocationStatus$1 | null;
|
|
3512
3761
|
|
|
3513
|
-
type KrakenEarnLockType = 'flex' | 'bonded' | 'timed' | 'instant';
|
|
3514
|
-
interface KrakenEarnListStrategiesParams {
|
|
3762
|
+
type KrakenEarnLockType$1 = 'flex' | 'bonded' | 'timed' | 'instant';
|
|
3763
|
+
interface KrakenEarnListStrategiesParams$1 {
|
|
3515
3764
|
ascending?: boolean | null;
|
|
3516
3765
|
asset?: string | null;
|
|
3517
3766
|
cursor?: string | null;
|
|
3518
3767
|
limit?: number | null;
|
|
3519
|
-
lock_type?: ReadonlyArray<KrakenEarnLockType> | null;
|
|
3768
|
+
lock_type?: ReadonlyArray<KrakenEarnLockType$1> | null;
|
|
3520
3769
|
}
|
|
3521
3770
|
interface KrakenEarnAprEstimate {
|
|
3522
3771
|
low: string;
|
|
@@ -3529,12 +3778,12 @@ interface KrakenEarnAutoCompoundInfo {
|
|
|
3529
3778
|
type: string;
|
|
3530
3779
|
}
|
|
3531
3780
|
interface KrakenEarnLockTypeInfo {
|
|
3532
|
-
type: KrakenEarnLockType | string;
|
|
3781
|
+
type: KrakenEarnLockType$1 | string;
|
|
3533
3782
|
}
|
|
3534
3783
|
interface KrakenEarnYieldSourceInfo {
|
|
3535
3784
|
type: string;
|
|
3536
3785
|
}
|
|
3537
|
-
interface KrakenEarnStrategy {
|
|
3786
|
+
interface KrakenEarnStrategy$1 {
|
|
3538
3787
|
allocation_fee: KrakenEarnFeeInfo | string | number;
|
|
3539
3788
|
allocation_restriction_info?: string[];
|
|
3540
3789
|
apr_estimate?: KrakenEarnAprEstimate | null;
|
|
@@ -3549,13 +3798,13 @@ interface KrakenEarnStrategy {
|
|
|
3549
3798
|
user_min_allocation?: string | null;
|
|
3550
3799
|
yield_source: KrakenEarnYieldSourceInfo;
|
|
3551
3800
|
}
|
|
3552
|
-
interface KrakenEarnListStrategiesResultObject {
|
|
3553
|
-
items: KrakenEarnStrategy[];
|
|
3801
|
+
interface KrakenEarnListStrategiesResultObject$1 {
|
|
3802
|
+
items: KrakenEarnStrategy$1[];
|
|
3554
3803
|
next_cursor: string | null;
|
|
3555
3804
|
}
|
|
3556
|
-
type KrakenEarnListStrategiesResult = KrakenEarnListStrategiesResultObject | null;
|
|
3805
|
+
type KrakenEarnListStrategiesResult$1 = KrakenEarnListStrategiesResultObject$1 | null;
|
|
3557
3806
|
|
|
3558
|
-
interface KrakenEarnListAllocationsParams {
|
|
3807
|
+
interface KrakenEarnListAllocationsParams$1 {
|
|
3559
3808
|
/**
|
|
3560
3809
|
* true to sort ascending, false (the default) for descending.
|
|
3561
3810
|
*/
|
|
@@ -3574,7 +3823,7 @@ interface KrakenEarnListAllocationsParams {
|
|
|
3574
3823
|
/**
|
|
3575
3824
|
* Simple converted/native pair used in many Earn allocation fields.
|
|
3576
3825
|
*/
|
|
3577
|
-
interface KrakenEarnAmountBreakdown {
|
|
3826
|
+
interface KrakenEarnAmountBreakdown$1 {
|
|
3578
3827
|
/**
|
|
3579
3828
|
* Amount converted into the requested asset.
|
|
3580
3829
|
*/
|
|
@@ -3646,11 +3895,11 @@ interface KrakenEarnAmountAllocated {
|
|
|
3646
3895
|
* operation is a deallocation. Only present when there are
|
|
3647
3896
|
* pending allocations.
|
|
3648
3897
|
*/
|
|
3649
|
-
pending?: KrakenEarnAmountBreakdown | null;
|
|
3898
|
+
pending?: KrakenEarnAmountBreakdown$1 | null;
|
|
3650
3899
|
/**
|
|
3651
3900
|
* Total amount allocated to this Earn strategy.
|
|
3652
3901
|
*/
|
|
3653
|
-
total: KrakenEarnAmountBreakdown;
|
|
3902
|
+
total: KrakenEarnAmountBreakdown$1;
|
|
3654
3903
|
/**
|
|
3655
3904
|
* Amount allocated in unbonding status.
|
|
3656
3905
|
* Only present when there are unbonding allocations.
|
|
@@ -3672,11 +3921,11 @@ interface KrakenEarnPayoutInfo {
|
|
|
3672
3921
|
/**
|
|
3673
3922
|
* Reward accumulated in the payout period until now.
|
|
3674
3923
|
*/
|
|
3675
|
-
accumulated_reward: KrakenEarnAmountBreakdown;
|
|
3924
|
+
accumulated_reward: KrakenEarnAmountBreakdown$1;
|
|
3676
3925
|
/**
|
|
3677
3926
|
* Estimated reward from now until the payout.
|
|
3678
3927
|
*/
|
|
3679
|
-
estimated_reward: KrakenEarnAmountBreakdown;
|
|
3928
|
+
estimated_reward: KrakenEarnAmountBreakdown$1;
|
|
3680
3929
|
/**
|
|
3681
3930
|
* Tentative date of the next reward payout.
|
|
3682
3931
|
*/
|
|
@@ -3690,7 +3939,7 @@ interface KrakenEarnPayoutInfo {
|
|
|
3690
3939
|
/**
|
|
3691
3940
|
* Single allocation entry per strategy.
|
|
3692
3941
|
*/
|
|
3693
|
-
interface KrakenEarnAllocationItem {
|
|
3942
|
+
interface KrakenEarnAllocationItem$1 {
|
|
3694
3943
|
/**
|
|
3695
3944
|
* Amounts allocated to this Earn strategy, broken down by state.
|
|
3696
3945
|
*/
|
|
@@ -3712,12 +3961,12 @@ interface KrakenEarnAllocationItem {
|
|
|
3712
3961
|
* Amount earned using the strategy during the whole lifetime
|
|
3713
3962
|
* of user account.
|
|
3714
3963
|
*/
|
|
3715
|
-
total_rewarded: KrakenEarnAmountBreakdown;
|
|
3964
|
+
total_rewarded: KrakenEarnAmountBreakdown$1;
|
|
3716
3965
|
}
|
|
3717
3966
|
/**
|
|
3718
3967
|
* Page response for /0/private/Earn/Allocations.
|
|
3719
3968
|
*/
|
|
3720
|
-
interface KrakenEarnListAllocationsResultObject {
|
|
3969
|
+
interface KrakenEarnListAllocationsResultObject$1 {
|
|
3721
3970
|
/**
|
|
3722
3971
|
* A secondary asset to show the value of allocations
|
|
3723
3972
|
* (e.g. "USD").
|
|
@@ -3726,7 +3975,7 @@ interface KrakenEarnListAllocationsResultObject {
|
|
|
3726
3975
|
/**
|
|
3727
3976
|
* Per-strategy allocation items.
|
|
3728
3977
|
*/
|
|
3729
|
-
items: KrakenEarnAllocationItem[];
|
|
3978
|
+
items: KrakenEarnAllocationItem$1[];
|
|
3730
3979
|
/**
|
|
3731
3980
|
* The total amount allocated across all strategies,
|
|
3732
3981
|
* denominated in the converted_asset currency.
|
|
@@ -3741,7 +3990,7 @@ interface KrakenEarnListAllocationsResultObject {
|
|
|
3741
3990
|
/**
|
|
3742
3991
|
* `result` is documented as `object|null`.
|
|
3743
3992
|
*/
|
|
3744
|
-
type KrakenEarnListAllocationsResult = KrakenEarnListAllocationsResultObject | null;
|
|
3993
|
+
type KrakenEarnListAllocationsResult$1 = KrakenEarnListAllocationsResultObject$1 | null;
|
|
3745
3994
|
|
|
3746
3995
|
/**
|
|
3747
3996
|
* Kraken Spot Earn API.
|
|
@@ -3773,7 +4022,7 @@ declare class KrakenSpotEarnApi {
|
|
|
3773
4022
|
* }
|
|
3774
4023
|
* ```
|
|
3775
4024
|
*/
|
|
3776
|
-
allocateFunds(params: KrakenEarnAllocateFundsParams): Promise<KrakenEarnAllocateFundsResult>;
|
|
4025
|
+
allocateFunds(params: KrakenEarnAllocateFundsParams$1): Promise<KrakenEarnAllocateFundsResult$1>;
|
|
3777
4026
|
/**
|
|
3778
4027
|
* Deallocate funds from an Earn strategy.
|
|
3779
4028
|
*
|
|
@@ -3795,7 +4044,7 @@ declare class KrakenSpotEarnApi {
|
|
|
3795
4044
|
* }
|
|
3796
4045
|
* ```
|
|
3797
4046
|
*/
|
|
3798
|
-
deallocateFunds(params: KrakenEarnDeallocateFundsParams): Promise<KrakenEarnDeallocateFundsResult>;
|
|
4047
|
+
deallocateFunds(params: KrakenEarnDeallocateFundsParams$1): Promise<KrakenEarnDeallocateFundsResult$1>;
|
|
3799
4048
|
/**
|
|
3800
4049
|
* Get the status of the last allocation/deallocation request for
|
|
3801
4050
|
* a given strategy (allocate-side status).
|
|
@@ -3817,7 +4066,7 @@ declare class KrakenSpotEarnApi {
|
|
|
3817
4066
|
* }
|
|
3818
4067
|
* ```
|
|
3819
4068
|
*/
|
|
3820
|
-
getAllocationStatus(params: KrakenEarnGetAllocationStatusParams): Promise<KrakenEarnGetAllocationStatusResult>;
|
|
4069
|
+
getAllocationStatus(params: KrakenEarnGetAllocationStatusParams$1): Promise<KrakenEarnGetAllocationStatusResult$1>;
|
|
3821
4070
|
/**
|
|
3822
4071
|
* Get the status of the last deallocation request for
|
|
3823
4072
|
* a given strategy (deallocate-side status).
|
|
@@ -3839,7 +4088,7 @@ declare class KrakenSpotEarnApi {
|
|
|
3839
4088
|
* }
|
|
3840
4089
|
* ```
|
|
3841
4090
|
*/
|
|
3842
|
-
getDeallocationStatus(params: KrakenEarnGetDeallocationStatusParams): Promise<KrakenEarnGetDeallocationStatusResult>;
|
|
4091
|
+
getDeallocationStatus(params: KrakenEarnGetDeallocationStatusParams$1): Promise<KrakenEarnGetDeallocationStatusResult$1>;
|
|
3843
4092
|
/**
|
|
3844
4093
|
* List earn strategies available to the user along with their parameters.
|
|
3845
4094
|
*
|
|
@@ -3869,7 +4118,7 @@ declare class KrakenSpotEarnApi {
|
|
|
3869
4118
|
* }
|
|
3870
4119
|
* ```
|
|
3871
4120
|
*/
|
|
3872
|
-
listStrategies(params?: KrakenEarnListStrategiesParams): Promise<KrakenEarnListStrategiesResult>;
|
|
4121
|
+
listStrategies(params?: KrakenEarnListStrategiesParams$1): Promise<KrakenEarnListStrategiesResult$1>;
|
|
3873
4122
|
/**
|
|
3874
4123
|
* List all Earn allocations for the user.
|
|
3875
4124
|
*
|
|
@@ -3903,10 +4152,30 @@ declare class KrakenSpotEarnApi {
|
|
|
3903
4152
|
* }
|
|
3904
4153
|
* ```
|
|
3905
4154
|
*/
|
|
3906
|
-
listAllocations(params?: KrakenEarnListAllocationsParams): Promise<KrakenEarnListAllocationsResult>;
|
|
3907
|
-
}
|
|
4155
|
+
listAllocations(params?: KrakenEarnListAllocationsParams$1): Promise<KrakenEarnListAllocationsResult$1>;
|
|
4156
|
+
}
|
|
4157
|
+
type KrakenEarnAllocateFundsParams = KrakenEarnAllocateFundsParams$1;
|
|
4158
|
+
type KrakenEarnAllocateFundsResult = KrakenEarnAllocateFundsResult$1;
|
|
4159
|
+
type KrakenEarnDeallocateFundsParams = KrakenEarnDeallocateFundsParams$1;
|
|
4160
|
+
type KrakenEarnDeallocateFundsResult = KrakenEarnDeallocateFundsResult$1;
|
|
4161
|
+
type KrakenEarnGetAllocationStatusParams = KrakenEarnGetAllocationStatusParams$1;
|
|
4162
|
+
type KrakenEarnGetAllocationStatusResult = KrakenEarnGetAllocationStatusResult$1;
|
|
4163
|
+
type KrakenEarnAllocationStatus = KrakenEarnAllocationStatus$1;
|
|
4164
|
+
type KrakenEarnGetDeallocationStatusParams = KrakenEarnGetDeallocationStatusParams$1;
|
|
4165
|
+
type KrakenEarnGetDeallocationStatusResult = KrakenEarnGetDeallocationStatusResult$1;
|
|
4166
|
+
type KrakenEarnDeallocationStatus = KrakenEarnDeallocationStatus$1;
|
|
4167
|
+
type KrakenEarnListStrategiesParams = KrakenEarnListStrategiesParams$1;
|
|
4168
|
+
type KrakenEarnListStrategiesResult = KrakenEarnListStrategiesResult$1;
|
|
4169
|
+
type KrakenEarnStrategy = KrakenEarnStrategy$1;
|
|
4170
|
+
type KrakenEarnLockType = KrakenEarnLockType$1;
|
|
4171
|
+
type KrakenEarnListStrategiesResultObject = KrakenEarnListStrategiesResultObject$1;
|
|
4172
|
+
type KrakenEarnListAllocationsParams = KrakenEarnListAllocationsParams$1;
|
|
4173
|
+
type KrakenEarnListAllocationsResult = KrakenEarnListAllocationsResult$1;
|
|
4174
|
+
type KrakenEarnAllocationItem = KrakenEarnAllocationItem$1;
|
|
4175
|
+
type KrakenEarnAmountBreakdown = KrakenEarnAmountBreakdown$1;
|
|
4176
|
+
type KrakenEarnListAllocationsResultObject = KrakenEarnListAllocationsResultObject$1;
|
|
3908
4177
|
|
|
3909
|
-
interface KrakenGetPreTradeDataParams {
|
|
4178
|
+
interface KrakenGetPreTradeDataParams$1 {
|
|
3910
4179
|
/**
|
|
3911
4180
|
* A list of symbols for the currency pairs.
|
|
3912
4181
|
*
|
|
@@ -3924,9 +4193,9 @@ interface KrakenGetPreTradeDataParams {
|
|
|
3924
4193
|
* As of the current Kraken docs, the schema is only documented as "object",
|
|
3925
4194
|
* without field-level detail. We keep this generic to avoid incorrect typing.
|
|
3926
4195
|
*/
|
|
3927
|
-
type KrakenPreTradeDataResult = Record<string, unknown>;
|
|
4196
|
+
type KrakenPreTradeDataResult$1 = Record<string, unknown>;
|
|
3928
4197
|
|
|
3929
|
-
interface KrakenGetPostTradeDataParams {
|
|
4198
|
+
interface KrakenGetPostTradeDataParams$1 {
|
|
3930
4199
|
/**
|
|
3931
4200
|
* Filter the results to the currency pair.
|
|
3932
4201
|
* Example: "BTC/USD"
|
|
@@ -3948,7 +4217,7 @@ interface KrakenGetPostTradeDataParams {
|
|
|
3948
4217
|
*/
|
|
3949
4218
|
count?: number;
|
|
3950
4219
|
}
|
|
3951
|
-
interface KrakenPostTradeEntry {
|
|
4220
|
+
interface KrakenPostTradeEntry$1 {
|
|
3952
4221
|
trade_id: string;
|
|
3953
4222
|
price: string;
|
|
3954
4223
|
quantity: string;
|
|
@@ -3963,10 +4232,10 @@ interface KrakenPostTradeEntry {
|
|
|
3963
4232
|
publication_venue: string;
|
|
3964
4233
|
publication_ts: string;
|
|
3965
4234
|
}
|
|
3966
|
-
interface KrakenGetPostTradeDataResult {
|
|
4235
|
+
interface KrakenGetPostTradeDataResult$1 {
|
|
3967
4236
|
last_ts: string;
|
|
3968
4237
|
count: number;
|
|
3969
|
-
trades: KrakenPostTradeEntry[];
|
|
4238
|
+
trades: KrakenPostTradeEntry$1[];
|
|
3970
4239
|
}
|
|
3971
4240
|
|
|
3972
4241
|
/**
|
|
@@ -3995,7 +4264,7 @@ declare class KrakenSpotTransparencyApi {
|
|
|
3995
4264
|
* console.log(JSON.stringify(preTrade, null, 2));
|
|
3996
4265
|
* ```
|
|
3997
4266
|
*/
|
|
3998
|
-
getPreTradeData(params: KrakenGetPreTradeDataParams): Promise<KrakenPreTradeDataResult>;
|
|
4267
|
+
getPreTradeData(params: KrakenGetPreTradeDataParams$1): Promise<KrakenPreTradeDataResult$1>;
|
|
3999
4268
|
/**
|
|
4000
4269
|
* Get post-trade data (executed trades) on the spot exchange.
|
|
4001
4270
|
*
|
|
@@ -4023,8 +4292,13 @@ declare class KrakenSpotTransparencyApi {
|
|
|
4023
4292
|
* }
|
|
4024
4293
|
* ```
|
|
4025
4294
|
*/
|
|
4026
|
-
getPostTradeData(params?: KrakenGetPostTradeDataParams): Promise<KrakenGetPostTradeDataResult>;
|
|
4295
|
+
getPostTradeData(params?: KrakenGetPostTradeDataParams$1): Promise<KrakenGetPostTradeDataResult$1>;
|
|
4027
4296
|
}
|
|
4297
|
+
type KrakenGetPreTradeDataParams = KrakenGetPreTradeDataParams$1;
|
|
4298
|
+
type KrakenPreTradeDataResult = KrakenPreTradeDataResult$1;
|
|
4299
|
+
type KrakenGetPostTradeDataParams = KrakenGetPostTradeDataParams$1;
|
|
4300
|
+
type KrakenGetPostTradeDataResult = KrakenGetPostTradeDataResult$1;
|
|
4301
|
+
type KrakenPostTradeEntry = KrakenPostTradeEntry$1;
|
|
4028
4302
|
|
|
4029
4303
|
/**
|
|
4030
4304
|
* Kraken Spot REST client.
|
|
@@ -4170,6 +4444,7 @@ declare class KrakenWebsocketBase {
|
|
|
4170
4444
|
private nextReqId;
|
|
4171
4445
|
private readonly pending;
|
|
4172
4446
|
private readonly messageHandlers;
|
|
4447
|
+
private reconnectAttempts;
|
|
4173
4448
|
constructor(options: KrakenWebsocketConnectionOptions);
|
|
4174
4449
|
/** Current readyState of the underlying WebSocket (or -1 if not created). */
|
|
4175
4450
|
get readyState(): number;
|
|
@@ -4230,7 +4505,7 @@ type KrakenWsStatusSystemState = 'online' | 'cancel_only' | 'maintenance' | 'pos
|
|
|
4230
4505
|
*
|
|
4231
4506
|
* Kraken guarantees there is exactly one element in the `data` array.
|
|
4232
4507
|
*/
|
|
4233
|
-
interface KrakenWsStatusData {
|
|
4508
|
+
interface KrakenWsStatusData$1 {
|
|
4234
4509
|
/**
|
|
4235
4510
|
* Trading engine state.
|
|
4236
4511
|
*/
|
|
@@ -4267,15 +4542,15 @@ interface KrakenWsStatusData {
|
|
|
4267
4542
|
* }
|
|
4268
4543
|
* ```
|
|
4269
4544
|
*/
|
|
4270
|
-
interface KrakenWsStatusUpdateMessage {
|
|
4545
|
+
interface KrakenWsStatusUpdateMessage$1 {
|
|
4271
4546
|
channel: 'status';
|
|
4272
4547
|
type: 'update';
|
|
4273
|
-
data: KrakenWsStatusData[];
|
|
4548
|
+
data: KrakenWsStatusData$1[];
|
|
4274
4549
|
}
|
|
4275
4550
|
/**
|
|
4276
4551
|
* Handler for status updates.
|
|
4277
4552
|
*/
|
|
4278
|
-
type KrakenWsStatusHandler = (msg: KrakenWsStatusUpdateMessage) => void;
|
|
4553
|
+
type KrakenWsStatusHandler = (msg: KrakenWsStatusUpdateMessage$1) => void;
|
|
4279
4554
|
|
|
4280
4555
|
/**
|
|
4281
4556
|
* Parameters for WS v2 `ping`.
|
|
@@ -4285,7 +4560,7 @@ type KrakenWsStatusHandler = (msg: KrakenWsStatusUpdateMessage) => void;
|
|
|
4285
4560
|
* - `req_id` is handled via KrakenWebsocketBase.request options,
|
|
4286
4561
|
* so this params object is intentionally empty.
|
|
4287
4562
|
*/
|
|
4288
|
-
interface KrakenWsPingParams {
|
|
4563
|
+
interface KrakenWsPingParams$1 {
|
|
4289
4564
|
}
|
|
4290
4565
|
/**
|
|
4291
4566
|
* Result payload inside the WS envelope for `ping` → `pong`.
|
|
@@ -4294,7 +4569,7 @@ interface KrakenWsPingParams {
|
|
|
4294
4569
|
* Most metadata (success, error, time_in, time_out, etc.) is on the outer
|
|
4295
4570
|
* {@link KrakenWsPingResponse} envelope.
|
|
4296
4571
|
*/
|
|
4297
|
-
interface KrakenWsPingResult {
|
|
4572
|
+
interface KrakenWsPingResult$1 {
|
|
4298
4573
|
/**
|
|
4299
4574
|
* Advisory messages, e.g. deprecation or behaviour notices.
|
|
4300
4575
|
*/
|
|
@@ -4303,7 +4578,7 @@ interface KrakenWsPingResult {
|
|
|
4303
4578
|
/**
|
|
4304
4579
|
* Full WS envelope returned from `ping` (the `pong` message).
|
|
4305
4580
|
*/
|
|
4306
|
-
type KrakenWsPingResponse = KrakenWsMethodResponseEnvelope<KrakenWsPingResult>;
|
|
4581
|
+
type KrakenWsPingResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsPingResult$1>;
|
|
4307
4582
|
/**
|
|
4308
4583
|
* Options for the `ping` wrapper – maps directly to KrakenWebsocketBase.request.
|
|
4309
4584
|
*/
|
|
@@ -4333,7 +4608,7 @@ interface KrakenWsPingOptions {
|
|
|
4333
4608
|
* no other channel updates. There is no subscribe/unsubscribe: they’re
|
|
4334
4609
|
* emitted globally once you’re subscribed to any channel.
|
|
4335
4610
|
*/
|
|
4336
|
-
interface KrakenWsHeartbeatMessage {
|
|
4611
|
+
interface KrakenWsHeartbeatMessage$1 {
|
|
4337
4612
|
/**
|
|
4338
4613
|
* Channel name – "heartbeat" is the only reliable indicator.
|
|
4339
4614
|
* The payload intentionally has no other fields per Kraken docs.
|
|
@@ -4344,7 +4619,7 @@ interface KrakenWsHeartbeatMessage {
|
|
|
4344
4619
|
/**
|
|
4345
4620
|
* Handler signature for heartbeat messages.
|
|
4346
4621
|
*/
|
|
4347
|
-
type KrakenWsHeartbeatHandler = (msg: KrakenWsHeartbeatMessage) => void;
|
|
4622
|
+
type KrakenWsHeartbeatHandler$1 = (msg: KrakenWsHeartbeatMessage$1) => void;
|
|
4348
4623
|
|
|
4349
4624
|
/**
|
|
4350
4625
|
* Kraken Spot WebSocket v2 – Admin / service utilities.
|
|
@@ -4366,7 +4641,7 @@ declare class KrakenSpotWsAdminApi {
|
|
|
4366
4641
|
* console.log('pong?', res.success, res.time_out);
|
|
4367
4642
|
* ```
|
|
4368
4643
|
*/
|
|
4369
|
-
ping(params?: KrakenWsPingParams, options?: KrakenWsPingOptions): Promise<KrakenWsPingResponse>;
|
|
4644
|
+
ping(params?: KrakenWsPingParams$1, options?: KrakenWsPingOptions): Promise<KrakenWsPingResponse$1>;
|
|
4370
4645
|
/**
|
|
4371
4646
|
* Subscribe to engine status updates.
|
|
4372
4647
|
*
|
|
@@ -4392,8 +4667,15 @@ declare class KrakenSpotWsAdminApi {
|
|
|
4392
4667
|
* });
|
|
4393
4668
|
* ```
|
|
4394
4669
|
*/
|
|
4395
|
-
onHeartbeat(handler: KrakenWsHeartbeatHandler): () => void;
|
|
4670
|
+
onHeartbeat(handler: KrakenWsHeartbeatHandler$1): () => void;
|
|
4396
4671
|
}
|
|
4672
|
+
type KrakenWsPingParams = KrakenWsPingParams$1;
|
|
4673
|
+
type KrakenWsPingResult = KrakenWsPingResult$1;
|
|
4674
|
+
type KrakenWsPingResponse = KrakenWsPingResponse$1;
|
|
4675
|
+
type KrakenWsStatusUpdateMessage = KrakenWsStatusUpdateMessage$1;
|
|
4676
|
+
type KrakenWsStatusData = KrakenWsStatusData$1;
|
|
4677
|
+
type KrakenWsHeartbeatMessage = KrakenWsHeartbeatMessage$1;
|
|
4678
|
+
type KrakenWsHeartbeatHandler = KrakenWsHeartbeatHandler$1;
|
|
4397
4679
|
|
|
4398
4680
|
/**
|
|
4399
4681
|
* Event trigger for the ticker channel.
|
|
@@ -4402,13 +4684,76 @@ declare class KrakenSpotWsAdminApi {
|
|
|
4402
4684
|
* - "trades" → update on every trade (default)
|
|
4403
4685
|
*/
|
|
4404
4686
|
type KrakenWsTickerEventTrigger = 'bbo' | 'trades';
|
|
4687
|
+
/**
|
|
4688
|
+
* Ticker payload (top of book + 24h stats).
|
|
4689
|
+
*
|
|
4690
|
+
* The ticker element is always the first (and only) item in the `data` array.
|
|
4691
|
+
*/
|
|
4692
|
+
interface KrakenWsTickerData$1 {
|
|
4693
|
+
/** Best ask price. */
|
|
4694
|
+
ask: number;
|
|
4695
|
+
/** Best ask quantity. */
|
|
4696
|
+
ask_qty: number;
|
|
4697
|
+
/** Best bid price. */
|
|
4698
|
+
bid: number;
|
|
4699
|
+
/** Best bid quantity. */
|
|
4700
|
+
bid_qty: number;
|
|
4701
|
+
/** 24-hour price change (in quote currency). */
|
|
4702
|
+
change: number;
|
|
4703
|
+
/** 24-hour price change (percentage points). */
|
|
4704
|
+
change_pct: number;
|
|
4705
|
+
/** 24-hour highest trade price. */
|
|
4706
|
+
high: number;
|
|
4707
|
+
/** Last traded price (only guaranteed if traded within past 24h). */
|
|
4708
|
+
last: number;
|
|
4709
|
+
/** 24-hour lowest trade price. */
|
|
4710
|
+
low: number;
|
|
4711
|
+
/** The symbol of the currency pair (e.g. "BTC/USD"). */
|
|
4712
|
+
symbol: string;
|
|
4713
|
+
/** 24-hour traded volume (in base currency). */
|
|
4714
|
+
volume: number;
|
|
4715
|
+
/** 24-hour volume weighted average price. */
|
|
4716
|
+
vwap: number;
|
|
4717
|
+
}
|
|
4718
|
+
/**
|
|
4719
|
+
* Snapshot message for the `ticker` channel.
|
|
4720
|
+
*
|
|
4721
|
+
* `data` will always contain exactly one ticker entry.
|
|
4722
|
+
*/
|
|
4723
|
+
interface KrakenWsTickerSnapshotMessage$1 {
|
|
4724
|
+
channel: 'ticker';
|
|
4725
|
+
type: 'snapshot';
|
|
4726
|
+
data: KrakenWsTickerData$1[];
|
|
4727
|
+
/**
|
|
4728
|
+
* Subscription message sequence number.
|
|
4729
|
+
*/
|
|
4730
|
+
sequence: number;
|
|
4731
|
+
}
|
|
4732
|
+
/**
|
|
4733
|
+
* Update message for the `ticker` channel.
|
|
4734
|
+
*
|
|
4735
|
+
* `data` will always contain exactly one ticker entry.
|
|
4736
|
+
*/
|
|
4737
|
+
interface KrakenWsTickerUpdateMessage$1 {
|
|
4738
|
+
channel: 'ticker';
|
|
4739
|
+
type: 'update';
|
|
4740
|
+
data: KrakenWsTickerData$1[];
|
|
4741
|
+
/**
|
|
4742
|
+
* Subscription message sequence number.
|
|
4743
|
+
*/
|
|
4744
|
+
sequence: number;
|
|
4745
|
+
}
|
|
4746
|
+
/**
|
|
4747
|
+
* Union of possible ticker messages.
|
|
4748
|
+
*/
|
|
4749
|
+
type KrakenWsTickerMessage$1 = KrakenWsTickerSnapshotMessage$1 | KrakenWsTickerUpdateMessage$1;
|
|
4405
4750
|
/**
|
|
4406
4751
|
* Parameters for subscribing to the `ticker` channel.
|
|
4407
4752
|
*
|
|
4408
4753
|
* NOTE:
|
|
4409
4754
|
* - `channel` is automatically set to "ticker" by the helper.
|
|
4410
4755
|
*/
|
|
4411
|
-
interface KrakenWsTickerSubscribeParams {
|
|
4756
|
+
interface KrakenWsTickerSubscribeParams$1 {
|
|
4412
4757
|
/**
|
|
4413
4758
|
* A list of currency pairs, e.g. ["BTC/USD", "MATIC/GBP"].
|
|
4414
4759
|
*/
|
|
@@ -4432,7 +4777,7 @@ interface KrakenWsTickerSubscribeParams {
|
|
|
4432
4777
|
/**
|
|
4433
4778
|
* Options for subscribeTicker wrapper – mapped to KrakenWebsocketBase.request.
|
|
4434
4779
|
*/
|
|
4435
|
-
interface KrakenWsTickerSubscribeOptions {
|
|
4780
|
+
interface KrakenWsTickerSubscribeOptions$1 {
|
|
4436
4781
|
reqId?: number;
|
|
4437
4782
|
timeoutMs?: number;
|
|
4438
4783
|
/**
|
|
@@ -4458,14 +4803,14 @@ interface KrakenWsTickerSubscribeResult {
|
|
|
4458
4803
|
/**
|
|
4459
4804
|
* Full WS envelope returned from subscribe (ack) for ticker.
|
|
4460
4805
|
*/
|
|
4461
|
-
type KrakenWsTickerSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsTickerSubscribeResult>;
|
|
4806
|
+
type KrakenWsTickerSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsTickerSubscribeResult>;
|
|
4462
4807
|
/**
|
|
4463
4808
|
* Parameters for unsubscribing from the `ticker` channel.
|
|
4464
4809
|
*
|
|
4465
4810
|
* NOTE:
|
|
4466
4811
|
* - Must match the symbols (and optionally event_trigger) you want to remove.
|
|
4467
4812
|
*/
|
|
4468
|
-
interface KrakenWsTickerUnsubscribeParams {
|
|
4813
|
+
interface KrakenWsTickerUnsubscribeParams$1 {
|
|
4469
4814
|
/**
|
|
4470
4815
|
* A list of currency pairs to unsubscribe.
|
|
4471
4816
|
*/
|
|
@@ -4480,7 +4825,7 @@ interface KrakenWsTickerUnsubscribeParams {
|
|
|
4480
4825
|
/**
|
|
4481
4826
|
* Options for unsubscribeTicker wrapper.
|
|
4482
4827
|
*/
|
|
4483
|
-
interface KrakenWsTickerUnsubscribeOptions {
|
|
4828
|
+
interface KrakenWsTickerUnsubscribeOptions$1 {
|
|
4484
4829
|
reqId?: number;
|
|
4485
4830
|
timeoutMs?: number;
|
|
4486
4831
|
attachAuthToken?: boolean;
|
|
@@ -4497,19 +4842,78 @@ interface KrakenWsTickerUnsubscribeResult {
|
|
|
4497
4842
|
/**
|
|
4498
4843
|
* Full WS envelope returned from unsubscribe (ack) for ticker.
|
|
4499
4844
|
*/
|
|
4500
|
-
type KrakenWsTickerUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsTickerUnsubscribeResult>;
|
|
4845
|
+
type KrakenWsTickerUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsTickerUnsubscribeResult>;
|
|
4501
4846
|
|
|
4502
4847
|
/**
|
|
4503
4848
|
* Allowed depth values for the book channel.
|
|
4504
4849
|
*/
|
|
4505
4850
|
type KrakenWsBookDepth = 10 | 25 | 100 | 500 | 1000;
|
|
4851
|
+
/**
|
|
4852
|
+
* Single price level entry in the L2 order book.
|
|
4853
|
+
*/
|
|
4854
|
+
interface KrakenWsBookLevel$1 {
|
|
4855
|
+
/** Price at this level. */
|
|
4856
|
+
price: number;
|
|
4857
|
+
/** Aggregate quantity at this level. */
|
|
4858
|
+
qty: number;
|
|
4859
|
+
}
|
|
4860
|
+
/**
|
|
4861
|
+
* Core book payload (used in both snapshot and update).
|
|
4862
|
+
*
|
|
4863
|
+
* The book element is always the first and only item in the `data` array.
|
|
4864
|
+
*/
|
|
4865
|
+
interface KrakenWsBookData {
|
|
4866
|
+
/** Ask side levels. */
|
|
4867
|
+
asks: KrakenWsBookLevel$1[];
|
|
4868
|
+
/** Bid side levels. */
|
|
4869
|
+
bids: KrakenWsBookLevel$1[];
|
|
4870
|
+
/** CRC32 checksum for top 10 bids/asks. */
|
|
4871
|
+
checksum: number;
|
|
4872
|
+
/** The symbol of the currency pair (e.g. "BTC/USD"). */
|
|
4873
|
+
symbol: string;
|
|
4874
|
+
}
|
|
4875
|
+
/**
|
|
4876
|
+
* Snapshot message for the `book` channel.
|
|
4877
|
+
*/
|
|
4878
|
+
interface KrakenWsBookSnapshotMessage$1 {
|
|
4879
|
+
channel: 'book';
|
|
4880
|
+
type: 'snapshot';
|
|
4881
|
+
data: KrakenWsBookData[];
|
|
4882
|
+
/**
|
|
4883
|
+
* Subscription message sequence number.
|
|
4884
|
+
*/
|
|
4885
|
+
sequence: number;
|
|
4886
|
+
}
|
|
4887
|
+
/**
|
|
4888
|
+
* Update message for the `book` channel.
|
|
4889
|
+
*
|
|
4890
|
+
* Includes a timestamp for the book update.
|
|
4891
|
+
*/
|
|
4892
|
+
interface KrakenWsBookUpdateMessage$1 {
|
|
4893
|
+
channel: 'book';
|
|
4894
|
+
type: 'update';
|
|
4895
|
+
data: Array<KrakenWsBookData & {
|
|
4896
|
+
/**
|
|
4897
|
+
* Order book update timestamp (RFC3339 with fractional seconds).
|
|
4898
|
+
*/
|
|
4899
|
+
timestamp: string;
|
|
4900
|
+
}>;
|
|
4901
|
+
/**
|
|
4902
|
+
* Subscription message sequence number.
|
|
4903
|
+
*/
|
|
4904
|
+
sequence: number;
|
|
4905
|
+
}
|
|
4906
|
+
/**
|
|
4907
|
+
* Union of possible book messages.
|
|
4908
|
+
*/
|
|
4909
|
+
type KrakenWsBookMessage$1 = KrakenWsBookSnapshotMessage$1 | KrakenWsBookUpdateMessage$1;
|
|
4506
4910
|
/**
|
|
4507
4911
|
* Parameters for subscribing to the `book` channel.
|
|
4508
4912
|
*
|
|
4509
4913
|
* NOTE:
|
|
4510
4914
|
* - `channel` is automatically set to "book" by the helper.
|
|
4511
4915
|
*/
|
|
4512
|
-
interface KrakenWsBookSubscribeParams {
|
|
4916
|
+
interface KrakenWsBookSubscribeParams$1 {
|
|
4513
4917
|
/**
|
|
4514
4918
|
* A list of currency pairs, e.g. ["BTC/USD", "MATIC/GBP"].
|
|
4515
4919
|
*/
|
|
@@ -4532,7 +4936,7 @@ interface KrakenWsBookSubscribeParams {
|
|
|
4532
4936
|
/**
|
|
4533
4937
|
* Options for subscribeBook wrapper – mapped to KrakenWebsocketBase.request.
|
|
4534
4938
|
*/
|
|
4535
|
-
interface KrakenWsBookSubscribeOptions {
|
|
4939
|
+
interface KrakenWsBookSubscribeOptions$1 {
|
|
4536
4940
|
reqId?: number;
|
|
4537
4941
|
timeoutMs?: number;
|
|
4538
4942
|
/**
|
|
@@ -4552,14 +4956,14 @@ interface KrakenWsBookSubscribeResult {
|
|
|
4552
4956
|
/**
|
|
4553
4957
|
* Full WS envelope returned from subscribe (ack) for book.
|
|
4554
4958
|
*/
|
|
4555
|
-
type KrakenWsBookSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsBookSubscribeResult>;
|
|
4959
|
+
type KrakenWsBookSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBookSubscribeResult>;
|
|
4556
4960
|
/**
|
|
4557
4961
|
* Parameters for unsubscribing from the `book` channel.
|
|
4558
4962
|
*
|
|
4559
4963
|
* NOTE:
|
|
4560
4964
|
* - Must match the symbols (and depth, if used) you want to remove.
|
|
4561
4965
|
*/
|
|
4562
|
-
interface KrakenWsBookUnsubscribeParams {
|
|
4966
|
+
interface KrakenWsBookUnsubscribeParams$1 {
|
|
4563
4967
|
/**
|
|
4564
4968
|
* A list of currency pairs to unsubscribe.
|
|
4565
4969
|
*/
|
|
@@ -4574,7 +4978,7 @@ interface KrakenWsBookUnsubscribeParams {
|
|
|
4574
4978
|
/**
|
|
4575
4979
|
* Options for unsubscribeBook wrapper.
|
|
4576
4980
|
*/
|
|
4577
|
-
interface KrakenWsBookUnsubscribeOptions {
|
|
4981
|
+
interface KrakenWsBookUnsubscribeOptions$1 {
|
|
4578
4982
|
reqId?: number;
|
|
4579
4983
|
timeoutMs?: number;
|
|
4580
4984
|
attachAuthToken?: boolean;
|
|
@@ -4591,12 +4995,114 @@ interface KrakenWsBookUnsubscribeResult {
|
|
|
4591
4995
|
/**
|
|
4592
4996
|
* Full WS envelope returned from unsubscribe (ack) for book.
|
|
4593
4997
|
*/
|
|
4594
|
-
type KrakenWsBookUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsBookUnsubscribeResult>;
|
|
4998
|
+
type KrakenWsBookUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBookUnsubscribeResult>;
|
|
4595
4999
|
|
|
4596
5000
|
/**
|
|
4597
5001
|
* Allowed depth values for the level3 channel.
|
|
4598
5002
|
*/
|
|
4599
|
-
type KrakenWsLevel3Depth = 10 | 100 | 1000;
|
|
5003
|
+
type KrakenWsLevel3Depth$1 = 10 | 100 | 1000;
|
|
5004
|
+
/**
|
|
5005
|
+
* Event type for Level 3 order updates.
|
|
5006
|
+
*
|
|
5007
|
+
* - "add" → new order resting in the book
|
|
5008
|
+
* - "modify" → quantity modified (typically due to a fill)
|
|
5009
|
+
* - "delete" → order removed (full fill or cancel)
|
|
5010
|
+
*/
|
|
5011
|
+
type KrakenWsLevel3OrderEventType$1 = 'add' | 'modify' | 'delete';
|
|
5012
|
+
/**
|
|
5013
|
+
* Single Level 3 order snapshot entry.
|
|
5014
|
+
*
|
|
5015
|
+
* Used in the initial snapshot (no event field).
|
|
5016
|
+
*/
|
|
5017
|
+
interface KrakenWsLevel3OrderSnapshotEntry {
|
|
5018
|
+
/** Kraken order identifier of the order in the book. */
|
|
5019
|
+
order_id: string;
|
|
5020
|
+
/** Limit price of the order. */
|
|
5021
|
+
limit_price: number;
|
|
5022
|
+
/** Remaining visible quantity. */
|
|
5023
|
+
order_qty: number;
|
|
5024
|
+
/** Time the order was inserted or amended (RFC3339). */
|
|
5025
|
+
timestamp: string;
|
|
5026
|
+
}
|
|
5027
|
+
/**
|
|
5028
|
+
* Single Level 3 order event entry (update).
|
|
5029
|
+
*
|
|
5030
|
+
* Used in the update stream (adds/modifies/deletes).
|
|
5031
|
+
*/
|
|
5032
|
+
interface KrakenWsLevel3OrderEventEntry extends KrakenWsLevel3OrderSnapshotEntry {
|
|
5033
|
+
/** Type of order event. */
|
|
5034
|
+
event: KrakenWsLevel3OrderEventType$1;
|
|
5035
|
+
}
|
|
5036
|
+
/**
|
|
5037
|
+
* Core Level 3 snapshot payload.
|
|
5038
|
+
*
|
|
5039
|
+
* The book element is always the first and only item in the `data` array.
|
|
5040
|
+
*/
|
|
5041
|
+
interface KrakenWsLevel3SnapshotData {
|
|
5042
|
+
/** Symbol of the currency pair, e.g. "BTC/USD". */
|
|
5043
|
+
symbol: string;
|
|
5044
|
+
/** List of resting bid orders in the book. */
|
|
5045
|
+
bids: KrakenWsLevel3OrderSnapshotEntry[];
|
|
5046
|
+
/** List of resting ask orders in the book. */
|
|
5047
|
+
asks: KrakenWsLevel3OrderSnapshotEntry[];
|
|
5048
|
+
/** CRC32 checksum for the top 10 price levels on both sides. */
|
|
5049
|
+
checksum: number;
|
|
5050
|
+
/** Time this market data message was generated (RFC3339). */
|
|
5051
|
+
timestamp: string;
|
|
5052
|
+
}
|
|
5053
|
+
/**
|
|
5054
|
+
* Core Level 3 update payload.
|
|
5055
|
+
*
|
|
5056
|
+
* The book element is always the first and only item in the `data` array.
|
|
5057
|
+
*/
|
|
5058
|
+
interface KrakenWsLevel3UpdateData {
|
|
5059
|
+
/** Symbol of the currency pair, e.g. "BTC/USD". */
|
|
5060
|
+
symbol: string;
|
|
5061
|
+
/** Time this market data message was generated (RFC3339). */
|
|
5062
|
+
timestamp: string;
|
|
5063
|
+
/** CRC32 checksum for the top 10 price levels on both sides. */
|
|
5064
|
+
checksum: number;
|
|
5065
|
+
/**
|
|
5066
|
+
* Order events on bid side.
|
|
5067
|
+
*
|
|
5068
|
+
* Each entry describes an add/modify/delete event for an order.
|
|
5069
|
+
*/
|
|
5070
|
+
bids: KrakenWsLevel3OrderEventEntry[];
|
|
5071
|
+
/**
|
|
5072
|
+
* Order events on ask side.
|
|
5073
|
+
*
|
|
5074
|
+
* Each entry describes an add/modify/delete event for an order.
|
|
5075
|
+
*/
|
|
5076
|
+
asks: KrakenWsLevel3OrderEventEntry[];
|
|
5077
|
+
}
|
|
5078
|
+
/**
|
|
5079
|
+
* Snapshot message for the `level3` channel.
|
|
5080
|
+
*/
|
|
5081
|
+
interface KrakenWsLevel3SnapshotMessage$1 {
|
|
5082
|
+
channel: 'level3';
|
|
5083
|
+
type: 'snapshot';
|
|
5084
|
+
data: KrakenWsLevel3SnapshotData[];
|
|
5085
|
+
/**
|
|
5086
|
+
* Subscription message sequence number.
|
|
5087
|
+
*/
|
|
5088
|
+
sequence: number;
|
|
5089
|
+
}
|
|
5090
|
+
/**
|
|
5091
|
+
* Update message for the `level3` channel.
|
|
5092
|
+
*/
|
|
5093
|
+
interface KrakenWsLevel3UpdateMessage$1 {
|
|
5094
|
+
channel: 'level3';
|
|
5095
|
+
type: 'update';
|
|
5096
|
+
data: KrakenWsLevel3UpdateData[];
|
|
5097
|
+
/**
|
|
5098
|
+
* Subscription message sequence number.
|
|
5099
|
+
*/
|
|
5100
|
+
sequence: number;
|
|
5101
|
+
}
|
|
5102
|
+
/**
|
|
5103
|
+
* Union of possible Level 3 messages.
|
|
5104
|
+
*/
|
|
5105
|
+
type KrakenWsLevel3Message$1 = KrakenWsLevel3SnapshotMessage$1 | KrakenWsLevel3UpdateMessage$1;
|
|
4600
5106
|
/**
|
|
4601
5107
|
* Parameters for subscribing to the `level3` channel.
|
|
4602
5108
|
*
|
|
@@ -4604,7 +5110,7 @@ type KrakenWsLevel3Depth = 10 | 100 | 1000;
|
|
|
4604
5110
|
* - `channel` is automatically set to "level3" by the helper.
|
|
4605
5111
|
* - `token` is required (authenticated feed).
|
|
4606
5112
|
*/
|
|
4607
|
-
interface KrakenWsLevel3SubscribeParams {
|
|
5113
|
+
interface KrakenWsLevel3SubscribeParams$1 {
|
|
4608
5114
|
/**
|
|
4609
5115
|
* A list of currency pairs, e.g. ["BTC/USD", "MATIC/GBP"].
|
|
4610
5116
|
*/
|
|
@@ -4613,7 +5119,7 @@ interface KrakenWsLevel3SubscribeParams {
|
|
|
4613
5119
|
* Number of price levels to receive.
|
|
4614
5120
|
* Default: 10.
|
|
4615
5121
|
*/
|
|
4616
|
-
depth?: KrakenWsLevel3Depth;
|
|
5122
|
+
depth?: KrakenWsLevel3Depth$1;
|
|
4617
5123
|
/**
|
|
4618
5124
|
* Whether to request an initial snapshot.
|
|
4619
5125
|
* Default: true.
|
|
@@ -4631,7 +5137,7 @@ interface KrakenWsLevel3SubscribeParams {
|
|
|
4631
5137
|
/**
|
|
4632
5138
|
* Options for subscribeLevel3 wrapper – mapped to KrakenWebsocketBase.request.
|
|
4633
5139
|
*/
|
|
4634
|
-
interface KrakenWsLevel3SubscribeOptions {
|
|
5140
|
+
interface KrakenWsLevel3SubscribeOptions$1 {
|
|
4635
5141
|
reqId?: number;
|
|
4636
5142
|
timeoutMs?: number;
|
|
4637
5143
|
/**
|
|
@@ -4645,14 +5151,14 @@ interface KrakenWsLevel3SubscribeOptions {
|
|
|
4645
5151
|
interface KrakenWsLevel3SubscribeResult {
|
|
4646
5152
|
channel: 'level3';
|
|
4647
5153
|
symbol: ReadonlyArray<string>;
|
|
4648
|
-
depth?: KrakenWsLevel3Depth;
|
|
5154
|
+
depth?: KrakenWsLevel3Depth$1;
|
|
4649
5155
|
snapshot?: boolean;
|
|
4650
5156
|
[key: string]: unknown;
|
|
4651
5157
|
}
|
|
4652
5158
|
/**
|
|
4653
5159
|
* Full WS envelope returned from subscribe (ack) for level3.
|
|
4654
5160
|
*/
|
|
4655
|
-
type KrakenWsLevel3SubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsLevel3SubscribeResult>;
|
|
5161
|
+
type KrakenWsLevel3SubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsLevel3SubscribeResult>;
|
|
4656
5162
|
/**
|
|
4657
5163
|
* Parameters for unsubscribing from the `level3` channel.
|
|
4658
5164
|
*
|
|
@@ -4660,7 +5166,7 @@ type KrakenWsLevel3SubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsLe
|
|
|
4660
5166
|
* - Must match the symbols (and depth, if used) you want to remove.
|
|
4661
5167
|
* - `token` is required (authenticated feed).
|
|
4662
5168
|
*/
|
|
4663
|
-
interface KrakenWsLevel3UnsubscribeParams {
|
|
5169
|
+
interface KrakenWsLevel3UnsubscribeParams$1 {
|
|
4664
5170
|
/**
|
|
4665
5171
|
* A list of currency pairs to unsubscribe.
|
|
4666
5172
|
*/
|
|
@@ -4669,7 +5175,7 @@ interface KrakenWsLevel3UnsubscribeParams {
|
|
|
4669
5175
|
* Number of price levels to unsubscribe.
|
|
4670
5176
|
* Must match the subscribed depth if specified.
|
|
4671
5177
|
*/
|
|
4672
|
-
depth?: KrakenWsLevel3Depth;
|
|
5178
|
+
depth?: KrakenWsLevel3Depth$1;
|
|
4673
5179
|
/**
|
|
4674
5180
|
* Auth session token from the REST API.
|
|
4675
5181
|
*/
|
|
@@ -4679,7 +5185,7 @@ interface KrakenWsLevel3UnsubscribeParams {
|
|
|
4679
5185
|
/**
|
|
4680
5186
|
* Options for unsubscribeLevel3 wrapper.
|
|
4681
5187
|
*/
|
|
4682
|
-
interface KrakenWsLevel3UnsubscribeOptions {
|
|
5188
|
+
interface KrakenWsLevel3UnsubscribeOptions$1 {
|
|
4683
5189
|
reqId?: number;
|
|
4684
5190
|
timeoutMs?: number;
|
|
4685
5191
|
attachAuthToken?: boolean;
|
|
@@ -4690,25 +5196,96 @@ interface KrakenWsLevel3UnsubscribeOptions {
|
|
|
4690
5196
|
interface KrakenWsLevel3UnsubscribeResult {
|
|
4691
5197
|
channel: 'level3';
|
|
4692
5198
|
symbol: ReadonlyArray<string>;
|
|
4693
|
-
depth?: KrakenWsLevel3Depth;
|
|
5199
|
+
depth?: KrakenWsLevel3Depth$1;
|
|
4694
5200
|
[key: string]: unknown;
|
|
4695
5201
|
}
|
|
4696
5202
|
/**
|
|
4697
5203
|
* Full WS envelope returned from unsubscribe (ack) for level3.
|
|
4698
5204
|
*/
|
|
4699
|
-
type KrakenWsLevel3UnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsLevel3UnsubscribeResult>;
|
|
5205
|
+
type KrakenWsLevel3UnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsLevel3UnsubscribeResult>;
|
|
4700
5206
|
|
|
4701
5207
|
/**
|
|
4702
5208
|
* Allowed OHLC intervals in minutes.
|
|
4703
5209
|
*/
|
|
4704
5210
|
type KrakenWsOhlcInterval = 1 | 5 | 15 | 30 | 60 | 240 | 1440 | 10080 | 21600;
|
|
5211
|
+
/**
|
|
5212
|
+
* Single OHLC candle entry.
|
|
5213
|
+
*
|
|
5214
|
+
* Used in both snapshot and update messages.
|
|
5215
|
+
*/
|
|
5216
|
+
interface KrakenWsOhlcCandle {
|
|
5217
|
+
/** Symbol of the currency pair, e.g. "BTC/USD". */
|
|
5218
|
+
symbol: string;
|
|
5219
|
+
/** Opening trade price within the interval. */
|
|
5220
|
+
open: number;
|
|
5221
|
+
/** Highest trade price within the interval. */
|
|
5222
|
+
high: number;
|
|
5223
|
+
/** Lowest trade price within the interval. */
|
|
5224
|
+
low: number;
|
|
5225
|
+
/** Last trade price within the interval. */
|
|
5226
|
+
close: number;
|
|
5227
|
+
/** Volume-weighted average trade price within the interval. */
|
|
5228
|
+
vwap: number;
|
|
5229
|
+
/** Number of trades within the interval. */
|
|
5230
|
+
trades: number;
|
|
5231
|
+
/** Total traded volume (base asset) within the interval. */
|
|
5232
|
+
volume: number;
|
|
5233
|
+
/**
|
|
5234
|
+
* Timestamp of the start of the interval (RFC3339 with fractional seconds).
|
|
5235
|
+
*/
|
|
5236
|
+
interval_begin: string;
|
|
5237
|
+
/**
|
|
5238
|
+
* Interval timeframe in minutes.
|
|
5239
|
+
*/
|
|
5240
|
+
interval: KrakenWsOhlcInterval;
|
|
5241
|
+
/**
|
|
5242
|
+
* DEPRECATED: Use `interval_begin`.
|
|
5243
|
+
*
|
|
5244
|
+
* Timestamp of start of the interval.
|
|
5245
|
+
*/
|
|
5246
|
+
timestamp?: string;
|
|
5247
|
+
}
|
|
5248
|
+
/**
|
|
5249
|
+
* Snapshot message for the `ohlc` channel.
|
|
5250
|
+
*/
|
|
5251
|
+
interface KrakenWsOhlcSnapshotMessage$1 {
|
|
5252
|
+
channel: 'ohlc';
|
|
5253
|
+
type: 'snapshot';
|
|
5254
|
+
/**
|
|
5255
|
+
* List of candle events.
|
|
5256
|
+
*/
|
|
5257
|
+
data: KrakenWsOhlcCandle[];
|
|
5258
|
+
/**
|
|
5259
|
+
* Subscription message sequence number.
|
|
5260
|
+
*/
|
|
5261
|
+
sequence: number;
|
|
5262
|
+
}
|
|
5263
|
+
/**
|
|
5264
|
+
* Update message for the `ohlc` channel.
|
|
5265
|
+
*/
|
|
5266
|
+
interface KrakenWsOhlcUpdateMessage$1 {
|
|
5267
|
+
channel: 'ohlc';
|
|
5268
|
+
type: 'update';
|
|
5269
|
+
/**
|
|
5270
|
+
* List of candle events.
|
|
5271
|
+
*/
|
|
5272
|
+
data: KrakenWsOhlcCandle[];
|
|
5273
|
+
/**
|
|
5274
|
+
* Subscription message sequence number.
|
|
5275
|
+
*/
|
|
5276
|
+
sequence: number;
|
|
5277
|
+
}
|
|
5278
|
+
/**
|
|
5279
|
+
* Union of possible OHLC messages.
|
|
5280
|
+
*/
|
|
5281
|
+
type KrakenWsOhlcMessage$1 = KrakenWsOhlcSnapshotMessage$1 | KrakenWsOhlcUpdateMessage$1;
|
|
4705
5282
|
/**
|
|
4706
5283
|
* Parameters for subscribing to the `ohlc` channel.
|
|
4707
5284
|
*
|
|
4708
5285
|
* NOTE:
|
|
4709
5286
|
* - `channel` is automatically set to "ohlc" by the helper.
|
|
4710
5287
|
*/
|
|
4711
|
-
interface KrakenWsOhlcSubscribeParams {
|
|
5288
|
+
interface KrakenWsOhlcSubscribeParams$1 {
|
|
4712
5289
|
/**
|
|
4713
5290
|
* A list of currency pairs, e.g. ["BTC/USD", "MATIC/GBP"].
|
|
4714
5291
|
*/
|
|
@@ -4732,7 +5309,7 @@ interface KrakenWsOhlcSubscribeParams {
|
|
|
4732
5309
|
/**
|
|
4733
5310
|
* Options for subscribeOhlc wrapper – mapped to KrakenWebsocketBase.request.
|
|
4734
5311
|
*/
|
|
4735
|
-
interface KrakenWsOhlcSubscribeOptions {
|
|
5312
|
+
interface KrakenWsOhlcSubscribeOptions$1 {
|
|
4736
5313
|
reqId?: number;
|
|
4737
5314
|
timeoutMs?: number;
|
|
4738
5315
|
/**
|
|
@@ -4752,14 +5329,14 @@ interface KrakenWsOhlcSubscribeResult {
|
|
|
4752
5329
|
/**
|
|
4753
5330
|
* Full WS envelope returned from subscribe (ack) for ohlc.
|
|
4754
5331
|
*/
|
|
4755
|
-
type KrakenWsOhlcSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsOhlcSubscribeResult>;
|
|
5332
|
+
type KrakenWsOhlcSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsOhlcSubscribeResult>;
|
|
4756
5333
|
/**
|
|
4757
5334
|
* Parameters for unsubscribing from the `ohlc` channel.
|
|
4758
5335
|
*
|
|
4759
5336
|
* NOTE:
|
|
4760
5337
|
* - Must match the symbols (and interval, if used) you want to remove.
|
|
4761
5338
|
*/
|
|
4762
|
-
interface KrakenWsOhlcUnsubscribeParams {
|
|
5339
|
+
interface KrakenWsOhlcUnsubscribeParams$1 {
|
|
4763
5340
|
/**
|
|
4764
5341
|
* A list of currency pairs to unsubscribe.
|
|
4765
5342
|
*/
|
|
@@ -4773,7 +5350,7 @@ interface KrakenWsOhlcUnsubscribeParams {
|
|
|
4773
5350
|
/**
|
|
4774
5351
|
* Options for unsubscribeOhlc wrapper.
|
|
4775
5352
|
*/
|
|
4776
|
-
interface KrakenWsOhlcUnsubscribeOptions {
|
|
5353
|
+
interface KrakenWsOhlcUnsubscribeOptions$1 {
|
|
4777
5354
|
reqId?: number;
|
|
4778
5355
|
timeoutMs?: number;
|
|
4779
5356
|
attachAuthToken?: boolean;
|
|
@@ -4790,15 +5367,96 @@ interface KrakenWsOhlcUnsubscribeResult {
|
|
|
4790
5367
|
/**
|
|
4791
5368
|
* Full WS envelope returned from unsubscribe (ack) for ohlc.
|
|
4792
5369
|
*/
|
|
4793
|
-
type KrakenWsOhlcUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsOhlcUnsubscribeResult>;
|
|
5370
|
+
type KrakenWsOhlcUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsOhlcUnsubscribeResult>;
|
|
4794
5371
|
|
|
5372
|
+
/**
|
|
5373
|
+
* Trade side for the taker order.
|
|
5374
|
+
*/
|
|
5375
|
+
type KrakenWsTradeSide$1 = 'buy' | 'sell';
|
|
5376
|
+
/**
|
|
5377
|
+
* Taker order type for a trade event.
|
|
5378
|
+
*/
|
|
5379
|
+
type KrakenWsTradeOrderType$1 = 'limit' | 'market';
|
|
5380
|
+
/**
|
|
5381
|
+
* Single trade event from the `trade` channel.
|
|
5382
|
+
*
|
|
5383
|
+
* Used in both snapshot and update messages.
|
|
5384
|
+
*/
|
|
5385
|
+
interface KrakenWsTradeEntry$1 {
|
|
5386
|
+
/**
|
|
5387
|
+
* Symbol of the currency pair, e.g. "BTC/USD".
|
|
5388
|
+
*/
|
|
5389
|
+
symbol: string;
|
|
5390
|
+
/**
|
|
5391
|
+
* Side of the taker order ("buy" or "sell").
|
|
5392
|
+
*/
|
|
5393
|
+
side: KrakenWsTradeSide$1;
|
|
5394
|
+
/**
|
|
5395
|
+
* Size of the trade (in base asset).
|
|
5396
|
+
*/
|
|
5397
|
+
qty: number;
|
|
5398
|
+
/**
|
|
5399
|
+
* Average price of the trade.
|
|
5400
|
+
*/
|
|
5401
|
+
price: number;
|
|
5402
|
+
/**
|
|
5403
|
+
* Order type of the taker order ("limit" or "market").
|
|
5404
|
+
*/
|
|
5405
|
+
ord_type: KrakenWsTradeOrderType$1;
|
|
5406
|
+
/**
|
|
5407
|
+
* Trade identifier – sequence number, unique per book.
|
|
5408
|
+
*/
|
|
5409
|
+
trade_id: number;
|
|
5410
|
+
/**
|
|
5411
|
+
* Book order update timestamp (RFC3339 with fractional seconds).
|
|
5412
|
+
*/
|
|
5413
|
+
timestamp: string;
|
|
5414
|
+
}
|
|
5415
|
+
/**
|
|
5416
|
+
* Snapshot message for the `trade` channel.
|
|
5417
|
+
*
|
|
5418
|
+
* Snapshot reflects the most recent 50 trades.
|
|
5419
|
+
*/
|
|
5420
|
+
interface KrakenWsTradeSnapshotMessage$1 {
|
|
5421
|
+
channel: 'trade';
|
|
5422
|
+
type: 'snapshot';
|
|
5423
|
+
/**
|
|
5424
|
+
* List of trade events (most recent 50).
|
|
5425
|
+
*/
|
|
5426
|
+
data: KrakenWsTradeEntry$1[];
|
|
5427
|
+
/**
|
|
5428
|
+
* Subscription message sequence number.
|
|
5429
|
+
*/
|
|
5430
|
+
sequence: number;
|
|
5431
|
+
}
|
|
5432
|
+
/**
|
|
5433
|
+
* Update message for the `trade` channel.
|
|
5434
|
+
*
|
|
5435
|
+
* Multiple trades may be batched in a single message.
|
|
5436
|
+
*/
|
|
5437
|
+
interface KrakenWsTradeUpdateMessage$1 {
|
|
5438
|
+
channel: 'trade';
|
|
5439
|
+
type: 'update';
|
|
5440
|
+
/**
|
|
5441
|
+
* List of trade events.
|
|
5442
|
+
*/
|
|
5443
|
+
data: KrakenWsTradeEntry$1[];
|
|
5444
|
+
/**
|
|
5445
|
+
* Subscription message sequence number.
|
|
5446
|
+
*/
|
|
5447
|
+
sequence: number;
|
|
5448
|
+
}
|
|
5449
|
+
/**
|
|
5450
|
+
* Union of possible `trade` channel messages.
|
|
5451
|
+
*/
|
|
5452
|
+
type KrakenWsTradeMessage$1 = KrakenWsTradeSnapshotMessage$1 | KrakenWsTradeUpdateMessage$1;
|
|
4795
5453
|
/**
|
|
4796
5454
|
* Parameters for subscribing to the `trade` channel.
|
|
4797
5455
|
*
|
|
4798
5456
|
* NOTE:
|
|
4799
5457
|
* - `channel` is automatically set to "trade" by the helper.
|
|
4800
5458
|
*/
|
|
4801
|
-
interface KrakenWsTradeSubscribeParams {
|
|
5459
|
+
interface KrakenWsTradeSubscribeParams$1 {
|
|
4802
5460
|
/**
|
|
4803
5461
|
* A list of currency pairs, e.g. ["BTC/USD", "MATIC/GBP"].
|
|
4804
5462
|
*/
|
|
@@ -4816,7 +5474,7 @@ interface KrakenWsTradeSubscribeParams {
|
|
|
4816
5474
|
/**
|
|
4817
5475
|
* Options for subscribeTrade wrapper – mapped to KrakenWebsocketBase.request.
|
|
4818
5476
|
*/
|
|
4819
|
-
interface KrakenWsTradeSubscribeOptions {
|
|
5477
|
+
interface KrakenWsTradeSubscribeOptions$1 {
|
|
4820
5478
|
reqId?: number;
|
|
4821
5479
|
timeoutMs?: number;
|
|
4822
5480
|
/**
|
|
@@ -4836,14 +5494,14 @@ interface KrakenWsTradeSubscribeResult {
|
|
|
4836
5494
|
/**
|
|
4837
5495
|
* Full WS envelope returned from subscribe (ack) for `trade`.
|
|
4838
5496
|
*/
|
|
4839
|
-
type KrakenWsTradeSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsTradeSubscribeResult>;
|
|
5497
|
+
type KrakenWsTradeSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsTradeSubscribeResult>;
|
|
4840
5498
|
/**
|
|
4841
5499
|
* Parameters for unsubscribing from the `trade` channel.
|
|
4842
5500
|
*
|
|
4843
5501
|
* NOTE:
|
|
4844
5502
|
* - Must match the symbols you want to remove.
|
|
4845
5503
|
*/
|
|
4846
|
-
interface KrakenWsTradeUnsubscribeParams {
|
|
5504
|
+
interface KrakenWsTradeUnsubscribeParams$1 {
|
|
4847
5505
|
/**
|
|
4848
5506
|
* A list of currency pairs to unsubscribe.
|
|
4849
5507
|
*/
|
|
@@ -4853,7 +5511,7 @@ interface KrakenWsTradeUnsubscribeParams {
|
|
|
4853
5511
|
/**
|
|
4854
5512
|
* Options for unsubscribeTrade wrapper.
|
|
4855
5513
|
*/
|
|
4856
|
-
interface KrakenWsTradeUnsubscribeOptions {
|
|
5514
|
+
interface KrakenWsTradeUnsubscribeOptions$1 {
|
|
4857
5515
|
reqId?: number;
|
|
4858
5516
|
timeoutMs?: number;
|
|
4859
5517
|
attachAuthToken?: boolean;
|
|
@@ -4869,15 +5527,134 @@ interface KrakenWsTradeUnsubscribeResult {
|
|
|
4869
5527
|
/**
|
|
4870
5528
|
* Full WS envelope returned from unsubscribe (ack) for `trade`.
|
|
4871
5529
|
*/
|
|
4872
|
-
type KrakenWsTradeUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsTradeUnsubscribeResult>;
|
|
5530
|
+
type KrakenWsTradeUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsTradeUnsubscribeResult>;
|
|
4873
5531
|
|
|
5532
|
+
/**
|
|
5533
|
+
* Status values for assets in the instrument feed.
|
|
5534
|
+
*/
|
|
5535
|
+
type KrakenWsInstrumentAssetStatus$1 = 'depositonly' | 'disabled' | 'enabled' | 'fundingtemporarilydisabled' | 'withdrawalonly' | 'workinprogress';
|
|
5536
|
+
/**
|
|
5537
|
+
* Status values for pairs in the instrument feed.
|
|
5538
|
+
*/
|
|
5539
|
+
type KrakenWsInstrumentPairStatus$1 = 'cancel_only' | 'delisted' | 'limit_only' | 'maintenance' | 'online' | 'post_only' | 'reduce_only' | 'work_in_progress';
|
|
5540
|
+
/**
|
|
5541
|
+
* Single asset entry in the instrument feed.
|
|
5542
|
+
*/
|
|
5543
|
+
interface KrakenWsInstrumentAsset$1 {
|
|
5544
|
+
/** Asset identifier (e.g. "XBT", "USD"). */
|
|
5545
|
+
id: string;
|
|
5546
|
+
/** Flag if asset is borrowable. */
|
|
5547
|
+
borrowable: boolean;
|
|
5548
|
+
/** Valuation as margin collateral (if applicable). */
|
|
5549
|
+
collateral_value: number;
|
|
5550
|
+
/** Interest rate to borrow the asset. */
|
|
5551
|
+
margin_rate: number;
|
|
5552
|
+
/** Maximum precision for asset ledger / balances. */
|
|
5553
|
+
precision: number;
|
|
5554
|
+
/** Recommended display precision. */
|
|
5555
|
+
precision_display: number;
|
|
5556
|
+
/**
|
|
5557
|
+
* Multiplier of the tokenised asset (fixed conversion rate of the token).
|
|
5558
|
+
* Only meaningful for tokenized assets / xStocks.
|
|
5559
|
+
*/
|
|
5560
|
+
multiplier?: number;
|
|
5561
|
+
/** Status of asset. */
|
|
5562
|
+
status: KrakenWsInstrumentAssetStatus$1;
|
|
5563
|
+
/** Allow future extension without breaking typing. */
|
|
5564
|
+
[key: string]: unknown;
|
|
5565
|
+
}
|
|
5566
|
+
/**
|
|
5567
|
+
* Single pair entry in the instrument feed.
|
|
5568
|
+
*/
|
|
5569
|
+
interface KrakenWsInstrumentPair$1 {
|
|
5570
|
+
/** Asset identifier of the base currency. */
|
|
5571
|
+
base: string;
|
|
5572
|
+
/** Asset identifier of the quote currency. */
|
|
5573
|
+
quote: string;
|
|
5574
|
+
/** Minimum cost (price * qty) for new orders (string as in docs). */
|
|
5575
|
+
cost_min: string;
|
|
5576
|
+
/** Maximum precision used for cost prices. */
|
|
5577
|
+
cost_precision: number;
|
|
5578
|
+
/** Whether the pair has an index available (e.g. for stop-loss triggers). */
|
|
5579
|
+
has_index: boolean;
|
|
5580
|
+
/** Whether the pair can be traded on margin. */
|
|
5581
|
+
marginable: boolean;
|
|
5582
|
+
/** Initial margin requirement (percent) – marginable pairs only. */
|
|
5583
|
+
margin_initial?: number;
|
|
5584
|
+
/** Limit for long positions – marginable pairs only. */
|
|
5585
|
+
position_limit_long?: number;
|
|
5586
|
+
/** Limit for short positions – marginable pairs only. */
|
|
5587
|
+
position_limit_short?: number;
|
|
5588
|
+
/** Minimum price increment for new orders. */
|
|
5589
|
+
price_increment: number;
|
|
5590
|
+
/** Maximum precision used for order prices. */
|
|
5591
|
+
price_precision: number;
|
|
5592
|
+
/** Minimum quantity increment for new orders. */
|
|
5593
|
+
qty_increment: number;
|
|
5594
|
+
/** Minimum quantity (base currency) for new orders. */
|
|
5595
|
+
qty_min: number;
|
|
5596
|
+
/** Maximum precision used for order quantities. */
|
|
5597
|
+
qty_precision: number;
|
|
5598
|
+
/** Status of pair. */
|
|
5599
|
+
status: KrakenWsInstrumentPairStatus$1;
|
|
5600
|
+
/** The symbol of the currency pair, e.g. "BTC/USD". */
|
|
5601
|
+
symbol: string;
|
|
5602
|
+
/**
|
|
5603
|
+
* DEPRECATED: Use `price_increment`.
|
|
5604
|
+
* Minimum price increment for new orders.
|
|
5605
|
+
*/
|
|
5606
|
+
tick_size?: number;
|
|
5607
|
+
[key: string]: unknown;
|
|
5608
|
+
}
|
|
5609
|
+
/**
|
|
5610
|
+
* Instrument payload: reference data for active assets and tradable pairs.
|
|
5611
|
+
*/
|
|
5612
|
+
interface KrakenWsInstrumentData$1 {
|
|
5613
|
+
/** List of assets. */
|
|
5614
|
+
assets: KrakenWsInstrumentAsset$1[];
|
|
5615
|
+
/** List of tradable pairs. */
|
|
5616
|
+
pairs: KrakenWsInstrumentPair$1[];
|
|
5617
|
+
[key: string]: unknown;
|
|
5618
|
+
}
|
|
5619
|
+
/**
|
|
5620
|
+
* Snapshot message for the `instrument` channel.
|
|
5621
|
+
*
|
|
5622
|
+
* Snapshot provides reference data of all active assets and tradable pairs.
|
|
5623
|
+
*/
|
|
5624
|
+
interface KrakenWsInstrumentSnapshotMessage$1 {
|
|
5625
|
+
channel: 'instrument';
|
|
5626
|
+
type: 'snapshot';
|
|
5627
|
+
data: KrakenWsInstrumentData$1;
|
|
5628
|
+
/**
|
|
5629
|
+
* Subscription message sequence number.
|
|
5630
|
+
*/
|
|
5631
|
+
sequence: number;
|
|
5632
|
+
}
|
|
5633
|
+
/**
|
|
5634
|
+
* Update message for the `instrument` channel.
|
|
5635
|
+
*
|
|
5636
|
+
* Updates stream changes to assets / pairs over time.
|
|
5637
|
+
*/
|
|
5638
|
+
interface KrakenWsInstrumentUpdateMessage$1 {
|
|
5639
|
+
channel: 'instrument';
|
|
5640
|
+
type: 'update';
|
|
5641
|
+
data: KrakenWsInstrumentData$1;
|
|
5642
|
+
/**
|
|
5643
|
+
* Subscription message sequence number.
|
|
5644
|
+
*/
|
|
5645
|
+
sequence: number;
|
|
5646
|
+
}
|
|
5647
|
+
/**
|
|
5648
|
+
* Union of possible `instrument` channel messages.
|
|
5649
|
+
*/
|
|
5650
|
+
type KrakenWsInstrumentMessage$1 = KrakenWsInstrumentSnapshotMessage$1 | KrakenWsInstrumentUpdateMessage$1;
|
|
4874
5651
|
/**
|
|
4875
5652
|
* Parameters for subscribing to the `instrument` channel.
|
|
4876
5653
|
*
|
|
4877
5654
|
* NOTE:
|
|
4878
5655
|
* - `channel` is automatically set to "instrument" by the helper.
|
|
4879
5656
|
*/
|
|
4880
|
-
interface KrakenWsInstrumentSubscribeParams {
|
|
5657
|
+
interface KrakenWsInstrumentSubscribeParams$1 {
|
|
4881
5658
|
/**
|
|
4882
5659
|
* If true, include tokenized assets / xStocks in the response.
|
|
4883
5660
|
* If false or omitted, include crypto spot pairs only.
|
|
@@ -4896,7 +5673,7 @@ interface KrakenWsInstrumentSubscribeParams {
|
|
|
4896
5673
|
/**
|
|
4897
5674
|
* Options for subscribeInstrument wrapper – mapped to KrakenWebsocketBase.request.
|
|
4898
5675
|
*/
|
|
4899
|
-
interface KrakenWsInstrumentSubscribeOptions {
|
|
5676
|
+
interface KrakenWsInstrumentSubscribeOptions$1 {
|
|
4900
5677
|
reqId?: number;
|
|
4901
5678
|
timeoutMs?: number;
|
|
4902
5679
|
/**
|
|
@@ -4916,7 +5693,7 @@ interface KrakenWsInstrumentSubscribeResult {
|
|
|
4916
5693
|
/**
|
|
4917
5694
|
* Full WS envelope returned from subscribe (ack) for `instrument`.
|
|
4918
5695
|
*/
|
|
4919
|
-
type KrakenWsInstrumentSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsInstrumentSubscribeResult>;
|
|
5696
|
+
type KrakenWsInstrumentSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsInstrumentSubscribeResult>;
|
|
4920
5697
|
/**
|
|
4921
5698
|
* Parameters for unsubscribing from the `instrument` channel.
|
|
4922
5699
|
*
|
|
@@ -4924,13 +5701,13 @@ type KrakenWsInstrumentSubscribeResponse = KrakenWsMethodResponseEnvelope<Kraken
|
|
|
4924
5701
|
* - Kraken's API only requires `channel` for this unsubscribe.
|
|
4925
5702
|
* - This is kept as an object for consistency / future extensibility.
|
|
4926
5703
|
*/
|
|
4927
|
-
interface KrakenWsInstrumentUnsubscribeParams {
|
|
5704
|
+
interface KrakenWsInstrumentUnsubscribeParams$1 {
|
|
4928
5705
|
[key: string]: unknown;
|
|
4929
5706
|
}
|
|
4930
5707
|
/**
|
|
4931
5708
|
* Options for unsubscribeInstrument wrapper.
|
|
4932
5709
|
*/
|
|
4933
|
-
interface KrakenWsInstrumentUnsubscribeOptions {
|
|
5710
|
+
interface KrakenWsInstrumentUnsubscribeOptions$1 {
|
|
4934
5711
|
reqId?: number;
|
|
4935
5712
|
timeoutMs?: number;
|
|
4936
5713
|
attachAuthToken?: boolean;
|
|
@@ -4945,7 +5722,7 @@ interface KrakenWsInstrumentUnsubscribeResult {
|
|
|
4945
5722
|
/**
|
|
4946
5723
|
* Full WS envelope returned from unsubscribe (ack) for `instrument`.
|
|
4947
5724
|
*/
|
|
4948
|
-
type KrakenWsInstrumentUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsInstrumentUnsubscribeResult>;
|
|
5725
|
+
type KrakenWsInstrumentUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsInstrumentUnsubscribeResult>;
|
|
4949
5726
|
|
|
4950
5727
|
/**
|
|
4951
5728
|
* Kraken Spot WebSocket v2 – Market Data API.
|
|
@@ -4988,7 +5765,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
4988
5765
|
* }
|
|
4989
5766
|
* ```
|
|
4990
5767
|
*/
|
|
4991
|
-
subscribeTicker(params: KrakenWsTickerSubscribeParams, options?: KrakenWsTickerSubscribeOptions): Promise<KrakenWsTickerSubscribeResponse>;
|
|
5768
|
+
subscribeTicker(params: KrakenWsTickerSubscribeParams$1, options?: KrakenWsTickerSubscribeOptions$1): Promise<KrakenWsTickerSubscribeResponse$1>;
|
|
4992
5769
|
/**
|
|
4993
5770
|
* Unsubscribe from the **ticker** channel.
|
|
4994
5771
|
*
|
|
@@ -5002,7 +5779,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5002
5779
|
* );
|
|
5003
5780
|
* ```
|
|
5004
5781
|
*/
|
|
5005
|
-
unsubscribeTicker(params: KrakenWsTickerUnsubscribeParams, options?: KrakenWsTickerUnsubscribeOptions): Promise<KrakenWsTickerUnsubscribeResponse>;
|
|
5782
|
+
unsubscribeTicker(params: KrakenWsTickerUnsubscribeParams$1, options?: KrakenWsTickerUnsubscribeOptions$1): Promise<KrakenWsTickerUnsubscribeResponse$1>;
|
|
5006
5783
|
/**
|
|
5007
5784
|
* Subscribe to the **book** (Level 2) channel.
|
|
5008
5785
|
*
|
|
@@ -5026,7 +5803,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5026
5803
|
* }
|
|
5027
5804
|
* ```
|
|
5028
5805
|
*/
|
|
5029
|
-
subscribeBook(params: KrakenWsBookSubscribeParams, options?: KrakenWsBookSubscribeOptions): Promise<KrakenWsBookSubscribeResponse>;
|
|
5806
|
+
subscribeBook(params: KrakenWsBookSubscribeParams$1, options?: KrakenWsBookSubscribeOptions$1): Promise<KrakenWsBookSubscribeResponse$1>;
|
|
5030
5807
|
/**
|
|
5031
5808
|
* Unsubscribe from the **book** (Level 2) channel.
|
|
5032
5809
|
*
|
|
@@ -5041,7 +5818,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5041
5818
|
* );
|
|
5042
5819
|
* ```
|
|
5043
5820
|
*/
|
|
5044
|
-
unsubscribeBook(params: KrakenWsBookUnsubscribeParams, options?: KrakenWsBookUnsubscribeOptions): Promise<KrakenWsBookUnsubscribeResponse>;
|
|
5821
|
+
unsubscribeBook(params: KrakenWsBookUnsubscribeParams$1, options?: KrakenWsBookUnsubscribeOptions$1): Promise<KrakenWsBookUnsubscribeResponse$1>;
|
|
5045
5822
|
/**
|
|
5046
5823
|
* Subscribe to the **level3** (per-order) book channel.
|
|
5047
5824
|
*
|
|
@@ -5069,7 +5846,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5069
5846
|
* }
|
|
5070
5847
|
* ```
|
|
5071
5848
|
*/
|
|
5072
|
-
subscribeLevel3(params: KrakenWsLevel3SubscribeParams, options?: KrakenWsLevel3SubscribeOptions): Promise<KrakenWsLevel3SubscribeResponse>;
|
|
5849
|
+
subscribeLevel3(params: KrakenWsLevel3SubscribeParams$1, options?: KrakenWsLevel3SubscribeOptions$1): Promise<KrakenWsLevel3SubscribeResponse$1>;
|
|
5073
5850
|
/**
|
|
5074
5851
|
* Unsubscribe from the **level3** channel.
|
|
5075
5852
|
*
|
|
@@ -5087,7 +5864,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5087
5864
|
* );
|
|
5088
5865
|
* ```
|
|
5089
5866
|
*/
|
|
5090
|
-
unsubscribeLevel3(params: KrakenWsLevel3UnsubscribeParams, options?: KrakenWsLevel3UnsubscribeOptions): Promise<KrakenWsLevel3UnsubscribeResponse>;
|
|
5867
|
+
unsubscribeLevel3(params: KrakenWsLevel3UnsubscribeParams$1, options?: KrakenWsLevel3UnsubscribeOptions$1): Promise<KrakenWsLevel3UnsubscribeResponse$1>;
|
|
5091
5868
|
/**
|
|
5092
5869
|
* Subscribe to **ohlc** candles.
|
|
5093
5870
|
*
|
|
@@ -5107,7 +5884,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5107
5884
|
* );
|
|
5108
5885
|
* ```
|
|
5109
5886
|
*/
|
|
5110
|
-
subscribeOhlc(params: KrakenWsOhlcSubscribeParams, options?: KrakenWsOhlcSubscribeOptions): Promise<KrakenWsOhlcSubscribeResponse>;
|
|
5887
|
+
subscribeOhlc(params: KrakenWsOhlcSubscribeParams$1, options?: KrakenWsOhlcSubscribeOptions$1): Promise<KrakenWsOhlcSubscribeResponse$1>;
|
|
5111
5888
|
/**
|
|
5112
5889
|
* Unsubscribe from **ohlc** candles.
|
|
5113
5890
|
*
|
|
@@ -5122,7 +5899,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5122
5899
|
* );
|
|
5123
5900
|
* ```
|
|
5124
5901
|
*/
|
|
5125
|
-
unsubscribeOhlc(params: KrakenWsOhlcUnsubscribeParams, options?: KrakenWsOhlcUnsubscribeOptions): Promise<KrakenWsOhlcUnsubscribeResponse>;
|
|
5902
|
+
unsubscribeOhlc(params: KrakenWsOhlcUnsubscribeParams$1, options?: KrakenWsOhlcUnsubscribeOptions$1): Promise<KrakenWsOhlcUnsubscribeResponse$1>;
|
|
5126
5903
|
/**
|
|
5127
5904
|
* Subscribe to public **trade** prints.
|
|
5128
5905
|
*
|
|
@@ -5141,7 +5918,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5141
5918
|
* );
|
|
5142
5919
|
* ```
|
|
5143
5920
|
*/
|
|
5144
|
-
subscribeTrade(params: KrakenWsTradeSubscribeParams, options?: KrakenWsTradeSubscribeOptions): Promise<KrakenWsTradeSubscribeResponse>;
|
|
5921
|
+
subscribeTrade(params: KrakenWsTradeSubscribeParams$1, options?: KrakenWsTradeSubscribeOptions$1): Promise<KrakenWsTradeSubscribeResponse$1>;
|
|
5145
5922
|
/**
|
|
5146
5923
|
* Unsubscribe from **trade** prints.
|
|
5147
5924
|
*
|
|
@@ -5155,7 +5932,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5155
5932
|
* );
|
|
5156
5933
|
* ```
|
|
5157
5934
|
*/
|
|
5158
|
-
unsubscribeTrade(params: KrakenWsTradeUnsubscribeParams, options?: KrakenWsTradeUnsubscribeOptions): Promise<KrakenWsTradeUnsubscribeResponse>;
|
|
5935
|
+
unsubscribeTrade(params: KrakenWsTradeUnsubscribeParams$1, options?: KrakenWsTradeUnsubscribeOptions$1): Promise<KrakenWsTradeUnsubscribeResponse$1>;
|
|
5159
5936
|
/**
|
|
5160
5937
|
* Subscribe to **instrument** reference data.
|
|
5161
5938
|
*
|
|
@@ -5174,7 +5951,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5174
5951
|
* );
|
|
5175
5952
|
* ```
|
|
5176
5953
|
*/
|
|
5177
|
-
subscribeInstrument(params?: KrakenWsInstrumentSubscribeParams, options?: KrakenWsInstrumentSubscribeOptions): Promise<KrakenWsInstrumentSubscribeResponse>;
|
|
5954
|
+
subscribeInstrument(params?: KrakenWsInstrumentSubscribeParams$1, options?: KrakenWsInstrumentSubscribeOptions$1): Promise<KrakenWsInstrumentSubscribeResponse$1>;
|
|
5178
5955
|
/**
|
|
5179
5956
|
* Unsubscribe from the **instrument** channel.
|
|
5180
5957
|
*
|
|
@@ -5186,9 +5963,291 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5186
5963
|
* );
|
|
5187
5964
|
* ```
|
|
5188
5965
|
*/
|
|
5189
|
-
unsubscribeInstrument(params?: KrakenWsInstrumentUnsubscribeParams, options?: KrakenWsInstrumentUnsubscribeOptions): Promise<KrakenWsInstrumentUnsubscribeResponse>;
|
|
5190
|
-
}
|
|
5966
|
+
unsubscribeInstrument(params?: KrakenWsInstrumentUnsubscribeParams$1, options?: KrakenWsInstrumentUnsubscribeOptions$1): Promise<KrakenWsInstrumentUnsubscribeResponse$1>;
|
|
5967
|
+
}
|
|
5968
|
+
type KrakenWsTickerData = KrakenWsTickerData$1;
|
|
5969
|
+
type KrakenWsTickerSnapshotMessage = KrakenWsTickerSnapshotMessage$1;
|
|
5970
|
+
type KrakenWsTickerUpdateMessage = KrakenWsTickerUpdateMessage$1;
|
|
5971
|
+
type KrakenWsTickerMessage = KrakenWsTickerMessage$1;
|
|
5972
|
+
type KrakenWsTickerSubscribeParams = KrakenWsTickerSubscribeParams$1;
|
|
5973
|
+
type KrakenWsTickerSubscribeOptions = KrakenWsTickerSubscribeOptions$1;
|
|
5974
|
+
type KrakenWsTickerSubscribeResponse = KrakenWsTickerSubscribeResponse$1;
|
|
5975
|
+
type KrakenWsTickerUnsubscribeParams = KrakenWsTickerUnsubscribeParams$1;
|
|
5976
|
+
type KrakenWsTickerUnsubscribeOptions = KrakenWsTickerUnsubscribeOptions$1;
|
|
5977
|
+
type KrakenWsTickerUnsubscribeResponse = KrakenWsTickerUnsubscribeResponse$1;
|
|
5978
|
+
type KrakenWsBookLevel = KrakenWsBookLevel$1;
|
|
5979
|
+
type KrakenWsBookSnapshotMessage = KrakenWsBookSnapshotMessage$1;
|
|
5980
|
+
type KrakenWsBookUpdateMessage = KrakenWsBookUpdateMessage$1;
|
|
5981
|
+
type KrakenWsBookMessage = KrakenWsBookMessage$1;
|
|
5982
|
+
type KrakenWsBookSubscribeParams = KrakenWsBookSubscribeParams$1;
|
|
5983
|
+
type KrakenWsBookSubscribeOptions = KrakenWsBookSubscribeOptions$1;
|
|
5984
|
+
type KrakenWsBookSubscribeResponse = KrakenWsBookSubscribeResponse$1;
|
|
5985
|
+
type KrakenWsBookUnsubscribeParams = KrakenWsBookUnsubscribeParams$1;
|
|
5986
|
+
type KrakenWsBookUnsubscribeOptions = KrakenWsBookUnsubscribeOptions$1;
|
|
5987
|
+
type KrakenWsBookUnsubscribeResponse = KrakenWsBookUnsubscribeResponse$1;
|
|
5988
|
+
type KrakenWsLevel3Depth = KrakenWsLevel3Depth$1;
|
|
5989
|
+
type KrakenWsLevel3OrderEventType = KrakenWsLevel3OrderEventType$1;
|
|
5990
|
+
type KrakenWsLevel3SnapshotMessage = KrakenWsLevel3SnapshotMessage$1;
|
|
5991
|
+
type KrakenWsLevel3UpdateMessage = KrakenWsLevel3UpdateMessage$1;
|
|
5992
|
+
type KrakenWsLevel3Message = KrakenWsLevel3Message$1;
|
|
5993
|
+
type KrakenWsLevel3SubscribeParams = KrakenWsLevel3SubscribeParams$1;
|
|
5994
|
+
type KrakenWsLevel3SubscribeOptions = KrakenWsLevel3SubscribeOptions$1;
|
|
5995
|
+
type KrakenWsLevel3SubscribeResponse = KrakenWsLevel3SubscribeResponse$1;
|
|
5996
|
+
type KrakenWsLevel3UnsubscribeParams = KrakenWsLevel3UnsubscribeParams$1;
|
|
5997
|
+
type KrakenWsLevel3UnsubscribeOptions = KrakenWsLevel3UnsubscribeOptions$1;
|
|
5998
|
+
type KrakenWsLevel3UnsubscribeResponse = KrakenWsLevel3UnsubscribeResponse$1;
|
|
5999
|
+
type KrakenWsOhlcSnapshotMessage = KrakenWsOhlcSnapshotMessage$1;
|
|
6000
|
+
type KrakenWsOhlcUpdateMessage = KrakenWsOhlcUpdateMessage$1;
|
|
6001
|
+
type KrakenWsOhlcMessage = KrakenWsOhlcMessage$1;
|
|
6002
|
+
type KrakenWsOhlcSubscribeParams = KrakenWsOhlcSubscribeParams$1;
|
|
6003
|
+
type KrakenWsOhlcSubscribeOptions = KrakenWsOhlcSubscribeOptions$1;
|
|
6004
|
+
type KrakenWsOhlcSubscribeResponse = KrakenWsOhlcSubscribeResponse$1;
|
|
6005
|
+
type KrakenWsOhlcUnsubscribeParams = KrakenWsOhlcUnsubscribeParams$1;
|
|
6006
|
+
type KrakenWsOhlcUnsubscribeOptions = KrakenWsOhlcUnsubscribeOptions$1;
|
|
6007
|
+
type KrakenWsOhlcUnsubscribeResponse = KrakenWsOhlcUnsubscribeResponse$1;
|
|
6008
|
+
type KrakenWsTradeSide = KrakenWsTradeSide$1;
|
|
6009
|
+
type KrakenWsTradeOrderType = KrakenWsTradeOrderType$1;
|
|
6010
|
+
type KrakenWsTradeEntry = KrakenWsTradeEntry$1;
|
|
6011
|
+
type KrakenWsTradeSnapshotMessage = KrakenWsTradeSnapshotMessage$1;
|
|
6012
|
+
type KrakenWsTradeUpdateMessage = KrakenWsTradeUpdateMessage$1;
|
|
6013
|
+
type KrakenWsTradeMessage = KrakenWsTradeMessage$1;
|
|
6014
|
+
type KrakenWsTradeSubscribeParams = KrakenWsTradeSubscribeParams$1;
|
|
6015
|
+
type KrakenWsTradeSubscribeOptions = KrakenWsTradeSubscribeOptions$1;
|
|
6016
|
+
type KrakenWsTradeSubscribeResponse = KrakenWsTradeSubscribeResponse$1;
|
|
6017
|
+
type KrakenWsTradeUnsubscribeParams = KrakenWsTradeUnsubscribeParams$1;
|
|
6018
|
+
type KrakenWsTradeUnsubscribeOptions = KrakenWsTradeUnsubscribeOptions$1;
|
|
6019
|
+
type KrakenWsTradeUnsubscribeResponse = KrakenWsTradeUnsubscribeResponse$1;
|
|
6020
|
+
type KrakenWsInstrumentAssetStatus = KrakenWsInstrumentAssetStatus$1;
|
|
6021
|
+
type KrakenWsInstrumentPairStatus = KrakenWsInstrumentPairStatus$1;
|
|
6022
|
+
type KrakenWsInstrumentAsset = KrakenWsInstrumentAsset$1;
|
|
6023
|
+
type KrakenWsInstrumentPair = KrakenWsInstrumentPair$1;
|
|
6024
|
+
type KrakenWsInstrumentData = KrakenWsInstrumentData$1;
|
|
6025
|
+
type KrakenWsInstrumentSnapshotMessage = KrakenWsInstrumentSnapshotMessage$1;
|
|
6026
|
+
type KrakenWsInstrumentUpdateMessage = KrakenWsInstrumentUpdateMessage$1;
|
|
6027
|
+
type KrakenWsInstrumentMessage = KrakenWsInstrumentMessage$1;
|
|
6028
|
+
type KrakenWsInstrumentSubscribeParams = KrakenWsInstrumentSubscribeParams$1;
|
|
6029
|
+
type KrakenWsInstrumentSubscribeOptions = KrakenWsInstrumentSubscribeOptions$1;
|
|
6030
|
+
type KrakenWsInstrumentSubscribeResponse = KrakenWsInstrumentSubscribeResponse$1;
|
|
6031
|
+
type KrakenWsInstrumentUnsubscribeParams = KrakenWsInstrumentUnsubscribeParams$1;
|
|
6032
|
+
type KrakenWsInstrumentUnsubscribeOptions = KrakenWsInstrumentUnsubscribeOptions$1;
|
|
6033
|
+
type KrakenWsInstrumentUnsubscribeResponse = KrakenWsInstrumentUnsubscribeResponse$1;
|
|
5191
6034
|
|
|
6035
|
+
/**
|
|
6036
|
+
* Exec type for executions channel events.
|
|
6037
|
+
*/
|
|
6038
|
+
type KrakenWsExecutionType$1 = 'pending_new' | 'new' | 'trade' | 'filled' | 'iceberg_refill' | 'canceled' | 'expired' | 'amended' | 'restated' | 'status';
|
|
6039
|
+
/**
|
|
6040
|
+
* Order status on executions events.
|
|
6041
|
+
*/
|
|
6042
|
+
type KrakenWsOrderStatus$1 = 'pending_new' | 'new' | 'partially_filled' | 'filled' | 'canceled' | 'expired';
|
|
6043
|
+
/**
|
|
6044
|
+
* Liquidity indicator (maker / taker).
|
|
6045
|
+
*/
|
|
6046
|
+
type KrakenWsLiquidityIndicator$1 = 'm' | 't';
|
|
6047
|
+
/**
|
|
6048
|
+
* Position status for margin orders.
|
|
6049
|
+
*/
|
|
6050
|
+
type KrakenWsPositionStatus$1 = 'opened' | 'closing' | 'closed';
|
|
6051
|
+
/**
|
|
6052
|
+
* Trigger status on triggered orders.
|
|
6053
|
+
*/
|
|
6054
|
+
type KrakenWsTriggerStatus$1 = 'triggered' | 'untriggered';
|
|
6055
|
+
/**
|
|
6056
|
+
* Time-in-force values used on executions stream (upper-case).
|
|
6057
|
+
*/
|
|
6058
|
+
type KrakenWsExecutionTimeInForce$1 = 'GTC' | 'GTD' | 'IOC';
|
|
6059
|
+
/**
|
|
6060
|
+
* Fee entry for trade events.
|
|
6061
|
+
*/
|
|
6062
|
+
interface KrakenWsExecutionFeeEntry$1 {
|
|
6063
|
+
/** The fee currency. */
|
|
6064
|
+
asset: string;
|
|
6065
|
+
/** The fee amount. */
|
|
6066
|
+
qty: number;
|
|
6067
|
+
}
|
|
6068
|
+
/**
|
|
6069
|
+
* Trigger parameters on execution reports (for triggered order types).
|
|
6070
|
+
*/
|
|
6071
|
+
interface KrakenWsExecutionTriggers$1 {
|
|
6072
|
+
/** The reference price tracked for triggering orders. */
|
|
6073
|
+
reference?: KrakenWsTriggerReference;
|
|
6074
|
+
/**
|
|
6075
|
+
* Trigger price amount (static or relative), used with `price_type`.
|
|
6076
|
+
*/
|
|
6077
|
+
price?: number;
|
|
6078
|
+
/**
|
|
6079
|
+
* Units for the trigger price.
|
|
6080
|
+
*/
|
|
6081
|
+
price_type?: KrakenWsPriceType;
|
|
6082
|
+
/**
|
|
6083
|
+
* Current value of the effective trigger price (after applying relative logic).
|
|
6084
|
+
*/
|
|
6085
|
+
actual_price?: number;
|
|
6086
|
+
/**
|
|
6087
|
+
* Peak / trough price on trailing-stop / trailing-stop-limit.
|
|
6088
|
+
*/
|
|
6089
|
+
peak_price?: number;
|
|
6090
|
+
/**
|
|
6091
|
+
* On trigger activation, the value of the reference last price that triggered
|
|
6092
|
+
* the order.
|
|
6093
|
+
*/
|
|
6094
|
+
last_price?: number;
|
|
6095
|
+
/**
|
|
6096
|
+
* Trigger status.
|
|
6097
|
+
*/
|
|
6098
|
+
status?: KrakenWsTriggerStatus$1;
|
|
6099
|
+
/**
|
|
6100
|
+
* On trigger activation, the timestamp of the trigger event.
|
|
6101
|
+
*/
|
|
6102
|
+
timestamp?: string;
|
|
6103
|
+
}
|
|
6104
|
+
/**
|
|
6105
|
+
* Contingent (secondary close order template) information on executions.
|
|
6106
|
+
*/
|
|
6107
|
+
interface KrakenWsExecutionContingent$1 {
|
|
6108
|
+
/**
|
|
6109
|
+
* Order type of the secondary close orders created on each fill.
|
|
6110
|
+
*/
|
|
6111
|
+
order_type?: 'limit' | 'stop-loss' | 'stop-loss-limit' | 'take-profit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit';
|
|
6112
|
+
/**
|
|
6113
|
+
* Trigger price for secondary orders (triggered types only).
|
|
6114
|
+
*/
|
|
6115
|
+
trigger_price?: number;
|
|
6116
|
+
/**
|
|
6117
|
+
* Trigger price units for secondary orders.
|
|
6118
|
+
*/
|
|
6119
|
+
trigger_price_type?: KrakenWsPriceType;
|
|
6120
|
+
/**
|
|
6121
|
+
* Limit price for secondary orders (limit-types only).
|
|
6122
|
+
*/
|
|
6123
|
+
limit_price?: number;
|
|
6124
|
+
/**
|
|
6125
|
+
* Limit price units for secondary orders.
|
|
6126
|
+
*/
|
|
6127
|
+
limit_price_type?: KrakenWsPriceType;
|
|
6128
|
+
}
|
|
6129
|
+
/**
|
|
6130
|
+
* Execution report structure for entries in the `executions` channel
|
|
6131
|
+
* `data` array.
|
|
6132
|
+
*
|
|
6133
|
+
* NOTE:
|
|
6134
|
+
* - Fields are often conditional based on `exec_type`.
|
|
6135
|
+
* - Most are optional here to account for different shapes per event.
|
|
6136
|
+
*/
|
|
6137
|
+
interface KrakenWsExecutionReport$1 {
|
|
6138
|
+
/** Unique order identifier generated by Kraken. */
|
|
6139
|
+
order_id?: string;
|
|
6140
|
+
/** Optional client identifier associated with the order. */
|
|
6141
|
+
cl_ord_id?: string;
|
|
6142
|
+
/** Optional numeric, client identifier associated with one or more orders. */
|
|
6143
|
+
order_userref?: number;
|
|
6144
|
+
/** The symbol of the currency pair (e.g. "BTC/USD"). */
|
|
6145
|
+
symbol?: string;
|
|
6146
|
+
/** Side of the order. */
|
|
6147
|
+
side?: 'buy' | 'sell';
|
|
6148
|
+
/** The execution model of the order. */
|
|
6149
|
+
order_type?: 'limit' | 'market' | 'iceberg' | 'stop-loss' | 'stop-loss-limit' | 'take-profit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
|
|
6150
|
+
/** Describes current state of the order. */
|
|
6151
|
+
order_status?: KrakenWsOrderStatus$1;
|
|
6152
|
+
/** Event type, determines what fields are present. */
|
|
6153
|
+
exec_type?: KrakenWsExecutionType$1;
|
|
6154
|
+
/** Time of the event. */
|
|
6155
|
+
timestamp?: string;
|
|
6156
|
+
/** Scheduled start time of the order. */
|
|
6157
|
+
effective_time?: string;
|
|
6158
|
+
/** Scheduled expiration time of the order. */
|
|
6159
|
+
expire_time?: string;
|
|
6160
|
+
/** Time-in-force for the order. */
|
|
6161
|
+
time_in_force?: KrakenWsExecutionTimeInForce$1;
|
|
6162
|
+
/** Client order quantity (base asset quantity). */
|
|
6163
|
+
order_qty?: number;
|
|
6164
|
+
/** Display quantity for iceberg order types. */
|
|
6165
|
+
display_qty?: number;
|
|
6166
|
+
/** For iceberg orders, the next display quantity. */
|
|
6167
|
+
display_qty_remain?: number;
|
|
6168
|
+
/** Limit price (for limit-type orders). */
|
|
6169
|
+
limit_price?: number;
|
|
6170
|
+
/** Indicates if the order can be funded on margin. */
|
|
6171
|
+
margin?: boolean;
|
|
6172
|
+
/** Indicates if the execution is on margin. (trade events only) */
|
|
6173
|
+
margin_borrow?: boolean;
|
|
6174
|
+
/** Indicates a reduce-only order. */
|
|
6175
|
+
reduce_only?: boolean;
|
|
6176
|
+
/** Indicates a post-only order. */
|
|
6177
|
+
post_only?: boolean;
|
|
6178
|
+
/** Indicates if the order has market price protection. */
|
|
6179
|
+
no_mpp?: boolean;
|
|
6180
|
+
/** Position status on margin orders. */
|
|
6181
|
+
position_status?: KrakenWsPositionStatus$1;
|
|
6182
|
+
/** Order's average fill price. */
|
|
6183
|
+
avg_price?: number;
|
|
6184
|
+
/** Client order quantity in quote currency (if supplied). */
|
|
6185
|
+
cash_order_qty?: number;
|
|
6186
|
+
/** Execution identifier (trade events only). */
|
|
6187
|
+
exec_id?: string;
|
|
6188
|
+
/** Quantity filled in this event (trade events only). */
|
|
6189
|
+
last_qty?: number;
|
|
6190
|
+
/** Average price in this trade event (trade events only). */
|
|
6191
|
+
last_price?: number;
|
|
6192
|
+
/** Value of an individual execution (trade events only). */
|
|
6193
|
+
cost?: number;
|
|
6194
|
+
/** The order cumulative value executed. */
|
|
6195
|
+
cum_cost?: number;
|
|
6196
|
+
/** The order cumulative executed quantity. */
|
|
6197
|
+
cum_qty?: number;
|
|
6198
|
+
/** Liquidity indicator, 't' taker, 'm' maker. */
|
|
6199
|
+
liquidity_ind?: KrakenWsLiquidityIndicator$1;
|
|
6200
|
+
/** Trade identifier. */
|
|
6201
|
+
trade_id?: number;
|
|
6202
|
+
/** Indicates if the order has been liquidated by the engine. */
|
|
6203
|
+
liquidated?: boolean;
|
|
6204
|
+
/** Referral order transaction id that created this order. */
|
|
6205
|
+
ord_ref_id?: string;
|
|
6206
|
+
/**
|
|
6207
|
+
* The fees paid on this trade event (quote currency currently).
|
|
6208
|
+
* Trade events only.
|
|
6209
|
+
*/
|
|
6210
|
+
fees?: KrakenWsExecutionFeeEntry$1[];
|
|
6211
|
+
/** Preferred currency for paying fees (fcib / fciq). */
|
|
6212
|
+
fee_ccy_pref?: string;
|
|
6213
|
+
/** Total fee paid in USD. */
|
|
6214
|
+
fee_usd_equiv?: number;
|
|
6215
|
+
/** Trigger parameters for triggered order types. */
|
|
6216
|
+
triggers?: KrakenWsExecutionTriggers$1;
|
|
6217
|
+
/** Template for secondary close orders. */
|
|
6218
|
+
contingent?: KrakenWsExecutionContingent$1;
|
|
6219
|
+
/** Indicates if the order has been amended. */
|
|
6220
|
+
amended?: boolean;
|
|
6221
|
+
/** Indicates if the order has been liquidated. */
|
|
6222
|
+
/** Engine / business reason on certain events. */
|
|
6223
|
+
reason?: string;
|
|
6224
|
+
/** For institutional accounts, identifies trader / sub-account for STP. */
|
|
6225
|
+
sender_sub_id?: string;
|
|
6226
|
+
/** User/sub-account identifier when `users=all` is used. */
|
|
6227
|
+
user?: string;
|
|
6228
|
+
/** Optional external partner order id. */
|
|
6229
|
+
ext_ord_id?: string;
|
|
6230
|
+
/** Optional external partner execution id. */
|
|
6231
|
+
ext_exec_id?: string;
|
|
6232
|
+
/** Deprecated: cancellation reason. */
|
|
6233
|
+
cancel_reason?: string;
|
|
6234
|
+
/** Deprecated: stop price (use `triggers`). */
|
|
6235
|
+
stop_price?: number;
|
|
6236
|
+
/** Deprecated: trigger reference (use `triggers`). */
|
|
6237
|
+
trigger?: KrakenWsTriggerReference;
|
|
6238
|
+
/** Deprecated: triggered price (use `triggers`). */
|
|
6239
|
+
triggered_price?: number;
|
|
6240
|
+
}
|
|
6241
|
+
/**
|
|
6242
|
+
* Message payload for the `executions` channel (snapshot or update).
|
|
6243
|
+
*/
|
|
6244
|
+
interface KrakenWsExecutionsMessage$1 {
|
|
6245
|
+
channel: 'executions';
|
|
6246
|
+
type: 'snapshot' | 'update';
|
|
6247
|
+
data: KrakenWsExecutionReport$1[];
|
|
6248
|
+
/** Subscription message sequence number. */
|
|
6249
|
+
sequence: number;
|
|
6250
|
+
}
|
|
5192
6251
|
/**
|
|
5193
6252
|
* Parameters for subscribing to the `executions` channel.
|
|
5194
6253
|
*
|
|
@@ -5197,7 +6256,7 @@ declare class KrakenSpotWsMarketDataApi {
|
|
|
5197
6256
|
* - `token` is optional here; KrakenWebsocketBase can inject it from
|
|
5198
6257
|
* the connection options when `attachAuthToken` is true.
|
|
5199
6258
|
*/
|
|
5200
|
-
interface KrakenWsExecutionsSubscribeParams {
|
|
6259
|
+
interface KrakenWsExecutionsSubscribeParams$1 {
|
|
5201
6260
|
/**
|
|
5202
6261
|
* If true, the last 50 order fills will be included in snapshot.
|
|
5203
6262
|
* Default: false.
|
|
@@ -5249,7 +6308,7 @@ interface KrakenWsExecutionsSubscribeParams {
|
|
|
5249
6308
|
/**
|
|
5250
6309
|
* Options for subscribeExecutions wrapper – mapped to KrakenWebsocketBase.request.
|
|
5251
6310
|
*/
|
|
5252
|
-
interface KrakenWsExecutionsSubscribeOptions {
|
|
6311
|
+
interface KrakenWsExecutionsSubscribeOptions$1 {
|
|
5253
6312
|
reqId?: number;
|
|
5254
6313
|
timeoutMs?: number;
|
|
5255
6314
|
attachAuthToken?: boolean;
|
|
@@ -5259,14 +6318,14 @@ interface KrakenWsExecutionsSubscribeOptions {
|
|
|
5259
6318
|
* (Kraken’s subscribe ack has a small result body; we keep it generic
|
|
5260
6319
|
* but always include `channel`.)
|
|
5261
6320
|
*/
|
|
5262
|
-
interface KrakenWsExecutionsSubscribeResult {
|
|
6321
|
+
interface KrakenWsExecutionsSubscribeResult$1 {
|
|
5263
6322
|
channel: 'executions';
|
|
5264
6323
|
[key: string]: unknown;
|
|
5265
6324
|
}
|
|
5266
6325
|
/**
|
|
5267
6326
|
* Full WS envelope returned from subscribe (ack) for executions.
|
|
5268
6327
|
*/
|
|
5269
|
-
type KrakenWsExecutionsSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsExecutionsSubscribeResult>;
|
|
6328
|
+
type KrakenWsExecutionsSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsExecutionsSubscribeResult$1>;
|
|
5270
6329
|
/**
|
|
5271
6330
|
* Parameters for unsubscribing from the `executions` channel.
|
|
5272
6331
|
*
|
|
@@ -5274,14 +6333,14 @@ type KrakenWsExecutionsSubscribeResponse = KrakenWsMethodResponseEnvelope<Kraken
|
|
|
5274
6333
|
* - `channel` is set to "executions" by the helper.
|
|
5275
6334
|
* - `token` is optional here; base may inject it automatically.
|
|
5276
6335
|
*/
|
|
5277
|
-
interface KrakenWsExecutionsUnsubscribeParams {
|
|
6336
|
+
interface KrakenWsExecutionsUnsubscribeParams$1 {
|
|
5278
6337
|
token?: string;
|
|
5279
6338
|
[key: string]: unknown;
|
|
5280
6339
|
}
|
|
5281
6340
|
/**
|
|
5282
6341
|
* Options for unsubscribeExecutions wrapper.
|
|
5283
6342
|
*/
|
|
5284
|
-
interface KrakenWsExecutionsUnsubscribeOptions {
|
|
6343
|
+
interface KrakenWsExecutionsUnsubscribeOptions$1 {
|
|
5285
6344
|
reqId?: number;
|
|
5286
6345
|
timeoutMs?: number;
|
|
5287
6346
|
attachAuthToken?: boolean;
|
|
@@ -5289,15 +6348,166 @@ interface KrakenWsExecutionsUnsubscribeOptions {
|
|
|
5289
6348
|
/**
|
|
5290
6349
|
* Result payload inside the unsubscribe ack envelope for executions.
|
|
5291
6350
|
*/
|
|
5292
|
-
interface KrakenWsExecutionsUnsubscribeResult {
|
|
6351
|
+
interface KrakenWsExecutionsUnsubscribeResult$1 {
|
|
5293
6352
|
channel: 'executions';
|
|
5294
6353
|
[key: string]: unknown;
|
|
5295
6354
|
}
|
|
5296
6355
|
/**
|
|
5297
6356
|
* Full WS envelope returned from unsubscribe (ack) for executions.
|
|
5298
6357
|
*/
|
|
5299
|
-
type KrakenWsExecutionsUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsExecutionsUnsubscribeResult>;
|
|
6358
|
+
type KrakenWsExecutionsUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsExecutionsUnsubscribeResult$1>;
|
|
5300
6359
|
|
|
6360
|
+
/**
|
|
6361
|
+
* Wallet type for balances channel.
|
|
6362
|
+
*/
|
|
6363
|
+
type KrakenWsBalanceWalletType$1 = 'spot' | 'earn';
|
|
6364
|
+
/**
|
|
6365
|
+
* Wallet identifier in snapshot.
|
|
6366
|
+
*/
|
|
6367
|
+
type KrakenWsBalanceWalletId$1 = 'main' | 'flex' | 'bonded' | 'flexible' | 'liquid' | 'locked' | 'closed';
|
|
6368
|
+
/**
|
|
6369
|
+
* Wallet identifier in update events.
|
|
6370
|
+
*/
|
|
6371
|
+
type KrakenWsBalanceUpdateWalletId$1 = 'main' | 'bonded' | 'flexible' | 'liquid' | 'locked';
|
|
6372
|
+
/**
|
|
6373
|
+
* Balance event type in updates.
|
|
6374
|
+
*/
|
|
6375
|
+
type KrakenWsBalanceEventType$1 = 'deposit' | 'withdrawal' | 'trade' | 'margin' | 'adjustment' | 'rollover' | 'credit' | 'transfer' | 'settled' | 'staking' | 'sale' | 'reserve' | 'conversion' | 'dividend' | 'reward' | 'creator_fee';
|
|
6376
|
+
/**
|
|
6377
|
+
* Balance event subtype in updates.
|
|
6378
|
+
*/
|
|
6379
|
+
type KrakenWsBalanceEventSubtype$1 = 'spotfromfutures' | 'spottofutures' | 'stakingfromspot' | 'spotfromstaking' | 'stakingtospot' | 'spottostaking';
|
|
6380
|
+
/**
|
|
6381
|
+
* Balance event category in updates.
|
|
6382
|
+
*/
|
|
6383
|
+
type KrakenWsBalanceEventCategory$1 = 'deposit' | 'withdrawal' | 'trade' | 'margin-trade' | 'margin-settle' | 'margin-conversion' | 'conversion' | 'credit' | 'marginrollover' | 'staking-rewards' | 'instant' | 'equity-trade' | 'airdrop' | 'equity-dividend' | 'reward-bonus' | 'nft' | 'block-trade';
|
|
6384
|
+
/**
|
|
6385
|
+
* Wallet entry for each asset in the snapshot.
|
|
6386
|
+
*/
|
|
6387
|
+
interface KrakenWsBalanceWalletEntry$1 {
|
|
6388
|
+
/**
|
|
6389
|
+
* Balance of asset in this wallet.
|
|
6390
|
+
*/
|
|
6391
|
+
balance: number;
|
|
6392
|
+
/**
|
|
6393
|
+
* Wallet type: spot / earn.
|
|
6394
|
+
*/
|
|
6395
|
+
type: KrakenWsBalanceWalletType$1;
|
|
6396
|
+
/**
|
|
6397
|
+
* Wallet identifier.
|
|
6398
|
+
*/
|
|
6399
|
+
id: KrakenWsBalanceWalletId$1;
|
|
6400
|
+
}
|
|
6401
|
+
/**
|
|
6402
|
+
* Snapshot entry for each asset in the balances snapshot.
|
|
6403
|
+
*/
|
|
6404
|
+
interface KrakenWsBalancesSnapshotAsset$1 {
|
|
6405
|
+
/**
|
|
6406
|
+
* The asset symbol code (e.g. "BTC", "USD").
|
|
6407
|
+
*/
|
|
6408
|
+
asset: string;
|
|
6409
|
+
/**
|
|
6410
|
+
* Asset class (currently "currency", placeholder for future expansion).
|
|
6411
|
+
*/
|
|
6412
|
+
asset_class: string;
|
|
6413
|
+
/**
|
|
6414
|
+
* Total amount of asset held across all wallet types.
|
|
6415
|
+
*/
|
|
6416
|
+
balance: number;
|
|
6417
|
+
/**
|
|
6418
|
+
* List of wallets holding this asset.
|
|
6419
|
+
*/
|
|
6420
|
+
wallets: KrakenWsBalanceWalletEntry$1[];
|
|
6421
|
+
}
|
|
6422
|
+
/**
|
|
6423
|
+
* Snapshot message payload for the `balances` channel.
|
|
6424
|
+
*/
|
|
6425
|
+
interface KrakenWsBalancesSnapshotMessage$1 {
|
|
6426
|
+
channel: 'balances';
|
|
6427
|
+
type: 'snapshot';
|
|
6428
|
+
data: KrakenWsBalancesSnapshotAsset$1[];
|
|
6429
|
+
/**
|
|
6430
|
+
* Subscription message sequence number.
|
|
6431
|
+
*/
|
|
6432
|
+
sequence: number;
|
|
6433
|
+
}
|
|
6434
|
+
/**
|
|
6435
|
+
* Ledger transaction entry in balances update messages.
|
|
6436
|
+
*/
|
|
6437
|
+
interface KrakenWsBalanceLedgerTransaction$1 {
|
|
6438
|
+
/**
|
|
6439
|
+
* The asset symbol code.
|
|
6440
|
+
*/
|
|
6441
|
+
asset: string;
|
|
6442
|
+
/**
|
|
6443
|
+
* Asset class (currently "currency").
|
|
6444
|
+
*/
|
|
6445
|
+
asset_class: string;
|
|
6446
|
+
/**
|
|
6447
|
+
* The amount of asset change in this event.
|
|
6448
|
+
*/
|
|
6449
|
+
amount: number;
|
|
6450
|
+
/**
|
|
6451
|
+
* The total amount of this asset held in account after the event.
|
|
6452
|
+
*/
|
|
6453
|
+
balance: number;
|
|
6454
|
+
/**
|
|
6455
|
+
* The fee paid on the transaction.
|
|
6456
|
+
*/
|
|
6457
|
+
fee: number;
|
|
6458
|
+
/**
|
|
6459
|
+
* Identifier for this account ledger entry.
|
|
6460
|
+
*/
|
|
6461
|
+
ledger_id: string;
|
|
6462
|
+
/**
|
|
6463
|
+
* Reference identifier for the balance event (e.g. trade_id for trades).
|
|
6464
|
+
*/
|
|
6465
|
+
ref_id: string;
|
|
6466
|
+
/**
|
|
6467
|
+
* Time of the balance change (RFC3339).
|
|
6468
|
+
*/
|
|
6469
|
+
timestamp: string;
|
|
6470
|
+
/**
|
|
6471
|
+
* Broad type of the balance event.
|
|
6472
|
+
*/
|
|
6473
|
+
type: KrakenWsBalanceEventType$1;
|
|
6474
|
+
/**
|
|
6475
|
+
* Specific subtype of the balance event.
|
|
6476
|
+
*/
|
|
6477
|
+
subtype?: KrakenWsBalanceEventSubtype$1;
|
|
6478
|
+
/**
|
|
6479
|
+
* Categorization of the balance event.
|
|
6480
|
+
*/
|
|
6481
|
+
category?: KrakenWsBalanceEventCategory$1;
|
|
6482
|
+
/**
|
|
6483
|
+
* Wallet type (spot / earn).
|
|
6484
|
+
*/
|
|
6485
|
+
wallet_type: KrakenWsBalanceWalletType$1;
|
|
6486
|
+
/**
|
|
6487
|
+
* Wallet identifier, depending on wallet type.
|
|
6488
|
+
*/
|
|
6489
|
+
wallet_id: KrakenWsBalanceUpdateWalletId$1;
|
|
6490
|
+
/**
|
|
6491
|
+
* Published when subscription uses `users=all` (master + subaccounts).
|
|
6492
|
+
*/
|
|
6493
|
+
user?: string;
|
|
6494
|
+
}
|
|
6495
|
+
/**
|
|
6496
|
+
* Update message payload for the `balances` channel.
|
|
6497
|
+
*/
|
|
6498
|
+
interface KrakenWsBalancesUpdateMessage$1 {
|
|
6499
|
+
channel: 'balances';
|
|
6500
|
+
type: 'update';
|
|
6501
|
+
data: KrakenWsBalanceLedgerTransaction$1[];
|
|
6502
|
+
/**
|
|
6503
|
+
* Subscription message sequence number.
|
|
6504
|
+
*/
|
|
6505
|
+
sequence: number;
|
|
6506
|
+
}
|
|
6507
|
+
/**
|
|
6508
|
+
* Union of possible balances channel messages.
|
|
6509
|
+
*/
|
|
6510
|
+
type KrakenWsBalancesMessage$1 = KrakenWsBalancesSnapshotMessage$1 | KrakenWsBalancesUpdateMessage$1;
|
|
5301
6511
|
/**
|
|
5302
6512
|
* Parameters for subscribing to the `balances` channel.
|
|
5303
6513
|
*
|
|
@@ -5306,7 +6516,7 @@ type KrakenWsExecutionsUnsubscribeResponse = KrakenWsMethodResponseEnvelope<Krak
|
|
|
5306
6516
|
* - `token` is optional here; KrakenWebsocketBase can inject it from
|
|
5307
6517
|
* the connection options when `attachAuthToken` is true.
|
|
5308
6518
|
*/
|
|
5309
|
-
interface KrakenWsBalancesSubscribeParams {
|
|
6519
|
+
interface KrakenWsBalancesSubscribeParams$1 {
|
|
5310
6520
|
/**
|
|
5311
6521
|
* Request a snapshot after subscribing.
|
|
5312
6522
|
* Default: true.
|
|
@@ -5336,7 +6546,7 @@ interface KrakenWsBalancesSubscribeParams {
|
|
|
5336
6546
|
/**
|
|
5337
6547
|
* Options for subscribeBalances wrapper – mapped to KrakenWebsocketBase.request.
|
|
5338
6548
|
*/
|
|
5339
|
-
interface KrakenWsBalancesSubscribeOptions {
|
|
6549
|
+
interface KrakenWsBalancesSubscribeOptions$1 {
|
|
5340
6550
|
reqId?: number;
|
|
5341
6551
|
timeoutMs?: number;
|
|
5342
6552
|
attachAuthToken?: boolean;
|
|
@@ -5344,14 +6554,14 @@ interface KrakenWsBalancesSubscribeOptions {
|
|
|
5344
6554
|
/**
|
|
5345
6555
|
* Result payload inside the subscribe ack envelope for balances.
|
|
5346
6556
|
*/
|
|
5347
|
-
interface KrakenWsBalancesSubscribeResult {
|
|
6557
|
+
interface KrakenWsBalancesSubscribeResult$1 {
|
|
5348
6558
|
channel: 'balances';
|
|
5349
6559
|
[key: string]: unknown;
|
|
5350
6560
|
}
|
|
5351
6561
|
/**
|
|
5352
6562
|
* Full WS envelope returned from subscribe (ack) for balances.
|
|
5353
6563
|
*/
|
|
5354
|
-
type KrakenWsBalancesSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsBalancesSubscribeResult>;
|
|
6564
|
+
type KrakenWsBalancesSubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBalancesSubscribeResult$1>;
|
|
5355
6565
|
/**
|
|
5356
6566
|
* Parameters for unsubscribing from the `balances` channel.
|
|
5357
6567
|
*
|
|
@@ -5359,14 +6569,14 @@ type KrakenWsBalancesSubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWs
|
|
|
5359
6569
|
* - `channel` is set to "balances" by the helper.
|
|
5360
6570
|
* - `token` is optional here; base may inject it automatically.
|
|
5361
6571
|
*/
|
|
5362
|
-
interface KrakenWsBalancesUnsubscribeParams {
|
|
6572
|
+
interface KrakenWsBalancesUnsubscribeParams$1 {
|
|
5363
6573
|
token?: string;
|
|
5364
6574
|
[key: string]: unknown;
|
|
5365
6575
|
}
|
|
5366
6576
|
/**
|
|
5367
6577
|
* Options for unsubscribeBalances wrapper.
|
|
5368
6578
|
*/
|
|
5369
|
-
interface KrakenWsBalancesUnsubscribeOptions {
|
|
6579
|
+
interface KrakenWsBalancesUnsubscribeOptions$1 {
|
|
5370
6580
|
reqId?: number;
|
|
5371
6581
|
timeoutMs?: number;
|
|
5372
6582
|
attachAuthToken?: boolean;
|
|
@@ -5374,14 +6584,14 @@ interface KrakenWsBalancesUnsubscribeOptions {
|
|
|
5374
6584
|
/**
|
|
5375
6585
|
* Result payload inside the unsubscribe ack envelope for balances.
|
|
5376
6586
|
*/
|
|
5377
|
-
interface KrakenWsBalancesUnsubscribeResult {
|
|
6587
|
+
interface KrakenWsBalancesUnsubscribeResult$1 {
|
|
5378
6588
|
channel: 'balances';
|
|
5379
6589
|
[key: string]: unknown;
|
|
5380
6590
|
}
|
|
5381
6591
|
/**
|
|
5382
6592
|
* Full WS envelope returned from unsubscribe (ack) for balances.
|
|
5383
6593
|
*/
|
|
5384
|
-
type KrakenWsBalancesUnsubscribeResponse = KrakenWsMethodResponseEnvelope<KrakenWsBalancesUnsubscribeResult>;
|
|
6594
|
+
type KrakenWsBalancesUnsubscribeResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBalancesUnsubscribeResult$1>;
|
|
5385
6595
|
|
|
5386
6596
|
/**
|
|
5387
6597
|
* Kraken Spot WebSocket v2 user-data API.
|
|
@@ -5448,7 +6658,7 @@ declare class KrakenSpotWsUserDataApi {
|
|
|
5448
6658
|
* });
|
|
5449
6659
|
* ```
|
|
5450
6660
|
*/
|
|
5451
|
-
subscribeExecutions(params: KrakenWsExecutionsSubscribeParams, options?: KrakenWsExecutionsSubscribeOptions): Promise<KrakenWsExecutionsSubscribeResponse>;
|
|
6661
|
+
subscribeExecutions(params: KrakenWsExecutionsSubscribeParams$1, options?: KrakenWsExecutionsSubscribeOptions$1): Promise<KrakenWsExecutionsSubscribeResponse$1>;
|
|
5452
6662
|
/**
|
|
5453
6663
|
* Unsubscribe from the `executions` channel.
|
|
5454
6664
|
*
|
|
@@ -5461,7 +6671,7 @@ declare class KrakenSpotWsUserDataApi {
|
|
|
5461
6671
|
* }
|
|
5462
6672
|
* ```
|
|
5463
6673
|
*/
|
|
5464
|
-
unsubscribeExecutions(params?: KrakenWsExecutionsUnsubscribeParams, options?: KrakenWsExecutionsUnsubscribeOptions): Promise<KrakenWsExecutionsUnsubscribeResponse>;
|
|
6674
|
+
unsubscribeExecutions(params?: KrakenWsExecutionsUnsubscribeParams$1, options?: KrakenWsExecutionsUnsubscribeOptions$1): Promise<KrakenWsExecutionsUnsubscribeResponse$1>;
|
|
5465
6675
|
/**
|
|
5466
6676
|
* Subscribe to the `balances` channel.
|
|
5467
6677
|
*
|
|
@@ -5512,7 +6722,7 @@ declare class KrakenSpotWsUserDataApi {
|
|
|
5512
6722
|
* });
|
|
5513
6723
|
* ```
|
|
5514
6724
|
*/
|
|
5515
|
-
subscribeBalances(params?: KrakenWsBalancesSubscribeParams, options?: KrakenWsBalancesSubscribeOptions): Promise<KrakenWsBalancesSubscribeResponse>;
|
|
6725
|
+
subscribeBalances(params?: KrakenWsBalancesSubscribeParams$1, options?: KrakenWsBalancesSubscribeOptions$1): Promise<KrakenWsBalancesSubscribeResponse$1>;
|
|
5516
6726
|
/**
|
|
5517
6727
|
* Unsubscribe from the `balances` channel.
|
|
5518
6728
|
*
|
|
@@ -5525,20 +6735,57 @@ declare class KrakenSpotWsUserDataApi {
|
|
|
5525
6735
|
* }
|
|
5526
6736
|
* ```
|
|
5527
6737
|
*/
|
|
5528
|
-
unsubscribeBalances(params?: KrakenWsBalancesUnsubscribeParams, options?: KrakenWsBalancesUnsubscribeOptions): Promise<KrakenWsBalancesUnsubscribeResponse>;
|
|
5529
|
-
}
|
|
6738
|
+
unsubscribeBalances(params?: KrakenWsBalancesUnsubscribeParams$1, options?: KrakenWsBalancesUnsubscribeOptions$1): Promise<KrakenWsBalancesUnsubscribeResponse$1>;
|
|
6739
|
+
}
|
|
6740
|
+
type KrakenWsExecutionType = KrakenWsExecutionType$1;
|
|
6741
|
+
type KrakenWsOrderStatus = KrakenWsOrderStatus$1;
|
|
6742
|
+
type KrakenWsLiquidityIndicator = KrakenWsLiquidityIndicator$1;
|
|
6743
|
+
type KrakenWsPositionStatus = KrakenWsPositionStatus$1;
|
|
6744
|
+
type KrakenWsTriggerStatus = KrakenWsTriggerStatus$1;
|
|
6745
|
+
type KrakenWsExecutionTimeInForce = KrakenWsExecutionTimeInForce$1;
|
|
6746
|
+
type KrakenWsExecutionFeeEntry = KrakenWsExecutionFeeEntry$1;
|
|
6747
|
+
type KrakenWsExecutionTriggers = KrakenWsExecutionTriggers$1;
|
|
6748
|
+
type KrakenWsExecutionContingent = KrakenWsExecutionContingent$1;
|
|
6749
|
+
type KrakenWsExecutionReport = KrakenWsExecutionReport$1;
|
|
6750
|
+
type KrakenWsExecutionsMessage = KrakenWsExecutionsMessage$1;
|
|
6751
|
+
type KrakenWsExecutionsSubscribeParams = KrakenWsExecutionsSubscribeParams$1;
|
|
6752
|
+
type KrakenWsExecutionsSubscribeOptions = KrakenWsExecutionsSubscribeOptions$1;
|
|
6753
|
+
type KrakenWsExecutionsSubscribeResult = KrakenWsExecutionsSubscribeResult$1;
|
|
6754
|
+
type KrakenWsExecutionsSubscribeResponse = KrakenWsExecutionsSubscribeResponse$1;
|
|
6755
|
+
type KrakenWsExecutionsUnsubscribeParams = KrakenWsExecutionsUnsubscribeParams$1;
|
|
6756
|
+
type KrakenWsExecutionsUnsubscribeOptions = KrakenWsExecutionsUnsubscribeOptions$1;
|
|
6757
|
+
type KrakenWsExecutionsUnsubscribeResult = KrakenWsExecutionsUnsubscribeResult$1;
|
|
6758
|
+
type KrakenWsExecutionsUnsubscribeResponse = KrakenWsExecutionsUnsubscribeResponse$1;
|
|
6759
|
+
type KrakenWsBalanceWalletType = KrakenWsBalanceWalletType$1;
|
|
6760
|
+
type KrakenWsBalanceWalletId = KrakenWsBalanceWalletId$1;
|
|
6761
|
+
type KrakenWsBalanceUpdateWalletId = KrakenWsBalanceUpdateWalletId$1;
|
|
6762
|
+
type KrakenWsBalanceEventType = KrakenWsBalanceEventType$1;
|
|
6763
|
+
type KrakenWsBalanceEventSubtype = KrakenWsBalanceEventSubtype$1;
|
|
6764
|
+
type KrakenWsBalanceEventCategory = KrakenWsBalanceEventCategory$1;
|
|
6765
|
+
type KrakenWsBalanceWalletEntry = KrakenWsBalanceWalletEntry$1;
|
|
6766
|
+
type KrakenWsBalancesSnapshotAsset = KrakenWsBalancesSnapshotAsset$1;
|
|
6767
|
+
type KrakenWsBalancesSnapshotMessage = KrakenWsBalancesSnapshotMessage$1;
|
|
6768
|
+
type KrakenWsBalanceLedgerTransaction = KrakenWsBalanceLedgerTransaction$1;
|
|
6769
|
+
type KrakenWsBalancesUpdateMessage = KrakenWsBalancesUpdateMessage$1;
|
|
6770
|
+
type KrakenWsBalancesMessage = KrakenWsBalancesMessage$1;
|
|
6771
|
+
type KrakenWsBalancesSubscribeParams = KrakenWsBalancesSubscribeParams$1;
|
|
6772
|
+
type KrakenWsBalancesSubscribeOptions = KrakenWsBalancesSubscribeOptions$1;
|
|
6773
|
+
type KrakenWsBalancesSubscribeResult = KrakenWsBalancesSubscribeResult$1;
|
|
6774
|
+
type KrakenWsBalancesSubscribeResponse = KrakenWsBalancesSubscribeResponse$1;
|
|
6775
|
+
type KrakenWsBalancesUnsubscribeParams = KrakenWsBalancesUnsubscribeParams$1;
|
|
6776
|
+
type KrakenWsBalancesUnsubscribeOptions = KrakenWsBalancesUnsubscribeOptions$1;
|
|
6777
|
+
type KrakenWsBalancesUnsubscribeResult = KrakenWsBalancesUnsubscribeResult$1;
|
|
6778
|
+
type KrakenWsBalancesUnsubscribeResponse = KrakenWsBalancesUnsubscribeResponse$1;
|
|
5530
6779
|
|
|
5531
|
-
type KrakenWsOrderSide = 'buy' | 'sell';
|
|
5532
|
-
type KrakenWsOrderType = 'limit' | 'market' | 'iceberg' | 'stop-loss' | 'stop-loss-limit' | 'take-profit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
|
|
5533
|
-
type
|
|
5534
|
-
type
|
|
5535
|
-
type
|
|
5536
|
-
type KrakenWsFeePreference = 'base' | 'quote';
|
|
5537
|
-
type KrakenWsStpType = 'cancel_newest' | 'cancel_oldest' | 'cancel_both';
|
|
6780
|
+
type KrakenWsOrderSide$1 = 'buy' | 'sell';
|
|
6781
|
+
type KrakenWsOrderType$1 = 'limit' | 'market' | 'iceberg' | 'stop-loss' | 'stop-loss-limit' | 'take-profit' | 'take-profit-limit' | 'trailing-stop' | 'trailing-stop-limit' | 'settle-position';
|
|
6782
|
+
type KrakenWsTimeInForce$1 = 'gtc' | 'gtd' | 'ioc';
|
|
6783
|
+
type KrakenWsFeePreference$1 = 'base' | 'quote';
|
|
6784
|
+
type KrakenWsStpType$1 = 'cancel_newest' | 'cancel_oldest' | 'cancel_both';
|
|
5538
6785
|
/**
|
|
5539
6786
|
* Trigger parameters for triggered order types.
|
|
5540
6787
|
*/
|
|
5541
|
-
interface KrakenWsAddOrderTriggers {
|
|
6788
|
+
interface KrakenWsAddOrderTriggers$1 {
|
|
5542
6789
|
/**
|
|
5543
6790
|
* Reference price to track for triggering orders.
|
|
5544
6791
|
* Default is "last".
|
|
@@ -5556,7 +6803,7 @@ interface KrakenWsAddOrderTriggers {
|
|
|
5556
6803
|
/**
|
|
5557
6804
|
* Conditional template for secondary close orders (OTO).
|
|
5558
6805
|
*/
|
|
5559
|
-
interface KrakenWsAddOrderConditional {
|
|
6806
|
+
interface KrakenWsAddOrderConditional$1 {
|
|
5560
6807
|
/**
|
|
5561
6808
|
* Order type of the secondary close orders.
|
|
5562
6809
|
*/
|
|
@@ -5589,7 +6836,7 @@ interface KrakenWsAddOrderConditional {
|
|
|
5589
6836
|
/**
|
|
5590
6837
|
* Fee preference base or quote currency.
|
|
5591
6838
|
*/
|
|
5592
|
-
fee_preference?: KrakenWsFeePreference;
|
|
6839
|
+
fee_preference?: KrakenWsFeePreference$1;
|
|
5593
6840
|
/**
|
|
5594
6841
|
* Deprecated, accepted but ignored.
|
|
5595
6842
|
*/
|
|
@@ -5597,7 +6844,7 @@ interface KrakenWsAddOrderConditional {
|
|
|
5597
6844
|
/**
|
|
5598
6845
|
* Self trade prevention mode for secondary orders.
|
|
5599
6846
|
*/
|
|
5600
|
-
stp_type?: KrakenWsStpType;
|
|
6847
|
+
stp_type?: KrakenWsStpType$1;
|
|
5601
6848
|
/**
|
|
5602
6849
|
* Order volume expressed in quote currency (for buy market orders).
|
|
5603
6850
|
*/
|
|
@@ -5611,15 +6858,15 @@ interface KrakenWsAddOrderConditional {
|
|
|
5611
6858
|
* the connection options.
|
|
5612
6859
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
5613
6860
|
*/
|
|
5614
|
-
interface KrakenWsAddOrderParams {
|
|
5615
|
-
order_type: KrakenWsOrderType;
|
|
5616
|
-
side: KrakenWsOrderSide;
|
|
6861
|
+
interface KrakenWsAddOrderParams$1 {
|
|
6862
|
+
order_type: KrakenWsOrderType$1;
|
|
6863
|
+
side: KrakenWsOrderSide$1;
|
|
5617
6864
|
order_qty: number;
|
|
5618
6865
|
symbol: string;
|
|
5619
6866
|
limit_price?: number;
|
|
5620
6867
|
limit_price_type?: KrakenWsPriceType;
|
|
5621
|
-
triggers?: KrakenWsAddOrderTriggers;
|
|
5622
|
-
time_in_force?: KrakenWsTimeInForce;
|
|
6868
|
+
triggers?: KrakenWsAddOrderTriggers$1;
|
|
6869
|
+
time_in_force?: KrakenWsTimeInForce$1;
|
|
5623
6870
|
margin?: boolean;
|
|
5624
6871
|
post_only?: boolean;
|
|
5625
6872
|
reduce_only?: boolean;
|
|
@@ -5628,10 +6875,10 @@ interface KrakenWsAddOrderParams {
|
|
|
5628
6875
|
deadline?: string;
|
|
5629
6876
|
cl_ord_id?: string;
|
|
5630
6877
|
order_userref?: number;
|
|
5631
|
-
conditional?: KrakenWsAddOrderConditional;
|
|
5632
|
-
fee_preference?: KrakenWsFeePreference;
|
|
6878
|
+
conditional?: KrakenWsAddOrderConditional$1;
|
|
6879
|
+
fee_preference?: KrakenWsFeePreference$1;
|
|
5633
6880
|
no_mpp?: boolean;
|
|
5634
|
-
stp_type?: KrakenWsStpType;
|
|
6881
|
+
stp_type?: KrakenWsStpType$1;
|
|
5635
6882
|
cash_order_qty?: number;
|
|
5636
6883
|
validate?: boolean;
|
|
5637
6884
|
sender_sub_id?: string;
|
|
@@ -5650,7 +6897,7 @@ interface KrakenWsAddOrderParams {
|
|
|
5650
6897
|
/**
|
|
5651
6898
|
* Options for addOrder wrapper – maps directly to KrakenWebsocketBase.request.
|
|
5652
6899
|
*/
|
|
5653
|
-
interface KrakenWsAddOrderOptions {
|
|
6900
|
+
interface KrakenWsAddOrderOptions$1 {
|
|
5654
6901
|
reqId?: number;
|
|
5655
6902
|
timeoutMs?: number;
|
|
5656
6903
|
attachAuthToken?: boolean;
|
|
@@ -5658,7 +6905,7 @@ interface KrakenWsAddOrderOptions {
|
|
|
5658
6905
|
/**
|
|
5659
6906
|
* Result payload inside the WS envelope for add_order.
|
|
5660
6907
|
*/
|
|
5661
|
-
interface KrakenWsAddOrderResult {
|
|
6908
|
+
interface KrakenWsAddOrderResult$1 {
|
|
5662
6909
|
/**
|
|
5663
6910
|
* Unique order identifier generated by Kraken.
|
|
5664
6911
|
*/
|
|
@@ -5679,7 +6926,7 @@ interface KrakenWsAddOrderResult {
|
|
|
5679
6926
|
/**
|
|
5680
6927
|
* Full WS envelope returned from add_order.
|
|
5681
6928
|
*/
|
|
5682
|
-
type KrakenWsAddOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsAddOrderResult>;
|
|
6929
|
+
type KrakenWsAddOrderResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsAddOrderResult$1>;
|
|
5683
6930
|
|
|
5684
6931
|
/**
|
|
5685
6932
|
* Parameters for WS v2 amend_order.
|
|
@@ -5691,7 +6938,7 @@ type KrakenWsAddOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsAddOrderR
|
|
|
5691
6938
|
* the connection options.
|
|
5692
6939
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
5693
6940
|
*/
|
|
5694
|
-
interface KrakenWsAmendOrderParams {
|
|
6941
|
+
interface KrakenWsAmendOrderParams$1 {
|
|
5695
6942
|
/**
|
|
5696
6943
|
* Kraken order identifier to amend.
|
|
5697
6944
|
* Either `order_id` or `cl_ord_id` is required.
|
|
@@ -5753,7 +7000,7 @@ interface KrakenWsAmendOrderParams {
|
|
|
5753
7000
|
/**
|
|
5754
7001
|
* Options for amendOrder wrapper – maps directly to KrakenWebsocketBase.request.
|
|
5755
7002
|
*/
|
|
5756
|
-
interface KrakenWsAmendOrderOptions {
|
|
7003
|
+
interface KrakenWsAmendOrderOptions$1 {
|
|
5757
7004
|
reqId?: number;
|
|
5758
7005
|
timeoutMs?: number;
|
|
5759
7006
|
attachAuthToken?: boolean;
|
|
@@ -5761,7 +7008,7 @@ interface KrakenWsAmendOrderOptions {
|
|
|
5761
7008
|
/**
|
|
5762
7009
|
* Result payload inside the WS envelope for amend_order.
|
|
5763
7010
|
*/
|
|
5764
|
-
interface KrakenWsAmendOrderResult {
|
|
7011
|
+
interface KrakenWsAmendOrderResult$1 {
|
|
5765
7012
|
/**
|
|
5766
7013
|
* Unique Kraken identifier generated for this amend transaction.
|
|
5767
7014
|
*/
|
|
@@ -5782,7 +7029,7 @@ interface KrakenWsAmendOrderResult {
|
|
|
5782
7029
|
/**
|
|
5783
7030
|
* Full WS envelope returned from amend_order.
|
|
5784
7031
|
*/
|
|
5785
|
-
type KrakenWsAmendOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsAmendOrderResult>;
|
|
7032
|
+
type KrakenWsAmendOrderResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsAmendOrderResult$1>;
|
|
5786
7033
|
|
|
5787
7034
|
/**
|
|
5788
7035
|
* Parameters for WS v2 edit_order.
|
|
@@ -5804,7 +7051,7 @@ type KrakenWsAmendOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsAmendOr
|
|
|
5804
7051
|
* the connection options.
|
|
5805
7052
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
5806
7053
|
*/
|
|
5807
|
-
interface KrakenWsEditOrderParams {
|
|
7054
|
+
interface KrakenWsEditOrderParams$1 {
|
|
5808
7055
|
/**
|
|
5809
7056
|
* The Kraken identifier for the order to be edited.
|
|
5810
7057
|
*/
|
|
@@ -5829,7 +7076,7 @@ interface KrakenWsEditOrderParams {
|
|
|
5829
7076
|
* Fee preference base or quote currency. `quote` is the default for buy
|
|
5830
7077
|
* orders, `base` is the default for sell orders.
|
|
5831
7078
|
*/
|
|
5832
|
-
fee_preference?: KrakenWsFeePreference;
|
|
7079
|
+
fee_preference?: KrakenWsFeePreference$1;
|
|
5833
7080
|
/**
|
|
5834
7081
|
* Limit price for order types that support limit price restriction.
|
|
5835
7082
|
*/
|
|
@@ -5860,7 +7107,7 @@ interface KrakenWsEditOrderParams {
|
|
|
5860
7107
|
/**
|
|
5861
7108
|
* Trigger parameters (for triggered order types only).
|
|
5862
7109
|
*/
|
|
5863
|
-
triggers?: KrakenWsAddOrderTriggers;
|
|
7110
|
+
triggers?: KrakenWsAddOrderTriggers$1;
|
|
5864
7111
|
/**
|
|
5865
7112
|
* Deprecated: use `triggers.reference` instead.
|
|
5866
7113
|
*/
|
|
@@ -5893,7 +7140,7 @@ interface KrakenWsEditOrderParams {
|
|
|
5893
7140
|
/**
|
|
5894
7141
|
* Options for editOrder wrapper – maps directly to KrakenWebsocketBase.request.
|
|
5895
7142
|
*/
|
|
5896
|
-
interface KrakenWsEditOrderOptions {
|
|
7143
|
+
interface KrakenWsEditOrderOptions$1 {
|
|
5897
7144
|
reqId?: number;
|
|
5898
7145
|
timeoutMs?: number;
|
|
5899
7146
|
attachAuthToken?: boolean;
|
|
@@ -5901,7 +7148,7 @@ interface KrakenWsEditOrderOptions {
|
|
|
5901
7148
|
/**
|
|
5902
7149
|
* Result payload inside the WS envelope for edit_order.
|
|
5903
7150
|
*/
|
|
5904
|
-
interface KrakenWsEditOrderResult {
|
|
7151
|
+
interface KrakenWsEditOrderResult$1 {
|
|
5905
7152
|
/**
|
|
5906
7153
|
* Unique ID of the new edited order.
|
|
5907
7154
|
*/
|
|
@@ -5918,7 +7165,7 @@ interface KrakenWsEditOrderResult {
|
|
|
5918
7165
|
/**
|
|
5919
7166
|
* Full WS envelope returned from edit_order.
|
|
5920
7167
|
*/
|
|
5921
|
-
type KrakenWsEditOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsEditOrderResult>;
|
|
7168
|
+
type KrakenWsEditOrderResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsEditOrderResult$1>;
|
|
5922
7169
|
|
|
5923
7170
|
/**
|
|
5924
7171
|
* Parameters for WS v2 cancel_order.
|
|
@@ -5931,7 +7178,7 @@ type KrakenWsEditOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsEditOrde
|
|
|
5931
7178
|
* the connection options.
|
|
5932
7179
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
5933
7180
|
*/
|
|
5934
|
-
interface KrakenWsCancelOrderParams {
|
|
7181
|
+
interface KrakenWsCancelOrderParams$1 {
|
|
5935
7182
|
/**
|
|
5936
7183
|
* A list of Kraken order_id identifiers.
|
|
5937
7184
|
*/
|
|
@@ -5953,7 +7200,7 @@ interface KrakenWsCancelOrderParams {
|
|
|
5953
7200
|
/**
|
|
5954
7201
|
* Options for cancelOrder wrapper – maps directly to KrakenWebsocketBase.request.
|
|
5955
7202
|
*/
|
|
5956
|
-
interface KrakenWsCancelOrderOptions {
|
|
7203
|
+
interface KrakenWsCancelOrderOptions$1 {
|
|
5957
7204
|
reqId?: number;
|
|
5958
7205
|
timeoutMs?: number;
|
|
5959
7206
|
attachAuthToken?: boolean;
|
|
@@ -5965,7 +7212,7 @@ interface KrakenWsCancelOrderOptions {
|
|
|
5965
7212
|
* individual responses (one per order). This type represents a single
|
|
5966
7213
|
* cancel response.
|
|
5967
7214
|
*/
|
|
5968
|
-
interface KrakenWsCancelOrderResult {
|
|
7215
|
+
interface KrakenWsCancelOrderResult$1 {
|
|
5969
7216
|
/**
|
|
5970
7217
|
* Kraken identifier of the cancelled order.
|
|
5971
7218
|
*/
|
|
@@ -5982,7 +7229,7 @@ interface KrakenWsCancelOrderResult {
|
|
|
5982
7229
|
/**
|
|
5983
7230
|
* Full WS envelope returned from cancel_order.
|
|
5984
7231
|
*/
|
|
5985
|
-
type KrakenWsCancelOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsCancelOrderResult>;
|
|
7232
|
+
type KrakenWsCancelOrderResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsCancelOrderResult$1>;
|
|
5986
7233
|
|
|
5987
7234
|
/**
|
|
5988
7235
|
* Parameters for WS v2 cancel_all.
|
|
@@ -5992,7 +7239,7 @@ type KrakenWsCancelOrderResponse = KrakenWsMethodResponseEnvelope<KrakenWsCancel
|
|
|
5992
7239
|
* the connection options.
|
|
5993
7240
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
5994
7241
|
*/
|
|
5995
|
-
interface KrakenWsCancelAllParams {
|
|
7242
|
+
interface KrakenWsCancelAllParams$1 {
|
|
5996
7243
|
/**
|
|
5997
7244
|
* Session token. Optional: if omitted, KrakenWebsocketBase will inject
|
|
5998
7245
|
* the connection's authToken (when present).
|
|
@@ -6002,7 +7249,7 @@ interface KrakenWsCancelAllParams {
|
|
|
6002
7249
|
/**
|
|
6003
7250
|
* Options for cancelAll wrapper – maps directly to KrakenWebsocketBase.request.
|
|
6004
7251
|
*/
|
|
6005
|
-
interface KrakenWsCancelAllOptions {
|
|
7252
|
+
interface KrakenWsCancelAllOptions$1 {
|
|
6006
7253
|
reqId?: number;
|
|
6007
7254
|
timeoutMs?: number;
|
|
6008
7255
|
attachAuthToken?: boolean;
|
|
@@ -6010,7 +7257,7 @@ interface KrakenWsCancelAllOptions {
|
|
|
6010
7257
|
/**
|
|
6011
7258
|
* Result payload inside the WS envelope for cancel_all.
|
|
6012
7259
|
*/
|
|
6013
|
-
interface KrakenWsCancelAllResult {
|
|
7260
|
+
interface KrakenWsCancelAllResult$1 {
|
|
6014
7261
|
/**
|
|
6015
7262
|
* Number of orders cancelled.
|
|
6016
7263
|
*/
|
|
@@ -6023,7 +7270,7 @@ interface KrakenWsCancelAllResult {
|
|
|
6023
7270
|
/**
|
|
6024
7271
|
* Full WS envelope returned from cancel_all.
|
|
6025
7272
|
*/
|
|
6026
|
-
type KrakenWsCancelAllResponse = KrakenWsMethodResponseEnvelope<KrakenWsCancelAllResult>;
|
|
7273
|
+
type KrakenWsCancelAllResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsCancelAllResult$1>;
|
|
6027
7274
|
|
|
6028
7275
|
/**
|
|
6029
7276
|
* Parameters for WS v2 cancel_all_orders_after.
|
|
@@ -6033,7 +7280,7 @@ type KrakenWsCancelAllResponse = KrakenWsMethodResponseEnvelope<KrakenWsCancelAl
|
|
|
6033
7280
|
* the connection options.
|
|
6034
7281
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
6035
7282
|
*/
|
|
6036
|
-
interface KrakenWsCancelAllOrdersAfterParams {
|
|
7283
|
+
interface KrakenWsCancelAllOrdersAfterParams$1 {
|
|
6037
7284
|
/**
|
|
6038
7285
|
* Duration (in seconds) to set/extend the timer.
|
|
6039
7286
|
*
|
|
@@ -6050,7 +7297,7 @@ interface KrakenWsCancelAllOrdersAfterParams {
|
|
|
6050
7297
|
/**
|
|
6051
7298
|
* Options for cancelAllOrdersAfter wrapper – maps directly to KrakenWebsocketBase.request.
|
|
6052
7299
|
*/
|
|
6053
|
-
interface KrakenWsCancelAllOrdersAfterOptions {
|
|
7300
|
+
interface KrakenWsCancelAllOrdersAfterOptions$1 {
|
|
6054
7301
|
reqId?: number;
|
|
6055
7302
|
timeoutMs?: number;
|
|
6056
7303
|
attachAuthToken?: boolean;
|
|
@@ -6058,7 +7305,7 @@ interface KrakenWsCancelAllOrdersAfterOptions {
|
|
|
6058
7305
|
/**
|
|
6059
7306
|
* Result payload inside the WS envelope for cancel_all_orders_after.
|
|
6060
7307
|
*/
|
|
6061
|
-
interface KrakenWsCancelAllOrdersAfterResult {
|
|
7308
|
+
interface KrakenWsCancelAllOrdersAfterResult$1 {
|
|
6062
7309
|
/**
|
|
6063
7310
|
* Current engine time.
|
|
6064
7311
|
*/
|
|
@@ -6075,7 +7322,7 @@ interface KrakenWsCancelAllOrdersAfterResult {
|
|
|
6075
7322
|
/**
|
|
6076
7323
|
* Full WS envelope returned from cancel_all_orders_after.
|
|
6077
7324
|
*/
|
|
6078
|
-
type KrakenWsCancelAllOrdersAfterResponse = KrakenWsMethodResponseEnvelope<KrakenWsCancelAllOrdersAfterResult>;
|
|
7325
|
+
type KrakenWsCancelAllOrdersAfterResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsCancelAllOrdersAfterResult$1>;
|
|
6079
7326
|
|
|
6080
7327
|
/**
|
|
6081
7328
|
* Single order entry inside a WS v2 batch_add request.
|
|
@@ -6083,15 +7330,15 @@ type KrakenWsCancelAllOrdersAfterResponse = KrakenWsMethodResponseEnvelope<Krake
|
|
|
6083
7330
|
* All orders in the batch share the same `symbol` (pair), defined at the
|
|
6084
7331
|
* top-level params.
|
|
6085
7332
|
*/
|
|
6086
|
-
interface KrakenWsBatchAddOrderEntry {
|
|
7333
|
+
interface KrakenWsBatchAddOrderEntry$1 {
|
|
6087
7334
|
/**
|
|
6088
7335
|
* Execution side of the order.
|
|
6089
7336
|
*/
|
|
6090
|
-
side: KrakenWsOrderSide;
|
|
7337
|
+
side: KrakenWsOrderSide$1;
|
|
6091
7338
|
/**
|
|
6092
7339
|
* Order type (limit, market, stop-loss, etc.).
|
|
6093
7340
|
*/
|
|
6094
|
-
order_type: KrakenWsOrderType;
|
|
7341
|
+
order_type: KrakenWsOrderType$1;
|
|
6095
7342
|
/**
|
|
6096
7343
|
* Order quantity in terms of the base asset.
|
|
6097
7344
|
*/
|
|
@@ -6103,7 +7350,7 @@ interface KrakenWsBatchAddOrderEntry {
|
|
|
6103
7350
|
/**
|
|
6104
7351
|
* Time-in-force for the order.
|
|
6105
7352
|
*/
|
|
6106
|
-
time_in_force?: KrakenWsTimeInForce;
|
|
7353
|
+
time_in_force?: KrakenWsTimeInForce$1;
|
|
6107
7354
|
/**
|
|
6108
7355
|
* Use margin funding with maximum leverage for the pair (up to 5x).
|
|
6109
7356
|
*/
|
|
@@ -6129,7 +7376,7 @@ interface KrakenWsBatchAddOrderEntry {
|
|
|
6129
7376
|
/**
|
|
6130
7377
|
* Fee preference base or quote currency.
|
|
6131
7378
|
*/
|
|
6132
|
-
fee_preference?: KrakenWsFeePreference;
|
|
7379
|
+
fee_preference?: KrakenWsFeePreference$1;
|
|
6133
7380
|
/**
|
|
6134
7381
|
* Limit price for order types that support it.
|
|
6135
7382
|
*/
|
|
@@ -6158,11 +7405,11 @@ interface KrakenWsBatchAddOrderEntry {
|
|
|
6158
7405
|
/**
|
|
6159
7406
|
* Self Trade Prevention mode.
|
|
6160
7407
|
*/
|
|
6161
|
-
stp_type?: KrakenWsStpType;
|
|
7408
|
+
stp_type?: KrakenWsStpType$1;
|
|
6162
7409
|
/**
|
|
6163
7410
|
* Trigger parameters (for triggered order types).
|
|
6164
7411
|
*/
|
|
6165
|
-
triggers?: KrakenWsAddOrderTriggers;
|
|
7412
|
+
triggers?: KrakenWsAddOrderTriggers$1;
|
|
6166
7413
|
/**
|
|
6167
7414
|
* Sub-account / trader identifier for enhanced STP.
|
|
6168
7415
|
*/
|
|
@@ -6178,7 +7425,7 @@ interface KrakenWsBatchAddOrderEntry {
|
|
|
6178
7425
|
/**
|
|
6179
7426
|
* Conditional template used to generate secondary close orders (OTO).
|
|
6180
7427
|
*/
|
|
6181
|
-
conditional?: KrakenWsAddOrderConditional;
|
|
7428
|
+
conditional?: KrakenWsAddOrderConditional$1;
|
|
6182
7429
|
}
|
|
6183
7430
|
/**
|
|
6184
7431
|
* Parameters for WS v2 batch_add.
|
|
@@ -6188,7 +7435,7 @@ interface KrakenWsBatchAddOrderEntry {
|
|
|
6188
7435
|
* the connection options.
|
|
6189
7436
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
6190
7437
|
*/
|
|
6191
|
-
interface KrakenWsBatchAddParams {
|
|
7438
|
+
interface KrakenWsBatchAddParams$1 {
|
|
6192
7439
|
/**
|
|
6193
7440
|
* The symbol (pair) for all orders in the batch, e.g. "BTC/USD".
|
|
6194
7441
|
*/
|
|
@@ -6197,7 +7444,7 @@ interface KrakenWsBatchAddParams {
|
|
|
6197
7444
|
* A list of orders in the batch.
|
|
6198
7445
|
* Must contain between 2 and 15 orders (inclusive).
|
|
6199
7446
|
*/
|
|
6200
|
-
orders: KrakenWsBatchAddOrderEntry[];
|
|
7447
|
+
orders: KrakenWsBatchAddOrderEntry$1[];
|
|
6201
7448
|
/**
|
|
6202
7449
|
* Deadline for the entire batch, in RFC3339 format with millisecond precision.
|
|
6203
7450
|
* Protects against latency on time-sensitive orders.
|
|
@@ -6216,7 +7463,7 @@ interface KrakenWsBatchAddParams {
|
|
|
6216
7463
|
/**
|
|
6217
7464
|
* Options for batchAdd wrapper – maps directly to KrakenWebsocketBase.request.
|
|
6218
7465
|
*/
|
|
6219
|
-
interface KrakenWsBatchAddOptions {
|
|
7466
|
+
interface KrakenWsBatchAddOptions$1 {
|
|
6220
7467
|
reqId?: number;
|
|
6221
7468
|
timeoutMs?: number;
|
|
6222
7469
|
attachAuthToken?: boolean;
|
|
@@ -6226,7 +7473,7 @@ interface KrakenWsBatchAddOptions {
|
|
|
6226
7473
|
*
|
|
6227
7474
|
* The order of these entries matches the order of the orders in the request.
|
|
6228
7475
|
*/
|
|
6229
|
-
interface KrakenWsBatchAddOrderResultEntry {
|
|
7476
|
+
interface KrakenWsBatchAddOrderResultEntry$1 {
|
|
6230
7477
|
/**
|
|
6231
7478
|
* Unique order identifier generated by Kraken.
|
|
6232
7479
|
*/
|
|
@@ -6248,7 +7495,7 @@ interface KrakenWsBatchAddOrderResultEntry {
|
|
|
6248
7495
|
* Full WS envelope returned from batch_add.
|
|
6249
7496
|
* `result` is an array of per-order results.
|
|
6250
7497
|
*/
|
|
6251
|
-
type KrakenWsBatchAddResponse = KrakenWsMethodResponseEnvelope<KrakenWsBatchAddOrderResultEntry[]>;
|
|
7498
|
+
type KrakenWsBatchAddResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBatchAddOrderResultEntry$1[]>;
|
|
6252
7499
|
|
|
6253
7500
|
/**
|
|
6254
7501
|
* Parameters for WS v2 batch_cancel.
|
|
@@ -6263,7 +7510,7 @@ type KrakenWsBatchAddResponse = KrakenWsMethodResponseEnvelope<KrakenWsBatchAddO
|
|
|
6263
7510
|
* the connection options.
|
|
6264
7511
|
* - `req_id` is handled by KrakenWebsocketBase.request; do not include it here.
|
|
6265
7512
|
*/
|
|
6266
|
-
interface KrakenWsBatchCancelParams {
|
|
7513
|
+
interface KrakenWsBatchCancelParams$1 {
|
|
6267
7514
|
/**
|
|
6268
7515
|
* A list containing either client order_userref or Kraken order_id
|
|
6269
7516
|
* identifiers.
|
|
@@ -6284,7 +7531,7 @@ interface KrakenWsBatchCancelParams {
|
|
|
6284
7531
|
/**
|
|
6285
7532
|
* Options for batchCancel wrapper – maps directly to KrakenWebsocketBase.request.
|
|
6286
7533
|
*/
|
|
6287
|
-
interface KrakenWsBatchCancelOptions {
|
|
7534
|
+
interface KrakenWsBatchCancelOptions$1 {
|
|
6288
7535
|
reqId?: number;
|
|
6289
7536
|
timeoutMs?: number;
|
|
6290
7537
|
attachAuthToken?: boolean;
|
|
@@ -6292,7 +7539,7 @@ interface KrakenWsBatchCancelOptions {
|
|
|
6292
7539
|
/**
|
|
6293
7540
|
* Result payload inside the WS envelope for batch_cancel.
|
|
6294
7541
|
*/
|
|
6295
|
-
interface KrakenWsBatchCancelResult {
|
|
7542
|
+
interface KrakenWsBatchCancelResult$1 {
|
|
6296
7543
|
/**
|
|
6297
7544
|
* Number of orders cancelled.
|
|
6298
7545
|
*/
|
|
@@ -6305,7 +7552,7 @@ interface KrakenWsBatchCancelResult {
|
|
|
6305
7552
|
/**
|
|
6306
7553
|
* Full WS envelope returned from batch_cancel.
|
|
6307
7554
|
*/
|
|
6308
|
-
type KrakenWsBatchCancelResponse = KrakenWsMethodResponseEnvelope<KrakenWsBatchCancelResult>;
|
|
7555
|
+
type KrakenWsBatchCancelResponse$1 = KrakenWsMethodResponseEnvelope<KrakenWsBatchCancelResult$1>;
|
|
6309
7556
|
|
|
6310
7557
|
/**
|
|
6311
7558
|
* User trading RPC methods over WebSocket v2 (auth WS).
|
|
@@ -6348,7 +7595,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6348
7595
|
* }
|
|
6349
7596
|
* ```
|
|
6350
7597
|
*/
|
|
6351
|
-
addOrder(params: KrakenWsAddOrderParams, options?: KrakenWsAddOrderOptions): Promise<KrakenWsAddOrderResponse>;
|
|
7598
|
+
addOrder(params: KrakenWsAddOrderParams$1, options?: KrakenWsAddOrderOptions$1): Promise<KrakenWsAddOrderResponse$1>;
|
|
6352
7599
|
/**
|
|
6353
7600
|
* Amend an existing order in-place.
|
|
6354
7601
|
*
|
|
@@ -6373,7 +7620,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6373
7620
|
* }
|
|
6374
7621
|
* ```
|
|
6375
7622
|
*/
|
|
6376
|
-
amendOrder(params: KrakenWsAmendOrderParams, options?: KrakenWsAmendOrderOptions): Promise<KrakenWsAmendOrderResponse>;
|
|
7623
|
+
amendOrder(params: KrakenWsAmendOrderParams$1, options?: KrakenWsAmendOrderOptions$1): Promise<KrakenWsAmendOrderResponse$1>;
|
|
6377
7624
|
/**
|
|
6378
7625
|
* Edit (replace) an existing order.
|
|
6379
7626
|
*
|
|
@@ -6409,7 +7656,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6409
7656
|
* }
|
|
6410
7657
|
* ```
|
|
6411
7658
|
*/
|
|
6412
|
-
editOrder(params: KrakenWsEditOrderParams, options?: KrakenWsEditOrderOptions): Promise<KrakenWsEditOrderResponse>;
|
|
7659
|
+
editOrder(params: KrakenWsEditOrderParams$1, options?: KrakenWsEditOrderOptions$1): Promise<KrakenWsEditOrderResponse$1>;
|
|
6413
7660
|
/**
|
|
6414
7661
|
* Cancel one or more open orders.
|
|
6415
7662
|
*
|
|
@@ -6435,7 +7682,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6435
7682
|
* }
|
|
6436
7683
|
* ```
|
|
6437
7684
|
*/
|
|
6438
|
-
cancelOrder(params: KrakenWsCancelOrderParams, options?: KrakenWsCancelOrderOptions): Promise<KrakenWsCancelOrderResponse>;
|
|
7685
|
+
cancelOrder(params: KrakenWsCancelOrderParams$1, options?: KrakenWsCancelOrderOptions$1): Promise<KrakenWsCancelOrderResponse$1>;
|
|
6439
7686
|
/**
|
|
6440
7687
|
* Cancel **all** open orders, including untriggered orders and orders
|
|
6441
7688
|
* resting in the book.
|
|
@@ -6454,7 +7701,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6454
7701
|
* }
|
|
6455
7702
|
* ```
|
|
6456
7703
|
*/
|
|
6457
|
-
cancelAll(params?: KrakenWsCancelAllParams, options?: KrakenWsCancelAllOptions): Promise<KrakenWsCancelAllResponse>;
|
|
7704
|
+
cancelAll(params?: KrakenWsCancelAllParams$1, options?: KrakenWsCancelAllOptions$1): Promise<KrakenWsCancelAllResponse$1>;
|
|
6458
7705
|
/**
|
|
6459
7706
|
* Configure the "Dead Man's Switch" timer that cancels all orders
|
|
6460
7707
|
* after a given number of seconds without refresh.
|
|
@@ -6480,7 +7727,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6480
7727
|
* }
|
|
6481
7728
|
* ```
|
|
6482
7729
|
*/
|
|
6483
|
-
cancelAllOrdersAfter(params: KrakenWsCancelAllOrdersAfterParams, options?: KrakenWsCancelAllOrdersAfterOptions): Promise<KrakenWsCancelAllOrdersAfterResponse>;
|
|
7730
|
+
cancelAllOrdersAfter(params: KrakenWsCancelAllOrdersAfterParams$1, options?: KrakenWsCancelAllOrdersAfterOptions$1): Promise<KrakenWsCancelAllOrdersAfterResponse$1>;
|
|
6484
7731
|
/**
|
|
6485
7732
|
* Send a batch of 2–15 orders for a single symbol.
|
|
6486
7733
|
*
|
|
@@ -6525,7 +7772,7 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6525
7772
|
* }
|
|
6526
7773
|
* ```
|
|
6527
7774
|
*/
|
|
6528
|
-
batchAdd(params: KrakenWsBatchAddParams, options?: KrakenWsBatchAddOptions): Promise<KrakenWsBatchAddResponse>;
|
|
7775
|
+
batchAdd(params: KrakenWsBatchAddParams$1, options?: KrakenWsBatchAddOptions$1): Promise<KrakenWsBatchAddResponse$1>;
|
|
6529
7776
|
/**
|
|
6530
7777
|
* Cancel multiple orders (2–50 identifiers) in a single WS v2 request.
|
|
6531
7778
|
*
|
|
@@ -6547,8 +7794,48 @@ declare class KrakenSpotWsUserTradingApi {
|
|
|
6547
7794
|
* }
|
|
6548
7795
|
* ```
|
|
6549
7796
|
*/
|
|
6550
|
-
batchCancel(params: KrakenWsBatchCancelParams, options?: KrakenWsBatchCancelOptions): Promise<KrakenWsBatchCancelResponse>;
|
|
6551
|
-
}
|
|
7797
|
+
batchCancel(params: KrakenWsBatchCancelParams$1, options?: KrakenWsBatchCancelOptions$1): Promise<KrakenWsBatchCancelResponse$1>;
|
|
7798
|
+
}
|
|
7799
|
+
type KrakenWsOrderSide = KrakenWsOrderSide$1;
|
|
7800
|
+
type KrakenWsOrderType = KrakenWsOrderType$1;
|
|
7801
|
+
type KrakenWsTimeInForce = KrakenWsTimeInForce$1;
|
|
7802
|
+
type KrakenWsFeePreference = KrakenWsFeePreference$1;
|
|
7803
|
+
type KrakenWsStpType = KrakenWsStpType$1;
|
|
7804
|
+
type KrakenWsAddOrderTriggers = KrakenWsAddOrderTriggers$1;
|
|
7805
|
+
type KrakenWsAddOrderConditional = KrakenWsAddOrderConditional$1;
|
|
7806
|
+
type KrakenWsAddOrderParams = KrakenWsAddOrderParams$1;
|
|
7807
|
+
type KrakenWsAddOrderOptions = KrakenWsAddOrderOptions$1;
|
|
7808
|
+
type KrakenWsAddOrderResult = KrakenWsAddOrderResult$1;
|
|
7809
|
+
type KrakenWsAddOrderResponse = KrakenWsAddOrderResponse$1;
|
|
7810
|
+
type KrakenWsAmendOrderParams = KrakenWsAmendOrderParams$1;
|
|
7811
|
+
type KrakenWsAmendOrderOptions = KrakenWsAmendOrderOptions$1;
|
|
7812
|
+
type KrakenWsAmendOrderResult = KrakenWsAmendOrderResult$1;
|
|
7813
|
+
type KrakenWsAmendOrderResponse = KrakenWsAmendOrderResponse$1;
|
|
7814
|
+
type KrakenWsEditOrderParams = KrakenWsEditOrderParams$1;
|
|
7815
|
+
type KrakenWsEditOrderOptions = KrakenWsEditOrderOptions$1;
|
|
7816
|
+
type KrakenWsEditOrderResult = KrakenWsEditOrderResult$1;
|
|
7817
|
+
type KrakenWsEditOrderResponse = KrakenWsEditOrderResponse$1;
|
|
7818
|
+
type KrakenWsCancelOrderParams = KrakenWsCancelOrderParams$1;
|
|
7819
|
+
type KrakenWsCancelOrderOptions = KrakenWsCancelOrderOptions$1;
|
|
7820
|
+
type KrakenWsCancelOrderResult = KrakenWsCancelOrderResult$1;
|
|
7821
|
+
type KrakenWsCancelOrderResponse = KrakenWsCancelOrderResponse$1;
|
|
7822
|
+
type KrakenWsCancelAllParams = KrakenWsCancelAllParams$1;
|
|
7823
|
+
type KrakenWsCancelAllOptions = KrakenWsCancelAllOptions$1;
|
|
7824
|
+
type KrakenWsCancelAllResult = KrakenWsCancelAllResult$1;
|
|
7825
|
+
type KrakenWsCancelAllResponse = KrakenWsCancelAllResponse$1;
|
|
7826
|
+
type KrakenWsCancelAllOrdersAfterParams = KrakenWsCancelAllOrdersAfterParams$1;
|
|
7827
|
+
type KrakenWsCancelAllOrdersAfterOptions = KrakenWsCancelAllOrdersAfterOptions$1;
|
|
7828
|
+
type KrakenWsCancelAllOrdersAfterResult = KrakenWsCancelAllOrdersAfterResult$1;
|
|
7829
|
+
type KrakenWsCancelAllOrdersAfterResponse = KrakenWsCancelAllOrdersAfterResponse$1;
|
|
7830
|
+
type KrakenWsBatchAddParams = KrakenWsBatchAddParams$1;
|
|
7831
|
+
type KrakenWsBatchAddOptions = KrakenWsBatchAddOptions$1;
|
|
7832
|
+
type KrakenWsBatchAddOrderEntry = KrakenWsBatchAddOrderEntry$1;
|
|
7833
|
+
type KrakenWsBatchAddOrderResultEntry = KrakenWsBatchAddOrderResultEntry$1;
|
|
7834
|
+
type KrakenWsBatchAddResponse = KrakenWsBatchAddResponse$1;
|
|
7835
|
+
type KrakenWsBatchCancelParams = KrakenWsBatchCancelParams$1;
|
|
7836
|
+
type KrakenWsBatchCancelOptions = KrakenWsBatchCancelOptions$1;
|
|
7837
|
+
type KrakenWsBatchCancelResult = KrakenWsBatchCancelResult$1;
|
|
7838
|
+
type KrakenWsBatchCancelResponse = KrakenWsBatchCancelResponse$1;
|
|
6552
7839
|
|
|
6553
7840
|
interface KrakenSpotWebsocketClientOptions {
|
|
6554
7841
|
publicUrl?: string;
|
|
@@ -6573,4 +7860,4 @@ declare class KrakenSpotWebsocketV2Client {
|
|
|
6573
7860
|
constructor(options?: KrakenSpotWebsocketClientOptions);
|
|
6574
7861
|
}
|
|
6575
7862
|
|
|
6576
|
-
export { type KrakenApiResponse, type KrakenClientOptions, type KrakenLogger, KrakenSpotRestClient, type KrakenSpotWebsocketClientOptions, KrakenSpotWebsocketV2Client };
|
|
7863
|
+
export { type KrakenAccountBalanceMap, type KrakenAccountTransferParams, type KrakenAccountTransferResult, type KrakenAddOrderBatchOrderDescription, type KrakenAddOrderBatchOrderParams, type KrakenAddOrderBatchOrderResult, type KrakenAddOrderBatchParams, type KrakenAddOrderBatchResult, type KrakenAddOrderDescription, type KrakenAddOrderParams, type KrakenAddOrderResult, type KrakenAddOrderStpType, type KrakenAddOrderTimeInForce, type KrakenAmendOrderParams, type KrakenAmendOrderResult, type KrakenApiResponse, type KrakenAssetClass, type KrakenAssetInfo, type KrakenAssetInfoMap, type KrakenAssetPair, type KrakenAssetPairInfoType, type KrakenAssetPairMap, type KrakenAssetPairStatus, type KrakenAssetStatus, type KrakenAssetTickerInfo, type KrakenCancelAllOrdersAfterParams, type KrakenCancelAllOrdersAfterResult, type KrakenCancelAllOrdersResult, type KrakenCancelOrderBatchOrderRef, type KrakenCancelOrderBatchParams, type KrakenCancelOrderBatchResult, type KrakenCancelOrderParams, type KrakenCancelOrderResult, type KrakenClientOptions, type KrakenClosedOrder, type KrakenClosedOrdersCloseTime, type KrakenClosedOrdersMap, type KrakenClosedOrdersResult, type KrakenCreateSubaccountParams, type KrakenCreateSubaccountResult, type KrakenCreditLinesAssetEntry, type KrakenCreditLinesAssetMap, type KrakenCreditLinesLimitsMonitor, type KrakenCreditLinesResponse, type KrakenCreditLinesResult, type KrakenDeleteExportReportParams, type KrakenDeleteExportReportResult, type KrakenDeleteExportReportType, type KrakenDepositAddress, type KrakenDepositMethod, type KrakenDepositStatusEntry, type KrakenEarnAllocateFundsParams, type KrakenEarnAllocateFundsResult, type KrakenEarnAllocationItem, type KrakenEarnAllocationStatus, type KrakenEarnAmountBreakdown, type KrakenEarnDeallocateFundsParams, type KrakenEarnDeallocateFundsResult, type KrakenEarnDeallocationStatus, type KrakenEarnGetAllocationStatusParams, type KrakenEarnGetAllocationStatusResult, type KrakenEarnGetDeallocationStatusParams, type KrakenEarnGetDeallocationStatusResult, type KrakenEarnListAllocationsParams, type KrakenEarnListAllocationsResult, type KrakenEarnListAllocationsResultObject, type KrakenEarnListStrategiesParams, type KrakenEarnListStrategiesResult, type KrakenEarnListStrategiesResultObject, type KrakenEarnLockType, type KrakenEarnStrategy, type KrakenEditOrderDescription, type KrakenEditOrderParams, type KrakenEditOrderResult, type KrakenExportReportFormat, type KrakenExportReportStatus, type KrakenExportReportStatusState, type KrakenExportReportType, type KrakenExtendedBalanceEntry, type KrakenExtendedBalanceMap, type KrakenFeeScheduleEntry, type KrakenFeeTierInfo, type KrakenGetAccountBalanceParams, type KrakenGetAssetInfoParams, type KrakenGetClosedOrdersParams, type KrakenGetCreditLinesParams, type KrakenGetDepositAddressesParams, type KrakenGetDepositAddressesResult, type KrakenGetDepositMethodsParams, type KrakenGetDepositMethodsResult, type KrakenGetDepositStatusParams, type KrakenGetExportReportStatusParams, type KrakenGetExtendedBalanceParams, type KrakenGetLedgersInfoParams, type KrakenGetLedgersQueryParams, type KrakenGetOhlcDataParams, type KrakenGetOpenOrdersParams, type KrakenGetOpenPositionsParams, type KrakenGetOrderAmendsParams, type KrakenGetOrderBookParams, type KrakenGetOrdersInfoParams, type KrakenGetPostTradeDataParams, type KrakenGetPostTradeDataResult, type KrakenGetPreTradeDataParams, type KrakenGetRecentSpreadsParams, type KrakenGetRecentTradesParams, type KrakenGetTickerInformationParams, type KrakenGetTradableAssetPairsParams, type KrakenGetTradeBalanceParams, type KrakenGetTradeVolumeParams, type KrakenGetTradesHistoryParams, type KrakenGetTradesInfoParams, type KrakenGetWebSocketsTokenResult, type KrakenGetWithdrawAddressesParams, type KrakenGetWithdrawAddressesResult, type KrakenGetWithdrawInfoParams, type KrakenGetWithdrawInfoResult, type KrakenGetWithdrawMethodsParams, type KrakenGetWithdrawMethodsResult, type KrakenGetWithdrawStatusParams, type KrakenGetWithdrawStatusResult, type KrakenLedgerEntry, type KrakenLedgerEntryType, type KrakenLedgerMap, type KrakenLedgerTypeFilter, type KrakenLedgersInfoResult, type KrakenLogger, type KrakenOhlcEntry, type KrakenOhlcInterval, type KrakenOhlcMap, type KrakenOhlcResponse, type KrakenOpenOrder, type KrakenOpenOrderDescription, type KrakenOpenOrdersMap, type KrakenOpenOrdersResult, type KrakenOpenPosition, type KrakenOpenPositionsConsolidationMode, type KrakenOpenPositionsMap, type KrakenOrderAmendEntry, type KrakenOrderAmendType, type KrakenOrderAmendsResult, type KrakenOrderBook, type KrakenOrderBookLevel, type KrakenOrderBookMap, type KrakenOrderSide, type KrakenOrderStatus, type KrakenOrderTrigger, type KrakenOrderType, type KrakenPositionStatus, type KrakenPostTradeEntry, type KrakenPreTradeDataResult, type KrakenQueriedLedgersMap, type KrakenQueriedOrder, type KrakenQueriedOrdersMap, type KrakenQueriedTradesMap, type KrakenRebaseMultiplier$1 as KrakenRebaseMultiplier, type KrakenRecentSpreadsResponse, type KrakenRecentTradesResponse, type KrakenRequestExportReportParams, type KrakenRequestExportReportResult, type KrakenRetrieveExportParams, type KrakenRetrieveExportResult, type KrakenServerTime, KrakenSpotAccountDataApi, KrakenSpotEarnApi, KrakenSpotFundingApi, KrakenSpotMarketDataApi, KrakenSpotRestClient, KrakenSpotSubaccountsApi, KrakenSpotTradingApi, KrakenSpotTransparencyApi, type KrakenSpotWebsocketClientOptions, KrakenSpotWebsocketV2Client, KrakenSpotWsAdminApi, KrakenSpotWsMarketDataApi, KrakenSpotWsUserDataApi, KrakenSpotWsUserTradingApi, type KrakenSpreadEntry, type KrakenSpreadsMap, type KrakenSystemStatus, type KrakenSystemStatusResult, type KrakenTickerAssetClass, type KrakenTickerInfoMap, type KrakenTradeBalanceResult, type KrakenTradeEntry, type KrakenTradeHistoryEntry, type KrakenTradeHistoryMap, type KrakenTradeHistoryTypeFilter, type KrakenTradeVolumeFeesMap, type KrakenTradeVolumeResult, type KrakenTradesHistoryResult, type KrakenTradesMap, type KrakenWalletTransferParams, type KrakenWalletTransferResult, type KrakenWebSocketLike, type KrakenWebSocketLikeCtor, KrakenWebsocketBase, type KrakenWebsocketConnectionOptions, type KrakenWebsocketLogger, type KrakenWithdrawAddress, type KrakenWithdrawCancelParams, type KrakenWithdrawCancelResult, type KrakenWithdrawFundsParams, type KrakenWithdrawFundsResult, type KrakenWithdrawInfo, type KrakenWithdrawMethod, type KrakenWithdrawStatusEntry, type KrakenWsAddOrderConditional, type KrakenWsAddOrderOptions, type KrakenWsAddOrderParams, type KrakenWsAddOrderResponse, type KrakenWsAddOrderResult, type KrakenWsAddOrderTriggers, type KrakenWsAmendOrderOptions, type KrakenWsAmendOrderParams, type KrakenWsAmendOrderResponse, type KrakenWsAmendOrderResult, type KrakenWsBalanceEventCategory, type KrakenWsBalanceEventSubtype, type KrakenWsBalanceEventType, type KrakenWsBalanceLedgerTransaction, type KrakenWsBalanceUpdateWalletId, type KrakenWsBalanceWalletEntry, type KrakenWsBalanceWalletId, type KrakenWsBalanceWalletType, type KrakenWsBalancesMessage, type KrakenWsBalancesSnapshotAsset, type KrakenWsBalancesSnapshotMessage, type KrakenWsBalancesSubscribeOptions, type KrakenWsBalancesSubscribeParams, type KrakenWsBalancesSubscribeResponse, type KrakenWsBalancesSubscribeResult, type KrakenWsBalancesUnsubscribeOptions, type KrakenWsBalancesUnsubscribeParams, type KrakenWsBalancesUnsubscribeResponse, type KrakenWsBalancesUnsubscribeResult, type KrakenWsBalancesUpdateMessage, type KrakenWsBatchAddOptions, type KrakenWsBatchAddOrderEntry, type KrakenWsBatchAddOrderResultEntry, type KrakenWsBatchAddParams, type KrakenWsBatchAddResponse, type KrakenWsBatchCancelOptions, type KrakenWsBatchCancelParams, type KrakenWsBatchCancelResponse, type KrakenWsBatchCancelResult, type KrakenWsBookLevel, type KrakenWsBookMessage, type KrakenWsBookSnapshotMessage, type KrakenWsBookSubscribeOptions, type KrakenWsBookSubscribeParams, type KrakenWsBookSubscribeResponse, type KrakenWsBookUnsubscribeOptions, type KrakenWsBookUnsubscribeParams, type KrakenWsBookUnsubscribeResponse, type KrakenWsBookUpdateMessage, type KrakenWsCancelAllOptions, type KrakenWsCancelAllOrdersAfterOptions, type KrakenWsCancelAllOrdersAfterParams, type KrakenWsCancelAllOrdersAfterResponse, type KrakenWsCancelAllOrdersAfterResult, type KrakenWsCancelAllParams, type KrakenWsCancelAllResponse, type KrakenWsCancelAllResult, type KrakenWsCancelOrderOptions, type KrakenWsCancelOrderParams, type KrakenWsCancelOrderResponse, type KrakenWsCancelOrderResult, type KrakenWsEditOrderOptions, type KrakenWsEditOrderParams, type KrakenWsEditOrderResponse, type KrakenWsEditOrderResult, type KrakenWsExecutionContingent, type KrakenWsExecutionFeeEntry, type KrakenWsExecutionReport, type KrakenWsExecutionTimeInForce, type KrakenWsExecutionTriggers, type KrakenWsExecutionType, type KrakenWsExecutionsMessage, type KrakenWsExecutionsSubscribeOptions, type KrakenWsExecutionsSubscribeParams, type KrakenWsExecutionsSubscribeResponse, type KrakenWsExecutionsSubscribeResult, type KrakenWsExecutionsUnsubscribeOptions, type KrakenWsExecutionsUnsubscribeParams, type KrakenWsExecutionsUnsubscribeResponse, type KrakenWsExecutionsUnsubscribeResult, type KrakenWsFeePreference, type KrakenWsHeartbeatHandler, type KrakenWsHeartbeatMessage, type KrakenWsInstrumentAsset, type KrakenWsInstrumentAssetStatus, type KrakenWsInstrumentData, type KrakenWsInstrumentMessage, type KrakenWsInstrumentPair, type KrakenWsInstrumentPairStatus, type KrakenWsInstrumentSnapshotMessage, type KrakenWsInstrumentSubscribeOptions, type KrakenWsInstrumentSubscribeParams, type KrakenWsInstrumentSubscribeResponse, type KrakenWsInstrumentUnsubscribeOptions, type KrakenWsInstrumentUnsubscribeParams, type KrakenWsInstrumentUnsubscribeResponse, type KrakenWsInstrumentUpdateMessage, type KrakenWsLevel3Depth, type KrakenWsLevel3Message, type KrakenWsLevel3OrderEventType, type KrakenWsLevel3SnapshotMessage, type KrakenWsLevel3SubscribeOptions, type KrakenWsLevel3SubscribeParams, type KrakenWsLevel3SubscribeResponse, type KrakenWsLevel3UnsubscribeOptions, type KrakenWsLevel3UnsubscribeParams, type KrakenWsLevel3UnsubscribeResponse, type KrakenWsLevel3UpdateMessage, type KrakenWsLiquidityIndicator, type KrakenWsMessageHandler, type KrakenWsMethodResponseEnvelope, type KrakenWsOhlcMessage, type KrakenWsOhlcSnapshotMessage, type KrakenWsOhlcSubscribeOptions, type KrakenWsOhlcSubscribeParams, type KrakenWsOhlcSubscribeResponse, type KrakenWsOhlcUnsubscribeOptions, type KrakenWsOhlcUnsubscribeParams, type KrakenWsOhlcUnsubscribeResponse, type KrakenWsOhlcUpdateMessage, type KrakenWsOrderSide, type KrakenWsOrderStatus, type KrakenWsOrderType, type KrakenWsPingParams, type KrakenWsPingResponse, type KrakenWsPingResult, type KrakenWsPositionStatus, type KrakenWsPriceType, type KrakenWsStatusData, type KrakenWsStatusUpdateMessage, type KrakenWsStpType, type KrakenWsTickerData, type KrakenWsTickerMessage, type KrakenWsTickerSnapshotMessage, type KrakenWsTickerSubscribeOptions, type KrakenWsTickerSubscribeParams, type KrakenWsTickerSubscribeResponse, type KrakenWsTickerUnsubscribeOptions, type KrakenWsTickerUnsubscribeParams, type KrakenWsTickerUnsubscribeResponse, type KrakenWsTickerUpdateMessage, type KrakenWsTimeInForce, type KrakenWsTradeEntry, type KrakenWsTradeMessage, type KrakenWsTradeOrderType, type KrakenWsTradeSide, type KrakenWsTradeSnapshotMessage, type KrakenWsTradeSubscribeOptions, type KrakenWsTradeSubscribeParams, type KrakenWsTradeSubscribeResponse, type KrakenWsTradeUnsubscribeOptions, type KrakenWsTradeUnsubscribeParams, type KrakenWsTradeUnsubscribeResponse, type KrakenWsTradeUpdateMessage, type KrakenWsTriggerReference, type KrakenWsTriggerStatus };
|