@reyaxyz/api-sdk 0.10.0 → 0.11.0

package/dist/clients/modules/account.js

@@ -61,14 +61,14 @@ var AccountClient = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Asynchronously retrieves a list of collateral accounts associated with a specific address.
+     * Asynchronously retrieves a list of margin accounts associated with a specific address.
      *
      * This method makes a request to the API endpoint to fetch collateral account data. The data is filtered
      * based on the provided Ethereum address. An optional limit can be specified to control the number of
      * collateral accounts returned in the response.
      *
      * @param {GetMarginAccountsParams} params
-     * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
+     * @returns {Promise<GetMarginAccountsResult>} A promise that resolves to the response containing the margin
      *                                                   account data.
      * @memberof account
      * */
@@ -88,19 +88,37 @@ var AccountClient = /** @class */ (function (_super) {
      * associated with the provided Ethereum address. The account is identified using the collateral account number.
      *
      * @param {GetMarginAccountParams} params
-     * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+     * @returns {Promise<GetMarginAccountResult>} A promise that resolves to the response containing the detailed
      *                                               information of the specified margin account.
      * @memberof account
      */
-    AccountClient.prototype.getCollateralAccount = function (params) {
+    AccountClient.prototype.getMarginAccount = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/accounts/".concat(params.address, "/collateralAccount/").concat(params.marginAccountNumber);
+                uri = "/api/accounts/".concat(params.address, "/marginAccount/").concat(params.marginAccountId);
                 return [2 /*return*/, this.get(uri)];
             });
         });
     };
+    AccountClient.prototype.getPositionsForMarginAccount = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var uri;
+            return __generator(this, function (_a) {
+                uri = "/api/accounts/".concat(params.address, "/marginAccount/").concat(params.marginAccountId, "/positions");
+                return [2 /*return*/, this.get(uri, { limit: params.limit })];
+            });
+        });
+    };
+    AccountClient.prototype.getPositionsHistoryForMarginAccount = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var uri;
+            return __generator(this, function (_a) {
+                uri = "/api/accounts/".concat(params.address, "/marginAccount/").concat(params.marginAccountId, "/positions/history");
+                return [2 /*return*/, this.get(uri, { limit: params.limit })];
+            });
+        });
+    };
     return AccountClient;
 }(rest_1.default));
 exports.default = AccountClient;

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

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAuCA,CAAC;IAtCC;;;;;;;;;;;SAWK;IAEC,yCAAiB,GAAvB,UACE,MAA+B;;;;gBAEzB,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,CAAE,CAAC;gBAC9C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAC;;;KAC/C;IAED;;;;;;;;;;OAUG;IAEG,4CAAoB,GAA1B,UACE,MAA8B;;;;gBAExB,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,gCAAsB,MAAM,CAAC,mBAAmB,CAAE,CAAC;gBAC9F,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} params\n   * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin\n   *                                                   account data.\n   * @memberof account\n   * */\n\n  async getMarginAccounts(\n    params: GetMarginAccountsParams,\n  ): Promise<MarginAccountEntity[]> {\n    const uri = `/api/accounts/${params.address}`;\n    return this.get(uri, { limit: params.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} params\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    params: GetMarginAccountParams,\n  ): Promise<MarginAccountEntity> {\n    const uri = `/api/accounts/${params.address}/collateralAccount/${params.marginAccountNumber}`;\n    return this.get(uri);\n  }\n}\n"]}
+{"version":3,"file":"account.js","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAqDA,CAAC;IApDC;;;;;;;;;;;SAWK;IAEC,yCAAiB,GAAvB,UACE,MAA+B;;;;gBAEzB,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,CAAE,CAAC;gBAC9C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAC;;;KAC/C;IAED;;;;;;;;;;OAUG;IAEG,wCAAgB,GAAtB,UACE,MAA8B;;;;gBAExB,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,4BAAkB,MAAM,CAAC,eAAe,CAAE,CAAC;gBACtF,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;KACtB;IAEK,oDAA4B,GAAlC,UACE,MAA0C;;;;gBAEpC,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,4BAAkB,MAAM,CAAC,eAAe,eAAY,CAAC;gBAChG,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAC;;;KAC/C;IAEK,2DAAmC,GAAzC,UACE,MAAiD;;;;gBAE3C,GAAG,GAAG,wBAAiB,MAAM,CAAC,OAAO,4BAAkB,MAAM,CAAC,eAAe,uBAAoB,CAAC;gBACxG,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAC;;;KAC/C;IACH,oBAAC;AAAD,CAAC,AArDD,CAA2C,cAAU,GAqDpD","sourcesContent":["import {\n  GetMarginAccountParams,\n  GetMarginAccountResult,\n  GetMarginAccountsParams,\n  GetMarginAccountsResult,\n  GetPositionsForMarginAccountParams,\n  GetPositionsForMarginAccountResult,\n  GetPositionsHistoryForMarginAccountParams,\n  GetPositionsHistoryForMarginAccountResult,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class AccountClient extends RestClient {\n  /**\n   * Asynchronously retrieves a list of margin 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} params\n   * @returns {Promise<GetMarginAccountsResult>} A promise that resolves to the response containing the margin\n   *                                                   account data.\n   * @memberof account\n   * */\n\n  async getMarginAccounts(\n    params: GetMarginAccountsParams,\n  ): Promise<GetMarginAccountsResult> {\n    const uri = `/api/accounts/${params.address}`;\n    return this.get(uri, { limit: params.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} params\n   * @returns {Promise<GetMarginAccountResult>} A promise that resolves to the response containing the detailed\n   *                                               information of the specified margin account.\n   * @memberof account\n   */\n\n  async getMarginAccount(\n    params: GetMarginAccountParams,\n  ): Promise<GetMarginAccountResult> {\n    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}`;\n    return this.get(uri);\n  }\n\n  async getPositionsForMarginAccount(\n    params: GetPositionsForMarginAccountParams,\n  ): Promise<GetPositionsForMarginAccountResult> {\n    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}/positions`;\n    return this.get(uri, { limit: params.limit });\n  }\n\n  async getPositionsHistoryForMarginAccount(\n    params: GetPositionsHistoryForMarginAccountParams,\n  ): Promise<GetPositionsHistoryForMarginAccountResult> {\n    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}/positions/history`;\n    return this.get(uri, { limit: params.limit });\n  }\n}\n"]}

