bybit-api 4.6.1 → 4.6.3

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

@@ -0,0 +1,102 @@
+export interface FixedTermEarnTieredApyV5 {
+    min: string;
+    max: string;
+    apy: string;
+}
+export interface FixedTermEarnInterestCoinApyV5 {
+    coin: string;
+    apy: string;
+    expectUnitEarning: string;
+    currentPrice: string;
+}
+export interface FixedTermEarnProductV5 {
+    productId: string;
+    category: 'FixedTermSaving' | 'FundPool' | 'FundPoolPremium' | string;
+    coin: string;
+    duration: string;
+    status: 'Available' | 'SoldOut' | 'NotStarted' | string;
+    tieredApyList: FixedTermEarnTieredApyV5[];
+    minStakeAmount: string;
+    maxStakeAmount: string;
+    precision: number;
+    subscribeStartAt: string;
+    subscribeEndAt: string;
+    allowEarlyRedemption: boolean;
+    earlyRedemptionApy: string;
+    redemptionLimitDuration: string;
+    allowAutoReinvest: boolean;
+    interestCoinApyList: FixedTermEarnInterestCoinApyV5[];
+    isVip: boolean;
+    creditTime: string;
+    specialUserGroupRequired: boolean;
+    specialUserGroupInfo: string;
+}
+export interface FixedTermEarnProductListV5 {
+    list: FixedTermEarnProductV5[];
+}
+export interface FixedTermEarnPlaceOrderResultV5 {
+    orderId: string;
+    orderLinkId: string;
+}
+export interface RedeemFixedTermEarnResultV5 {
+    redeemAmount: string;
+    estEarnings: string;
+}
+export interface FixedTermEarnEarlyRedeemInfoV5 {
+    allowEarlyRedeem: boolean;
+    earlyRedeemEarning: string;
+    returnCoin: string;
+    redemptionLimitDuration: string;
+}
+export interface FixedTermEarnPositionInterestV5 {
+    coin: string;
+    apy: string;
+    expectReturnEarning: string;
+    price: string;
+}
+export interface FixedTermEarnPositionV5 {
+    positionId: string;
+    productId: string;
+    category: string;
+    coin: string;
+    amount: string;
+    effectiveAmount: string;
+    duration: string;
+    status: string;
+    settlementTime: string;
+    createdAt: string;
+    orderId: string;
+    earlyRedeemInfo: FixedTermEarnEarlyRedeemInfoV5 | null;
+    allowAutoReinvest: boolean;
+    autoReinvest: string;
+    interestCoinApyList: FixedTermEarnPositionInterestV5[];
+}
+export interface FixedTermEarnPositionListV5 {
+    list: FixedTermEarnPositionV5[];
+}
+export interface FixedTermEarnOrderYieldInfoV5 {
+    coin: string;
+    amount: string;
+    status: string;
+    createdAt: string;
+    apy: string;
+}
+export interface FixedTermEarnOrderV5 {
+    orderId: string;
+    orderLinkId: string;
+    orderType: string;
+    status: string;
+    productId: string;
+    category: string;
+    coin: string;
+    amount: string;
+    duration: string;
+    accountType: string;
+    settlementTime: string;
+    createdAt: string;
+    yieldInfoList: FixedTermEarnOrderYieldInfoV5[];
+}
+export interface FixedTermEarnOrderListV5 {
+    list: FixedTermEarnOrderV5[];
+    nextPageCursor: string;
+}

package/lib/types/response/v5-earn-fixed-term.js

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

package/lib/types/response/v5-earn-fixed-term.js.map

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

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

@@ -0,0 +1,31 @@
+export interface LiquidityMiningApyBreakdownV5 {
+    coin: string;
+    apy: string;
+}
+export interface LiquidityMiningProductV5 {
+    productId: string;
+    baseCoin: string;
+    quoteCoin: string;
+    status: 'Available' | 'NotAvailable' | string;
+    maxLeverage: number;
+    minInvestmentQuote: string;
+    minInvestmentBase: string;
+    maxInvestmentQuote: string;
+    maxInvestmentBase: string;
+    minWithdrawalAmount: string;
+    minReinvestAmount: string;
+    baseCoinPrecision: number;
+    quoteCoinPrecision: number;
+    yieldCoins: string[];
+    apyE8: string;
+    apy7dE8: string;
+    poolLiquidityValue: string;
+    dailyYield: string;
+    slippageRateE8List: string[];
+    apyBreakdown: LiquidityMiningApyBreakdownV5[];
+    apy7dBreakdown: LiquidityMiningApyBreakdownV5[];
+    slippage_levels?: string[];
+}
+export interface LiquidityMiningProductResultV5 {
+    products: LiquidityMiningProductV5[];
+}

package/lib/types/response/v5-earn-liquidity-mining.js

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

package/lib/types/response/v5-earn-liquidity-mining.js.map

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

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-token.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Earn token product (e.g. BYUSDT) — /v5/earn/token/*
+ */
+export interface EarnTokenProductV5 {
+    productId: string;
+    coin: string;
+    mintFeeRateE8: string;
+    redeemFeeRateE8: string;
+    minInvestment: string;
+    userHolding: string;
+    leftQuota: string;
+    canMint: boolean;
+    savingsBalance: string;
+    aprE8: string;
+    bonusAprE8: string;
+    bonusMaxAmount: string;
+    baseCoinPrecision: number;
+    tokenPrecision: number;
+}
+export interface PlaceEarnTokenOrderResultV5 {
+    orderId: string;
+    orderLinkId: string;
+}
+export interface EarnTokenOrderV5 {
+    orderId: string;
+    orderLinkId: string;
+    orderType: 'Mint' | 'Redeem';
+    fromCoin: string;
+    toCoin: string;
+    fromAmount: string;
+    toAmount: string;
+    serviceFee: string;
+    status: 'Success' | 'Processing' | 'Fail';
+    createdTime: string;
+}
+export interface EarnTokenPositionV5 {
+    totalAmount: string;
+    totalYield: string;
+    yesterdayYield: string;
+    aprE8: number;
+    bonusAprE8: number;
+    bonusMaxAmount: string;
+    hasQuota: boolean;
+}
+export interface EarnTokenDailyYieldRecordV5 {
+    yield: string;
+    bonusYield: string;
+    status: 'Success' | 'Processing';
+    createdTime: string;
+}
+export interface EarnTokenHourlyYieldRecordV5 {
+    effectiveAmount: string;
+    yield: string;
+    rewardType: 0 | 1;
+    aprE8: string;
+    hourlyDate: string;
+    createdTime: string;
+}
+export interface EarnTokenHistoryAprPointV5 {
+    timestamp: string;
+    aprE8: string;
+}

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

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Earn token product (e.g. BYUSDT) — /v5/earn/token/*
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v5-earn-token.js.map

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

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