bybit-api 2.3.2 → 2.4.0-beta.1

package/lib/usdc-option-client.js

@@ -0,0 +1,186 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USDCOptionClient = void 0;
+const util_1 = require("./util");
+const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
+/**
+ * REST API client for USDC Option APIs
+ */
+class USDCOptionClient extends BaseRestClient_1.default {
+    getClientType() {
+        return util_1.REST_CLIENT_TYPE_ENUM.v3;
+    }
+    fetchServerTime() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.getServerTime();
+            return Number(res.time_now);
+        });
+    }
+    /**
+     *
+     * Market Data Endpoints
+     *
+     */
+    /** Query order book info. Each side has a depth of 25 orders. */
+    getOrderBook(symbol) {
+        return this.get('/option/usdc/openapi/public/v1/order-book', { symbol });
+    }
+    /** Fetch trading rules (such as min/max qty). Query for all if blank. */
+    getContractInfo(params) {
+        return this.get('/option/usdc/openapi/public/v1/symbols', params);
+    }
+    /** Get a symbol price/statistics ticker */
+    getSymbolTicker(symbol) {
+        return this.get('/option/usdc/openapi/public/v1/tick', { symbol });
+    }
+    /** Get delivery information */
+    getDeliveryPrice(params) {
+        return this.get('/option/usdc/openapi/public/v1/delivery-price', params);
+    }
+    /** Returned records are Taker Buy in default. */
+    getLast500Trades(params) {
+        return this.get('/option/usdc/openapi/public/v1/query-trade-latest', params);
+    }
+    /**
+     * The data is in hourly.
+     * If time field is not passed, it returns the recent 1 hour data by default.
+     * It could be any timeframe by inputting startTime & endTime, but it must satisfy [endTime - startTime] <= 30 days.
+     * It returns all data in 2 years when startTime & endTime are not passed.
+     * Both startTime & endTime entered together or both are left blank
+     */
+    getHistoricalVolatility(params) {
+        return this.get('/option/usdc/openapi/public/v1/query-historical-volatility', params);
+    }
+    /**
+     *
+     * Account Data Endpoints
+     *
+     */
+    /** -> Order API */
+    /**
+     * Place an order using the USDC Derivatives Account.
+     * The request status can be queried in real-time.
+     * The response parameters must be queried through a query or a WebSocket response.
+     */
+    submitOrder(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/place-order', params);
+    }
+    /**
+     * Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request.
+     */
+    batchSubmitOrders(orderRequest) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/batch-place-orders', { orderRequest });
+    }
+    /** For Options, at least one of the three parameters — price, quantity or implied volatility — must be input. */
+    modifyOrder(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/replace-order', params);
+    }
+    /** Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request. */
+    batchModifyOrders(replaceOrderRequest) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/batch-replace-orders', { replaceOrderRequest });
+    }
+    /** Cancel order */
+    cancelOrder(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/cancel-order', params);
+    }
+    /** Batch cancel orders */
+    batchCancelOrders(cancelRequest) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/batch-cancel-orders', { cancelRequest });
+    }
+    /** This is used to cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
+    cancelActiveOrders(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/cancel-all', params);
+    }
+    /** Query Unfilled/Partially Filled Orders(real-time), up to last 7 days of partially filled/unfilled orders */
+    getActiveRealtimeOrders(params) {
+        return this.getPrivate('/option/usdc/openapi/private/v1/trade/query-active-orders', params);
+    }
+    /** Query Unfilled/Partially Filled Orders */
+    getActiveOrders(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-active-orders', params);
+    }
+    /** Query order history. The endpoint only supports up to 30 days of queried records */
+    getHistoricOrders(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-order-history', params);
+    }
+    /** Query trade history. The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getOrderExecutionHistory(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/execution-list', params);
+    }
+    /** -> Account API */
+    /** The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getTransactionLog(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-transaction-log', params);
+    }
+    /** Wallet info for USDC account. */
+    getBalances() {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-wallet-balance');
+    }
+    /** Asset Info */
+    getAssetInfo(baseCoin) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-asset-info', { baseCoin });
+    }
+    /**
+     * If USDC derivatives account balance is greater than X, you can open PORTFOLIO_MARGIN, and if it is less than Y, it will automatically close PORTFOLIO_MARGIN and change back to REGULAR_MARGIN. X and Y will be adjusted according to operational requirements.
+     * Rest API returns the result of checking prerequisites. You could get the real status of margin mode change by subscribing margin mode.
+     */
+    setMarginMode(newMarginMode) {
+        return this.postPrivate('/option/usdc/private/asset/account/setMarginMode', { setMarginMode: newMarginMode });
+    }
+    /** Query margin mode for USDC account. */
+    getMarginMode() {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-margin-info');
+    }
+    /** -> Positions API */
+    /** Query my positions */
+    getPositions(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-position', params);
+    }
+    /** Query Delivery History */
+    getDeliveryHistory(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-delivery-list', params);
+    }
+    /** Query Positions Info Upon Expiry */
+    getPositionsInfoUponExpiry(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-position-exp-date', params);
+    }
+    /** -> Market Maker Protection */
+    /** modifyMMP */
+    modifyMMP(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/mmp-modify', params);
+    }
+    /** resetMMP */
+    resetMMP(currency) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/mmp-reset', {
+            currency,
+        });
+    }
+    /** queryMMPState */
+    queryMMPState(baseCoin) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/get-mmp-state', {
+            baseCoin,
+        });
+    }
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime() {
+        return this.get('/v2/public/time');
+    }
+}
+exports.USDCOptionClient = USDCOptionClient;
+//# sourceMappingURL=usdc-option-client.js.map