package/dist/clients/modules/markets.js

@@ -66,8 +66,7 @@ var MarketsClient = /** @class */ (function (_super) {
      * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,
      * it fetches data for that particular market; otherwise, it fetches data for all available markets.
      *
-     * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.
-     * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.
+     * @returns {Promise<GetMarketsResult>} A promise that resolves to the response containing market data.
      * @memberof MarketsClient
      *
      * @example
@@ -78,12 +77,21 @@ var MarketsClient = /** @class */ (function (_super) {
      * // Fetch data for a specific market
      * const specificMarketData = await market.getMarkets('ETH-USDC');
      */
-    MarketsClient.prototype.getMarkets = function (params) {
+    MarketsClient.prototype.getMarkets = function () {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
                 uri = '/api/markets';
-                return [2 /*return*/, this.get(uri, { id: params === null || params === void 0 ? void 0 : params.id })];
+                return [2 /*return*/, this.get(uri)];
+            });
+        });
+    };
+    MarketsClient.prototype.getMarket = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var uri;
+            return __generator(this, function (_a) {
+                uri = "/api/markets/".concat(params.id);
+                return [2 /*return*/, this.get(uri)];
             });
         });
     };
@@ -93,38 +101,34 @@ var MarketsClient = /** @class */ (function (_super) {
      * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.
      * The data can be filtered by time range (fromISO and toISO) and resolution.
      *
-     * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.
-     * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').
-     * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.
-     * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.
-     * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.
+     * @param {GetCandlesParams} params
      * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.
      * @memberof MarketsClient
      *
      * @example
      * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');
      */
-    MarketsClient.prototype.getMarketCandles = function (marketId, resolution, fromISO, toISO, limit) {
+    MarketsClient.prototype.getMarketCandles = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/markets/candles/".concat(marketId);
+                uri = "/api/markets/candles/".concat(params.marketId);
                 return [2 /*return*/, this.get(uri, {
-                        resolution: resolution,
-                        fromISO: fromISO,
-                        toISO: toISO,
-                        limit: limit,
+                        resolution: params.resolution,
+                        fromISO: params.fromISO,
+                        toISO: params.toISO,
+                        limit: params.limit,
                     })];
             });
         });
     };
-    MarketsClient.prototype.getPerpetualMarketTrades = function (marketId, limit) {
+    MarketsClient.prototype.getMarketTradingHistory = function (params) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/trades/".concat(marketId);
+                uri = "/api/trades/".concat(params.marketId);
                 return [2 /*return*/, this.get(uri, {
-                        limit: limit,
+                        limit: params.limit,
                     })];
             });
         });

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

