@binance/alpha 1.0.16 → 3.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 +103 -0
- package/dist/index.d.mts +2356 -178
- package/dist/index.d.ts +2356 -178
- package/dist/index.js +761 -39
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +751 -41
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import { ALPHA_REST_API_PROD_URL, BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";
|
|
1
|
+
import { ALPHA_REST_API_PROD_URL, ALPHA_WS_STREAMS_PROD_URL, BadRequestError, ConfigurationRestAPI, ConfigurationWebsocketStreams, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError, WebsocketStream, WebsocketStreamsBase } from "@binance/common";
|
|
2
2
|
|
|
3
3
|
//#region rolldown:runtime
|
|
4
4
|
|
|
5
5
|
//#endregion
|
|
6
6
|
//#region src/rest-api/types/aggregated-trades-response-data-inner.d.ts
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Alpha Trading REST API
|
|
9
9
|
*
|
|
10
|
-
*
|
|
10
|
+
* APIs for Binance Alpha Trading.
|
|
11
11
|
*
|
|
12
12
|
* The version of the OpenAPI document: 1.0.0
|
|
13
13
|
*
|
|
@@ -23,43 +23,43 @@ import { ALPHA_REST_API_PROD_URL, BadRequestError, ConfigurationRestAPI, Connect
|
|
|
23
23
|
*/
|
|
24
24
|
interface AggregatedTradesResponseDataInner {
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Aggregate trade ID.
|
|
27
27
|
* @type {number | bigint}
|
|
28
28
|
* @memberof AggregatedTradesResponseDataInner
|
|
29
29
|
*/
|
|
30
30
|
a?: number | bigint;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* Trade price.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof AggregatedTradesResponseDataInner
|
|
35
35
|
*/
|
|
36
36
|
p?: string;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Trade quantity.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof AggregatedTradesResponseDataInner
|
|
41
41
|
*/
|
|
42
42
|
q?: string;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* First trade ID in the aggregation.
|
|
45
45
|
* @type {number | bigint}
|
|
46
46
|
* @memberof AggregatedTradesResponseDataInner
|
|
47
47
|
*/
|
|
48
48
|
f?: number | bigint;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Last trade ID in the aggregation.
|
|
51
51
|
* @type {number | bigint}
|
|
52
52
|
* @memberof AggregatedTradesResponseDataInner
|
|
53
53
|
*/
|
|
54
54
|
l?: number | bigint;
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* Trade timestamp in milliseconds.
|
|
57
57
|
* @type {number | bigint}
|
|
58
58
|
* @memberof AggregatedTradesResponseDataInner
|
|
59
59
|
*/
|
|
60
60
|
T?: number | bigint;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Whether buyer is the market maker (deprecated).
|
|
63
63
|
* @type {boolean}
|
|
64
64
|
* @memberof AggregatedTradesResponseDataInner
|
|
65
65
|
*/
|
|
@@ -74,36 +74,132 @@ interface AggregatedTradesResponseDataInner {
|
|
|
74
74
|
*/
|
|
75
75
|
interface AggregatedTradesResponse {
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* API response code. \"000000\" indicates success.
|
|
78
78
|
* @type {string}
|
|
79
79
|
* @memberof AggregatedTradesResponse
|
|
80
80
|
*/
|
|
81
81
|
code?: string;
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* Response message.
|
|
84
84
|
* @type {string}
|
|
85
85
|
* @memberof AggregatedTradesResponse
|
|
86
86
|
*/
|
|
87
87
|
message?: string;
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Detailed response message.
|
|
90
90
|
* @type {string}
|
|
91
91
|
* @memberof AggregatedTradesResponse
|
|
92
92
|
*/
|
|
93
93
|
messageDetail?: string;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* Array of aggregated trades.
|
|
96
96
|
* @type {Array<AggregatedTradesResponseDataInner>}
|
|
97
97
|
* @memberof AggregatedTradesResponse
|
|
98
98
|
*/
|
|
99
99
|
data?: Array<AggregatedTradesResponseDataInner>;
|
|
100
100
|
}
|
|
101
101
|
//#endregion
|
|
102
|
+
//#region src/rest-api/types/full-depth-response-data.d.ts
|
|
103
|
+
/**
|
|
104
|
+
* Alpha Trading REST API
|
|
105
|
+
*
|
|
106
|
+
* APIs for Binance Alpha Trading.
|
|
107
|
+
*
|
|
108
|
+
* The version of the OpenAPI document: 1.0.0
|
|
109
|
+
*
|
|
110
|
+
*
|
|
111
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
112
|
+
* https://openapi-generator.tech
|
|
113
|
+
* Do not edit the class manually.
|
|
114
|
+
*/
|
|
115
|
+
/**
|
|
116
|
+
* Order book data.
|
|
117
|
+
* @export
|
|
118
|
+
* @interface FullDepthResponseData
|
|
119
|
+
*/
|
|
120
|
+
interface FullDepthResponseData {
|
|
121
|
+
/**
|
|
122
|
+
* Last order book update ID.
|
|
123
|
+
* @type {number | bigint}
|
|
124
|
+
* @memberof FullDepthResponseData
|
|
125
|
+
*/
|
|
126
|
+
lastUpdateId?: number | bigint;
|
|
127
|
+
/**
|
|
128
|
+
* Trading pair symbol.
|
|
129
|
+
* @type {string}
|
|
130
|
+
* @memberof FullDepthResponseData
|
|
131
|
+
*/
|
|
132
|
+
symbol?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Bid orders. Each entry is [price, quantity].
|
|
135
|
+
* @type {Array<Array<string>>}
|
|
136
|
+
* @memberof FullDepthResponseData
|
|
137
|
+
*/
|
|
138
|
+
bids?: Array<Array<string>>;
|
|
139
|
+
/**
|
|
140
|
+
* Ask orders. Each entry is [price, quantity].
|
|
141
|
+
* @type {Array<Array<string>>}
|
|
142
|
+
* @memberof FullDepthResponseData
|
|
143
|
+
*/
|
|
144
|
+
asks?: Array<Array<string>>;
|
|
145
|
+
/**
|
|
146
|
+
* Event time in milliseconds.
|
|
147
|
+
* @type {number | bigint}
|
|
148
|
+
* @memberof FullDepthResponseData
|
|
149
|
+
*/
|
|
150
|
+
E?: number | bigint;
|
|
151
|
+
/**
|
|
152
|
+
* Transaction time in milliseconds.
|
|
153
|
+
* @type {number | bigint}
|
|
154
|
+
* @memberof FullDepthResponseData
|
|
155
|
+
*/
|
|
156
|
+
T?: number | bigint;
|
|
157
|
+
}
|
|
158
|
+
//#endregion
|
|
159
|
+
//#region src/rest-api/types/full-depth-response.d.ts
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @export
|
|
163
|
+
* @interface FullDepthResponse
|
|
164
|
+
*/
|
|
165
|
+
interface FullDepthResponse {
|
|
166
|
+
/**
|
|
167
|
+
* API response code. \"000000\" indicates success.
|
|
168
|
+
* @type {string}
|
|
169
|
+
* @memberof FullDepthResponse
|
|
170
|
+
*/
|
|
171
|
+
code?: string;
|
|
172
|
+
/**
|
|
173
|
+
* Response message.
|
|
174
|
+
* @type {string}
|
|
175
|
+
* @memberof FullDepthResponse
|
|
176
|
+
*/
|
|
177
|
+
message?: string;
|
|
178
|
+
/**
|
|
179
|
+
* Detailed response message.
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof FullDepthResponse
|
|
182
|
+
*/
|
|
183
|
+
messageDetail?: string;
|
|
184
|
+
/**
|
|
185
|
+
* Whether request is successful.
|
|
186
|
+
* @type {boolean}
|
|
187
|
+
* @memberof FullDepthResponse
|
|
188
|
+
*/
|
|
189
|
+
success?: boolean;
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @type {FullDepthResponseData}
|
|
193
|
+
* @memberof FullDepthResponse
|
|
194
|
+
*/
|
|
195
|
+
data?: FullDepthResponseData;
|
|
196
|
+
}
|
|
197
|
+
//#endregion
|
|
102
198
|
//#region src/rest-api/types/get-exchange-info-response-data-assets-inner.d.ts
|
|
103
199
|
/**
|
|
104
|
-
*
|
|
200
|
+
* Alpha Trading REST API
|
|
105
201
|
*
|
|
106
|
-
*
|
|
202
|
+
* APIs for Binance Alpha Trading.
|
|
107
203
|
*
|
|
108
204
|
* The version of the OpenAPI document: 1.0.0
|
|
109
205
|
*
|
|
@@ -119,7 +215,7 @@ interface AggregatedTradesResponse {
|
|
|
119
215
|
*/
|
|
120
216
|
interface GetExchangeInfoResponseDataAssetsInner {
|
|
121
217
|
/**
|
|
122
|
-
*
|
|
218
|
+
* Asset symbol.
|
|
123
219
|
* @type {string}
|
|
124
220
|
* @memberof GetExchangeInfoResponseDataAssetsInner
|
|
125
221
|
*/
|
|
@@ -128,9 +224,9 @@ interface GetExchangeInfoResponseDataAssetsInner {
|
|
|
128
224
|
//#endregion
|
|
129
225
|
//#region src/rest-api/types/get-exchange-info-response-data-symbols-inner-filters-inner.d.ts
|
|
130
226
|
/**
|
|
131
|
-
*
|
|
227
|
+
* Alpha Trading REST API
|
|
132
228
|
*
|
|
133
|
-
*
|
|
229
|
+
* APIs for Binance Alpha Trading.
|
|
134
230
|
*
|
|
135
231
|
* The version of the OpenAPI document: 1.0.0
|
|
136
232
|
*
|
|
@@ -146,97 +242,97 @@ interface GetExchangeInfoResponseDataAssetsInner {
|
|
|
146
242
|
*/
|
|
147
243
|
interface GetExchangeInfoResponseDataSymbolsInnerFiltersInner {
|
|
148
244
|
/**
|
|
149
|
-
*
|
|
245
|
+
* Filter type.
|
|
150
246
|
* @type {string}
|
|
151
247
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
152
248
|
*/
|
|
153
249
|
filterType?: string;
|
|
154
250
|
/**
|
|
155
|
-
*
|
|
251
|
+
* Minimum price.
|
|
156
252
|
* @type {string}
|
|
157
253
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
158
254
|
*/
|
|
159
255
|
minPrice?: string;
|
|
160
256
|
/**
|
|
161
|
-
*
|
|
257
|
+
* Maximum price.
|
|
162
258
|
* @type {string}
|
|
163
259
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
164
260
|
*/
|
|
165
261
|
maxPrice?: string;
|
|
166
262
|
/**
|
|
167
|
-
*
|
|
263
|
+
* Tick size.
|
|
168
264
|
* @type {string}
|
|
169
265
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
170
266
|
*/
|
|
171
267
|
tickSize?: string;
|
|
172
268
|
/**
|
|
173
|
-
*
|
|
269
|
+
* Step size.
|
|
174
270
|
* @type {string}
|
|
175
271
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
176
272
|
*/
|
|
177
273
|
stepSize?: string;
|
|
178
274
|
/**
|
|
179
|
-
*
|
|
275
|
+
* Maximum quantity.
|
|
180
276
|
* @type {string}
|
|
181
277
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
182
278
|
*/
|
|
183
279
|
maxQty?: string;
|
|
184
280
|
/**
|
|
185
|
-
*
|
|
281
|
+
* Minimum quantity.
|
|
186
282
|
* @type {string}
|
|
187
283
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
188
284
|
*/
|
|
189
285
|
minQty?: string;
|
|
190
286
|
/**
|
|
191
|
-
*
|
|
287
|
+
* Maximum allowed orders for this rule.
|
|
192
288
|
* @type {number | bigint}
|
|
193
289
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
194
290
|
*/
|
|
195
291
|
limit?: number | bigint;
|
|
196
292
|
/**
|
|
197
|
-
*
|
|
293
|
+
* Minimum notional value.
|
|
198
294
|
* @type {string}
|
|
199
295
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
200
296
|
*/
|
|
201
297
|
minNotional?: string;
|
|
202
298
|
/**
|
|
203
|
-
*
|
|
299
|
+
* Maximum notional value.
|
|
204
300
|
* @type {string}
|
|
205
301
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
206
302
|
*/
|
|
207
303
|
maxNotional?: string;
|
|
208
304
|
/**
|
|
209
|
-
*
|
|
305
|
+
* Lower multiplier bound.
|
|
210
306
|
* @type {string}
|
|
211
307
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
212
308
|
*/
|
|
213
309
|
multiplierDown?: string;
|
|
214
310
|
/**
|
|
215
|
-
*
|
|
311
|
+
* Upper multiplier bound.
|
|
216
312
|
* @type {string}
|
|
217
313
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
218
314
|
*/
|
|
219
315
|
multiplierUp?: string;
|
|
220
316
|
/**
|
|
221
|
-
*
|
|
317
|
+
* Upper multiplier bound for bids.
|
|
222
318
|
* @type {string}
|
|
223
319
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
224
320
|
*/
|
|
225
321
|
bidMultiplierUp?: string;
|
|
226
322
|
/**
|
|
227
|
-
*
|
|
323
|
+
* Upper multiplier bound for asks.
|
|
228
324
|
* @type {string}
|
|
229
325
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
230
326
|
*/
|
|
231
327
|
askMultiplierUp?: string;
|
|
232
328
|
/**
|
|
233
|
-
*
|
|
329
|
+
* Lower multiplier bound for bids.
|
|
234
330
|
* @type {string}
|
|
235
331
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
236
332
|
*/
|
|
237
333
|
bidMultiplierDown?: string;
|
|
238
334
|
/**
|
|
239
|
-
*
|
|
335
|
+
* Lower multiplier bound for asks.
|
|
240
336
|
* @type {string}
|
|
241
337
|
* @memberof GetExchangeInfoResponseDataSymbolsInnerFiltersInner
|
|
242
338
|
*/
|
|
@@ -251,61 +347,61 @@ interface GetExchangeInfoResponseDataSymbolsInnerFiltersInner {
|
|
|
251
347
|
*/
|
|
252
348
|
interface GetExchangeInfoResponseDataSymbolsInner {
|
|
253
349
|
/**
|
|
254
|
-
*
|
|
350
|
+
* Trading symbol.
|
|
255
351
|
* @type {string}
|
|
256
352
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
257
353
|
*/
|
|
258
354
|
symbol?: string;
|
|
259
355
|
/**
|
|
260
|
-
*
|
|
356
|
+
* Trading status.
|
|
261
357
|
* @type {string}
|
|
262
358
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
263
359
|
*/
|
|
264
360
|
status?: string;
|
|
265
361
|
/**
|
|
266
|
-
*
|
|
362
|
+
* Base asset symbol.
|
|
267
363
|
* @type {string}
|
|
268
364
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
269
365
|
*/
|
|
270
366
|
baseAsset?: string;
|
|
271
367
|
/**
|
|
272
|
-
*
|
|
368
|
+
* Quote asset symbol.
|
|
273
369
|
* @type {string}
|
|
274
370
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
275
371
|
*/
|
|
276
372
|
quoteAsset?: string;
|
|
277
373
|
/**
|
|
278
|
-
*
|
|
374
|
+
* Allowed precision for price.
|
|
279
375
|
* @type {number | bigint}
|
|
280
376
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
281
377
|
*/
|
|
282
378
|
pricePrecision?: number | bigint;
|
|
283
379
|
/**
|
|
284
|
-
*
|
|
380
|
+
* Allowed precision for quantity.
|
|
285
381
|
* @type {number | bigint}
|
|
286
382
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
287
383
|
*/
|
|
288
384
|
quantityPrecision?: number | bigint;
|
|
289
385
|
/**
|
|
290
|
-
*
|
|
386
|
+
* Base asset precision.
|
|
291
387
|
* @type {number | bigint}
|
|
292
388
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
293
389
|
*/
|
|
294
390
|
baseAssetPrecision?: number | bigint;
|
|
295
391
|
/**
|
|
296
|
-
*
|
|
392
|
+
* Quote asset precision.
|
|
297
393
|
* @type {number | bigint}
|
|
298
394
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
299
395
|
*/
|
|
300
396
|
quotePrecision?: number | bigint;
|
|
301
397
|
/**
|
|
302
|
-
*
|
|
398
|
+
* Trading filters and constraints.
|
|
303
399
|
* @type {Array<GetExchangeInfoResponseDataSymbolsInnerFiltersInner>}
|
|
304
400
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
305
401
|
*/
|
|
306
402
|
filters?: Array<GetExchangeInfoResponseDataSymbolsInnerFiltersInner>;
|
|
307
403
|
/**
|
|
308
|
-
*
|
|
404
|
+
* Supported order types for this symbol.
|
|
309
405
|
* @type {Array<string>}
|
|
310
406
|
* @memberof GetExchangeInfoResponseDataSymbolsInner
|
|
311
407
|
*/
|
|
@@ -314,31 +410,31 @@ interface GetExchangeInfoResponseDataSymbolsInner {
|
|
|
314
410
|
//#endregion
|
|
315
411
|
//#region src/rest-api/types/get-exchange-info-response-data.d.ts
|
|
316
412
|
/**
|
|
317
|
-
*
|
|
413
|
+
* Exchange metadata, including assets and symbols.
|
|
318
414
|
* @export
|
|
319
415
|
* @interface GetExchangeInfoResponseData
|
|
320
416
|
*/
|
|
321
417
|
interface GetExchangeInfoResponseData {
|
|
322
418
|
/**
|
|
323
|
-
*
|
|
419
|
+
* Timezone of market data.
|
|
324
420
|
* @type {string}
|
|
325
421
|
* @memberof GetExchangeInfoResponseData
|
|
326
422
|
*/
|
|
327
423
|
timezone?: string;
|
|
328
424
|
/**
|
|
329
|
-
*
|
|
425
|
+
* Supported assets.
|
|
330
426
|
* @type {Array<GetExchangeInfoResponseDataAssetsInner>}
|
|
331
427
|
* @memberof GetExchangeInfoResponseData
|
|
332
428
|
*/
|
|
333
429
|
assets?: Array<GetExchangeInfoResponseDataAssetsInner>;
|
|
334
430
|
/**
|
|
335
|
-
*
|
|
431
|
+
* Supported trading symbols.
|
|
336
432
|
* @type {Array<GetExchangeInfoResponseDataSymbolsInner>}
|
|
337
433
|
* @memberof GetExchangeInfoResponseData
|
|
338
434
|
*/
|
|
339
435
|
symbols?: Array<GetExchangeInfoResponseDataSymbolsInner>;
|
|
340
436
|
/**
|
|
341
|
-
*
|
|
437
|
+
* Order types metadata returned by backend.
|
|
342
438
|
* @type {string}
|
|
343
439
|
* @memberof GetExchangeInfoResponseData
|
|
344
440
|
*/
|
|
@@ -353,25 +449,25 @@ interface GetExchangeInfoResponseData {
|
|
|
353
449
|
*/
|
|
354
450
|
interface GetExchangeInfoResponse {
|
|
355
451
|
/**
|
|
356
|
-
*
|
|
452
|
+
* API response code. \"000000\" indicates success.
|
|
357
453
|
* @type {string}
|
|
358
454
|
* @memberof GetExchangeInfoResponse
|
|
359
455
|
*/
|
|
360
456
|
code?: string;
|
|
361
457
|
/**
|
|
362
|
-
*
|
|
458
|
+
* Response message.
|
|
363
459
|
* @type {string}
|
|
364
460
|
* @memberof GetExchangeInfoResponse
|
|
365
461
|
*/
|
|
366
462
|
message?: string;
|
|
367
463
|
/**
|
|
368
|
-
*
|
|
464
|
+
* Detailed response message.
|
|
369
465
|
* @type {string}
|
|
370
466
|
* @memberof GetExchangeInfoResponse
|
|
371
467
|
*/
|
|
372
468
|
messageDetail?: string;
|
|
373
469
|
/**
|
|
374
|
-
*
|
|
470
|
+
* Whether request is successful.
|
|
375
471
|
* @type {boolean}
|
|
376
472
|
* @memberof GetExchangeInfoResponse
|
|
377
473
|
*/
|
|
@@ -384,11 +480,11 @@ interface GetExchangeInfoResponse {
|
|
|
384
480
|
data?: GetExchangeInfoResponseData;
|
|
385
481
|
}
|
|
386
482
|
//#endregion
|
|
387
|
-
//#region src/rest-api/types/klines-response-data-
|
|
483
|
+
//#region src/rest-api/types/klines-response-data-inner-inner.d.ts
|
|
388
484
|
/**
|
|
389
|
-
*
|
|
485
|
+
* Alpha Trading REST API
|
|
390
486
|
*
|
|
391
|
-
*
|
|
487
|
+
* APIs for Binance Alpha Trading.
|
|
392
488
|
*
|
|
393
489
|
* The version of the OpenAPI document: 1.0.0
|
|
394
490
|
*
|
|
@@ -398,18 +494,9 @@ interface GetExchangeInfoResponse {
|
|
|
398
494
|
* Do not edit the class manually.
|
|
399
495
|
*/
|
|
400
496
|
/**
|
|
401
|
-
* @type
|
|
402
|
-
* @export
|
|
403
|
-
*/
|
|
404
|
-
type KlinesResponseDataItemInner = number | string;
|
|
405
|
-
//#endregion
|
|
406
|
-
//#region src/rest-api/types/klines-response-data-item.d.ts
|
|
407
|
-
/**
|
|
408
|
-
*
|
|
409
|
-
* @export
|
|
410
|
-
* @interface KlinesResponseDataItem
|
|
497
|
+
* @type KlinesResponseDataInnerInner
|
|
411
498
|
*/
|
|
412
|
-
|
|
499
|
+
type KlinesResponseDataInnerInner = number | string;
|
|
413
500
|
//#endregion
|
|
414
501
|
//#region src/rest-api/types/klines-response.d.ts
|
|
415
502
|
/**
|
|
@@ -419,42 +506,42 @@ interface KlinesResponseDataItem extends Array<KlinesResponseDataItemInner> {}
|
|
|
419
506
|
*/
|
|
420
507
|
interface KlinesResponse {
|
|
421
508
|
/**
|
|
422
|
-
*
|
|
509
|
+
* API response code. \"000000\" indicates success.
|
|
423
510
|
* @type {string}
|
|
424
511
|
* @memberof KlinesResponse
|
|
425
512
|
*/
|
|
426
513
|
code?: string;
|
|
427
514
|
/**
|
|
428
|
-
*
|
|
515
|
+
* Response message.
|
|
429
516
|
* @type {string}
|
|
430
517
|
* @memberof KlinesResponse
|
|
431
518
|
*/
|
|
432
519
|
message?: string;
|
|
433
520
|
/**
|
|
434
|
-
*
|
|
521
|
+
* Detailed response message.
|
|
435
522
|
* @type {string}
|
|
436
523
|
* @memberof KlinesResponse
|
|
437
524
|
*/
|
|
438
525
|
messageDetail?: string;
|
|
439
526
|
/**
|
|
440
|
-
*
|
|
527
|
+
* Whether request is successful.
|
|
441
528
|
* @type {boolean}
|
|
442
529
|
* @memberof KlinesResponse
|
|
443
530
|
*/
|
|
444
531
|
success?: boolean;
|
|
445
532
|
/**
|
|
446
|
-
*
|
|
447
|
-
* @type {Array<
|
|
533
|
+
* Array of kline rows. Each row contains: open time, open, high, low, close, volume, close time, quote volume, trade count, taker buy base volume, taker buy quote volume, and a static 0.
|
|
534
|
+
* @type {Array<Array<KlinesResponseDataInnerInner>>}
|
|
448
535
|
* @memberof KlinesResponse
|
|
449
536
|
*/
|
|
450
|
-
data?: Array<
|
|
537
|
+
data?: Array<Array<KlinesResponseDataInnerInner>>;
|
|
451
538
|
}
|
|
452
539
|
//#endregion
|
|
453
540
|
//#region src/rest-api/types/ticker-response-data.d.ts
|
|
454
541
|
/**
|
|
455
|
-
*
|
|
542
|
+
* Alpha Trading REST API
|
|
456
543
|
*
|
|
457
|
-
*
|
|
544
|
+
* APIs for Binance Alpha Trading.
|
|
458
545
|
*
|
|
459
546
|
* The version of the OpenAPI document: 1.0.0
|
|
460
547
|
*
|
|
@@ -464,103 +551,103 @@ interface KlinesResponse {
|
|
|
464
551
|
* Do not edit the class manually.
|
|
465
552
|
*/
|
|
466
553
|
/**
|
|
467
|
-
*
|
|
554
|
+
* 24-hour rolling window ticker statistics.
|
|
468
555
|
* @export
|
|
469
556
|
* @interface TickerResponseData
|
|
470
557
|
*/
|
|
471
558
|
interface TickerResponseData {
|
|
472
559
|
/**
|
|
473
|
-
*
|
|
560
|
+
* Trading pair symbol.
|
|
474
561
|
* @type {string}
|
|
475
562
|
* @memberof TickerResponseData
|
|
476
563
|
*/
|
|
477
564
|
symbol?: string;
|
|
478
565
|
/**
|
|
479
|
-
*
|
|
566
|
+
* Absolute price change in the 24h window.
|
|
480
567
|
* @type {string}
|
|
481
568
|
* @memberof TickerResponseData
|
|
482
569
|
*/
|
|
483
570
|
priceChange?: string;
|
|
484
571
|
/**
|
|
485
|
-
*
|
|
572
|
+
* Percentage price change in the 24h window.
|
|
486
573
|
* @type {string}
|
|
487
574
|
* @memberof TickerResponseData
|
|
488
575
|
*/
|
|
489
576
|
priceChangePercent?: string;
|
|
490
577
|
/**
|
|
491
|
-
*
|
|
578
|
+
* Weighted average price in the 24h window.
|
|
492
579
|
* @type {string}
|
|
493
580
|
* @memberof TickerResponseData
|
|
494
581
|
*/
|
|
495
582
|
weightedAvgPrice?: string;
|
|
496
583
|
/**
|
|
497
|
-
*
|
|
584
|
+
* Latest traded price.
|
|
498
585
|
* @type {string}
|
|
499
586
|
* @memberof TickerResponseData
|
|
500
587
|
*/
|
|
501
588
|
lastPrice?: string;
|
|
502
589
|
/**
|
|
503
|
-
*
|
|
590
|
+
* Quantity of the latest trade.
|
|
504
591
|
* @type {string}
|
|
505
592
|
* @memberof TickerResponseData
|
|
506
593
|
*/
|
|
507
594
|
lastQty?: string;
|
|
508
595
|
/**
|
|
509
|
-
*
|
|
596
|
+
* Opening price of the 24h window.
|
|
510
597
|
* @type {string}
|
|
511
598
|
* @memberof TickerResponseData
|
|
512
599
|
*/
|
|
513
600
|
openPrice?: string;
|
|
514
601
|
/**
|
|
515
|
-
*
|
|
602
|
+
* Highest price in the 24h window.
|
|
516
603
|
* @type {string}
|
|
517
604
|
* @memberof TickerResponseData
|
|
518
605
|
*/
|
|
519
606
|
highPrice?: string;
|
|
520
607
|
/**
|
|
521
|
-
*
|
|
608
|
+
* Lowest price in the 24h window.
|
|
522
609
|
* @type {string}
|
|
523
610
|
* @memberof TickerResponseData
|
|
524
611
|
*/
|
|
525
612
|
lowPrice?: string;
|
|
526
613
|
/**
|
|
527
|
-
*
|
|
614
|
+
* Base asset volume in the 24h window.
|
|
528
615
|
* @type {string}
|
|
529
616
|
* @memberof TickerResponseData
|
|
530
617
|
*/
|
|
531
618
|
volume?: string;
|
|
532
619
|
/**
|
|
533
|
-
*
|
|
620
|
+
* Quote asset volume in the 24h window.
|
|
534
621
|
* @type {string}
|
|
535
622
|
* @memberof TickerResponseData
|
|
536
623
|
*/
|
|
537
624
|
quoteVolume?: string;
|
|
538
625
|
/**
|
|
539
|
-
*
|
|
626
|
+
* Start time of the 24h window (milliseconds).
|
|
540
627
|
* @type {number | bigint}
|
|
541
628
|
* @memberof TickerResponseData
|
|
542
629
|
*/
|
|
543
630
|
openTime?: number | bigint;
|
|
544
631
|
/**
|
|
545
|
-
*
|
|
632
|
+
* End time of the 24h window (milliseconds).
|
|
546
633
|
* @type {number | bigint}
|
|
547
634
|
* @memberof TickerResponseData
|
|
548
635
|
*/
|
|
549
636
|
closeTime?: number | bigint;
|
|
550
637
|
/**
|
|
551
|
-
*
|
|
638
|
+
* First trade ID in the 24h window.
|
|
552
639
|
* @type {number | bigint}
|
|
553
640
|
* @memberof TickerResponseData
|
|
554
641
|
*/
|
|
555
642
|
firstId?: number | bigint;
|
|
556
643
|
/**
|
|
557
|
-
*
|
|
644
|
+
* Last trade ID in the 24h window.
|
|
558
645
|
* @type {number | bigint}
|
|
559
646
|
* @memberof TickerResponseData
|
|
560
647
|
*/
|
|
561
648
|
lastId?: number | bigint;
|
|
562
649
|
/**
|
|
563
|
-
*
|
|
650
|
+
* Total number of trades in the 24h window.
|
|
564
651
|
* @type {number | bigint}
|
|
565
652
|
* @memberof TickerResponseData
|
|
566
653
|
*/
|
|
@@ -575,19 +662,19 @@ interface TickerResponseData {
|
|
|
575
662
|
*/
|
|
576
663
|
interface TickerResponse {
|
|
577
664
|
/**
|
|
578
|
-
*
|
|
665
|
+
* API response code. \"000000\" indicates success.
|
|
579
666
|
* @type {string}
|
|
580
667
|
* @memberof TickerResponse
|
|
581
668
|
*/
|
|
582
669
|
code?: string;
|
|
583
670
|
/**
|
|
584
|
-
*
|
|
671
|
+
* Response message.
|
|
585
672
|
* @type {string}
|
|
586
673
|
* @memberof TickerResponse
|
|
587
674
|
*/
|
|
588
675
|
message?: string;
|
|
589
676
|
/**
|
|
590
|
-
*
|
|
677
|
+
* Detailed response message.
|
|
591
678
|
* @type {string}
|
|
592
679
|
* @memberof TickerResponse
|
|
593
680
|
*/
|
|
@@ -599,7 +686,7 @@ interface TickerResponse {
|
|
|
599
686
|
*/
|
|
600
687
|
data?: TickerResponseData;
|
|
601
688
|
/**
|
|
602
|
-
*
|
|
689
|
+
* Whether request is successful.
|
|
603
690
|
* @type {boolean}
|
|
604
691
|
* @memberof TickerResponse
|
|
605
692
|
*/
|
|
@@ -608,9 +695,9 @@ interface TickerResponse {
|
|
|
608
695
|
//#endregion
|
|
609
696
|
//#region src/rest-api/types/token-list-response-data-inner.d.ts
|
|
610
697
|
/**
|
|
611
|
-
*
|
|
698
|
+
* Alpha Trading REST API
|
|
612
699
|
*
|
|
613
|
-
*
|
|
700
|
+
* APIs for Binance Alpha Trading.
|
|
614
701
|
*
|
|
615
702
|
* The version of the OpenAPI document: 1.0.0
|
|
616
703
|
*
|
|
@@ -626,67 +713,67 @@ interface TickerResponse {
|
|
|
626
713
|
*/
|
|
627
714
|
interface TokenListResponseDataInner {
|
|
628
715
|
/**
|
|
629
|
-
*
|
|
716
|
+
* Unique token identifier.
|
|
630
717
|
* @type {string}
|
|
631
718
|
* @memberof TokenListResponseDataInner
|
|
632
719
|
*/
|
|
633
720
|
tokenId?: string;
|
|
634
721
|
/**
|
|
635
|
-
*
|
|
722
|
+
* Chain ID.
|
|
636
723
|
* @type {string}
|
|
637
724
|
* @memberof TokenListResponseDataInner
|
|
638
725
|
*/
|
|
639
726
|
chainId?: string;
|
|
640
727
|
/**
|
|
641
|
-
*
|
|
728
|
+
* Chain icon URL.
|
|
642
729
|
* @type {string}
|
|
643
730
|
* @memberof TokenListResponseDataInner
|
|
644
731
|
*/
|
|
645
732
|
chainIconUrl?: string;
|
|
646
733
|
/**
|
|
647
|
-
*
|
|
734
|
+
* Chain name.
|
|
648
735
|
* @type {string}
|
|
649
736
|
* @memberof TokenListResponseDataInner
|
|
650
737
|
*/
|
|
651
738
|
chainName?: string;
|
|
652
739
|
/**
|
|
653
|
-
*
|
|
740
|
+
* Token contract address.
|
|
654
741
|
* @type {string}
|
|
655
742
|
* @memberof TokenListResponseDataInner
|
|
656
743
|
*/
|
|
657
744
|
contractAddress?: string;
|
|
658
745
|
/**
|
|
659
|
-
*
|
|
746
|
+
* Token name.
|
|
660
747
|
* @type {string}
|
|
661
748
|
* @memberof TokenListResponseDataInner
|
|
662
749
|
*/
|
|
663
750
|
name?: string;
|
|
664
751
|
/**
|
|
665
|
-
*
|
|
752
|
+
* Token symbol.
|
|
666
753
|
* @type {string}
|
|
667
754
|
* @memberof TokenListResponseDataInner
|
|
668
755
|
*/
|
|
669
756
|
symbol?: string;
|
|
670
757
|
/**
|
|
671
|
-
*
|
|
758
|
+
* Token icon URL.
|
|
672
759
|
* @type {string}
|
|
673
760
|
* @memberof TokenListResponseDataInner
|
|
674
761
|
*/
|
|
675
762
|
iconUrl?: string;
|
|
676
763
|
/**
|
|
677
|
-
*
|
|
764
|
+
* Latest token price.
|
|
678
765
|
* @type {string}
|
|
679
766
|
* @memberof TokenListResponseDataInner
|
|
680
767
|
*/
|
|
681
768
|
price?: string;
|
|
682
769
|
/**
|
|
683
|
-
*
|
|
770
|
+
* 24-hour price change percentage.
|
|
684
771
|
* @type {string}
|
|
685
772
|
* @memberof TokenListResponseDataInner
|
|
686
773
|
*/
|
|
687
774
|
percentChange24h?: string;
|
|
688
775
|
/**
|
|
689
|
-
*
|
|
776
|
+
* 24-hour trading volume.
|
|
690
777
|
* @type {string}
|
|
691
778
|
* @memberof TokenListResponseDataInner
|
|
692
779
|
*/
|
|
@@ -776,7 +863,7 @@ interface TokenListResponseDataInner {
|
|
|
776
863
|
*/
|
|
777
864
|
tradeDecimal?: number | bigint;
|
|
778
865
|
/**
|
|
779
|
-
*
|
|
866
|
+
* ALPHA token ID, e.g. ALPHA_175.
|
|
780
867
|
* @type {string}
|
|
781
868
|
* @memberof TokenListResponseDataInner
|
|
782
869
|
*/
|
|
@@ -863,31 +950,31 @@ interface TokenListResponseDataInner {
|
|
|
863
950
|
*/
|
|
864
951
|
interface TokenListResponse {
|
|
865
952
|
/**
|
|
866
|
-
*
|
|
953
|
+
* API response code. \"000000\" indicates success.
|
|
867
954
|
* @type {string}
|
|
868
955
|
* @memberof TokenListResponse
|
|
869
956
|
*/
|
|
870
957
|
code?: string;
|
|
871
958
|
/**
|
|
872
|
-
*
|
|
959
|
+
* Response message.
|
|
873
960
|
* @type {string}
|
|
874
961
|
* @memberof TokenListResponse
|
|
875
962
|
*/
|
|
876
963
|
message?: string;
|
|
877
964
|
/**
|
|
878
|
-
*
|
|
965
|
+
* Detailed response message.
|
|
879
966
|
* @type {string}
|
|
880
967
|
* @memberof TokenListResponse
|
|
881
968
|
*/
|
|
882
969
|
messageDetail?: string;
|
|
883
970
|
/**
|
|
884
|
-
*
|
|
971
|
+
* Whether request is successful.
|
|
885
972
|
* @type {boolean}
|
|
886
973
|
* @memberof TokenListResponse
|
|
887
974
|
*/
|
|
888
975
|
success?: boolean;
|
|
889
976
|
/**
|
|
890
|
-
*
|
|
977
|
+
* List of ALPHA tokens and metadata.
|
|
891
978
|
* @type {Array<TokenListResponseDataInner>}
|
|
892
979
|
* @memberof TokenListResponse
|
|
893
980
|
*/
|
|
@@ -903,8 +990,6 @@ interface MarketDataApiInterface {
|
|
|
903
990
|
/**
|
|
904
991
|
* Retrieves compressed, aggregated historical trades for a specific symbol. Useful for recent trade history.
|
|
905
992
|
*
|
|
906
|
-
* Weight: 0
|
|
907
|
-
*
|
|
908
993
|
* @summary Aggregated Trades
|
|
909
994
|
* @param {AggregatedTradesRequest} requestParameters Request parameters.
|
|
910
995
|
*
|
|
@@ -913,9 +998,17 @@ interface MarketDataApiInterface {
|
|
|
913
998
|
*/
|
|
914
999
|
aggregatedTrades(requestParameters: AggregatedTradesRequest): Promise<RestApiResponse<AggregatedTradesResponse>>;
|
|
915
1000
|
/**
|
|
916
|
-
* Fetches
|
|
1001
|
+
* Fetches the full order book depth (UI & API orders) for a symbol, including bid and ask orders with their prices and quantities.
|
|
917
1002
|
*
|
|
918
|
-
*
|
|
1003
|
+
* @summary Full Depth
|
|
1004
|
+
* @param {FullDepthRequest} requestParameters Request parameters.
|
|
1005
|
+
*
|
|
1006
|
+
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1007
|
+
* @memberof MarketDataApiInterface
|
|
1008
|
+
*/
|
|
1009
|
+
fullDepth(requestParameters: FullDepthRequest): Promise<RestApiResponse<FullDepthResponse>>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Fetches general exchange information, such as supported symbols, rate limits, and server time.
|
|
919
1012
|
*
|
|
920
1013
|
* @summary Get Exchange Info
|
|
921
1014
|
*
|
|
@@ -926,9 +1019,7 @@ interface MarketDataApiInterface {
|
|
|
926
1019
|
/**
|
|
927
1020
|
* Fetches Kline/candlestick bars for a symbol, which include open/high/low/close prices and volume over intervals. Useful for charting and analysis.
|
|
928
1021
|
*
|
|
929
|
-
*
|
|
930
|
-
*
|
|
931
|
-
* @summary Klines (Candlestick Data)
|
|
1022
|
+
* @summary Klines
|
|
932
1023
|
* @param {KlinesRequest} requestParameters Request parameters.
|
|
933
1024
|
*
|
|
934
1025
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
@@ -938,9 +1029,7 @@ interface MarketDataApiInterface {
|
|
|
938
1029
|
/**
|
|
939
1030
|
* Gets the 24-hour rolling window price change statistics for a symbol, including volume and price changes.
|
|
940
1031
|
*
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
* @summary Ticker (24hr Price Statistics)
|
|
1032
|
+
* @summary Ticker
|
|
944
1033
|
* @param {TickerRequest} requestParameters Request parameters.
|
|
945
1034
|
*
|
|
946
1035
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
@@ -950,8 +1039,6 @@ interface MarketDataApiInterface {
|
|
|
950
1039
|
/**
|
|
951
1040
|
* Retrieves a list of all available ALPHA tokens, including their IDs and symbols. Use this to find the token ID for constructing symbols in other endpoints.
|
|
952
1041
|
*
|
|
953
|
-
* Weight: 0
|
|
954
|
-
*
|
|
955
1042
|
* @summary Token List
|
|
956
1043
|
*
|
|
957
1044
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
@@ -965,67 +1052,85 @@ interface MarketDataApiInterface {
|
|
|
965
1052
|
*/
|
|
966
1053
|
interface AggregatedTradesRequest {
|
|
967
1054
|
/**
|
|
968
|
-
* e.g
|
|
1055
|
+
* Trading pair symbol, e.g. ALPHA_118USDC (use token ID from Token List).
|
|
969
1056
|
* @type {string}
|
|
970
1057
|
* @memberof MarketDataApiAggregatedTrades
|
|
971
1058
|
*/
|
|
972
1059
|
readonly symbol: string;
|
|
973
1060
|
/**
|
|
974
|
-
*
|
|
1061
|
+
* Starting aggregate trade ID to fetch from.
|
|
975
1062
|
* @type {number | bigint}
|
|
976
1063
|
* @memberof MarketDataApiAggregatedTrades
|
|
977
1064
|
*/
|
|
978
1065
|
readonly fromId?: number | bigint;
|
|
979
1066
|
/**
|
|
980
|
-
*
|
|
1067
|
+
* Start timestamp in milliseconds.
|
|
981
1068
|
* @type {number | bigint}
|
|
982
1069
|
* @memberof MarketDataApiAggregatedTrades
|
|
983
1070
|
*/
|
|
984
1071
|
readonly startTime?: number | bigint;
|
|
985
1072
|
/**
|
|
986
|
-
*
|
|
1073
|
+
* End timestamp in milliseconds.
|
|
987
1074
|
* @type {number | bigint}
|
|
988
1075
|
* @memberof MarketDataApiAggregatedTrades
|
|
989
1076
|
*/
|
|
990
1077
|
readonly endTime?: number | bigint;
|
|
991
1078
|
/**
|
|
992
|
-
*
|
|
1079
|
+
* Number of results to return.
|
|
993
1080
|
* @type {number | bigint}
|
|
994
1081
|
* @memberof MarketDataApiAggregatedTrades
|
|
995
1082
|
*/
|
|
996
1083
|
readonly limit?: number | bigint;
|
|
997
1084
|
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Request parameters for fullDepth operation in MarketDataApi.
|
|
1087
|
+
* @interface FullDepthRequest
|
|
1088
|
+
*/
|
|
1089
|
+
interface FullDepthRequest {
|
|
1090
|
+
/**
|
|
1091
|
+
* Trading pair symbol, e.g. ALPHA_175USDT (use token ID from Token List).
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof MarketDataApiFullDepth
|
|
1094
|
+
*/
|
|
1095
|
+
readonly symbol: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Number of price levels to return. Valid values: 5, 10, 20, 50, 100, 500, 1000.
|
|
1098
|
+
* @type {5 | 10 | 20 | 50 | 100 | 500 | 1000 | bigint}
|
|
1099
|
+
* @memberof MarketDataApiFullDepth
|
|
1100
|
+
*/
|
|
1101
|
+
readonly limit?: FullDepthLimitEnum;
|
|
1102
|
+
}
|
|
998
1103
|
/**
|
|
999
1104
|
* Request parameters for klines operation in MarketDataApi.
|
|
1000
1105
|
* @interface KlinesRequest
|
|
1001
1106
|
*/
|
|
1002
1107
|
interface KlinesRequest {
|
|
1003
1108
|
/**
|
|
1004
|
-
* e.g
|
|
1109
|
+
* Trading pair symbol, e.g. ALPHA_175USDT (use token ID from Token List).
|
|
1005
1110
|
* @type {string}
|
|
1006
1111
|
* @memberof MarketDataApiKlines
|
|
1007
1112
|
*/
|
|
1008
1113
|
readonly symbol: string;
|
|
1009
1114
|
/**
|
|
1010
|
-
*
|
|
1011
|
-
* @type {
|
|
1115
|
+
* Kline interval.
|
|
1116
|
+
* @type {'1s' | '15s' | '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'}
|
|
1012
1117
|
* @memberof MarketDataApiKlines
|
|
1013
1118
|
*/
|
|
1014
|
-
readonly interval:
|
|
1119
|
+
readonly interval: KlinesIntervalEnum;
|
|
1015
1120
|
/**
|
|
1016
|
-
*
|
|
1121
|
+
* Number of klines to return.
|
|
1017
1122
|
* @type {number | bigint}
|
|
1018
1123
|
* @memberof MarketDataApiKlines
|
|
1019
1124
|
*/
|
|
1020
1125
|
readonly limit?: number | bigint;
|
|
1021
1126
|
/**
|
|
1022
|
-
*
|
|
1127
|
+
* Start timestamp in milliseconds.
|
|
1023
1128
|
* @type {number | bigint}
|
|
1024
1129
|
* @memberof MarketDataApiKlines
|
|
1025
1130
|
*/
|
|
1026
1131
|
readonly startTime?: number | bigint;
|
|
1027
1132
|
/**
|
|
1028
|
-
*
|
|
1133
|
+
* End timestamp in milliseconds.
|
|
1029
1134
|
* @type {number | bigint}
|
|
1030
1135
|
* @memberof MarketDataApiKlines
|
|
1031
1136
|
*/
|
|
@@ -1037,7 +1142,7 @@ interface KlinesRequest {
|
|
|
1037
1142
|
*/
|
|
1038
1143
|
interface TickerRequest {
|
|
1039
1144
|
/**
|
|
1040
|
-
* e.g
|
|
1145
|
+
* Trading pair symbol, e.g. ALPHA_175USDT (use token ID from Token List).
|
|
1041
1146
|
* @type {string}
|
|
1042
1147
|
* @memberof MarketDataApiTicker
|
|
1043
1148
|
*/
|
|
@@ -1054,67 +1159,96 @@ declare class MarketDataApi implements MarketDataApiInterface {
|
|
|
1054
1159
|
/**
|
|
1055
1160
|
* Retrieves compressed, aggregated historical trades for a specific symbol. Useful for recent trade history.
|
|
1056
1161
|
*
|
|
1057
|
-
* Weight: 0
|
|
1058
|
-
*
|
|
1059
1162
|
* @summary Aggregated Trades
|
|
1060
1163
|
* @param {AggregatedTradesRequest} requestParameters Request parameters.
|
|
1061
1164
|
* @returns {Promise<RestApiResponse<AggregatedTradesResponse>>}
|
|
1062
1165
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1063
1166
|
* @memberof MarketDataApi
|
|
1064
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1167
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#aggregated-trades Binance API Documentation}
|
|
1065
1168
|
*/
|
|
1066
1169
|
aggregatedTrades(requestParameters: AggregatedTradesRequest): Promise<RestApiResponse<AggregatedTradesResponse>>;
|
|
1067
1170
|
/**
|
|
1068
|
-
* Fetches
|
|
1171
|
+
* Fetches the full order book depth (UI & API orders) for a symbol, including bid and ask orders with their prices and quantities.
|
|
1069
1172
|
*
|
|
1070
|
-
*
|
|
1173
|
+
* @summary Full Depth
|
|
1174
|
+
* @param {FullDepthRequest} requestParameters Request parameters.
|
|
1175
|
+
* @returns {Promise<RestApiResponse<FullDepthResponse>>}
|
|
1176
|
+
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1177
|
+
* @memberof MarketDataApi
|
|
1178
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#full-depth Binance API Documentation}
|
|
1179
|
+
*/
|
|
1180
|
+
fullDepth(requestParameters: FullDepthRequest): Promise<RestApiResponse<FullDepthResponse>>;
|
|
1181
|
+
/**
|
|
1182
|
+
* Fetches general exchange information, such as supported symbols, rate limits, and server time.
|
|
1071
1183
|
*
|
|
1072
1184
|
* @summary Get Exchange Info
|
|
1073
1185
|
* @returns {Promise<RestApiResponse<GetExchangeInfoResponse>>}
|
|
1074
1186
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1075
1187
|
* @memberof MarketDataApi
|
|
1076
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1188
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#get-exchange-info Binance API Documentation}
|
|
1077
1189
|
*/
|
|
1078
1190
|
getExchangeInfo(): Promise<RestApiResponse<GetExchangeInfoResponse>>;
|
|
1079
1191
|
/**
|
|
1080
1192
|
* Fetches Kline/candlestick bars for a symbol, which include open/high/low/close prices and volume over intervals. Useful for charting and analysis.
|
|
1081
1193
|
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
1084
|
-
* @summary Klines (Candlestick Data)
|
|
1194
|
+
* @summary Klines
|
|
1085
1195
|
* @param {KlinesRequest} requestParameters Request parameters.
|
|
1086
1196
|
* @returns {Promise<RestApiResponse<KlinesResponse>>}
|
|
1087
1197
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1088
1198
|
* @memberof MarketDataApi
|
|
1089
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1199
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#klines Binance API Documentation}
|
|
1090
1200
|
*/
|
|
1091
1201
|
klines(requestParameters: KlinesRequest): Promise<RestApiResponse<KlinesResponse>>;
|
|
1092
1202
|
/**
|
|
1093
1203
|
* Gets the 24-hour rolling window price change statistics for a symbol, including volume and price changes.
|
|
1094
1204
|
*
|
|
1095
|
-
*
|
|
1096
|
-
*
|
|
1097
|
-
* @summary Ticker (24hr Price Statistics)
|
|
1205
|
+
* @summary Ticker
|
|
1098
1206
|
* @param {TickerRequest} requestParameters Request parameters.
|
|
1099
1207
|
* @returns {Promise<RestApiResponse<TickerResponse>>}
|
|
1100
1208
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1101
1209
|
* @memberof MarketDataApi
|
|
1102
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1210
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#ticker Binance API Documentation}
|
|
1103
1211
|
*/
|
|
1104
1212
|
ticker(requestParameters: TickerRequest): Promise<RestApiResponse<TickerResponse>>;
|
|
1105
1213
|
/**
|
|
1106
1214
|
* Retrieves a list of all available ALPHA tokens, including their IDs and symbols. Use this to find the token ID for constructing symbols in other endpoints.
|
|
1107
1215
|
*
|
|
1108
|
-
* Weight: 0
|
|
1109
|
-
*
|
|
1110
1216
|
* @summary Token List
|
|
1111
1217
|
* @returns {Promise<RestApiResponse<TokenListResponse>>}
|
|
1112
1218
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1113
1219
|
* @memberof MarketDataApi
|
|
1114
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1220
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#token-list Binance API Documentation}
|
|
1115
1221
|
*/
|
|
1116
1222
|
tokenList(): Promise<RestApiResponse<TokenListResponse>>;
|
|
1117
1223
|
}
|
|
1224
|
+
declare enum FullDepthLimitEnum {
|
|
1225
|
+
LIMIT_5 = 5,
|
|
1226
|
+
LIMIT_10 = 10,
|
|
1227
|
+
LIMIT_20 = 20,
|
|
1228
|
+
LIMIT_50 = 50,
|
|
1229
|
+
LIMIT_100 = 100,
|
|
1230
|
+
LIMIT_500 = 500,
|
|
1231
|
+
LIMIT_1000 = 1000,
|
|
1232
|
+
}
|
|
1233
|
+
declare enum KlinesIntervalEnum {
|
|
1234
|
+
INTERVAL_1s = "1s",
|
|
1235
|
+
INTERVAL_15s = "15s",
|
|
1236
|
+
INTERVAL_1m = "1m",
|
|
1237
|
+
INTERVAL_3m = "3m",
|
|
1238
|
+
INTERVAL_5m = "5m",
|
|
1239
|
+
INTERVAL_15m = "15m",
|
|
1240
|
+
INTERVAL_30m = "30m",
|
|
1241
|
+
INTERVAL_1h = "1h",
|
|
1242
|
+
INTERVAL_2h = "2h",
|
|
1243
|
+
INTERVAL_4h = "4h",
|
|
1244
|
+
INTERVAL_6h = "6h",
|
|
1245
|
+
INTERVAL_8h = "8h",
|
|
1246
|
+
INTERVAL_12h = "12h",
|
|
1247
|
+
INTERVAL_1d = "1d",
|
|
1248
|
+
INTERVAL_3d = "3d",
|
|
1249
|
+
INTERVAL_1w = "1w",
|
|
1250
|
+
INTERVAL_1M = "1M",
|
|
1251
|
+
}
|
|
1118
1252
|
//#endregion
|
|
1119
1253
|
//#region src/rest-api/rest-api.d.ts
|
|
1120
1254
|
declare class RestAPI {
|
|
@@ -1144,79 +1278,2123 @@ declare class RestAPI {
|
|
|
1144
1278
|
/**
|
|
1145
1279
|
* Retrieves compressed, aggregated historical trades for a specific symbol. Useful for recent trade history.
|
|
1146
1280
|
*
|
|
1147
|
-
* Weight: 0
|
|
1148
|
-
*
|
|
1149
1281
|
* @summary Aggregated Trades
|
|
1150
1282
|
* @param {AggregatedTradesRequest} requestParameters Request parameters.
|
|
1151
1283
|
*
|
|
1152
1284
|
* @returns {Promise<RestApiResponse<AggregatedTradesResponse>>}
|
|
1153
1285
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1154
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1286
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#aggregated-trades Binance API Documentation}
|
|
1155
1287
|
*/
|
|
1156
1288
|
aggregatedTrades(requestParameters: AggregatedTradesRequest): Promise<RestApiResponse<AggregatedTradesResponse>>;
|
|
1157
1289
|
/**
|
|
1158
|
-
* Fetches
|
|
1290
|
+
* Fetches the full order book depth (UI & API orders) for a symbol, including bid and ask orders with their prices and quantities.
|
|
1291
|
+
*
|
|
1292
|
+
* @summary Full Depth
|
|
1293
|
+
* @param {FullDepthRequest} requestParameters Request parameters.
|
|
1159
1294
|
*
|
|
1160
|
-
*
|
|
1295
|
+
* @returns {Promise<RestApiResponse<FullDepthResponse>>}
|
|
1296
|
+
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1297
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#full-depth Binance API Documentation}
|
|
1298
|
+
*/
|
|
1299
|
+
fullDepth(requestParameters: FullDepthRequest): Promise<RestApiResponse<FullDepthResponse>>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Fetches general exchange information, such as supported symbols, rate limits, and server time.
|
|
1161
1302
|
*
|
|
1162
1303
|
* @summary Get Exchange Info
|
|
1163
1304
|
*
|
|
1164
1305
|
* @returns {Promise<RestApiResponse<GetExchangeInfoResponse>>}
|
|
1165
1306
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1166
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1307
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#get-exchange-info Binance API Documentation}
|
|
1167
1308
|
*/
|
|
1168
1309
|
getExchangeInfo(): Promise<RestApiResponse<GetExchangeInfoResponse>>;
|
|
1169
1310
|
/**
|
|
1170
1311
|
* Fetches Kline/candlestick bars for a symbol, which include open/high/low/close prices and volume over intervals. Useful for charting and analysis.
|
|
1171
1312
|
*
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
* @summary Klines (Candlestick Data)
|
|
1313
|
+
* @summary Klines
|
|
1175
1314
|
* @param {KlinesRequest} requestParameters Request parameters.
|
|
1176
1315
|
*
|
|
1177
1316
|
* @returns {Promise<RestApiResponse<KlinesResponse>>}
|
|
1178
1317
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1179
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1318
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#klines Binance API Documentation}
|
|
1180
1319
|
*/
|
|
1181
1320
|
klines(requestParameters: KlinesRequest): Promise<RestApiResponse<KlinesResponse>>;
|
|
1182
1321
|
/**
|
|
1183
1322
|
* Gets the 24-hour rolling window price change statistics for a symbol, including volume and price changes.
|
|
1184
1323
|
*
|
|
1185
|
-
*
|
|
1186
|
-
*
|
|
1187
|
-
* @summary Ticker (24hr Price Statistics)
|
|
1324
|
+
* @summary Ticker
|
|
1188
1325
|
* @param {TickerRequest} requestParameters Request parameters.
|
|
1189
1326
|
*
|
|
1190
1327
|
* @returns {Promise<RestApiResponse<TickerResponse>>}
|
|
1191
1328
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1192
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1329
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#ticker Binance API Documentation}
|
|
1193
1330
|
*/
|
|
1194
1331
|
ticker(requestParameters: TickerRequest): Promise<RestApiResponse<TickerResponse>>;
|
|
1195
1332
|
/**
|
|
1196
1333
|
* Retrieves a list of all available ALPHA tokens, including their IDs and symbols. Use this to find the token ID for constructing symbols in other endpoints.
|
|
1197
1334
|
*
|
|
1198
|
-
* Weight: 0
|
|
1199
|
-
*
|
|
1200
1335
|
* @summary Token List
|
|
1201
1336
|
*
|
|
1202
1337
|
* @returns {Promise<RestApiResponse<TokenListResponse>>}
|
|
1203
1338
|
* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
|
|
1204
|
-
* @see {@link https://developers.binance.com/docs/
|
|
1339
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/rest-api/market-data#token-list Binance API Documentation}
|
|
1205
1340
|
*/
|
|
1206
1341
|
tokenList(): Promise<RestApiResponse<TokenListResponse>>;
|
|
1207
1342
|
}
|
|
1208
1343
|
declare namespace index_d_exports {
|
|
1209
|
-
export { AggregatedTradesRequest, AggregatedTradesResponse, AggregatedTradesResponseDataInner, GetExchangeInfoResponse, GetExchangeInfoResponseData, GetExchangeInfoResponseDataAssetsInner, GetExchangeInfoResponseDataSymbolsInner, GetExchangeInfoResponseDataSymbolsInnerFiltersInner, KlinesRequest, KlinesResponse,
|
|
1344
|
+
export { AggregatedTradesRequest, AggregatedTradesResponse, AggregatedTradesResponseDataInner, FullDepthLimitEnum, FullDepthRequest, FullDepthResponse, FullDepthResponseData, GetExchangeInfoResponse, GetExchangeInfoResponseData, GetExchangeInfoResponseDataAssetsInner, GetExchangeInfoResponseDataSymbolsInner, GetExchangeInfoResponseDataSymbolsInnerFiltersInner, KlinesIntervalEnum, KlinesRequest, KlinesResponse, KlinesResponseDataInnerInner, MarketDataApi, MarketDataApiInterface, RestAPI, TickerRequest, TickerResponse, TickerResponseData, TokenListResponse, TokenListResponseDataInner };
|
|
1345
|
+
}
|
|
1346
|
+
//#endregion
|
|
1347
|
+
//#region src/websocket-streams/types/aggregate-trade-stream-response.d.ts
|
|
1348
|
+
/**
|
|
1349
|
+
* Alpha WebSocket Market Streams
|
|
1350
|
+
*
|
|
1351
|
+
* Access Alpha market streams over WebSocket.
|
|
1352
|
+
*
|
|
1353
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1354
|
+
*
|
|
1355
|
+
*
|
|
1356
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1357
|
+
* https://openapi-generator.tech
|
|
1358
|
+
* Do not edit the class manually.
|
|
1359
|
+
*/
|
|
1360
|
+
/**
|
|
1361
|
+
*
|
|
1362
|
+
* @export
|
|
1363
|
+
* @interface AggregateTradeStreamResponse
|
|
1364
|
+
*/
|
|
1365
|
+
interface AggregateTradeStreamResponse {
|
|
1366
|
+
/**
|
|
1367
|
+
* Event type
|
|
1368
|
+
* @type {string}
|
|
1369
|
+
* @memberof AggregateTradeStreamResponse
|
|
1370
|
+
*/
|
|
1371
|
+
e?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* Event time (ms)
|
|
1374
|
+
* @type {number | bigint}
|
|
1375
|
+
* @memberof AggregateTradeStreamResponse
|
|
1376
|
+
*/
|
|
1377
|
+
E?: number | bigint;
|
|
1378
|
+
/**
|
|
1379
|
+
* Trade time (ms)
|
|
1380
|
+
* @type {number | bigint}
|
|
1381
|
+
* @memberof AggregateTradeStreamResponse
|
|
1382
|
+
*/
|
|
1383
|
+
T?: number | bigint;
|
|
1384
|
+
/**
|
|
1385
|
+
* Aggregated trade ID
|
|
1386
|
+
* @type {number | bigint}
|
|
1387
|
+
* @memberof AggregateTradeStreamResponse
|
|
1388
|
+
*/
|
|
1389
|
+
a?: number | bigint;
|
|
1390
|
+
/**
|
|
1391
|
+
* First trade ID in the aggregation
|
|
1392
|
+
* @type {number | bigint}
|
|
1393
|
+
* @memberof AggregateTradeStreamResponse
|
|
1394
|
+
*/
|
|
1395
|
+
f?: number | bigint;
|
|
1396
|
+
/**
|
|
1397
|
+
* Last trade ID in the aggregation
|
|
1398
|
+
* @type {number | bigint}
|
|
1399
|
+
* @memberof AggregateTradeStreamResponse
|
|
1400
|
+
*/
|
|
1401
|
+
l?: number | bigint;
|
|
1402
|
+
/**
|
|
1403
|
+
* Is the buyer the market maker
|
|
1404
|
+
* @type {boolean}
|
|
1405
|
+
* @memberof AggregateTradeStreamResponse
|
|
1406
|
+
*/
|
|
1407
|
+
m?: boolean;
|
|
1408
|
+
/**
|
|
1409
|
+
* Price
|
|
1410
|
+
* @type {string}
|
|
1411
|
+
* @memberof AggregateTradeStreamResponse
|
|
1412
|
+
*/
|
|
1413
|
+
p?: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* Quantity
|
|
1416
|
+
* @type {string}
|
|
1417
|
+
* @memberof AggregateTradeStreamResponse
|
|
1418
|
+
*/
|
|
1419
|
+
q?: string;
|
|
1420
|
+
/**
|
|
1421
|
+
* Symbol
|
|
1422
|
+
* @type {string}
|
|
1423
|
+
* @memberof AggregateTradeStreamResponse
|
|
1424
|
+
*/
|
|
1425
|
+
s?: string;
|
|
1426
|
+
}
|
|
1427
|
+
//#endregion
|
|
1428
|
+
//#region src/websocket-streams/types/all-book-ticker-stream-response.d.ts
|
|
1429
|
+
/**
|
|
1430
|
+
* Alpha WebSocket Market Streams
|
|
1431
|
+
*
|
|
1432
|
+
* Access Alpha market streams over WebSocket.
|
|
1433
|
+
*
|
|
1434
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1435
|
+
*
|
|
1436
|
+
*
|
|
1437
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1438
|
+
* https://openapi-generator.tech
|
|
1439
|
+
* Do not edit the class manually.
|
|
1440
|
+
*/
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @export
|
|
1444
|
+
* @interface AllBookTickerStreamResponse
|
|
1445
|
+
*/
|
|
1446
|
+
interface AllBookTickerStreamResponse {
|
|
1447
|
+
/**
|
|
1448
|
+
* eventType
|
|
1449
|
+
* @type {string}
|
|
1450
|
+
* @memberof AllBookTickerStreamResponse
|
|
1451
|
+
*/
|
|
1452
|
+
e?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* eventTime
|
|
1455
|
+
* @type {number | bigint}
|
|
1456
|
+
* @memberof AllBookTickerStreamResponse
|
|
1457
|
+
*/
|
|
1458
|
+
E?: number | bigint;
|
|
1459
|
+
/**
|
|
1460
|
+
* transactionTime
|
|
1461
|
+
* @type {number | bigint}
|
|
1462
|
+
* @memberof AllBookTickerStreamResponse
|
|
1463
|
+
*/
|
|
1464
|
+
T?: number | bigint;
|
|
1465
|
+
/**
|
|
1466
|
+
* updateId
|
|
1467
|
+
* @type {number | bigint}
|
|
1468
|
+
* @memberof AllBookTickerStreamResponse
|
|
1469
|
+
*/
|
|
1470
|
+
u?: number | bigint;
|
|
1471
|
+
/**
|
|
1472
|
+
* symbol
|
|
1473
|
+
* @type {string}
|
|
1474
|
+
* @memberof AllBookTickerStreamResponse
|
|
1475
|
+
*/
|
|
1476
|
+
s?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* bid1Price
|
|
1479
|
+
* @type {string}
|
|
1480
|
+
* @memberof AllBookTickerStreamResponse
|
|
1481
|
+
*/
|
|
1482
|
+
b?: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* bid1Quantity
|
|
1485
|
+
* @type {string}
|
|
1486
|
+
* @memberof AllBookTickerStreamResponse
|
|
1487
|
+
*/
|
|
1488
|
+
B?: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* ask1Price
|
|
1491
|
+
* @type {string}
|
|
1492
|
+
* @memberof AllBookTickerStreamResponse
|
|
1493
|
+
*/
|
|
1494
|
+
a?: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* ask1Quantity
|
|
1497
|
+
* @type {string}
|
|
1498
|
+
* @memberof AllBookTickerStreamResponse
|
|
1499
|
+
*/
|
|
1500
|
+
A?: string;
|
|
1501
|
+
}
|
|
1502
|
+
//#endregion
|
|
1503
|
+
//#region src/websocket-streams/types/all-mini-ticker-stream-response.d.ts
|
|
1504
|
+
/**
|
|
1505
|
+
* Alpha WebSocket Market Streams
|
|
1506
|
+
*
|
|
1507
|
+
* Access Alpha market streams over WebSocket.
|
|
1508
|
+
*
|
|
1509
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1510
|
+
*
|
|
1511
|
+
*
|
|
1512
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1513
|
+
* https://openapi-generator.tech
|
|
1514
|
+
* Do not edit the class manually.
|
|
1515
|
+
*/
|
|
1516
|
+
/**
|
|
1517
|
+
*
|
|
1518
|
+
* @export
|
|
1519
|
+
* @interface AllMiniTickerStreamResponse
|
|
1520
|
+
*/
|
|
1521
|
+
interface AllMiniTickerStreamResponse {
|
|
1522
|
+
/**
|
|
1523
|
+
* eventType
|
|
1524
|
+
* @type {string}
|
|
1525
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1526
|
+
*/
|
|
1527
|
+
e?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* eventTime
|
|
1530
|
+
* @type {number | bigint}
|
|
1531
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1532
|
+
*/
|
|
1533
|
+
E?: number | bigint;
|
|
1534
|
+
/**
|
|
1535
|
+
* symbol
|
|
1536
|
+
* @type {string}
|
|
1537
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1538
|
+
*/
|
|
1539
|
+
s?: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* closePrice
|
|
1542
|
+
* @type {string}
|
|
1543
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1544
|
+
*/
|
|
1545
|
+
c?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* openPrice
|
|
1548
|
+
* @type {string}
|
|
1549
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1550
|
+
*/
|
|
1551
|
+
o?: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* highPrice
|
|
1554
|
+
* @type {string}
|
|
1555
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1556
|
+
*/
|
|
1557
|
+
h?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* lowPrice
|
|
1560
|
+
* @type {string}
|
|
1561
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1562
|
+
*/
|
|
1563
|
+
l?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* volume
|
|
1566
|
+
* @type {string}
|
|
1567
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1568
|
+
*/
|
|
1569
|
+
v?: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* quoteVolume
|
|
1572
|
+
* @type {string}
|
|
1573
|
+
* @memberof AllMiniTickerStreamResponse
|
|
1574
|
+
*/
|
|
1575
|
+
q?: string;
|
|
1576
|
+
}
|
|
1577
|
+
//#endregion
|
|
1578
|
+
//#region src/websocket-streams/types/all-ticker-stream-response.d.ts
|
|
1579
|
+
/**
|
|
1580
|
+
* Alpha WebSocket Market Streams
|
|
1581
|
+
*
|
|
1582
|
+
* Access Alpha market streams over WebSocket.
|
|
1583
|
+
*
|
|
1584
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1585
|
+
*
|
|
1586
|
+
*
|
|
1587
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1588
|
+
* https://openapi-generator.tech
|
|
1589
|
+
* Do not edit the class manually.
|
|
1590
|
+
*/
|
|
1591
|
+
/**
|
|
1592
|
+
*
|
|
1593
|
+
* @export
|
|
1594
|
+
* @interface AllTickerStreamResponse
|
|
1595
|
+
*/
|
|
1596
|
+
interface AllTickerStreamResponse {
|
|
1597
|
+
/**
|
|
1598
|
+
* eventType
|
|
1599
|
+
* @type {string}
|
|
1600
|
+
* @memberof AllTickerStreamResponse
|
|
1601
|
+
*/
|
|
1602
|
+
e?: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* eventTime
|
|
1605
|
+
* @type {number | bigint}
|
|
1606
|
+
* @memberof AllTickerStreamResponse
|
|
1607
|
+
*/
|
|
1608
|
+
E?: number | bigint;
|
|
1609
|
+
/**
|
|
1610
|
+
* symbol
|
|
1611
|
+
* @type {string}
|
|
1612
|
+
* @memberof AllTickerStreamResponse
|
|
1613
|
+
*/
|
|
1614
|
+
s?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* priceChange
|
|
1617
|
+
* @type {string}
|
|
1618
|
+
* @memberof AllTickerStreamResponse
|
|
1619
|
+
*/
|
|
1620
|
+
p?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* priceChangePercent
|
|
1623
|
+
* @type {string}
|
|
1624
|
+
* @memberof AllTickerStreamResponse
|
|
1625
|
+
*/
|
|
1626
|
+
P?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* averagePrice
|
|
1629
|
+
* @type {string}
|
|
1630
|
+
* @memberof AllTickerStreamResponse
|
|
1631
|
+
*/
|
|
1632
|
+
w?: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* closePrice
|
|
1635
|
+
* @type {string}
|
|
1636
|
+
* @memberof AllTickerStreamResponse
|
|
1637
|
+
*/
|
|
1638
|
+
c?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* lastTradeVolume
|
|
1641
|
+
* @type {string}
|
|
1642
|
+
* @memberof AllTickerStreamResponse
|
|
1643
|
+
*/
|
|
1644
|
+
Q?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* openPrice
|
|
1647
|
+
* @type {string}
|
|
1648
|
+
* @memberof AllTickerStreamResponse
|
|
1649
|
+
*/
|
|
1650
|
+
o?: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* highPrice
|
|
1653
|
+
* @type {string}
|
|
1654
|
+
* @memberof AllTickerStreamResponse
|
|
1655
|
+
*/
|
|
1656
|
+
h?: string;
|
|
1657
|
+
/**
|
|
1658
|
+
* lowPrice
|
|
1659
|
+
* @type {string}
|
|
1660
|
+
* @memberof AllTickerStreamResponse
|
|
1661
|
+
*/
|
|
1662
|
+
l?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* volume
|
|
1665
|
+
* @type {string}
|
|
1666
|
+
* @memberof AllTickerStreamResponse
|
|
1667
|
+
*/
|
|
1668
|
+
v?: string;
|
|
1669
|
+
/**
|
|
1670
|
+
* quoteVolume
|
|
1671
|
+
* @type {string}
|
|
1672
|
+
* @memberof AllTickerStreamResponse
|
|
1673
|
+
*/
|
|
1674
|
+
q?: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* startTime
|
|
1677
|
+
* @type {number | bigint}
|
|
1678
|
+
* @memberof AllTickerStreamResponse
|
|
1679
|
+
*/
|
|
1680
|
+
O?: number | bigint;
|
|
1681
|
+
/**
|
|
1682
|
+
* endTime
|
|
1683
|
+
* @type {number | bigint}
|
|
1684
|
+
* @memberof AllTickerStreamResponse
|
|
1685
|
+
*/
|
|
1686
|
+
C?: number | bigint;
|
|
1687
|
+
/**
|
|
1688
|
+
* firstTradeId
|
|
1689
|
+
* @type {number | bigint}
|
|
1690
|
+
* @memberof AllTickerStreamResponse
|
|
1691
|
+
*/
|
|
1692
|
+
F?: number | bigint;
|
|
1693
|
+
/**
|
|
1694
|
+
* lastTradeId
|
|
1695
|
+
* @type {number | bigint}
|
|
1696
|
+
* @memberof AllTickerStreamResponse
|
|
1697
|
+
*/
|
|
1698
|
+
L?: number | bigint;
|
|
1699
|
+
/**
|
|
1700
|
+
* tradeNum
|
|
1701
|
+
* @type {number | bigint}
|
|
1702
|
+
* @memberof AllTickerStreamResponse
|
|
1703
|
+
*/
|
|
1704
|
+
n?: number | bigint;
|
|
1705
|
+
}
|
|
1706
|
+
//#endregion
|
|
1707
|
+
//#region src/websocket-streams/types/all-tokens24h-ticker-stream-response-dinner.d.ts
|
|
1708
|
+
/**
|
|
1709
|
+
* Alpha WebSocket Market Streams
|
|
1710
|
+
*
|
|
1711
|
+
* Access Alpha market streams over WebSocket.
|
|
1712
|
+
*
|
|
1713
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1714
|
+
*
|
|
1715
|
+
*
|
|
1716
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1717
|
+
* https://openapi-generator.tech
|
|
1718
|
+
* Do not edit the class manually.
|
|
1719
|
+
*/
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @export
|
|
1723
|
+
* @interface AllTokens24hTickerStreamResponseDInner
|
|
1724
|
+
*/
|
|
1725
|
+
interface AllTokens24hTickerStreamResponseDInner {
|
|
1726
|
+
/**
|
|
1727
|
+
* Contract address@chain ID
|
|
1728
|
+
* @type {string}
|
|
1729
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1730
|
+
*/
|
|
1731
|
+
ca?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* Number of trades in the last 24 hours
|
|
1734
|
+
* @type {number | bigint}
|
|
1735
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1736
|
+
*/
|
|
1737
|
+
cnt24?: number | bigint;
|
|
1738
|
+
/**
|
|
1739
|
+
* Fully diluted valuation
|
|
1740
|
+
* @type {string}
|
|
1741
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1742
|
+
*/
|
|
1743
|
+
fdv?: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* Number of holders
|
|
1746
|
+
* @type {string}
|
|
1747
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1748
|
+
*/
|
|
1749
|
+
hc?: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Liquidity
|
|
1752
|
+
* @type {string}
|
|
1753
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1754
|
+
*/
|
|
1755
|
+
liq?: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Market cap
|
|
1758
|
+
* @type {string}
|
|
1759
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1760
|
+
*/
|
|
1761
|
+
mc?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* Current price
|
|
1764
|
+
* @type {string}
|
|
1765
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1766
|
+
*/
|
|
1767
|
+
p?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* 24-hour price change percent
|
|
1770
|
+
* @type {string}
|
|
1771
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1772
|
+
*/
|
|
1773
|
+
pc24?: string;
|
|
1774
|
+
/**
|
|
1775
|
+
* Token short identifier
|
|
1776
|
+
* @type {string}
|
|
1777
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1778
|
+
*/
|
|
1779
|
+
s?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Event timestamp in milliseconds
|
|
1782
|
+
* @type {number | bigint}
|
|
1783
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1784
|
+
*/
|
|
1785
|
+
t?: number | bigint;
|
|
1786
|
+
/**
|
|
1787
|
+
* 24-hour volume
|
|
1788
|
+
* @type {string}
|
|
1789
|
+
* @memberof AllTokens24hTickerStreamResponseDInner
|
|
1790
|
+
*/
|
|
1791
|
+
vol24?: string;
|
|
1792
|
+
}
|
|
1793
|
+
//#endregion
|
|
1794
|
+
//#region src/websocket-streams/types/all-tokens24h-ticker-stream-response.d.ts
|
|
1795
|
+
/**
|
|
1796
|
+
*
|
|
1797
|
+
* @export
|
|
1798
|
+
* @interface AllTokens24hTickerStreamResponse
|
|
1799
|
+
*/
|
|
1800
|
+
interface AllTokens24hTickerStreamResponse {
|
|
1801
|
+
/**
|
|
1802
|
+
* Event type
|
|
1803
|
+
* @type {string}
|
|
1804
|
+
* @memberof AllTokens24hTickerStreamResponse
|
|
1805
|
+
*/
|
|
1806
|
+
e?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* Per-token 24-hour ticker metrics
|
|
1809
|
+
* @type {Array<AllTokens24hTickerStreamResponseDInner>}
|
|
1810
|
+
* @memberof AllTokens24hTickerStreamResponse
|
|
1811
|
+
*/
|
|
1812
|
+
d?: Array<AllTokens24hTickerStreamResponseDInner>;
|
|
1813
|
+
}
|
|
1814
|
+
//#endregion
|
|
1815
|
+
//#region src/websocket-streams/types/book-ticker-stream-response.d.ts
|
|
1816
|
+
/**
|
|
1817
|
+
* Alpha WebSocket Market Streams
|
|
1818
|
+
*
|
|
1819
|
+
* Access Alpha market streams over WebSocket.
|
|
1820
|
+
*
|
|
1821
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1822
|
+
*
|
|
1823
|
+
*
|
|
1824
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1825
|
+
* https://openapi-generator.tech
|
|
1826
|
+
* Do not edit the class manually.
|
|
1827
|
+
*/
|
|
1828
|
+
/**
|
|
1829
|
+
*
|
|
1830
|
+
* @export
|
|
1831
|
+
* @interface BookTickerStreamResponse
|
|
1832
|
+
*/
|
|
1833
|
+
interface BookTickerStreamResponse {
|
|
1834
|
+
/**
|
|
1835
|
+
* eventType
|
|
1836
|
+
* @type {string}
|
|
1837
|
+
* @memberof BookTickerStreamResponse
|
|
1838
|
+
*/
|
|
1839
|
+
e?: string;
|
|
1840
|
+
/**
|
|
1841
|
+
* eventTime
|
|
1842
|
+
* @type {number | bigint}
|
|
1843
|
+
* @memberof BookTickerStreamResponse
|
|
1844
|
+
*/
|
|
1845
|
+
E?: number | bigint;
|
|
1846
|
+
/**
|
|
1847
|
+
* transactionTime
|
|
1848
|
+
* @type {number | bigint}
|
|
1849
|
+
* @memberof BookTickerStreamResponse
|
|
1850
|
+
*/
|
|
1851
|
+
T?: number | bigint;
|
|
1852
|
+
/**
|
|
1853
|
+
* updateId
|
|
1854
|
+
* @type {number | bigint}
|
|
1855
|
+
* @memberof BookTickerStreamResponse
|
|
1856
|
+
*/
|
|
1857
|
+
u?: number | bigint;
|
|
1858
|
+
/**
|
|
1859
|
+
* symbol
|
|
1860
|
+
* @type {string}
|
|
1861
|
+
* @memberof BookTickerStreamResponse
|
|
1862
|
+
*/
|
|
1863
|
+
s?: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* bid1Price
|
|
1866
|
+
* @type {string}
|
|
1867
|
+
* @memberof BookTickerStreamResponse
|
|
1868
|
+
*/
|
|
1869
|
+
b?: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* bid1Quantity
|
|
1872
|
+
* @type {string}
|
|
1873
|
+
* @memberof BookTickerStreamResponse
|
|
1874
|
+
*/
|
|
1875
|
+
B?: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* ask1Price
|
|
1878
|
+
* @type {string}
|
|
1879
|
+
* @memberof BookTickerStreamResponse
|
|
1880
|
+
*/
|
|
1881
|
+
a?: string;
|
|
1882
|
+
/**
|
|
1883
|
+
* ask1Quantity
|
|
1884
|
+
* @type {string}
|
|
1885
|
+
* @memberof BookTickerStreamResponse
|
|
1886
|
+
*/
|
|
1887
|
+
A?: string;
|
|
1888
|
+
}
|
|
1889
|
+
//#endregion
|
|
1890
|
+
//#region src/websocket-streams/types/contract-kline-stream-response-k.d.ts
|
|
1891
|
+
/**
|
|
1892
|
+
* Alpha WebSocket Market Streams
|
|
1893
|
+
*
|
|
1894
|
+
* Access Alpha market streams over WebSocket.
|
|
1895
|
+
*
|
|
1896
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1897
|
+
*
|
|
1898
|
+
*
|
|
1899
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1900
|
+
* https://openapi-generator.tech
|
|
1901
|
+
* Do not edit the class manually.
|
|
1902
|
+
*/
|
|
1903
|
+
/**
|
|
1904
|
+
* Kline payload
|
|
1905
|
+
* @export
|
|
1906
|
+
* @interface ContractKlineStreamResponseK
|
|
1907
|
+
*/
|
|
1908
|
+
interface ContractKlineStreamResponseK {
|
|
1909
|
+
/**
|
|
1910
|
+
* Open price
|
|
1911
|
+
* @type {string}
|
|
1912
|
+
* @memberof ContractKlineStreamResponseK
|
|
1913
|
+
*/
|
|
1914
|
+
o?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Close price
|
|
1917
|
+
* @type {string}
|
|
1918
|
+
* @memberof ContractKlineStreamResponseK
|
|
1919
|
+
*/
|
|
1920
|
+
c?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* High price
|
|
1923
|
+
* @type {string}
|
|
1924
|
+
* @memberof ContractKlineStreamResponseK
|
|
1925
|
+
*/
|
|
1926
|
+
h?: string;
|
|
1927
|
+
/**
|
|
1928
|
+
* Low price
|
|
1929
|
+
* @type {string}
|
|
1930
|
+
* @memberof ContractKlineStreamResponseK
|
|
1931
|
+
*/
|
|
1932
|
+
l?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* Volume
|
|
1935
|
+
* @type {string}
|
|
1936
|
+
* @memberof ContractKlineStreamResponseK
|
|
1937
|
+
*/
|
|
1938
|
+
v?: string;
|
|
1939
|
+
/**
|
|
1940
|
+
* Kline open time
|
|
1941
|
+
* @type {number | bigint}
|
|
1942
|
+
* @memberof ContractKlineStreamResponseK
|
|
1943
|
+
*/
|
|
1944
|
+
ot?: number | bigint;
|
|
1945
|
+
/**
|
|
1946
|
+
* Kline close time
|
|
1947
|
+
* @type {number | bigint}
|
|
1948
|
+
* @memberof ContractKlineStreamResponseK
|
|
1949
|
+
*/
|
|
1950
|
+
ct?: number | bigint;
|
|
1951
|
+
/**
|
|
1952
|
+
* Interval
|
|
1953
|
+
* @type {string}
|
|
1954
|
+
* @memberof ContractKlineStreamResponseK
|
|
1955
|
+
*/
|
|
1956
|
+
i?: string;
|
|
1957
|
+
}
|
|
1958
|
+
//#endregion
|
|
1959
|
+
//#region src/websocket-streams/types/contract-kline-stream-response.d.ts
|
|
1960
|
+
/**
|
|
1961
|
+
*
|
|
1962
|
+
* @export
|
|
1963
|
+
* @interface ContractKlineStreamResponse
|
|
1964
|
+
*/
|
|
1965
|
+
interface ContractKlineStreamResponse {
|
|
1966
|
+
/**
|
|
1967
|
+
* Contract address@Chain ID
|
|
1968
|
+
* @type {string}
|
|
1969
|
+
* @memberof ContractKlineStreamResponse
|
|
1970
|
+
*/
|
|
1971
|
+
ca?: string;
|
|
1972
|
+
/**
|
|
1973
|
+
* Event type
|
|
1974
|
+
* @type {string}
|
|
1975
|
+
* @memberof ContractKlineStreamResponse
|
|
1976
|
+
*/
|
|
1977
|
+
e?: string;
|
|
1978
|
+
/**
|
|
1979
|
+
*
|
|
1980
|
+
* @type {ContractKlineStreamResponseK}
|
|
1981
|
+
* @memberof ContractKlineStreamResponse
|
|
1982
|
+
*/
|
|
1983
|
+
k?: ContractKlineStreamResponseK;
|
|
1984
|
+
}
|
|
1985
|
+
//#endregion
|
|
1986
|
+
//#region src/websocket-streams/types/full-depth-stream-response.d.ts
|
|
1987
|
+
/**
|
|
1988
|
+
* Alpha WebSocket Market Streams
|
|
1989
|
+
*
|
|
1990
|
+
* Access Alpha market streams over WebSocket.
|
|
1991
|
+
*
|
|
1992
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1993
|
+
*
|
|
1994
|
+
*
|
|
1995
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1996
|
+
* https://openapi-generator.tech
|
|
1997
|
+
* Do not edit the class manually.
|
|
1998
|
+
*/
|
|
1999
|
+
/**
|
|
2000
|
+
*
|
|
2001
|
+
* @export
|
|
2002
|
+
* @interface FullDepthStreamResponse
|
|
2003
|
+
*/
|
|
2004
|
+
interface FullDepthStreamResponse {
|
|
2005
|
+
/**
|
|
2006
|
+
* Event type
|
|
2007
|
+
* @type {string}
|
|
2008
|
+
* @memberof FullDepthStreamResponse
|
|
2009
|
+
*/
|
|
2010
|
+
e?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* Event time (ms)
|
|
2013
|
+
* @type {number | bigint}
|
|
2014
|
+
* @memberof FullDepthStreamResponse
|
|
2015
|
+
*/
|
|
2016
|
+
E?: number | bigint;
|
|
2017
|
+
/**
|
|
2018
|
+
* Matching time (ms)
|
|
2019
|
+
* @type {number | bigint}
|
|
2020
|
+
* @memberof FullDepthStreamResponse
|
|
2021
|
+
*/
|
|
2022
|
+
T?: number | bigint;
|
|
2023
|
+
/**
|
|
2024
|
+
* First updateId in this event
|
|
2025
|
+
* @type {number | bigint}
|
|
2026
|
+
* @memberof FullDepthStreamResponse
|
|
2027
|
+
*/
|
|
2028
|
+
U?: number | bigint;
|
|
2029
|
+
/**
|
|
2030
|
+
* Last updateId in this event
|
|
2031
|
+
* @type {number | bigint}
|
|
2032
|
+
* @memberof FullDepthStreamResponse
|
|
2033
|
+
*/
|
|
2034
|
+
u?: number | bigint;
|
|
2035
|
+
/**
|
|
2036
|
+
* Previous updateId from the last push
|
|
2037
|
+
* @type {number | bigint}
|
|
2038
|
+
* @memberof FullDepthStreamResponse
|
|
2039
|
+
*/
|
|
2040
|
+
pu?: number | bigint;
|
|
2041
|
+
/**
|
|
2042
|
+
* Symbol
|
|
2043
|
+
* @type {string}
|
|
2044
|
+
* @memberof FullDepthStreamResponse
|
|
2045
|
+
*/
|
|
2046
|
+
s?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* bids to be updated
|
|
2049
|
+
* @type {Array<Array<string>>}
|
|
2050
|
+
* @memberof FullDepthStreamResponse
|
|
2051
|
+
*/
|
|
2052
|
+
b?: Array<Array<string>>;
|
|
2053
|
+
/**
|
|
2054
|
+
* asks to be updated
|
|
2055
|
+
* @type {Array<Array<string>>}
|
|
2056
|
+
* @memberof FullDepthStreamResponse
|
|
2057
|
+
*/
|
|
2058
|
+
a?: Array<Array<string>>;
|
|
2059
|
+
}
|
|
2060
|
+
//#endregion
|
|
2061
|
+
//#region src/websocket-streams/types/kline-stream-response-k.d.ts
|
|
2062
|
+
/**
|
|
2063
|
+
* Alpha WebSocket Market Streams
|
|
2064
|
+
*
|
|
2065
|
+
* Access Alpha market streams over WebSocket.
|
|
2066
|
+
*
|
|
2067
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2068
|
+
*
|
|
2069
|
+
*
|
|
2070
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2071
|
+
* https://openapi-generator.tech
|
|
2072
|
+
* Do not edit the class manually.
|
|
2073
|
+
*/
|
|
2074
|
+
/**
|
|
2075
|
+
*
|
|
2076
|
+
* @export
|
|
2077
|
+
* @interface KlineStreamResponseK
|
|
2078
|
+
*/
|
|
2079
|
+
interface KlineStreamResponseK {
|
|
2080
|
+
/**
|
|
2081
|
+
* startTime
|
|
2082
|
+
* @type {number | bigint}
|
|
2083
|
+
* @memberof KlineStreamResponseK
|
|
2084
|
+
*/
|
|
2085
|
+
t?: number | bigint;
|
|
2086
|
+
/**
|
|
2087
|
+
* endTime
|
|
2088
|
+
* @type {number | bigint}
|
|
2089
|
+
* @memberof KlineStreamResponseK
|
|
2090
|
+
*/
|
|
2091
|
+
T?: number | bigint;
|
|
2092
|
+
/**
|
|
2093
|
+
* symbol
|
|
2094
|
+
* @type {string}
|
|
2095
|
+
* @memberof KlineStreamResponseK
|
|
2096
|
+
*/
|
|
2097
|
+
s?: string;
|
|
2098
|
+
/**
|
|
2099
|
+
* interval
|
|
2100
|
+
* @type {string}
|
|
2101
|
+
* @memberof KlineStreamResponseK
|
|
2102
|
+
*/
|
|
2103
|
+
i?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* firstTradeId
|
|
2106
|
+
* @type {number | bigint}
|
|
2107
|
+
* @memberof KlineStreamResponseK
|
|
2108
|
+
*/
|
|
2109
|
+
f?: number | bigint;
|
|
2110
|
+
/**
|
|
2111
|
+
* lastTradeId
|
|
2112
|
+
* @type {number | bigint}
|
|
2113
|
+
* @memberof KlineStreamResponseK
|
|
2114
|
+
*/
|
|
2115
|
+
L?: number | bigint;
|
|
2116
|
+
/**
|
|
2117
|
+
* openPrice
|
|
2118
|
+
* @type {string}
|
|
2119
|
+
* @memberof KlineStreamResponseK
|
|
2120
|
+
*/
|
|
2121
|
+
o?: string;
|
|
2122
|
+
/**
|
|
2123
|
+
* closePrice
|
|
2124
|
+
* @type {string}
|
|
2125
|
+
* @memberof KlineStreamResponseK
|
|
2126
|
+
*/
|
|
2127
|
+
c?: string;
|
|
2128
|
+
/**
|
|
2129
|
+
* highPrice
|
|
2130
|
+
* @type {string}
|
|
2131
|
+
* @memberof KlineStreamResponseK
|
|
2132
|
+
*/
|
|
2133
|
+
h?: string;
|
|
2134
|
+
/**
|
|
2135
|
+
* lowPrice
|
|
2136
|
+
* @type {string}
|
|
2137
|
+
* @memberof KlineStreamResponseK
|
|
2138
|
+
*/
|
|
2139
|
+
l?: string;
|
|
2140
|
+
/**
|
|
2141
|
+
* volume
|
|
2142
|
+
* @type {string}
|
|
2143
|
+
* @memberof KlineStreamResponseK
|
|
2144
|
+
*/
|
|
2145
|
+
v?: string;
|
|
2146
|
+
/**
|
|
2147
|
+
* tradeNum
|
|
2148
|
+
* @type {number | bigint}
|
|
2149
|
+
* @memberof KlineStreamResponseK
|
|
2150
|
+
*/
|
|
2151
|
+
n?: number | bigint;
|
|
2152
|
+
/**
|
|
2153
|
+
* klineComplete
|
|
2154
|
+
* @type {boolean}
|
|
2155
|
+
* @memberof KlineStreamResponseK
|
|
2156
|
+
*/
|
|
2157
|
+
x?: boolean;
|
|
2158
|
+
/**
|
|
2159
|
+
* quoteAssetVolume
|
|
2160
|
+
* @type {string}
|
|
2161
|
+
* @memberof KlineStreamResponseK
|
|
2162
|
+
*/
|
|
2163
|
+
q?: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* takerBuyBaseAssetVolume
|
|
2166
|
+
* @type {string}
|
|
2167
|
+
* @memberof KlineStreamResponseK
|
|
2168
|
+
*/
|
|
2169
|
+
V?: string;
|
|
2170
|
+
/**
|
|
2171
|
+
* takerBuyQuoteAssetVolume
|
|
2172
|
+
* @type {string}
|
|
2173
|
+
* @memberof KlineStreamResponseK
|
|
2174
|
+
*/
|
|
2175
|
+
Q?: string;
|
|
2176
|
+
/**
|
|
2177
|
+
* ignore
|
|
2178
|
+
* @type {string}
|
|
2179
|
+
* @memberof KlineStreamResponseK
|
|
2180
|
+
*/
|
|
2181
|
+
B?: string;
|
|
2182
|
+
}
|
|
2183
|
+
//#endregion
|
|
2184
|
+
//#region src/websocket-streams/types/kline-stream-response.d.ts
|
|
2185
|
+
/**
|
|
2186
|
+
*
|
|
2187
|
+
* @export
|
|
2188
|
+
* @interface KlineStreamResponse
|
|
2189
|
+
*/
|
|
2190
|
+
interface KlineStreamResponse {
|
|
2191
|
+
/**
|
|
2192
|
+
* eventType
|
|
2193
|
+
* @type {string}
|
|
2194
|
+
* @memberof KlineStreamResponse
|
|
2195
|
+
*/
|
|
2196
|
+
e?: string;
|
|
2197
|
+
/**
|
|
2198
|
+
* eventTime
|
|
2199
|
+
* @type {number | bigint}
|
|
2200
|
+
* @memberof KlineStreamResponse
|
|
2201
|
+
*/
|
|
2202
|
+
E?: number | bigint;
|
|
2203
|
+
/**
|
|
2204
|
+
* symbol
|
|
2205
|
+
* @type {string}
|
|
2206
|
+
* @memberof KlineStreamResponse
|
|
2207
|
+
*/
|
|
2208
|
+
s?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
*
|
|
2211
|
+
* @type {KlineStreamResponseK}
|
|
2212
|
+
* @memberof KlineStreamResponse
|
|
2213
|
+
*/
|
|
2214
|
+
k?: KlineStreamResponseK;
|
|
2215
|
+
}
|
|
2216
|
+
//#endregion
|
|
2217
|
+
//#region src/websocket-streams/types/mini-ticker-stream-response.d.ts
|
|
2218
|
+
/**
|
|
2219
|
+
* Alpha WebSocket Market Streams
|
|
2220
|
+
*
|
|
2221
|
+
* Access Alpha market streams over WebSocket.
|
|
2222
|
+
*
|
|
2223
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2224
|
+
*
|
|
2225
|
+
*
|
|
2226
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2227
|
+
* https://openapi-generator.tech
|
|
2228
|
+
* Do not edit the class manually.
|
|
2229
|
+
*/
|
|
2230
|
+
/**
|
|
2231
|
+
*
|
|
2232
|
+
* @export
|
|
2233
|
+
* @interface MiniTickerStreamResponse
|
|
2234
|
+
*/
|
|
2235
|
+
interface MiniTickerStreamResponse {
|
|
2236
|
+
/**
|
|
2237
|
+
* eventType
|
|
2238
|
+
* @type {string}
|
|
2239
|
+
* @memberof MiniTickerStreamResponse
|
|
2240
|
+
*/
|
|
2241
|
+
e?: string;
|
|
2242
|
+
/**
|
|
2243
|
+
* eventTime
|
|
2244
|
+
* @type {number | bigint}
|
|
2245
|
+
* @memberof MiniTickerStreamResponse
|
|
2246
|
+
*/
|
|
2247
|
+
E?: number | bigint;
|
|
2248
|
+
/**
|
|
2249
|
+
* symbol
|
|
2250
|
+
* @type {string}
|
|
2251
|
+
* @memberof MiniTickerStreamResponse
|
|
2252
|
+
*/
|
|
2253
|
+
s?: string;
|
|
2254
|
+
/**
|
|
2255
|
+
* closePrice
|
|
2256
|
+
* @type {string}
|
|
2257
|
+
* @memberof MiniTickerStreamResponse
|
|
2258
|
+
*/
|
|
2259
|
+
c?: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* openPrice
|
|
2262
|
+
* @type {string}
|
|
2263
|
+
* @memberof MiniTickerStreamResponse
|
|
2264
|
+
*/
|
|
2265
|
+
o?: string;
|
|
2266
|
+
/**
|
|
2267
|
+
* highPrice
|
|
2268
|
+
* @type {string}
|
|
2269
|
+
* @memberof MiniTickerStreamResponse
|
|
2270
|
+
*/
|
|
2271
|
+
h?: string;
|
|
2272
|
+
/**
|
|
2273
|
+
* lowPrice
|
|
2274
|
+
* @type {string}
|
|
2275
|
+
* @memberof MiniTickerStreamResponse
|
|
2276
|
+
*/
|
|
2277
|
+
l?: string;
|
|
2278
|
+
/**
|
|
2279
|
+
* volume
|
|
2280
|
+
* @type {string}
|
|
2281
|
+
* @memberof MiniTickerStreamResponse
|
|
2282
|
+
*/
|
|
2283
|
+
v?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* quoteVolume
|
|
2286
|
+
* @type {string}
|
|
2287
|
+
* @memberof MiniTickerStreamResponse
|
|
2288
|
+
*/
|
|
2289
|
+
q?: string;
|
|
2290
|
+
}
|
|
2291
|
+
//#endregion
|
|
2292
|
+
//#region src/websocket-streams/types/partial-depth-stream-response.d.ts
|
|
2293
|
+
/**
|
|
2294
|
+
* Alpha WebSocket Market Streams
|
|
2295
|
+
*
|
|
2296
|
+
* Access Alpha market streams over WebSocket.
|
|
2297
|
+
*
|
|
2298
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2299
|
+
*
|
|
2300
|
+
*
|
|
2301
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2302
|
+
* https://openapi-generator.tech
|
|
2303
|
+
* Do not edit the class manually.
|
|
2304
|
+
*/
|
|
2305
|
+
/**
|
|
2306
|
+
*
|
|
2307
|
+
* @export
|
|
2308
|
+
* @interface PartialDepthStreamResponse
|
|
2309
|
+
*/
|
|
2310
|
+
interface PartialDepthStreamResponse {
|
|
2311
|
+
/**
|
|
2312
|
+
* eventType
|
|
2313
|
+
* @type {string}
|
|
2314
|
+
* @memberof PartialDepthStreamResponse
|
|
2315
|
+
*/
|
|
2316
|
+
e?: string;
|
|
2317
|
+
/**
|
|
2318
|
+
* eventTime
|
|
2319
|
+
* @type {number | bigint}
|
|
2320
|
+
* @memberof PartialDepthStreamResponse
|
|
2321
|
+
*/
|
|
2322
|
+
E?: number | bigint;
|
|
2323
|
+
/**
|
|
2324
|
+
* transactionTime
|
|
2325
|
+
* @type {number | bigint}
|
|
2326
|
+
* @memberof PartialDepthStreamResponse
|
|
2327
|
+
*/
|
|
2328
|
+
T?: number | bigint;
|
|
2329
|
+
/**
|
|
2330
|
+
* firstUpdateId
|
|
2331
|
+
* @type {number | bigint}
|
|
2332
|
+
* @memberof PartialDepthStreamResponse
|
|
2333
|
+
*/
|
|
2334
|
+
U?: number | bigint;
|
|
2335
|
+
/**
|
|
2336
|
+
* lastUpdateId
|
|
2337
|
+
* @type {number | bigint}
|
|
2338
|
+
* @memberof PartialDepthStreamResponse
|
|
2339
|
+
*/
|
|
2340
|
+
u?: number | bigint;
|
|
2341
|
+
/**
|
|
2342
|
+
* previousUpdateId
|
|
2343
|
+
* @type {number | bigint}
|
|
2344
|
+
* @memberof PartialDepthStreamResponse
|
|
2345
|
+
*/
|
|
2346
|
+
pu?: number | bigint;
|
|
2347
|
+
/**
|
|
2348
|
+
* symbol
|
|
2349
|
+
* @type {string}
|
|
2350
|
+
* @memberof PartialDepthStreamResponse
|
|
2351
|
+
*/
|
|
2352
|
+
s?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* bids to be updated
|
|
2355
|
+
* @type {Array<Array<string>>}
|
|
2356
|
+
* @memberof PartialDepthStreamResponse
|
|
2357
|
+
*/
|
|
2358
|
+
b?: Array<Array<string>>;
|
|
2359
|
+
/**
|
|
2360
|
+
* asks to be updated
|
|
2361
|
+
* @type {Array<Array<string>>}
|
|
2362
|
+
* @memberof PartialDepthStreamResponse
|
|
2363
|
+
*/
|
|
2364
|
+
a?: Array<Array<string>>;
|
|
2365
|
+
}
|
|
2366
|
+
//#endregion
|
|
2367
|
+
//#region src/websocket-streams/types/ticker-stream-response.d.ts
|
|
2368
|
+
/**
|
|
2369
|
+
* Alpha WebSocket Market Streams
|
|
2370
|
+
*
|
|
2371
|
+
* Access Alpha market streams over WebSocket.
|
|
2372
|
+
*
|
|
2373
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2374
|
+
*
|
|
2375
|
+
*
|
|
2376
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2377
|
+
* https://openapi-generator.tech
|
|
2378
|
+
* Do not edit the class manually.
|
|
2379
|
+
*/
|
|
2380
|
+
/**
|
|
2381
|
+
*
|
|
2382
|
+
* @export
|
|
2383
|
+
* @interface TickerStreamResponse
|
|
2384
|
+
*/
|
|
2385
|
+
interface TickerStreamResponse {
|
|
2386
|
+
/**
|
|
2387
|
+
* eventType
|
|
2388
|
+
* @type {string}
|
|
2389
|
+
* @memberof TickerStreamResponse
|
|
2390
|
+
*/
|
|
2391
|
+
e?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* eventTime
|
|
2394
|
+
* @type {number | bigint}
|
|
2395
|
+
* @memberof TickerStreamResponse
|
|
2396
|
+
*/
|
|
2397
|
+
E?: number | bigint;
|
|
2398
|
+
/**
|
|
2399
|
+
* symbol
|
|
2400
|
+
* @type {string}
|
|
2401
|
+
* @memberof TickerStreamResponse
|
|
2402
|
+
*/
|
|
2403
|
+
s?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* priceChange
|
|
2406
|
+
* @type {string}
|
|
2407
|
+
* @memberof TickerStreamResponse
|
|
2408
|
+
*/
|
|
2409
|
+
p?: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* priceChangePercent
|
|
2412
|
+
* @type {string}
|
|
2413
|
+
* @memberof TickerStreamResponse
|
|
2414
|
+
*/
|
|
2415
|
+
P?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* averagePrice
|
|
2418
|
+
* @type {string}
|
|
2419
|
+
* @memberof TickerStreamResponse
|
|
2420
|
+
*/
|
|
2421
|
+
w?: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* closePrice
|
|
2424
|
+
* @type {string}
|
|
2425
|
+
* @memberof TickerStreamResponse
|
|
2426
|
+
*/
|
|
2427
|
+
c?: string;
|
|
2428
|
+
/**
|
|
2429
|
+
* lastTradeVolume
|
|
2430
|
+
* @type {string}
|
|
2431
|
+
* @memberof TickerStreamResponse
|
|
2432
|
+
*/
|
|
2433
|
+
Q?: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* openPrice
|
|
2436
|
+
* @type {string}
|
|
2437
|
+
* @memberof TickerStreamResponse
|
|
2438
|
+
*/
|
|
2439
|
+
o?: string;
|
|
2440
|
+
/**
|
|
2441
|
+
* highPrice
|
|
2442
|
+
* @type {string}
|
|
2443
|
+
* @memberof TickerStreamResponse
|
|
2444
|
+
*/
|
|
2445
|
+
h?: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* lowPrice
|
|
2448
|
+
* @type {string}
|
|
2449
|
+
* @memberof TickerStreamResponse
|
|
2450
|
+
*/
|
|
2451
|
+
l?: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* volume
|
|
2454
|
+
* @type {string}
|
|
2455
|
+
* @memberof TickerStreamResponse
|
|
2456
|
+
*/
|
|
2457
|
+
v?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* quoteVolume
|
|
2460
|
+
* @type {string}
|
|
2461
|
+
* @memberof TickerStreamResponse
|
|
2462
|
+
*/
|
|
2463
|
+
q?: string;
|
|
2464
|
+
/**
|
|
2465
|
+
* startTime
|
|
2466
|
+
* @type {number | bigint}
|
|
2467
|
+
* @memberof TickerStreamResponse
|
|
2468
|
+
*/
|
|
2469
|
+
O?: number | bigint;
|
|
2470
|
+
/**
|
|
2471
|
+
* endTime
|
|
2472
|
+
* @type {number | bigint}
|
|
2473
|
+
* @memberof TickerStreamResponse
|
|
2474
|
+
*/
|
|
2475
|
+
C?: number | bigint;
|
|
2476
|
+
/**
|
|
2477
|
+
* firstTradeId
|
|
2478
|
+
* @type {number | bigint}
|
|
2479
|
+
* @memberof TickerStreamResponse
|
|
2480
|
+
*/
|
|
2481
|
+
F?: number | bigint;
|
|
2482
|
+
/**
|
|
2483
|
+
* lastTradeId
|
|
2484
|
+
* @type {number | bigint}
|
|
2485
|
+
* @memberof TickerStreamResponse
|
|
2486
|
+
*/
|
|
2487
|
+
L?: number | bigint;
|
|
2488
|
+
/**
|
|
2489
|
+
* tradeNum
|
|
2490
|
+
* @type {number | bigint}
|
|
2491
|
+
* @memberof TickerStreamResponse
|
|
2492
|
+
*/
|
|
2493
|
+
n?: number | bigint;
|
|
2494
|
+
}
|
|
2495
|
+
//#endregion
|
|
2496
|
+
//#region src/websocket-streams/types/trade-stream-response.d.ts
|
|
2497
|
+
/**
|
|
2498
|
+
* Alpha WebSocket Market Streams
|
|
2499
|
+
*
|
|
2500
|
+
* Access Alpha market streams over WebSocket.
|
|
2501
|
+
*
|
|
2502
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2503
|
+
*
|
|
2504
|
+
*
|
|
2505
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2506
|
+
* https://openapi-generator.tech
|
|
2507
|
+
* Do not edit the class manually.
|
|
2508
|
+
*/
|
|
2509
|
+
/**
|
|
2510
|
+
*
|
|
2511
|
+
* @export
|
|
2512
|
+
* @interface TradeStreamResponse
|
|
2513
|
+
*/
|
|
2514
|
+
interface TradeStreamResponse {
|
|
2515
|
+
/**
|
|
2516
|
+
* eventType
|
|
2517
|
+
* @type {string}
|
|
2518
|
+
* @memberof TradeStreamResponse
|
|
2519
|
+
*/
|
|
2520
|
+
e?: string;
|
|
2521
|
+
/**
|
|
2522
|
+
* eventTime
|
|
2523
|
+
* @type {number | bigint}
|
|
2524
|
+
* @memberof TradeStreamResponse
|
|
2525
|
+
*/
|
|
2526
|
+
E?: number | bigint;
|
|
2527
|
+
/**
|
|
2528
|
+
* tradeTime
|
|
2529
|
+
* @type {number | bigint}
|
|
2530
|
+
* @memberof TradeStreamResponse
|
|
2531
|
+
*/
|
|
2532
|
+
T?: number | bigint;
|
|
2533
|
+
/**
|
|
2534
|
+
* symbol
|
|
2535
|
+
* @type {string}
|
|
2536
|
+
* @memberof TradeStreamResponse
|
|
2537
|
+
*/
|
|
2538
|
+
s?: string;
|
|
2539
|
+
/**
|
|
2540
|
+
* tradeId
|
|
2541
|
+
* @type {number | bigint}
|
|
2542
|
+
* @memberof TradeStreamResponse
|
|
2543
|
+
*/
|
|
2544
|
+
t?: number | bigint;
|
|
2545
|
+
/**
|
|
2546
|
+
* fillPrice
|
|
2547
|
+
* @type {string}
|
|
2548
|
+
* @memberof TradeStreamResponse
|
|
2549
|
+
*/
|
|
2550
|
+
p?: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* fillQty
|
|
2553
|
+
* @type {string}
|
|
2554
|
+
* @memberof TradeStreamResponse
|
|
2555
|
+
*/
|
|
2556
|
+
q?: string;
|
|
2557
|
+
/**
|
|
2558
|
+
* isBuyerMaker
|
|
2559
|
+
* @type {boolean}
|
|
2560
|
+
* @memberof TradeStreamResponse
|
|
2561
|
+
*/
|
|
2562
|
+
m?: boolean;
|
|
2563
|
+
}
|
|
2564
|
+
//#endregion
|
|
2565
|
+
//#region src/websocket-streams/modules/api.d.ts
|
|
2566
|
+
/**
|
|
2567
|
+
* Api - interface
|
|
2568
|
+
* @interface Api
|
|
2569
|
+
*/
|
|
2570
|
+
interface ApiInterface {
|
|
2571
|
+
/**
|
|
2572
|
+
* Pushes aggregate trade updates for a symbol.
|
|
2573
|
+
*
|
|
2574
|
+
* @summary Aggregate Trade Stream
|
|
2575
|
+
* @param {AggregateTradeStreamRequest} requestParameters Request parameters.
|
|
2576
|
+
*
|
|
2577
|
+
* @returns {WebsocketStream<AggregateTradeStreamResponse>}
|
|
2578
|
+
* @throws {RequiredError}
|
|
2579
|
+
* @memberof ApiInterface
|
|
2580
|
+
*/
|
|
2581
|
+
aggregateTradeStream(requestParameters: AggregateTradeStreamRequest): WebsocketStream<AggregateTradeStreamResponse>;
|
|
2582
|
+
/**
|
|
2583
|
+
* Pushes best bid/ask updates for all symbols.
|
|
2584
|
+
*
|
|
2585
|
+
* @summary All Book Ticker Stream
|
|
2586
|
+
* @param {AllBookTickerStreamRequest} requestParameters Request parameters.
|
|
2587
|
+
*
|
|
2588
|
+
* @returns {WebsocketStream<AllBookTickerStreamResponse>}
|
|
2589
|
+
* @throws {RequiredError}
|
|
2590
|
+
* @memberof ApiInterface
|
|
2591
|
+
*/
|
|
2592
|
+
allBookTickerStream(requestParameters?: AllBookTickerStreamRequest): WebsocketStream<AllBookTickerStreamResponse>;
|
|
2593
|
+
/**
|
|
2594
|
+
* Pushes mini ticker statistics for all symbols.
|
|
2595
|
+
*
|
|
2596
|
+
* @summary All Mini Ticker Stream
|
|
2597
|
+
* @param {AllMiniTickerStreamRequest} requestParameters Request parameters.
|
|
2598
|
+
*
|
|
2599
|
+
* @returns {WebsocketStream<AllMiniTickerStreamResponse>}
|
|
2600
|
+
* @throws {RequiredError}
|
|
2601
|
+
* @memberof ApiInterface
|
|
2602
|
+
*/
|
|
2603
|
+
allMiniTickerStream(requestParameters?: AllMiniTickerStreamRequest): WebsocketStream<AllMiniTickerStreamResponse>;
|
|
2604
|
+
/**
|
|
2605
|
+
* Pushes full ticker statistics for all symbols.
|
|
2606
|
+
*
|
|
2607
|
+
* @summary All Ticker Stream
|
|
2608
|
+
* @param {AllTickerStreamRequest} requestParameters Request parameters.
|
|
2609
|
+
*
|
|
2610
|
+
* @returns {WebsocketStream<AllTickerStreamResponse>}
|
|
2611
|
+
* @throws {RequiredError}
|
|
2612
|
+
* @memberof ApiInterface
|
|
2613
|
+
*/
|
|
2614
|
+
allTickerStream(requestParameters?: AllTickerStreamRequest): WebsocketStream<AllTickerStreamResponse>;
|
|
2615
|
+
/**
|
|
2616
|
+
* Pushes 24h ticker-like metrics for all tokens.
|
|
2617
|
+
*
|
|
2618
|
+
* @summary All Tokens 24h Ticker Stream
|
|
2619
|
+
* @param {AllTokens24hTickerStreamRequest} requestParameters Request parameters.
|
|
2620
|
+
*
|
|
2621
|
+
* @returns {WebsocketStream<AllTokens24hTickerStreamResponse>}
|
|
2622
|
+
* @throws {RequiredError}
|
|
2623
|
+
* @memberof ApiInterface
|
|
2624
|
+
*/
|
|
2625
|
+
allTokens24hTickerStream(requestParameters?: AllTokens24hTickerStreamRequest): WebsocketStream<AllTokens24hTickerStreamResponse>;
|
|
2626
|
+
/**
|
|
2627
|
+
* Pushes best bid/ask updates for a symbol.
|
|
2628
|
+
*
|
|
2629
|
+
* @summary Book Ticker Stream
|
|
2630
|
+
* @param {BookTickerStreamRequest} requestParameters Request parameters.
|
|
2631
|
+
*
|
|
2632
|
+
* @returns {WebsocketStream<BookTickerStreamResponse>}
|
|
2633
|
+
* @throws {RequiredError}
|
|
2634
|
+
* @memberof ApiInterface
|
|
2635
|
+
*/
|
|
2636
|
+
bookTickerStream(requestParameters: BookTickerStreamRequest): WebsocketStream<BookTickerStreamResponse>;
|
|
2637
|
+
/**
|
|
2638
|
+
* Pushes kline updates by contractAddress@chainId.
|
|
2639
|
+
*
|
|
2640
|
+
* @summary Contract Kline Stream
|
|
2641
|
+
* @param {ContractKlineStreamRequest} requestParameters Request parameters.
|
|
2642
|
+
*
|
|
2643
|
+
* @returns {WebsocketStream<ContractKlineStreamResponse>}
|
|
2644
|
+
* @throws {RequiredError}
|
|
2645
|
+
* @memberof ApiInterface
|
|
2646
|
+
*/
|
|
2647
|
+
contractKlineStream(requestParameters: ContractKlineStreamRequest): WebsocketStream<ContractKlineStreamResponse>;
|
|
2648
|
+
/**
|
|
2649
|
+
* Returns all available depth, including UI and API orders.
|
|
2650
|
+
*
|
|
2651
|
+
* @summary Full Depth Stream
|
|
2652
|
+
* @param {FullDepthStreamRequest} requestParameters Request parameters.
|
|
2653
|
+
*
|
|
2654
|
+
* @returns {WebsocketStream<FullDepthStreamResponse>}
|
|
2655
|
+
* @throws {RequiredError}
|
|
2656
|
+
* @memberof ApiInterface
|
|
2657
|
+
*/
|
|
2658
|
+
fullDepthStream(requestParameters: FullDepthStreamRequest): WebsocketStream<FullDepthStreamResponse>;
|
|
2659
|
+
/**
|
|
2660
|
+
* Pushes kline updates for a symbol.
|
|
2661
|
+
*
|
|
2662
|
+
* @summary Kline Stream
|
|
2663
|
+
* @param {KlineStreamRequest} requestParameters Request parameters.
|
|
2664
|
+
*
|
|
2665
|
+
* @returns {WebsocketStream<KlineStreamResponse>}
|
|
2666
|
+
* @throws {RequiredError}
|
|
2667
|
+
* @memberof ApiInterface
|
|
2668
|
+
*/
|
|
2669
|
+
klineStream(requestParameters: KlineStreamRequest): WebsocketStream<KlineStreamResponse>;
|
|
2670
|
+
/**
|
|
2671
|
+
* Pushes 24h rolling mini ticker statistics.
|
|
2672
|
+
*
|
|
2673
|
+
* @summary Mini Ticker Stream
|
|
2674
|
+
* @param {MiniTickerStreamRequest} requestParameters Request parameters.
|
|
2675
|
+
*
|
|
2676
|
+
* @returns {WebsocketStream<MiniTickerStreamResponse>}
|
|
2677
|
+
* @throws {RequiredError}
|
|
2678
|
+
* @memberof ApiInterface
|
|
2679
|
+
*/
|
|
2680
|
+
miniTickerStream(requestParameters: MiniTickerStreamRequest): WebsocketStream<MiniTickerStreamResponse>;
|
|
2681
|
+
/**
|
|
2682
|
+
* Pushes partial depth updates (UI orders only).
|
|
2683
|
+
*
|
|
2684
|
+
* @summary Partial Depth Stream
|
|
2685
|
+
* @param {PartialDepthStreamRequest} requestParameters Request parameters.
|
|
2686
|
+
*
|
|
2687
|
+
* @returns {WebsocketStream<PartialDepthStreamResponse>}
|
|
2688
|
+
* @throws {RequiredError}
|
|
2689
|
+
* @memberof ApiInterface
|
|
2690
|
+
*/
|
|
2691
|
+
partialDepthStream(requestParameters: PartialDepthStreamRequest): WebsocketStream<PartialDepthStreamResponse>;
|
|
2692
|
+
/**
|
|
2693
|
+
* Pushes full 24h rolling ticker statistics.
|
|
2694
|
+
*
|
|
2695
|
+
* @summary Ticker Stream
|
|
2696
|
+
* @param {TickerStreamRequest} requestParameters Request parameters.
|
|
2697
|
+
*
|
|
2698
|
+
* @returns {WebsocketStream<TickerStreamResponse>}
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
* @memberof ApiInterface
|
|
2701
|
+
*/
|
|
2702
|
+
tickerStream(requestParameters: TickerStreamRequest): WebsocketStream<TickerStreamResponse>;
|
|
2703
|
+
/**
|
|
2704
|
+
* Pushes raw trade updates for a symbol.
|
|
2705
|
+
*
|
|
2706
|
+
* @summary Trade Stream
|
|
2707
|
+
* @param {TradeStreamRequest} requestParameters Request parameters.
|
|
2708
|
+
*
|
|
2709
|
+
* @returns {WebsocketStream<TradeStreamResponse>}
|
|
2710
|
+
* @throws {RequiredError}
|
|
2711
|
+
* @memberof ApiInterface
|
|
2712
|
+
*/
|
|
2713
|
+
tradeStream(requestParameters: TradeStreamRequest): WebsocketStream<TradeStreamResponse>;
|
|
2714
|
+
}
|
|
2715
|
+
/**
|
|
2716
|
+
* Request parameters for aggregateTradeStream operation in Api.
|
|
2717
|
+
* @interface AggregateTradeStreamRequest
|
|
2718
|
+
*/
|
|
2719
|
+
interface AggregateTradeStreamRequest {
|
|
2720
|
+
/**
|
|
2721
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2722
|
+
* @type {string}
|
|
2723
|
+
* @memberof ApiAggregateTradeStream
|
|
2724
|
+
*/
|
|
2725
|
+
readonly symbol: string;
|
|
2726
|
+
/**
|
|
2727
|
+
* Unique WebSocket request ID.
|
|
2728
|
+
* @type {string}
|
|
2729
|
+
* @memberof ApiAggregateTradeStream
|
|
2730
|
+
*/
|
|
2731
|
+
readonly id?: string;
|
|
2732
|
+
}
|
|
2733
|
+
/**
|
|
2734
|
+
* Request parameters for allBookTickerStream operation in Api.
|
|
2735
|
+
* @interface AllBookTickerStreamRequest
|
|
2736
|
+
*/
|
|
2737
|
+
interface AllBookTickerStreamRequest {
|
|
2738
|
+
/**
|
|
2739
|
+
* Unique WebSocket request ID.
|
|
2740
|
+
* @type {string}
|
|
2741
|
+
* @memberof ApiAllBookTickerStream
|
|
2742
|
+
*/
|
|
2743
|
+
readonly id?: string;
|
|
2744
|
+
}
|
|
2745
|
+
/**
|
|
2746
|
+
* Request parameters for allMiniTickerStream operation in Api.
|
|
2747
|
+
* @interface AllMiniTickerStreamRequest
|
|
2748
|
+
*/
|
|
2749
|
+
interface AllMiniTickerStreamRequest {
|
|
2750
|
+
/**
|
|
2751
|
+
* Unique WebSocket request ID.
|
|
2752
|
+
* @type {string}
|
|
2753
|
+
* @memberof ApiAllMiniTickerStream
|
|
2754
|
+
*/
|
|
2755
|
+
readonly id?: string;
|
|
2756
|
+
}
|
|
2757
|
+
/**
|
|
2758
|
+
* Request parameters for allTickerStream operation in Api.
|
|
2759
|
+
* @interface AllTickerStreamRequest
|
|
2760
|
+
*/
|
|
2761
|
+
interface AllTickerStreamRequest {
|
|
2762
|
+
/**
|
|
2763
|
+
* Unique WebSocket request ID.
|
|
2764
|
+
* @type {string}
|
|
2765
|
+
* @memberof ApiAllTickerStream
|
|
2766
|
+
*/
|
|
2767
|
+
readonly id?: string;
|
|
2768
|
+
}
|
|
2769
|
+
/**
|
|
2770
|
+
* Request parameters for allTokens24hTickerStream operation in Api.
|
|
2771
|
+
* @interface AllTokens24hTickerStreamRequest
|
|
2772
|
+
*/
|
|
2773
|
+
interface AllTokens24hTickerStreamRequest {
|
|
2774
|
+
/**
|
|
2775
|
+
* Unique WebSocket request ID.
|
|
2776
|
+
* @type {string}
|
|
2777
|
+
* @memberof ApiAllTokens24hTickerStream
|
|
2778
|
+
*/
|
|
2779
|
+
readonly id?: string;
|
|
2780
|
+
}
|
|
2781
|
+
/**
|
|
2782
|
+
* Request parameters for bookTickerStream operation in Api.
|
|
2783
|
+
* @interface BookTickerStreamRequest
|
|
2784
|
+
*/
|
|
2785
|
+
interface BookTickerStreamRequest {
|
|
2786
|
+
/**
|
|
2787
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2788
|
+
* @type {string}
|
|
2789
|
+
* @memberof ApiBookTickerStream
|
|
2790
|
+
*/
|
|
2791
|
+
readonly symbol: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* Unique WebSocket request ID.
|
|
2794
|
+
* @type {string}
|
|
2795
|
+
* @memberof ApiBookTickerStream
|
|
2796
|
+
*/
|
|
2797
|
+
readonly id?: string;
|
|
2798
|
+
}
|
|
2799
|
+
/**
|
|
2800
|
+
* Request parameters for contractKlineStream operation in Api.
|
|
2801
|
+
* @interface ContractKlineStreamRequest
|
|
2802
|
+
*/
|
|
2803
|
+
interface ContractKlineStreamRequest {
|
|
2804
|
+
/**
|
|
2805
|
+
* Contract address.
|
|
2806
|
+
* @type {string}
|
|
2807
|
+
* @memberof ApiContractKlineStream
|
|
2808
|
+
*/
|
|
2809
|
+
readonly contractAddress: string;
|
|
2810
|
+
/**
|
|
2811
|
+
* Chain ID.
|
|
2812
|
+
* @type {string}
|
|
2813
|
+
* @memberof ApiContractKlineStream
|
|
2814
|
+
*/
|
|
2815
|
+
readonly chainId: string;
|
|
2816
|
+
/**
|
|
2817
|
+
* Kline interval.
|
|
2818
|
+
* @type {'1s' | '1m' | '5m' | '15m' | '1h' | '4h' | '1d'}
|
|
2819
|
+
* @memberof ApiContractKlineStream
|
|
2820
|
+
*/
|
|
2821
|
+
readonly interval: ContractKlineStreamIntervalEnum;
|
|
2822
|
+
/**
|
|
2823
|
+
* Unique WebSocket request ID.
|
|
2824
|
+
* @type {string}
|
|
2825
|
+
* @memberof ApiContractKlineStream
|
|
2826
|
+
*/
|
|
2827
|
+
readonly id?: string;
|
|
2828
|
+
}
|
|
2829
|
+
/**
|
|
2830
|
+
* Request parameters for fullDepthStream operation in Api.
|
|
2831
|
+
* @interface FullDepthStreamRequest
|
|
2832
|
+
*/
|
|
2833
|
+
interface FullDepthStreamRequest {
|
|
2834
|
+
/**
|
|
2835
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2836
|
+
* @type {string}
|
|
2837
|
+
* @memberof ApiFullDepthStream
|
|
2838
|
+
*/
|
|
2839
|
+
readonly symbol: string;
|
|
2840
|
+
/**
|
|
2841
|
+
* Update interval.
|
|
2842
|
+
* @type {'0ms' | '100ms' | '500ms'}
|
|
2843
|
+
* @memberof ApiFullDepthStream
|
|
2844
|
+
*/
|
|
2845
|
+
readonly interval: FullDepthStreamIntervalEnum;
|
|
2846
|
+
/**
|
|
2847
|
+
* Unique WebSocket request ID.
|
|
2848
|
+
* @type {string}
|
|
2849
|
+
* @memberof ApiFullDepthStream
|
|
2850
|
+
*/
|
|
2851
|
+
readonly id?: string;
|
|
2852
|
+
}
|
|
2853
|
+
/**
|
|
2854
|
+
* Request parameters for klineStream operation in Api.
|
|
2855
|
+
* @interface KlineStreamRequest
|
|
2856
|
+
*/
|
|
2857
|
+
interface KlineStreamRequest {
|
|
2858
|
+
/**
|
|
2859
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2860
|
+
* @type {string}
|
|
2861
|
+
* @memberof ApiKlineStream
|
|
2862
|
+
*/
|
|
2863
|
+
readonly symbol: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* Kline interval.
|
|
2866
|
+
* @type {'1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '8h' | '12h' | '1d' | '3d' | '1w' | '1M'}
|
|
2867
|
+
* @memberof ApiKlineStream
|
|
2868
|
+
*/
|
|
2869
|
+
readonly interval: KlineStreamIntervalEnum;
|
|
2870
|
+
/**
|
|
2871
|
+
* Unique WebSocket request ID.
|
|
2872
|
+
* @type {string}
|
|
2873
|
+
* @memberof ApiKlineStream
|
|
2874
|
+
*/
|
|
2875
|
+
readonly id?: string;
|
|
2876
|
+
}
|
|
2877
|
+
/**
|
|
2878
|
+
* Request parameters for miniTickerStream operation in Api.
|
|
2879
|
+
* @interface MiniTickerStreamRequest
|
|
2880
|
+
*/
|
|
2881
|
+
interface MiniTickerStreamRequest {
|
|
2882
|
+
/**
|
|
2883
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2884
|
+
* @type {string}
|
|
2885
|
+
* @memberof ApiMiniTickerStream
|
|
2886
|
+
*/
|
|
2887
|
+
readonly symbol: string;
|
|
2888
|
+
/**
|
|
2889
|
+
* Unique WebSocket request ID.
|
|
2890
|
+
* @type {string}
|
|
2891
|
+
* @memberof ApiMiniTickerStream
|
|
2892
|
+
*/
|
|
2893
|
+
readonly id?: string;
|
|
2894
|
+
}
|
|
2895
|
+
/**
|
|
2896
|
+
* Request parameters for partialDepthStream operation in Api.
|
|
2897
|
+
* @interface PartialDepthStreamRequest
|
|
2898
|
+
*/
|
|
2899
|
+
interface PartialDepthStreamRequest {
|
|
2900
|
+
/**
|
|
2901
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2902
|
+
* @type {string}
|
|
2903
|
+
* @memberof ApiPartialDepthStream
|
|
2904
|
+
*/
|
|
2905
|
+
readonly symbol: string;
|
|
2906
|
+
/**
|
|
2907
|
+
* Depth levels.
|
|
2908
|
+
* @type {'5' | '10' | '20'}
|
|
2909
|
+
* @memberof ApiPartialDepthStream
|
|
2910
|
+
*/
|
|
2911
|
+
readonly levels: PartialDepthStreamLevelsEnum;
|
|
2912
|
+
/**
|
|
2913
|
+
* Update interval.
|
|
2914
|
+
* @type {'0ms' | '100ms' | '500ms'}
|
|
2915
|
+
* @memberof ApiPartialDepthStream
|
|
2916
|
+
*/
|
|
2917
|
+
readonly interval: PartialDepthStreamIntervalEnum;
|
|
2918
|
+
/**
|
|
2919
|
+
* Unique WebSocket request ID.
|
|
2920
|
+
* @type {string}
|
|
2921
|
+
* @memberof ApiPartialDepthStream
|
|
2922
|
+
*/
|
|
2923
|
+
readonly id?: string;
|
|
2924
|
+
}
|
|
2925
|
+
/**
|
|
2926
|
+
* Request parameters for tickerStream operation in Api.
|
|
2927
|
+
* @interface TickerStreamRequest
|
|
2928
|
+
*/
|
|
2929
|
+
interface TickerStreamRequest {
|
|
2930
|
+
/**
|
|
2931
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2932
|
+
* @type {string}
|
|
2933
|
+
* @memberof ApiTickerStream
|
|
2934
|
+
*/
|
|
2935
|
+
readonly symbol: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Unique WebSocket request ID.
|
|
2938
|
+
* @type {string}
|
|
2939
|
+
* @memberof ApiTickerStream
|
|
2940
|
+
*/
|
|
2941
|
+
readonly id?: string;
|
|
2942
|
+
}
|
|
2943
|
+
/**
|
|
2944
|
+
* Request parameters for tradeStream operation in Api.
|
|
2945
|
+
* @interface TradeStreamRequest
|
|
2946
|
+
*/
|
|
2947
|
+
interface TradeStreamRequest {
|
|
2948
|
+
/**
|
|
2949
|
+
* Symbol to subscribe, in lowercase stream format.
|
|
2950
|
+
* @type {string}
|
|
2951
|
+
* @memberof ApiTradeStream
|
|
2952
|
+
*/
|
|
2953
|
+
readonly symbol: string;
|
|
2954
|
+
/**
|
|
2955
|
+
* Unique WebSocket request ID.
|
|
2956
|
+
* @type {string}
|
|
2957
|
+
* @memberof ApiTradeStream
|
|
2958
|
+
*/
|
|
2959
|
+
readonly id?: string;
|
|
2960
|
+
}
|
|
2961
|
+
/**
|
|
2962
|
+
* Api - interface
|
|
2963
|
+
* @class Api
|
|
2964
|
+
* @extends {WebsocketStreamsBase}
|
|
2965
|
+
*/
|
|
2966
|
+
declare class Api implements ApiInterface {
|
|
2967
|
+
private readonly websocketBase;
|
|
2968
|
+
private localVarParamCreator;
|
|
2969
|
+
constructor(websocketBase: WebsocketStreamsBase);
|
|
2970
|
+
/**
|
|
2971
|
+
* Pushes aggregate trade updates for a symbol.
|
|
2972
|
+
*
|
|
2973
|
+
* @summary Aggregate Trade Stream
|
|
2974
|
+
* @param {AggregateTradeStreamRequest} requestParameters Request parameters.
|
|
2975
|
+
* @returns {WebsocketStream<AggregateTradeStreamResponse>}
|
|
2976
|
+
* @throws {RequiredError}
|
|
2977
|
+
* @memberof Api
|
|
2978
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#aggregate-trade-stream Binance API Documentation}
|
|
2979
|
+
*/
|
|
2980
|
+
aggregateTradeStream(requestParameters: AggregateTradeStreamRequest): WebsocketStream<AggregateTradeStreamResponse>;
|
|
2981
|
+
/**
|
|
2982
|
+
* Pushes best bid/ask updates for all symbols.
|
|
2983
|
+
*
|
|
2984
|
+
* @summary All Book Ticker Stream
|
|
2985
|
+
* @param {AllBookTickerStreamRequest} requestParameters Request parameters.
|
|
2986
|
+
* @returns {WebsocketStream<AllBookTickerStreamResponse>}
|
|
2987
|
+
* @throws {RequiredError}
|
|
2988
|
+
* @memberof Api
|
|
2989
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-book-ticker-stream Binance API Documentation}
|
|
2990
|
+
*/
|
|
2991
|
+
allBookTickerStream(requestParameters?: AllBookTickerStreamRequest): WebsocketStream<AllBookTickerStreamResponse>;
|
|
2992
|
+
/**
|
|
2993
|
+
* Pushes mini ticker statistics for all symbols.
|
|
2994
|
+
*
|
|
2995
|
+
* @summary All Mini Ticker Stream
|
|
2996
|
+
* @param {AllMiniTickerStreamRequest} requestParameters Request parameters.
|
|
2997
|
+
* @returns {WebsocketStream<AllMiniTickerStreamResponse>}
|
|
2998
|
+
* @throws {RequiredError}
|
|
2999
|
+
* @memberof Api
|
|
3000
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-mini-ticker-stream Binance API Documentation}
|
|
3001
|
+
*/
|
|
3002
|
+
allMiniTickerStream(requestParameters?: AllMiniTickerStreamRequest): WebsocketStream<AllMiniTickerStreamResponse>;
|
|
3003
|
+
/**
|
|
3004
|
+
* Pushes full ticker statistics for all symbols.
|
|
3005
|
+
*
|
|
3006
|
+
* @summary All Ticker Stream
|
|
3007
|
+
* @param {AllTickerStreamRequest} requestParameters Request parameters.
|
|
3008
|
+
* @returns {WebsocketStream<AllTickerStreamResponse>}
|
|
3009
|
+
* @throws {RequiredError}
|
|
3010
|
+
* @memberof Api
|
|
3011
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-ticker-stream Binance API Documentation}
|
|
3012
|
+
*/
|
|
3013
|
+
allTickerStream(requestParameters?: AllTickerStreamRequest): WebsocketStream<AllTickerStreamResponse>;
|
|
3014
|
+
/**
|
|
3015
|
+
* Pushes 24h ticker-like metrics for all tokens.
|
|
3016
|
+
*
|
|
3017
|
+
* @summary All Tokens 24h Ticker Stream
|
|
3018
|
+
* @param {AllTokens24hTickerStreamRequest} requestParameters Request parameters.
|
|
3019
|
+
* @returns {WebsocketStream<AllTokens24hTickerStreamResponse>}
|
|
3020
|
+
* @throws {RequiredError}
|
|
3021
|
+
* @memberof Api
|
|
3022
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-tokens24h-ticker-stream Binance API Documentation}
|
|
3023
|
+
*/
|
|
3024
|
+
allTokens24hTickerStream(requestParameters?: AllTokens24hTickerStreamRequest): WebsocketStream<AllTokens24hTickerStreamResponse>;
|
|
3025
|
+
/**
|
|
3026
|
+
* Pushes best bid/ask updates for a symbol.
|
|
3027
|
+
*
|
|
3028
|
+
* @summary Book Ticker Stream
|
|
3029
|
+
* @param {BookTickerStreamRequest} requestParameters Request parameters.
|
|
3030
|
+
* @returns {WebsocketStream<BookTickerStreamResponse>}
|
|
3031
|
+
* @throws {RequiredError}
|
|
3032
|
+
* @memberof Api
|
|
3033
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#book-ticker-stream Binance API Documentation}
|
|
3034
|
+
*/
|
|
3035
|
+
bookTickerStream(requestParameters: BookTickerStreamRequest): WebsocketStream<BookTickerStreamResponse>;
|
|
3036
|
+
/**
|
|
3037
|
+
* Pushes kline updates by contractAddress@chainId.
|
|
3038
|
+
*
|
|
3039
|
+
* @summary Contract Kline Stream
|
|
3040
|
+
* @param {ContractKlineStreamRequest} requestParameters Request parameters.
|
|
3041
|
+
* @returns {WebsocketStream<ContractKlineStreamResponse>}
|
|
3042
|
+
* @throws {RequiredError}
|
|
3043
|
+
* @memberof Api
|
|
3044
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#contract-kline-stream Binance API Documentation}
|
|
3045
|
+
*/
|
|
3046
|
+
contractKlineStream(requestParameters: ContractKlineStreamRequest): WebsocketStream<ContractKlineStreamResponse>;
|
|
3047
|
+
/**
|
|
3048
|
+
* Returns all available depth, including UI and API orders.
|
|
3049
|
+
*
|
|
3050
|
+
* @summary Full Depth Stream
|
|
3051
|
+
* @param {FullDepthStreamRequest} requestParameters Request parameters.
|
|
3052
|
+
* @returns {WebsocketStream<FullDepthStreamResponse>}
|
|
3053
|
+
* @throws {RequiredError}
|
|
3054
|
+
* @memberof Api
|
|
3055
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#full-depth-stream Binance API Documentation}
|
|
3056
|
+
*/
|
|
3057
|
+
fullDepthStream(requestParameters: FullDepthStreamRequest): WebsocketStream<FullDepthStreamResponse>;
|
|
3058
|
+
/**
|
|
3059
|
+
* Pushes kline updates for a symbol.
|
|
3060
|
+
*
|
|
3061
|
+
* @summary Kline Stream
|
|
3062
|
+
* @param {KlineStreamRequest} requestParameters Request parameters.
|
|
3063
|
+
* @returns {WebsocketStream<KlineStreamResponse>}
|
|
3064
|
+
* @throws {RequiredError}
|
|
3065
|
+
* @memberof Api
|
|
3066
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#kline-stream Binance API Documentation}
|
|
3067
|
+
*/
|
|
3068
|
+
klineStream(requestParameters: KlineStreamRequest): WebsocketStream<KlineStreamResponse>;
|
|
3069
|
+
/**
|
|
3070
|
+
* Pushes 24h rolling mini ticker statistics.
|
|
3071
|
+
*
|
|
3072
|
+
* @summary Mini Ticker Stream
|
|
3073
|
+
* @param {MiniTickerStreamRequest} requestParameters Request parameters.
|
|
3074
|
+
* @returns {WebsocketStream<MiniTickerStreamResponse>}
|
|
3075
|
+
* @throws {RequiredError}
|
|
3076
|
+
* @memberof Api
|
|
3077
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#mini-ticker-stream Binance API Documentation}
|
|
3078
|
+
*/
|
|
3079
|
+
miniTickerStream(requestParameters: MiniTickerStreamRequest): WebsocketStream<MiniTickerStreamResponse>;
|
|
3080
|
+
/**
|
|
3081
|
+
* Pushes partial depth updates (UI orders only).
|
|
3082
|
+
*
|
|
3083
|
+
* @summary Partial Depth Stream
|
|
3084
|
+
* @param {PartialDepthStreamRequest} requestParameters Request parameters.
|
|
3085
|
+
* @returns {WebsocketStream<PartialDepthStreamResponse>}
|
|
3086
|
+
* @throws {RequiredError}
|
|
3087
|
+
* @memberof Api
|
|
3088
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#partial-depth-stream Binance API Documentation}
|
|
3089
|
+
*/
|
|
3090
|
+
partialDepthStream(requestParameters: PartialDepthStreamRequest): WebsocketStream<PartialDepthStreamResponse>;
|
|
3091
|
+
/**
|
|
3092
|
+
* Pushes full 24h rolling ticker statistics.
|
|
3093
|
+
*
|
|
3094
|
+
* @summary Ticker Stream
|
|
3095
|
+
* @param {TickerStreamRequest} requestParameters Request parameters.
|
|
3096
|
+
* @returns {WebsocketStream<TickerStreamResponse>}
|
|
3097
|
+
* @throws {RequiredError}
|
|
3098
|
+
* @memberof Api
|
|
3099
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#ticker-stream Binance API Documentation}
|
|
3100
|
+
*/
|
|
3101
|
+
tickerStream(requestParameters: TickerStreamRequest): WebsocketStream<TickerStreamResponse>;
|
|
3102
|
+
/**
|
|
3103
|
+
* Pushes raw trade updates for a symbol.
|
|
3104
|
+
*
|
|
3105
|
+
* @summary Trade Stream
|
|
3106
|
+
* @param {TradeStreamRequest} requestParameters Request parameters.
|
|
3107
|
+
* @returns {WebsocketStream<TradeStreamResponse>}
|
|
3108
|
+
* @throws {RequiredError}
|
|
3109
|
+
* @memberof Api
|
|
3110
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#trade-stream Binance API Documentation}
|
|
3111
|
+
*/
|
|
3112
|
+
tradeStream(requestParameters: TradeStreamRequest): WebsocketStream<TradeStreamResponse>;
|
|
3113
|
+
}
|
|
3114
|
+
declare enum ContractKlineStreamIntervalEnum {
|
|
3115
|
+
INTERVAL_1s = "1s",
|
|
3116
|
+
INTERVAL_1m = "1m",
|
|
3117
|
+
INTERVAL_5m = "5m",
|
|
3118
|
+
INTERVAL_15m = "15m",
|
|
3119
|
+
INTERVAL_1h = "1h",
|
|
3120
|
+
INTERVAL_4h = "4h",
|
|
3121
|
+
INTERVAL_1d = "1d",
|
|
3122
|
+
}
|
|
3123
|
+
declare enum FullDepthStreamIntervalEnum {
|
|
3124
|
+
INTERVAL_0ms = "0ms",
|
|
3125
|
+
INTERVAL_100ms = "100ms",
|
|
3126
|
+
INTERVAL_500ms = "500ms",
|
|
3127
|
+
}
|
|
3128
|
+
declare enum KlineStreamIntervalEnum {
|
|
3129
|
+
INTERVAL_1m = "1m",
|
|
3130
|
+
INTERVAL_3m = "3m",
|
|
3131
|
+
INTERVAL_5m = "5m",
|
|
3132
|
+
INTERVAL_15m = "15m",
|
|
3133
|
+
INTERVAL_30m = "30m",
|
|
3134
|
+
INTERVAL_1h = "1h",
|
|
3135
|
+
INTERVAL_2h = "2h",
|
|
3136
|
+
INTERVAL_4h = "4h",
|
|
3137
|
+
INTERVAL_6h = "6h",
|
|
3138
|
+
INTERVAL_8h = "8h",
|
|
3139
|
+
INTERVAL_12h = "12h",
|
|
3140
|
+
INTERVAL_1d = "1d",
|
|
3141
|
+
INTERVAL_3d = "3d",
|
|
3142
|
+
INTERVAL_1w = "1w",
|
|
3143
|
+
INTERVAL_1M = "1M",
|
|
3144
|
+
}
|
|
3145
|
+
declare enum PartialDepthStreamLevelsEnum {
|
|
3146
|
+
LEVELS_5 = "5",
|
|
3147
|
+
LEVELS_10 = "10",
|
|
3148
|
+
LEVELS_20 = "20",
|
|
3149
|
+
}
|
|
3150
|
+
declare enum PartialDepthStreamIntervalEnum {
|
|
3151
|
+
INTERVAL_0ms = "0ms",
|
|
3152
|
+
INTERVAL_100ms = "100ms",
|
|
3153
|
+
INTERVAL_500ms = "500ms",
|
|
3154
|
+
}
|
|
3155
|
+
//#endregion
|
|
3156
|
+
//#region src/websocket-streams/websocket-streams-connection.d.ts
|
|
3157
|
+
declare class WebsocketStreamsConnection {
|
|
3158
|
+
private websocketBase;
|
|
3159
|
+
private api;
|
|
3160
|
+
constructor(websocketBase: WebsocketStreamsBase);
|
|
3161
|
+
/**
|
|
3162
|
+
* Adds an event listener for the specified WebSocket event.
|
|
3163
|
+
* @param event - The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
|
|
3164
|
+
* @param listener - The callback function to be executed when the event is triggered. The function can accept any number of arguments.
|
|
3165
|
+
*/
|
|
3166
|
+
on(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void;
|
|
3167
|
+
/**
|
|
3168
|
+
* Removes an event listener for the specified WebSocket event.
|
|
3169
|
+
* @param event - The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
|
|
3170
|
+
* @param listener - The callback function that was previously added as the event listener.
|
|
3171
|
+
*/
|
|
3172
|
+
off(event: 'open' | 'message' | 'error' | 'close' | 'ping' | 'pong', listener: (...args: any[]) => void): void;
|
|
3173
|
+
/**
|
|
3174
|
+
* Disconnects from the WebSocket server.
|
|
3175
|
+
* If there is no active connection, a warning is logged.
|
|
3176
|
+
* Otherwise, all connections in the connection pool are closed gracefully,
|
|
3177
|
+
* and a message is logged indicating that the connection has been disconnected.
|
|
3178
|
+
* @returns A Promise that resolves when all connections have been closed.
|
|
3179
|
+
* @throws Error if the WebSocket client is not set.
|
|
3180
|
+
*/
|
|
3181
|
+
disconnect(): Promise<void>;
|
|
3182
|
+
/**
|
|
3183
|
+
* Checks if the WebSocket connection is currently open.
|
|
3184
|
+
* @returns `true` if the connection is open, `false` otherwise.
|
|
3185
|
+
*/
|
|
3186
|
+
isConnected(): boolean;
|
|
3187
|
+
/**
|
|
3188
|
+
* Sends a ping message to all connected Websocket servers in the pool.
|
|
3189
|
+
* If no connections are ready, a warning is logged.
|
|
3190
|
+
* For each active connection, the ping message is sent, and debug logs provide details.
|
|
3191
|
+
* @throws Error if a Websocket client is not set for a connection.
|
|
3192
|
+
*/
|
|
3193
|
+
pingServer(): void;
|
|
3194
|
+
/**
|
|
3195
|
+
* Subscribes to one or multiple WebSocket streams
|
|
3196
|
+
* Handles both single and pool modes
|
|
3197
|
+
* @param stream Single stream name or array of stream names to subscribe to
|
|
3198
|
+
* @param id Optional subscription ID
|
|
3199
|
+
* @returns void
|
|
3200
|
+
*/
|
|
3201
|
+
subscribe(stream: string | string[], id?: number): void;
|
|
3202
|
+
/**
|
|
3203
|
+
* Unsubscribes from one or multiple WebSocket streams
|
|
3204
|
+
* Handles both single and pool modes
|
|
3205
|
+
* @param stream Single stream name or array of stream names to unsubscribe from
|
|
3206
|
+
* @param id Optional unsubscription ID
|
|
3207
|
+
* @returns void
|
|
3208
|
+
*/
|
|
3209
|
+
unsubscribe(stream: string | string[], id?: number): void;
|
|
3210
|
+
/**
|
|
3211
|
+
* Checks if the WebSocket connection is subscribed to the specified stream.
|
|
3212
|
+
* @param stream The name of the WebSocket stream to check.
|
|
3213
|
+
* @returns `true` if the connection is subscribed to the stream, `false` otherwise.
|
|
3214
|
+
*/
|
|
3215
|
+
isSubscribed(stream: string): boolean;
|
|
3216
|
+
/**
|
|
3217
|
+
* Pushes aggregate trade updates for a symbol.
|
|
3218
|
+
*
|
|
3219
|
+
* @summary Aggregate Trade Stream
|
|
3220
|
+
* @param {AggregateTradeStreamRequest} requestParameters Request parameters.
|
|
3221
|
+
*
|
|
3222
|
+
* @returns {WebsocketStream<AggregateTradeStreamResponse>}
|
|
3223
|
+
* @throws {RequiredError}
|
|
3224
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#aggregate-trade-stream Binance API Documentation}
|
|
3225
|
+
*/
|
|
3226
|
+
aggregateTradeStream(requestParameters: AggregateTradeStreamRequest): WebsocketStream<AggregateTradeStreamResponse>;
|
|
3227
|
+
/**
|
|
3228
|
+
* Pushes best bid/ask updates for all symbols.
|
|
3229
|
+
*
|
|
3230
|
+
* @summary All Book Ticker Stream
|
|
3231
|
+
* @param {AllBookTickerStreamRequest} requestParameters Request parameters.
|
|
3232
|
+
*
|
|
3233
|
+
* @returns {WebsocketStream<AllBookTickerStreamResponse>}
|
|
3234
|
+
* @throws {RequiredError}
|
|
3235
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-book-ticker-stream Binance API Documentation}
|
|
3236
|
+
*/
|
|
3237
|
+
allBookTickerStream(requestParameters?: AllBookTickerStreamRequest): WebsocketStream<AllBookTickerStreamResponse>;
|
|
3238
|
+
/**
|
|
3239
|
+
* Pushes mini ticker statistics for all symbols.
|
|
3240
|
+
*
|
|
3241
|
+
* @summary All Mini Ticker Stream
|
|
3242
|
+
* @param {AllMiniTickerStreamRequest} requestParameters Request parameters.
|
|
3243
|
+
*
|
|
3244
|
+
* @returns {WebsocketStream<AllMiniTickerStreamResponse>}
|
|
3245
|
+
* @throws {RequiredError}
|
|
3246
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-mini-ticker-stream Binance API Documentation}
|
|
3247
|
+
*/
|
|
3248
|
+
allMiniTickerStream(requestParameters?: AllMiniTickerStreamRequest): WebsocketStream<AllMiniTickerStreamResponse>;
|
|
3249
|
+
/**
|
|
3250
|
+
* Pushes full ticker statistics for all symbols.
|
|
3251
|
+
*
|
|
3252
|
+
* @summary All Ticker Stream
|
|
3253
|
+
* @param {AllTickerStreamRequest} requestParameters Request parameters.
|
|
3254
|
+
*
|
|
3255
|
+
* @returns {WebsocketStream<AllTickerStreamResponse>}
|
|
3256
|
+
* @throws {RequiredError}
|
|
3257
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-ticker-stream Binance API Documentation}
|
|
3258
|
+
*/
|
|
3259
|
+
allTickerStream(requestParameters?: AllTickerStreamRequest): WebsocketStream<AllTickerStreamResponse>;
|
|
3260
|
+
/**
|
|
3261
|
+
* Pushes 24h ticker-like metrics for all tokens.
|
|
3262
|
+
*
|
|
3263
|
+
* @summary All Tokens 24h Ticker Stream
|
|
3264
|
+
* @param {AllTokens24hTickerStreamRequest} requestParameters Request parameters.
|
|
3265
|
+
*
|
|
3266
|
+
* @returns {WebsocketStream<AllTokens24hTickerStreamResponse>}
|
|
3267
|
+
* @throws {RequiredError}
|
|
3268
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#all-tokens24h-ticker-stream Binance API Documentation}
|
|
3269
|
+
*/
|
|
3270
|
+
allTokens24hTickerStream(requestParameters?: AllTokens24hTickerStreamRequest): WebsocketStream<AllTokens24hTickerStreamResponse>;
|
|
3271
|
+
/**
|
|
3272
|
+
* Pushes best bid/ask updates for a symbol.
|
|
3273
|
+
*
|
|
3274
|
+
* @summary Book Ticker Stream
|
|
3275
|
+
* @param {BookTickerStreamRequest} requestParameters Request parameters.
|
|
3276
|
+
*
|
|
3277
|
+
* @returns {WebsocketStream<BookTickerStreamResponse>}
|
|
3278
|
+
* @throws {RequiredError}
|
|
3279
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#book-ticker-stream Binance API Documentation}
|
|
3280
|
+
*/
|
|
3281
|
+
bookTickerStream(requestParameters: BookTickerStreamRequest): WebsocketStream<BookTickerStreamResponse>;
|
|
3282
|
+
/**
|
|
3283
|
+
* Pushes kline updates by contractAddress@chainId.
|
|
3284
|
+
*
|
|
3285
|
+
* @summary Contract Kline Stream
|
|
3286
|
+
* @param {ContractKlineStreamRequest} requestParameters Request parameters.
|
|
3287
|
+
*
|
|
3288
|
+
* @returns {WebsocketStream<ContractKlineStreamResponse>}
|
|
3289
|
+
* @throws {RequiredError}
|
|
3290
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#contract-kline-stream Binance API Documentation}
|
|
3291
|
+
*/
|
|
3292
|
+
contractKlineStream(requestParameters: ContractKlineStreamRequest): WebsocketStream<ContractKlineStreamResponse>;
|
|
3293
|
+
/**
|
|
3294
|
+
* Returns all available depth, including UI and API orders.
|
|
3295
|
+
*
|
|
3296
|
+
* @summary Full Depth Stream
|
|
3297
|
+
* @param {FullDepthStreamRequest} requestParameters Request parameters.
|
|
3298
|
+
*
|
|
3299
|
+
* @returns {WebsocketStream<FullDepthStreamResponse>}
|
|
3300
|
+
* @throws {RequiredError}
|
|
3301
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#full-depth-stream Binance API Documentation}
|
|
3302
|
+
*/
|
|
3303
|
+
fullDepthStream(requestParameters: FullDepthStreamRequest): WebsocketStream<FullDepthStreamResponse>;
|
|
3304
|
+
/**
|
|
3305
|
+
* Pushes kline updates for a symbol.
|
|
3306
|
+
*
|
|
3307
|
+
* @summary Kline Stream
|
|
3308
|
+
* @param {KlineStreamRequest} requestParameters Request parameters.
|
|
3309
|
+
*
|
|
3310
|
+
* @returns {WebsocketStream<KlineStreamResponse>}
|
|
3311
|
+
* @throws {RequiredError}
|
|
3312
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#kline-stream Binance API Documentation}
|
|
3313
|
+
*/
|
|
3314
|
+
klineStream(requestParameters: KlineStreamRequest): WebsocketStream<KlineStreamResponse>;
|
|
3315
|
+
/**
|
|
3316
|
+
* Pushes 24h rolling mini ticker statistics.
|
|
3317
|
+
*
|
|
3318
|
+
* @summary Mini Ticker Stream
|
|
3319
|
+
* @param {MiniTickerStreamRequest} requestParameters Request parameters.
|
|
3320
|
+
*
|
|
3321
|
+
* @returns {WebsocketStream<MiniTickerStreamResponse>}
|
|
3322
|
+
* @throws {RequiredError}
|
|
3323
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#mini-ticker-stream Binance API Documentation}
|
|
3324
|
+
*/
|
|
3325
|
+
miniTickerStream(requestParameters: MiniTickerStreamRequest): WebsocketStream<MiniTickerStreamResponse>;
|
|
3326
|
+
/**
|
|
3327
|
+
* Pushes partial depth updates (UI orders only).
|
|
3328
|
+
*
|
|
3329
|
+
* @summary Partial Depth Stream
|
|
3330
|
+
* @param {PartialDepthStreamRequest} requestParameters Request parameters.
|
|
3331
|
+
*
|
|
3332
|
+
* @returns {WebsocketStream<PartialDepthStreamResponse>}
|
|
3333
|
+
* @throws {RequiredError}
|
|
3334
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#partial-depth-stream Binance API Documentation}
|
|
3335
|
+
*/
|
|
3336
|
+
partialDepthStream(requestParameters: PartialDepthStreamRequest): WebsocketStream<PartialDepthStreamResponse>;
|
|
3337
|
+
/**
|
|
3338
|
+
* Pushes full 24h rolling ticker statistics.
|
|
3339
|
+
*
|
|
3340
|
+
* @summary Ticker Stream
|
|
3341
|
+
* @param {TickerStreamRequest} requestParameters Request parameters.
|
|
3342
|
+
*
|
|
3343
|
+
* @returns {WebsocketStream<TickerStreamResponse>}
|
|
3344
|
+
* @throws {RequiredError}
|
|
3345
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#ticker-stream Binance API Documentation}
|
|
3346
|
+
*/
|
|
3347
|
+
tickerStream(requestParameters: TickerStreamRequest): WebsocketStream<TickerStreamResponse>;
|
|
3348
|
+
/**
|
|
3349
|
+
* Pushes raw trade updates for a symbol.
|
|
3350
|
+
*
|
|
3351
|
+
* @summary Trade Stream
|
|
3352
|
+
* @param {TradeStreamRequest} requestParameters Request parameters.
|
|
3353
|
+
*
|
|
3354
|
+
* @returns {WebsocketStream<TradeStreamResponse>}
|
|
3355
|
+
* @throws {RequiredError}
|
|
3356
|
+
* @see {@link https://developers.binance.com/en/docs/catalog/advanced-trading-alpha-trading/api/ws-streams/~#trade-stream Binance API Documentation}
|
|
3357
|
+
*/
|
|
3358
|
+
tradeStream(requestParameters: TradeStreamRequest): WebsocketStream<TradeStreamResponse>;
|
|
3359
|
+
}
|
|
3360
|
+
//#endregion
|
|
3361
|
+
//#region src/websocket-streams/websocket-streams.d.ts
|
|
3362
|
+
declare class WebsocketStreams {
|
|
3363
|
+
private configuration;
|
|
3364
|
+
constructor(configuration: ConfigurationWebsocketStreams);
|
|
3365
|
+
/**
|
|
3366
|
+
* Connects to the Binance WebSocket streams and returns a `WebsocketStreamsConnection` instance.
|
|
3367
|
+
*
|
|
3368
|
+
* @param {object} [options] - Optional connection options.
|
|
3369
|
+
* @param {string|string[]} [options.stream] - The stream(s) to connect to.
|
|
3370
|
+
* @param {'single'|'pool'} [options.mode] - The connection mode, either 'single' or 'pool'. Overwrite the `mode` option in the configuration.
|
|
3371
|
+
* @param {number} [options.poolSize] - The number of connections to use in pool mode. Overwrite the `poolSize` option in the configuration.
|
|
3372
|
+
* @returns {Promise<WebsocketStreamsConnection>} - A promise that resolves to a `WebsocketStreamsConnection` instance.
|
|
3373
|
+
*/
|
|
3374
|
+
connect({
|
|
3375
|
+
stream,
|
|
3376
|
+
mode,
|
|
3377
|
+
poolSize
|
|
3378
|
+
}?: {
|
|
3379
|
+
stream?: string | string[];
|
|
3380
|
+
mode?: 'single' | 'pool';
|
|
3381
|
+
poolSize?: number;
|
|
3382
|
+
}): Promise<WebsocketStreamsConnection>;
|
|
3383
|
+
}
|
|
3384
|
+
declare namespace index_d_exports$1 {
|
|
3385
|
+
export { AggregateTradeStreamRequest, AggregateTradeStreamResponse, AllBookTickerStreamRequest, AllBookTickerStreamResponse, AllMiniTickerStreamRequest, AllMiniTickerStreamResponse, AllTickerStreamRequest, AllTickerStreamResponse, AllTokens24hTickerStreamRequest, AllTokens24hTickerStreamResponse, AllTokens24hTickerStreamResponseDInner, Api, ApiInterface, BookTickerStreamRequest, BookTickerStreamResponse, ContractKlineStreamIntervalEnum, ContractKlineStreamRequest, ContractKlineStreamResponse, ContractKlineStreamResponseK, FullDepthStreamIntervalEnum, FullDepthStreamRequest, FullDepthStreamResponse, KlineStreamIntervalEnum, KlineStreamRequest, KlineStreamResponse, KlineStreamResponseK, MiniTickerStreamRequest, MiniTickerStreamResponse, PartialDepthStreamIntervalEnum, PartialDepthStreamLevelsEnum, PartialDepthStreamRequest, PartialDepthStreamResponse, TickerStreamRequest, TickerStreamResponse, TradeStreamRequest, TradeStreamResponse, WebsocketStreams, WebsocketStreamsConnection };
|
|
1210
3386
|
}
|
|
1211
3387
|
//#endregion
|
|
1212
3388
|
//#region src/alpha.d.ts
|
|
1213
3389
|
interface ConfigurationAlpha {
|
|
1214
3390
|
configurationRestAPI?: ConfigurationRestAPI;
|
|
3391
|
+
configurationWebsocketStreams?: ConfigurationWebsocketStreams;
|
|
1215
3392
|
}
|
|
1216
3393
|
declare class Alpha {
|
|
1217
3394
|
restAPI: RestAPI;
|
|
3395
|
+
websocketStreams: WebsocketStreams;
|
|
1218
3396
|
constructor(config: ConfigurationAlpha);
|
|
1219
3397
|
}
|
|
1220
3398
|
//#endregion
|
|
1221
|
-
export { ALPHA_REST_API_PROD_URL, Alpha, index_d_exports as AlphaRestAPI, BadRequestError, type ConfigurationAlpha, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
|
|
3399
|
+
export { ALPHA_REST_API_PROD_URL, ALPHA_WS_STREAMS_PROD_URL, Alpha, index_d_exports as AlphaRestAPI, index_d_exports$1 as AlphaWebsocketStreams, BadRequestError, type ConfigurationAlpha, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
|
|
1222
3400
|
//# sourceMappingURL=index.d.ts.map
|