bybit-api 4.6.0 → 4.6.2

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

@@ -0,0 +1,118 @@
+export interface CardAssetRecordV5 {
+    pan4: string;
+    pan6: string;
+    tradeStatus: string;
+    side: string;
+    basicAmount: string;
+    basicCurrency: string;
+    transactionAmount: string;
+    transactionCurrency: string;
+    txnCreate: number;
+    merchCountry: string;
+    merchCity: string;
+    merchName: string;
+    txnId: string;
+    declinedReason: string;
+    totalFees: string;
+    uid: number;
+    transactionCurrencyAmount: string;
+    fxPad: string;
+    interchangeFee: string;
+    billAmount: string;
+    paidAmount: string;
+    paidCurrency: string;
+    bonusAmount: string;
+    foreignTransactionFee: string;
+    totalTax: string;
+    paidFiat: string;
+    withdrawalFee: string;
+    status: string;
+    orderNo: string;
+    mccCode: string;
+    merchCategoryDesc: string;
+}
+export interface CardAssetRecordsResultV5 {
+    pageSize: number;
+    pageNo: number;
+    totalCount: number;
+    data: CardAssetRecordV5[];
+}
+export interface CardPointBalanceV5 {
+    accountId: string;
+    availablePoint: string | number;
+    pendingPoint: string | number;
+    status: string;
+    updateTime: string | number;
+    settlementPeriod: number;
+}
+export interface CardPointRecordV5 {
+    outOrderId: string;
+    point: number;
+    side: string;
+    type: string;
+    subType: string;
+    createTime: number;
+    updateTime: number;
+    bizId: string;
+    bizTxnId: string;
+    transactionDate: string;
+    transactionId: string;
+    transactionAmount: string;
+    basicCurrency: string;
+    merchCategoryDesc: string;
+    merchName: string;
+    merchCountry: string;
+    merchCity: string;
+    pan4: string;
+    payFiatAmount: string;
+    transactionCurrencyAmount: string;
+}
+export interface CardPointRecordsResultV5 {
+    pageSize: number;
+    pageNo: number;
+    totalCount: number;
+    data: CardPointRecordV5[];
+}
+export interface CardPointTierInfoV5 {
+    usedLimit: string;
+    limit: string;
+    unit: string;
+    tier: string;
+    autoCashback: boolean;
+}
+export interface CardMallItemV5 {
+    itemId: string;
+    itemName: string;
+    priority: number;
+    onTime: string;
+    offTime: string;
+    price: string;
+    discountPrice: string;
+    totalNum: number;
+    redeemNum: number;
+    picPath: string;
+    currency: string;
+    currencyType: number;
+    itemType: number;
+    itemBizType: number;
+}
+export interface CardMallItemListResultV5 {
+    pageNo: number;
+    pageSize: number;
+    totalCount: number;
+    data: CardMallItemV5[];
+}
+export interface CardPointCashbackDetailV5 {
+    points: string;
+    amt: string;
+    ccy: string;
+    ccyType: string;
+    createTime: string;
+    bizTxnId: string;
+    sourceId: number;
+    sourceCode: string;
+    orderStatus: number;
+    orderSubStatus: number;
+    orderShowStatus: string;
+    failedBizCode: string;
+}

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

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

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

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

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