package/lib/usdc-option-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usdc-option-client.js","sourceRoot":"","sources":["../src/usdc-option-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAqBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,wBAAc;IAClD,aAAa;QACX,OAAO,4BAAqB,CAAC,EAAE,CAAC;IAClC,CAAC;IAEK,eAAe;;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;KAAA;IAED;;;;OAIG;IAEH,iEAAiE;IACjE,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,yEAAyE;IACzE,eAAe,CACb,MAAuC;QAEvC,OAAO,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,2CAA2C;IAC3C,eAAe,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,+BAA+B;IAC/B,gBAAgB,CACd,MAAwC;QAExC,OAAO,IAAI,CAAC,GAAG,CAAC,+CAA+C,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,iDAAiD;IACjD,gBAAgB,CACd,MAAsC;QAEtC,OAAO,IAAI,CAAC,GAAG,CACb,mDAAmD,EACnD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CACrB,MAA+C;QAE/C,OAAO,IAAI,CAAC,GAAG,CACb,4DAA4D,EAC5D,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH,mBAAmB;IAEnB;;;;OAIG;IACH,WAAW,CAAC,MAA+B;QACzC,OAAO,IAAI,CAAC,WAAW,CACrB,6CAA6C,EAC7C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,YAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CACrB,oDAAoD,EACpD,EAAE,YAAY,EAAE,CACjB,CAAC;IACJ,CAAC;IAED,iHAAiH;IACjH,WAAW,CACT,MAAqC;QAErC,OAAO,IAAI,CAAC,WAAW,CACrB,+CAA+C,EAC/C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,yIAAyI;IACzI,iBAAiB,CACf,mBAAoD;QAEpD,OAAO,IAAI,CAAC,WAAW,CACrB,sDAAsD,EACtD,EAAE,mBAAmB,EAAE,CACxB,CAAC;IACJ,CAAC;IAED,mBAAmB;IACnB,WAAW,CACT,MAAqC;QAErC,OAAO,IAAI,CAAC,WAAW,CACrB,8CAA8C,EAC9C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,0BAA0B;IAC1B,iBAAiB,CACf,aAA8C;QAE9C,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,EAAE,aAAa,EAAE,CAClB,CAAC;IACJ,CAAC;IAED,0IAA0I;IAC1I,kBAAkB,CAChB,MAA0C;QAE1C,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,+GAA+G;IAC/G,uBAAuB,CACrB,MAA+C;QAE/C,OAAO,IAAI,CAAC,UAAU,CACpB,2DAA2D,EAC3D,MAAM,CACP,CAAC;IACJ,CAAC;IAED,6CAA6C;IAC7C,eAAe,CACb,MAAsC;QAEtC,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,uFAAuF;IACvF,iBAAiB,CACf,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qJAAqJ;IACrJ,wBAAwB,CACtB,MAAwC;QAExC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qBAAqB;IAErB,gIAAgI;IAChI,iBAAiB,CACf,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CACrB,uDAAuD,EACvD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,oCAAoC;IACpC,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,CACrB,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,iBAAiB;IACjB,YAAY,CAAC,QAAiB;QAC5B,OAAO,IAAI,CAAC,WAAW,CACrB,kDAAkD,EAClD,EAAE,QAAQ,EAAE,CACb,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,aAAoD;QAEpD,OAAO,IAAI,CAAC,WAAW,CACrB,kDAAkD,EAClD,EAAE,aAAa,EAAE,aAAa,EAAE,CACjC,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CACrB,mDAAmD,CACpD,CAAC;IACJ,CAAC;IAED,uBAAuB;IAEvB,yBAAyB;IACzB,YAAY,CAAC,MAA4B;QACvC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,6BAA6B;IAC7B,kBAAkB,CAChB,MAAyC;QAEzC,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,uCAAuC;IACvC,0BAA0B,CACxB,MAA8C;QAE9C,OAAO,IAAI,CAAC,WAAW,CACrB,yDAAyD,EACzD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,iCAAiC;IAEjC,gBAAgB;IAChB,SAAS,CAAC,MAAmC;QAC3C,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,eAAe;IACf,QAAQ,CAAC,QAAgB;QACvB,OAAO,IAAI,CAAC,WAAW,CAAC,2CAA2C,EAAE;YACnE,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB;IACpB,aAAa,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,+CAA+C,EAAE;YACvE,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF;AA1SD,4CA0SC"}

