placeholder private test. Deprecate requestWrapper public getters
This commit is contained in:
@@ -70,13 +70,13 @@ export class InverseClient extends BaseRestClient {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/orderBook/L2', params);
|
return this.get('v2/public/orderBook/L2', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getKline(
|
getKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/kline/list', params);
|
return this.get('v2/public/kline/list', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -85,33 +85,33 @@ export class InverseClient extends BaseRestClient {
|
|||||||
getTickers(
|
getTickers(
|
||||||
params?: Partial<SymbolParam>
|
params?: Partial<SymbolParam>
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/tickers', params);
|
return this.get('v2/public/tickers', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/trading-records', params);
|
return this.get('v2/public/trading-records', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
||||||
return this.requestWrapper.get('v2/public/symbols');
|
return this.get('v2/public/symbols');
|
||||||
}
|
}
|
||||||
|
|
||||||
getMarkPriceKline(
|
getMarkPriceKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/mark-price-kline', params);
|
return this.get('v2/public/mark-price-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getIndexPriceKline(
|
getIndexPriceKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/index-price-kline', params);
|
return this.get('v2/public/index-price-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getPremiumIndexKline(
|
getPremiumIndexKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/premium-index-kline', params);
|
return this.get('v2/public/premium-index-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -123,19 +123,19 @@ export class InverseClient extends BaseRestClient {
|
|||||||
getOpenInterest(
|
getOpenInterest(
|
||||||
params: SymbolPeriodLimitParam
|
params: SymbolPeriodLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/open-interest', params);
|
return this.get('v2/public/open-interest', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getLatestBigDeal(
|
getLatestBigDeal(
|
||||||
params: SymbolLimitParam
|
params: SymbolLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/big-deal', params);
|
return this.get('v2/public/big-deal', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getLongShortRatio(
|
getLongShortRatio(
|
||||||
params: SymbolPeriodLimitParam
|
params: SymbolPeriodLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/account-ratio', params);
|
return this.get('v2/public/account-ratio', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -179,11 +179,11 @@ export class InverseClient extends BaseRestClient {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
||||||
return this.requestWrapper.get('v2/public/time');
|
return this.get('v2/public/time');
|
||||||
}
|
}
|
||||||
|
|
||||||
getApiAnnouncements(): Promise<APIResponseWithTime<any[]>> {
|
getApiAnnouncements(): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/announcement');
|
return this.get('v2/public/announcement');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -443,10 +443,7 @@ export class InverseClient extends BaseRestClient {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
getLastFundingRate(params: SymbolParam): GenericAPIResponse {
|
getLastFundingRate(params: SymbolParam): GenericAPIResponse {
|
||||||
return this.requestWrapper.get(
|
return this.get('v2/public/funding/prev-funding-rate', params);
|
||||||
'v2/public/funding/prev-funding-rate',
|
|
||||||
params
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
getMyLastFundingFee(params: SymbolParam): GenericAPIResponse {
|
getMyLastFundingFee(params: SymbolParam): GenericAPIResponse {
|
||||||
|
|||||||
@@ -70,13 +70,13 @@ export class InverseFuturesClient extends BaseRestClient {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/orderBook/L2', params);
|
return this.get('v2/public/orderBook/L2', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getKline(
|
getKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/kline/list', params);
|
return this.get('v2/public/kline/list', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -85,36 +85,36 @@ export class InverseFuturesClient extends BaseRestClient {
|
|||||||
getTickers(
|
getTickers(
|
||||||
params?: Partial<SymbolParam>
|
params?: Partial<SymbolParam>
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/tickers', params);
|
return this.get('v2/public/tickers', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Public trading records
|
* Public trading records
|
||||||
*/
|
*/
|
||||||
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/trading-records', params);
|
return this.get('v2/public/trading-records', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
||||||
return this.requestWrapper.get('v2/public/symbols');
|
return this.get('v2/public/symbols');
|
||||||
}
|
}
|
||||||
|
|
||||||
getMarkPriceKline(
|
getMarkPriceKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/mark-price-kline', params);
|
return this.get('v2/public/mark-price-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getIndexPriceKline(
|
getIndexPriceKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/index-price-kline', params);
|
return this.get('v2/public/index-price-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getPremiumIndexKline(
|
getPremiumIndexKline(
|
||||||
params: SymbolIntervalFromLimitParam
|
params: SymbolIntervalFromLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/premium-index-kline', params);
|
return this.get('v2/public/premium-index-kline', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -126,19 +126,19 @@ export class InverseFuturesClient extends BaseRestClient {
|
|||||||
getOpenInterest(
|
getOpenInterest(
|
||||||
params: SymbolPeriodLimitParam
|
params: SymbolPeriodLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/open-interest', params);
|
return this.get('v2/public/open-interest', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getLatestBigDeal(
|
getLatestBigDeal(
|
||||||
params: SymbolLimitParam
|
params: SymbolLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/big-deal', params);
|
return this.get('v2/public/big-deal', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
getLongShortRatio(
|
getLongShortRatio(
|
||||||
params: SymbolPeriodLimitParam
|
params: SymbolPeriodLimitParam
|
||||||
): Promise<APIResponseWithTime<any[]>> {
|
): Promise<APIResponseWithTime<any[]>> {
|
||||||
return this.requestWrapper.get('v2/public/account-ratio', params);
|
return this.get('v2/public/account-ratio', params);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -182,11 +182,11 @@ export class InverseFuturesClient extends BaseRestClient {
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
||||||
return this.requestWrapper.get('v2/public/time');
|
return this.get('v2/public/time');
|
||||||
}
|
}
|
||||||
|
|
||||||
getApiAnnouncements(): GenericAPIResponse {
|
getApiAnnouncements(): GenericAPIResponse {
|
||||||
return this.requestWrapper.get('v2/public/announcement');
|
return this.get('v2/public/announcement');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
40
test/inverse/private.test.ts
Normal file
40
test/inverse/private.test.ts
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import { InverseClient } from '../../src/inverse-client';
|
||||||
|
import {
|
||||||
|
notAuthenticatedError,
|
||||||
|
successResponseList,
|
||||||
|
successResponseObject,
|
||||||
|
} from '../response.util';
|
||||||
|
|
||||||
|
describe.skip('Private Inverse REST API Endpoints', () => {
|
||||||
|
const useLivenet = true;
|
||||||
|
const API_KEY = process.env.API_KEY_COM;
|
||||||
|
const API_SECRET = process.env.API_SECRET_COM;
|
||||||
|
|
||||||
|
it('should have api credentials to test with', () => {
|
||||||
|
expect(API_KEY).toStrictEqual(expect.any(String));
|
||||||
|
expect(API_SECRET).toStrictEqual(expect.any(String));
|
||||||
|
});
|
||||||
|
|
||||||
|
const api = new InverseClient(API_KEY, API_SECRET, useLivenet, {
|
||||||
|
disable_time_sync: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
const symbol = 'BTCUSD';
|
||||||
|
const interval = '15';
|
||||||
|
const timestampOneHourAgo = new Date().getTime() / 1000 - 1000 * 60 * 60;
|
||||||
|
const from = Number(timestampOneHourAgo.toFixed(0));
|
||||||
|
|
||||||
|
describe('Inverse only endpoints', () => {
|
||||||
|
it('getOrderBook()', async () => {
|
||||||
|
expect(await api.getOrderBook({ symbol })).toMatchObject(
|
||||||
|
successResponseList()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('getKline()', async () => {
|
||||||
|
expect(await api.getKline({ symbol, interval, from })).toMatchObject(
|
||||||
|
successResponseList()
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user