bybit-api 4.3.0 → 4.3.2

package/lib/types/response/v5-market.d.ts

@@ -35,6 +35,7 @@ export interface LinearInverseInstrumentInfoV5 {
     status: InstrumentStatusV5;
     baseCoin: string;
     quoteCoin: string;
+    symbolType: string;
     launchTime: string;
     deliveryTime?: string;
     deliveryFeeRate?: string;
@@ -90,6 +91,7 @@ export interface OptionInstrumentInfoV5 {
     baseCoin: string;
     quoteCoin: string;
     settleCoin: string;
+    symbolType: string;
     launchTime: string;
     deliveryTime: string;
     deliveryFeeRate: string;
@@ -109,6 +111,7 @@ export interface SpotInstrumentInfoV5 {
     symbol: string;
     baseCoin: string;
     quoteCoin: string;
+    symbolType: string;
     innovation: '0' | '1';
     status: InstrumentStatusV5;
     marginTrading: MarginTradingV5;
@@ -149,6 +152,19 @@ export interface OrderbookResponseV5 {
     seq: number;
     cts: number;
 }
+/**
+ * RPI Orderbook level: [price, nonRpiSize, rpiSize]
+ */
+export type RPIOrderbookLevelV5 = [string, string, string];
+export interface RPIOrderbookResponseV5 {
+    s: string;
+    b: RPIOrderbookLevelV5[];
+    a: RPIOrderbookLevelV5[];
+    ts: number;
+    u: number;
+    seq: number;
+    cts: number;
+}
 export interface TickerLinearInverseV5 {
     symbol: string;
     lastPrice: string;
@@ -238,6 +254,7 @@ export interface PublicTradeV5 {
     iP?: string;
     mIv?: string;
     iv?: string;
+    seq?: string;
 }
 /**
  *
@@ -304,4 +321,53 @@ export interface OrderPriceLimitV5 {
     sellLmt: string;
     ts: string;
 }
+export interface IndexPriceComponentV5 {
+    exchange: string;
+    spotPair: string;
+    equivalentPrice: string;
+    multiplier: string;
+    price: string;
+    weight: string;
+}
+export interface IndexPriceComponentsResponseV5 {
+    indexName: string;
+    lastPrice: string;
+    updateTime: string;
+    components: IndexPriceComponentV5[];
+}
+export interface ADLAlertItemV5 {
+    coin: string;
+    symbol: string;
+    balance: string;
+    maxBalance: string;
+    insurancePnlRatio: string;
+    pnlRatio: string;
+    adlTriggerThreshold: string;
+    adlStopRatio: string;
+}
+export interface ADLAlertResponseV5 {
+    updateTime: string;
+    list: ADLAlertItemV5[];
+}
+export interface FeeGroupLevelV5 {
+    level: string;
+    takerFeeRate: string;
+    makerFeeRate: string;
+    makerRebate: string;
+}
+export interface FeeGroupRatesV5 {
+    pro: FeeGroupLevelV5[];
+    marketMaker: FeeGroupLevelV5[];
+}
+export interface FeeGroupItemV5 {
+    groupName: string;
+    weightingFactor: number;
+    symbolsNumbers: number;
+    symbols: string[];
+    feeRates: FeeGroupRatesV5;
+    updateTime: string;
+}
+export interface FeeGroupStructureResponseV5 {
+    list: FeeGroupItemV5[];
+}
 export {};

package/lib/types/response/v5-position.d.ts

@@ -82,6 +82,7 @@ export interface ExecutionV5 {
     stopOrderType?: StopOrderTypeV5;
     execFee: string;
     execFeeV2: string;
+    feeCurrency: string;
     execId: string;
     execPrice: string;
     execQty: string;

package/lib/types/response/v5-spreadtrading.d.ts

@@ -46,6 +46,7 @@ export interface SpreadRecentTradeV5 {
     size: string;
     side: 'Buy' | 'Sell';
     time: string;
+    seq?: string;
 }
 export interface SpreadOpenOrderV5 {
     symbol: string;
@@ -90,6 +91,7 @@ export interface SpreadOrderHistoryV5 {
     leg2Symbol: string;
     leg2Side: string;
     cxlRejReason: string;
+    cumFeeDetail?: Record<string, string>;
 }
 export interface SpreadTradeLegV5 {
     symbol: string;
@@ -101,6 +103,7 @@ export interface SpreadTradeLegV5 {
     category: 'linear' | 'spot';
     execQty: string;
     execFee: string;
+    feeCurrency: string;
     execId: string;
 }
 export interface SpreadTradeV5 {

package/lib/types/response/v5-trade.d.ts

@@ -51,6 +51,7 @@ export interface AccountOrderV5 {
     createdTime: string;
     updatedTime: string;
     extraFees: string;
+    cumFeeDetail?: Record<string, string>;
 }
 export interface BatchCreateOrderResultV5 {
     category: CategoryV5;

package/lib/types/shared-v5.d.ts

@@ -98,7 +98,7 @@ export type TPSLModeV5 = 'Full' | 'Partial';
 export type AccountMarginModeV5 = 'ISOLATED_MARGIN' | 'REGULAR_MARGIN' | 'PORTFOLIO_MARGIN';
 export type UnifiedUpdateStatusV5 = 'FAIL' | 'PROCESS' | 'SUCCESS';
 export type AccountTypeV5 = 'CONTRACT' | 'SPOT' | 'INVESTMENT' | 'OPTION' | 'UNIFIED' | 'FUND';
-export type TransactionTypeV5 = 'TRANSFER_IN' | 'TRANSFER_OUT' | 'TRADE' | 'SETTLEMENT' | 'DELIVERY' | 'LIQUIDATION' | 'ADL' | 'AIRDROP' | 'BONUS_RECOLLECT' | 'BONUS_RECOLLECT' | 'FEE_REFUND' | 'INTEREST' | 'CURRENCY_BUY' | 'CURRENCY_SELL' | 'BORROWED_AMOUNT_INS_LOAN' | 'PRINCIPLE_REPAYMENT_INS_LOAN' | 'INTEREST_REPAYMENT_INS_LOAN' | 'AUTO_SOLD_COLLATERAL_INS_LOAN' | 'AUTO_BUY_LIABILITY_INS_LOAN' | 'AUTO_PRINCIPLE_REPAYMENT_INS_LOAN' | 'AUTO_INTEREST_REPAYMENT_INS_LOAN' | 'TRANSFER_IN_INS_LOAN' | 'TRANSFER_OUT_INS_LOAN' | 'SPOT_REPAYMENT_SELL' | 'SPOT_REPAYMENT_BUY' | 'TOKENS_SUBSCRIPTION' | 'TOKENS_REDEMPTION' | 'AUTO_DEDUCTION' | 'FLEXIBLE_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REDEMPTION' | 'FIXED_STAKING_SUBSCRIPTION' | 'BORROWED_AMOUNT_INS_LOAN' | 'PRINCIPLE_REPAYMENT_INS_LOAN' | 'INTEREST_REPAYMENT_INS_LOAN' | 'AUTO_SOLD_COLLATERAL_INS_LOAN' | 'AUTO_BUY_LIABILITY_INS_LOAN' | 'AUTO_PRINCIPLE_REPAYMENT_INS_LOAN' | 'AUTO_INTEREST_REPAYMENT_INS_LOAN' | 'TRANSFER_IN_INS_LOAN' | 'TRANSFER_OUT_INS_LOAN' | 'SPOT_REPAYMENT_SELL' | 'SPOT_REPAYMENT_BUY' | 'TOKENS_SUBSCRIPTION' | 'TOKENS_REDEMPTION' | 'AUTO_DEDUCTION' | 'FLEXIBLE_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REDEMPTION' | 'FIXED_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REFUND' | 'FIXED_STAKING_REFUND' | 'PREMARKET_TRANSFER_OUT' | 'PREMARKET_DELIVERY_SELL_NEW_COIN' | 'PREMARKET_DELIVERY_BUY_NEW_COIN' | 'PREMARKET_DELIVERY_PLEDGE_PAY_SELLER' | 'PREMARKET_DELIVERY_PLEDGE_BACK' | 'PREMARKET_ROLLBACK_PLEDGE_BACK' | 'PREMARKET_ROLLBACK_PLEDGE_PENALTY_TO_BUYER' | 'CUSTODY_NETWORK_FEE' | 'CUSTODY_SETTLE_FEE' | 'CUSTODY_LOCK' | 'CUSTODY_UNLOCK' | 'CUSTODY_UNLOCK_REFUND' | 'LOANS_BORROW_FUNDS' | 'LOANS_PLEDGE_ASSET' | 'BONUS_TRANSFER_IN' | 'BONUS_TRANSFER_OUT' | 'PEF_TRANSFER_IN' | 'PEF_TRANSFER_OUT' | 'PEF_PROFIT_SHARE' | 'ONCHAINEARN_SUBSCRIPTION' | 'ONCHAINEARN_REDEMPTION' | 'ONCHAINEARN_REFUND' | 'STRUCTURE_PRODUCT_SUBSCRIPTION' | 'STRUCTURE_PRODUCT_REFUND' | 'CLASSIC_WEALTH_MANAGEMENT_SUBSCRIPTION' | 'PREMIMUM_WEALTH_MANAGEMENT_SUBSCRIPTION' | 'PREMIMUM_WEALTH_MANAGEMENT_REFUND' | 'LIQUIDITY_MINING_SUBSCRIPTION' | 'LIQUIDITY_MINING_REFUND' | 'PWM_SUBSCRIPTION' | 'PWM_REFUND' | 'DEFI_INVESTMENT_SUBSCRIPTION' | 'DEFI_INVESTMENT_REFUND' | 'DEFI_INVESTMENT_REDEMPTION' | 'INSTITUTION_LOAN_IN' | 'INSTITUTION_PAYBACK_PRINCIPAL_OUT' | 'INSTITUTION_PAYBACK_INTEREST_OUT' | 'INSTITUTION_EXCHANGE_SELL' | 'INSTITUTION_EXCHANGE_BUY' | 'INSTITUTION_LIQ_PRINCIPAL_OUT' | 'INSTITUTION_LIQ_INTEREST_OUT' | 'INSTITUTION_LOAN_TRANSFER_IN' | 'INSTITUTION_LOAN_TRANSFER_OUT' | 'INSTITUTION_LOAN_WITHOUT_WITHDRAW' | 'INSTITUTION_LOAN_RESERVE_IN' | 'INSTITUTION_LOAN_RESERVE_OUT';
+export type TransactionTypeV5 = 'TRANSFER_IN' | 'TRANSFER_OUT' | 'TRADE' | 'SETTLEMENT' | 'DELIVERY' | 'LIQUIDATION' | 'ADL' | 'AIRDROP' | 'BONUS_RECOLLECT' | 'BONUS_RECOLLECT' | 'FEE_REFUND' | 'INTEREST' | 'CURRENCY_BUY' | 'CURRENCY_SELL' | 'BORROWED_AMOUNT_INS_LOAN' | 'PRINCIPLE_REPAYMENT_INS_LOAN' | 'INTEREST_REPAYMENT_INS_LOAN' | 'AUTO_SOLD_COLLATERAL_INS_LOAN' | 'AUTO_BUY_LIABILITY_INS_LOAN' | 'AUTO_PRINCIPLE_REPAYMENT_INS_LOAN' | 'AUTO_INTEREST_REPAYMENT_INS_LOAN' | 'TRANSFER_IN_INS_LOAN' | 'TRANSFER_OUT_INS_LOAN' | 'SPOT_REPAYMENT_SELL' | 'SPOT_REPAYMENT_BUY' | 'TOKENS_SUBSCRIPTION' | 'TOKENS_REDEMPTION' | 'AUTO_DEDUCTION' | 'FLEXIBLE_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REDEMPTION' | 'FIXED_STAKING_SUBSCRIPTION' | 'BORROWED_AMOUNT_INS_LOAN' | 'PRINCIPLE_REPAYMENT_INS_LOAN' | 'INTEREST_REPAYMENT_INS_LOAN' | 'AUTO_SOLD_COLLATERAL_INS_LOAN' | 'AUTO_BUY_LIABILITY_INS_LOAN' | 'AUTO_PRINCIPLE_REPAYMENT_INS_LOAN' | 'AUTO_INTEREST_REPAYMENT_INS_LOAN' | 'TRANSFER_IN_INS_LOAN' | 'TRANSFER_OUT_INS_LOAN' | 'SPOT_REPAYMENT_SELL' | 'SPOT_REPAYMENT_BUY' | 'TOKENS_SUBSCRIPTION' | 'TOKENS_REDEMPTION' | 'AUTO_DEDUCTION' | 'FLEXIBLE_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REDEMPTION' | 'FIXED_STAKING_SUBSCRIPTION' | 'FLEXIBLE_STAKING_REFUND' | 'FIXED_STAKING_REFUND' | 'PREMARKET_TRANSFER_OUT' | 'PREMARKET_DELIVERY_SELL_NEW_COIN' | 'PREMARKET_DELIVERY_BUY_NEW_COIN' | 'PREMARKET_DELIVERY_PLEDGE_PAY_SELLER' | 'PREMARKET_DELIVERY_PLEDGE_BACK' | 'PREMARKET_ROLLBACK_PLEDGE_BACK' | 'PREMARKET_ROLLBACK_PLEDGE_PENALTY_TO_BUYER' | 'CUSTODY_NETWORK_FEE' | 'CUSTODY_SETTLE_FEE' | 'CUSTODY_LOCK' | 'CUSTODY_UNLOCK' | 'CUSTODY_UNLOCK_REFUND' | 'LOANS_BORROW_FUNDS' | 'LOANS_PLEDGE_ASSET' | 'BONUS_TRANSFER_IN' | 'BONUS_TRANSFER_OUT' | 'PEF_TRANSFER_IN' | 'PEF_TRANSFER_OUT' | 'PEF_PROFIT_SHARE' | 'ONCHAINEARN_SUBSCRIPTION' | 'ONCHAINEARN_REDEMPTION' | 'ONCHAINEARN_REFUND' | 'STRUCTURE_PRODUCT_SUBSCRIPTION' | 'STRUCTURE_PRODUCT_REFUND' | 'CLASSIC_WEALTH_MANAGEMENT_SUBSCRIPTION' | 'PREMIMUM_WEALTH_MANAGEMENT_SUBSCRIPTION' | 'PREMIMUM_WEALTH_MANAGEMENT_REFUND' | 'LIQUIDITY_MINING_SUBSCRIPTION' | 'LIQUIDITY_MINING_REFUND' | 'PWM_SUBSCRIPTION' | 'PWM_REFUND' | 'DEFI_INVESTMENT_SUBSCRIPTION' | 'DEFI_INVESTMENT_REFUND' | 'DEFI_INVESTMENT_REDEMPTION' | 'INSTITUTION_LOAN_IN' | 'INSTITUTION_PAYBACK_PRINCIPAL_OUT' | 'INSTITUTION_PAYBACK_INTEREST_OUT' | 'INSTITUTION_EXCHANGE_SELL' | 'INSTITUTION_EXCHANGE_BUY' | 'INSTITUTION_LIQ_PRINCIPAL_OUT' | 'INSTITUTION_LIQ_INTEREST_OUT' | 'INSTITUTION_LOAN_TRANSFER_IN' | 'INSTITUTION_LOAN_TRANSFER_OUT' | 'INSTITUTION_LOAN_WITHOUT_WITHDRAW' | 'INSTITUTION_LOAN_RESERVE_IN' | 'INSTITUTION_LOAN_RESERVE_OUT' | 'PLATFORM_TOKEN_MNT_LIQRECALLEDMMNT' | 'PLATFORM_TOKEN_MNT_LIQRETURNEDMNT';
 export type PermissionTypeV5 = 'ContractTrade' | 'Spot' | 'Wallet' | 'Options' | 'Derivatives' | 'Exchange' | 'NFT';
 /**
  * Leveraged token status:

package/lib/types/websockets/ws-events.d.ts

@@ -246,6 +246,7 @@ export interface WSAccountOrderV5 {
     smpOrderId: string;
     createdTime: string;
     updatedTime: string;
+    cumFeeDetail?: Record<string, string>;
 }
 export type WSAccountOrderEventV5 = WSPrivateTopicEventV5<'order', WSAccountOrderV5[]>;
 export interface WSExecutionV5 {
@@ -262,6 +263,7 @@ export interface WSExecutionV5 {
     orderType: OrderTypeV5;
     stopOrderType: StopOrderTypeV5;
     execFee: string;
+    feeCurrency: string;
     execId: string;
     execPrice: string;
     execQty: string;
@@ -317,6 +319,7 @@ export interface WSCoinV5 {
     bonus: string;
     collateralSwitch: boolean;
     marginCollateral: boolean;
+    spotBorrow: string;
 }
 export interface WSWalletV5 {
     accountType: string;
@@ -371,6 +374,7 @@ export interface WSSpreadOrderV5 {
     feeCurrency: string;
     createType: OrderCreateTypeV5;
     closedPnl: string;
+    cumFeeDetail?: Record<string, string>;
 }
 export type WSSpreadOrderEventV5 = WSPrivateTopicEventV5<'spread.order', WSSpreadOrderV5[]>;
 export interface WSSpreadExecutionV5 {
@@ -416,6 +420,17 @@ export interface WSPriceLimitV5 {
     sellLmt: string;
 }
 export type WSPriceLimitEventV5 = WSPublicTopicEventV5<string, 'snapshot', WSPriceLimitV5>;
+export interface WSADLAlertV5 {
+    c: string;
+    s: string;
+    b: string;
+    mb: string;
+    i_pr: string;
+    pr: string;
+    adl_tt: string;
+    adl_sr: string;
+}
+export type WSADLAlertEventV5 = WSPublicTopicEventV5<'adlAlert.USDT' | 'adlAlert.USDC' | 'adlAlert.inverse', 'snapshot', WSADLAlertV5[]>;
 export type WSSystemStatusEventV5 = WSPublicTopicEventV5<'system.status', 'snapshot', SystemStatusItemV5[]>;
 /**
  * RFQ WebSocket Events