package/lib/usdc-perpetual-client.d.ts

@@ -0,0 +1,88 @@
+import { APIResponseWithTime, SymbolLimitParam, SymbolPeriodLimitParam, APIResponseV3, USDCKlineRequest, USDCLast500TradesRequest, USDCOpenInterestRequest, USDCOrderFilter, USDCPerpActiveOrdersRequest, USDCPerpCancelOrderRequest, USDCPerpHistoricOrdersRequest, USDCPerpModifyOrderRequest, USDCPerpOrderRequest, USDCPositionsRequest, USDCSymbolDirectionLimit, USDCSymbolDirectionLimitCursor, USDCTransactionLogRequest } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client for USDC Perpetual APIs
+ */
+export declare class USDCPerpetualClient extends BaseRestClient {
+    getClientType(): "v3";
+    fetchServerTime(): Promise<number>;
+    /**
+     *
+     * Market Data Endpoints
+     *
+     */
+    getOrderBook(symbol: string): Promise<APIResponseV3<any>>;
+    /** Fetch trading rules (such as min/max qty). Query for all if blank. */
+    getContractInfo(params?: USDCSymbolDirectionLimit): Promise<APIResponseV3<any>>;
+    /** Get a symbol price/statistics ticker */
+    getSymbolTicker(symbol: string): Promise<APIResponseV3<any>>;
+    getCandles(params: USDCKlineRequest): Promise<APIResponseV3<any>>;
+    getMarkPrice(params: USDCKlineRequest): Promise<APIResponseV3<any>>;
+    getIndexPrice(params: USDCKlineRequest): Promise<APIResponseV3<any>>;
+    getIndexPremium(params: USDCKlineRequest): Promise<APIResponseV3<any>>;
+    getOpenInterest(params: USDCOpenInterestRequest): Promise<APIResponseV3<any>>;
+    getLargeOrders(params: SymbolLimitParam<string>): Promise<APIResponseV3<any>>;
+    getLongShortRatio(params: SymbolPeriodLimitParam<string>): Promise<APIResponseV3<any>>;
+    getLast500Trades(params: USDCLast500TradesRequest): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * Account Data Endpoints
+     *
+     */
+    /** -> Order API */
+    /**
+     * Place an order using the USDC Derivatives Account.
+     * The request status can be queried in real-time.
+     * The response parameters must be queried through a query or a WebSocket response.
+     */
+    submitOrder(params: USDCPerpOrderRequest): Promise<APIResponseV3<any>>;
+    /** Active order parameters (such as quantity, price) and stop order parameters cannot be modified in one request at the same time. Please request modification separately. */
+    modifyOrder(params: USDCPerpModifyOrderRequest): Promise<APIResponseV3<any>>;
+    /** Cancel order */
+    cancelOrder(params: USDCPerpCancelOrderRequest): Promise<APIResponseV3<any>>;
+    /** Cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
+    cancelActiveOrders(symbol: string, orderFilter: USDCOrderFilter): Promise<APIResponseV3<any>>;
+    /** Query Unfilled/Partially Filled Orders */
+    getActiveOrders(params: USDCPerpActiveOrdersRequest): Promise<APIResponseV3<any>>;
+    /** Query order history. The endpoint only supports up to 30 days of queried records */
+    getHistoricOrders(params: USDCPerpHistoricOrdersRequest): Promise<APIResponseV3<any>>;
+    /** Query trade history. The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getOrderExecutionHistory(params: USDCPerpActiveOrdersRequest): Promise<APIResponseV3<any>>;
+    /** -> Account API */
+    /** The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getTransactionLog(params: USDCTransactionLogRequest): Promise<APIResponseV3<any>>;
+    /** Wallet info for USDC account. */
+    getBalances(): Promise<APIResponseV3<any>>;
+    /** Asset Info */
+    getAssetInfo(baseCoin?: string): Promise<APIResponseV3<any>>;
+    /**
+     * If USDC derivatives account balance is greater than X, you can open PORTFOLIO_MARGIN, and if it is less than Y, it will automatically close PORTFOLIO_MARGIN and change back to REGULAR_MARGIN. X and Y will be adjusted according to operational requirements.
+     * Rest API returns the result of checking prerequisites. You could get the real status of margin mode change by subscribing margin mode.
+     */
+    setMarginMode(newMarginMode: 'REGULAR_MARGIN' | 'PORTFOLIO_MARGIN'): Promise<APIResponseV3<any>>;
+    /** Query margin mode for USDC account. */
+    getMarginMode(): Promise<APIResponseV3<any>>;
+    /** -> Positions API */
+    /** Query my positions */
+    getPositions(params: USDCPositionsRequest): Promise<APIResponseV3<any>>;
+    /** Only for REGULAR_MARGIN */
+    setLeverage(symbol: string, leverage: string): Promise<APIResponseV3<any>>;
+    /** Query Settlement History */
+    getSettlementHistory(params?: USDCSymbolDirectionLimitCursor): Promise<APIResponseV3<any>>;
+    /** -> Risk Limit API */
+    /** Query risk limit */
+    getRiskLimit(symbol: string): Promise<APIResponseV3<any>>;
+    /** Set risk limit */
+    setRiskLimit(symbol: string, riskId: number): Promise<APIResponseV3<any>>;
+    /** -> Funding API */
+    /** Funding settlement occurs every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC. The current interval's fund fee settlement is based on the previous interval's fund rate. For example, at 16:00, the settlement is based on the fund rate generated at 8:00. The fund rate generated at 16:00 will be used at 0:00 the next day. */
+    getLastFundingRate(symbol: string): Promise<APIResponseV3<any>>;
+    /** Get predicted funding rate and my predicted funding fee */
+    getPredictedFundingRate(symbol: string): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime(): Promise<APIResponseWithTime>;
+}

