@reyaxyz/api-sdk 0.6.3 → 0.6.4

package/README.md

@@ -1,12 +1,4 @@
-# @reya-network/api-sdk
-
-<p align="center">
-  <a href="https://app.voltz.xyz/">
-    <picture>
-      <img src="./assets/voltz-background.jpeg" alt="Voltz" width="512" />
-    </picture>
-  </a>
-</p>
+# @reyaxyz/api-sdk
 
 <p align="center"> API sdk for the Reya Network </p>
 

package/dist/clients/modules/markets.js

@@ -66,8 +66,8 @@ 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 {string} [market] - The specific market ticker identifier for which data is requested. This parameter is optional.
-     * @returns {Promise<MarketListResponse>} A promise that resolves to the response containing market data.
+     * @param {GetMarketsParams} [getMarketsParams] - 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.
      * @memberof MarketsClient
      *
      * @example
@@ -78,12 +78,12 @@ var MarketsClient = /** @class */ (function (_super) {
      * // Fetch data for a specific market
      * const specificMarketData = await market.getMarkets('ETH-USDC');
      */
-    MarketsClient.prototype.getMarkets = function (market) {
+    MarketsClient.prototype.getMarkets = function (getMarketsParams) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
                 uri = '/api/markets';
-                return [2 /*return*/, this.get(uri, { ticker: market })];
+                return [2 /*return*/, this.get(uri, { id: getMarketsParams.id })];
             });
         });
     };
