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