package/lib/usdc-perpetual-client.js

@@ -0,0 +1,181 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USDCPerpetualClient = void 0;
+const util_1 = require("./util");
+const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
+/**
+ * REST API client for USDC Perpetual APIs
+ */
+class USDCPerpetualClient extends BaseRestClient_1.default {
+    getClientType() {
+        return util_1.REST_CLIENT_TYPE_ENUM.v3;
+    }
+    fetchServerTime() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.getServerTime();
+            return Number(res.time_now);
+        });
+    }
+    /**
+     *
+     * Market Data Endpoints
+     *
+     */
+    getOrderBook(symbol) {
+        return this.get('/perpetual/usdc/openapi/public/v1/order-book', { symbol });
+    }
+    /** Fetch trading rules (such as min/max qty). Query for all if blank. */
+    getContractInfo(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/symbols', params);
+    }
+    /** Get a symbol price/statistics ticker */
+    getSymbolTicker(symbol) {
+        return this.get('/perpetual/usdc/openapi/public/v1/tick', { symbol });
+    }
+    getCandles(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/kline/list', params);
+    }
+    getMarkPrice(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/mark-price-kline', params);
+    }
+    getIndexPrice(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/index-price-kline', params);
+    }
+    getIndexPremium(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/premium-index-kline', params);
+    }
+    getOpenInterest(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/open-interest', params);
+    }
+    getLargeOrders(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/big-deal', params);
+    }
+    getLongShortRatio(params) {
+        return this.get('/perpetual/usdc/openapi/public/v1/account-ratio', params);
+    }
+    getLast500Trades(params) {
+        return this.get('/option/usdc/openapi/public/v1/query-trade-latest', params);
+    }
+    /**
+     *
+     * Account Data Endpoints
+     *
+     */
+    /** -> Order API */
+    /**
+     * Place an order using the USDC Derivatives Account.
+     * The request status can be queried in real-time.
+     * The response parameters must be queried through a query or a WebSocket response.
+     */
+    submitOrder(params) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/place-order', params);
+    }
+    /** Active order parameters (such as quantity, price) and stop order parameters cannot be modified in one request at the same time. Please request modification separately. */
+    modifyOrder(params) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/replace-order', params);
+    }
+    /** Cancel order */
+    cancelOrder(params) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/cancel-order', params);
+    }
+    /** Cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
+    cancelActiveOrders(symbol, orderFilter) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/cancel-all', {
+            symbol,
+            orderFilter,
+        });
+    }
+    /** Query Unfilled/Partially Filled Orders */
+    getActiveOrders(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-active-orders', params);
+    }
+    /** Query order history. The endpoint only supports up to 30 days of queried records */
+    getHistoricOrders(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-order-history', params);
+    }
+    /** Query trade history. The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getOrderExecutionHistory(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/execution-list', params);
+    }
+    /** -> Account API */
+    /** The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
+    getTransactionLog(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-transaction-log', params);
+    }
+    /** Wallet info for USDC account. */
+    getBalances() {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-wallet-balance');
+    }
+    /** Asset Info */
+    getAssetInfo(baseCoin) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-asset-info', { baseCoin });
+    }
+    /**
+     * If USDC derivatives account balance is greater than X, you can open PORTFOLIO_MARGIN, and if it is less than Y, it will automatically close PORTFOLIO_MARGIN and change back to REGULAR_MARGIN. X and Y will be adjusted according to operational requirements.
+     * Rest API returns the result of checking prerequisites. You could get the real status of margin mode change by subscribing margin mode.
+     */
+    setMarginMode(newMarginMode) {
+        return this.postPrivate('/option/usdc/private/asset/account/setMarginMode', { setMarginMode: newMarginMode });
+    }
+    /** Query margin mode for USDC account. */
+    getMarginMode() {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-margin-info');
+    }
+    /** -> Positions API */
+    /** Query my positions */
+    getPositions(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/query-position', params);
+    }
+    /** Only for REGULAR_MARGIN */
+    setLeverage(symbol, leverage) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/position/leverage/save', { symbol, leverage });
+    }
+    /** Query Settlement History */
+    getSettlementHistory(params) {
+        return this.postPrivate('/option/usdc/openapi/private/v1/session-settlement', params);
+    }
+    /** -> Risk Limit API */
+    /** Query risk limit */
+    getRiskLimit(symbol) {
+        return this.getPrivate('/perpetual/usdc/openapi/public/v1/risk-limit/list', {
+            symbol,
+        });
+    }
+    /** Set risk limit */
+    setRiskLimit(symbol, riskId) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/position/set-risk-limit', { symbol, riskId });
+    }
+    /** -> Funding API */
+    /** Funding settlement occurs every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC. The current interval's fund fee settlement is based on the previous interval's fund rate. For example, at 16:00, the settlement is based on the fund rate generated at 8:00. The fund rate generated at 16:00 will be used at 0:00 the next day. */
+    getLastFundingRate(symbol) {
+        return this.get('/perpetual/usdc/openapi/public/v1/prev-funding-rate', {
+            symbol,
+        });
+    }
+    /** Get predicted funding rate and my predicted funding fee */
+    getPredictedFundingRate(symbol) {
+        return this.postPrivate('/perpetual/usdc/openapi/private/v1/predicted-funding', { symbol });
+    }
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime() {
+        return this.get('/v2/public/time');
+    }
+}
+exports.USDCPerpetualClient = USDCPerpetualClient;
+//# sourceMappingURL=usdc-perpetual-client.js.map

