bybit-api 3.1.3 → 3.3.0

package/README.md

@@ -11,7 +11,7 @@
 Node.js connector for the Bybit APIs and WebSockets:
 - Complete integration with all bybit APIs.
 - TypeScript support (with type declarations for most API requests & responses).
-- Over 300 integration tests making real API calls & WebSocket connections, validating any changes before they reach npm.
+- Over 300 end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
 - Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
 - Browser support (via webpack bundle - see "Browser Usage" below).
 
@@ -25,10 +25,10 @@ Node.js connector for the Bybit APIs and WebSockets:
 ## Related projects
 Check out my related projects:
 - Try my connectors:
-  - [ftx-api](https://www.npmjs.com/package/ftx-api)
-  - [bybit-api](https://www.npmjs.com/package/bybit-api)
   - [binance](https://www.npmjs.com/package/binance)
+  - [bybit-api](https://www.npmjs.com/package/bybit-api)
   - [okx-api](https://www.npmjs.com/package/okx-api)
+  - [ftx-api](https://www.npmjs.com/package/ftx-api)
 - Try my misc utilities:
   - [orderbooks](https://www.npmjs.com/package/orderbooks)
 - Check out my examples:
@@ -180,6 +180,8 @@ The WebsocketClient can be configured to a specific API group using the market p
 | Copy Trading                 	| `market: 'linear'`  	| The [copy trading](https://bybit-exchange.github.io/docs/copy_trading/#t-websocket) category. Use the linear market to listen to all copy trading topics.                                               |
 | USDC Perps                   	| `market: 'usdcPerp`   | The [USDC perps](https://bybit-exchange.github.io/docs/usdc/perpetual/#t-websocket) category.                                   	                                                                      |
 | USDC Options                 	| `market: 'usdcOption'`| The [USDC options](https://bybit-exchange.github.io/docs/usdc/option/#t-websocket) category.                            	                                                                              |
+| Contract v3 USDT              | `market: 'contractUSDT'`| The [Contract V3](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocket) category (USDT perps)    |
+| Contract v3 Inverse           | `market: 'contractInverse'`| The [Contract V3](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocket) category (inverse perps)    |
 
 ```javascript
 const { WebsocketClient } = require('bybit-api');

package/lib/constants/enum.d.ts

@@ -43,6 +43,8 @@ export declare const API_ERROR_CODE: {
     readonly RISK_LIMIT_NOT_EXISTS: 30090;
     readonly LEVERAGE_NOT_MODIFIED: 34036;
     readonly SAME_SLTP_MODE: 37002;
+    readonly COPY_TRADE_NOT_OPEN_ORDER: 39426;
+    readonly QTY_EXCEEDS_MAX_LIMIT: 130006;
     readonly ORDER_NOT_FOUND_OR_TOO_LATE_LINEAR: 130010;
     readonly ORDER_COST_NOT_AVAILABLE: 130021;
     readonly CANNOT_SET_LINEAR_TRADING_STOP_FOR_ZERO_POS: 130024;
@@ -52,6 +54,12 @@ export declare const API_ERROR_CODE: {
     readonly INSUFFICIENT_BALANCE_FOR_ORDER_COST_LINEAR: 130080;
     readonly SAME_SLTP_MODE_LINEAR: 130150;
     readonly RISK_ID_NOT_MODIFIED: 134026;
+    readonly CONTRACT_ORDER_NOT_EXISTS: 140001;
+    readonly CONTRACT_INSUFFICIENT_BALANCE: 140007;
+    readonly CONTRACT_POSITION_MODE_NOT_MODIFIED: 140025;
+    readonly CONTRACT_MARGIN_MODE_NOT_MODIFIED: 140026;
+    readonly CONTRACT_RISK_LIMIT_INFO_NOT_EXISTS: 140031;
+    readonly CONTRACT_SET_LEVERAGE_NOT_MODIFIED: 140043;
     /** E.g. USDC Options trading, trying to access a symbol that is no longer active */
     readonly CONTRACT_NAME_NOT_EXIST: 3100111;
     readonly ORDER_NOT_EXIST: 3100136;

package/lib/constants/enum.js

@@ -46,6 +46,8 @@ exports.API_ERROR_CODE = {
     RISK_LIMIT_NOT_EXISTS: 30090,
     LEVERAGE_NOT_MODIFIED: 34036,
     SAME_SLTP_MODE: 37002,
+    COPY_TRADE_NOT_OPEN_ORDER: 39426,
+    QTY_EXCEEDS_MAX_LIMIT: 130006,
     ORDER_NOT_FOUND_OR_TOO_LATE_LINEAR: 130010,
     ORDER_COST_NOT_AVAILABLE: 130021,
     CANNOT_SET_LINEAR_TRADING_STOP_FOR_ZERO_POS: 130024,
@@ -55,6 +57,12 @@ exports.API_ERROR_CODE = {
     INSUFFICIENT_BALANCE_FOR_ORDER_COST_LINEAR: 130080,
     SAME_SLTP_MODE_LINEAR: 130150,
     RISK_ID_NOT_MODIFIED: 134026,
+    CONTRACT_ORDER_NOT_EXISTS: 140001,
+    CONTRACT_INSUFFICIENT_BALANCE: 140007,
+    CONTRACT_POSITION_MODE_NOT_MODIFIED: 140025,
+    CONTRACT_MARGIN_MODE_NOT_MODIFIED: 140026,
+    CONTRACT_RISK_LIMIT_INFO_NOT_EXISTS: 140031,
+    CONTRACT_SET_LEVERAGE_NOT_MODIFIED: 140043,
     /** E.g. USDC Options trading, trying to access a symbol that is no longer active */
     CONTRACT_NAME_NOT_EXIST: 3100111,
     ORDER_NOT_EXIST: 3100136,

package/lib/constants/enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,OAAO,EAAE,CAAC;IACV,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,8BAA8B,EAAE,KAAK;IACrC,mBAAmB,EAAE,KAAK;IAC1B,6BAA6B,EAAE,KAAK;IACpC,4BAA4B,EAAE,OAAO;IACrC,kDAAkD;IAClD,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,KAAK;IAC9B,+BAA+B,EAAE,KAAK;IACtC,oCAAoC,EAAE,KAAK;IAC3C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,mCAAmC,EAAE,KAAK;IAC1C,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,oBAAoB,EAAE,MAAM;IAC5B,oFAAoF;IACpF,uBAAuB,EAAE,OAAO;IAChC,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,yFAAyF;IACzF,iBAAiB,EAAE,OAAO;IAC1B,wBAAwB,EAAE,OAAO;IACjC,+BAA+B,EAAE,OAAO;CAChC,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,cAAc;IAC1B,SAAS,EAAE,UAAU;CACb,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,4HAA4H;IAC5H,IAAI,EAAE,MAAM;IACZ,sHAAsH;IACtH,OAAO,EAAE,SAAS;CACV,CAAC;AAEE,QAAA,cAAc,GAAG;IAC5B,yBAAyB,EAAE,CAAC,IAAI;IAChC,gCAAgC,EAAE,CAAC,IAAI;IACvC,OAAO,EAAE,CAAC;IACV,0FAA0F;IAC1F,uBAAuB,EAAE,KAAK;IAC9B,8BAA8B,EAAE,KAAK;IACrC,mBAAmB,EAAE,KAAK;IAC1B,6BAA6B,EAAE,KAAK;IACpC,4BAA4B,EAAE,OAAO;IACrC,kDAAkD;IAClD,mBAAmB,EAAE,KAAK;IAC1B,aAAa,EAAE,KAAK;IACpB,4BAA4B,EAAE,KAAK;IACnC,uBAAuB,EAAE,KAAK;IAC9B,+BAA+B,EAAE,KAAK;IACtC,oCAAoC,EAAE,KAAK;IAC3C,wBAAwB,EAAE,KAAK;IAC/B,2BAA2B,EAAE,KAAK;IAClC,mCAAmC,EAAE,KAAK;IAC1C,2BAA2B,EAAE,KAAK;IAClC,0BAA0B,EAAE,KAAK;IACjC,oCAAoC,EAAE,KAAK;IAC3C,iCAAiC;IACjC,mCAAmC,EAAE,KAAK;IAC1C,oCAAoC,EAAE,KAAK;IAC3C,+CAA+C;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,2DAA2D;IAC3D,wBAAwB,EAAE,KAAK;IAC/B,0BAA0B,EAAE,KAAK;IACjC,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,KAAK;IACrB,yBAAyB,EAAE,KAAK;IAChC,qBAAqB,EAAE,MAAM;IAC7B,kCAAkC,EAAE,MAAM;IAC1C,wBAAwB,EAAE,MAAM;IAChC,2CAA2C,EAAE,MAAM;IACnD,4BAA4B,EAAE,MAAM;IACpC,qBAAqB,EAAE,MAAM;IAC7B,4BAA4B,EAAE,MAAM;IACpC,0CAA0C,EAAE,MAAM;IAClD,qBAAqB,EAAE,MAAM;IAC7B,oBAAoB,EAAE,MAAM;IAC5B,yBAAyB,EAAE,MAAM;IACjC,6BAA6B,EAAE,MAAM;IACrC,mCAAmC,EAAE,MAAM;IAC3C,iCAAiC,EAAE,MAAM;IACzC,mCAAmC,EAAE,MAAM;IAC3C,kCAAkC,EAAE,MAAM;IAC1C,oFAAoF;IACpF,uBAAuB,EAAE,OAAO;IAChC,eAAe,EAAE,OAAO;IACxB,eAAe,EAAE,OAAO;IACxB,yFAAyF;IACzF,iBAAiB,EAAE,OAAO;IAC1B,wBAAwB,EAAE,OAAO;IACjC,+BAA+B,EAAE,OAAO;CAChC,CAAC;AAEX;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,qEAAc,CAAA;IACd,+DAAW,CAAA;IACX,iEAAY,CAAA;AACd,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}

package/lib/contract-client.d.ts

@@ -0,0 +1,118 @@
+import { APIResponseWithTime, APIResponseV3, UMCandlesRequest, UMCategory, UMFundingRateHistoryRequest, UMInstrumentInfoRequest, UMOpenInterestRequest, UMOptionDeliveryPriceRequest, UMPublicTradesRequest, ContractOrderRequest, ContractHistoricOrdersRequest, ContractCancelOrderRequest, ContractModifyOrderRequest, ContractActiveOrdersRequest, ContractPositionsRequest, ContractSetAutoAddMarginRequest, ContractSetMarginSwitchRequest, ContractSetPositionModeRequest, ContractSetTPSLRequest, ContractUserExecutionHistoryRequest, ContractClosedPNLRequest, ContractWalletFundRecordRequest } from './types';
+import BaseRestClient from './util/BaseRestClient';
+/**
+ * REST API client for Derivatives V3 Contract APIs
+ */
+export declare class ContractClient extends BaseRestClient {
+    getClientType(): "v3";
+    fetchServerTime(): Promise<number>;
+    /**
+     *
+     * Market Data Endpoints : these seem exactly the same as the unified margin market data endpoints
+     *
+     */
+    /** Query order book info. Each side has a depth of 25 orders. */
+    getOrderBook(symbol: string, category: string, limit?: number): Promise<APIResponseV3<any>>;
+    /** Get candles/klines */
+    getCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>>;
+    /** Get a symbol price/statistics ticker */
+    getSymbolTicker(category: UMCategory, symbol?: string): Promise<APIResponseV3<any>>;
+    /** Get trading rules per symbol/contract, incl price/amount/value/leverage filters */
+    getInstrumentInfo(params: UMInstrumentInfoRequest): Promise<APIResponseV3<any>>;
+    /** Query mark price kline (like getCandles() but for mark price). */
+    getMarkPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>>;
+    /** Query Index Price Kline */
+    getIndexPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>>;
+    /**
+     * The funding rate is generated every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC.
+     * For example, if a request is sent at 12:00 UTC, the funding rate generated earlier that day at 08:00 UTC will be sent.
+     */
+    getFundingRateHistory(params: UMFundingRateHistoryRequest): Promise<APIResponseV3<any>>;
+    /** Get Risk Limit */
+    getRiskLimit(category: UMCategory, symbol: string): Promise<APIResponseV3<any>>;
+    /** Get option delivery price */
+    getOptionDeliveryPrice(params: UMOptionDeliveryPriceRequest): Promise<APIResponseV3<any>>;
+    /** Get public trading history */
+    getTrades(params: UMPublicTradesRequest): Promise<APIResponseV3<any>>;
+    /**
+     * Gets the total amount of unsettled contracts.
+     * In other words, the total number of contracts held in open positions.
+     */
+    getOpenInterest(params: UMOpenInterestRequest): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * Contract Account Endpoints
+     *
+     */
+    /** -> Order API */
+    /** Place an order */
+    submitOrder(params: ContractOrderRequest): Promise<APIResponseV3<any>>;
+    /** Query order history. As order creation/cancellation is asynchronous, the data returned from the interface may be delayed. To access order information in real-time, call getActiveOrders() */
+    getHistoricOrders(params: ContractHistoricOrdersRequest): Promise<APIResponseV3<any>>;
+    /** Cancel order */
+    cancelOrder(params: ContractCancelOrderRequest): Promise<APIResponseV3<any>>;
+    /** Cancel all orders */
+    cancelAllOrders(symbol: string): Promise<APIResponseV3<any>>;
+    /** Replace order : 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: ContractModifyOrderRequest): Promise<APIResponseV3<any>>;
+    /** Query Open Order(s) (real-time) */
+    getActiveOrders(params: ContractActiveOrdersRequest): Promise<APIResponseV3<any>>;
+    /** -> Positions API */
+    /**
+     * Query my positions real-time. Accessing personal list of positions.
+     * Either symbol or settleCoin is required.
+     * Users can access their position holding information through this interface, such as the number of position holdings and wallet balance.
+     */
+    getPositions(params?: ContractPositionsRequest): Promise<APIResponseV3<any>>;
+    /** Set auto add margin, or Auto-Margin Replenishment. */
+    setAutoAddMargin(params: ContractSetAutoAddMarginRequest): Promise<APIResponseV3<any>>;
+    /** Switch cross margin mode/isolated margin mode */
+    setMarginSwitch(params: ContractSetMarginSwitchRequest): Promise<APIResponseV3<any>>;
+    /** Supports switching between One-Way Mode and Hedge Mode at the coin level. */
+    setPositionMode(params: ContractSetPositionModeRequest): Promise<APIResponseV3<any>>;
+    /**
+     * Switch mode between Full or Partial
+     */
+    setTPSLMode(symbol: string, tpSlMode: 'Full' | 'Partial'): Promise<APIResponseV3<any>>;
+    /** Leverage setting. */
+    setLeverage(symbol: string, buyLeverage: string, sellLeverage: string): Promise<APIResponseV3<any>>;
+    /**
+     * Set take profit, stop loss, and trailing stop for your open position.
+     * If using partial mode, TP/SL/TS orders will not close your entire position.
+     */
+    setTPSL(params: ContractSetTPSLRequest): Promise<APIResponseV3<any>>;
+    /** Set risk limit */
+    setRiskLimit(symbol: string, riskId: number, 
+    /** 0-one-way, 1-buy side, 2-sell side */
+    positionIdx: 0 | 1 | 2): Promise<APIResponseV3<any>>;
+    /**
+     * Get user's trading records.
+     * The results are ordered in descending order (the first item is the latest). Returns records up to 2 years old.
+     */
+    getUserExecutionHistory(params: ContractUserExecutionHistoryRequest): Promise<APIResponseV3<any>>;
+    /**
+     * Get user's closed profit and loss records.
+     * The results are ordered in descending order (the first item is the latest).
+     */
+    getClosedProfitAndLoss(params: ContractClosedPNLRequest): Promise<APIResponseV3<any>>;
+    /** Get the information of open interest limit. */
+    getOpenInterestLimitInfo(symbol: string): Promise<APIResponseV3<any>>;
+    /** -> Account API */
+    /** Query wallet balance */
+    getBalances(coin?: string): Promise<APIResponseV3<any>>;
+    /** Get user trading fee rate */
+    getTradingFeeRate(symbol?: string): Promise<APIResponseV3<any>>;
+    /**
+     * Get wallet fund records.
+     * This endpoint also shows exchanges from the Asset Exchange, where the types for the exchange are ExchangeOrderWithdraw and ExchangeOrderDeposit.
+     * This endpoint returns incomplete information for transfers involving the derivatives wallet.
+     * Use the account asset API for creating and querying internal transfers.
+     */
+    getWalletFundRecords(params?: ContractWalletFundRecordRequest): Promise<APIResponseV3<any>>;
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime(): Promise<APIResponseWithTime>;
+}

package/lib/contract-client.js

@@ -0,0 +1,233 @@
+"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.ContractClient = void 0;
+const util_1 = require("./util");
+const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
+/**
+ * REST API client for Derivatives V3 Contract APIs
+ */
+class ContractClient extends BaseRestClient_1.default {
+    getClientType() {
+        // Follows the same authentication mechanism as other v3 APIs (e.g. USDC)
+        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 : these seem exactly the same as the unified margin market data endpoints
+     *
+     */
+    /** Query order book info. Each side has a depth of 25 orders. */
+    getOrderBook(symbol, category, limit) {
+        return this.get('/derivatives/v3/public/order-book/L2', {
+            category,
+            symbol,
+            limit,
+        });
+    }
+    /** Get candles/klines */
+    getCandles(params) {
+        return this.get('/derivatives/v3/public/kline', params);
+    }
+    /** Get a symbol price/statistics ticker */
+    getSymbolTicker(category, symbol) {
+        return this.get('/derivatives/v3/public/tickers', { category, symbol });
+    }
+    /** Get trading rules per symbol/contract, incl price/amount/value/leverage filters */
+    getInstrumentInfo(params) {
+        return this.get('/derivatives/v3/public/instruments-info', params);
+    }
+    /** Query mark price kline (like getCandles() but for mark price). */
+    getMarkPriceCandles(params) {
+        return this.get('/derivatives/v3/public/mark-price-kline', params);
+    }
+    /** Query Index Price Kline */
+    getIndexPriceCandles(params) {
+        return this.get('/derivatives/v3/public/index-price-kline', params);
+    }
+    /**
+     * The funding rate is generated every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC.
+     * For example, if a request is sent at 12:00 UTC, the funding rate generated earlier that day at 08:00 UTC will be sent.
+     */
+    getFundingRateHistory(params) {
+        return this.get('/derivatives/v3/public/funding/history-funding-rate', params);
+    }
+    /** Get Risk Limit */
+    getRiskLimit(category, symbol) {
+        return this.get('/derivatives/v3/public/risk-limit/list', {
+            category,
+            symbol,
+        });
+    }
+    /** Get option delivery price */
+    getOptionDeliveryPrice(params) {
+        return this.get('/derivatives/v3/public/delivery-price', params);
+    }
+    /** Get public trading history */
+    getTrades(params) {
+        return this.get('/derivatives/v3/public/recent-trade', params);
+    }
+    /**
+     * Gets the total amount of unsettled contracts.
+     * In other words, the total number of contracts held in open positions.
+     */
+    getOpenInterest(params) {
+        return this.get('/derivatives/v3/public/open-interest', params);
+    }
+    /**
+     *
+     * Contract Account Endpoints
+     *
+     */
+    /** -> Order API */
+    /** Place an order */
+    submitOrder(params) {
+        return this.postPrivate('/contract/v3/private/order/create', params);
+    }
+    /** Query order history. As order creation/cancellation is asynchronous, the data returned from the interface may be delayed. To access order information in real-time, call getActiveOrders() */
+    getHistoricOrders(params) {
+        return this.getPrivate('/contract/v3/private/order/list', params);
+    }
+    /** Cancel order */
+    cancelOrder(params) {
+        return this.postPrivate('/contract/v3/private/order/cancel', params);
+    }
+    /** Cancel all orders */
+    cancelAllOrders(symbol) {
+        return this.postPrivate('/contract/v3/private/order/cancel-all', {
+            symbol,
+        });
+    }
+    /** Replace order : 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('/contract/v3/private/order/replace', params);
+    }
+    /** Query Open Order(s) (real-time) */
+    getActiveOrders(params) {
+        return this.getPrivate('/contract/v3/private/order/unfilled-orders', params);
+    }
+    /** -> Positions API */
+    /**
+     * Query my positions real-time. Accessing personal list of positions.
+     * Either symbol or settleCoin is required.
+     * Users can access their position holding information through this interface, such as the number of position holdings and wallet balance.
+     */
+    getPositions(params) {
+        return this.getPrivate('/contract/v3/private/position/list', params);
+    }
+    /** Set auto add margin, or Auto-Margin Replenishment. */
+    setAutoAddMargin(params) {
+        return this.postPrivate('/contract/v3/private/position/set-auto-add-margin', params);
+    }
+    /** Switch cross margin mode/isolated margin mode */
+    setMarginSwitch(params) {
+        return this.postPrivate('/contract/v3/private/position/switch-isolated', params);
+    }
+    /** Supports switching between One-Way Mode and Hedge Mode at the coin level. */
+    setPositionMode(params) {
+        return this.postPrivate('/contract/v3/private/position/switch-mode', params);
+    }
+    /**
+     * Switch mode between Full or Partial
+     */
+    setTPSLMode(symbol, tpSlMode) {
+        return this.postPrivate('/contract/v3/private/position/switch-tpsl-mode', {
+            symbol,
+            tpSlMode,
+        });
+    }
+    /** Leverage setting. */
+    setLeverage(symbol, buyLeverage, sellLeverage) {
+        return this.postPrivate('/contract/v3/private/position/set-leverage', {
+            symbol,
+            buyLeverage,
+            sellLeverage,
+        });
+    }
+    /**
+     * Set take profit, stop loss, and trailing stop for your open position.
+     * If using partial mode, TP/SL/TS orders will not close your entire position.
+     */
+    setTPSL(params) {
+        return this.postPrivate('/contract/v3/private/position/trading-stop', params);
+    }
+    /** Set risk limit */
+    setRiskLimit(symbol, riskId, 
+    /** 0-one-way, 1-buy side, 2-sell side */
+    positionIdx) {
+        return this.postPrivate('/contract/v3/private/position/set-risk-limit', {
+            symbol,
+            riskId,
+            positionIdx,
+        });
+    }
+    /**
+     * Get user's trading records.
+     * The results are ordered in descending order (the first item is the latest). Returns records up to 2 years old.
+     */
+    getUserExecutionHistory(params) {
+        return this.getPrivate('/contract/v3/private/execution/list', params);
+    }
+    /**
+     * Get user's closed profit and loss records.
+     * The results are ordered in descending order (the first item is the latest).
+     */
+    getClosedProfitAndLoss(params) {
+        return this.getPrivate('/contract/v3/private/position/closed-pnl', params);
+    }
+    /** Get the information of open interest limit. */
+    getOpenInterestLimitInfo(symbol) {
+        return this.getPrivate('/contract/v3/private/position/closed-pnl', {
+            symbol,
+        });
+    }
+    /** -> Account API */
+    /** Query wallet balance */
+    getBalances(coin) {
+        return this.getPrivate('/contract/v3/private/account/wallet/balance', {
+            coin,
+        });
+    }
+    /** Get user trading fee rate */
+    getTradingFeeRate(symbol) {
+        return this.getPrivate('/contract/v3/private/account/fee-rate', {
+            symbol,
+        });
+    }
+    /**
+     * Get wallet fund records.
+     * This endpoint also shows exchanges from the Asset Exchange, where the types for the exchange are ExchangeOrderWithdraw and ExchangeOrderDeposit.
+     * This endpoint returns incomplete information for transfers involving the derivatives wallet.
+     * Use the account asset API for creating and querying internal transfers.
+     */
+    getWalletFundRecords(params) {
+        return this.getPrivate('/contract/v3/private/account/wallet/fund-records', params);
+    }
+    /**
+     *
+     * API Data Endpoints
+     *
+     */
+    getServerTime() {
+        return this.get('/v2/public/time');
+    }
+}
+exports.ContractClient = ContractClient;
+//# sourceMappingURL=contract-client.js.map

package/lib/contract-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-client.js","sourceRoot":"","sources":["../src/contract-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAwBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,cAAe,SAAQ,wBAAc;IAChD,aAAa;QACX,yEAAyE;QACzE,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,CACV,MAAc,EACd,QAAgB,EAChB,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACtD,QAAQ;YACR,MAAM;YACN,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,UAAU,CAAC,MAAwB;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,2CAA2C;IAC3C,eAAe,CACb,QAAoB,EACpB,MAAe;QAEf,OAAO,IAAI,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,sFAAsF;IACtF,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,qEAAqE;IACrE,mBAAmB,CAAC,MAAwB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,8BAA8B;IAC9B,oBAAoB,CAAC,MAAwB;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAmC;QAEnC,OAAO,IAAI,CAAC,GAAG,CACb,qDAAqD,EACrD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qBAAqB;IACrB,YAAY,CACV,QAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,wCAAwC,EAAE;YACxD,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC;IAChC,sBAAsB,CACpB,MAAoC;QAEpC,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,iCAAiC;IACjC,SAAS,CAAC,MAA6B;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAA6B;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IAEH,mBAAmB;IAEnB,qBAAqB;IACrB,WAAW,CAAC,MAA4B;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,iMAAiM;IACjM,iBAAiB,CACf,MAAqC;QAErC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,mBAAmB;IACnB,WAAW,CAAC,MAAkC;QAC5C,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,wBAAwB;IACxB,eAAe,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE;YAC/D,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,8LAA8L;IAC9L,WAAW,CAAC,MAAkC;QAC5C,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,sCAAsC;IACtC,eAAe,CACb,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CACpB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,uBAAuB;IAEvB;;;;OAIG;IACH,YAAY,CAAC,MAAiC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,yDAAyD;IACzD,gBAAgB,CACd,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CACrB,mDAAmD,EACnD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,oDAAoD;IACpD,eAAe,CACb,MAAsC;QAEtC,OAAO,IAAI,CAAC,WAAW,CACrB,+CAA+C,EAC/C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,gFAAgF;IAChF,eAAe,CACb,MAAsC;QAEtC,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,WAAW,CACT,MAAc,EACd,QAA4B;QAE5B,OAAO,IAAI,CAAC,WAAW,CAAC,gDAAgD,EAAE;YACxE,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB;IACxB,WAAW,CACT,MAAc,EACd,WAAmB,EACnB,YAAoB;QAEpB,OAAO,IAAI,CAAC,WAAW,CAAC,4CAA4C,EAAE;YACpE,MAAM;YACN,WAAW;YACX,YAAY;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,MAA8B;QACpC,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,qBAAqB;IACrB,YAAY,CACV,MAAc,EACd,MAAc;IACd,yCAAyC;IACzC,WAAsB;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,8CAA8C,EAAE;YACtE,MAAM;YACN,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,uBAAuB,CACrB,MAA2C;QAE3C,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,sBAAsB,CACpB,MAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED,kDAAkD;IAClD,wBAAwB,CAAC,MAAc;QACrC,OAAO,IAAI,CAAC,UAAU,CAAC,0CAA0C,EAAE;YACjE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,qBAAqB;IAErB,2BAA2B;IAC3B,WAAW,CAAC,IAAa;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,6CAA6C,EAAE;YACpE,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC;IAChC,iBAAiB,CAAC,MAAe;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,uCAAuC,EAAE;YAC9D,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAClB,MAAwC;QAExC,OAAO,IAAI,CAAC,UAAU,CACpB,kDAAkD,EAClD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF;AAtTD,wCAsTC"}

package/lib/index.d.ts

@@ -8,6 +8,7 @@ export * from './spot-client-v3';
 export * from './usdc-option-client';
 export * from './usdc-perpetual-client';
 export * from './unified-margin-client';
+export * from './contract-client';
 export * from './websocket-client';
 export * from './util/logger';
 export * from './util';

package/lib/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./spot-client-v3"), exports);
 __exportStar(require("./usdc-option-client"), exports);
 __exportStar(require("./usdc-perpetual-client"), exports);
 __exportStar(require("./unified-margin-client"), exports);
+__exportStar(require("./contract-client"), exports);
 __exportStar(require("./websocket-client"), exports);
 __exportStar(require("./util/logger"), exports);
 __exportStar(require("./util"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,wDAAsC;AACtC,mDAAiC;AACjC,2DAAyC;AACzC,kDAAgC;AAChC,gDAA8B;AAC9B,mDAAiC;AACjC,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,qDAAmC;AACnC,gDAA8B;AAC9B,yCAAuB;AACvB,0CAAwB;AACxB,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,wDAAsC;AACtC,mDAAiC;AACjC,2DAAyC;AACzC,kDAAgC;AAChC,gDAA8B;AAC9B,mDAAiC;AACjC,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,oDAAkC;AAClC,qDAAmC;AACnC,gDAA8B;AAC9B,yCAAuB;AACvB,0CAAwB;AACxB,mDAAiC"}

package/lib/types/request/contract.d.ts

@@ -0,0 +1,115 @@
+import { OrderSide } from '../shared';
+import { UMOrderType } from './unified-margin';
+import { USDCOrderFilter, USDCTimeInForce } from './usdc-shared';
+export interface ContractOrderRequest {
+    symbol: string;
+    side: OrderSide;
+    positionIdx?: '0' | '1' | '2';
+    orderType: UMOrderType;
+    qty: string;
+    price?: string;
+    triggerDirection?: '1' | '2';
+    triggerPrice?: string;
+    triggerBy?: string;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    timeInForce: USDCTimeInForce;
+    orderLinkId?: string;
+    takeProfit?: number;
+    stopLoss?: number;
+    reduceOnly?: boolean;
+    closeOnTrigger?: boolean;
+}
+export interface ContractHistoricOrdersRequest {
+    orderId?: string;
+    orderLinkId?: string;
+    symbol: string;
+    orderStatus?: string;
+    orderFilter?: USDCOrderFilter;
+    limit?: number;
+    cursor?: string;
+}
+export interface ContractCancelOrderRequest {
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+}
+export interface ContractModifyOrderRequest {
+    orderId?: string;
+    orderLinkId?: string;
+    symbol: string;
+    qty?: string;
+    price?: string;
+    takeProfit?: number;
+    stopLoss?: number;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    triggerBy?: string;
+}
+export interface ContractActiveOrdersRequest {
+    symbol?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    settleCoin?: string;
+    orderFilter?: USDCOrderFilter;
+    limit?: number;
+}
+export interface ContractPositionsRequest {
+    symbol?: string;
+    settleCoin?: string;
+    dataFilter?: string;
+}
+export interface ContractSetAutoAddMarginRequest {
+    symbol: string;
+    side: 'Buy' | 'Sell';
+    autoAddMargin: 1 | 0;
+    positionIdx?: 0 | 1 | 2;
+}
+export interface ContractSetMarginSwitchRequest {
+    symbol: string;
+    tradeMode: 0 | 1;
+    buyLeverage: string;
+    sellLeverage: string;
+}
+export interface ContractSetPositionModeRequest {
+    symbol?: string;
+    coin?: string;
+    mode: 0 | 3;
+}
+export interface ContractSetTPSLRequest {
+    symbol: string;
+    takeProfit?: string;
+    stopLoss?: string;
+    activePrice?: string;
+    trailingStop?: string;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    slSize?: string;
+    tpSize?: string;
+    /** 0-one-way, 1-buy side, 2-sell side */
+    positionIdx?: 0 | 1 | 2;
+}
+export interface ContractUserExecutionHistoryRequest {
+    symbol: string;
+    orderId?: string;
+    startTime?: number;
+    endTime?: number;
+    execType?: 'Trade' | 'AdlTrade' | 'Funding' | 'BustTrade';
+    limit?: number;
+    cursor?: string;
+}
+export interface ContractClosedPNLRequest {
+    symbol: string;
+    startTime?: number;
+    endTime?: number;
+    limit?: number;
+    cursor?: string;
+}
+export interface ContractWalletFundRecordRequest {
+    startTime?: string;
+    endTime?: string;
+    coin?: string;
+    walletFundType?: string;
+    limit?: string;
+    cursor?: string;
+}

package/lib/types/request/contract.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contract.js.map

package/lib/types/request/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../../src/types/request/contract.ts"],"names":[],"mappings":""}

package/lib/types/request/index.d.ts

@@ -7,3 +7,4 @@ export * from './usdc-perp';
 export * from './usdc-options';
 export * from './usdc-shared';
 export * from './unified-margin';
+export * from './contract';

package/lib/types/request/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./usdc-perp"), exports);
 __exportStar(require("./usdc-options"), exports);
 __exportStar(require("./usdc-shared"), exports);
 __exportStar(require("./unified-margin"), exports);
+__exportStar(require("./contract"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/request/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4CAA0B;AAC1B,yCAAuB;AACvB,8CAA4B;AAC5B,iDAA+B;AAC/B,gDAA8B;AAC9B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,iDAA+B;AAC/B,2CAAyB;AACzB,4CAA0B;AAC1B,yCAAuB;AACvB,8CAA4B;AAC5B,iDAA+B;AAC/B,gDAA8B;AAC9B,mDAAiC;AACjC,6CAA2B"}

package/lib/types/response/index.d.ts

@@ -1,3 +1,4 @@
 export * from './shared';
 export * from './spot';
 export * from './usdt-perp';
+export * from './unified-margin';

package/lib/types/response/index.js

@@ -13,4 +13,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./shared"), exports);
 __exportStar(require("./spot"), exports);
 __exportStar(require("./usdt-perp"), exports);
+__exportStar(require("./unified-margin"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/response/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,yCAAuB;AACvB,8CAA4B;AAC5B,mDAAiC"}