@reyaxyz/api-sdk 0.6.3

package/dist/types/clients/api-client.d.ts

@@ -0,0 +1,30 @@
+import { ServiceConfig } from './helpers/constants';
+import MarketsClient from './modules/markets';
+import AccountClient from './modules/account';
+/**
+ * @description Client for API
+ */
+export declare class ApiClient {
+    readonly config: ServiceConfig;
+    readonly apiTimeout: number;
+    readonly _markets: MarketsClient;
+    readonly _account: AccountClient;
+    constructor(config: ServiceConfig, apiTimeout?: number);
+    /**
+     * Provides access to the MarketsClient instance.
+     * This getter allows for interacting with market-related API functionalities.
+     *
+     * @returns {MarketsClient} An instance of MarketsClient for market-related operations.
+     * @memberof ApiClient
+     */
+    get markets(): MarketsClient;
+    /**
+     * Provides access to the AccountClient instance.
+     * This getter allows for interacting with account-related API functionalities.
+     *
+     * @returns {AccountClient} An instance of AccountClient for account-related operations.
+     * @memberof ApiClient
+     */
+    get account(): AccountClient;
+}
+//# sourceMappingURL=api-client.d.ts.map

package/dist/types/clients/api-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client.d.ts","sourceRoot":"/","sources":["clients/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAe,MAAM,qBAAqB,CAAC;AACjE,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAC9C,OAAO,aAAa,MAAM,mBAAmB,CAAC;AAE9C;;GAEG;AACH,qBAAa,SAAS;IACpB,SAAgB,MAAM,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;gBAErB,MAAM,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,MAAM;IAQtD;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,aAAa,CAE3B;IAED;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,aAAa,CAE3B;CACF"}

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

@@ -0,0 +1,7 @@
+export declare const API_TIMEOUT: number;
+export declare class ServiceConfig {
+    restEndpoint: string;
+    websocketEndpoint: string;
+    constructor(restEndpoint: string, websocketEndpoint: string);
+}
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"/","sources":["clients/helpers/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,EAAE,MAAa,CAAC;AAExC,qBAAa,aAAa;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;gBAErB,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM;CAI5D"}

package/dist/types/clients/helpers/query-helper.d.ts

@@ -0,0 +1,2 @@
+export declare function generateQueryPath(url: string, params: NonNullable<unknown>): string;
+//# sourceMappingURL=query-helper.d.ts.map

package/dist/types/clients/helpers/query-helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-helper.d.ts","sourceRoot":"/","sources":["clients/helpers/query-helper.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAC3B,MAAM,CAaR"}

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

@@ -0,0 +1,14 @@
+export declare enum RequestMethod {
+    POST = "POST",
+    PUT = "PUT",
+    GET = "GET",
+    DELETE = "DELETE"
+}
+export type ResponseData = never;
+export interface Response {
+    status: number;
+    data: ResponseData;
+    headers: NonNullable<unknown>;
+}
+export declare function request(url: string, method?: RequestMethod, body?: unknown | null, headers?: NonNullable<unknown>): Promise<Response>;
+//# sourceMappingURL=axios.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"axios.d.ts","sourceRoot":"/","sources":["clients/lib/axios.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa;IACvB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC;AAEjC,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAC/B;AAMD,wBAAgB,OAAO,CACrB,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,aAAiC,EACzC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,EACrB,OAAO,GAAE,WAAW,CAAC,OAAO,CAAM,GACjC,OAAO,CAAC,QAAQ,CAAC,CAOnB"}

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

