@reyaxyz/api-sdk 0.6.3

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.
Files changed (53) hide show
  1. package/LICENSE.md +1 -0
  2. package/README.md +18 -0
  3. package/dist/clients/api-client.js +51 -0
  4. package/dist/clients/api-client.js.map +1 -0
  5. package/dist/clients/helpers/constants.js +13 -0
  6. package/dist/clients/helpers/constants.js.map +1 -0
  7. package/dist/clients/helpers/query-helper.js +21 -0
  8. package/dist/clients/helpers/query-helper.js.map +1 -0
  9. package/dist/clients/lib/axios.js +69 -0
  10. package/dist/clients/lib/axios.js.map +1 -0
  11. package/dist/clients/modules/account.js +122 -0
  12. package/dist/clients/modules/account.js.map +1 -0
  13. package/dist/clients/modules/markets.js +135 -0
  14. package/dist/clients/modules/markets.js.map +1 -0
  15. package/dist/clients/modules/rest.js +77 -0
  16. package/dist/clients/modules/rest.js.map +1 -0
  17. package/dist/clients/socket-client.js +2 -0
  18. package/dist/clients/socket-client.js.map +1 -0
  19. package/dist/clients/types.js +14 -0
  20. package/dist/clients/types.js.map +1 -0
  21. package/dist/index.js +6 -0
  22. package/dist/index.js.map +1 -0
  23. package/dist/types/clients/api-client.d.ts +30 -0
  24. package/dist/types/clients/api-client.d.ts.map +1 -0
  25. package/dist/types/clients/helpers/constants.d.ts +7 -0
  26. package/dist/types/clients/helpers/constants.d.ts.map +1 -0
  27. package/dist/types/clients/helpers/query-helper.d.ts +2 -0
  28. package/dist/types/clients/helpers/query-helper.d.ts.map +1 -0
  29. package/dist/types/clients/lib/axios.d.ts +14 -0
  30. package/dist/types/clients/lib/axios.d.ts.map +1 -0
  31. package/dist/types/clients/modules/account.d.ts +45 -0
  32. package/dist/types/clients/modules/account.d.ts.map +1 -0
  33. package/dist/types/clients/modules/markets.d.ts +43 -0
  34. package/dist/types/clients/modules/markets.d.ts.map +1 -0
  35. package/dist/types/clients/modules/rest.d.ts +9 -0
  36. package/dist/types/clients/modules/rest.d.ts.map +1 -0
  37. package/dist/types/clients/socket-client.d.ts +1 -0
  38. package/dist/types/clients/socket-client.d.ts.map +1 -0
  39. package/dist/types/clients/types.d.ts +106 -0
  40. package/dist/types/clients/types.d.ts.map +1 -0
  41. package/dist/types/index.d.ts +2 -0
  42. package/dist/types/index.d.ts.map +1 -0
  43. package/package.json +40 -0
  44. package/src/clients/api-client.ts +43 -0
  45. package/src/clients/helpers/constants.ts +11 -0
  46. package/src/clients/helpers/query-helper.ts +17 -0
  47. package/src/clients/lib/axios.ts +34 -0
  48. package/src/clients/modules/account.ts +63 -0
  49. package/src/clients/modules/markets.ts +77 -0
  50. package/src/clients/modules/rest.ts +31 -0
  51. package/src/clients/socket-client.ts +0 -0
  52. package/src/clients/types.ts +122 -0
  53. package/src/index.ts +1 -0
@@ -0,0 +1,122 @@
1
+ export enum CandlesResolution {
2
+ ONE_MINUTE = '1MIN',
3
+ FIVE_MINUTES = '5MINS',
4
+ FIFTEEN_MINUTES = '15MINS',
5
+ THIRTY_MINUTES = '30MINS',
6
+ ONE_HOUR = '1HOUR',
7
+ FOUR_HOURS = '4HOURS',
8
+ ONE_DAY = '1DAY',
9
+ }
10
+
11
+ // -- Candles --
12
+ export interface Candle {
13
+ startedAt: string;
14
+ ticker: string;
15
+ resolution: CandlesResolution;
16
+ low: string;
17
+ high: string;
18
+ open: string;
19
+ close: string;
20
+ baseTokenVolume: string;
21
+ usdVolume: string;
22
+ trades: number;
23
+ startingOpenInterest: string;
24
+ id: string;
25
+ }
26
+
27
+ export interface MarketCandlesResponse {
28
+ candles: Candle[];
29
+ }
30
+
31
+ // -- Markets --
32
+
33
+ export interface MarketEntry {
34
+ id: number;
35
+ ticker: string;
36
+ instrumentName: string;
37
+ instrumentType: string;
38
+ underlyingAsset: string;
39
+ quoteAsset: string;
40
+ markPrice: number;
41
+ indexPrice: number;
42
+ isActive: boolean;
43
+ maxLeverage: number;
44
+ volume24H: number;
45
+ priceChange24H: number;
46
+ priceChange24HPercentage: string;
47
+ openInterest: string;
48
+ fundingRate: string;
49
+ priceStep: number;
50
+ amountStep: number;
51
+ minOrderValue: number;
52
+ }
53
+
54
+ export interface MarketListResponse {
55
+ [key: string]: MarketEntry;
56
+ }
57
+
58
+ // -- Account --
59
+
60
+ export interface CollateralAccount {
61
+ id: number;
62
+ name: string;
63
+ equity: number;
64
+ balance: number;
65
+ marginRatio: string;
66
+ collaterals: Collateral[];
67
+ positions: Position[];
68
+ }
69
+
70
+ export interface Collateral {
71
+ collateralAsset: string;
72
+ balance: number;
73
+ availableBalance: number;
74
+ withdrawableBalance: number;
75
+ collateralValue: number;
76
+ }
77
+
78
+ export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
79
+ export type Side = 'LONG' | 'SHORT';
80
+
81
+ export interface Position {
82
+ id: number;
83
+ symbol: string;
84
+ side: Side;
85
+ size: number;
86
+ price: number;
87
+ orderStatus: Status;
88
+ markPrice: number;
89
+ unrealisedPnl: number;
90
+ realisedPnl: number;
91
+ liquidationPrice: number;
92
+ fundingRate: string;
93
+ date: string;
94
+ }
95
+
96
+ export interface CollateralAccountListResponse {
97
+ address: string;
98
+ collateralAccounts: CollateralAccount[];
99
+ }
100
+
101
+ export interface CollateralAccountResponse {
102
+ address: string;
103
+ id: number;
104
+ name: string;
105
+ equity: number;
106
+ balance: number;
107
+ marginRatio: string;
108
+ collaterals: Collateral[];
109
+ positions: Position[];
110
+ }
111
+
112
+ export type Trade = {
113
+ id: number;
114
+ side: Side;
115
+ size: string;
116
+ price: number;
117
+ date: string;
118
+ };
119
+
120
+ export type TradesResponse = {
121
+ trades: Trade[];
122
+ };
package/src/index.ts ADDED
@@ -0,0 +1 @@
1
+ export { ApiClient } from './clients/api-client';