@reyaxyz/api-sdk 0.6.4 → 0.7.0

package/dist/clients/modules/account.js

@@ -67,27 +67,17 @@ var AccountClient = /** @class */ (function (_super) {
      * based on the provided Ethereum address. An optional limit can be specified to control the number of
      * collateral accounts returned in the response.
      *
-     * @param {string} address - The Ethereum address for which collateral account data is being requested.
-     * @param {number} [limit] - An optional limit on the number of collateral accounts to retrieve. If not specified,
-     *                           all available collateral accounts for the address will be returned.
-     * @returns {Promise<CollateralAccountListResponse>} A promise that resolves to the response containing the collateral
+     * @param {GetMarginAccountsParams} getMarginAccountsParams
+     * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
      *                                                   account data.
      * @memberof account
-     *
-     * @example
-     * // Fetch all collateral accounts for a specific address
-     * const accounts = await account.getCollateralAccounts('0x123...');
-     *
-     * @example
-     * // Fetch a limited number of collateral accounts for a specific address
-     * const limitedAccounts = await account.getCollateralAccounts('0x123...', 5);
-     */
-    AccountClient.prototype.getCollateralAccounts = function (address, limit) {
+     * */
+    AccountClient.prototype.getCollateralAccounts = function (getMarginAccountsParams) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/accounts/".concat(address);
-                return [2 /*return*/, this.get(uri, { limit: limit })];
+                uri = "/api/accounts/".concat(getMarginAccountsParams.address);
+                return [2 /*return*/, this.get(uri, { limit: getMarginAccountsParams.limit })];
             });
         });
     };
@@ -97,21 +87,16 @@ var AccountClient = /** @class */ (function (_super) {
      * This method sends a request to the API to obtain detailed information about a specific collateral account
      * associated with the provided Ethereum address. The account is identified using the collateral account number.
      *
-     * @param {string} address - The Ethereum address associated with the collateral account.
-     * @param {number} collateralAccountNumber - The number identifying the specific collateral account.
-     * @returns {Promise<CollateralAccountResponse>} A promise that resolves to the response containing the detailed
-     *                                               information of the specified collateral account.
+     * @param {GetMarginAccountParams} getMarginAccountParams
+     * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+     *                                               information of the specified margin account.
      * @memberof account
-     *
-     * @example
-     * // Fetch details of a specific collateral account by its number for a given address
-     * const accountDetails = await account.getCollateralAccount('0x123...', 1);
      */
-    AccountClient.prototype.getCollateralAccount = function (address, collateralAccountNumber) {
+    AccountClient.prototype.getCollateralAccount = function (getMarginAccountParams) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/accounts/".concat(address, "/collateralAccount/").concat(collateralAccountNumber);
+                uri = "/api/accounts/".concat(getMarginAccountParams.address, "/collateralAccount/").concat(getMarginAccountParams.marginAccountNumber);
                 return [2 /*return*/, this.get(uri)];
             });
         });