@@ -0,0 +1,45 @@
+import { CollateralAccountListResponse, CollateralAccountResponse } from '../types';
+import RestClient from './rest';
+export default class AccountClient extends RestClient {
+    /**
+     * Asynchronously retrieves a list of collateral 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 {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
+     *                                                   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>;
+    /**
+     * 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.
+     * @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>;
+}
+//# sourceMappingURL=account.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,43 @@
+import { CandlesResolution, MarketCandlesResponse, MarketListResponse, TradesResponse } from '../types';
+import RestClient from './rest';
+export default class MarketsClient extends RestClient {
+    /**
+     * Asynchronously retrieves market data from the API.
+     *
+     * 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.
+     * @memberof MarketsClient
+     *
+     * @example
+     * // Fetch data for all markets
+     * const allMarketsData = await market.getMarkets();
+     *
+     * @example
+     * // Fetch data for a specific market
+     * const specificMarketData = await market.getMarkets('ETH-USDC');
+     */
+    getMarkets(market?: string): Promise<MarketListResponse>;
+    /**
+     * 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 {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.
+     * @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(market: string, resolution: CandlesResolution, fromISO?: string | null, toISO?: string | null, limit?: number | null): Promise<MarketCandlesResponse>;
+    getPerpetualMarketTrades(market: string, limit?: number | null): Promise<TradesResponse>;
+}
+//# sourceMappingURL=markets.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,9 @@
+import { Response, ResponseData } from '../lib/axios';
+export default class RestClient {
+    readonly host: string;
+    readonly apiTimeout: number;
+    constructor(host: string, apiTimeout?: number | null);
+    get(requestPath: string, params?: NonNullable<unknown>): Promise<ResponseData>;
+    post(requestPath: string, params?: NonNullable<unknown>, body?: unknown | null, headers?: NonNullable<unknown>): Promise<Response>;
+}
+//# sourceMappingURL=rest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rest.d.ts","sourceRoot":"/","sources":["clients/modules/rest.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,QAAQ,EAAW,YAAY,EAAE,MAAM,cAAc,CAAC;AAC9E,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;gBAEhB,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAK9C,GAAG,CACP,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,WAAW,CAAC,OAAO,CAAM,GAChC,OAAO,CAAC,YAAY,CAAC;IAMlB,IAAI,CACR,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,WAAW,CAAC,OAAO,CAAM,EACjC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,EACrB,OAAO,GAAE,WAAW,CAAC,OAAO,CAAM,GACjC,OAAO,CAAC,QAAQ,CAAC;CAIrB"}

package/dist/types/clients/socket-client.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=socket-client.d.ts.map

package/dist/types/clients/socket-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-client.d.ts","sourceRoot":"/","sources":["clients/socket-client.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,106 @@
+export declare enum CandlesResolution {
+    ONE_MINUTE = "1MIN",
+    FIVE_MINUTES = "5MINS",
+    FIFTEEN_MINUTES = "15MINS",
+    THIRTY_MINUTES = "30MINS",
+    ONE_HOUR = "1HOUR",
+    FOUR_HOURS = "4HOURS",
+    ONE_DAY = "1DAY"
+}
+export interface Candle {
+    startedAt: string;
+    ticker: string;
+    resolution: CandlesResolution;
+    low: string;
+    high: string;
+    open: string;
+    close: string;
+    baseTokenVolume: string;
+    usdVolume: string;
+    trades: number;
+    startingOpenInterest: string;
+    id: string;
+}
+export interface MarketCandlesResponse {
+    candles: Candle[];
+}
+export interface MarketEntry {
+    id: number;
+    ticker: string;
+    instrumentName: string;
+    instrumentType: string;
+    underlyingAsset: string;
+    quoteAsset: 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;
+}
+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 interface Position {
+    id: number;
+    symbol: string;
+    side: Side;
+    size: number;
+    price: number;
+    orderStatus: Status;
+    markPrice: number;
+    unrealisedPnl: number;
+    realisedPnl: number;
+    liquidationPrice: number;
+    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;
+    size: string;
+    price: number;
+    date: string;
+};
+export type TradesResponse = {
+    trades: Trade[];
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +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"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { ApiClient } from './clients/api-client';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@reyaxyz/api-sdk",
+  "version": "0.6.3",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Voltz-Protocol/reya-off-chain-monorepo.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/types",
+  "license": "MIT",
+  "files": [
+    "src/**/*.*",
+    "dist/**/*.*",
+    "README.md"
+  ],
+  "scripts": {
+    "prebuild": "rm -rf node_modules && rm -rf dist",
+    "build": "tsc -p tsconfig.build.json",
+    "ts:check-types": "npx tsc --noEmit",
+    "ts:circular-check": "dpdm --no-output --no-tree --no-warning --exit-code circular:1 -T src/index.ts",
+    "ts:check": "pnpm ts:check-types && pnpm ts:circular-check",
+    "lint:check": "eslint '{src,demo,tests}/**/*.{ts,tsx}'",
+    "prettier:check": "npx prettier --loglevel silent --check './{src,demo,tests}/**/*.{ts,tsx}'",
+    "code-quality:check": "npx concurrently 'pnpm ts:check' 'pnpm prettier:check' 'pnpm lint:check --quiet'",
+    "lint:fix": "npx eslint --fix '{src,demo,tests}/**/*.{ts,tsx}'",
+    "prettier:fix": "npx prettier --loglevel silent --write './{src,demo,tests}/**/*.{ts,tsx}'",
+    "test": "npx jest --silent",
+    "test:coverage": "npx jest test --coverage",
+    "generate:coverage-badges": "npx istanbul-badges-readme --silent"
+  },
+  "dependencies": {
+    "axios": "^1.6.2"
+  },
+  "packageManager": "pnpm@8.10.4",
+  "gitHead": "12b257e116bed35f8bb69fcd44e5619715228906"
+}

