@reyaxyz/api-sdk 0.39.0 → 0.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/clients/modules/markets/index.js +12 -0
- package/dist/clients/modules/markets/index.js.map +1 -1
- package/dist/clients/modules/markets/types.js.map +1 -1
- package/dist/types/clients/modules/markets/index.d.ts +3 -1
- package/dist/types/clients/modules/markets/index.d.ts.map +1 -1
- package/dist/types/clients/modules/markets/types.d.ts +8 -0
- package/dist/types/clients/modules/markets/types.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/clients/modules/markets/index.ts +12 -0
- package/src/clients/modules/markets/types.ts +9 -0
|
@@ -134,6 +134,18 @@ var MarketsClient = /** @class */ (function (_super) {
|
|
|
134
134
|
});
|
|
135
135
|
});
|
|
136
136
|
};
|
|
137
|
+
MarketsClient.prototype.getFundingRateChartData = function (params) {
|
|
138
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
139
|
+
var uri;
|
|
140
|
+
return __generator(this, function (_a) {
|
|
141
|
+
uri = "/api/markets/".concat(params.marketId, "/funding-rate-history");
|
|
142
|
+
return [2 /*return*/, this.get(uri, {
|
|
143
|
+
timeframeMs: params.filters.timeframeMs,
|
|
144
|
+
granularity: params.filters.granularity,
|
|
145
|
+
})];
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
};
|
|
137
149
|
return MarketsClient;
|
|
138
150
|
}(rest_1.default));
|
|
139
151
|
exports.default = MarketsClient;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"/","sources":["clients/modules/markets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"/","sources":["clients/modules/markets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUA,iDAAiC;AAGjC;IAA2C,iCAAU;IAArD;;IA0EA,CAAC;IAzEC;;;;;;;;;;;;;;;;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;wBACnB,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;qBAClE,CAAC,EAAC;;;KACJ;IAEK,+CAAuB,GAA7B,UACE,MAAqC;;;;gBAE/B,GAAG,GAAG,uBAAgB,MAAM,CAAC,QAAQ,0BAAuB,CAAC;gBACnE,sBAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;wBACnB,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW;wBACvC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW;qBACxC,CAAC,EAAC;;;KACJ;IACH,oBAAC;AAAD,CAAC,AA1ED,CAA2C,cAAU,GA0EpD","sourcesContent":["import {\n GetCandlesParams,\n GetFundingRateChartDataParams,\n GetMarketParams,\n GetMarketResult,\n GetMarketsResult,\n GetMarketTradingHistoryParams,\n GetTradingHistoryResult,\n MarketCandlesResponse,\n} from './types';\nimport RestClient from '../rest';\nimport { GetFundingRateChartDataResult } from '@reyaxyz/common';\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 fromTimestampMillisecondsUTC: params.fromTimestampMillisecondsUTC,\n });\n }\n\n async getFundingRateChartData(\n params: GetFundingRateChartDataParams,\n ): Promise<GetFundingRateChartDataResult> {\n const uri = `/api/markets/${params.marketId}/funding-rate-history`;\n return this.get(uri, {\n timeframeMs: params.filters.timeframeMs,\n granularity: params.filters.granularity,\n });\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/modules/markets/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n CandlesResolution,\n MarketEntity,\n TradingHistoryEntity,\n Candle,\n} from '@reyaxyz/common';\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\nexport type GetMarketTradingHistoryParams = {\n marketId: number;\n limit?: number;\n fromTimestampMillisecondsUTC?: number;\n};\nexport type GetTradingHistoryResult = TradingHistoryEntity[];\n\nexport interface MarketCandlesResponse {\n candles: Candle[];\n}\n"]}
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"/","sources":["clients/modules/markets/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n CandlesResolution,\n MarketEntity,\n TradingHistoryEntity,\n Candle,\n} from '@reyaxyz/common';\nimport { FundingRateHistoryGranularity } from '@reyaxyz/common';\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\nexport type GetMarketTradingHistoryParams = {\n marketId: number;\n limit?: number;\n fromTimestampMillisecondsUTC?: number;\n};\nexport type GetTradingHistoryResult = TradingHistoryEntity[];\n\nexport interface MarketCandlesResponse {\n candles: Candle[];\n}\n\nexport type GetFundingRateChartDataParams = {\n marketId: MarketEntity['id'];\n filters: {\n timeframeMs: number;\n granularity: FundingRateHistoryGranularity;\n };\n};\n"]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { GetCandlesParams, GetMarketParams, GetMarketResult, GetMarketsResult, GetMarketTradingHistoryParams, GetTradingHistoryResult, MarketCandlesResponse } from './types';
|
|
1
|
+
import { GetCandlesParams, GetFundingRateChartDataParams, GetMarketParams, GetMarketResult, GetMarketsResult, GetMarketTradingHistoryParams, GetTradingHistoryResult, MarketCandlesResponse } from './types';
|
|
2
2
|
import RestClient from '../rest';
|
|
3
|
+
import { GetFundingRateChartDataResult } from '@reyaxyz/common';
|
|
3
4
|
export default class MarketsClient extends RestClient {
|
|
4
5
|
/**
|
|
5
6
|
* Asynchronously retrieves market data from the API.
|
|
@@ -35,5 +36,6 @@ export default class MarketsClient extends RestClient {
|
|
|
35
36
|
*/
|
|
36
37
|
getMarketCandles(params: GetCandlesParams): Promise<MarketCandlesResponse>;
|
|
37
38
|
getMarketTradingHistory(params: GetMarketTradingHistoryParams): Promise<GetTradingHistoryResult>;
|
|
39
|
+
getFundingRateChartData(params: GetFundingRateChartDataParams): Promise<GetFundingRateChartDataResult>;
|
|
38
40
|
}
|
|
39
41
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["clients/modules/markets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,6BAA6B,EAC7B,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,UAAU,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"/","sources":["clients/modules/markets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,6BAA6B,EAC7B,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,6BAA6B,EAC7B,uBAAuB,EACvB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AACjB,OAAO,UAAU,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAEhE,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;IAQ7B,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,GACpC,OAAO,CAAC,6BAA6B,CAAC;CAO1C"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CandlesResolution, MarketEntity, TradingHistoryEntity, Candle } from '@reyaxyz/common';
|
|
2
|
+
import { FundingRateHistoryGranularity } from '@reyaxyz/common';
|
|
2
3
|
export type GetMarketsResult = MarketEntity[];
|
|
3
4
|
export type GetMarketResult = MarketEntity;
|
|
4
5
|
export type GetMarketParams = {
|
|
@@ -20,4 +21,11 @@ export type GetTradingHistoryResult = TradingHistoryEntity[];
|
|
|
20
21
|
export interface MarketCandlesResponse {
|
|
21
22
|
candles: Candle[];
|
|
22
23
|
}
|
|
24
|
+
export type GetFundingRateChartDataParams = {
|
|
25
|
+
marketId: MarketEntity['id'];
|
|
26
|
+
filters: {
|
|
27
|
+
timeframeMs: number;
|
|
28
|
+
granularity: FundingRateHistoryGranularity;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
23
31
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/modules/markets/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,oBAAoB,EACpB,MAAM,EACP,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"/","sources":["clients/modules/markets/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,oBAAoB,EACpB,MAAM,EACP,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AAEhE,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;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,EAAE,CAAC;AAE7D,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,6BAA6B,CAAC;KAC5C,CAAC;CACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reyaxyz/api-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.40.0",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org"
|
|
@@ -33,10 +33,10 @@
|
|
|
33
33
|
"generate:coverage-badges": "npx istanbul-badges-readme --silent"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@reyaxyz/common": "0.
|
|
36
|
+
"@reyaxyz/common": "0.18.0",
|
|
37
37
|
"axios": "^1.6.2",
|
|
38
38
|
"bignumber.js": "^9.1.2"
|
|
39
39
|
},
|
|
40
40
|
"packageManager": "pnpm@8.10.4",
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "d16c8366a3c4d68f810eddc1ecea931dc5ab03c9"
|
|
42
42
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import {
|
|
2
2
|
GetCandlesParams,
|
|
3
|
+
GetFundingRateChartDataParams,
|
|
3
4
|
GetMarketParams,
|
|
4
5
|
GetMarketResult,
|
|
5
6
|
GetMarketsResult,
|
|
@@ -8,6 +9,7 @@ import {
|
|
|
8
9
|
MarketCandlesResponse,
|
|
9
10
|
} from './types';
|
|
10
11
|
import RestClient from '../rest';
|
|
12
|
+
import { GetFundingRateChartDataResult } from '@reyaxyz/common';
|
|
11
13
|
|
|
12
14
|
export default class MarketsClient extends RestClient {
|
|
13
15
|
/**
|
|
@@ -73,4 +75,14 @@ export default class MarketsClient extends RestClient {
|
|
|
73
75
|
fromTimestampMillisecondsUTC: params.fromTimestampMillisecondsUTC,
|
|
74
76
|
});
|
|
75
77
|
}
|
|
78
|
+
|
|
79
|
+
async getFundingRateChartData(
|
|
80
|
+
params: GetFundingRateChartDataParams,
|
|
81
|
+
): Promise<GetFundingRateChartDataResult> {
|
|
82
|
+
const uri = `/api/markets/${params.marketId}/funding-rate-history`;
|
|
83
|
+
return this.get(uri, {
|
|
84
|
+
timeframeMs: params.filters.timeframeMs,
|
|
85
|
+
granularity: params.filters.granularity,
|
|
86
|
+
});
|
|
87
|
+
}
|
|
76
88
|
}
|
|
@@ -4,6 +4,7 @@ import {
|
|
|
4
4
|
TradingHistoryEntity,
|
|
5
5
|
Candle,
|
|
6
6
|
} from '@reyaxyz/common';
|
|
7
|
+
import { FundingRateHistoryGranularity } from '@reyaxyz/common';
|
|
7
8
|
|
|
8
9
|
export type GetMarketsResult = MarketEntity[];
|
|
9
10
|
|
|
@@ -31,3 +32,11 @@ export type GetTradingHistoryResult = TradingHistoryEntity[];
|
|
|
31
32
|
export interface MarketCandlesResponse {
|
|
32
33
|
candles: Candle[];
|
|
33
34
|
}
|
|
35
|
+
|
|
36
|
+
export type GetFundingRateChartDataParams = {
|
|
37
|
+
marketId: MarketEntity['id'];
|
|
38
|
+
filters: {
|
|
39
|
+
timeframeMs: number;
|
|
40
|
+
granularity: FundingRateHistoryGranularity;
|
|
41
|
+
};
|
|
42
|
+
};
|