bybit-api 4.6.1 → 4.6.3

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

@@ -0,0 +1,170 @@
+/**
+ * V5 private Alpha / on-chain (Web3) trade responses.
+ */
+export interface AlphaTradeQuoteModeEstimationV5 {
+    quoteMode: number;
+    estimatedGas: string;
+    estimatedGasUsd: string;
+    estimatedSlippage: string;
+}
+export interface AlphaTradeQuoteResultV5 {
+    tradeType: number;
+    fromTokenCode: string;
+    fromTokenAmount: string;
+    fromTokenAmountUsd: string;
+    toTokenCode: string;
+    toTokenAmount: string;
+    toTokenAmountUsd: string;
+    minToTokenAmount: string;
+    slippage: string;
+    gas: string;
+    gasUsd: string;
+    platformFee: string;
+    platformFeeUsd: string;
+    swapRate: string;
+    lossRate: string;
+    quoteData: string;
+    correctingCode: string;
+    quoteMode: number;
+    quoteDataId: string;
+    expireTime: number;
+    modeEstimations: AlphaTradeQuoteModeEstimationV5[];
+    chargeAmount?: string;
+    timestamp?: number;
+}
+export interface ExecuteAlphaTradeResultV5 {
+    orderNo: string;
+}
+export interface AlphaPayTokenV5 {
+    tokenCode: string;
+    symbol: string;
+    tokenDecimals: number;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    limit: string;
+    supportChains: string[];
+}
+export interface AlphaTradeOrderV5 {
+    orderType: number;
+    tradeType: number;
+    orderNo: string;
+    orderStatus: number;
+    fromTokenCode: string;
+    fromTokenAmount: string;
+    fromTokenSymbol: string;
+    fromTokenDecimals: number;
+    fromTokenIconUrlDay?: string;
+    fromTokenIconUrlNight?: string;
+    fromChainCode: string;
+    fromChainIconUrl?: string;
+    toTokenCode: string;
+    toTokenAmount: string;
+    toTokenSymbol: string;
+    toTokenDecimals: number;
+    toTokenIconUrlDay?: string;
+    toTokenIconUrlNight?: string;
+    toChainCode: string;
+    toChainIconUrl?: string;
+    gasTokenSymbol: string;
+    gasOnchain: string;
+    gasUsd: string | null;
+    platformFee: string;
+    platformFeeUsd: string | null;
+    quoteMode: number;
+    createTime: number;
+    executionTime?: number;
+    failureReasonCode?: string;
+    source?: string;
+    swapRate: string;
+    actualFromTokenAmount: string;
+}
+export interface AlphaTradeOrderListResultV5 {
+    total: number;
+    pageIndex: number;
+    orders: AlphaTradeOrderV5[];
+}
+export interface AlphaBizTokenV5 {
+    tokenCode: string;
+    chainCode: string;
+    chainIconUrl: string;
+    tokenAddress: string;
+    symbol: string;
+    tokenDecimals: number;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    createTime: number;
+    createTimeOnchain: number;
+    riskFlag: number;
+    minOrderQuantity: number;
+    maxOrderQuantity: number;
+    tokenTags: number[];
+    payTokenCodes: string[];
+}
+export interface AlphaBizTokenPriceV5 {
+    chainCode: string;
+    tokenAddress: string;
+    price: string;
+    change24h: string;
+    vol24h: string;
+    marketCap: string;
+    liquidity: string;
+    holders: string;
+}
+export interface AlphaBizTokenPriceListResultV5 {
+    tokenPriceInfoList: AlphaBizTokenPriceV5[];
+}
+export interface AlphaBizTokenDetailsV5 {
+    tokenCode: string;
+    chainCode: string;
+    chainIconUrl: string;
+    tokenAddress: string;
+    symbol: string;
+    tokenDecimals: number;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    minOrderQuantity: string;
+    maxOrderQuantity: string;
+    maxPositionQuantity: string;
+    tokenDesc: string;
+    xUrl: string;
+    officialUrl: string;
+    whitePaperUrl: string;
+    tokenTag: number;
+    riskFlag: number;
+    createTimeOnchain: number;
+    status: number;
+    tokenTags: number[];
+    showMessage: number;
+    content?: string;
+    linkName?: string;
+    linkAddress?: string;
+}
+export interface AlphaAssetV5 {
+    chainCode: string;
+    chainIconUrl: string;
+    tokenAddress: string;
+    tokenCode: string;
+    tokenSymbol: string;
+    tokenDecimals: number;
+    tokenIconUrlDay: string;
+    tokenIconUrlNight: string;
+    tokenAmount: string;
+    tokenAmountUsd: string;
+    tradeFlag: number;
+    pnl: string | null;
+    pnlRatio: string | null;
+    costPrice: string | null;
+    lastPrice: string;
+    costTotalValue: string | null;
+    assetStatus: number;
+    announcementUrl?: string;
+    estimatedOfflineTime?: number;
+    delistingTime?: number;
+}
+export interface AlphaAssetListResultV5 {
+    totalAssetUsd: string;
+    assetList: AlphaAssetV5[];
+}
+export interface AlphaAssetDetailResultV5 {
+    assetList: AlphaAssetV5[];
+}

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

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

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

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

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