package/src/clients/api-client.ts

@@ -0,0 +1,43 @@
+import { ServiceConfig, API_TIMEOUT } from './helpers/constants';
+import MarketsClient from './modules/markets';
+import AccountClient from './modules/account';
+
+/**
+ * @description Client for API
+ */
+export class ApiClient {
+  public readonly config: ServiceConfig;
+  readonly apiTimeout: number;
+  readonly _markets: MarketsClient;
+  readonly _account: AccountClient;
+
+  constructor(config: ServiceConfig, apiTimeout?: number) {
+    this.config = config;
+    this.apiTimeout = apiTimeout ?? API_TIMEOUT;
+
+    this._markets = new MarketsClient(config.restEndpoint);
+    this._account = new AccountClient(config.restEndpoint);
+  }
+
+  /**
+   * Provides access to the MarketsClient instance.
+   * This getter allows for interacting with market-related API functionalities.
+   *
+   * @returns {MarketsClient} An instance of MarketsClient for market-related operations.
+   * @memberof ApiClient
+   */
+  get markets(): MarketsClient {
+    return this._markets;
+  }
+
+  /**
+   * Provides access to the AccountClient instance.
+   * This getter allows for interacting with account-related API functionalities.
+   *
+   * @returns {AccountClient} An instance of AccountClient for account-related operations.
+   * @memberof ApiClient
+   */
+  get account(): AccountClient {
+    return this._account;
+  }
+}

package/src/clients/helpers/constants.ts

@@ -0,0 +1,11 @@
+export const API_TIMEOUT: number = 2500;
+
+export class ServiceConfig {
+  public restEndpoint: string;
+  public websocketEndpoint: string;
+
+  constructor(restEndpoint: string, websocketEndpoint: string) {
+    this.restEndpoint = restEndpoint;
+    this.websocketEndpoint = websocketEndpoint;
+  }
+}

package/src/clients/helpers/query-helper.ts

@@ -0,0 +1,17 @@
+export function generateQueryPath(
+  url: string,
+  params: NonNullable<unknown>,
+): string {
+  const definedEntries = Object.entries(params).filter(
+    ([, value]: [string, unknown]) => value !== undefined,
+  );
+
+  if (!definedEntries.length) {
+    return url;
+  }
+
+  const paramsString = definedEntries
+    .map(([key, value]: [string, unknown]) => `${key}=${value}`)
+    .join('&');
+  return `${url}?${paramsString}`;
+}

package/src/clients/lib/axios.ts

