bybit-api 2.3.2 → 2.4.0-beta.2

package/lib/types/request/unified-margin.d.ts

@@ -0,0 +1,223 @@
+import { KlineIntervalV3, OrderSide } from '../shared';
+import { USDCOrderFilter, USDCTimeInForce } from './usdc-shared';
+export declare type UMCategory = 'linear' | 'inverse' | 'option';
+export declare type UMOrderType = 'Limit' | 'Market';
+export declare type UMDirection = 'prev' | 'next';
+export interface UMCandlesRequest {
+    category: UMCategory;
+    symbol: string;
+    interval: KlineIntervalV3;
+    start: number;
+    end: number;
+    limit?: number;
+}
+export interface UMInstrumentInfoRequest {
+    category: UMCategory;
+    symbol?: string;
+    baseCoin?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface UMFundingRateHistoryRequest {
+    category: UMCategory;
+    symbol: string;
+    startTime?: number;
+    endTime?: number;
+    limit?: number;
+}
+export interface UMOptionDeliveryPriceRequest {
+    category: UMCategory;
+    symbol?: string;
+    baseCoin?: string;
+    direction?: UMDirection;
+    limit?: string;
+    cursor?: string;
+}
+export interface UMPublicTradesRequest {
+    category: UMCategory;
+    symbol: string;
+    baseCoin?: string;
+    optionType?: 'Call' | 'Put';
+    limit?: string;
+}
+export interface UMOpenInterestRequest {
+    category: UMCategory;
+    symbol: string;
+    interval: '5min' | '15min' | '30min' | '1h' | '4h' | '1d';
+    startTime?: number;
+    endTime?: number;
+    limit?: number;
+}
+export interface UMOrderRequest {
+    category: UMCategory;
+    symbol: string;
+    side: OrderSide;
+    positionIdx?: '0';
+    orderType: UMOrderType;
+    qty: string;
+    price?: string;
+    basePrice?: string;
+    triggerPrice?: string;
+    triggerBy?: string;
+    iv?: string;
+    timeInForce: USDCTimeInForce;
+    orderLinkId?: string;
+    takeProfit?: number;
+    stopLoss?: number;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    reduceOnly?: boolean;
+    closeOnTrigger?: boolean;
+    mmp?: boolean;
+}
+export interface UMModifyOrderRequest {
+    category: UMCategory;
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+    iv?: string;
+    triggerPrice?: string;
+    qty?: string;
+    price?: string;
+    takeProfit?: number;
+    stopLoss?: number;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    triggerBy?: string;
+}
+export interface UMCancelOrderRequest {
+    category: UMCategory;
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderFilter?: USDCOrderFilter;
+}
+export interface UMActiveOrdersRequest {
+    category: UMCategory;
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderFilter?: USDCOrderFilter;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMHistoricOrdersRequest {
+    category: UMCategory;
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderStatus?: string;
+    orderFilter?: USDCOrderFilter;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMBatchOrder {
+    symbol: string;
+    side: OrderSide;
+    positionIdx?: '0';
+    orderType: UMOrderType;
+    qty: string;
+    price?: string;
+    iv?: string;
+    timeInForce: USDCTimeInForce;
+    orderLinkId?: string;
+    reduceOnly?: boolean;
+    closeOnTrigger?: boolean;
+    mmp?: boolean;
+}
+export interface UMBatchOrderReplace {
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+    iv?: string;
+    qty?: string;
+    price?: string;
+}
+export interface UMBatchOrderCancel {
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+}
+export interface UMCancelAllOrdersRequest {
+    category: UMCategory;
+    baseCoin?: string;
+    settleCoin?: string;
+    symbol?: string;
+    orderFilter?: USDCOrderFilter;
+}
+export interface UMPositionsRequest {
+    category: UMCategory;
+    symbol?: string;
+    baseCoin?: string;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMSetTPSLRequest {
+    category: UMCategory;
+    symbol: string;
+    takeProfit?: string;
+    stopLoss?: string;
+    trailingStop?: string;
+    tpTriggerBy?: string;
+    slTriggerBy?: string;
+    activePrice?: string;
+    slSize?: string;
+    tpSize?: string;
+    positionIdx?: '0';
+}
+export interface UM7DayTradingHistoryRequest {
+    category: UMCategory;
+    symbol: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    startTime?: number;
+    endTime?: number;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+    execType?: string;
+}
+export interface UMOptionsSettlementHistoryRequest {
+    category: UMCategory;
+    symbol?: string;
+    expDate?: string;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMPerpSettlementHistoryRequest {
+    category: UMCategory;
+    symbol?: string;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMTransactionLogRequest {
+    category: UMCategory;
+    currency: string;
+    baseCoin?: string;
+    type?: string;
+    startTime?: number;
+    endTime?: number;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}
+export interface UMExchangeCoinsRequest {
+    fromCoin?: string;
+    toCoin?: string;
+}
+export interface UMBorrowHistoryRequest {
+    currency: string;
+    startTime?: number;
+    endTime?: number;
+    direction?: UMDirection;
+    limit?: number;
+    cursor?: string;
+}

package/lib/types/request/unified-margin.js

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

package/lib/types/request/unified-margin.js.map

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

package/lib/types/request/usdc-options.d.ts

@@ -0,0 +1,119 @@
+import { OrderSide } from '../shared';
+import { USDCAPICategory, USDCOrderType, USDCTimeInForce } from './usdc-shared';
+export interface USDCOptionsContractInfoRequest {
+    symbol?: string;
+    status?: 'WAITING_ONLINE' | 'ONLINE' | 'DELIVERING' | 'OFFLINE';
+    baseCoin?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface USDCOptionsDeliveryPriceRequest {
+    symbol?: string;
+    baseCoin?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface USDCOptionsRecentTradesRequest {
+    category: USDCAPICategory;
+    symbol?: string;
+    baseCoin?: string;
+    optionType?: 'Call' | 'Put';
+    limit?: string;
+}
+export interface USDCOptionsHistoricalVolatilityRequest {
+    baseCoin?: string;
+    period?: string;
+    startTime?: string;
+    endTime?: string;
+}
+export interface USDCOptionsOrderRequest {
+    symbol: string;
+    orderType: USDCOrderType;
+    side: OrderSide;
+    orderPrice?: string;
+    orderQty: string;
+    iv?: string;
+    timeInForce?: USDCTimeInForce;
+    orderLinkId?: string;
+    reduceOnly?: boolean;
+}
+export interface USDCOptionsModifyOrderRequest {
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderPrice?: string;
+    orderQty?: string;
+    iv?: string;
+}
+export interface USDCOptionsCancelOrderRequest {
+    symbol: string;
+    orderId?: string;
+    orderLinkId?: string;
+}
+export interface USDCOptionsCancelAllOrdersRequest {
+    symbol?: string;
+    baseCoin?: string;
+}
+export interface USDCOptionsActiveOrdersRealtimeRequest {
+    orderId?: string;
+    orderLinkId?: string;
+    symbol?: string;
+    baseCoin?: string;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface USDCOptionsActiveOrdersRequest {
+    category: 'OPTION';
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface USDCOptionsHistoricOrdersRequest {
+    category: 'OPTION';
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderStatus?: string;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface USDCOptionsOrderExecutionRequest {
+    category: 'OPTION';
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    startTime?: string;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface USDCOptionsDeliveryHistoryRequest {
+    symbol: string;
+    expDate?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface USDCOptionsPositionsInfoExpiryRequest {
+    expDate?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface USDCOptionsModifyMMPRequest {
+    currency: string;
+    windowMs: number;
+    frozenPeriodMs: number;
+    qtyLimit: string;
+    deltaLimit: string;
+}

package/lib/types/request/usdc-options.js

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

package/lib/types/request/usdc-options.js.map

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

package/lib/types/request/usdc-perp.d.ts

@@ -0,0 +1,86 @@
+import { OrderSide } from '../shared';
+import { USDCAPICategory, USDCOrderFilter, USDCOrderType, USDCTimeInForce } from './usdc-shared';
+export interface USDCOpenInterestRequest {
+    symbol: string;
+    period: string;
+    limit?: number;
+}
+export interface USDCLast500TradesRequest {
+    category: USDCAPICategory;
+    symbol?: string;
+    baseCoin?: string;
+    limit?: string;
+}
+export interface USDCSymbolDirectionLimit {
+    symbol?: string;
+    direction?: string;
+    limit?: string;
+}
+export interface USDCSymbolDirectionLimitCursor {
+    symbol?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface USDCPerpOrderRequest {
+    symbol: string;
+    orderType: USDCOrderType;
+    orderFilter: USDCOrderFilter;
+    side: OrderSide;
+    orderPrice?: string;
+    orderQty: string;
+    timeInForce?: USDCTimeInForce;
+    orderLinkId?: string;
+    reduceOnly?: boolean;
+    closeOnTrigger?: boolean;
+    takeProfit?: string;
+    stopLoss?: string;
+    tptriggerby?: string;
+    slTriggerBy?: string;
+    basePrice?: string;
+    triggerPrice?: string;
+    triggerBy?: string;
+    mmp?: boolean;
+}
+export interface USDCPerpModifyOrderRequest {
+    symbol: string;
+    orderFilter: USDCOrderFilter;
+    orderId?: string;
+    orderLinkId?: string;
+    orderPrice?: string;
+    orderQty?: string;
+    takeProfit?: string;
+    stopLoss?: string;
+    tptriggerby?: string;
+    slTriggerBy?: string;
+    triggerPrice?: string;
+}
+export interface USDCPerpCancelOrderRequest {
+    symbol: string;
+    orderFilter: USDCOrderFilter;
+    orderId?: string;
+    orderLinkId?: string;
+}
+export interface USDCPerpActiveOrdersRequest {
+    category: 'PERPETUAL';
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderFilter?: USDCOrderFilter;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}
+export interface USDCPerpHistoricOrdersRequest {
+    category: 'PERPETUAL';
+    symbol?: string;
+    baseCoin?: string;
+    orderId?: string;
+    orderLinkId?: string;
+    orderStatus?: string;
+    orderFilter?: USDCOrderFilter;
+    direction?: string;
+    limit?: number;
+    cursor?: string;
+}

package/lib/types/request/usdc-perp.js

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

package/lib/types/request/usdc-perp.js.map

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

package/lib/types/request/usdc-shared.d.ts

@@ -0,0 +1,29 @@
+export declare type USDCAPICategory = 'PERPETUAL' | 'OPTION';
+export declare type USDCOrderType = 'Limit' | 'Market';
+export declare type USDCTimeInForce = 'GoodTillCancel' | 'ImmediateOrCancel' | 'FillOrKill' | 'PostOnly';
+export declare type USDCOrderFilter = 'Order' | 'StopOrder';
+export interface USDCKlineRequest {
+    symbol: string;
+    period: string;
+    startTime: number;
+    limit?: string;
+}
+export interface USDCTransactionLogRequest {
+    type: string;
+    baseCoin?: string;
+    startTime?: string;
+    endTime?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+    category?: USDCAPICategory;
+}
+export interface USDCPositionsRequest {
+    category: USDCAPICategory;
+    symbol?: string;
+    baseCoin?: string;
+    expDate?: string;
+    direction?: string;
+    limit?: string;
+    cursor?: string;
+}

package/lib/types/request/usdc-shared.js

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

package/lib/types/request/usdc-shared.js.map

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

package/lib/types/shared.d.ts

@@ -1,6 +1,14 @@
+import { InverseClient } from '../inverse-client';
+import { LinearClient } from '../linear-client';
+import { SpotClient } from '../spot-client';
+import { SpotClientV3 } from '../spot-client-v3';
+import { USDCOptionClient } from '../usdc-option-client';
+import { USDCPerpetualClient } from '../usdc-perpetual-client';
+export declare type RESTClient = InverseClient | LinearClient | SpotClient | SpotClientV3 | USDCOptionClient | USDCPerpetualClient;
 export declare type numberInString = string;
 export declare type OrderSide = 'Buy' | 'Sell';
 export declare type KlineInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1h' | '2h' | '4h' | '6h' | '12h' | '1d' | '1w' | '1M';
+export declare type KlineIntervalV3 = '1' | '3' | '5' | '15' | '30' | '60' | '120' | '240' | '360' | '720' | 'D' | 'W' | 'M';
 export interface APIResponse<T> {
     ret_code: number;
     ret_msg: 'OK' | string;
@@ -8,7 +16,12 @@ export interface APIResponse<T> {
     ext_info: string | null;
     result: T;
 }
-export interface APIResponseWithTime<T> extends APIResponse<T> {
+export interface APIResponseV3<T> {
+    retCode: number;
+    retMsg: 'OK' | string;
+    result: T;
+}
+export interface APIResponseWithTime<T = {}> extends APIResponse<T> {
     /** UTC timestamp */
     time_now: numberInString;
 }
@@ -18,14 +31,14 @@ export interface APIResponseWithTime<T> extends APIResponse<T> {
 export interface SymbolParam {
     symbol: string;
 }
-export interface SymbolLimitParam {
+export interface SymbolLimitParam<TLimit = number> {
     symbol: string;
-    limit?: number;
+    limit?: TLimit;
 }
-export interface SymbolPeriodLimitParam {
+export interface SymbolPeriodLimitParam<TLimit = number> {
     symbol: string;
     period: string;
-    limit?: number;
+    limit?: TLimit;
 }
 export interface SymbolFromLimitParam {
     symbol: string;

package/lib/types/websockets.d.ts

@@ -0,0 +1,41 @@
+import { RestClientOptions, WS_KEY_MAP } from '../util';
+/** For spot markets, spotV3 is recommended */
+export declare type APIMarket = 'inverse' | 'linear' | 'spot' | 'spotv3' | 'usdcOption' | 'usdcPerp';
+export declare type WsPublicInverseTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'klineV2';
+export declare type WsPublicUSDTPerpTopic = 'orderBookL2_25' | 'orderBookL2_200' | 'trade' | 'insurance' | 'instrument_info' | 'kline';
+export declare type WsPublicSpotV1Topic = 'trade' | 'realtimes' | 'kline' | 'depth' | 'mergedDepth' | 'diffDepth';
+export declare type WsPublicSpotV2Topic = 'depth' | 'kline' | 'trade' | 'bookTicker' | 'realtimes';
+export declare type WsPublicTopics = WsPublicInverseTopic | WsPublicUSDTPerpTopic | WsPublicSpotV1Topic | WsPublicSpotV2Topic | string;
+export declare type WsPrivateInverseTopic = 'position' | 'execution' | 'order' | 'stop_order';
+export declare type WsPrivateUSDTPerpTopic = 'position' | 'execution' | 'order' | 'stop_order' | 'wallet';
+export declare type WsPrivateSpotTopic = 'outboundAccountInfo' | 'executionReport' | 'ticketInfo';
+export declare type WsPrivateTopic = WsPrivateInverseTopic | WsPrivateUSDTPerpTopic | WsPrivateSpotTopic | string;
+export declare type WsTopic = WsPublicTopics | WsPrivateTopic;
+/** This is used to differentiate between each of the available websocket streams (as bybit has multiple websockets) */
+export declare type WsKey = typeof WS_KEY_MAP[keyof typeof WS_KEY_MAP];
+export interface WSClientConfigurableOptions {
+    key?: string;
+    secret?: string;
+    testnet?: boolean;
+    /**
+     * The API group this client should connect to.
+     *
+     * For the V3 APIs use `v3` as the market (spot/unified margin/usdc/account asset/copy trading)
+     */
+    market: APIMarket;
+    pongTimeout?: number;
+    pingInterval?: number;
+    reconnectTimeout?: number;
+    restOptions?: RestClientOptions;
+    requestOptions?: any;
+    wsUrl?: string;
+    /** If true, fetch server time before trying to authenticate (disabled by default) */
+    fetchTimeOffsetBeforeAuth?: boolean;
+}
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    testnet?: boolean;
+    market: APIMarket;
+    pongTimeout: number;
+    pingInterval: number;
+    reconnectTimeout: number;
+}

package/lib/types/websockets.js

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

package/lib/types/websockets.js.map

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