bybit-api 4.6.3 → 4.7.0

package/lib/types/response/v5-alpha-lp.d.ts

@@ -0,0 +1,121 @@
+/**
+ * V5 private Alpha LP responses.
+ */
+export interface AlphaLPPoolV5 {
+    poolAddress: string;
+    poolName: string;
+    poolTag: string;
+    apy: string;
+    tvl: string;
+    token0Symbol: string;
+    token0IconUrlDay: string;
+    token0IconUrlNight: string;
+    token1Symbol: string;
+    token1IconUrlDay: string;
+    token1IconUrlNight: string;
+    chainCode: string;
+    chainIconUrl: string;
+}
+export interface AlphaLPPoolListResultV5 {
+    pools: AlphaLPPoolV5[];
+}
+export interface AlphaLPPoolInfoV5 {
+    poolAddress: string;
+    poolName: string;
+    apy: string;
+    tvl: string;
+    feeRate: string;
+    token0Symbol: string;
+    token0Reserve: string;
+    token1Symbol: string;
+    token1Reserve: string;
+    priceRangeLower: string;
+    priceRangeUpper: string;
+    currentPrice: string;
+}
+export interface ExecuteAlphaLPStakeResultV5 {
+    positionId: number;
+    orderNo: string;
+}
+export interface ExecuteAlphaLPRedeemResultV5 {
+    orderNo: string;
+}
+export interface AlphaLPOrderV5 {
+    orderType: number;
+    orderNo: string;
+    orderStatus: number;
+    poolAddress: string;
+    poolName: string;
+    positionId: number;
+    tokenCode: string;
+    tokenSymbol: string;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    amount: string;
+    chainCode: string;
+    chainIconUrl: string;
+    gasTokenSymbol: string;
+    gasOnchain: string;
+    gasUsd: string | null;
+    platformFee: string;
+    platformFeeUsd: string | null;
+    createTime: number;
+    executionTime: number;
+    failureReason?: string;
+    dercRatio?: string;
+}
+export interface AlphaLPOrderListResultV5 {
+    total: number;
+    pageIndex: number;
+    orders: AlphaLPOrderV5[];
+}
+export interface AlphaLPPayTokenV5 {
+    tokenCode: string;
+    tokenSymbol: string;
+    chainCode: string;
+    chainIconUrl: string;
+    decimals: number;
+    availableBalance: string;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    minStakeAmount: string;
+    maxStakeAmount: string;
+}
+export interface AlphaLPPayTokenListResultV5 {
+    tokens: AlphaLPPayTokenV5[];
+}
+export interface AlphaLPPayTokenPriceV5 {
+    tokenCode: string;
+    tokenSymbol: string;
+    priceUsd: string;
+    chainCode: string;
+    updateTime: number;
+}
+export interface AlphaLPPayTokenPriceResultV5 {
+    prices: AlphaLPPayTokenPriceV5[];
+}
+export interface AlphaLPPositionV5 {
+    positionId: number;
+    poolAddress: string;
+    poolName: string;
+    stakedAmount: string;
+    stakedTokenCode: string;
+    stakedTokenSymbol: string;
+    currentValueUsd: string;
+    earnedRewardsUsd: string;
+    unrealizedPnl: string;
+    realizedPnl: string;
+    apy: string;
+    token0Amount: string;
+    token0Symbol: string;
+    token1Amount: string;
+    token1Symbol: string;
+    rangeUpper: string;
+    rangeLower: string;
+    createTime: number;
+    updateTime: number;
+    status: number;
+}
+export interface AlphaLPPositionListResultV5 {
+    positions: AlphaLPPositionV5[];
+}

package/lib/types/response/v5-alpha-lp.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * V5 private Alpha LP responses.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v5-alpha-lp.js.map

package/lib/types/response/v5-alpha-lp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v5-alpha-lp.js","sourceRoot":"","sources":["../../../src/types/response/v5-alpha-lp.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/lib/types/response/v5-alpha-prediction.d.ts

