bybit-api 3.10.30 → 4.0.0-beta.0

package/lib/unified-margin-client.js

@@ -1,270 +0,0 @@
-"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.UnifiedMarginClient = void 0;
-const util_1 = require("./util");
-const BaseRestClient_1 = __importDefault(require("./util/BaseRestClient"));
-/**
- * REST API client for Derivatives V3 unified margin APIs
- * @deprecated WARNING
- * These endpoints are being switched off gradually and are expected to be completely turned off by the end of 2024.
- * They may stop working at any point before then.
- * Please update your code as soon as possible to use the V5 APIs instead.
- */
-class UnifiedMarginClient 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, 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 recent trades */
-    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);
-    }
-    /**
-     *
-     * Unified Margin Account Endpoints
-     *
-     */
-    /** -> Order API */
-    /** Place an order */
-    submitOrder(params) {
-        return this.postPrivate('/unified/v3/private/order/create', 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('/unified/v3/private/order/replace', params);
-    }
-    /** Cancel order */
-    cancelOrder(params) {
-        return this.postPrivate('/unified/v3/private/order/cancel', params);
-    }
-    /** Query Open Orders */
-    getActiveOrders(params) {
-        return this.getPrivate('/unified/v3/private/order/unfilled-orders', 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('/unified/v3/private/order/list', params);
-    }
-    /**
-     * This API provides the batch order mode under the unified margin account.
-     * Max 10 per request
-     */
-    batchSubmitOrders(category, orders) {
-        return this.postPrivate('/unified/v3/private/order/create-batch', {
-            category,
-            request: orders,
-        });
-    }
-    /**
-     * This interface can modify the open order information in batches.
-     * Currently, it is not supported to modify the conditional order information.
-     * Please note that only unfilled or partial filled orders can be modified.
-     * If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type
-     */
-    batchReplaceOrders(category, orders) {
-        return this.postPrivate('/unified/v3/private/order/replace-batch', {
-            category,
-            request: orders,
-        });
-    }
-    /**
-     * This API provides batch cancellation under the unified margin account.
-     * Order cancellation of futures and options cannot be canceled in one request at the same time.
-     * If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type.
-     */
-    batchCancelOrders(category, orders) {
-        return this.postPrivate('/unified/v3/private/order/cancel-batch', {
-            category,
-            request: orders,
-        });
-    }
-    /**
-     * This API provides the cancellation of all open orders under the unified margin account.
-     * Order cancellation of futures and options cannot be canceled in one request at the same time.
-     * If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type.
-     */
-    cancelAllOrders(params) {
-        return this.postPrivate('/unified/v3/private/order/cancel-all', params);
-    }
-    /** -> Positions API */
-    /**
-     * Query my positions real-time. Accessing personal list of positions.
-     * 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('/unified/v3/private/position/list', params);
-    }
-    /** Leverage setting. */
-    setLeverage(category, symbol, buyLeverage, sellLeverage) {
-        return this.postPrivate('/unified/v3/private/position/set-leverage', {
-            category,
-            symbol,
-            buyLeverage,
-            sellLeverage,
-        });
-    }
-    /**
-     * Switching the TP/SL mode to the cross margin mode or selected positions.
-     * When you set the TP/SL mode on the selected positions, the quantity of take-profit or stop-loss orders can be smaller than the position size. Please use Trading-Stop endpoint.
-     */
-    setTPSLMode(category, symbol, tpSlMode) {
-        return this.postPrivate('/unified/v3/private/position/tpsl/switch-mode', {
-            category,
-            symbol,
-            tpSlMode,
-        });
-    }
-    /** Set risk limit */
-    setRiskLimit(category, symbol, riskId, positionIdx) {
-        return this.postPrivate('/unified/v3/private/position/set-risk-limit', {
-            category,
-            symbol,
-            riskId,
-            positionIdx,
-        });
-    }
-    /**
-     * Set position TP/SL and trailing stop.
-     * Pass the following parameters, then the system will create conditional orders.
-     * If the position is closed, the system will cancel these orders, and adjust the position size.
-     */
-    setTPSL(params) {
-        return this.postPrivate('/unified/v3/private/position/trading-stop', params);
-    }
-    /**
-     * Access the user's filled history, ranked by time in descending order.
-     * There might be multiple filled histories for an order.
-     */
-    get7DayTradingHistory(params) {
-        return this.getPrivate('/unified/v3/private/execution/list', params);
-    }
-    /** Query the settlement history, ranked by time in descending order. */
-    getOptionsSettlementHistory(params) {
-        return this.getPrivate('/unified/v3/private/delivery-record', params);
-    }
-    /** Query session settlement records, only for USDC perpetual */
-    getUSDCPerpetualSettlementHistory(params) {
-        return this.getPrivate('/unified/v3/private/settlement-record', params);
-    }
-    /** -> Account API */
-    /** Query wallet balance */
-    getBalances(coin) {
-        return this.getPrivate('/unified/v3/private/account/wallet/balance', {
-            coin,
-        });
-    }
-    /**
-     * Upgrade to unified margin account.
-     * WARNING: This is currently not reversable!
-     */
-    upgradeToUnifiedMargin() {
-        return this.postPrivate('/unified/v3/private/account/upgrade-unified-account');
-    }
-    /** Query trading history */
-    getTransactionLog(params) {
-        return this.getPrivate('/unified/v3/private/account/transaction-log', params);
-    }
-    /** Fund transfer between accounts (v2) */
-    transferFunds(params) {
-        return this.postPrivate('/asset/v1/private/transfer', params);
-    }
-    /** Exchange Coins */
-    getCoinExchangeHistory(params) {
-        return this.getPrivate('/asset/v2/private/exchange/exchange-order-all', params);
-    }
-    /** Get Borrow History */
-    getBorrowHistory(params) {
-        return this.getPrivate('/unified/v3/private/account/borrow-history', params);
-    }
-    /** Get Borrow Rate */
-    getBorrowRate(currency) {
-        return this.getPrivate('/unified/v3/private/account/borrow-rate', {
-            currency,
-        });
-    }
-    /**
-     *
-     * API Data Endpoints
-     *
-     */
-    getServerTime() {
-        return this.get('/v2/public/time');
-    }
-}
-exports.UnifiedMarginClient = UnifiedMarginClient;
-//# sourceMappingURL=unified-margin-client.js.map

package/lib/unified-margin-client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"unified-margin-client.js","sourceRoot":"","sources":["../src/unified-margin-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAkCA,iCAA+C;AAC/C,2EAAmD;AAEnD;;;;;;GAMG;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,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,wBAAwB;IACxB,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,MAAsB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,8KAA8K;IAC9K,WAAW,CAAC,MAA4B;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,mBAAmB;IACnB,WAAW,CAAC,MAA4B;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,wBAAwB;IACxB,eAAe,CAAC,MAA6B;QAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED,iMAAiM;IACjM,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACH,iBAAiB,CACf,QAAoB,EACpB,MAAsB;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,QAAQ;YACR,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAChB,QAAoB,EACpB,MAA6B;QAE7B,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,QAAQ;YACR,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,QAAoB,EACpB,MAA4B;QAE5B,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,QAAQ;YACR,OAAO,EAAE,MAAM;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,eAAe,CACb,MAAgC;QAEhC,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,uBAAuB;IAEvB;;;OAGG;IACH,YAAY,CAAC,MAA0B;QACrC,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,wBAAwB;IACxB,WAAW,CACT,QAAoB,EACpB,MAAc,EACd,WAAmB,EACnB,YAAoB;QAEpB,OAAO,IAAI,CAAC,WAAW,CAAC,2CAA2C,EAAE;YACnE,QAAQ;YACR,MAAM;YACN,WAAW;YACX,YAAY;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,WAAW,CACT,QAAoB,EACpB,MAAc,EACd,QAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,+CAA+C,EAAE;YACvE,QAAQ;YACR,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,qBAAqB;IACrB,YAAY,CACV,QAAoB,EACpB,MAAc,EACd,MAAc,EACd,WAAmB;QAEnB,OAAO,IAAI,CAAC,WAAW,CAAC,6CAA6C,EAAE;YACrE,QAAQ;YACR,MAAM;YACN,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAwB;QAC9B,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,qBAAqB,CACnB,MAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,wEAAwE;IACxE,2BAA2B,CACzB,MAAyC;QAEzC,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,gEAAgE;IAChE,iCAAiC,CAC/B,MAAsC;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED,qBAAqB;IAErB,2BAA2B;IAC3B,WAAW,CAAC,IAAa;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,4CAA4C,EAAE;YACnE,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,WAAW,CACrB,qDAAqD,CACtD,CAAC;IACJ,CAAC;IAED,4BAA4B;IAC5B,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,UAAU,CACpB,6CAA6C,EAC7C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,aAAa,CAAC,MAA+B;QAC3C,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,qBAAqB;IACrB,sBAAsB,CACpB,MAA+B;QAE/B,OAAO,IAAI,CAAC,UAAU,CACpB,+CAA+C,EAC/C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,MAA+B;QAE/B,OAAO,IAAI,CAAC,UAAU,CACpB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,sBAAsB;IACtB,aAAa,CAAC,QAAiB;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,yCAAyC,EAAE;YAChE,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF;AApWD,kDAoWC"}

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

@@ -1,110 +0,0 @@
-import { APIResponseV3, APIResponseWithTime, USDCOptionsActiveOrdersRealtimeRequest, USDCOptionsActiveOrdersRequest, USDCOptionsCancelAllOrdersRequest, USDCOptionsCancelOrderRequest, USDCOptionsContractInfoRequest, USDCOptionsDeliveryHistoryRequest, USDCOptionsDeliveryPriceRequest, USDCOptionsHistoricOrdersRequest, USDCOptionsHistoricalVolatilityRequest, USDCOptionsModifyMMPRequest, USDCOptionsModifyOrderRequest, USDCOptionsOrderExecutionRequest, USDCOptionsOrderRequest, USDCOptionsPositionsInfoExpiryRequest, USDCOptionsRecentTradesRequest, USDCPositionsRequest, USDCTransactionLogRequest } from './types';
-import BaseRestClient from './util/BaseRestClient';
-/**
- * REST API client for USDC Option APIs
- *
- * @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
- * will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
- * Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
- */
-export declare class USDCOptionClient extends BaseRestClient {
-    getClientType(): "v3";
-    fetchServerTime(): Promise<number>;
-    /**
-     *
-     * Market Data Endpoints
-     *
-     */
-    /** Query order book info. Each side has a depth of 25 orders. */
-    getOrderBook(symbol: string): Promise<APIResponseV3<any>>;
-    /** Fetch trading rules (such as min/max qty). Query for all if blank. */
-    getContractInfo(params?: USDCOptionsContractInfoRequest): Promise<APIResponseV3<any>>;
-    /** Get a symbol price/statistics ticker */
-    getSymbolTicker(symbol: string): Promise<APIResponseV3<any>>;
-    /** Get delivery information */
-    getDeliveryPrice(params?: USDCOptionsDeliveryPriceRequest): Promise<APIResponseV3<any>>;
-    /** Returned records are Taker Buy in default. */
-    getLast500Trades(params: USDCOptionsRecentTradesRequest): Promise<APIResponseV3<any>>;
-    /**
-     * 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?: USDCOptionsHistoricalVolatilityRequest): 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: USDCOptionsOrderRequest): Promise<APIResponseV3<any>>;
-    /**
-     * Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request.
-     */
-    batchSubmitOrders(orderRequest: USDCOptionsOrderRequest[]): Promise<APIResponseV3<any>>;
-    /** For Options, at least one of the three parameters — price, quantity or implied volatility — must be input. */
-    modifyOrder(params: USDCOptionsModifyOrderRequest): Promise<APIResponseV3<any>>;
-    /** Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request. */
-    batchModifyOrders(replaceOrderRequest: USDCOptionsModifyOrderRequest[]): Promise<APIResponseV3<any>>;
-    /** Cancel order */
-    cancelOrder(params: USDCOptionsCancelOrderRequest): Promise<APIResponseV3<any>>;
-    /** Batch cancel orders */
-    batchCancelOrders(cancelRequest: USDCOptionsCancelOrderRequest[]): Promise<APIResponseV3<any>>;
-    /** This is used to cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
-    cancelActiveOrders(params?: USDCOptionsCancelAllOrdersRequest): Promise<APIResponseV3<any>>;
-    /** Query Unfilled/Partially Filled Orders(real-time), up to last 7 days of partially filled/unfilled orders */
-    getActiveRealtimeOrders(params?: USDCOptionsActiveOrdersRealtimeRequest): Promise<APIResponseV3<any>>;
-    /** Query Unfilled/Partially Filled Orders */
-    getActiveOrders(params: USDCOptionsActiveOrdersRequest): Promise<APIResponseV3<any>>;
-    /** Query order history. The endpoint only supports up to 30 days of queried records */
-    getHistoricOrders(params: USDCOptionsHistoricOrdersRequest): 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: USDCOptionsOrderExecutionRequest): 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>>;
-    /** Query Delivery History */
-    getDeliveryHistory(params: USDCOptionsDeliveryHistoryRequest): Promise<APIResponseV3<any>>;
-    /** Query Positions Info Upon Expiry */
-    getPositionsInfoUponExpiry(params?: USDCOptionsPositionsInfoExpiryRequest): Promise<APIResponseV3<any>>;
-    /** -> Market Maker Protection */
-    /** modifyMMP */
-    modifyMMP(params: USDCOptionsModifyMMPRequest): Promise<APIResponseV3<any>>;
-    /** resetMMP */
-    resetMMP(currency: string): Promise<APIResponseV3<any>>;
-    /** queryMMPState */
-    queryMMPState(baseCoin: string): Promise<APIResponseV3<any>>;
-    /**
-     *
-     * API Data Endpoints
-     *
-     */
-    getServerTime(): Promise<APIResponseWithTime>;
-}

package/lib/usdc-option-client.js

@@ -1,196 +0,0 @@
-"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
- *
- * @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
- * will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
- * Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
- */
-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

@@ -1 +0,0 @@
-{"version":3,"file":"usdc-option-client.js","sourceRoot":"","sources":["../src/usdc-option-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAsBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;;;;;GAMG;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;;;;OAIG;IACH,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;;;;;OAKG;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;AAhTD,4CAgTC"}