@@ -1 +1 @@
-{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAoEA,CAAC;IAnEC;;;;;;;;;;;;;;;;;OAiBG;IAEG,kCAAU,GAAhB,UAAiB,MAAyB;;;;gBAClC,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,EAAE,CAAC,EAAC;;;KAC1C;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,wCAAgB,GAAtB,UACE,QAA4B,EAC5B,UAA6B,EAC7B,OAAuB,EACvB,KAAqB,EACrB,KAAqB;;;;gBAEf,GAAG,GAAG,+BAAwB,QAAQ,CAAE,CAAC;gBAC/C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,UAAU,YAAA;wBACV,OAAO,SAAA;wBACP,KAAK,OAAA;wBACL,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IAEK,gDAAwB,GAA9B,UACE,QAAgB,EAChB,KAAqB;;;;gBAEf,GAAG,GAAG,sBAAe,QAAQ,CAAE,CAAC;gBACtC,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,KAAK,OAAA;qBACN,CAAC,EAAC;;;KACJ;IACH,oBAAC;AAAD,CAAC,AApED,CAA2C,cAAU,GAoEpD","sourcesContent":["import {\n  CandlesResolution,\n  GetMarketsParams,\n  MarketCandlesResponse,\n  MarketEntity,\n  TradesResponse,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class MarketsClient extends RestClient {\n  /**\n   * Asynchronously retrieves market data from the API.\n   *\n   * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,\n   * it fetches data for that particular market; otherwise, it fetches data for all available markets.\n   *\n   * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.\n   * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * // Fetch data for all markets\n   * const allMarketsData = await market.getMarkets();\n   *\n   * @example\n   * // Fetch data for a specific market\n   * const specificMarketData = await market.getMarkets('ETH-USDC');\n   */\n\n  async getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]> {\n    const uri = '/api/markets';\n    return this.get(uri, { id: params?.id });\n  }\n\n  /**\n   * Retrieves candlestick data for a specified market.\n   *\n   * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.\n   * The data can be filtered by time range (fromISO and toISO) and resolution.\n   *\n   * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.\n   * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').\n   * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.\n   * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.\n   * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');\n   */\n\n  async getMarketCandles(\n    marketId: MarketEntity['id'],\n    resolution: CandlesResolution,\n    fromISO?: string | null,\n    toISO?: string | null,\n    limit?: number | null,\n  ): Promise<MarketCandlesResponse> {\n    const uri = `/api/markets/candles/${marketId}`;\n    return this.get(uri, {\n      resolution,\n      fromISO,\n      toISO,\n      limit,\n    });\n  }\n\n  async getPerpetualMarketTrades(\n    marketId: number,\n    limit?: number | null,\n  ): Promise<TradesResponse> {\n    const uri = `/api/trades/${marketId}`;\n    return this.get(uri, {\n      limit,\n    });\n  }\n}\n"]}
+{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AASA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IA+DA,CAAC;IA9DC;;;;;;;;;;;;;;;;OAgBG;IAEG,kCAAU,GAAhB;;;;gBACQ,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;KACtB;IAEK,iCAAS,GAAf,UAAgB,MAAuB;;;;gBAC/B,GAAG,GAAG,uBAAgB,MAAM,CAAC,EAAE,CAAE,CAAC;gBACxC,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;KACtB;IAED;;;;;;;;;;;;OAYG;IAEG,wCAAgB,GAAtB,UACE,MAAwB;;;;gBAElB,GAAG,GAAG,+BAAwB,MAAM,CAAC,QAAQ,CAAE,CAAC;gBACtD,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,UAAU,EAAE,MAAM,CAAC,UAAU;wBAC7B,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;qBACpB,CAAC,EAAC;;;KACJ;IAEK,+CAAuB,GAA7B,UACE,MAAqC;;;;gBAE/B,GAAG,GAAG,sBAAe,MAAM,CAAC,QAAQ,CAAE,CAAC;gBAC7C,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;qBACpB,CAAC,EAAC;;;KACJ;IACH,oBAAC;AAAD,CAAC,AA/DD,CAA2C,cAAU,GA+DpD","sourcesContent":["import {\n  GetCandlesParams,\n  GetMarketParams,\n  GetMarketResult,\n  GetMarketsResult,\n  GetMarketTradingHistoryParams,\n  GetTradingHistoryResult,\n  MarketCandlesResponse,\n} from '../types';\nimport RestClient from './rest';\n\nexport default class MarketsClient extends RestClient {\n  /**\n   * Asynchronously retrieves market data from the API.\n   *\n   * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,\n   * it fetches data for that particular market; otherwise, it fetches data for all available markets.\n   *\n   * @returns {Promise<GetMarketsResult>} A promise that resolves to the response containing market data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * // Fetch data for all markets\n   * const allMarketsData = await market.getMarkets();\n   *\n   * @example\n   * // Fetch data for a specific market\n   * const specificMarketData = await market.getMarkets('ETH-USDC');\n   */\n\n  async getMarkets(): Promise<GetMarketsResult> {\n    const uri = '/api/markets';\n    return this.get(uri);\n  }\n\n  async getMarket(params: GetMarketParams): Promise<GetMarketResult> {\n    const uri = `/api/markets/${params.id}`;\n    return this.get(uri);\n  }\n\n  /**\n   * Retrieves candlestick data for a specified market.\n   *\n   * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.\n   * The data can be filtered by time range (fromISO and toISO) and resolution.\n   *\n   * @param {GetCandlesParams} params\n   * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.\n   * @memberof MarketsClient\n   *\n   * @example\n   * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');\n   */\n\n  async getMarketCandles(\n    params: GetCandlesParams,\n  ): Promise<MarketCandlesResponse> {\n    const uri = `/api/markets/candles/${params.marketId}`;\n    return this.get(uri, {\n      resolution: params.resolution,\n      fromISO: params.fromISO,\n      toISO: params.toISO,\n      limit: params.limit,\n    });\n  }\n\n  async getMarketTradingHistory(\n    params: GetMarketTradingHistoryParams,\n  ): Promise<GetTradingHistoryResult> {\n    const uri = `/api/trades/${params.marketId}`;\n    return this.get(uri, {\n      limit: params.limit,\n    });\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 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"]}
+{"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 GetMarketsResult = MarketEntity[];\n\nexport type GetMarketResult = MarketEntity;\n\nexport type GetMarketParams = {\n  id: MarketEntity['id'];\n};\n\nexport type GetCandlesParams = {\n  marketId: MarketEntity['id'];\n  resolution: CandlesResolution;\n  fromISO?: string | null;\n  toISO?: string | null;\n  limit?: number | null;\n};\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  marginAccountId: MarginAccountEntity['id'];\n};\n\nexport type GetPositionsForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: 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 type GetMarginAccountsResult = MarginAccountEntity[];\nexport type GetMarginAccountResult = MarginAccountEntity;\n\nexport type PositionEntity = {\n  id: number;\n  side: Side;\n  size: number;\n  price: number;\n  markPrice: number;\n  orderStatus: Status;\n  realisedPnl?: number | null;\n  unrealisedPnl?: number | null;\n  liquidationPrice: number;\n  fundingRate: number;\n  market: MarketEntity;\n  date: Date;\n};\n\nexport type GetPositionsForMarginAccountResult = {\n  positions: PositionEntity[];\n  totalUnrealizedPNL: number;\n};\n\n// --- Trading History ----\n\nexport type GetMarketTradingHistoryParams = {\n  marketId: number;\n  limit?: number;\n};\n\nexport type TradingHistoryEntity = {\n  id: number;\n  price: number;\n  priceUnderlyingToken: string;\n  size: number;\n  sizeUnderlyingToken: string;\n  timestampMillisecondsUTC: number;\n};\n\nexport type GetTradingHistoryResult = TradingHistoryEntity[];\n\n// --- Position History ---\n\nexport type GetPositionsHistoryForMarginAccountParams = {\n  address: string;\n  marginAccountId: MarginAccountEntity['id'];\n  limit?: number;\n};\n\nexport type OrderType = 'market';\n\nexport type PositionHistoryType =\n  | 'long-trade'\n  | 'short-trade'\n  | 'long-liquidation'\n  | 'short-liquidation';\n\nexport type PositionHistoryEntity = {\n  id: number;\n  action: PositionHistoryType;\n  orderType: OrderType;\n  size: number;\n  executionPrice: number;\n  realisedPnl?: number | null;\n  fees: number;\n  timestamp: number;\n  market: MarketEntity;\n};\n\nexport type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];\n"]}

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

@@ -1,19 +1,19 @@
-import { GetMarginAccountParams, GetMarginAccountsParams, MarginAccountEntity } from '../types';
+import { GetMarginAccountParams, GetMarginAccountResult, GetMarginAccountsParams, GetMarginAccountsResult, GetPositionsForMarginAccountParams, GetPositionsForMarginAccountResult, GetPositionsHistoryForMarginAccountParams, GetPositionsHistoryForMarginAccountResult } from '../types';
 import RestClient from './rest';
 export default class AccountClient extends RestClient {
     /**
-     * Asynchronously retrieves a list of collateral accounts associated with a specific address.
+     * Asynchronously retrieves a list of margin accounts associated with a specific address.
      *
      * This method makes a request to the API endpoint to fetch collateral account data. The data is filtered
      * based on the provided Ethereum address. An optional limit can be specified to control the number of
      * collateral accounts returned in the response.
      *
      * @param {GetMarginAccountsParams} params
-     * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
+     * @returns {Promise<GetMarginAccountsResult>} A promise that resolves to the response containing the margin
      *                                                   account data.
      * @memberof account
      * */
-    getMarginAccounts(params: GetMarginAccountsParams): Promise<MarginAccountEntity[]>;
+    getMarginAccounts(params: GetMarginAccountsParams): Promise<GetMarginAccountsResult>;
     /**
      * Asynchronously retrieves details of a specific collateral account for a given Ethereum address.
      *
@@ -21,10 +21,12 @@ export default class AccountClient extends RestClient {
      * associated with the provided Ethereum address. The account is identified using the collateral account number.
      *
      * @param {GetMarginAccountParams} params
-     * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+     * @returns {Promise<GetMarginAccountResult>} A promise that resolves to the response containing the detailed
      *                                               information of the specified margin account.
      * @memberof account
      */
-    getCollateralAccount(params: GetMarginAccountParams): Promise<MarginAccountEntity>;
+    getMarginAccount(params: GetMarginAccountParams): Promise<GetMarginAccountResult>;
+    getPositionsForMarginAccount(params: GetPositionsForMarginAccountParams): Promise<GetPositionsForMarginAccountResult>;
+    getPositionsHistoryForMarginAccount(params: GetPositionsHistoryForMarginAccountParams): Promise<GetPositionsHistoryForMarginAccountResult>;
 }
 //# 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,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,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAKjC;;;;;;;;;;OAUG;IAEG,oBAAoB,CACxB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,mBAAmB,CAAC;CAIhC"}
+{"version":3,"file":"account.d.ts","sourceRoot":"/","sources":["clients/modules/account.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,kCAAkC,EAClC,kCAAkC,EAClC,yCAAyC,EACzC,yCAAyC,EAC1C,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;SAWK;IAEC,iBAAiB,CACrB,MAAM,EAAE,uBAAuB,GAC9B,OAAO,CAAC,uBAAuB,CAAC;IAKnC;;;;;;;;;;OAUG;IAEG,gBAAgB,CACpB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,sBAAsB,CAAC;IAK5B,4BAA4B,CAChC,MAAM,EAAE,kCAAkC,GACzC,OAAO,CAAC,kCAAkC,CAAC;IAKxC,mCAAmC,CACvC,MAAM,EAAE,yCAAyC,GAChD,OAAO,CAAC,yCAAyC,CAAC;CAItD"}

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

@@ -1,4 +1,4 @@
-import { CandlesResolution, GetMarketsParams, MarketCandlesResponse, MarketEntity, TradesResponse } from '../types';
+import { GetCandlesParams, GetMarketParams, GetMarketResult, GetMarketsResult, GetMarketTradingHistoryParams, GetTradingHistoryResult, MarketCandlesResponse } from '../types';
 import RestClient from './rest';
 export default class MarketsClient extends RestClient {
     /**
@@ -7,8 +7,7 @@ export default class MarketsClient extends RestClient {
      * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,
      * it fetches data for that particular market; otherwise, it fetches data for all available markets.
      *
-     * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.
-     * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.
+     * @returns {Promise<GetMarketsResult>} A promise that resolves to the response containing market data.
      * @memberof MarketsClient
      *
      * @example
@@ -19,25 +18,22 @@ export default class MarketsClient extends RestClient {
      * // Fetch data for a specific market
      * const specificMarketData = await market.getMarkets('ETH-USDC');
      */
-    getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]>;
+    getMarkets(): Promise<GetMarketsResult>;
+    getMarket(params: GetMarketParams): Promise<GetMarketResult>;
     /**
      * Retrieves candlestick data for a specified market.
      *
      * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.
      * The data can be filtered by time range (fromISO and toISO) and resolution.
      *
-     * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.
-     * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').
-     * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.
-     * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.
-     * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.
+     * @param {GetCandlesParams} params
      * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.
      * @memberof MarketsClient
      *
      * @example
      * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');
      */
-    getMarketCandles(marketId: MarketEntity['id'], resolution: CandlesResolution, fromISO?: string | null, toISO?: string | null, limit?: number | null): Promise<MarketCandlesResponse>;
-    getPerpetualMarketTrades(marketId: number, limit?: number | null): Promise<TradesResponse>;
+    getMarketCandles(params: GetCandlesParams): Promise<MarketCandlesResponse>;
+    getMarketTradingHistory(params: GetMarketTradingHistoryParams): Promise<GetTradingHistoryResult>;
 }
 //# sourceMappingURL=markets.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"markets.d.ts","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACZ,cAAc,EACf,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;;OAiBG;IAEG,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAKpE;;;;;;;;;;;;;;;;OAgBG;IAEG,gBAAgB,CACpB,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,EAC5B,UAAU,EAAE,iBAAiB,EAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,EACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,qBAAqB,CAAC;IAU3B,wBAAwB,CAC5B,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,cAAc,CAAC;CAM3B"}
+{"version":3,"file":"markets.d.ts","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,6BAA6B,EAC7B,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAClB,OAAO,UAAU,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;OAgBG;IAEG,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAKvC,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAKlE;;;;;;;;;;;;OAYG;IAEG,gBAAgB,CACpB,MAAM,EAAE,gBAAgB,GACvB,OAAO,CAAC,qBAAqB,CAAC;IAU3B,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,GACpC,OAAO,CAAC,uBAAuB,CAAC;CAMpC"}

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

@@ -40,8 +40,17 @@ export type MarketEntity = {
     description: string;
     tickSizeDecimals: number;
 };
-export type GetMarketsParams = {
-    id?: number;
+export type GetMarketsResult = MarketEntity[];
+export type GetMarketResult = MarketEntity;
+export type GetMarketParams = {
+    id: MarketEntity['id'];
+};
+export type GetCandlesParams = {
+    marketId: MarketEntity['id'];
+    resolution: CandlesResolution;
+    fromISO?: string | null;
+    toISO?: string | null;
+    limit?: number | null;
 };
 export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
 export type Side = 'LONG' | 'SHORT';
@@ -51,7 +60,12 @@ export type GetMarginAccountsParams = {
 };
 export type GetMarginAccountParams = {
     address: string;
-    marginAccountNumber: number;
+    marginAccountId: MarginAccountEntity['id'];
+};
+export type GetPositionsForMarginAccountParams = {
+    address: string;
+    marginAccountId: MarginAccountEntity['id'];
+    limit?: number;
 };
 export type MarginAccountEntity = {
     id: number;
@@ -67,29 +81,56 @@ export type MarginAccountEntity = {
         balanceRUSD: number;
     }[];
 };
-export interface Position {
+export type GetMarginAccountsResult = MarginAccountEntity[];
+export type GetMarginAccountResult = MarginAccountEntity;
+export type PositionEntity = {
     id: number;
-    symbol: string;
     side: Side;
     size: number;
     price: number;
-    orderStatus: Status;
     markPrice: number;
-    unrealisedPnl: number;
-    realisedPnl: number;
+    orderStatus: Status;
+    realisedPnl?: number | null;
+    unrealisedPnl?: number | null;
     liquidationPrice: number;
-    fundingRate: string;
-    date: string;
-}
-export type Trade = {
+    fundingRate: number;
+    market: MarketEntity;
+    date: Date;
+};
+export type GetPositionsForMarginAccountResult = {
+    positions: PositionEntity[];
+    totalUnrealizedPNL: number;
+};
+export type GetMarketTradingHistoryParams = {
+    marketId: number;
+    limit?: number;
+};
+export type TradingHistoryEntity = {
     id: number;
-    side: Side;
-    size: string;
     price: number;
-    date: string;
-    txId: string;
+    priceUnderlyingToken: string;
+    size: number;
+    sizeUnderlyingToken: string;
+    timestampMillisecondsUTC: number;
 };
-export type TradesResponse = {
-    trades: Trade[];
+export type GetTradingHistoryResult = TradingHistoryEntity[];
+export type GetPositionsHistoryForMarginAccountParams = {
+    address: string;
+    marginAccountId: MarginAccountEntity['id'];
+    limit?: number;
+};
+export type OrderType = 'market';
+export type PositionHistoryType = 'long-trade' | 'short-trade' | 'long-liquidation' | 'short-liquidation';
+export type PositionHistoryEntity = {
+    id: number;
+    action: PositionHistoryType;
+    orderType: OrderType;
+    size: number;
+    executionPrice: number;
+    realisedPnl?: number | null;
+    fees: number;
+    timestamp: number;
+    market: MarketEntity;
 };
+export type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];
 //# sourceMappingURL=types.d.ts.map

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,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"}
+{"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,YAAY,EAAE,CAAC;AAE9C,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC;AAE3C,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAIF,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,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,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,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAC5D,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAIF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,EAAE,CAAC;AAI7D,MAAM,MAAM,yCAAyC,GAAG;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;AAEjC,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,aAAa,GACb,kBAAkB,GAClB,mBAAmB,CAAC;AAExB,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG,qBAAqB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reyaxyz/api-sdk",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -36,5 +36,5 @@
     "axios": "^1.6.2"
   },
   "packageManager": "pnpm@8.10.4",
-  "gitHead": "faa38b7af7e74b04a98215efadbef38fab902665"
+  "gitHead": "fd3cc11b3fd31d81704adca09e2816b79d3a9721"
 }

package/src/clients/modules/account.ts

@@ -1,27 +1,32 @@
 import {
   GetMarginAccountParams,
+  GetMarginAccountResult,
   GetMarginAccountsParams,
-  MarginAccountEntity,
+  GetMarginAccountsResult,
+  GetPositionsForMarginAccountParams,
+  GetPositionsForMarginAccountResult,
+  GetPositionsHistoryForMarginAccountParams,
+  GetPositionsHistoryForMarginAccountResult,
 } from '../types';
 import RestClient from './rest';
 
 export default class AccountClient extends RestClient {
   /**
-   * Asynchronously retrieves a list of collateral accounts associated with a specific address.
+   * Asynchronously retrieves a list of margin accounts associated with a specific address.
    *
    * This method makes a request to the API endpoint to fetch collateral account data. The data is filtered
    * based on the provided Ethereum address. An optional limit can be specified to control the number of
    * collateral accounts returned in the response.
    *
    * @param {GetMarginAccountsParams} params
-   * @returns {Promise<MarginAccountEntity[]>} A promise that resolves to the response containing the margin
+   * @returns {Promise<GetMarginAccountsResult>} A promise that resolves to the response containing the margin
    *                                                   account data.
    * @memberof account
    * */
 
   async getMarginAccounts(
     params: GetMarginAccountsParams,
-  ): Promise<MarginAccountEntity[]> {
+  ): Promise<GetMarginAccountsResult> {
     const uri = `/api/accounts/${params.address}`;
     return this.get(uri, { limit: params.limit });
   }
@@ -33,15 +38,29 @@ export default class AccountClient extends RestClient {
    * associated with the provided Ethereum address. The account is identified using the collateral account number.
    *
    * @param {GetMarginAccountParams} params
-   * @returns {Promise<MarginAccountEntity>} A promise that resolves to the response containing the detailed
+   * @returns {Promise<GetMarginAccountResult>} A promise that resolves to the response containing the detailed
    *                                               information of the specified margin account.
    * @memberof account
    */
 
-  async getCollateralAccount(
+  async getMarginAccount(
     params: GetMarginAccountParams,
-  ): Promise<MarginAccountEntity> {
-    const uri = `/api/accounts/${params.address}/collateralAccount/${params.marginAccountNumber}`;
+  ): Promise<GetMarginAccountResult> {
+    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}`;
     return this.get(uri);
   }
+
+  async getPositionsForMarginAccount(
+    params: GetPositionsForMarginAccountParams,
+  ): Promise<GetPositionsForMarginAccountResult> {
+    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}/positions`;
+    return this.get(uri, { limit: params.limit });
+  }
+
+  async getPositionsHistoryForMarginAccount(
+    params: GetPositionsHistoryForMarginAccountParams,
+  ): Promise<GetPositionsHistoryForMarginAccountResult> {
+    const uri = `/api/accounts/${params.address}/marginAccount/${params.marginAccountId}/positions/history`;
+    return this.get(uri, { limit: params.limit });
+  }
 }

package/src/clients/modules/markets.ts

@@ -1,9 +1,11 @@
 import {
-  CandlesResolution,
-  GetMarketsParams,
+  GetCandlesParams,
+  GetMarketParams,
+  GetMarketResult,
+  GetMarketsResult,
+  GetMarketTradingHistoryParams,
+  GetTradingHistoryResult,
   MarketCandlesResponse,
-  MarketEntity,
-  TradesResponse,
 } from '../types';
 import RestClient from './rest';
 
@@ -14,8 +16,7 @@ export default class MarketsClient extends RestClient {
    * This method makes a request to the API to fetch data for markets. If a specific market is provided as a parameter,
    * it fetches data for that particular market; otherwise, it fetches data for all available markets.
    *
-   * @param {GetMarketsParams} [params] - The specific market ticker identifier for which data is requested. This parameter is optional.
-   * @returns {Promise<MarketEntity[]>} A promise that resolves to the response containing market data.
+   * @returns {Promise<GetMarketsResult>} A promise that resolves to the response containing market data.
    * @memberof MarketsClient
    *
    * @example
@@ -27,9 +28,14 @@ export default class MarketsClient extends RestClient {
    * const specificMarketData = await market.getMarkets('ETH-USDC');
    */
 
-  async getMarkets(params?: GetMarketsParams): Promise<MarketEntity[]> {
+  async getMarkets(): Promise<GetMarketsResult> {
     const uri = '/api/markets';
-    return this.get(uri, { id: params?.id });
+    return this.get(uri);
+  }
+
+  async getMarket(params: GetMarketParams): Promise<GetMarketResult> {
+    const uri = `/api/markets/${params.id}`;
+    return this.get(uri);
   }
 
   /**
@@ -38,11 +44,7 @@ export default class MarketsClient extends RestClient {
    * This method fetches historical candlestick (or OHLC - Open, High, Low, Close) data for a given market.
    * The data can be filtered by time range (fromISO and toISO) and resolution.
    *
-   * @param {number} marketId - The market identifier for which candlestick data is to be retrieved.
-   * @param {CandlesResolution} resolution - The granularity of the candlestick data (e.g., '1MIN', '5MIN', '1HR').
-   * @param {string|null} [fromISO] - The start time for the range of candlestick data in ISO 8601 format. Optional.
-   * @param {string|null} [toISO] - The end time for the range of candlestick data in ISO 8601 format. Optional.
-   * @param {number|null} [limit] - The maximum number of candlestick data points to retrieve. Optional.
+   * @param {GetCandlesParams} params
    * @returns {Promise<MarketCandlesResponse>} A promise that resolves to the market candlestick data.
    * @memberof MarketsClient
    *
@@ -51,28 +53,23 @@ export default class MarketsClient extends RestClient {
    */
 
   async getMarketCandles(
-    marketId: MarketEntity['id'],
-    resolution: CandlesResolution,
-    fromISO?: string | null,
-    toISO?: string | null,
-    limit?: number | null,
+    params: GetCandlesParams,
   ): Promise<MarketCandlesResponse> {
-    const uri = `/api/markets/candles/${marketId}`;
+    const uri = `/api/markets/candles/${params.marketId}`;
     return this.get(uri, {
-      resolution,
-      fromISO,
-      toISO,
-      limit,
+      resolution: params.resolution,
+      fromISO: params.fromISO,
+      toISO: params.toISO,
+      limit: params.limit,
     });
   }
 
-  async getPerpetualMarketTrades(
-    marketId: number,
-    limit?: number | null,
-  ): Promise<TradesResponse> {
-    const uri = `/api/trades/${marketId}`;
+  async getMarketTradingHistory(
+    params: GetMarketTradingHistoryParams,
+  ): Promise<GetTradingHistoryResult> {
+    const uri = `/api/trades/${params.marketId}`;
     return this.get(uri, {
-      limit,
+      limit: params.limit,
     });
   }
 }

package/src/clients/types.ts

@@ -47,9 +47,22 @@ export type MarketEntity = {
   tickSizeDecimals: number;
 };
 
-export type GetMarketsParams = {
-  id?: number;
+export type GetMarketsResult = MarketEntity[];
+
+export type GetMarketResult = MarketEntity;
+
+export type GetMarketParams = {
+  id: MarketEntity['id'];
+};
+
+export type GetCandlesParams = {
+  marketId: MarketEntity['id'];
+  resolution: CandlesResolution;
+  fromISO?: string | null;
+  toISO?: string | null;
+  limit?: number | null;
 };
+
 // -- Account --
 
 export type Status = 'OPEN' | 'CLOSED' | 'LIQUIDATED' | 'FILLED';
@@ -62,7 +75,13 @@ export type GetMarginAccountsParams = {
 
 export type GetMarginAccountParams = {
   address: string;
-  marginAccountNumber: number;
+  marginAccountId: MarginAccountEntity['id'];
+};
+
+export type GetPositionsForMarginAccountParams = {
+  address: string;
+  marginAccountId: MarginAccountEntity['id'];
+  limit?: number;
 };
 
 export type MarginAccountEntity = {
@@ -80,30 +99,73 @@ export type MarginAccountEntity = {
   }[];
 };
 
-export interface Position {
+export type GetMarginAccountsResult = MarginAccountEntity[];
+export type GetMarginAccountResult = MarginAccountEntity;
+
+export type PositionEntity = {
   id: number;
-  symbol: string;
   side: Side;
   size: number;
   price: number;
-  orderStatus: Status;
   markPrice: number;
-  unrealisedPnl: number;
-  realisedPnl: number;
+  orderStatus: Status;
+  realisedPnl?: number | null;
+  unrealisedPnl?: number | null;
   liquidationPrice: number;
-  fundingRate: string;
-  date: string;
-}
+  fundingRate: number;
+  market: MarketEntity;
+  date: Date;
+};
+
+export type GetPositionsForMarginAccountResult = {
+  positions: PositionEntity[];
+  totalUnrealizedPNL: number;
+};
 
-export type Trade = {
+// --- Trading History ----
+
+export type GetMarketTradingHistoryParams = {
+  marketId: number;
+  limit?: number;
+};
+
+export type TradingHistoryEntity = {
   id: number;
-  side: Side;
-  size: string;
   price: number;
-  date: string;
-  txId: string;
+  priceUnderlyingToken: string;
+  size: number;
+  sizeUnderlyingToken: string;
+  timestampMillisecondsUTC: number;
 };
 
-export type TradesResponse = {
-  trades: Trade[];
+export type GetTradingHistoryResult = TradingHistoryEntity[];
+
+// --- Position History ---
+
+export type GetPositionsHistoryForMarginAccountParams = {
+  address: string;
+  marginAccountId: MarginAccountEntity['id'];
+  limit?: number;
+};
+
+export type OrderType = 'market';
+
+export type PositionHistoryType =
+  | 'long-trade'
+  | 'short-trade'
+  | 'long-liquidation'
+  | 'short-liquidation';
+
+export type PositionHistoryEntity = {
+  id: number;
+  action: PositionHistoryType;
+  orderType: OrderType;
+  size: number;
+  executionPrice: number;
+  realisedPnl?: number | null;
+  fees: number;
+  timestamp: number;
+  market: MarketEntity;
 };
+
+export type GetPositionsHistoryForMarginAccountResult = PositionHistoryEntity[];