@@ -0,0 +1,225 @@
+/**
+ * V5 private Alpha prediction market responses.
+ */
+export interface AlphaPredictionEngineStatusV5 {
+    available: boolean;
+}
+export interface AlphaPredictionPayTokenV5 {
+    tokenCode: string;
+    symbol: string;
+    tokenDecimals: number;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    supportChains: string[];
+}
+export interface AlphaPredictionMarketV5 {
+    tokenId: string;
+    outcome: string;
+    price: string;
+    side: number;
+    volume: string;
+    liquidity: string;
+}
+export interface AlphaPredictionEventDetailV5 {
+    eventId: string;
+    slug: string;
+    title: string;
+    description: string;
+    category: string;
+    endDate: number;
+    resolved: boolean;
+    volume: string;
+    liquidity: string;
+    markets: AlphaPredictionMarketV5[];
+}
+export interface AlphaPredictionOrderEstimateFeeDetailV5 {
+    serverFee: string;
+    polymarketFee: string;
+}
+export interface AlphaPredictionOrderEstimateV5 {
+    avgPrice: string;
+    estimatedCost: string;
+    estimatedReceive: string;
+    toWin?: string;
+    feeAmount: string;
+    feeDetail: AlphaPredictionOrderEstimateFeeDetailV5;
+    slippage: string;
+}
+export interface ExecuteAlphaPredictionOrderResultV5 {
+    orderNo: string;
+}
+export interface AlphaPredictionOrderV5 {
+    orderNo: string;
+    tokenId: string;
+    eventId: string;
+    side: number;
+    orderType: number;
+    orderAmount: string;
+    filledSize: string;
+    filledPrice: string;
+    totalFee: string;
+    status: number;
+    createdAt: number;
+    updatedAt: number;
+}
+export interface AlphaPredictionOrderListResultV5 {
+    orders: AlphaPredictionOrderV5[];
+    total: number;
+    pageIndex: number;
+}
+export interface AlphaPredictionOrderBookLevelV5 {
+    price: string;
+    size: string;
+}
+export interface AlphaPredictionOrderBookV5 {
+    tokenId: string;
+    bids: AlphaPredictionOrderBookLevelV5[];
+    asks: AlphaPredictionOrderBookLevelV5[];
+}
+export interface AlphaPredictionTokenPriceV5 {
+    tokenId: string;
+    bestBid: string;
+    bestAsk: string;
+    lastPrice: string;
+    volume24h: string;
+    updateTime: number;
+}
+export interface AlphaPredictionPriceHistoryCandleV5 {
+    openTime: number;
+    open: string;
+    high: string;
+    low: string;
+    close: string;
+    volume: string;
+}
+export interface AlphaPredictionPriceHistoryV5 {
+    tokenId: string;
+    interval: string;
+    list: AlphaPredictionPriceHistoryCandleV5[];
+}
+export interface AlphaPredictionPositionV5 {
+    positionId: string;
+    tokenId: string;
+    eventId: string;
+    outcomeName: string;
+    shares: string;
+    cost: string;
+    avgPrice: string;
+    currentPrice: string;
+    value: string;
+    unrealizedPnl: string;
+    unrealizedPnlRate: string;
+    createdAt: number;
+    finished: boolean;
+}
+export interface AlphaPredictionPositionListResultV5 {
+    positions: AlphaPredictionPositionV5[];
+    total: number;
+    totalAssetUsd: string;
+}
+export interface AlphaPredictionPositionHistoryV5 {
+    positionId: string;
+    tokenId: string;
+    eventId: string;
+    outcomeName: string;
+    shares: string;
+    cost: string;
+    avgPrice: string;
+    exitPrice: string;
+    realizedPnl: string;
+    realizedPnlRate: string;
+    result: number;
+    closedAt: number;
+}
+export interface AlphaPredictionPositionHistoryResultV5 {
+    positions: AlphaPredictionPositionHistoryV5[];
+    total: number;
+}
+export interface AlphaPredictionPortfolioSummaryV5 {
+    positionValue: string;
+    positionValueUsd: string;
+    biggestWin: string;
+    winRate: string;
+    winCount: number;
+    lossCount: number;
+}
+export interface AlphaPredictionSideMarketTokenV5 {
+    tokenId: string;
+    outcome: string;
+    price: string;
+    liquidity: string;
+}
+export interface AlphaPredictionSideMarketV5 {
+    marketId: string;
+    eventId: string;
+    marketType: number;
+    question: string;
+    tokens: AlphaPredictionSideMarketTokenV5[];
+    volume24h: string;
+    endDate: number;
+    status: number;
+}
+export interface AlphaPredictionSideMarketListResultV5 {
+    list: AlphaPredictionSideMarketV5[];
+    total: number;
+    pageIndex: number;
+    pageSize: number;
+}
+export interface AlphaPredictionSportsMatchV5 {
+    matchId: string;
+    eventType: number;
+    stageCode: string;
+    homeTeam: string;
+    awayTeam: string;
+    matchTime: number;
+    status: number;
+    eventId: string;
+}
+export interface AlphaPredictionSportsMatchListResultV5 {
+    list: AlphaPredictionSportsMatchV5[];
+    total: number;
+    pageIndex: number;
+    pageSize: number;
+}
+export interface AlphaPredictionSportsTimelineStageV5 {
+    stageCode: string;
+    stageName: string;
+    status: number;
+    matchCount: number;
+    startTime: number;
+    endTime: number;
+}
+export interface AlphaPredictionSportsTimelineStagesV5 {
+    eventType: number;
+    stages: AlphaPredictionSportsTimelineStageV5[];
+}
+export interface AlphaPredictionSportsGroupStandingV5 {
+    rank: number;
+    teamName: string;
+    played: number;
+    won: number;
+    drawn: number;
+    lost: number;
+    goalsFor: number;
+    goalsAgainst: number;
+    goalDifference: number;
+    points: number;
+}
+export interface AlphaPredictionSportsGroupMatchV5 {
+    matchId: string;
+    homeTeam: string;
+    awayTeam: string;
+    matchTime: number;
+    status: number;
+    homeScore: number;
+    awayScore: number;
+    eventId: string;
+}
+export interface AlphaPredictionSportsGroupV5 {
+    groupName: string;
+    standings: AlphaPredictionSportsGroupStandingV5[];
+    matches: AlphaPredictionSportsGroupMatchV5[];
+}
+export interface AlphaPredictionSportsGroupStageDetailV5 {
+    groups: AlphaPredictionSportsGroupV5[];
+}

