bybit-api 4.6.2 → 4.6.4

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

@@ -0,0 +1,425 @@
+export interface PwmCoinAmountV5 {
+    coin: string;
+    amount: string;
+}
+export interface PwmMultiCoinsEarningPositionItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    currentAmount: string;
+    accumulateYield: string;
+    apr: string;
+    positionId: string;
+    status?: string;
+}
+export interface PwmMultiCoinsEarningPositionsV5 {
+    totalInvestmentUsd: string;
+    accumulateYieldUsd: string;
+    weightedAvgApr: string;
+    items: PwmMultiCoinsEarningPositionItemV5[];
+}
+export interface PwmFixedYieldPositionItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    currentAmount: string;
+    accumulateYield: string;
+    apr: string;
+    duration: number;
+    maturityTime: string;
+    autoReinvest: boolean;
+    positionId: string;
+    status?: string;
+}
+export interface PwmFixedYieldPositionsV5 {
+    totalInvestmentUsd: string;
+    accumulateYieldUsd: string;
+    weightedAvgApr: string;
+    items: PwmFixedYieldPositionItemV5[];
+}
+export interface PwmEquityFundPositionItemV5 {
+    category: string;
+    productId: string;
+    fundName: string;
+    coin: string;
+    tags: string[];
+    nav: string;
+    userShares: string;
+    shareValue: string;
+    holdingValue: string;
+    accumulateYield: string;
+    apr30d: string;
+    aprTotal: string;
+    sharpRatio: string;
+    maxDrawdown: string;
+    createdTime: string;
+    runningDays: number;
+    positionId?: string;
+    status?: string;
+}
+export interface PwmEquityFundsPositionsV5 {
+    totalInvestmentUsd: string;
+    accumulateYieldUsd: string;
+    weightedAvgApr: string;
+    items: PwmEquityFundPositionItemV5[];
+}
+export interface PwmOnchainEarnPositionItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    stakeAmount: string;
+    apr: string;
+    positionId: string;
+    status?: string;
+}
+export interface PwmOnchainEarnPositionsV5 {
+    totalInvestmentUsd: string;
+    accumulateYieldUsd: string;
+    items: PwmOnchainEarnPositionItemV5[];
+}
+export interface PwmInvestmentPlanPositionsV5 {
+    multiCoinsEarning?: PwmMultiCoinsEarningPositionsV5;
+    fixedYield?: PwmFixedYieldPositionsV5;
+    equityFunds?: PwmEquityFundsPositionsV5;
+    onchainEarn?: PwmOnchainEarnPositionsV5;
+    fundingAccount?: PwmCoinAmountV5[];
+}
+/** GET /v5/earn/pwm/investment-plan/list */
+export interface PwmInvestmentPlanSummaryV5 {
+    planId: string;
+    planName: string;
+    planType: string;
+    status: string;
+    currentAssetUsd?: string;
+    accumulateYieldUsd?: string;
+    weightedAvgApr?: string;
+    createdTime?: string;
+}
+export interface PwmInvestmentPlanListResultV5 {
+    list: PwmInvestmentPlanSummaryV5[];
+}
+/** GET /v5/earn/pwm/investment-plan/detail */
+export interface PwmInvestmentPlanDetailV5 {
+    planId: string;
+    planName: string;
+    planType: string;
+    status: string;
+    currentAssetUsd: string;
+    accumulateYieldUsd: string;
+    weightedAvgApr: string;
+    currentAssets: PwmCoinAmountV5[];
+    positions: PwmInvestmentPlanPositionsV5;
+    createdTime: string;
+}
+export interface PwmEquityFundIntroductionV5 {
+    description: string;
+    historicalYieldRateMax: string;
+    historicalYieldRateMin: string;
+    sharpRatio: string;
+    maxDrawback: string;
+    lockupPeriod: string;
+}
+export interface PwmPendingMultiCoinsEarningItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    configuredAmount: string;
+    apr: string;
+}
+export interface PwmPendingFixedYieldItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    configuredAmount: string;
+    apr: string;
+    duration: number;
+}
+export interface PwmPendingEquityFundItemV5 {
+    category: string;
+    productId: string;
+    fundName: string;
+    coin: string;
+    configuredAmount: string;
+    tags: string[];
+    introduction: PwmEquityFundIntroductionV5;
+}
+export interface PwmPendingOnchainEarnItemV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    configuredAmount: string;
+    apr: string;
+}
+export interface PwmPendingInvestmentPlanProductsV5 {
+    multiCoinsEarning?: {
+        configuredAmountUsd: string;
+        items: PwmPendingMultiCoinsEarningItemV5[];
+    };
+    fixedYield?: {
+        configuredAmountUsd: string;
+        items: PwmPendingFixedYieldItemV5[];
+    };
+    equityFunds?: {
+        configuredAmountUsd: string;
+        items: PwmPendingEquityFundItemV5[];
+    };
+    onchainEarn?: {
+        configuredAmountUsd: string;
+        items: PwmPendingOnchainEarnItemV5[];
+    };
+}
+/** GET /v5/earn/pwm/investment-plan/new-plan */
+export interface PwmPendingInvestmentPlanDetailV5 {
+    planId: string;
+    planName: string;
+    planType: string;
+    status: string;
+    source: string;
+    totalConfiguredAmountUsd: string;
+    products: PwmPendingInvestmentPlanProductsV5;
+    createdTime: string;
+}
+/** POST /v5/earn/pwm/investment-plan/claim */
+export interface ClaimPwmWithdrawableFundsResultV5 {
+    planId: string;
+    toAccountType: number;
+    status: string;
+    createdTime: string;
+}
+export interface PwmAssetTrendDataPointV5 {
+    date: string;
+    assetValueUsd: string;
+}
+/** GET /v5/earn/pwm/investment-plan/asset-trend */
+export interface PwmInvestmentPlanAssetTrendResultV5 {
+    planId: string;
+    dataPoints: PwmAssetTrendDataPointV5[];
+}
+export interface PwmFundNavDataPointV5 {
+    date: string;
+    nav: string;
+}
+/** GET /v5/earn/pwm/investment-plan/fund-nav */
+export interface PwmFundHistoricalNavResultV5 {
+    fundId: string;
+    fundName: string;
+    coin: string;
+    currentNav: string;
+    dataPoints: PwmFundNavDataPointV5[];
+}
+/** POST /v5/earn/pwm/investment-plan/subscribe */
+export interface SubscribePwmInvestmentPlanResultV5 {
+    planId: string;
+    status: string;
+    orderLinkId: string;
+}
+/** POST /v5/earn/pwm/investment-plan/invest-more */
+export interface InvestMorePwmInvestmentPlanResultV5 {
+    planId: string;
+    category: string;
+    productId: string;
+    coin: string;
+    amount: string;
+    status: string;
+    orderLinkId: string;
+    orderId: string;
+}
+/** POST /v5/earn/pwm/investment-plan/redeem */
+export interface RedeemPwmInvestmentPlanResultV5 {
+    orderId: string;
+    planId: string;
+    category: string;
+    productId: string;
+    shares?: string;
+    amount?: string;
+    estimatedAmount?: string;
+    coin: string;
+    status: string;
+    orderLinkId: string;
+}
+/** GET /v5/earn/pwm/investment-plan/order */
+export interface PwmInvestmentPlanOrderV5 {
+    orderId: string;
+    planId: string;
+    type: string;
+    accountType: string;
+    coin: string;
+    amount: string;
+    category: string;
+    productId: string;
+    status: string;
+    orderTime: string;
+}
+export interface PwmInvestmentPlanOrdersResultV5 {
+    list: PwmInvestmentPlanOrderV5[];
+    nextPageCursor: string;
+}
+/** GET /v5/earn/pwm/customize-plan/product */
+export interface PwmSubscribableProductCardV5 {
+    category: string;
+    productId?: string;
+    fundName?: string;
+    coin: string;
+    apr?: string;
+    aprRangeLow?: string;
+    aprRangeHigh?: string;
+    tags?: string[];
+    introduction?: string;
+    aum?: string;
+    minInvestmentAmount?: string;
+    maxInvestmentAmount?: string;
+    duration?: number;
+    maxDrawdown?: string;
+    sharpRatio?: string;
+    estAPR?: string;
+}
+export interface PwmSubscribableProductGroupV5 {
+    type: string;
+    cards: PwmSubscribableProductCardV5[];
+}
+export interface PwmSubscribableProductInfoResultV5 {
+    products: PwmSubscribableProductGroupV5[];
+}
+/** POST /v5/earn/pwm/customize-plan/create */
+export interface CreatePwmCustomizeInvestmentPlanResultV5 {
+    planId: string;
+    planName: string;
+    status: string;
+    orderLinkId?: string;
+}
+/** GET /v5/earn/pwm/asset-manager/all-funds */
+export interface PwmAssetManagerFundV5 {
+    fundId: string;
+    fundName: string;
+    coin: string;
+    status: string;
+    totalEquity: string;
+    totalShares: string;
+    currentNav: string;
+    currentAPR?: string;
+    accountUid: string;
+    subAccountList: string[];
+    profitShareRate: string;
+    managementFeeRate: string;
+    uncollectedProfit: string;
+    collectedProfit: string;
+    totalLoan: string;
+    createdTime: string;
+}
+export interface PwmAllFundsResultV5 {
+    list: PwmAssetManagerFundV5[];
+    nextPageCursor: string;
+}
+/** POST /v5/earn/pwm/asset-manager/settle-profit */
+export interface SettlePwmFundProfitResultV5 {
+    fundId: string;
+    status: string;
+    totalProfitShared: string;
+    instIncome: string;
+    coin: string;
+    createdTime: string;
+}
+/** POST /v5/earn/pwm/asset-manager/create-fund */
+export interface CreatePwmFundResultV5 {
+    fundId: string;
+    fundName: string;
+    coin: string;
+    status: string;
+    profitShareRate: string;
+    managementFeeRate: string;
+    accountUid: string;
+    createdTime: string;
+}
+/** POST /v5/earn/pwm/asset-manager/create-investment-plan */
+export interface CreatePwmAssetManagerInvestmentPlanResultV5 {
+    planId: string;
+    planType: string;
+    accountUid: string;
+    status: string;
+    createdTime: string;
+}
+/** GET /v5/earn/pwm/asset-manager/get-investment-plan */
+export interface PwmAssetManagerInvestmentPlanDistributionV5 {
+    category: string;
+    coin: string;
+    productId: string;
+    currentAmount: string;
+}
+export interface PwmAssetManagerInvestmentPlanV5 {
+    planId: string;
+    planName: string;
+    planType: string;
+    subscriptionUid: string;
+    status: string;
+    source: string;
+    currentAssetUsd: string;
+    accumulateYieldUsd: string;
+    investmentDistribution: PwmAssetManagerInvestmentPlanDistributionV5[];
+    createdTime: string;
+}
+export interface PwmAssetManagerInvestmentPlansResultV5 {
+    list: PwmAssetManagerInvestmentPlanV5[];
+    nextPageCursor: string;
+}
+/** POST /v5/earn/pwm/asset-manager/manage-investment-plan */
+export interface ManagePwmAssetManagerInvestmentPlanFundResultV5 {
+    fundId: string;
+    amount: string;
+}
+export interface ManagePwmAssetManagerInvestmentPlanResultV5 {
+    planId: string;
+    status: string;
+    updatedTime: string;
+    updateFunds: ManagePwmAssetManagerInvestmentPlanFundResultV5[];
+}
+/** GET /v5/earn/pwm/asset-manager/all-order */
+export interface PwmAssetManagerFundOrderV5 {
+    orderId: string;
+    fundId: string;
+    fundName: string;
+    accountUid: string;
+    orderType: string;
+    coin: string;
+    amount: string;
+    shares: string;
+    status: string;
+    createdTime: string;
+}
+export interface PwmAllFundOrdersResultV5 {
+    list: PwmAssetManagerFundOrderV5[];
+    nextPageCursor: string;
+}
+/** POST /v5/earn/pwm/asset-manager/manage-order */
+export interface ManagePwmFundOrderResultV5 {
+    orderId: string;
+    fundId: string;
+    accountUid: string;
+    orderStatus: string;
+    orderType: string;
+    action: string;
+    coin: string;
+    amount: string;
+    shares: string;
+    updatedTime: string;
+}
+/** POST /v5/earn/pwm/asset-manager/create-sub-account */
+export interface CreatePwmFundSubAccountResultV5 {
+    fundId: string;
+    subAccountUid: string;
+    createdTime: string;
+    status: string;
+}
+/** POST /v5/earn/pwm/fund-transfer */
+export interface PwmFundTransferResultV5 {
+    transferId: string;
+    status: string;
+}
+/** GET /v5/earn/pwm/query-fund-transfer-result */
+export interface PwmFundTransferRecordV5 {
+    transferId: string;
+    status: string;
+    fromUserId: number;
+    toUserId: number;
+    amount: string;
+    coin: string;
+}

