@reyaxyz/api-v2-sdk 0.301.1
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/LICENSE.md +1 -0
- package/dist/index.js +47 -0
- package/dist/index.js.map +1 -0
- package/dist/rest/apis/MarketDataApi.js +393 -0
- package/dist/rest/apis/MarketDataApi.js.map +1 -0
- package/dist/rest/apis/OrderEntryApi.js +199 -0
- package/dist/rest/apis/OrderEntryApi.js.map +1 -0
- package/dist/rest/apis/ReferenceDataApi.js +308 -0
- package/dist/rest/apis/ReferenceDataApi.js.map +1 -0
- package/dist/rest/apis/WalletDataApi.js +387 -0
- package/dist/rest/apis/WalletDataApi.js.map +1 -0
- package/dist/rest/apis/index.js +23 -0
- package/dist/rest/apis/index.js.map +1 -0
- package/dist/rest/index.js +22 -0
- package/dist/rest/index.js.map +1 -0
- package/dist/rest/models/index.js +222 -0
- package/dist/rest/models/index.js.map +1 -0
- package/dist/rest/runtime.js +551 -0
- package/dist/rest/runtime.js.map +1 -0
- package/dist/types/index.d.ts +14 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/rest/apis/MarketDataApi.d.ts +104 -0
- package/dist/types/rest/apis/MarketDataApi.d.ts.map +1 -0
- package/dist/types/rest/apis/OrderEntryApi.d.ts +45 -0
- package/dist/types/rest/apis/OrderEntryApi.d.ts.map +1 -0
- package/dist/types/rest/apis/ReferenceDataApi.d.ts +59 -0
- package/dist/types/rest/apis/ReferenceDataApi.d.ts.map +1 -0
- package/dist/types/rest/apis/WalletDataApi.d.ts +97 -0
- package/dist/types/rest/apis/WalletDataApi.d.ts.map +1 -0
- package/dist/types/rest/apis/index.d.ts +5 -0
- package/dist/types/rest/apis/index.d.ts.map +1 -0
- package/dist/types/rest/index.d.ts +4 -0
- package/dist/types/rest/index.d.ts.map +1 -0
- package/dist/types/rest/models/index.d.ts +1346 -0
- package/dist/types/rest/models/index.d.ts.map +1 -0
- package/dist/types/rest/runtime.d.ts +181 -0
- package/dist/types/rest/runtime.d.ts.map +1 -0
- package/dist/types/websocket/types.d.ts +173 -0
- package/dist/types/websocket/types.d.ts.map +1 -0
- package/dist/websocket/types.js +61 -0
- package/dist/websocket/types.js.map +1 -0
- package/package.json +43 -0
- package/rest/apis/MarketDataApi.ts +261 -0
- package/rest/apis/OrderEntryApi.ts +109 -0
- package/rest/apis/ReferenceDataApi.ts +162 -0
- package/rest/apis/WalletDataApi.ts +265 -0
- package/rest/apis/index.ts +6 -0
- package/rest/index.ts +5 -0
- package/rest/models/index.ts +1405 -0
- package/rest/runtime.ts +421 -0
- package/websocket/types.ts +226 -0
|
@@ -0,0 +1,1346 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @export
|
|
4
|
+
* @interface Account
|
|
5
|
+
*/
|
|
6
|
+
export interface Account {
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @type {number}
|
|
10
|
+
* @memberof Account
|
|
11
|
+
*/
|
|
12
|
+
accountId: number;
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @type {string}
|
|
16
|
+
* @memberof Account
|
|
17
|
+
*/
|
|
18
|
+
name: string;
|
|
19
|
+
/**
|
|
20
|
+
* Last update timestamp (milliseconds)
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof Account
|
|
23
|
+
*/
|
|
24
|
+
lastUpdateAt: number;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface AssetDefinition
|
|
30
|
+
*/
|
|
31
|
+
export interface AssetDefinition {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof AssetDefinition
|
|
36
|
+
*/
|
|
37
|
+
asset: string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof AssetDefinition
|
|
42
|
+
*/
|
|
43
|
+
spotMarketSymbol: string;
|
|
44
|
+
/**
|
|
45
|
+
* Notional discount to the value of a collateral when used to satisfy the margin requirements; it does not imply any token conversion, but is rather an accounting adjustment.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof AssetDefinition
|
|
48
|
+
*/
|
|
49
|
+
priceHaircut: string;
|
|
50
|
+
/**
|
|
51
|
+
* Discount in the token price when liquidating collateral.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof AssetDefinition
|
|
54
|
+
*/
|
|
55
|
+
liquidationDiscount: string;
|
|
56
|
+
/**
|
|
57
|
+
* Configuration timestamp (milliseconds)
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof AssetDefinition
|
|
60
|
+
*/
|
|
61
|
+
timestamp: number;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @export
|
|
66
|
+
* @interface CancelOrderRequest
|
|
67
|
+
*/
|
|
68
|
+
export interface CancelOrderRequest {
|
|
69
|
+
/**
|
|
70
|
+
* Order ID to cancel
|
|
71
|
+
* @type {string}
|
|
72
|
+
* @memberof CancelOrderRequest
|
|
73
|
+
*/
|
|
74
|
+
orderId: string;
|
|
75
|
+
/**
|
|
76
|
+
* See signatures section for more details on how to generate.
|
|
77
|
+
* @type {string}
|
|
78
|
+
* @memberof CancelOrderRequest
|
|
79
|
+
*/
|
|
80
|
+
signature: string;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @export
|
|
85
|
+
* @interface CancelOrderResponse
|
|
86
|
+
*/
|
|
87
|
+
export interface CancelOrderResponse {
|
|
88
|
+
/**
|
|
89
|
+
* Order status
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof CancelOrderResponse
|
|
92
|
+
*/
|
|
93
|
+
status: CancelOrderResponseStatusEnum;
|
|
94
|
+
/**
|
|
95
|
+
* Cancelled order ID
|
|
96
|
+
* @type {string}
|
|
97
|
+
* @memberof CancelOrderResponse
|
|
98
|
+
*/
|
|
99
|
+
orderId: string;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* @export
|
|
103
|
+
*/
|
|
104
|
+
export declare const CancelOrderResponseStatusEnum: {
|
|
105
|
+
readonly OPEN: "OPEN";
|
|
106
|
+
readonly FILLED: "FILLED";
|
|
107
|
+
readonly CANCELLED: "CANCELLED";
|
|
108
|
+
readonly REJECTED: "REJECTED";
|
|
109
|
+
};
|
|
110
|
+
export type CancelOrderResponseStatusEnum = typeof CancelOrderResponseStatusEnum[keyof typeof CancelOrderResponseStatusEnum];
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @export
|
|
114
|
+
* @interface CandleHistoryData
|
|
115
|
+
*/
|
|
116
|
+
export interface CandleHistoryData {
|
|
117
|
+
/**
|
|
118
|
+
* Array of timestamps (seconds)
|
|
119
|
+
* @type {Array<number>}
|
|
120
|
+
* @memberof CandleHistoryData
|
|
121
|
+
*/
|
|
122
|
+
t: Array<number>;
|
|
123
|
+
/**
|
|
124
|
+
* Array of opening prices
|
|
125
|
+
* @type {Array<string>}
|
|
126
|
+
* @memberof CandleHistoryData
|
|
127
|
+
*/
|
|
128
|
+
o: Array<string>;
|
|
129
|
+
/**
|
|
130
|
+
* Array of high prices
|
|
131
|
+
* @type {Array<string>}
|
|
132
|
+
* @memberof CandleHistoryData
|
|
133
|
+
*/
|
|
134
|
+
h: Array<string>;
|
|
135
|
+
/**
|
|
136
|
+
* Array of low prices
|
|
137
|
+
* @type {Array<string>}
|
|
138
|
+
* @memberof CandleHistoryData
|
|
139
|
+
*/
|
|
140
|
+
l: Array<string>;
|
|
141
|
+
/**
|
|
142
|
+
* Array of closing prices
|
|
143
|
+
* @type {Array<string>}
|
|
144
|
+
* @memberof CandleHistoryData
|
|
145
|
+
*/
|
|
146
|
+
c: Array<string>;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
*
|
|
150
|
+
* @export
|
|
151
|
+
* @interface CreateOrderRequest
|
|
152
|
+
*/
|
|
153
|
+
export interface CreateOrderRequest {
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @type {number}
|
|
157
|
+
* @memberof CreateOrderRequest
|
|
158
|
+
*/
|
|
159
|
+
exchangeId: number;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @type {string}
|
|
163
|
+
* @memberof CreateOrderRequest
|
|
164
|
+
*/
|
|
165
|
+
symbol?: string;
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* @type {number}
|
|
169
|
+
* @memberof CreateOrderRequest
|
|
170
|
+
*/
|
|
171
|
+
accountId: number;
|
|
172
|
+
/**
|
|
173
|
+
* Whether this is a buy order
|
|
174
|
+
* @type {boolean}
|
|
175
|
+
* @memberof CreateOrderRequest
|
|
176
|
+
*/
|
|
177
|
+
isBuy: boolean;
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof CreateOrderRequest
|
|
182
|
+
*/
|
|
183
|
+
limitPx: string;
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof CreateOrderRequest
|
|
188
|
+
*/
|
|
189
|
+
qty?: string;
|
|
190
|
+
/**
|
|
191
|
+
* Order type, (LIMIT = Limit, TP = Take Profit, SL = Stop Loss)
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof CreateOrderRequest
|
|
194
|
+
*/
|
|
195
|
+
orderType: CreateOrderRequestOrderTypeEnum;
|
|
196
|
+
/**
|
|
197
|
+
* Order time in force, exclusively used for LIMIT orders
|
|
198
|
+
* @type {string}
|
|
199
|
+
* @memberof CreateOrderRequest
|
|
200
|
+
*/
|
|
201
|
+
timeInForce?: CreateOrderRequestTimeInForceEnum;
|
|
202
|
+
/**
|
|
203
|
+
* Trigger price, only for TP/SL orders
|
|
204
|
+
* @type {string}
|
|
205
|
+
* @memberof CreateOrderRequest
|
|
206
|
+
*/
|
|
207
|
+
triggerPx?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Whether this is a reduce-only order, exclusively used for LIMIT IOC orders.
|
|
210
|
+
* @type {boolean}
|
|
211
|
+
* @memberof CreateOrderRequest
|
|
212
|
+
*/
|
|
213
|
+
reduceOnly?: boolean;
|
|
214
|
+
/**
|
|
215
|
+
* See signatures and nonces section for more details on how to generate.
|
|
216
|
+
* @type {string}
|
|
217
|
+
* @memberof CreateOrderRequest
|
|
218
|
+
*/
|
|
219
|
+
signature: string;
|
|
220
|
+
/**
|
|
221
|
+
* Order nonce, see signatures and nonces section for more details.
|
|
222
|
+
* @type {string}
|
|
223
|
+
* @memberof CreateOrderRequest
|
|
224
|
+
*/
|
|
225
|
+
nonce: string;
|
|
226
|
+
/**
|
|
227
|
+
* Signer wallet address
|
|
228
|
+
* @type {string}
|
|
229
|
+
* @memberof CreateOrderRequest
|
|
230
|
+
*/
|
|
231
|
+
signerWallet: string;
|
|
232
|
+
/**
|
|
233
|
+
* Expiration timestamp (exclusively for IOC orders). The order will only be filled before this timestamp.
|
|
234
|
+
* @type {number}
|
|
235
|
+
* @memberof CreateOrderRequest
|
|
236
|
+
*/
|
|
237
|
+
expiresAfter?: number;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* @export
|
|
241
|
+
*/
|
|
242
|
+
export declare const CreateOrderRequestOrderTypeEnum: {
|
|
243
|
+
readonly LIMIT: "LIMIT";
|
|
244
|
+
readonly TP: "TP";
|
|
245
|
+
readonly SL: "SL";
|
|
246
|
+
};
|
|
247
|
+
export type CreateOrderRequestOrderTypeEnum = typeof CreateOrderRequestOrderTypeEnum[keyof typeof CreateOrderRequestOrderTypeEnum];
|
|
248
|
+
/**
|
|
249
|
+
* @export
|
|
250
|
+
*/
|
|
251
|
+
export declare const CreateOrderRequestTimeInForceEnum: {
|
|
252
|
+
readonly IOC: "IOC";
|
|
253
|
+
readonly GTC: "GTC";
|
|
254
|
+
};
|
|
255
|
+
export type CreateOrderRequestTimeInForceEnum = typeof CreateOrderRequestTimeInForceEnum[keyof typeof CreateOrderRequestTimeInForceEnum];
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @export
|
|
259
|
+
* @interface CreateOrderResponse
|
|
260
|
+
*/
|
|
261
|
+
export interface CreateOrderResponse {
|
|
262
|
+
/**
|
|
263
|
+
* Order status
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof CreateOrderResponse
|
|
266
|
+
*/
|
|
267
|
+
status: CreateOrderResponseStatusEnum;
|
|
268
|
+
/**
|
|
269
|
+
* Created order ID (currently generated for all order types except IOC)
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof CreateOrderResponse
|
|
272
|
+
*/
|
|
273
|
+
orderId?: string;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @export
|
|
277
|
+
*/
|
|
278
|
+
export declare const CreateOrderResponseStatusEnum: {
|
|
279
|
+
readonly OPEN: "OPEN";
|
|
280
|
+
readonly FILLED: "FILLED";
|
|
281
|
+
readonly CANCELLED: "CANCELLED";
|
|
282
|
+
readonly REJECTED: "REJECTED";
|
|
283
|
+
};
|
|
284
|
+
export type CreateOrderResponseStatusEnum = typeof CreateOrderResponseStatusEnum[keyof typeof CreateOrderResponseStatusEnum];
|
|
285
|
+
/**
|
|
286
|
+
* Type of execution
|
|
287
|
+
* @export
|
|
288
|
+
*/
|
|
289
|
+
export declare const ExecutionType: {
|
|
290
|
+
readonly ORDER_MATCH: "ORDER_MATCH";
|
|
291
|
+
readonly LIQUIDATION: "LIQUIDATION";
|
|
292
|
+
readonly ADL: "ADL";
|
|
293
|
+
};
|
|
294
|
+
export type ExecutionType = typeof ExecutionType[keyof typeof ExecutionType];
|
|
295
|
+
/**
|
|
296
|
+
*
|
|
297
|
+
* @export
|
|
298
|
+
* @interface FeeTierParameters
|
|
299
|
+
*/
|
|
300
|
+
export interface FeeTierParameters {
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @type {number}
|
|
304
|
+
* @memberof FeeTierParameters
|
|
305
|
+
*/
|
|
306
|
+
tierId: number;
|
|
307
|
+
/**
|
|
308
|
+
* Taker fee rate (fee will be qty * takerFee)
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof FeeTierParameters
|
|
311
|
+
*/
|
|
312
|
+
takerFee: string;
|
|
313
|
+
/**
|
|
314
|
+
* Maker fee rate (fee will be qty * makerFee)
|
|
315
|
+
* @type {string}
|
|
316
|
+
* @memberof FeeTierParameters
|
|
317
|
+
*/
|
|
318
|
+
makerFee: string;
|
|
319
|
+
/**
|
|
320
|
+
* 14-day volume level required this fee tier to be applied to a wallet
|
|
321
|
+
* @type {string}
|
|
322
|
+
* @memberof FeeTierParameters
|
|
323
|
+
*/
|
|
324
|
+
volume14d: string;
|
|
325
|
+
/**
|
|
326
|
+
* Fee tier type (REGULAR = Standard tier, VIP = VIP tier)
|
|
327
|
+
* @type {string}
|
|
328
|
+
* @memberof FeeTierParameters
|
|
329
|
+
*/
|
|
330
|
+
tierType: FeeTierParametersTierTypeEnum;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* @export
|
|
334
|
+
*/
|
|
335
|
+
export declare const FeeTierParametersTierTypeEnum: {
|
|
336
|
+
readonly REGULAR: "REGULAR";
|
|
337
|
+
readonly VIP: "VIP";
|
|
338
|
+
};
|
|
339
|
+
export type FeeTierParametersTierTypeEnum = typeof FeeTierParametersTierTypeEnum[keyof typeof FeeTierParametersTierTypeEnum];
|
|
340
|
+
/**
|
|
341
|
+
*
|
|
342
|
+
* @export
|
|
343
|
+
* @interface GlobalFeeParameters
|
|
344
|
+
*/
|
|
345
|
+
export interface GlobalFeeParameters {
|
|
346
|
+
/**
|
|
347
|
+
* OG user discount
|
|
348
|
+
* @type {string}
|
|
349
|
+
* @memberof GlobalFeeParameters
|
|
350
|
+
*/
|
|
351
|
+
ogDiscount: string;
|
|
352
|
+
/**
|
|
353
|
+
* Referee discount
|
|
354
|
+
* @type {string}
|
|
355
|
+
* @memberof GlobalFeeParameters
|
|
356
|
+
*/
|
|
357
|
+
refereeDiscount: string;
|
|
358
|
+
/**
|
|
359
|
+
* Referrer rebate
|
|
360
|
+
* @type {string}
|
|
361
|
+
* @memberof GlobalFeeParameters
|
|
362
|
+
*/
|
|
363
|
+
referrerRebate: string;
|
|
364
|
+
/**
|
|
365
|
+
* Affiliate referrer rebate
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof GlobalFeeParameters
|
|
368
|
+
*/
|
|
369
|
+
affiliateReferrerRebate: string;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @export
|
|
374
|
+
* @interface LiquidityParameters
|
|
375
|
+
*/
|
|
376
|
+
export interface LiquidityParameters {
|
|
377
|
+
/**
|
|
378
|
+
*
|
|
379
|
+
* @type {string}
|
|
380
|
+
* @memberof LiquidityParameters
|
|
381
|
+
*/
|
|
382
|
+
symbol: string;
|
|
383
|
+
/**
|
|
384
|
+
* Parameter determining the liquidity distribution along the AMM pricing curve, in particular expanding or contracting the max exposure parameter that would otherwise be determined by the capital available.
|
|
385
|
+
* @type {string}
|
|
386
|
+
* @memberof LiquidityParameters
|
|
387
|
+
*/
|
|
388
|
+
depth: string;
|
|
389
|
+
/**
|
|
390
|
+
* Parameter determining the sensitivity of the dynamic funding rate to the size of the imbalances; higher multiplier means that the funding rate will diverge faster, all else being equal.
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof LiquidityParameters
|
|
393
|
+
*/
|
|
394
|
+
velocityMultiplier: string;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @export
|
|
399
|
+
* @interface MarketDefinition
|
|
400
|
+
*/
|
|
401
|
+
export interface MarketDefinition {
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @type {string}
|
|
405
|
+
* @memberof MarketDefinition
|
|
406
|
+
*/
|
|
407
|
+
symbol: string;
|
|
408
|
+
/**
|
|
409
|
+
* Numerical identifier for each market, only needed to generate signatures
|
|
410
|
+
* @type {number}
|
|
411
|
+
* @memberof MarketDefinition
|
|
412
|
+
*/
|
|
413
|
+
marketId: number;
|
|
414
|
+
/**
|
|
415
|
+
*
|
|
416
|
+
* @type {string}
|
|
417
|
+
* @memberof MarketDefinition
|
|
418
|
+
*/
|
|
419
|
+
minOrderQty: string;
|
|
420
|
+
/**
|
|
421
|
+
* Minimum size increment
|
|
422
|
+
* @type {string}
|
|
423
|
+
* @memberof MarketDefinition
|
|
424
|
+
*/
|
|
425
|
+
qtyStepSize: string;
|
|
426
|
+
/**
|
|
427
|
+
* Minimum price increment
|
|
428
|
+
* @type {string}
|
|
429
|
+
* @memberof MarketDefinition
|
|
430
|
+
*/
|
|
431
|
+
tickSize: string;
|
|
432
|
+
/**
|
|
433
|
+
* Minimum percentage of notional that needs to be covered to avoid liquidation procedures for a given market; below this value, your account is subject to liquidation procedures. When cross margining, all requirements across markets are covered by the same balance, and all positions are subject to liquidations.
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof MarketDefinition
|
|
436
|
+
*/
|
|
437
|
+
liquidationMarginParameter: string;
|
|
438
|
+
/**
|
|
439
|
+
* Minimum percentage of notional that needs to be covered post trade; if the account does not satisfy this requirement, trades will not get executed.
|
|
440
|
+
* @type {string}
|
|
441
|
+
* @memberof MarketDefinition
|
|
442
|
+
*/
|
|
443
|
+
initialMarginParameter: string;
|
|
444
|
+
/**
|
|
445
|
+
* Maximum leverage allowed
|
|
446
|
+
* @type {number}
|
|
447
|
+
* @memberof MarketDefinition
|
|
448
|
+
*/
|
|
449
|
+
maxLeverage: number;
|
|
450
|
+
/**
|
|
451
|
+
* Maximum one-sided open interest in units for a given market.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof MarketDefinition
|
|
454
|
+
*/
|
|
455
|
+
oiCap: string;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @export
|
|
460
|
+
* @interface MarketSummary
|
|
461
|
+
*/
|
|
462
|
+
export interface MarketSummary {
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof MarketSummary
|
|
467
|
+
*/
|
|
468
|
+
symbol: string;
|
|
469
|
+
/**
|
|
470
|
+
* Time when the market summary was last calculated (milliseconds)
|
|
471
|
+
* @type {number}
|
|
472
|
+
* @memberof MarketSummary
|
|
473
|
+
*/
|
|
474
|
+
updatedAt: number;
|
|
475
|
+
/**
|
|
476
|
+
* Long open interest in lots
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof MarketSummary
|
|
479
|
+
*/
|
|
480
|
+
longOiQty: string;
|
|
481
|
+
/**
|
|
482
|
+
* Short open interest in lots
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof MarketSummary
|
|
485
|
+
*/
|
|
486
|
+
shortOiQty: string;
|
|
487
|
+
/**
|
|
488
|
+
* Total open interest quantity
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof MarketSummary
|
|
491
|
+
*/
|
|
492
|
+
oiQty: string;
|
|
493
|
+
/**
|
|
494
|
+
* Current hourly funding rate
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof MarketSummary
|
|
497
|
+
*/
|
|
498
|
+
fundingRate: string;
|
|
499
|
+
/**
|
|
500
|
+
* Current reference value of funding accrued by one unit of exposure; there is one funding value per market and per direction, with short v long funding values differing possibly due to Auto-Deleveraging (ADL)
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof MarketSummary
|
|
503
|
+
*/
|
|
504
|
+
longFundingValue: string;
|
|
505
|
+
/**
|
|
506
|
+
* Current reference value of funding accrued by one unit of exposure; there is one funding value per market and per direction, with short v long funding values differing possibly due to Auto-Deleveraging (ADL)
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof MarketSummary
|
|
509
|
+
*/
|
|
510
|
+
shortFundingValue: string;
|
|
511
|
+
/**
|
|
512
|
+
* Funding rate velocity
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof MarketSummary
|
|
515
|
+
*/
|
|
516
|
+
fundingRateVelocity: string;
|
|
517
|
+
/**
|
|
518
|
+
*
|
|
519
|
+
* @type {string}
|
|
520
|
+
* @memberof MarketSummary
|
|
521
|
+
*/
|
|
522
|
+
volume24h: string;
|
|
523
|
+
/**
|
|
524
|
+
*
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof MarketSummary
|
|
527
|
+
*/
|
|
528
|
+
pxChange24h?: string;
|
|
529
|
+
/**
|
|
530
|
+
* Last oracle price, at the moment of the last market summary update
|
|
531
|
+
* @type {string}
|
|
532
|
+
* @memberof MarketSummary
|
|
533
|
+
*/
|
|
534
|
+
throttledOraclePrice?: string;
|
|
535
|
+
/**
|
|
536
|
+
* Last pool price, at the moment of the last market summary update
|
|
537
|
+
* @type {string}
|
|
538
|
+
* @memberof MarketSummary
|
|
539
|
+
*/
|
|
540
|
+
throttledPoolPrice?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Timestamp of the last price update (milliseconds)
|
|
543
|
+
* @type {number}
|
|
544
|
+
* @memberof MarketSummary
|
|
545
|
+
*/
|
|
546
|
+
pricesUpdatedAt?: number;
|
|
547
|
+
}
|
|
548
|
+
/**
|
|
549
|
+
*
|
|
550
|
+
* @export
|
|
551
|
+
* @interface Order
|
|
552
|
+
*/
|
|
553
|
+
export interface Order {
|
|
554
|
+
/**
|
|
555
|
+
*
|
|
556
|
+
* @type {number}
|
|
557
|
+
* @memberof Order
|
|
558
|
+
*/
|
|
559
|
+
exchangeId: number;
|
|
560
|
+
/**
|
|
561
|
+
*
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof Order
|
|
564
|
+
*/
|
|
565
|
+
symbol: string;
|
|
566
|
+
/**
|
|
567
|
+
*
|
|
568
|
+
* @type {number}
|
|
569
|
+
* @memberof Order
|
|
570
|
+
*/
|
|
571
|
+
accountId: number;
|
|
572
|
+
/**
|
|
573
|
+
*
|
|
574
|
+
* @type {string}
|
|
575
|
+
* @memberof Order
|
|
576
|
+
*/
|
|
577
|
+
orderId?: string;
|
|
578
|
+
/**
|
|
579
|
+
*
|
|
580
|
+
* @type {string}
|
|
581
|
+
* @memberof Order
|
|
582
|
+
*/
|
|
583
|
+
qty?: string;
|
|
584
|
+
/**
|
|
585
|
+
* Executed quantity. Example: I request 1.0 BTCRUSDPERP and the order is filled with 0.2 BTCRUSDPERP, qty will stay at 1.0 and execQty will be 0.2.
|
|
586
|
+
* @type {string}
|
|
587
|
+
* @memberof Order
|
|
588
|
+
*/
|
|
589
|
+
execQty?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
592
|
+
* @type {string}
|
|
593
|
+
* @memberof Order
|
|
594
|
+
*/
|
|
595
|
+
side: OrderSideEnum;
|
|
596
|
+
/**
|
|
597
|
+
*
|
|
598
|
+
* @type {string}
|
|
599
|
+
* @memberof Order
|
|
600
|
+
*/
|
|
601
|
+
limitPx: string;
|
|
602
|
+
/**
|
|
603
|
+
* Order type, (LIMIT = Limit, TP = Take Profit, SL = Stop Loss)
|
|
604
|
+
* @type {string}
|
|
605
|
+
* @memberof Order
|
|
606
|
+
*/
|
|
607
|
+
orderType: OrderOrderTypeEnum;
|
|
608
|
+
/**
|
|
609
|
+
* Price at which TP/SL orders will be triggered, should not be set for other order types.
|
|
610
|
+
* @type {string}
|
|
611
|
+
* @memberof Order
|
|
612
|
+
*/
|
|
613
|
+
triggerPx?: string;
|
|
614
|
+
/**
|
|
615
|
+
* Order time in force, exclusively used for LIMIT orders
|
|
616
|
+
* @type {string}
|
|
617
|
+
* @memberof Order
|
|
618
|
+
*/
|
|
619
|
+
timeInForce?: OrderTimeInForceEnum;
|
|
620
|
+
/**
|
|
621
|
+
* Whether this is a reduce-only order, exclusively used for LIMIT IOC orders.
|
|
622
|
+
* @type {boolean}
|
|
623
|
+
* @memberof Order
|
|
624
|
+
*/
|
|
625
|
+
reduceOnly?: boolean;
|
|
626
|
+
/**
|
|
627
|
+
* Order status
|
|
628
|
+
* @type {string}
|
|
629
|
+
* @memberof Order
|
|
630
|
+
*/
|
|
631
|
+
status: OrderStatusEnum;
|
|
632
|
+
/**
|
|
633
|
+
* Creation timestamp (milliseconds)
|
|
634
|
+
* @type {number}
|
|
635
|
+
* @memberof Order
|
|
636
|
+
*/
|
|
637
|
+
createdAt: number;
|
|
638
|
+
/**
|
|
639
|
+
* Last update timestamp (milliseconds)
|
|
640
|
+
* @type {number}
|
|
641
|
+
* @memberof Order
|
|
642
|
+
*/
|
|
643
|
+
lastUpdateAt: number;
|
|
644
|
+
}
|
|
645
|
+
/**
|
|
646
|
+
* @export
|
|
647
|
+
*/
|
|
648
|
+
export declare const OrderSideEnum: {
|
|
649
|
+
readonly B: "B";
|
|
650
|
+
readonly A: "A";
|
|
651
|
+
};
|
|
652
|
+
export type OrderSideEnum = typeof OrderSideEnum[keyof typeof OrderSideEnum];
|
|
653
|
+
/**
|
|
654
|
+
* @export
|
|
655
|
+
*/
|
|
656
|
+
export declare const OrderOrderTypeEnum: {
|
|
657
|
+
readonly LIMIT: "LIMIT";
|
|
658
|
+
readonly TP: "TP";
|
|
659
|
+
readonly SL: "SL";
|
|
660
|
+
};
|
|
661
|
+
export type OrderOrderTypeEnum = typeof OrderOrderTypeEnum[keyof typeof OrderOrderTypeEnum];
|
|
662
|
+
/**
|
|
663
|
+
* @export
|
|
664
|
+
*/
|
|
665
|
+
export declare const OrderTimeInForceEnum: {
|
|
666
|
+
readonly IOC: "IOC";
|
|
667
|
+
readonly GTC: "GTC";
|
|
668
|
+
};
|
|
669
|
+
export type OrderTimeInForceEnum = typeof OrderTimeInForceEnum[keyof typeof OrderTimeInForceEnum];
|
|
670
|
+
/**
|
|
671
|
+
* @export
|
|
672
|
+
*/
|
|
673
|
+
export declare const OrderStatusEnum: {
|
|
674
|
+
readonly OPEN: "OPEN";
|
|
675
|
+
readonly FILLED: "FILLED";
|
|
676
|
+
readonly CANCELLED: "CANCELLED";
|
|
677
|
+
readonly REJECTED: "REJECTED";
|
|
678
|
+
};
|
|
679
|
+
export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum];
|
|
680
|
+
/**
|
|
681
|
+
* Order status
|
|
682
|
+
* @export
|
|
683
|
+
*/
|
|
684
|
+
export declare const OrderStatus: {
|
|
685
|
+
readonly OPEN: "OPEN";
|
|
686
|
+
readonly FILLED: "FILLED";
|
|
687
|
+
readonly CANCELLED: "CANCELLED";
|
|
688
|
+
readonly REJECTED: "REJECTED";
|
|
689
|
+
};
|
|
690
|
+
export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus];
|
|
691
|
+
/**
|
|
692
|
+
* Order type, (LIMIT = Limit, TP = Take Profit, SL = Stop Loss)
|
|
693
|
+
* @export
|
|
694
|
+
*/
|
|
695
|
+
export declare const OrderType: {
|
|
696
|
+
readonly LIMIT: "LIMIT";
|
|
697
|
+
readonly TP: "TP";
|
|
698
|
+
readonly SL: "SL";
|
|
699
|
+
};
|
|
700
|
+
export type OrderType = typeof OrderType[keyof typeof OrderType];
|
|
701
|
+
/**
|
|
702
|
+
*
|
|
703
|
+
* @export
|
|
704
|
+
* @interface PaginationParameters
|
|
705
|
+
*/
|
|
706
|
+
export interface PaginationParameters {
|
|
707
|
+
/**
|
|
708
|
+
* Number of items requested
|
|
709
|
+
* @type {number}
|
|
710
|
+
* @memberof PaginationParameters
|
|
711
|
+
*/
|
|
712
|
+
limit: number;
|
|
713
|
+
/**
|
|
714
|
+
* Number of items returned
|
|
715
|
+
* @type {number}
|
|
716
|
+
* @memberof PaginationParameters
|
|
717
|
+
*/
|
|
718
|
+
count: number;
|
|
719
|
+
/**
|
|
720
|
+
* Timestamp of last result, in milliseconds
|
|
721
|
+
* @type {number}
|
|
722
|
+
* @memberof PaginationParameters
|
|
723
|
+
*/
|
|
724
|
+
endTime?: number;
|
|
725
|
+
/**
|
|
726
|
+
* Timestamp of first result, in milliseconds
|
|
727
|
+
* @type {number}
|
|
728
|
+
* @memberof PaginationParameters
|
|
729
|
+
*/
|
|
730
|
+
startTime?: number;
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
*
|
|
734
|
+
* @export
|
|
735
|
+
* @interface PerpExecution
|
|
736
|
+
*/
|
|
737
|
+
export interface PerpExecution {
|
|
738
|
+
/**
|
|
739
|
+
*
|
|
740
|
+
* @type {number}
|
|
741
|
+
* @memberof PerpExecution
|
|
742
|
+
*/
|
|
743
|
+
exchangeId: number;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof PerpExecution
|
|
748
|
+
*/
|
|
749
|
+
symbol: string;
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @type {number}
|
|
753
|
+
* @memberof PerpExecution
|
|
754
|
+
*/
|
|
755
|
+
accountId: number;
|
|
756
|
+
/**
|
|
757
|
+
*
|
|
758
|
+
* @type {string}
|
|
759
|
+
* @memberof PerpExecution
|
|
760
|
+
*/
|
|
761
|
+
qty: string;
|
|
762
|
+
/**
|
|
763
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
764
|
+
* @type {string}
|
|
765
|
+
* @memberof PerpExecution
|
|
766
|
+
*/
|
|
767
|
+
side: PerpExecutionSideEnum;
|
|
768
|
+
/**
|
|
769
|
+
*
|
|
770
|
+
* @type {string}
|
|
771
|
+
* @memberof PerpExecution
|
|
772
|
+
*/
|
|
773
|
+
price: string;
|
|
774
|
+
/**
|
|
775
|
+
*
|
|
776
|
+
* @type {string}
|
|
777
|
+
* @memberof PerpExecution
|
|
778
|
+
*/
|
|
779
|
+
fee: string;
|
|
780
|
+
/**
|
|
781
|
+
* Type of execution
|
|
782
|
+
* @type {string}
|
|
783
|
+
* @memberof PerpExecution
|
|
784
|
+
*/
|
|
785
|
+
type: PerpExecutionTypeEnum;
|
|
786
|
+
/**
|
|
787
|
+
* Execution timestamp (milliseconds)
|
|
788
|
+
* @type {number}
|
|
789
|
+
* @memberof PerpExecution
|
|
790
|
+
*/
|
|
791
|
+
timestamp: number;
|
|
792
|
+
/**
|
|
793
|
+
* Execution sequence number, increases by 1 for every perp execution in reya chain
|
|
794
|
+
* @type {number}
|
|
795
|
+
* @memberof PerpExecution
|
|
796
|
+
*/
|
|
797
|
+
sequenceNumber: number;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* @export
|
|
801
|
+
*/
|
|
802
|
+
export declare const PerpExecutionSideEnum: {
|
|
803
|
+
readonly B: "B";
|
|
804
|
+
readonly A: "A";
|
|
805
|
+
};
|
|
806
|
+
export type PerpExecutionSideEnum = typeof PerpExecutionSideEnum[keyof typeof PerpExecutionSideEnum];
|
|
807
|
+
/**
|
|
808
|
+
* @export
|
|
809
|
+
*/
|
|
810
|
+
export declare const PerpExecutionTypeEnum: {
|
|
811
|
+
readonly ORDER_MATCH: "ORDER_MATCH";
|
|
812
|
+
readonly LIQUIDATION: "LIQUIDATION";
|
|
813
|
+
readonly ADL: "ADL";
|
|
814
|
+
};
|
|
815
|
+
export type PerpExecutionTypeEnum = typeof PerpExecutionTypeEnum[keyof typeof PerpExecutionTypeEnum];
|
|
816
|
+
/**
|
|
817
|
+
*
|
|
818
|
+
* @export
|
|
819
|
+
* @interface PerpExecutionList
|
|
820
|
+
*/
|
|
821
|
+
export interface PerpExecutionList {
|
|
822
|
+
/**
|
|
823
|
+
*
|
|
824
|
+
* @type {Array<PerpExecutionListDataInner>}
|
|
825
|
+
* @memberof PerpExecutionList
|
|
826
|
+
*/
|
|
827
|
+
data: Array<PerpExecutionListDataInner>;
|
|
828
|
+
/**
|
|
829
|
+
*
|
|
830
|
+
* @type {PerpExecutionListMeta}
|
|
831
|
+
* @memberof PerpExecutionList
|
|
832
|
+
*/
|
|
833
|
+
meta: PerpExecutionListMeta;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
*
|
|
837
|
+
* @export
|
|
838
|
+
* @interface PerpExecutionListDataInner
|
|
839
|
+
*/
|
|
840
|
+
export interface PerpExecutionListDataInner {
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @type {number}
|
|
844
|
+
* @memberof PerpExecutionListDataInner
|
|
845
|
+
*/
|
|
846
|
+
exchangeId: number;
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @type {string}
|
|
850
|
+
* @memberof PerpExecutionListDataInner
|
|
851
|
+
*/
|
|
852
|
+
symbol: string;
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @type {number}
|
|
856
|
+
* @memberof PerpExecutionListDataInner
|
|
857
|
+
*/
|
|
858
|
+
accountId: number;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof PerpExecutionListDataInner
|
|
863
|
+
*/
|
|
864
|
+
qty: string;
|
|
865
|
+
/**
|
|
866
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
867
|
+
* @type {string}
|
|
868
|
+
* @memberof PerpExecutionListDataInner
|
|
869
|
+
*/
|
|
870
|
+
side: PerpExecutionListDataInnerSideEnum;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {string}
|
|
874
|
+
* @memberof PerpExecutionListDataInner
|
|
875
|
+
*/
|
|
876
|
+
price: string;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {string}
|
|
880
|
+
* @memberof PerpExecutionListDataInner
|
|
881
|
+
*/
|
|
882
|
+
fee: string;
|
|
883
|
+
/**
|
|
884
|
+
* Type of execution
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof PerpExecutionListDataInner
|
|
887
|
+
*/
|
|
888
|
+
type: PerpExecutionListDataInnerTypeEnum;
|
|
889
|
+
/**
|
|
890
|
+
* Execution timestamp (milliseconds)
|
|
891
|
+
* @type {number}
|
|
892
|
+
* @memberof PerpExecutionListDataInner
|
|
893
|
+
*/
|
|
894
|
+
timestamp: number;
|
|
895
|
+
/**
|
|
896
|
+
* Execution sequence number, increases by 1 for every perp execution in reya chain
|
|
897
|
+
* @type {number}
|
|
898
|
+
* @memberof PerpExecutionListDataInner
|
|
899
|
+
*/
|
|
900
|
+
sequenceNumber: number;
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* @export
|
|
904
|
+
*/
|
|
905
|
+
export declare const PerpExecutionListDataInnerSideEnum: {
|
|
906
|
+
readonly B: "B";
|
|
907
|
+
readonly A: "A";
|
|
908
|
+
};
|
|
909
|
+
export type PerpExecutionListDataInnerSideEnum = typeof PerpExecutionListDataInnerSideEnum[keyof typeof PerpExecutionListDataInnerSideEnum];
|
|
910
|
+
/**
|
|
911
|
+
* @export
|
|
912
|
+
*/
|
|
913
|
+
export declare const PerpExecutionListDataInnerTypeEnum: {
|
|
914
|
+
readonly ORDER_MATCH: "ORDER_MATCH";
|
|
915
|
+
readonly LIQUIDATION: "LIQUIDATION";
|
|
916
|
+
readonly ADL: "ADL";
|
|
917
|
+
};
|
|
918
|
+
export type PerpExecutionListDataInnerTypeEnum = typeof PerpExecutionListDataInnerTypeEnum[keyof typeof PerpExecutionListDataInnerTypeEnum];
|
|
919
|
+
/**
|
|
920
|
+
*
|
|
921
|
+
* @export
|
|
922
|
+
* @interface PerpExecutionListMeta
|
|
923
|
+
*/
|
|
924
|
+
export interface PerpExecutionListMeta {
|
|
925
|
+
/**
|
|
926
|
+
* Number of items requested
|
|
927
|
+
* @type {number}
|
|
928
|
+
* @memberof PerpExecutionListMeta
|
|
929
|
+
*/
|
|
930
|
+
limit: number;
|
|
931
|
+
/**
|
|
932
|
+
* Number of items returned
|
|
933
|
+
* @type {number}
|
|
934
|
+
* @memberof PerpExecutionListMeta
|
|
935
|
+
*/
|
|
936
|
+
count: number;
|
|
937
|
+
/**
|
|
938
|
+
* Timestamp of last result, in milliseconds
|
|
939
|
+
* @type {number}
|
|
940
|
+
* @memberof PerpExecutionListMeta
|
|
941
|
+
*/
|
|
942
|
+
endTime?: number;
|
|
943
|
+
/**
|
|
944
|
+
* Timestamp of first result, in milliseconds
|
|
945
|
+
* @type {number}
|
|
946
|
+
* @memberof PerpExecutionListMeta
|
|
947
|
+
*/
|
|
948
|
+
startTime?: number;
|
|
949
|
+
}
|
|
950
|
+
/**
|
|
951
|
+
*
|
|
952
|
+
* @export
|
|
953
|
+
* @interface Position
|
|
954
|
+
*/
|
|
955
|
+
export interface Position {
|
|
956
|
+
/**
|
|
957
|
+
*
|
|
958
|
+
* @type {number}
|
|
959
|
+
* @memberof Position
|
|
960
|
+
*/
|
|
961
|
+
exchangeId: number;
|
|
962
|
+
/**
|
|
963
|
+
*
|
|
964
|
+
* @type {string}
|
|
965
|
+
* @memberof Position
|
|
966
|
+
*/
|
|
967
|
+
symbol: string;
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
* @type {number}
|
|
971
|
+
* @memberof Position
|
|
972
|
+
*/
|
|
973
|
+
accountId: number;
|
|
974
|
+
/**
|
|
975
|
+
*
|
|
976
|
+
* @type {string}
|
|
977
|
+
* @memberof Position
|
|
978
|
+
*/
|
|
979
|
+
qty: string;
|
|
980
|
+
/**
|
|
981
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
982
|
+
* @type {string}
|
|
983
|
+
* @memberof Position
|
|
984
|
+
*/
|
|
985
|
+
side: PositionSideEnum;
|
|
986
|
+
/**
|
|
987
|
+
*
|
|
988
|
+
* @type {string}
|
|
989
|
+
* @memberof Position
|
|
990
|
+
*/
|
|
991
|
+
avgEntryPrice: string;
|
|
992
|
+
/**
|
|
993
|
+
* Average of funding values at the entry times of currently open exposure, which serves as a baseline from which to compute the accrued funding in the position: units x (fundingValue - avgEntryFundingValue)
|
|
994
|
+
* @type {string}
|
|
995
|
+
* @memberof Position
|
|
996
|
+
*/
|
|
997
|
+
avgEntryFundingValue: string;
|
|
998
|
+
/**
|
|
999
|
+
* Sequence number of last execution taken into account for the position.
|
|
1000
|
+
* @type {number}
|
|
1001
|
+
* @memberof Position
|
|
1002
|
+
*/
|
|
1003
|
+
lastTradeSequenceNumber: number;
|
|
1004
|
+
}
|
|
1005
|
+
/**
|
|
1006
|
+
* @export
|
|
1007
|
+
*/
|
|
1008
|
+
export declare const PositionSideEnum: {
|
|
1009
|
+
readonly B: "B";
|
|
1010
|
+
readonly A: "A";
|
|
1011
|
+
};
|
|
1012
|
+
export type PositionSideEnum = typeof PositionSideEnum[keyof typeof PositionSideEnum];
|
|
1013
|
+
/**
|
|
1014
|
+
*
|
|
1015
|
+
* @export
|
|
1016
|
+
* @interface Price
|
|
1017
|
+
*/
|
|
1018
|
+
export interface Price {
|
|
1019
|
+
/**
|
|
1020
|
+
*
|
|
1021
|
+
* @type {string}
|
|
1022
|
+
* @memberof Price
|
|
1023
|
+
*/
|
|
1024
|
+
symbol: string;
|
|
1025
|
+
/**
|
|
1026
|
+
* Price given by the Stork feeds, used both as the peg price for prices on Reya, as well as Mark Prices. The Stork price feed is usually the perp prices across three major CEXs
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof Price
|
|
1029
|
+
*/
|
|
1030
|
+
oraclePrice?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* The price currently quoted by the AMM for zero volume, from which trades are priced (equivalent to mid price in an order book); a trade of any size will be move this price up or down depending on the direction.
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof Price
|
|
1035
|
+
*/
|
|
1036
|
+
poolPrice?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Last update timestamp (milliseconds)
|
|
1039
|
+
* @type {number}
|
|
1040
|
+
* @memberof Price
|
|
1041
|
+
*/
|
|
1042
|
+
updatedAt: number;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
*
|
|
1046
|
+
* @export
|
|
1047
|
+
* @interface RequestError
|
|
1048
|
+
*/
|
|
1049
|
+
export interface RequestError {
|
|
1050
|
+
/**
|
|
1051
|
+
* Standardized error codes for API responses
|
|
1052
|
+
* @type {string}
|
|
1053
|
+
* @memberof RequestError
|
|
1054
|
+
*/
|
|
1055
|
+
error: RequestErrorErrorEnum;
|
|
1056
|
+
/**
|
|
1057
|
+
* Human-readable error message
|
|
1058
|
+
* @type {string}
|
|
1059
|
+
* @memberof RequestError
|
|
1060
|
+
*/
|
|
1061
|
+
message: string;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* @export
|
|
1065
|
+
*/
|
|
1066
|
+
export declare const RequestErrorErrorEnum: {
|
|
1067
|
+
readonly SYMBOL_NOT_FOUND: "SYMBOL_NOT_FOUND";
|
|
1068
|
+
readonly NO_ACCOUNTS_FOUND: "NO_ACCOUNTS_FOUND";
|
|
1069
|
+
readonly NO_PRICES_FOUND_FOR_SYMBOL: "NO_PRICES_FOUND_FOR_SYMBOL";
|
|
1070
|
+
readonly INPUT_VALIDATION_ERROR: "INPUT_VALIDATION_ERROR";
|
|
1071
|
+
readonly CREATE_ORDER_OTHER_ERROR: "CREATE_ORDER_OTHER_ERROR";
|
|
1072
|
+
readonly CANCEL_ORDER_OTHER_ERROR: "CANCEL_ORDER_OTHER_ERROR";
|
|
1073
|
+
};
|
|
1074
|
+
export type RequestErrorErrorEnum = typeof RequestErrorErrorEnum[keyof typeof RequestErrorErrorEnum];
|
|
1075
|
+
/**
|
|
1076
|
+
* Standardized error codes for API responses
|
|
1077
|
+
* @export
|
|
1078
|
+
*/
|
|
1079
|
+
export declare const RequestErrorCode: {
|
|
1080
|
+
readonly SYMBOL_NOT_FOUND: "SYMBOL_NOT_FOUND";
|
|
1081
|
+
readonly NO_ACCOUNTS_FOUND: "NO_ACCOUNTS_FOUND";
|
|
1082
|
+
readonly NO_PRICES_FOUND_FOR_SYMBOL: "NO_PRICES_FOUND_FOR_SYMBOL";
|
|
1083
|
+
readonly INPUT_VALIDATION_ERROR: "INPUT_VALIDATION_ERROR";
|
|
1084
|
+
readonly CREATE_ORDER_OTHER_ERROR: "CREATE_ORDER_OTHER_ERROR";
|
|
1085
|
+
readonly CANCEL_ORDER_OTHER_ERROR: "CANCEL_ORDER_OTHER_ERROR";
|
|
1086
|
+
};
|
|
1087
|
+
export type RequestErrorCode = typeof RequestErrorCode[keyof typeof RequestErrorCode];
|
|
1088
|
+
/**
|
|
1089
|
+
*
|
|
1090
|
+
* @export
|
|
1091
|
+
* @interface ServerError
|
|
1092
|
+
*/
|
|
1093
|
+
export interface ServerError {
|
|
1094
|
+
/**
|
|
1095
|
+
* Standardized error codes for API responses
|
|
1096
|
+
* @type {string}
|
|
1097
|
+
* @memberof ServerError
|
|
1098
|
+
*/
|
|
1099
|
+
error: ServerErrorErrorEnum;
|
|
1100
|
+
/**
|
|
1101
|
+
* Human-readable error message
|
|
1102
|
+
* @type {string}
|
|
1103
|
+
* @memberof ServerError
|
|
1104
|
+
*/
|
|
1105
|
+
message: string;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* @export
|
|
1109
|
+
*/
|
|
1110
|
+
export declare const ServerErrorErrorEnum: {
|
|
1111
|
+
readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
|
|
1112
|
+
};
|
|
1113
|
+
export type ServerErrorErrorEnum = typeof ServerErrorErrorEnum[keyof typeof ServerErrorErrorEnum];
|
|
1114
|
+
/**
|
|
1115
|
+
* Standardized error codes for API responses
|
|
1116
|
+
* @export
|
|
1117
|
+
*/
|
|
1118
|
+
export declare const ServerErrorCode: {
|
|
1119
|
+
readonly INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR";
|
|
1120
|
+
};
|
|
1121
|
+
export type ServerErrorCode = typeof ServerErrorCode[keyof typeof ServerErrorCode];
|
|
1122
|
+
/**
|
|
1123
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
1124
|
+
* @export
|
|
1125
|
+
*/
|
|
1126
|
+
export declare const Side: {
|
|
1127
|
+
readonly B: "B";
|
|
1128
|
+
readonly A: "A";
|
|
1129
|
+
};
|
|
1130
|
+
export type Side = typeof Side[keyof typeof Side];
|
|
1131
|
+
/**
|
|
1132
|
+
*
|
|
1133
|
+
* @export
|
|
1134
|
+
* @interface SpotExecution
|
|
1135
|
+
*/
|
|
1136
|
+
export interface SpotExecution {
|
|
1137
|
+
/**
|
|
1138
|
+
*
|
|
1139
|
+
* @type {number}
|
|
1140
|
+
* @memberof SpotExecution
|
|
1141
|
+
*/
|
|
1142
|
+
exchangeId: number;
|
|
1143
|
+
/**
|
|
1144
|
+
*
|
|
1145
|
+
* @type {string}
|
|
1146
|
+
* @memberof SpotExecution
|
|
1147
|
+
*/
|
|
1148
|
+
symbol: string;
|
|
1149
|
+
/**
|
|
1150
|
+
*
|
|
1151
|
+
* @type {number}
|
|
1152
|
+
* @memberof SpotExecution
|
|
1153
|
+
*/
|
|
1154
|
+
accountId: number;
|
|
1155
|
+
/**
|
|
1156
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
1157
|
+
* @type {string}
|
|
1158
|
+
* @memberof SpotExecution
|
|
1159
|
+
*/
|
|
1160
|
+
side: SpotExecutionSideEnum;
|
|
1161
|
+
/**
|
|
1162
|
+
*
|
|
1163
|
+
* @type {string}
|
|
1164
|
+
* @memberof SpotExecution
|
|
1165
|
+
*/
|
|
1166
|
+
qty: string;
|
|
1167
|
+
/**
|
|
1168
|
+
*
|
|
1169
|
+
* @type {string}
|
|
1170
|
+
* @memberof SpotExecution
|
|
1171
|
+
*/
|
|
1172
|
+
price?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
*
|
|
1175
|
+
* @type {string}
|
|
1176
|
+
* @memberof SpotExecution
|
|
1177
|
+
*/
|
|
1178
|
+
fee: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* Type of execution
|
|
1181
|
+
* @type {string}
|
|
1182
|
+
* @memberof SpotExecution
|
|
1183
|
+
*/
|
|
1184
|
+
type: SpotExecutionTypeEnum;
|
|
1185
|
+
/**
|
|
1186
|
+
* Execution timestamp (milliseconds)
|
|
1187
|
+
* @type {number}
|
|
1188
|
+
* @memberof SpotExecution
|
|
1189
|
+
*/
|
|
1190
|
+
timestamp: number;
|
|
1191
|
+
}
|
|
1192
|
+
/**
|
|
1193
|
+
* @export
|
|
1194
|
+
*/
|
|
1195
|
+
export declare const SpotExecutionSideEnum: {
|
|
1196
|
+
readonly B: "B";
|
|
1197
|
+
readonly A: "A";
|
|
1198
|
+
};
|
|
1199
|
+
export type SpotExecutionSideEnum = typeof SpotExecutionSideEnum[keyof typeof SpotExecutionSideEnum];
|
|
1200
|
+
/**
|
|
1201
|
+
* @export
|
|
1202
|
+
*/
|
|
1203
|
+
export declare const SpotExecutionTypeEnum: {
|
|
1204
|
+
readonly ORDER_MATCH: "ORDER_MATCH";
|
|
1205
|
+
readonly LIQUIDATION: "LIQUIDATION";
|
|
1206
|
+
readonly ADL: "ADL";
|
|
1207
|
+
};
|
|
1208
|
+
export type SpotExecutionTypeEnum = typeof SpotExecutionTypeEnum[keyof typeof SpotExecutionTypeEnum];
|
|
1209
|
+
/**
|
|
1210
|
+
*
|
|
1211
|
+
* @export
|
|
1212
|
+
* @interface SpotExecutionList
|
|
1213
|
+
*/
|
|
1214
|
+
export interface SpotExecutionList {
|
|
1215
|
+
/**
|
|
1216
|
+
*
|
|
1217
|
+
* @type {Array<SpotExecutionListDataInner>}
|
|
1218
|
+
* @memberof SpotExecutionList
|
|
1219
|
+
*/
|
|
1220
|
+
data: Array<SpotExecutionListDataInner>;
|
|
1221
|
+
/**
|
|
1222
|
+
*
|
|
1223
|
+
* @type {PerpExecutionListMeta}
|
|
1224
|
+
* @memberof SpotExecutionList
|
|
1225
|
+
*/
|
|
1226
|
+
meta: PerpExecutionListMeta;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
*
|
|
1230
|
+
* @export
|
|
1231
|
+
* @interface SpotExecutionListDataInner
|
|
1232
|
+
*/
|
|
1233
|
+
export interface SpotExecutionListDataInner {
|
|
1234
|
+
/**
|
|
1235
|
+
*
|
|
1236
|
+
* @type {number}
|
|
1237
|
+
* @memberof SpotExecutionListDataInner
|
|
1238
|
+
*/
|
|
1239
|
+
exchangeId: number;
|
|
1240
|
+
/**
|
|
1241
|
+
*
|
|
1242
|
+
* @type {string}
|
|
1243
|
+
* @memberof SpotExecutionListDataInner
|
|
1244
|
+
*/
|
|
1245
|
+
symbol: string;
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @type {number}
|
|
1249
|
+
* @memberof SpotExecutionListDataInner
|
|
1250
|
+
*/
|
|
1251
|
+
accountId: number;
|
|
1252
|
+
/**
|
|
1253
|
+
* Order side (B = Buy/Bid, A = Ask/Sell)
|
|
1254
|
+
* @type {string}
|
|
1255
|
+
* @memberof SpotExecutionListDataInner
|
|
1256
|
+
*/
|
|
1257
|
+
side: SpotExecutionListDataInnerSideEnum;
|
|
1258
|
+
/**
|
|
1259
|
+
*
|
|
1260
|
+
* @type {string}
|
|
1261
|
+
* @memberof SpotExecutionListDataInner
|
|
1262
|
+
*/
|
|
1263
|
+
qty: string;
|
|
1264
|
+
/**
|
|
1265
|
+
*
|
|
1266
|
+
* @type {string}
|
|
1267
|
+
* @memberof SpotExecutionListDataInner
|
|
1268
|
+
*/
|
|
1269
|
+
price?: string;
|
|
1270
|
+
/**
|
|
1271
|
+
*
|
|
1272
|
+
* @type {string}
|
|
1273
|
+
* @memberof SpotExecutionListDataInner
|
|
1274
|
+
*/
|
|
1275
|
+
fee: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* Type of execution
|
|
1278
|
+
* @type {string}
|
|
1279
|
+
* @memberof SpotExecutionListDataInner
|
|
1280
|
+
*/
|
|
1281
|
+
type: SpotExecutionListDataInnerTypeEnum;
|
|
1282
|
+
/**
|
|
1283
|
+
* Execution timestamp (milliseconds)
|
|
1284
|
+
* @type {number}
|
|
1285
|
+
* @memberof SpotExecutionListDataInner
|
|
1286
|
+
*/
|
|
1287
|
+
timestamp: number;
|
|
1288
|
+
}
|
|
1289
|
+
/**
|
|
1290
|
+
* @export
|
|
1291
|
+
*/
|
|
1292
|
+
export declare const SpotExecutionListDataInnerSideEnum: {
|
|
1293
|
+
readonly B: "B";
|
|
1294
|
+
readonly A: "A";
|
|
1295
|
+
};
|
|
1296
|
+
export type SpotExecutionListDataInnerSideEnum = typeof SpotExecutionListDataInnerSideEnum[keyof typeof SpotExecutionListDataInnerSideEnum];
|
|
1297
|
+
/**
|
|
1298
|
+
* @export
|
|
1299
|
+
*/
|
|
1300
|
+
export declare const SpotExecutionListDataInnerTypeEnum: {
|
|
1301
|
+
readonly ORDER_MATCH: "ORDER_MATCH";
|
|
1302
|
+
readonly LIQUIDATION: "LIQUIDATION";
|
|
1303
|
+
readonly ADL: "ADL";
|
|
1304
|
+
};
|
|
1305
|
+
export type SpotExecutionListDataInnerTypeEnum = typeof SpotExecutionListDataInnerTypeEnum[keyof typeof SpotExecutionListDataInnerTypeEnum];
|
|
1306
|
+
/**
|
|
1307
|
+
* Order time in force (IOC = Immediate or Cancel, GTC = Good Till Cancel)
|
|
1308
|
+
* @export
|
|
1309
|
+
*/
|
|
1310
|
+
export declare const TimeInForce: {
|
|
1311
|
+
readonly IOC: "IOC";
|
|
1312
|
+
readonly GTC: "GTC";
|
|
1313
|
+
};
|
|
1314
|
+
export type TimeInForce = typeof TimeInForce[keyof typeof TimeInForce];
|
|
1315
|
+
/**
|
|
1316
|
+
*
|
|
1317
|
+
* @export
|
|
1318
|
+
* @interface WalletConfiguration
|
|
1319
|
+
*/
|
|
1320
|
+
export interface WalletConfiguration {
|
|
1321
|
+
/**
|
|
1322
|
+
* Fee tier identifier
|
|
1323
|
+
* @type {number}
|
|
1324
|
+
* @memberof WalletConfiguration
|
|
1325
|
+
*/
|
|
1326
|
+
feeTierId: number;
|
|
1327
|
+
/**
|
|
1328
|
+
* OG status
|
|
1329
|
+
* @type {boolean}
|
|
1330
|
+
* @memberof WalletConfiguration
|
|
1331
|
+
*/
|
|
1332
|
+
ogStatus: boolean;
|
|
1333
|
+
/**
|
|
1334
|
+
* Affiliate status
|
|
1335
|
+
* @type {boolean}
|
|
1336
|
+
* @memberof WalletConfiguration
|
|
1337
|
+
*/
|
|
1338
|
+
affiliateStatus: boolean;
|
|
1339
|
+
/**
|
|
1340
|
+
* Referee status
|
|
1341
|
+
* @type {boolean}
|
|
1342
|
+
* @memberof WalletConfiguration
|
|
1343
|
+
*/
|
|
1344
|
+
refereeStatus: boolean;
|
|
1345
|
+
}
|
|
1346
|
+
//# sourceMappingURL=index.d.ts.map
|