@@ -0,0 +1,143 @@
+export interface AdvanceEarnDiscountBuyOfferV5 {
+    productId: string;
+    currentPrice: string;
+    purchasePrice: string;
+    knockoutPrice: string;
+    knockoutCouponE8: string;
+    maxInvestmentAmount: string;
+    instUid: string;
+    expiredAt: string;
+    category: string;
+}
+/** GET /v5/earn/advance/product-extra-info?category=DiscountBuy */
+export interface AdvanceEarnProductExtraInfoDiscountBuyV5 {
+    offers: AdvanceEarnDiscountBuyOfferV5[];
+}
+export interface AdvanceEarnDualAssetQuoteLevelV5 {
+    selectPrice: string;
+    apyE8: string;
+    maxInvestmentAmount: string;
+    expiredAt: string;
+}
+export interface AdvanceEarnDualAssetQuoteProductV5 {
+    productId: string;
+    currentPrice: string;
+    buyLowPrice: AdvanceEarnDualAssetQuoteLevelV5[];
+    sellHighPrice: AdvanceEarnDualAssetQuoteLevelV5[];
+}
+/** GET /v5/earn/advance/product-extra-info?category=DualAssets&productId= */
+export interface AdvanceEarnProductExtraInfoDualAssetsV5 {
+    category: 'DualAssets';
+    list: AdvanceEarnDualAssetQuoteProductV5[];
+}
+export type AdvanceEarnProductExtraInfoV5 = AdvanceEarnProductExtraInfoDiscountBuyV5 | AdvanceEarnProductExtraInfoDualAssetsV5;
+export interface AdvanceEarnPlaceOrderResultV5 {
+    orderId: string;
+    orderLinkId: string;
+}
+export interface AdvanceEarnDiscountBuyPositionV5 {
+    positionId: string;
+    productId: string;
+    category: string;
+    coin: string;
+    underlyingAsset: string;
+    amount: string;
+    purchasePrice: string;
+    knockoutPrice: string;
+    knockoutCouponE8: string;
+    status: string;
+    orderId: string;
+    duration: string;
+    settlementTime: string;
+    accountType: string;
+    toAccountType: string;
+    settleType: string;
+    expectReceiveAt: string;
+}
+export interface AdvanceEarnDualAssetsPositionV5 {
+    positionId: string;
+    productId: string;
+    category: string;
+    baseCoin: string;
+    quoteCoin: string;
+    investCoin: string;
+    amount: string;
+    apyE8: string;
+    direction: 'BuyLow' | 'SellHigh' | string;
+    targetPrice: string;
+    settlementTime: string;
+    status: string;
+    orderId: string;
+    duration: string;
+    expectReturnCoin: string;
+    expectReturnAmount: string;
+    accountType: string;
+    toAccountType: string;
+    yieldStartAt: string | number;
+    yieldEndAt: string | number;
+}
+export interface AdvanceEarnPositionListV5 {
+    category: string;
+    list: (AdvanceEarnDiscountBuyPositionV5 | AdvanceEarnDualAssetsPositionV5)[];
+    nextPageCursor: string;
+}
+export interface AdvanceEarnDiscountBuyOrderV5 {
+    orderId: string;
+    orderLinkId: string;
+    productId: string;
+    category: string;
+    orderType: string;
+    amount: string;
+    coin: string;
+    underlyingAsset: string;
+    status: string;
+    createdTime: string;
+    purchasePrice: string;
+    knockoutPrice: string;
+    knockoutCouponE8: string;
+    duration: string;
+    settlementTime: string;
+    accountType: string;
+    toAccountType: string;
+    settleType: string;
+    settlementPrice: string;
+    settlementCoin: string;
+    settlementAmount: string;
+    isVip: boolean;
+    refundStatus: string;
+}
+export interface AdvanceEarnDualAssetsOrderV5 {
+    orderId: string;
+    orderLinkId: string;
+    productId: string;
+    category: string;
+    orderType: string;
+    amount: string;
+    coin: string;
+    baseCoin: string;
+    quoteCoin: string;
+    status: string;
+    createdTime: string;
+    updatedTime: string;
+    direction: 'BuyLow' | 'SellHigh' | string;
+    targetPrice: string;
+    settlementTime: string | number;
+    estimateApyE8: string | number;
+    duration: string;
+    accountType: string;
+    toAccountType: string;
+    selectApyE8: string | number;
+    isVip: boolean;
+    settlementCoin: string;
+    settlementAmount: string;
+    orderMode: string;
+    settlementPrice: string;
+    refundStatus: string;
+    trialBonusAmount: string;
+    trialBonusPnl: string;
+}
+export interface AdvanceEarnOrderListV5 {
+    category: string;
+    list: (AdvanceEarnDiscountBuyOrderV5 | AdvanceEarnDualAssetsOrderV5)[];
+    nextPageCursor: string;
+}

package/lib/types/response/v5-earn-advance-discount.js

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

package/lib/types/response/v5-earn-advance-discount.js.map

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

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-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"}

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