@@ -134,6 +134,7 @@ export interface DepositAddressResultV5 {
 export interface CoinInfoV5 {
     name: string;
     coin: string;
+    /** @deprecated Use `chains[].withdrawMax` instead */
     remainAmount: string;
     chains: {
         chain: string;
@@ -148,6 +149,8 @@ export interface CoinInfoV5 {
         withdrawPercentageFee: string;
         contractAddress: string;
         safeConfirmNumber: string;
+        /** Max withdraw amount per transaction per chain. `-1` means no limit */
+        withdrawMax: string;
     }[];
 }
 export interface WithdrawalRecordV5 {
@@ -175,19 +178,22 @@ export interface WithdrawalAddressV5 {
     verified: number;
     createdAt: string;
 }
+export interface WithdrawableAccountSliceV5 {
+    coin: string;
+    withdrawableAmount: string;
+    availableBalance: string;
+}
+/**
+ * GET /v5/asset/withdraw/withdrawable-amount. Only keys with data are returned
+ * (e.g. UTA, FUND, EARN; EARN when the coin can be withdrawn from Earn; SPOT if present).
+ */
 export interface WithdrawableAmountV5 {
     limitAmountUsd: string;
     withdrawableAmount: {
-        SPOT: {
-            coin: string;
-            withdrawableAmount: string;
-            availableBalance: string;
-        };
-        FUND: {
-            coin: string;
-            withdrawableAmount: string;
-            availableBalance: string;
-        };
+        SPOT?: WithdrawableAccountSliceV5;
+        FUND?: WithdrawableAccountSliceV5;
+        UTA?: WithdrawableAccountSliceV5;
+        EARN?: WithdrawableAccountSliceV5;
     };
 }
 export interface VaspEntityV5 {
@@ -314,9 +320,16 @@ export interface FundingAccountTransactionRecordV5 {
     description: string;
     descriptionEn: string;
 }
+/** When accountType=Alpha and category is farm, under `coinDetail` in sub-categories. */
+export interface AssetOverviewCoinExtMapV5 {
+    priceUpper?: string;
+    priceLower?: string;
+    equityUnit?: string;
+}
 export interface AssetOverviewCoinDetailV5 {
     coin: string;
     equity: string;
+    extMap?: AssetOverviewCoinExtMapV5;
 }
 export interface AssetOverviewCategoryV5 {
     category: string;
@@ -335,3 +348,108 @@ export interface AssetOverviewResultV5 {
     totalEquity: string;
     list: AssetOverviewAccountItemV5[];
 }
+export interface PortfolioMarginWalletV5 {
+    equity: string;
+    cashBalance: string;
+    marginBalance: string;
+    availableBalance: string;
+    accountIM: string;
+    accountMM: string;
+    accountMMRate: string;
+    accountIMRate: string;
+}
+export interface PortfolioMarginPnlRangePointV5 {
+    priceScale: string;
+    pnls: string[];
+}
+export interface PortfolioMarginContractBucketPnlV5 {
+    pnlRanges: PortfolioMarginPnlRangePointV5[];
+}
+export interface PortfolioMarginTotalPnlRangesV5 {
+    ALL?: PortfolioMarginContractBucketPnlV5;
+    PERPETUAL?: PortfolioMarginContractBucketPnlV5;
+    OPTION?: PortfolioMarginContractBucketPnlV5;
+}
+export interface PortfolioMarginPerpPositionPnlV5 {
+    symbolName: string;
+    position: string;
+    pnlRanges: PortfolioMarginPnlRangePointV5[];
+    sessionAvgPrice: string;
+    markPrice: string;
+    orderSize: string;
+    contractType: number;
+    settleCoin: string;
+    symbolAlias?: string;
+}
+export interface PortfolioMarginOptionPositionPnlV5 {
+    symbolName: string;
+    position: string;
+    pnlRanges: PortfolioMarginPnlRangePointV5[];
+    sessionAvgPrice: string;
+    markPrice: string;
+    orderSize: string;
+    contractType: number;
+    settleCoin: string;
+}
+export interface PortfolioMarginOptionExpiryPnlV5 {
+    expiryDateRepresentation: string;
+    pnlRanges: PortfolioMarginPnlRangePointV5[];
+    optionPositionPnlRanges: PortfolioMarginOptionPositionPnlV5[];
+}
+export interface PortfolioMarginContingencyV5 {
+    optionContingency: string;
+    futureDeltaContingency: string;
+    optionVegaContingency: string;
+    contingencyComponents: string;
+    usdtUsdcContingency: string;
+    futureContingency: string;
+}
+export interface PortfolioMarginAssetBlockV5 {
+    coin: string;
+    assetIM: string;
+    assetMM: string;
+}
+export interface PortfolioMarginSpotHedgeInfoV5 {
+    hedgeSpotSize: string;
+    walletBalance: string;
+    usdIndexPrice: string;
+    pnlRanges: PortfolioMarginPnlRangePointV5[];
+}
+export interface PortfolioMarginByBaseCoinV5 {
+    baseCoin: string;
+    totalPnlRanges: PortfolioMarginTotalPnlRangesV5;
+    perpPositionPnlRanges: PortfolioMarginPerpPositionPnlV5[];
+    optionExpiryDatePnlRanges: PortfolioMarginOptionExpiryPnlV5[];
+    contingency: PortfolioMarginContingencyV5;
+    asset: PortfolioMarginAssetBlockV5;
+    maxLossPriceMove: string;
+    maxLossIvShock: string;
+    totalClosePzFee: string;
+    spotHedgeInfo: PortfolioMarginSpotHedgeInfoV5;
+    maxLossIvShockList: string[];
+}
+export interface PortfolioMarginInfoResultV5 {
+    wallet: PortfolioMarginWalletV5;
+    assetPnlRange: PortfolioMarginByBaseCoinV5[];
+}
+export interface TotalMembersAccountBreakdownItemV5 {
+    type: string;
+    origb: string;
+    quoteb: string;
+    stat: number;
+}
+export interface TotalMembersMemberEntryV5 {
+    uid: number;
+    isM?: boolean;
+    type?: number;
+    stat: number;
+    origb: string;
+    quoteb?: string;
+    items: TotalMembersAccountBreakdownItemV5[];
+}
+export interface TotalMembersAssetsResultV5 {
+    total: string;
+    quoteTotal: string;
+    stat: number;
+    list: TotalMembersMemberEntryV5[];
+}

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