@reyaxyz/api-v2-sdk 0.301.4 → 0.301.5

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.
@@ -20,7 +20,7 @@ export interface Account {
20
20
  */
21
21
  name: string;
22
22
  /**
23
- * Last update timestamp (milliseconds)
23
+ *
24
24
  * @type {number}
25
25
  * @memberof Account
26
26
  */
@@ -46,7 +46,7 @@ export interface AccountBalance {
46
46
  */
47
47
  asset: string;
48
48
  /**
49
- * Sum of account net deposits (transfers, deposits and withdrawals) and realized pnl from closed positions. Realized pnl only applies to RUSD given it is the only settlement asset
49
+ *
50
50
  * @type {string}
51
51
  * @memberof AccountBalance
52
52
  */
@@ -72,19 +72,19 @@ export interface AssetDefinition {
72
72
  */
73
73
  spotMarketSymbol: string;
74
74
  /**
75
- * 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.
75
+ *
76
76
  * @type {string}
77
77
  * @memberof AssetDefinition
78
78
  */
79
79
  priceHaircut: string;
80
80
  /**
81
- * Discount in the token price when liquidating collateral.
81
+ *
82
82
  * @type {string}
83
83
  * @memberof AssetDefinition
84
84
  */
85
85
  liquidationDiscount: string;
86
86
  /**
87
- * Configuration timestamp (milliseconds)
87
+ *
88
88
  * @type {number}
89
89
  * @memberof AssetDefinition
90
90
  */
@@ -224,7 +224,7 @@ export interface CreateOrderRequest {
224
224
  */
225
225
  timeInForce?: TimeInForce;
226
226
  /**
227
- * Trigger price, only for TP/SL orders
227
+ *
228
228
  * @type {string}
229
229
  * @memberof CreateOrderRequest
230
230
  */
@@ -248,13 +248,13 @@ export interface CreateOrderRequest {
248
248
  */
249
249
  nonce: string;
250
250
  /**
251
- * Ethereum wallet address
251
+ *
252
252
  * @type {string}
253
253
  * @memberof CreateOrderRequest
254
254
  */
255
255
  signerWallet: string;
256
256
  /**
257
- * Expiration timestamp (exclusively for IOC orders). The order will only be filled before this timestamp.
257
+ *
258
258
  * @type {number}
259
259
  * @memberof CreateOrderRequest
260
260
  */
@@ -306,19 +306,19 @@ export interface FeeTierParameters {
306
306
  */
307
307
  tierId: number;
308
308
  /**
309
- * Taker fee rate (fee will be qty * takerFee)
309
+ *
310
310
  * @type {string}
311
311
  * @memberof FeeTierParameters
312
312
  */
313
313
  takerFee: string;
314
314
  /**
315
- * Maker fee rate (fee will be qty * makerFee)
315
+ *
316
316
  * @type {string}
317
317
  * @memberof FeeTierParameters
318
318
  */
319
319
  makerFee: string;
320
320
  /**
321
- * 14-day volume level required this fee tier to be applied to a wallet
321
+ *
322
322
  * @type {string}
323
323
  * @memberof FeeTierParameters
324
324
  */
@@ -338,25 +338,25 @@ export interface FeeTierParameters {
338
338
  export interface GlobalFeeParameters {
339
339
  [key: string]: any | any;
340
340
  /**
341
- * OG user discount
341
+ *
342
342
  * @type {string}
343
343
  * @memberof GlobalFeeParameters
344
344
  */
345
345
  ogDiscount: string;
346
346
  /**
347
- * Referee discount
347
+ *
348
348
  * @type {string}
349
349
  * @memberof GlobalFeeParameters
350
350
  */
351
351
  refereeDiscount: string;
352
352
  /**
353
- * Referrer rebate
353
+ *
354
354
  * @type {string}
355
355
  * @memberof GlobalFeeParameters
356
356
  */
357
357
  referrerRebate: string;
358
358
  /**
359
- * Affiliate referrer rebate
359
+ *
360
360
  * @type {string}
361
361
  * @memberof GlobalFeeParameters
362
362
  */
@@ -376,13 +376,13 @@ export interface LiquidityParameters {
376
376
  */
377
377
  symbol: string;
378
378
  /**
379
- * 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.
379
+ *
380
380
  * @type {string}
381
381
  * @memberof LiquidityParameters
382
382
  */
383
383
  depth: string;
384
384
  /**
385
- * 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.
385
+ *
386
386
  * @type {string}
387
387
  * @memberof LiquidityParameters
388
388
  */
@@ -402,7 +402,7 @@ export interface MarketDefinition {
402
402
  */
403
403
  symbol: string;
404
404
  /**
405
- * Numerical identifier for each market, only needed to generate signatures
405
+ *
406
406
  * @type {number}
407
407
  * @memberof MarketDefinition
408
408
  */
@@ -414,37 +414,37 @@ export interface MarketDefinition {
414
414
  */
415
415
  minOrderQty: string;
416
416
  /**
417
- * Minimum size increment
417
+ *
418
418
  * @type {string}
419
419
  * @memberof MarketDefinition
420
420
  */
421
421
  qtyStepSize: string;
422
422
  /**
423
- * Minimum price increment
423
+ *
424
424
  * @type {string}
425
425
  * @memberof MarketDefinition
426
426
  */
427
427
  tickSize: string;
428
428
  /**
429
- * 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.
429
+ *
430
430
  * @type {string}
431
431
  * @memberof MarketDefinition
432
432
  */
433
433
  liquidationMarginParameter: string;
434
434
  /**
435
- * Minimum percentage of notional that needs to be covered post trade; if the account does not satisfy this requirement, trades will not get executed.
435
+ *
436
436
  * @type {string}
437
437
  * @memberof MarketDefinition
438
438
  */
439
439
  initialMarginParameter: string;
440
440
  /**
441
- * Maximum leverage allowed
441
+ *
442
442
  * @type {number}
443
443
  * @memberof MarketDefinition
444
444
  */
445
445
  maxLeverage: number;
446
446
  /**
447
- * Maximum one-sided open interest in units for a given market.
447
+ *
448
448
  * @type {string}
449
449
  * @memberof MarketDefinition
450
450
  */
@@ -464,49 +464,49 @@ export interface MarketSummary {
464
464
  */
465
465
  symbol: string;
466
466
  /**
467
- * Time when the market summary was last calculated (milliseconds)
467
+ *
468
468
  * @type {number}
469
469
  * @memberof MarketSummary
470
470
  */
471
471
  updatedAt: number;
472
472
  /**
473
- * Long open interest in lots
473
+ *
474
474
  * @type {string}
475
475
  * @memberof MarketSummary
476
476
  */
477
477
  longOiQty: string;
478
478
  /**
479
- * Short open interest in lots
479
+ *
480
480
  * @type {string}
481
481
  * @memberof MarketSummary
482
482
  */
483
483
  shortOiQty: string;
484
484
  /**
485
- * Total open interest quantity
485
+ *
486
486
  * @type {string}
487
487
  * @memberof MarketSummary
488
488
  */
489
489
  oiQty: string;
490
490
  /**
491
- * Current hourly funding rate
491
+ *
492
492
  * @type {string}
493
493
  * @memberof MarketSummary
494
494
  */
495
495
  fundingRate: string;
496
496
  /**
497
- * 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)
497
+ *
498
498
  * @type {string}
499
499
  * @memberof MarketSummary
500
500
  */
501
501
  longFundingValue: string;
502
502
  /**
503
- * 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)
503
+ *
504
504
  * @type {string}
505
505
  * @memberof MarketSummary
506
506
  */
507
507
  shortFundingValue: string;
508
508
  /**
509
- * Funding rate velocity
509
+ *
510
510
  * @type {string}
511
511
  * @memberof MarketSummary
512
512
  */
@@ -524,19 +524,19 @@ export interface MarketSummary {
524
524
  */
525
525
  pxChange24h?: string;
526
526
  /**
527
- * Last oracle price, at the moment of the last market summary update
527
+ *
528
528
  * @type {string}
529
529
  * @memberof MarketSummary
530
530
  */
531
531
  throttledOraclePrice?: string;
532
532
  /**
533
- * Last pool price, at the moment of the last market summary update
533
+ *
534
534
  * @type {string}
535
535
  * @memberof MarketSummary
536
536
  */
537
537
  throttledPoolPrice?: string;
538
538
  /**
539
- * Timestamp of the last price update (milliseconds)
539
+ *
540
540
  * @type {number}
541
541
  * @memberof MarketSummary
542
542
  */
@@ -580,7 +580,7 @@ export interface Order {
580
580
  */
581
581
  qty?: string;
582
582
  /**
583
- * 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.
583
+ *
584
584
  * @type {string}
585
585
  * @memberof Order
586
586
  */
@@ -604,7 +604,7 @@ export interface Order {
604
604
  */
605
605
  orderType: OrderType;
606
606
  /**
607
- * Price at which TP/SL orders will be triggered, should not be set for other order types.
607
+ *
608
608
  * @type {string}
609
609
  * @memberof Order
610
610
  */
@@ -628,13 +628,13 @@ export interface Order {
628
628
  */
629
629
  status: OrderStatus;
630
630
  /**
631
- * Creation timestamp (milliseconds)
631
+ *
632
632
  * @type {number}
633
633
  * @memberof Order
634
634
  */
635
635
  createdAt: number;
636
636
  /**
637
- * Last update timestamp (milliseconds)
637
+ *
638
638
  * @type {number}
639
639
  * @memberof Order
640
640
  */
@@ -673,62 +673,30 @@ export type OrderType = typeof OrderType[keyof typeof OrderType];
673
673
  export interface PaginationMeta {
674
674
  [key: string]: any | any;
675
675
  /**
676
- * Number of items requested
676
+ *
677
677
  * @type {number}
678
678
  * @memberof PaginationMeta
679
679
  */
680
680
  limit: number;
681
681
  /**
682
- * Number of items returned
682
+ *
683
683
  * @type {number}
684
684
  * @memberof PaginationMeta
685
685
  */
686
686
  count: number;
687
687
  /**
688
- * Timestamp of last result, in milliseconds
688
+ *
689
689
  * @type {number}
690
690
  * @memberof PaginationMeta
691
691
  */
692
692
  endTime?: number;
693
693
  /**
694
- * Timestamp of first result, in milliseconds
694
+ *
695
695
  * @type {number}
696
696
  * @memberof PaginationMeta
697
697
  */
698
698
  startTime?: number;
699
699
  }
700
- /**
701
- *
702
- * @export
703
- * @interface PaginationParameters
704
- */
705
- export interface PaginationParameters {
706
- [key: string]: any | any;
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
700
  /**
733
701
  *
734
702
  * @export
@@ -785,13 +753,13 @@ export interface PerpExecution {
785
753
  */
786
754
  type: ExecutionType;
787
755
  /**
788
- * Execution timestamp (milliseconds)
756
+ *
789
757
  * @type {number}
790
758
  * @memberof PerpExecution
791
759
  */
792
760
  timestamp: number;
793
761
  /**
794
- * Execution sequence number, increases by 1 for every perp execution in reya chain
762
+ *
795
763
  * @type {number}
796
764
  * @memberof PerpExecution
797
765
  */
@@ -861,13 +829,13 @@ export interface Position {
861
829
  */
862
830
  avgEntryPrice: string;
863
831
  /**
864
- * 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)
832
+ *
865
833
  * @type {string}
866
834
  * @memberof Position
867
835
  */
868
836
  avgEntryFundingValue: string;
869
837
  /**
870
- * Sequence number of last execution taken into account for the position.
838
+ *
871
839
  * @type {number}
872
840
  * @memberof Position
873
841
  */
@@ -887,19 +855,19 @@ export interface Price {
887
855
  */
888
856
  symbol: string;
889
857
  /**
890
- * 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
858
+ *
891
859
  * @type {string}
892
860
  * @memberof Price
893
861
  */
894
862
  oraclePrice: string;
895
863
  /**
896
- * 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.
864
+ *
897
865
  * @type {string}
898
866
  * @memberof Price
899
867
  */
900
868
  poolPrice?: string;
901
869
  /**
902
- * Last update timestamp (milliseconds)
870
+ *
903
871
  * @type {number}
904
872
  * @memberof Price
905
873
  */
@@ -1037,7 +1005,7 @@ export interface SpotExecution {
1037
1005
  */
1038
1006
  type: ExecutionType;
1039
1007
  /**
1040
- * Execution timestamp (milliseconds)
1008
+ *
1041
1009
  * @type {number}
1042
1010
  * @memberof SpotExecution
1043
1011
  */
@@ -1093,7 +1061,7 @@ export type TimeInForce = typeof TimeInForce[keyof typeof TimeInForce];
1093
1061
  export interface WalletConfiguration {
1094
1062
  [key: string]: any | any;
1095
1063
  /**
1096
- * Fee tier identifier
1064
+ *
1097
1065
  * @type {number}
1098
1066
  * @memberof WalletConfiguration
1099
1067
  */
package/rest/runtime.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Reya DEX Trading API v2
5
5
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
6
  *
7
- * The version of the OpenAPI document: 2.0.4
7
+ * The version of the OpenAPI document: 2.0.6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).