package/lib/usdc-perpetual-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usdc-perpetual-client.js","sourceRoot":"","sources":["../src/usdc-perpetual-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAmBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,wBAAc;IACrD,aAAa;QACX,OAAO,4BAAqB,CAAC,EAAE,CAAC;IAClC,CAAC;IAEK,eAAe;;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;KAAA;IAED;;;;OAIG;IAEH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,8CAA8C,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,yEAAyE;IACzE,eAAe,CACb,MAAiC;QAEjC,OAAO,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,2CAA2C;IAC3C,eAAe,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,UAAU,CAAC,MAAwB;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,8CAA8C,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,YAAY,CAAC,MAAwB;QACnC,OAAO,IAAI,CAAC,GAAG,CACb,oDAAoD,EACpD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,aAAa,CAAC,MAAwB;QACpC,OAAO,IAAI,CAAC,GAAG,CACb,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,eAAe,CAAC,MAAwB;QACtC,OAAO,IAAI,CAAC,GAAG,CACb,uDAAuD,EACvD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,eAAe,CACb,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,iDAAiD,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,GAAG,CAAC,4CAA4C,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,iBAAiB,CACf,MAAsC;QAEtC,OAAO,IAAI,CAAC,GAAG,CAAC,iDAAiD,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,gBAAgB,CACd,MAAgC;QAEhC,OAAO,IAAI,CAAC,GAAG,CACb,mDAAmD,EACnD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH,mBAAmB;IAEnB;;;;OAIG;IACH,WAAW,CAAC,MAA4B;QACtC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,8KAA8K;IAC9K,WAAW,CAAC,MAAkC;QAC5C,OAAO,IAAI,CAAC,WAAW,CACrB,kDAAkD,EAClD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,mBAAmB;IACnB,WAAW,CAAC,MAAkC;QAC5C,OAAO,IAAI,CAAC,WAAW,CACrB,iDAAiD,EACjD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,0HAA0H;IAC1H,kBAAkB,CAChB,MAAc,EACd,WAA4B;QAE5B,OAAO,IAAI,CAAC,WAAW,CAAC,+CAA+C,EAAE;YACvE,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IAC7C,eAAe,CACb,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,uFAAuF;IACvF,iBAAiB,CACf,MAAqC;QAErC,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qJAAqJ;IACrJ,wBAAwB,CACtB,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qBAAqB;IAErB,gIAAgI;IAChI,iBAAiB,CACf,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CACrB,uDAAuD,EACvD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,oCAAoC;IACpC,WAAW;QACT,OAAO,IAAI,CAAC,WAAW,CACrB,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,iBAAiB;IACjB,YAAY,CAAC,QAAiB;QAC5B,OAAO,IAAI,CAAC,WAAW,CACrB,kDAAkD,EAClD,EAAE,QAAQ,EAAE,CACb,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,aAAoD;QAEpD,OAAO,IAAI,CAAC,WAAW,CACrB,kDAAkD,EAClD,EAAE,aAAa,EAAE,aAAa,EAAE,CACjC,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CACrB,mDAAmD,CACpD,CAAC;IACJ,CAAC;IAED,uBAAuB;IAEvB,yBAAyB;IACzB,YAAY,CAAC,MAA4B;QACvC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,8BAA8B;IAC9B,WAAW,CAAC,MAAc,EAAE,QAAgB;QAC1C,OAAO,IAAI,CAAC,WAAW,CACrB,2DAA2D,EAC3D,EAAE,MAAM,EAAE,QAAQ,EAAE,CACrB,CAAC;IACJ,CAAC;IAED,+BAA+B;IAC/B,oBAAoB,CAClB,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CACrB,oDAAoD,EACpD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,wBAAwB;IAExB,uBAAuB;IACvB,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,UAAU,CACpB,mDAAmD,EACnD;YACE,MAAM;SACP,CACF,CAAC;IACJ,CAAC;IAED,qBAAqB;IACrB,YAAY,CAAC,MAAc,EAAE,MAAc;QACzC,OAAO,IAAI,CAAC,WAAW,CACrB,4DAA4D,EAC5D,EAAE,MAAM,EAAE,MAAM,EAAE,CACnB,CAAC;IACJ,CAAC;IAED,qBAAqB;IAErB,sUAAsU;IACtU,kBAAkB,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,qDAAqD,EAAE;YACrE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,8DAA8D;IAC9D,uBAAuB,CAAC,MAAc;QACpC,OAAO,IAAI,CAAC,WAAW,CACrB,sDAAsD,EACtD,EAAE,MAAM,EAAE,CACX,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF;AA1RD,kDA0RC"}