@@ -93,7 +93,7 @@ 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 {string} market - The market identifier for which candlestick data is to be retrieved.
+     * @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.
@@ -104,11 +104,11 @@ var MarketsClient = /** @class */ (function (_super) {
      * @example
      * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');
      */
-    MarketsClient.prototype.getMarketCandles = function (market, resolution, fromISO, toISO, limit) {
+    MarketsClient.prototype.getMarketCandles = function (marketId, resolution, fromISO, toISO, limit) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/markets/candles/".concat(market);
+                uri = "/api/markets/candles/".concat(marketId);
                 return [2 /*return*/, this.get(uri, {
                         resolution: resolution,
                         fromISO: fromISO,
@@ -118,11 +118,11 @@ var MarketsClient = /** @class */ (function (_super) {
             });
         });
     };
-    MarketsClient.prototype.getPerpetualMarketTrades = function (market, limit) {
+    MarketsClient.prototype.getPerpetualMarketTrades = function (marketId, limit) {
         return __awaiter(this, void 0, void 0, function () {
             var uri;
             return __generator(this, function (_a) {
-                uri = "/api/trades/".concat(market);
+                uri = "/api/trades/".concat(marketId);
                 return [2 /*return*/, this.get(uri, {
                         limit: limit,
                     })];

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

@@ -1 +1 @@
-{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAoEA,CAAC;IAnEC;;;;;;;;;;;;;;;;;OAiBG;IAEG,kCAAU,GAAhB,UAAiB,MAAe;;;;gBACxB,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAC;;;KAC1C;IAED;;;;;;;;;;;;;;;;OAgBG;IAEG,wCAAgB,GAAtB,UACE,MAAc,EACd,UAA6B,EAC7B,OAAuB,EACvB,KAAqB,EACrB,KAAqB;;;;gBAEf,GAAG,GAAG,+BAAwB,MAAM,CAAE,CAAC;gBAC7C,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,MAAc,EACd,KAAqB;;;;gBAEf,GAAG,GAAG,sBAAe,MAAM,CAAE,CAAC;gBACpC,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  MarketCandlesResponse,\n  MarketListResponse,\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 {string} [market] - The specific market ticker identifier for which data is requested. This parameter is optional.\n   * @returns {Promise<MarketListResponse>} 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(market?: string): Promise<MarketListResponse> {\n    const uri = '/api/markets';\n    return this.get(uri, { ticker: market });\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 {string} market - 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    market: string,\n    resolution: CandlesResolution,\n    fromISO?: string | null,\n    toISO?: string | null,\n    limit?: number | null,\n  ): Promise<MarketCandlesResponse> {\n    const uri = `/api/markets/candles/${market}`;\n    return this.get(uri, {\n      resolution,\n      fromISO,\n      toISO,\n      limit,\n    });\n  }\n\n  async getPerpetualMarketTrades(\n    market: string,\n    limit?: number | null,\n  ): Promise<TradesResponse> {\n    const uri = `/api/trades/${market}`;\n    return this.get(uri, {\n      limit,\n    });\n  }\n}\n"]}
+{"version":3,"file":"markets.js","sourceRoot":"/","sources":["clients/modules/markets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,gDAAgC;AAEhC;IAA2C,iCAAU;IAArD;;IAsEA,CAAC;IArEC;;;;;;;;;;;;;;;;;OAiBG;IAEG,kCAAU,GAAhB,UACE,gBAAkC;;;;gBAE5B,GAAG,GAAG,cAAc,CAAC;gBAC3B,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,gBAAgB,CAAC,EAAE,EAAE,CAAC,EAAC;;;KACnD;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,AAtED,CAA2C,cAAU,GAsEpD","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} [getMarketsParams] - 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(\n    getMarketsParams: GetMarketsParams,\n  ): Promise<MarketEntity[]> {\n    const uri = '/api/markets';\n    return this.get(uri, { id: getMarketsParams.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"]}

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 interface MarketEntry {\n  id: number;\n  ticker: string;\n  instrumentName: string;\n  instrumentType: string;\n  underlyingAsset: string;\n  quoteAsset: string;\n  markPrice: number;\n  indexPrice: number;\n  isActive: boolean;\n  maxLeverage: number;\n  volume24H: number;\n  priceChange24H: number;\n  priceChange24HPercentage: string;\n  openInterest: string;\n  fundingRate: string;\n  priceStep: number;\n  amountStep: number;\n  minOrderValue: number;\n}\n\nexport interface MarketListResponse {\n  [key: string]: MarketEntry;\n}\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};\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 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"]}

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

@@ -1,4 +1,4 @@
-import { CandlesResolution, MarketCandlesResponse, MarketListResponse, TradesResponse } from '../types';
+import { CandlesResolution, GetMarketsParams, MarketCandlesResponse, MarketEntity, TradesResponse } from '../types';
 import RestClient from './rest';
 export default class MarketsClient extends RestClient {
     /**
@@ -7,8 +7,8 @@ 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 {string} [market] - The specific market ticker identifier for which data is requested. This parameter is optional.
-     * @returns {Promise<MarketListResponse>} A promise that resolves to the response containing market data.
+     * @param {GetMarketsParams} [getMarketsParams] - 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.
      * @memberof MarketsClient
      *
      * @example
@@ -19,14 +19,14 @@ export default class MarketsClient extends RestClient {
      * // Fetch data for a specific market
      * const specificMarketData = await market.getMarkets('ETH-USDC');
      */
-    getMarkets(market?: string): Promise<MarketListResponse>;
+    getMarkets(getMarketsParams: GetMarketsParams): Promise<MarketEntity[]>;
     /**
      * 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 {string} market - The market identifier for which candlestick data is to be retrieved.
+     * @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.
@@ -37,7 +37,7 @@ export default class MarketsClient extends RestClient {
      * @example
      * const marketCandles = await market.getMarketCandles('BTC-USD', '1HR', '2023-01-01T00:00:00Z', '2023-01-02T00:00:00Z');
      */
-    getMarketCandles(market: string, resolution: CandlesResolution, fromISO?: string | null, toISO?: string | null, limit?: number | null): Promise<MarketCandlesResponse>;
-    getPerpetualMarketTrades(market: string, limit?: number | null): Promise<TradesResponse>;
+    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>;
 }
 //# 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,qBAAqB,EACrB,kBAAkB,EAClB,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,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAK9D;;;;;;;;;;;;;;;;OAgBG;IAEG,gBAAgB,CACpB,MAAM,EAAE,MAAM,EACd,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,MAAM,EAAE,MAAM,EACd,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,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,CACd,gBAAgB,EAAE,gBAAgB,GACjC,OAAO,CAAC,YAAY,EAAE,CAAC;IAK1B;;;;;;;;;;;;;;;;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"}

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

@@ -24,29 +24,25 @@ export interface Candle {
 export interface MarketCandlesResponse {
     candles: Candle[];
 }
-export interface MarketEntry {
+export type MarketEntity = {
     id: number;
     ticker: string;
-    instrumentName: string;
-    instrumentType: string;
     underlyingAsset: string;
-    quoteAsset: string;
+    quoteToken: string;
     markPrice: number;
-    indexPrice: number;
     isActive: boolean;
     maxLeverage: number;
     volume24H: number;
     priceChange24H: number;
-    priceChange24HPercentage: string;
-    openInterest: string;
-    fundingRate: string;
-    priceStep: number;
-    amountStep: number;
-    minOrderValue: number;
-}
-export interface MarketListResponse {
-    [key: string]: MarketEntry;
-}
+    priceChange24HPercentage: number;
+    openInterest: number;
+    fundingRate: number;
+    description: string;
+    tickSizeDecimals: number;
+};
+export type GetMarketsParams = {
+    id?: number;
+};
 export interface CollateralAccount {
     id: number;
     name: string;
@@ -99,6 +95,7 @@ export type Trade = {
     size: string;
     price: number;
     date: string;
+    txId: string;
 };
 export type TradesResponse = {
     trades: Trade[];

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,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,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,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5B;AAID,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;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,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"}

package/package.json

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

package/src/clients/modules/markets.ts

@@ -1,7 +1,8 @@
 import {
   CandlesResolution,
+  GetMarketsParams,
   MarketCandlesResponse,
-  MarketListResponse,
+  MarketEntity,
   TradesResponse,
 } from '../types';
 import RestClient from './rest';
@@ -13,8 +14,8 @@ 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 {string} [market] - The specific market ticker identifier for which data is requested. This parameter is optional.
-   * @returns {Promise<MarketListResponse>} A promise that resolves to the response containing market data.
+   * @param {GetMarketsParams} [getMarketsParams] - 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.
    * @memberof MarketsClient
    *
    * @example
@@ -26,9 +27,11 @@ export default class MarketsClient extends RestClient {
    * const specificMarketData = await market.getMarkets('ETH-USDC');
    */
 
-  async getMarkets(market?: string): Promise<MarketListResponse> {
+  async getMarkets(
+    getMarketsParams: GetMarketsParams,
+  ): Promise<MarketEntity[]> {
     const uri = '/api/markets';
-    return this.get(uri, { ticker: market });
+    return this.get(uri, { id: getMarketsParams.id });
   }
 
   /**
@@ -37,7 +40,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 {string} market - The market identifier for which candlestick data is to be retrieved.
+   * @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.
@@ -50,13 +53,13 @@ export default class MarketsClient extends RestClient {
    */
 
   async getMarketCandles(
-    market: string,
+    marketId: MarketEntity['id'],
     resolution: CandlesResolution,
     fromISO?: string | null,
     toISO?: string | null,
     limit?: number | null,
   ): Promise<MarketCandlesResponse> {
-    const uri = `/api/markets/candles/${market}`;
+    const uri = `/api/markets/candles/${marketId}`;
     return this.get(uri, {
       resolution,
       fromISO,
@@ -66,10 +69,10 @@ export default class MarketsClient extends RestClient {
   }
 
   async getPerpetualMarketTrades(
-    market: string,
+    marketId: number,
     limit?: number | null,
   ): Promise<TradesResponse> {
-    const uri = `/api/trades/${market}`;
+    const uri = `/api/trades/${marketId}`;
     return this.get(uri, {
       limit,
     });

package/src/clients/types.ts

@@ -30,31 +30,26 @@ export interface MarketCandlesResponse {
 
 // -- Markets --
 
-export interface MarketEntry {
+export type MarketEntity = {
   id: number;
   ticker: string;
-  instrumentName: string;
-  instrumentType: string;
   underlyingAsset: string;
-  quoteAsset: string;
+  quoteToken: string;
   markPrice: number;
-  indexPrice: number;
   isActive: boolean;
   maxLeverage: number;
   volume24H: number;
   priceChange24H: number;
-  priceChange24HPercentage: string;
-  openInterest: string;
-  fundingRate: string;
-  priceStep: number;
-  amountStep: number;
-  minOrderValue: number;
-}
-
-export interface MarketListResponse {
-  [key: string]: MarketEntry;
-}
+  priceChange24HPercentage: number;
+  openInterest: number;
+  fundingRate: number;
+  description: string;
+  tickSizeDecimals: number;
+};
 
+export type GetMarketsParams = {
+  id?: number;
+};
 // -- Account --
 
 export interface CollateralAccount {
@@ -115,6 +110,7 @@ export type Trade = {
   size: string;
   price: number;
   date: string;
+  txId: string;
 };
 
 export type TradesResponse = {