package/lib/types/response/v5-alpha-prediction.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * V5 private Alpha prediction market responses.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v5-alpha-prediction.js.map

package/lib/types/response/v5-alpha-prediction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v5-alpha-prediction.js","sourceRoot":"","sources":["../../../src/types/response/v5-alpha-prediction.ts"],"names":[],"mappings":";AAAA;;GAEG"}

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

@@ -109,6 +109,9 @@ export interface DepositRecordV5 {
     depositType: string;
     fromAddress: string;
 }
+export interface SubmitDepositOriginatorInfoResultV5 {
+    travelRuleStatus: number;
+}
 export interface InternalDepositRecordV5 {
     id: string;
     type: 1;

package/lib/types/response/v5-crypto-loan.d.ts

@@ -156,6 +156,7 @@ export interface CryptoLoanPositionV5 {
     totalCollateral: string;
     totalDebt: string;
     totalSupply: string;
+    colRes?: string;
 }
 export interface BorrowFlexibleV5 {
     orderId: string;
@@ -283,6 +284,56 @@ export interface RenewOrderInfoFixedV5 {
     renewLoanNo: string;
     time: string;
 }
+export interface InstitutionalLendingProductInfoV5 {
+    productId: string;
+    leverage: string;
+    supportSpot: number;
+    supportContract: number;
+    supportMarginTrading: number;
+    withdrawLine: string;
+    transferLine: string;
+    spotBuyLine: string;
+    spotSellLine: string;
+    contractOpenLine: string;
+    liquidationLine: string;
+    stopLiquidationLine: string;
+    contractLeverage: string;
+    transferRatio: string;
+    spotSymbols: unknown[];
+    contractSymbols: unknown[];
+    supportUSDCContract: number;
+    supportUSDCOptions: number;
+    USDTPerpetualOpenLine?: string;
+    USDCContractOpenLine?: string;
+    USDCOptionsOpenLine?: string;
+    USDTPerpetualCloseLine?: string;
+    USDCContractCloseLine?: string;
+    USDCOptionsCloseLine?: string;
+    USDTPerpetualLeverage?: {
+        symbol: string;
+        leverage: string;
+    }[];
+    USDCContractLeverage?: {
+        symbol: string;
+        leverage: string;
+    }[];
+    deferredLiquidationLine?: string;
+    deferredLiquidationTime?: string;
+    marginLeverage?: string;
+    /** `0`: Default, `1`: CTA, `2`: Hedge */
+    productType?: '0' | '1' | '2' | string;
+}
+export interface InstitutionalLendingCoinDeltaItemV5 {
+    coin: string;
+    coinDeltaSize: string;
+    coinDeltaAvailableAmount: string;
+    coinDeltaAmount: string;
+}
+export interface InstitutionalLendingCoinDeltaAmountV5 {
+    riskUnitDeltaAmount: string;
+    riskUnitDeltaAvailableAmount: string;
+    list: InstitutionalLendingCoinDeltaItemV5[];
+}
 export interface UnpaidInfoV5 {
     token: string;
     unpaidQty: string;

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

@@ -1,3 +1,37 @@
+export interface EarnInterestCardV5 {
+    awardId: number;
+    specCode: string;
+    coin: string;
+    apy: string;
+    duration: number;
+    claimedAt: number;
+    expireAt: number;
+    usedAt: number;
+    status: 'InUse' | 'NotUse' | 'Expired' | 'AlreadyUsed' | string;
+    currentPnl: string;
+    limitPnl: string;
+    positionEffectiveAmount: string;
+    productId: number;
+    category: 'FlexibleSaving' | 'DualAssets' | string;
+}
+export interface EarnAwardCardV5 {
+    awardId: number;
+    specCode: string;
+    claimedAt: number;
+    usedAt: number;
+    expireAt: number;
+    status: 'InUse' | 'NotUse' | 'Expired' | 'AlreadyUsed' | string;
+    amount: string;
+    limitPnlPercentage: string;
+    baseCoin: string;
+    quoteCoin: string;
+    direction: 1 | 2;
+    category: 'FlexibleSaving' | 'DualAssets' | string;
+}
+export interface EarnCouponListResultV5 {
+    interestCards: EarnInterestCardV5[];
+    awardCards: EarnAwardCardV5[];
+}
 export interface EarnProductV5 {
     category: string;
     estimateApr: string;

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

@@ -208,6 +208,8 @@ export interface TickerLinearInverseV5 {
     prevPrice1h: string;
     openInterest: string;
     openInterestValue: string;
+    singleOpenInterest?: string;
+    singleOpenInterestValue?: string;
     turnover24h: string;
     volume24h: string;
     fundingRate: string;
@@ -297,6 +299,7 @@ export interface PublicTradeV5 {
  */
 export type OpenInterestV5 = {
     openInterest: string;
+    singleOpenInterest?: string;
     timestamp: string;
 };
 export interface OpenInterestResponseV5 {

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

@@ -1,4 +1,14 @@
 import { CategoryV5, ExecTypeV5, OrderSideV5, OrderTypeV5, PositionIdx, PositionSideV5, PositionStatusV5, StopOrderTypeV5, TPSLModeV5, TradeModeV5 } from '../shared-v5';
+export interface FuturesLeverageItemV5 {
+    symbol: string;
+    leverage: string;
+    side: OrderSideV5 | '';
+    positionIdx: PositionIdx;
+}
+export interface FuturesLeverageResultV5 {
+    category: 'linear' | 'inverse';
+    list: FuturesLeverageItemV5[];
+}
 export interface PositionV5 {
     positionIdx: PositionIdx;
     riskId: number;

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

@@ -0,0 +1,73 @@
+/**
+ * V5 RWA (Real World Assets) earn responses.
+ */
+export interface RWAProductV5 {
+    productId: number;
+    coin: string;
+    assetSymbol: string;
+    manager: string;
+    baseApr: string;
+    bonusApr: string;
+    savingType: 'Flexible' | 'Fixed' | string;
+    duration: number;
+    nav: string;
+    minStakeAmount: string;
+    maxStakeAmount: string;
+    userMaxAmount: string;
+    userQuota: string;
+    minRedeemShare: string;
+    redeemFeeRate: string;
+    subscriptionFee: string;
+    extLink: string;
+    amountPrecision: number;
+    sharePrecision: number;
+}
+export interface RWAProductListResultV5 {
+    list: RWAProductV5[];
+}
+export interface PlaceRWAOrderResultV5 {
+    orderId: string;
+    orderLinkId: string;
+}
+export interface RWAPositionV5 {
+    productId: number;
+    coin: string;
+    assetSymbol: string;
+    effectiveShare: string;
+    processingStakeAmount: string;
+    processingRedeemShare: string;
+    bonusEarned: string;
+    nav: string;
+    holdAmount: string;
+    duration: number;
+}
+export interface RWAPositionListResultV5 {
+    list: RWAPositionV5[];
+}
+export interface RWAOrderV5 {
+    orderId: string;
+    orderLinkId: string;
+    orderType: 'Stake' | 'Redeem';
+    productId: number;
+    coin: string;
+    stakeAmount?: string;
+    redeemShares?: string;
+    status: 'Processing' | 'Success' | 'Failed' | string;
+    accountType: 'FUND' | 'UNIFIED' | string;
+    createdTime: number;
+    updatedTime: number;
+    settledShares?: string;
+    settledAmount?: string;
+}
+export interface RWAOrderListResultV5 {
+    list: RWAOrderV5[];
+    nextPageCursor: string;
+}
+export interface RWANavChartPointV5 {
+    date: string;
+    nav: string;
+}
+export interface RWANavChartResultV5 {
+    productId: number;
+    list: RWANavChartPointV5[];
+}

package/lib/types/response/v5-rwa.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * V5 RWA (Real World Assets) earn responses.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v5-rwa.js.map

package/lib/types/response/v5-rwa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v5-rwa.js","sourceRoot":"","sources":["../../../src/types/response/v5-rwa.ts"],"names":[],"mappings":";AAAA;;GAEG"}

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

@@ -54,6 +54,11 @@ export interface AccountOrderV5 {
     updatedTime: string;
     extraFees: string;
     cumFeeDetail?: Record<string, string>;
+    rpiTakerAccess?: boolean;
+    rpiMatchedQty?: string;
+    fromAccount?: string;
+    toAccount?: string;
+    externalEventType?: string;
 }
 export interface BatchCreateOrderResultV5 {
     category: CategoryV5;

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

@@ -78,6 +78,8 @@ export interface WSTickerV5 {
     indexPrice: string;
     openInterest: string;
     openInterestValue: string;
+    singleOpenInterest?: string;
+    singleOpenInterestValue?: string;
     turnover24h: string;
     volume24h: string;
     nextFundingTime: string;
@@ -254,6 +256,8 @@ export interface WSAccountOrderV5 {
     createdTime: string;
     updatedTime: string;
     cumFeeDetail?: Record<string, string>;
+    rpiTakerAccess?: boolean;
+    rpiMatchedQty?: string;
 }
 export type WSAccountOrderEventV5 = WSPrivateTopicEventV5<'order', WSAccountOrderV5[]>;
 export interface WSExecutionV5 {
@@ -304,6 +308,7 @@ export interface WSExecutionFastV5 {
     side: OrderSideV5;
     execTime: string;
     seq: number;
+    liquidity?: string;
 }
 export type WSExecutionFastEventV5 = WSPrivateTopicEventV5<'execution.fast', WSExecutionFastV5[]>;
 export interface WSCoinV5 {
@@ -327,6 +332,7 @@ export interface WSCoinV5 {
     collateralSwitch: boolean;
     marginCollateral: boolean;
     spotBorrow: string;
+    colRes?: string;
 }
 export interface WSWalletV5 {
     accountType: string;