package/lib/util/BaseRestClient.d.ts

@@ -9,16 +9,29 @@ export default abstract class BaseRestClient {
     private key;
     private secret;
     private clientType;
-    /** Function that calls exchange API to query & resolve server time, used by time sync */
+    /** Function that calls exchange API to query & resolve server time, used by time sync, disabled by default */
     abstract fetchServerTime(): Promise<number>;
-    constructor(key: string | undefined, secret: string | undefined, baseUrl: string, options: RestClientOptions | undefined, requestOptions: AxiosRequestConfig | undefined, clientType: RestClientType);
+    /** Defines the client type (affecting how requests & signatures behave) */
+    abstract getClientType(): RestClientType;
+    /**
+     * Create an instance of the REST client
+     * @param {string} key - your API key
+     * @param {string} secret - your API secret
+     * @param {boolean} [useLivenet=false]
+     * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+     * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
+     */
+    constructor(key?: string | undefined, secret?: string | undefined, useLivenet?: boolean, options?: RestClientOptions, requestOptions?: AxiosRequestConfig);
     private isSpotClient;
+    private isUSDCClient;
     get(endpoint: string, params?: any): Promise<any>;
     post(endpoint: string, params?: any): Promise<any>;
     getPrivate(endpoint: string, params?: any): Promise<any>;
     postPrivate(endpoint: string, params?: any): Promise<any>;
     deletePrivate(endpoint: string, params?: any): Promise<any>;
     private prepareSignParams;
+    /** Returns an axios request object. Handles signing process automatically if this is a private API call */
+    private buildRequest;
     /**
      * @private Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
      */