package/dist/clients/modules/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAwDA,CAAC;IAvDC;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEG,6CAAqB,GAA3B,UACE,OAAe,EACf,KAAc;;;;gBAER,GAAG,GAAG,wBAAiB,OAAO,CAAE,CAAC;gBACvC,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,OAAA,EAAE,CAAC,EAAC;;;KACjC;IAED;;;;;;;;;;;;;;;OAeG;IAEG,4CAAoB,GAA1B,UACE,OAAe,EACf,uBAA+B;;;;gBAEzB,GAAG,GAAG,wBAAiB,OAAO,gCAAsB,uBAAuB,CAAE,CAAC;gBACpF,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;KACtB;IACH,oBAAC;AAAD,CAAC,AAxDD,CAA2C,cAAU,GAwDpD","sourcesContent":["import {\n  CollateralAccountListResponse,\n  CollateralAccountResponse,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class AccountClient extends RestClient {\n  /**\n   * Asynchronously retrieves a list of collateral accounts associated with a specific address.\n   *\n   * This method makes a request to the API endpoint to fetch collateral account data. The data is filtered\n   * based on the provided Ethereum address. An optional limit can be specified to control the number of\n   * collateral accounts returned in the response.\n   *\n   * @param {string} address - The Ethereum address for which collateral account data is being requested.\n   * @param {number} [limit] - An optional limit on the number of collateral accounts to retrieve. If not specified,\n   *                           all available collateral accounts for the address will be returned.\n   * @returns {Promise<CollateralAccountListResponse>} A promise that resolves to the response containing the collateral\n   *                                                   account data.\n   * @memberof account\n   *\n   * @example\n   * // Fetch all collateral accounts for a specific address\n   * const accounts = await account.getCollateralAccounts('0x123...');\n   *\n   * @example\n   * // Fetch a limited number of collateral accounts for a specific address\n   * const limitedAccounts = await account.getCollateralAccounts('0x123...', 5);\n   */\n\n  async getCollateralAccounts(\n    address: string,\n    limit?: number,\n  ): Promise<CollateralAccountListResponse> {\n    const uri = `/api/accounts/${address}`;\n    return this.get(uri, { limit });\n  }\n\n  /**\n   * Asynchronously retrieves details of a specific collateral account for a given Ethereum address.\n   *\n   * This method sends a request to the API to obtain detailed information about a specific collateral account\n   * associated with the provided Ethereum address. The account is identified using the collateral account number.\n   *\n   * @param {string} address - The Ethereum address associated with the collateral account.\n   * @param {number} collateralAccountNumber - The number identifying the specific collateral account.\n   * @returns {Promise<CollateralAccountResponse>} A promise that resolves to the response containing the detailed\n   *                                               information of the specified collateral account.\n   * @memberof account\n   *\n   * @example\n   * // Fetch details of a specific collateral account by its number for a given address\n   * const accountDetails = await account.getCollateralAccount('0x123...', 1);\n   */\n\n  async getCollateralAccount(\n    address: string,\n    collateralAccountNumber: number,\n  ): Promise<CollateralAccountResponse> {\n    const uri = `/api/accounts/${address}/collateralAccount/${collateralAccountNumber}`;\n    return this.get(uri);\n  }\n}\n"]}
+{"version":3,"file":"account.js","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAuCA,CAAC;IAtCC;;;;;;;;;;;SAWK;IAEC,6CAAqB,GAA3B,UACE,uBAAgD;;;;gBAE1C,GAAG,GAAG,wBAAiB,uBAAuB,CAAC,OAAO,CAAE,CAAC;gBAC/D,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,uBAAuB,CAAC,KAAK,EAAE,CAAC,EAAC;;;KAChE;IAED;;;;;;;;;;OAUG;IAEG,4CAAoB,GAA1B,UACE,sBAA8C;;;;gBAExC,GAAG,GAAG,wBAAiB,sBAAsB,CAAC,OAAO,gCAAsB,sBAAsB,CAAC,mBAAmB,CAAE,CAAC;gBAC9H,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;KACtB;IACH,oBAAC;AAAD,CAAC,AAvCD,CAA2C,cAAU,GAuCpD","sourcesContent":["import {\n  GetMarginAccountParams,\n  GetMarginAccountsParams,\n  MarginAccountEntity,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class AccountClient extends RestClient {\n  /**\n   * Asynchronously retrieves a list of collateral accounts associated with a specific address.\n   *\n   * This method makes a request to the API endpoint to fetch collateral account data. The data is filtered\n   * based on the provided Ethereum address. An optional limit can be specified to control the number of\n   * collateral accounts returned in the response.\n   *\n   * @param {GetMarginAccountsParams} getMarginAccountsParams\n   * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin\n   *                                                   account data.\n   * @memberof account\n   * */\n\n  async getCollateralAccounts(\n    getMarginAccountsParams: GetMarginAccountsParams,\n  ): Promise<MarginAccountEntity[]> {\n    const uri = `/api/accounts/${getMarginAccountsParams.address}`;\n    return this.get(uri, { limit: getMarginAccountsParams.limit });\n  }\n\n  /**\n   * Asynchronously retrieves details of a specific collateral account for a given Ethereum address.\n   *\n   * This method sends a request to the API to obtain detailed information about a specific collateral account\n   * associated with the provided Ethereum address. The account is identified using the collateral account number.\n   *\n   * @param {GetMarginAccountParams} getMarginAccountParams\n   * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed\n   *                                               information of the specified margin account.\n   * @memberof account\n   */\n\n  async getCollateralAccount(\n    getMarginAccountParams: GetMarginAccountParams,\n  ): Promise<MarginAccountEntity> {\n    const uri = `/api/accounts/${getMarginAccountParams.address}/collateralAccount/${getMarginAccountParams.marginAccountNumber}`;\n    return this.get(uri);\n  }\n}\n"]}

package/dist/clients/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,+CAA0B,CAAA;IAC1B,8CAAyB,CAAA;IACzB,uCAAkB,CAAA;IAClB,0CAAqB,CAAA;IACrB,qCAAgB,CAAA;AAClB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B","sourcesContent":["export enum CandlesResolution {\n  ONE_MINUTE = '1MIN',\n  FIVE_MINUTES = '5MINS',\n  FIFTEEN_MINUTES = '15MINS',\n  THIRTY_MINUTES = '30MINS',\n  ONE_HOUR = '1HOUR',\n  FOUR_HOURS = '4HOURS',\n  ONE_DAY = '1DAY',\n}\n\n// -- Candles --\nexport interface Candle {\n  startedAt: string;\n  ticker: string;\n  resolution: CandlesResolution;\n  low: string;\n  high: string;\n  open: string;\n  close: string;\n  baseTokenVolume: string;\n  usdVolume: string;\n  trades: number;\n  startingOpenInterest: string;\n  id: string;\n}\n\nexport interface MarketCandlesResponse {\n  candles: Candle[];\n}\n\n// -- Markets --\n\nexport type MarketEntity = {\n  id: number;\n  ticker: string;\n  underlyingAsset: string;\n  quoteToken: string;\n  markPrice: number;\n  isActive: boolean;\n  maxLeverage: number;\n  volume24H: number;\n  priceChange24H: number;\n  priceChange24HPercentage: number;\n  openInterest: number;\n  fundingRate: number;\n  description: string;\n  tickSizeDecimals: number;\n};\n\nexport type GetMarketsParams = {\n  id?: number;\n};\n// -- Account --\n\nexport interface CollateralAccount {\n  id: number;\n  name: string;\n  equity: number;\n  balance: number;\n  marginRatio: string;\n  collaterals: Collateral[];\n  positions: Position[];\n}\n\nexport interface Collateral {\n  collateralAsset: string;\n  balance: number;\n  availableBalance: number;\n  withdrawableBalance: number;\n  collateralValue: number;\n}\n\nexport type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';\nexport type Side = 'LONG' | 'SHORT';\n\nexport interface Position {\n  id: number;\n  symbol: string;\n  side: Side;\n  size: number;\n  price: number;\n  orderStatus: Status;\n  markPrice: number;\n  unrealisedPnl: number;\n  realisedPnl: number;\n  liquidationPrice: number;\n  fundingRate: string;\n  date: string;\n}\n\nexport interface CollateralAccountListResponse {\n  address: string;\n  collateralAccounts: CollateralAccount[];\n}\n\nexport interface CollateralAccountResponse {\n  address: string;\n  id: number;\n  name: string;\n  equity: number;\n  balance: number;\n  marginRatio: string;\n  collaterals: Collateral[];\n  positions: Position[];\n}\n\nexport type Trade = {\n  id: number;\n  side: Side;\n  size: string;\n  price: number;\n  date: string;\n  txId: string;\n};\n\nexport type TradesResponse = {\n  trades: Trade[];\n};\n"]}
+{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,2CAAsB,CAAA;IACtB,+CAA0B,CAAA;IAC1B,8CAAyB,CAAA;IACzB,uCAAkB,CAAA;IAClB,0CAAqB,CAAA;IACrB,qCAAgB,CAAA;AAClB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B","sourcesContent":["export enum CandlesResolution {\n  ONE_MINUTE = '1MIN',\n  FIVE_MINUTES = '5MINS',\n  FIFTEEN_MINUTES = '15MINS',\n  THIRTY_MINUTES = '30MINS',\n  ONE_HOUR = '1HOUR',\n  FOUR_HOURS = '4HOURS',\n  ONE_DAY = '1DAY',\n}\n\n// -- Candles --\nexport interface Candle {\n  startedAt: string;\n  ticker: string;\n  resolution: CandlesResolution;\n  low: string;\n  high: string;\n  open: string;\n  close: string;\n  baseTokenVolume: string;\n  usdVolume: string;\n  trades: number;\n  startingOpenInterest: string;\n  id: string;\n}\n\nexport interface MarketCandlesResponse {\n  candles: Candle[];\n}\n\n// -- Markets --\n\nexport type MarketEntity = {\n  id: number;\n  ticker: string;\n  underlyingAsset: string;\n  quoteToken: string;\n  markPrice: number;\n  isActive: boolean;\n  maxLeverage: number;\n  volume24H: number;\n  priceChange24H: number;\n  priceChange24HPercentage: number;\n  openInterest: number;\n  fundingRate: number;\n  description: string;\n  tickSizeDecimals: number;\n};\n\nexport type GetMarketsParams = {\n  id?: number;\n};\n// -- Account --\n\nexport type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';\nexport type Side = 'LONG' | 'SHORT';\n\nexport type GetMarginAccountsParams = {\n  address: string;\n  limit?: number;\n};\n\nexport type GetMarginAccountParams = {\n  address: string;\n  marginAccountNumber: number;\n};\n\nexport type MarginAccountEntity = {\n  id: number;\n  name: string;\n  marginRatioHealth: 'danger' | 'healthy' | 'warning';\n  marginRatioPercentage: number;\n  totalBalance: number;\n  totalBalanceUnderlyingAsset: string;\n  collaterals: {\n    token: string;\n    percentage: number;\n    balance: number;\n    balanceRUSD: number;\n  }[];\n};\n\nexport interface Position {\n  id: number;\n  symbol: string;\n  side: Side;\n  size: number;\n  price: number;\n  orderStatus: Status;\n  markPrice: number;\n  unrealisedPnl: number;\n  realisedPnl: number;\n  liquidationPrice: number;\n  fundingRate: string;\n  date: string;\n}\n\nexport type Trade = {\n  id: number;\n  side: Side;\n  size: string;\n  price: number;\n  date: string;\n  txId: string;\n};\n\nexport type TradesResponse = {\n  trades: Trade[];\n};\n"]}

package/dist/types/clients/modules/account.d.ts

@@ -1,4 +1,4 @@
-import { CollateralAccountListResponse, CollateralAccountResponse } from '../types';
+import { GetMarginAccountParams, GetMarginAccountsParams, MarginAccountEntity } from '../types';
 import RestClient from './rest';
 export default class AccountClient extends RestClient {
     /**
@@ -8,38 +8,23 @@ export default class AccountClient extends RestClient {
      * based on the provided Ethereum address. An optional limit can be specified to control the number of
      * collateral accounts returned in the response.
      *
-     * @param {string} address - The Ethereum address for which collateral account data is being requested.
-     * @param {number} [limit] - An optional limit on the number of collateral accounts to retrieve. If not specified,
-     *                           all available collateral accounts for the address will be returned.
-     * @returns {Promise<CollateralAccountListResponse>} A promise that resolves to the response containing the collateral
+     * @param {GetMarginAccountsParams} getMarginAccountsParams
+     * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
      *                                                   account data.
      * @memberof account
-     *
-     * @example
-     * // Fetch all collateral accounts for a specific address
-     * const accounts = await account.getCollateralAccounts('0x123...');
-     *
-     * @example
-     * // Fetch a limited number of collateral accounts for a specific address
-     * const limitedAccounts = await account.getCollateralAccounts('0x123...', 5);
-     */
-    getCollateralAccounts(address: string, limit?: number): Promise<CollateralAccountListResponse>;
+     * */
+    getCollateralAccounts(getMarginAccountsParams: GetMarginAccountsParams): Promise<MarginAccountEntity[]>;
     /**
      * Asynchronously retrieves details of a specific collateral account for a given Ethereum address.
      *
      * This method sends a request to the API to obtain detailed information about a specific collateral account
      * associated with the provided Ethereum address. The account is identified using the collateral account number.
      *
-     * @param {string} address - The Ethereum address associated with the collateral account.
-     * @param {number} collateralAccountNumber - The number identifying the specific collateral account.
-     * @returns {Promise<CollateralAccountResponse>} A promise that resolves to the response containing the detailed
-     *                                               information of the specified collateral account.
+     * @param {GetMarginAccountParams} getMarginAccountParams
+     * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+     *                                               information of the specified margin account.
      * @memberof account
-     *
-     * @example
-     * // Fetch details of a specific collateral account by its number for a given address
-     * const accountDetails = await account.getCollateralAccount('0x123...', 1);
      */
-    getCollateralAccount(address: string, collateralAccountNumber: number): Promise<CollateralAccountResponse>;
+    getCollateralAccount(getMarginAccountParams: GetMarginAccountParams): Promise<MarginAccountEntity>;
 }
 //# sourceMappingURL=account.d.ts.map

package/dist/types/clients/modules/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAC7B,yBAAyB,EAC1B,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEG,qBAAqB,CACzB,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,6BAA6B,CAAC;IAKzC;;;;;;;;;;;;;;;OAeG;IAEG,oBAAoB,CACxB,OAAO,EAAE,MAAM,EACf,uBAAuB,EAAE,MAAM,GAC9B,OAAO,CAAC,yBAAyB,CAAC;CAItC"}
+{"version":3,"file":"account.d.ts","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;SAWK;IAEC,qBAAqB,CACzB,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAKjC;;;;;;;;;;OAUG;IAEG,oBAAoB,CACxB,sBAAsB,EAAE,sBAAsB,GAC7C,OAAO,CAAC,mBAAmB,CAAC;CAIhC"}

package/dist/types/clients/types.d.ts

@@ -43,24 +43,30 @@ export type MarketEntity = {
 export type GetMarketsParams = {
     id?: number;
 };
-export interface CollateralAccount {
-    id: number;
-    name: string;
-    equity: number;
-    balance: number;
-    marginRatio: string;
-    collaterals: Collateral[];
-    positions: Position[];
-}
-export interface Collateral {
-    collateralAsset: string;
-    balance: number;
-    availableBalance: number;
-    withdrawableBalance: number;
-    collateralValue: number;
-}
 export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
 export type Side = 'LONG' | 'SHORT';
+export type GetMarginAccountsParams = {
+    address: string;
+    limit?: number;
+};
+export type GetMarginAccountParams = {
+    address: string;
+    marginAccountNumber: number;
+};
+export type MarginAccountEntity = {
+    id: number;
+    name: string;
+    marginRatioHealth: 'danger' | 'healthy' | 'warning';
+    marginRatioPercentage: number;
+    totalBalance: number;
+    totalBalanceUnderlyingAsset: string;
+    collaterals: {
+        token: string;
+        percentage: number;
+        balance: number;
+        balanceRUSD: number;
+    }[];
+};
 export interface Position {
     id: number;
     symbol: string;
@@ -75,20 +81,6 @@ export interface Position {
     fundingRate: string;
     date: string;
 }
-export interface CollateralAccountListResponse {
-    address: string;
-    collateralAccounts: CollateralAccount[];
-}
-export interface CollateralAccountResponse {
-    address: string;
-    id: number;
-    name: string;
-    equity: number;
-    balance: number;
-    marginRatio: string;
-    collaterals: Collateral[];
-    positions: Position[];
-}
 export type Trade = {
     id: number;
     side: Side;

package/dist/types/clients/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":"AAAA,oBAAY,iBAAiB;IAC3B,UAAU,SAAS;IACnB,YAAY,UAAU;IACtB,eAAe,WAAW;IAC1B,cAAc,WAAW;IACzB,QAAQ,UAAU;IAClB,UAAU,WAAW;IACrB,OAAO,SAAS;CACjB;AAGD,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,iBAAiB,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAID,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAGF,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;AACjE,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpC,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/types.ts"],"names":[],"mappings":"AAAA,oBAAY,iBAAiB;IAC3B,UAAU,SAAS;IACnB,YAAY,UAAU;IACtB,eAAe,WAAW;IAC1B,cAAc,WAAW;IACzB,QAAQ,UAAU;IAClB,UAAU,WAAW;IACrB,OAAO,SAAS;CACjB;AAGD,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,iBAAiB,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,MAAM,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAID,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAGF,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;AACjE,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpC,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IACpD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B,EAAE,MAAM,CAAC;IACpC,WAAW,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reyaxyz/api-sdk",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -36,5 +36,5 @@
     "axios": "^1.6.2"
   },
   "packageManager": "pnpm@8.10.4",
-  "gitHead": "dba265659591bc135dc84f4c799fb8e9d19af3b4"
+  "gitHead": "0a81b19c8d03ac890f08059f697aa4d907ad39e0"
 }

package/src/clients/modules/account.ts

@@ -1,6 +1,7 @@
 import {
-  CollateralAccountListResponse,
-  CollateralAccountResponse,
+  GetMarginAccountParams,
+  GetMarginAccountsParams,
+  MarginAccountEntity,
 } from '../types';
 import RestClient from './rest';
 
@@ -12,28 +13,17 @@ export default class AccountClient extends RestClient {
    * based on the provided Ethereum address. An optional limit can be specified to control the number of
    * collateral accounts returned in the response.
    *
-   * @param {string} address - The Ethereum address for which collateral account data is being requested.
-   * @param {number} [limit] - An optional limit on the number of collateral accounts to retrieve. If not specified,
-   *                           all available collateral accounts for the address will be returned.
-   * @returns {Promise<CollateralAccountListResponse>} A promise that resolves to the response containing the collateral
+   * @param {GetMarginAccountsParams} getMarginAccountsParams
+   * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
    *                                                   account data.
    * @memberof account
-   *
-   * @example
-   * // Fetch all collateral accounts for a specific address
-   * const accounts = await account.getCollateralAccounts('0x123...');
-   *
-   * @example
-   * // Fetch a limited number of collateral accounts for a specific address
-   * const limitedAccounts = await account.getCollateralAccounts('0x123...', 5);
-   */
+   * */
 
   async getCollateralAccounts(
-    address: string,
-    limit?: number,
-  ): Promise<CollateralAccountListResponse> {
-    const uri = `/api/accounts/${address}`;
-    return this.get(uri, { limit });
+    getMarginAccountsParams: GetMarginAccountsParams,
+  ): Promise<MarginAccountEntity[]> {
+    const uri = `/api/accounts/${getMarginAccountsParams.address}`;
+    return this.get(uri, { limit: getMarginAccountsParams.limit });
   }
 
   /**
@@ -42,22 +32,16 @@ export default class AccountClient extends RestClient {
    * This method sends a request to the API to obtain detailed information about a specific collateral account
    * associated with the provided Ethereum address. The account is identified using the collateral account number.
    *
-   * @param {string} address - The Ethereum address associated with the collateral account.
-   * @param {number} collateralAccountNumber - The number identifying the specific collateral account.
-   * @returns {Promise<CollateralAccountResponse>} A promise that resolves to the response containing the detailed
-   *                                               information of the specified collateral account.
+   * @param {GetMarginAccountParams} getMarginAccountParams
+   * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+   *                                               information of the specified margin account.
    * @memberof account
-   *
-   * @example
-   * // Fetch details of a specific collateral account by its number for a given address
-   * const accountDetails = await account.getCollateralAccount('0x123...', 1);
    */
 
   async getCollateralAccount(
-    address: string,
-    collateralAccountNumber: number,
-  ): Promise<CollateralAccountResponse> {
-    const uri = `/api/accounts/${address}/collateralAccount/${collateralAccountNumber}`;
+    getMarginAccountParams: GetMarginAccountParams,
+  ): Promise<MarginAccountEntity> {
+    const uri = `/api/accounts/${getMarginAccountParams.address}/collateralAccount/${getMarginAccountParams.marginAccountNumber}`;
     return this.get(uri);
   }
 }

package/src/clients/types.ts

@@ -52,27 +52,34 @@ export type GetMarketsParams = {
 };
 // -- Account --
 
-export interface CollateralAccount {
-  id: number;
-  name: string;
-  equity: number;
-  balance: number;
-  marginRatio: string;
-  collaterals: Collateral[];
-  positions: Position[];
-}
-
-export interface Collateral {
-  collateralAsset: string;
-  balance: number;
-  availableBalance: number;
-  withdrawableBalance: number;
-  collateralValue: number;
-}
-
 export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
 export type Side = 'LONG' | 'SHORT';
 
+export type GetMarginAccountsParams = {
+  address: string;
+  limit?: number;
+};
+
+export type GetMarginAccountParams = {
+  address: string;
+  marginAccountNumber: number;
+};
+
+export type MarginAccountEntity = {
+  id: number;
+  name: string;
+  marginRatioHealth: 'danger' | 'healthy' | 'warning';
+  marginRatioPercentage: number;
+  totalBalance: number;
+  totalBalanceUnderlyingAsset: string;
+  collaterals: {
+    token: string;
+    percentage: number;
+    balance: number;
+    balanceRUSD: number;
+  }[];
+};
+
 export interface Position {
   id: number;
   symbol: string;
@@ -88,22 +95,6 @@ export interface Position {
   date: string;
 }
 
-export interface CollateralAccountListResponse {
-  address: string;
-  collateralAccounts: CollateralAccount[];
-}
-
-export interface CollateralAccountResponse {
-  address: string;
-  id: number;
-  name: string;
-  equity: number;
-  balance: number;
-  marginRatio: string;
-  collaterals: Collateral[];
-  positions: Position[];
-}
-
 export type Trade = {
   id: number;
   side: Side;