package/lib/types/response/v5-earn-pwm.js

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

package/lib/types/response/v5-earn-pwm.js.map

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

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

@@ -22,6 +22,10 @@ export interface EarnOrderHistoryV5 {
     estimateRedeemTime: string;
     estimateStakeTime: string;
 }
+export interface EarnPositionFreezeDetailV5 {
+    amount: string;
+    description: string;
+}
 export interface EarnPositionV5 {
     coin: string;
     productId: string;
@@ -36,6 +40,9 @@ export interface EarnPositionV5 {
     estimateInterestCalculationTime?: string;
     settlementTime?: string;
     autoReinvest?: string;
+    /** Redeemable amount */
+    availableAmount: string;
+    freezeDetails: EarnPositionFreezeDetailV5[];
 }
 export interface EarnYieldHistoryV5 {
     productId: string;
@@ -154,3 +161,34 @@ export interface AdvanceEarnAdvanceProductInfoV5 {
     category: string;
     list: AdvanceEarnAdvanceProductListItemV5[];
 }
+/** GET /v5/earn/hold-to-earn/product — Hold to Earn airdrop products */
+export type HoldToEarnAirdropProductStatusV5 = 'NotStarted' | 'Online' | 'Ended';
+export interface HoldToEarnAirdropProductYieldV5 {
+    coinName: string;
+    /** Yesterday's APR for display, e.g. "10%", "0%" */
+    apy: string;
+}
+export interface HoldToEarnAirdropProductV5 {
+    coinName: string;
+    yields: HoldToEarnAirdropProductYieldV5[];
+    status: HoldToEarnAirdropProductStatusV5;
+    announcementUrl: string;
+    /** Yesterday's avg APR across yield coins */
+    apy: string;
+}
+export interface HoldToEarnAirdropProductsResultV5 {
+    products: HoldToEarnAirdropProductV5[];
+}
+/** GET /v5/earn/hold-to-earn/yield-history */
+export interface HoldToEarnAirdropDailyPnlV5 {
+    coinName: string;
+    yieldCoinName: string;
+    effectiveAmount: string;
+    pnl: string;
+    apy: string;
+    createdAt: number;
+}
+export interface HoldToEarnAirdropYieldHistoryResultV5 {
+    nextCursor: string;
+    airdropDailyPnls: HoldToEarnAirdropDailyPnlV5[];
+}

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

@@ -1,4 +1,4 @@
-import { CategoryCursorListV5, CategoryV5, ContractTypeV5, CopyTradingV5, InstrumentStatusV5, MarginTradingV5, OptionTypeV5, OrderSideV5 } from '../shared-v5';
+import { CategoryCursorListV5, CategoryV5, ContractTypeV5, CopyTradingV5, InstrumentStatusV5, InstrumentSymbolTypeV5, MarginTradingV5, OptionTypeV5, OrderSideV5 } from '../shared-v5';
 /**
  * OHLCVT candle used by v5 APIs
  *
@@ -30,15 +30,15 @@ export type OHLCVKlineV5 = [
  */
 export type OHLCKlineV5 = [string, string, string, string, string];
 export interface LinearInverseInstrumentInfoV5 {
+    /** The ID of the symbol name. */
+    symbolId: number;
     symbol: string;
     contractType: ContractTypeV5;
     status: InstrumentStatusV5;
     baseCoin: string;
     quoteCoin: string;
-    /**
-     * Region / product class for the pair. For `category=linear`, includes e.g. `stock`, `forex`, `commodity`, `xstocks` (per Bybit; new values may be added).
-     */
-    symbolType: string;
+    /** Region / product class for the pair (`stock`, `forex`, `commodity`, `xstocks`, etc.). */
+    symbolType: InstrumentSymbolTypeV5;
     launchTime: string;
     deliveryTime?: string;
     deliveryFeeRate?: string;
@@ -89,16 +89,15 @@ export interface LinearInverseInstrumentInfoV5 {
     displayName: string;
 }
 export interface OptionInstrumentInfoV5 {
+    /** The ID of the symbol name. */
+    symbolId: number;
     symbol: string;
     optionsType: OptionTypeV5;
     status: InstrumentStatusV5;
     baseCoin: string;
     quoteCoin: string;
     settleCoin: string;
-    /**
-     * Region / product class for the pair (see Bybit instruments docs; new values may be added).
-     */
-    symbolType: string;
+    symbolType: InstrumentSymbolTypeV5;
     launchTime: string;
     deliveryTime: string;
     deliveryFeeRate: string;
@@ -115,6 +114,8 @@ export interface OptionInstrumentInfoV5 {
     displayName: string;
 }
 export interface SpotInstrumentInfoV5 {
+    /** The ID of the symbol name. */
+    symbolId: number;
     symbol: string;
     baseCoin: string;
     quoteCoin: string;
@@ -123,10 +124,7 @@ export interface SpotInstrumentInfoV5 {
      * `stock_qty = token_qty * multiplier`. Default `"1"`.
      */
     xstockMultiplier?: string;
-    /**
-     * Region / product class (see Bybit instruments docs; linear category also uses values such as `stock`, `forex`).
-     */
-    symbolType: string;
+    symbolType: InstrumentSymbolTypeV5;
     innovation: '0' | '1';
     status: InstrumentStatusV5;
     marginTrading: MarginTradingV5;

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

@@ -37,10 +37,8 @@ export interface PositionV5 {
     leverageSysUpdatedTime: string | '';
     createdTime: string;
     updatedTime: string;
-    /**
-     * Position open timestamp (ms), default 0. Documented as testnet-only in some API versions.
-     */
-    openTime?: number;
+    /** Position open timestamp (ms). Default `0` when not set. */
+    openTime: number;
     positionIMByMp: string;
     positionMMByMp: string;
     seq: number;

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

@@ -0,0 +1,96 @@
+import { OrderSideV5, PositionIdx, PovModeV5, StrategyCategoryV5, StrategyPreferV5, StrategyTypeV5 } from '../shared-v5';
+export interface CreateStrategyOrderResultV5 {
+    strategyId: string;
+    /** null when creation succeeded */
+    result: string | null;
+}
+export interface StopStrategyResultV5 {
+    strategyId: string;
+}
+export interface StrategyListItemV5 {
+    strategyId: string;
+    category: StrategyCategoryV5;
+    symbol: string;
+    side: OrderSideV5;
+    size: string;
+    strategyType: StrategyTypeV5;
+    /** 2: running, 3: terminated, 4: terminated unfilled, 5: paused, 6: untriggered */
+    status: 2 | 3 | 4 | 5 | 6;
+    executedSize: string;
+    executedAvgPrice: string;
+    executedStartTimeE3: string;
+    executedEndTimeE3: string;
+    createdTimeE3: string;
+    updatedTimeE3: string;
+    reduceOnly: boolean;
+    triggerPrice: string;
+    isTriggered: boolean;
+    leverageType: 0 | 1;
+    terminateType: number;
+    terminateRemark: string;
+    triggerCount: string;
+    tradingCount: string;
+    realizedPnl: string;
+    strategyName: string;
+    strategyPrefer: StrategyPreferV5 | string;
+    duration: number;
+    executedDuration: number;
+    isRandom: boolean;
+    interval: number;
+    limitPrice: string;
+    chasePercentE4: string;
+    chaseDistance: string;
+    maxChasePrice: string;
+    chaseOrderPrice: string;
+    chasePrice: string;
+    postOnly: number;
+    isRebalance: boolean;
+    orderType: string;
+    orderPriceOffset: string;
+    strategySl: string;
+    strategyTp: string;
+    arbitrageOrders: unknown[];
+    positionValue: string;
+    filledPositionValue: string;
+    /** POV only */
+    mode?: PovModeV5 | string;
+    participationRate?: string;
+    referenceWindow?: string;
+    depthReference?: string;
+}
+export interface StrategyListResultV5 {
+    list: StrategyListItemV5[];
+    nextCursor: string;
+    prevCursor: string;
+}
+export interface StrategyOrderListItemV5 {
+    strategyId: string;
+    orderId: string;
+    symbol: string;
+    side: OrderSideV5;
+    size: string;
+    price: string;
+    /** 2: created, 3: create failed, 4: partially filled, 5: fully filled, 6: rejected, 7: canceled */
+    status: string;
+    executedSize: string;
+    dealTimeE3: string;
+    parentOrderId: string;
+    createdTimeE3: string;
+    updatedTimeE3: string;
+    code: number;
+    msg: string;
+    category: StrategyCategoryV5;
+    positionIdx: PositionIdx;
+    leverageType: 0 | 1;
+    tpPrice: string;
+    slPrice: string;
+    orderType: string;
+    orderPriceOffset: string;
+    positionValue: string;
+    filledPositionValue: string;
+}
+export interface StrategyOrderListResultV5 {
+    list: StrategyOrderListItemV5[];
+    nextCursor: string;
+    prevCursor: string;
+}

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

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

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

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