@@ -0,0 +1,34 @@
+import axios, { AxiosRequestConfig } from 'axios';
+
+export enum RequestMethod {
+  POST = 'POST',
+  PUT = 'PUT',
+  GET = 'GET',
+  DELETE = 'DELETE',
+}
+
+export type ResponseData = never;
+
+export interface Response {
+  status: number;
+  data: ResponseData;
+  headers: NonNullable<unknown>;
+}
+
+async function axiosRequest(options: AxiosRequestConfig): Promise<Response> {
+  return axios(options);
+}
+
+export function request(
+  url: string,
+  method: RequestMethod = RequestMethod.GET,
+  body?: unknown | null,
+  headers: NonNullable<unknown> = {},
+): Promise<Response> {
+  return axiosRequest({
+    url,
+    method,
+    data: body,
+    headers,
+  });
+}

package/src/clients/modules/account.ts

@@ -0,0 +1,63 @@
+import {
+  CollateralAccountListResponse,
+  CollateralAccountResponse,
+} from '../types';
+import RestClient from './rest';
+
+export default class AccountClient extends RestClient {
+  /**
+   * Asynchronously retrieves a list of collateral 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 {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
+   *                                                   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 });
+  }
+
+  /**
+   * 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.
+   * @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}`;
+    return this.get(uri);
+  }
+}

package/src/clients/modules/markets.ts

@@ -0,0 +1,77 @@
+import {
+  CandlesResolution,
+  MarketCandlesResponse,
+  MarketListResponse,
+  TradesResponse,
+} from '../types';
+import RestClient from './rest';
+
+export default class MarketsClient extends RestClient {
+  /**
+   * Asynchronously retrieves market data from the API.
+   *
+   * 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.
+   * @memberof MarketsClient
+   *
+   * @example
+   * // Fetch data for all markets
+   * const allMarketsData = await market.getMarkets();
+   *
+   * @example
+   * // Fetch data for a specific market
+   * const specificMarketData = await market.getMarkets('ETH-USDC');
+   */
+
+  async getMarkets(market?: string): Promise<MarketListResponse> {
+    const uri = '/api/markets';
+    return this.get(uri, { ticker: market });
+  }
+
+  /**
+   * 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 {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.
+   * @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');
+   */
+
+  async getMarketCandles(
+    market: string,
+    resolution: CandlesResolution,
+    fromISO?: string | null,
+    toISO?: string | null,
+    limit?: number | null,
+  ): Promise<MarketCandlesResponse> {
+    const uri = `/api/markets/candles/${market}`;
+    return this.get(uri, {
+      resolution,
+      fromISO,
+      toISO,
+      limit,
+    });
+  }
+
+  async getPerpetualMarketTrades(
+    market: string,
+    limit?: number | null,
+  ): Promise<TradesResponse> {
+    const uri = `/api/trades/${market}`;
+    return this.get(uri, {
+      limit,
+    });
+  }
+}

package/src/clients/modules/rest.ts

@@ -0,0 +1,31 @@
+import { API_TIMEOUT } from '../helpers/constants';
+import { generateQueryPath } from '../helpers/query-helper';
+import { RequestMethod, Response, request, ResponseData } from '../lib/axios';
+export default class RestClient {
+  readonly host: string;
+  readonly apiTimeout: number;
+
+  constructor(host: string, apiTimeout?: number | null) {
+    this.host = host;
+    this.apiTimeout = apiTimeout || API_TIMEOUT;
+  }
+
+  async get(
+    requestPath: string,
+    params: NonNullable<unknown> = {},
+  ): Promise<ResponseData> {
+    const url = `${this.host}${generateQueryPath(requestPath, params)}`;
+    const response = await request(url);
+    return response.data;
+  }
+
+  async post(
+    requestPath: string,
+    params: NonNullable<unknown> = {},
+    body?: unknown | null,
+    headers: NonNullable<unknown> = {},
+  ): Promise<Response> {
+    const url = `${this.host}${generateQueryPath(requestPath, params)}`;
+    return request(url, RequestMethod.POST, body, headers);
+  }
+}