@@ -28,6 +28,14 @@ export interface EarnPositionV5 {
     amount: string;
     totalPnl: string;
     claimableYield: string;
+    id?: string;
+    status?: string;
+    orderId?: string;
+    estimateRedeemTime?: string;
+    estimateStakeTime?: string;
+    estimateInterestCalculationTime?: string;
+    settlementTime?: string;
+    autoReinvest?: string;
 }
 export interface EarnYieldHistoryV5 {
     productId: string;
@@ -51,3 +59,98 @@ export interface EarnHourlyYieldHistoryV5 {
     hourlyDate: string;
     createdAt: string;
 }
+export interface EarnAprHistoryPointV5 {
+    timestamp: string;
+    apr: string;
+}
+/**
+ * Advanced Earn — Dual Asset product (GET /v5/earn/advance/product).
+ */
+export interface AdvanceEarnDualAssetProductV5 {
+    category: string;
+    productId: string;
+    baseCoin: string;
+    quoteCoin: string;
+    expectReceiveAt: string;
+    duration: string;
+    status: 'Available' | 'NotAvailable';
+    isVipProduct: boolean;
+    subscribeStartAt: string;
+    subscribeEndAt: string;
+    applyStartAt: string;
+    settlementTime: string;
+    minPurchaseQuoteAmount: string;
+    minPurchaseBaseAmount: string;
+    remainingAmountQuote: string;
+    remainingAmountBase: string;
+    orderPrecisionDigitalQuote: number;
+    orderPrecisionDigitalBase: number;
+}
+export interface AdvanceEarnDualAssetProductInfoV5 {
+    category: string;
+    list: AdvanceEarnDualAssetProductV5[];
+}
+/**
+ * Advanced Earn — Double Win (GET /v5/earn/advance/product?category=DoubleWin).
+ */
+export interface AdvanceEarnDoubleWinProductV5 {
+    category: string;
+    productId: string;
+    investCoin: string;
+    underlyingAsset: string;
+    duration: string;
+    subscribeStartAt: string;
+    subscribeEndAt: string;
+    settlementTime: string;
+    expectReceiveAt: string;
+    minPurchaseAmount: string;
+    orderPrecisionDigital: number;
+    isRfqProduct: boolean;
+    lowerPriceBuffer: string;
+    upperPriceBuffer: string;
+    minDeviationRatio: string;
+    maxDeviationRatio: string;
+    priceTickSize: string;
+}
+/**
+ * Advanced Earn — Smart Leverage (GET /v5/earn/advance/product?category=SmartLeverage).
+ */
+export interface AdvanceEarnSmartLeverageProductV5 {
+    category: string;
+    productId: string;
+    investCoin: string;
+    underlyingAsset: string;
+    direction: 'Long' | 'Short';
+    leverage: string;
+    duration: string;
+    subscribeStartAt: string;
+    subscribeEndAt: string;
+    settlementTime: string;
+    expectReceiveAt: string;
+    minPurchaseAmount: string;
+    remainingAmount: string;
+    orderPrecisionDigital: number;
+}
+/**
+ * Advanced Earn — Discount Buy (GET /v5/earn/advance/product?category=DiscountBuy).
+ */
+export interface AdvanceEarnDiscountBuyProductV5 {
+    category: string;
+    productId: string;
+    coin: string;
+    underlyingAsset: string;
+    settlementTime: string;
+    duration: string;
+    isVipProduct: boolean;
+    subscribeStartAt: string;
+    subscribeEndAt: string;
+    minPurchaseAmount: string;
+    remainingAmount: string;
+    orderPrecisionDigital: number;
+    expectReceiveAt: string;
+}
+export type AdvanceEarnAdvanceProductListItemV5 = AdvanceEarnDualAssetProductV5 | AdvanceEarnDoubleWinProductV5 | AdvanceEarnSmartLeverageProductV5 | AdvanceEarnDiscountBuyProductV5;
+export interface AdvanceEarnAdvanceProductInfoV5 {
+    category: string;
+    list: AdvanceEarnAdvanceProductListItemV5[];
+}

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

@@ -35,6 +35,9 @@ export interface LinearInverseInstrumentInfoV5 {
     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;
     launchTime: string;
     deliveryTime?: string;
@@ -92,6 +95,9 @@ export interface OptionInstrumentInfoV5 {
     baseCoin: string;
     quoteCoin: string;
     settleCoin: string;
+    /**
+     * Region / product class for the pair (see Bybit instruments docs; new values may be added).
+     */
     symbolType: string;
     launchTime: string;
     deliveryTime: string;
@@ -112,6 +118,14 @@ export interface SpotInstrumentInfoV5 {
     symbol: string;
     baseCoin: string;
     quoteCoin: string;
+    /**
+     * Xstock multiplier for `symbolType` = xstocks pairs. `stock_price = token_price / multiplier`,
+     * `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;
     innovation: '0' | '1';
     status: InstrumentStatusV5;

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

@@ -37,6 +37,10 @@ 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;
     positionIMByMp: string;
     positionMMByMp: string;
     seq: number;