bybit-api 3.4.2 → 3.5.0-beta.0

package/lib/types/request/v5-user.d.ts

@@ -0,0 +1,18 @@
+import { PermissionsV5 } from '../v5-shared';
+export interface CreateSubApiKeyParamsV5 {
+    subuid: number;
+    note?: string;
+    readOnly: 0 | 1;
+    ips?: string[];
+    permissions: PermissionsV5;
+}
+export interface UpdateApiKeyParamsV5 {
+    readOnly?: 0 | 1;
+    ips?: string[];
+    permissions: PermissionsV5;
+}
+export interface UpdateSubApiKeyUpdateParamsV5 {
+    readOnly?: number;
+    ips?: string[];
+    permissions: PermissionsV5;
+}

package/lib/types/request/v5-user.js

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

package/lib/types/request/v5-user.js.map

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

package/lib/types/response/index.d.ts

@@ -4,3 +4,10 @@ export * from './shared';
 export * from './spot';
 export * from './usdt-perp';
 export * from './unified-margin';
+export * from './v5-account';
+export * from './v5-asset';
+export * from './v5-market';
+export * from './v5-position';
+export * from './v5-trade';
+export * from './v5-user';
+export * from './v5-spot-leverage-token';

package/lib/types/response/index.js

@@ -16,4 +16,11 @@ __exportStar(require("./shared"), exports);
 __exportStar(require("./spot"), exports);
 __exportStar(require("./usdt-perp"), exports);
 __exportStar(require("./unified-margin"), exports);
+__exportStar(require("./v5-account"), exports);
+__exportStar(require("./v5-asset"), exports);
+__exportStar(require("./v5-market"), exports);
+__exportStar(require("./v5-position"), exports);
+__exportStar(require("./v5-trade"), exports);
+__exportStar(require("./v5-user"), exports);
+__exportStar(require("./v5-spot-leverage-token"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/response/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB;AACvB,8CAA4B;AAC5B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/response/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,6CAA2B;AAC3B,2CAAyB;AACzB,yCAAuB;AACvB,8CAA4B;AAC5B,mDAAiC;AACjC,+CAA6B;AAC7B,6CAA2B;AAC3B,8CAA4B;AAC5B,gDAA8B;AAC9B,6CAA2B;AAC3B,4CAA0B;AAC1B,2DAAyC"}

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

@@ -0,0 +1,101 @@
+import { AccountMarginModeV5, AccountTypeV5, CategoryV5, TransactionTypeV5, UnifiedUpdateStatusV5 } from '../v5-shared';
+export interface WalletBalanceV5Coin {
+    coin: string;
+    equity: string;
+    usdValue: string;
+    walletBalance: string;
+    borrowAmount: string;
+    availableToBorrow: string;
+    availableToWithdraw: string;
+    accruedInterest: string;
+    totalOrderIM: string;
+    totalPositionIM: string;
+    totalPositionMM: string;
+    unrealisedPnl: string;
+    cumRealisedPnl: string;
+}
+export interface WalletBalanceV5 {
+    accountType: AccountTypeV5;
+    accountIMRate: string;
+    accountMMRate: string;
+    totalEquity: string;
+    totalWalletBalance: string;
+    totalMarginBalance: string;
+    totalAvailableBalance: string;
+    totalPerpUPL: string;
+    totalInitialMargin: string;
+    totalMaintenanceMargin: string;
+    coin: WalletBalanceV5Coin[];
+}
+export interface UnifiedAccountUpgradeResultV5 {
+    unifiedUpdateStatus: UnifiedUpdateStatusV5;
+    unifiedUpdateMsg: {
+        msg: string[] | null;
+    };
+}
+export interface BorrowHistoryRecordV5 {
+    currency: string;
+    createdTime: number;
+    borrowCost: string;
+    hourlyBorrowRate: string;
+    InterestBearingBorrowSize: string;
+    costExemption: string;
+}
+export interface CollateralInfoV5 {
+    currency: string;
+    hourlyBorrowRate: string;
+    maxBorrowingAmount: string;
+    freeBorrowingAmount: string;
+    borrowAmount: string;
+    availableToBorrow: string;
+    borrowable: boolean;
+    marginCollateral: boolean;
+    collateralRatio: string;
+}
+export interface CoinGreeksV5 {
+    baseCoin: string;
+    totalDelta: string;
+    totalGamma: string;
+    totalVega: string;
+    totalTheta: string;
+}
+export interface FeeRateV5 {
+    symbol: string;
+    takerFeeRate: string;
+    makerFeeRate: string;
+}
+export interface AccountInfoV5 {
+    unifiedMarginStatus: number;
+    marginMode: AccountMarginModeV5;
+    updatedTime: string;
+}
+export interface TransactionLogV5 {
+    symbol: string;
+    category: CategoryV5;
+    side: string;
+    transactionTime: string;
+    type: TransactionTypeV5;
+    qty: string;
+    size: string;
+    currency: string;
+    tradePrice: string;
+    funding: string;
+    fee: string;
+    cashFlow: string;
+    change: string;
+    cashBalance: string;
+    feeRate: string;
+    tradeId: string;
+    orderId: string;
+    orderLinkId: string;
+}
+export interface MMPStateV5 {
+    baseCoin: string;
+    mmpEnabled: boolean;
+    window: string;
+    frozenPeriod: string;
+    qtyLimit: string;
+    deltaLimit: string;
+    mmpFrozenUntil: string;
+    mmpFrozen: boolean;
+}

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

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

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

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

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

@@ -0,0 +1,133 @@
+import { AccountTypeV5, OrderSideV5, WithdrawalTypeV5 } from '../v5-shared';
+export interface CoinExchangeRecordV5 {
+    fromCoin: string;
+    fromAmount: string;
+    toCoin: string;
+    toAmount: string;
+    exchangeRate: string;
+    createdTime: string;
+    exchangeTxId: string;
+}
+export interface DeliveryRecordV5 {
+    deliveryTime: number;
+    symbol: string;
+    side: OrderSideV5;
+    position: string;
+    deliveryPrice: string;
+    strike: string;
+    fee: string;
+    deliveryRpl: string;
+}
+export interface SettlementRecordV5 {
+    symbol: string;
+    side: string;
+    size: number;
+    sessionAvgPrice: string;
+    markPrice: string;
+    realisedPnl: string;
+    createdTime: string;
+}
+export interface AssetInfoAssetV5 {
+    coin: string;
+    frozen: string;
+    free: string;
+    withdraw: string;
+}
+export interface AssetInfoV5 {
+    status: 'ACCOUNT_STATUS_NORMAL' | 'ACCOUNT_STATUS_UNSPECIFIED';
+    assets: AssetInfoAssetV5[];
+}
+export interface CoinBalanceV5 {
+    coin: string;
+    walletBalance: string;
+    transferBalance: string;
+    bonus?: string;
+}
+export interface AllCoinsBalanceV5 {
+    accountType: AccountTypeV5;
+    memberId?: string;
+    balance: CoinBalanceV5[];
+}
+export interface AccountCoinBalanceV5 {
+    accountType: AccountTypeV5;
+    bizType: number;
+    accountId: string;
+    memberId: string;
+    balance: {
+        coin: string;
+        walletBalance: string;
+        transferBalance: string;
+        bonus: string;
+    };
+}
+export interface InternalTransferRecordV5 {
+    transferId: string;
+    coin: string;
+    amount: string;
+    fromAccountType: AccountTypeV5;
+    toAccountType: AccountTypeV5;
+    timestamp: string;
+    status: string;
+}
+export interface AllowedDepositCoinInfoV5 {
+    coin: string;
+    chain: string;
+    coinShowName: string;
+    chainType: string;
+    blockConfirmNumber: number;
+    minDepositAmount: string;
+}
+export interface DepositRecordV5 {
+    coin: string;
+    chain: string;
+    amount: string;
+    txID: string;
+    status: number;
+    toAddress: string;
+    tag: string;
+    depositFee: string;
+    successAt: string;
+    confirmations: string;
+    txIndex: string;
+    blockHash: string;
+}
+export interface DepositAddressChainV5 {
+    chainType: string;
+    addressDeposit: string;
+    tagDeposit: string;
+    chain: string;
+}
+export interface DepositAddressResultV5 {
+    coin: string;
+    chains: DepositAddressChainV5[];
+}
+export interface CoinInfoV5 {
+    name: number;
+    coin: string;
+    remainAmount: string;
+    chains: {
+        chain: string;
+        chainType: string;
+        confirmation: string;
+        withdrawFee: string;
+        depositMin: string;
+        withdrawMin: string;
+        minAccuracy: string;
+        chainDeposit: string;
+        chainWithdraw: string;
+    }[];
+}
+export interface WithdrawalRecordV5 {
+    withdrawId: string;
+    txID: string;
+    withdrawType: WithdrawalTypeV5;
+    coin: string;
+    chain: string;
+    amount: string;
+    withdrawFee: string;
+    status: string;
+    toAddress: string;
+    tag: string;
+    createTime: string;
+    updateTime: string;
+}

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

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

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

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

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

@@ -0,0 +1,234 @@
+import { CategoryCursorListV5, ContractTypeV5, InstrumentStatusV5, OptionTypeV5, OrderSideV5 } from '../v5-shared';
+/**
+ * OHLCVT candle used by v5 APIs
+ *
+ * - list[0]: startTime	string	Start time of the candle (ms)
+ * - list[1]: openPrice	string	Open price
+ * - list[2]: highPrice	string	Highest price
+ * - list[3]: lowPrice	string	Lowest price
+ * - list[4]: closePrice	string	Close price. Is the last traded price when the candle is not closed
+ * - list[5]: volume	string	Trade volume. Unit of contract: pieces of contract. Unit of spot: quantity of coins
+ * - list[6]: turnover	string	Turnover. Unit of figure: quantity of quota coin
+ */
+export declare type OHLCVKlineV5 = [
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string
+];
+/**
+ * OHLC candle used by v5 APIs
+ *
+ * - list[0]: startTime	string	Start time of the candle (ms)
+ * - list[1]: openPrice	string	Open price
+ * - list[2]: highPrice	string	Highest price
+ * - list[3]: lowPrice	string	Lowest price
+ * - list[4]: closePrice	string	Close price. Is the last traded price when the candle is not closed
+ */
+export declare type OHLCKlineV5 = [string, string, string, string, string];
+export interface LinearInverseInstrumentInfoV5 {
+    symbol: string;
+    contractType: ContractTypeV5;
+    status: InstrumentStatusV5;
+    baseCoin: string;
+    quoteCoin: string;
+    launchTime: string;
+    deliveryTime?: string;
+    deliveryFeeRate?: string;
+    priceScale: string;
+    leverageFilter: {
+        minLeverage: string;
+        maxLeverage: string;
+        leverageStep: string;
+    };
+    priceFilter: {
+        minPrice: string;
+        maxPrice: string;
+        tickSize: string;
+    };
+    lotSizeFilter: {
+        maxOrderQty: string;
+        minOrderQty: string;
+        qtyStep: string;
+        postOnlyMaxOrderQty?: string;
+    };
+    unifiedMarginTrade: boolean;
+    fundingInterval: number;
+    settleCoin: string;
+}
+export interface OptionInstrumentInfoV5 {
+    symbol: string;
+    optionsType: OptionTypeV5;
+    status: InstrumentStatusV5;
+    baseCoin: string;
+    quoteCoin: string;
+    settleCoin: boolean;
+    launchTime: string;
+    deliveryTime: string;
+    deliveryFeeRate: string;
+    priceFilter: {
+        minPrice: string;
+        maxPrice: string;
+        tickSize: string;
+    };
+    lotSizeFilter: {
+        maxOrderQty: string;
+        minOrderQty: string;
+        qtyStep: string;
+    };
+}
+export interface SpotInstrumentInfoV5 {
+    symbol: string;
+    baseCoin: string;
+    quoteCoin: string;
+    innovation: '0' | '1';
+    status: InstrumentStatusV5;
+    lotSizeFilter: {
+        basePrecision: string;
+        quotePrecision: string;
+        minOrderQty: string;
+        maxOrderQty: string;
+        minOrderAmt: string;
+        maxOrderAmt: string;
+    };
+    priceFilter: {
+        tickSize: string;
+    };
+}
+export declare type InstrumentInfoResponseV5 = CategoryCursorListV5<LinearInverseInstrumentInfoV5[], 'linear' | 'inverse'> | CategoryCursorListV5<OptionInstrumentInfoV5[], 'option'> | CategoryCursorListV5<SpotInstrumentInfoV5[], 'spot'>;
+export default interface OrderbookLevelV5 {
+    price: string;
+    size: string;
+}
+export interface OrderbookResponseV5 {
+    s: string;
+    b: OrderbookLevelV5[];
+    a: OrderbookLevelV5[];
+    ts: number;
+    u: number;
+}
+export interface TickerLinearInverseV5 {
+    symbol: string;
+    lastPrice: string;
+    indexPrice: string;
+    markPrice: string;
+    prevPrice24h: string;
+    price24hPcnt: string;
+    highPrice24h: string;
+    lowPrice24h: string;
+    prevPrice1h: string;
+    openInterest: string;
+    openInterestValue: string;
+    turnover24h: string;
+    volume24h: string;
+    fundingRate: string;
+    nextFundingTime: string;
+    predictedDeliveryPrice: string;
+    basisRate: string;
+    deliveryFeeRate: string;
+    deliveryTime: string;
+    ask1Size: string;
+    bid1Price: string;
+    ask1Price: string;
+    bid1Size: string;
+}
+export interface TickerOptionV5 {
+    symbol: string;
+    bid1Price: string;
+    bid1Size: string;
+    bid1Iv: string;
+    ask1Price: string;
+    ask1Size: string;
+    ask1Iv: string;
+    lastPrice: string;
+    highPrice24h: string;
+    lowPrice24h: string;
+    markPrice: string;
+    indexPrice: string;
+    markIv: string;
+    underlyingPrice: string;
+    openInterest: string;
+    turnover24h: string;
+    volume24h: string;
+    totalVolume: string;
+    totalTurnover: string;
+    delta: string;
+    gamma: string;
+    vega: string;
+    theta: string;
+    predictedDeliveryPrice: string;
+    change24h: string;
+}
+export interface TickerSpotV5 {
+    symbol: string;
+    bid1Price: string;
+    bid1Size: string;
+    ask1Price: string;
+    ask1Size: string;
+    lastPrice: string;
+    prevPrice24h: string;
+    price24hPcnt: string;
+    highPrice24h: string;
+    lowPrice24h: string;
+    turnover24h: string;
+    volume24h: string;
+    usdIndexPrice: string;
+}
+export interface FundingRateHistoryResponseV5 {
+    symbol: string;
+    fundingRate: string;
+    fundingRateTimestamp: string;
+}
+export interface PublicTradeV5 {
+    execId: string;
+    symbol: string;
+    price: string;
+    size: string;
+    side: OrderSideV5;
+    time: string;
+    isBlockTrade: boolean;
+}
+/**
+ *
+ * - openInterest	string	Open interest
+ * - timestamp	string	The timestamp (ms)
+ */
+export declare type OpenInterestV5 = [string, string];
+export interface OpenInterestResponseV5 {
+    category: 'linear' | 'inverse';
+    symbol: string;
+    list: OpenInterestV5[];
+    nextPageCursor?: string;
+}
+export interface HistoricalVolatilityV5 {
+    period: number;
+    value: string;
+    time: string;
+}
+export interface InsuranceDataV5 {
+    coin: string;
+    balance: string;
+    value: string;
+}
+export interface InsuranceResponseV5 {
+    updatedTime: string;
+    list: InsuranceDataV5[];
+}
+export interface RiskLimitV5 {
+    id: number;
+    symbol: string;
+    riskLimitValue: string;
+    maintenanceMargin: number;
+    initialMargin: number;
+    section: any;
+    isLowestRisk: 0 | 1;
+    maxLeverage: string;
+}
+export interface OptionDeliveryPriceV5 {
+    symbol: string;
+    deliveryPrice: string;
+    deliveryTime: string;
+}

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

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

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

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

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

@@ -0,0 +1,78 @@
+import { CategoryV5, ExecTypeV5, OrderSideV5, OrderTypeV5, PositionIdx, StopOrderTypeV5, TPSLModeV5, TradeModeV5 } from '../v5-shared';
+export interface PositionV5 {
+    positionIdx: PositionIdx;
+    riskId: number;
+    riskLimitValue: string;
+    symbol: string;
+    side: 'Buy' | 'Sell' | 'None';
+    size: string;
+    avgPrice: string;
+    positionValue: string;
+    tradeMode: TradeModeV5;
+    autoAddMargin?: number;
+    positionStatus: 'Normal' | 'Liq' | 'Adl';
+    leverage?: string;
+    markPrice: string;
+    liqPrice: string;
+    bustPrice?: string;
+    positionIM?: string;
+    positionMM?: string;
+    tpslMode?: TPSLModeV5;
+    takeProfit?: string;
+    stopLoss?: string;
+    trailingStop?: string;
+    unrealisedPnl: string;
+    cumRealisedPnl: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface SetRiskLimitResultV5 {
+    category: CategoryV5;
+    riskId: number;
+    riskLimitValue: string;
+}
+export interface ExecutionV5 {
+    symbol: string;
+    orderId: string;
+    orderLinkId: string;
+    side: OrderSideV5;
+    orderPrice: string;
+    orderQty: string;
+    leavesQty: string;
+    orderType: OrderTypeV5;
+    stopOrderType?: StopOrderTypeV5;
+    execFee: string;
+    execId: string;
+    execPrice: string;
+    execQty: string;
+    execType: ExecTypeV5;
+    execValue: string;
+    execTime: string;
+    isMaker: boolean;
+    feeRate: string;
+    tradeIv?: string;
+    markIv?: string;
+    markPrice: string;
+    indexPrice: string;
+    underlyingPrice?: string;
+    blockTradeId?: string;
+}
+export interface ClosedPnLV5 {
+    symbol: string;
+    orderId: string;
+    side: string;
+    qty: string;
+    orderPrice: string;
+    orderType: OrderTypeV5;
+    execType: ExecTypeV5;
+    closedSize: string;
+    cumEntryValue: string;
+    avgEntryPrice: string;
+    cumExitValue: string;
+    avgExitPrice: string;
+    closedPnl: string;
+    fillCount: string;
+    leverage: string;
+    createdTime: string;
+    updatedTime: string;
+}

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

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

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

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

package/lib/types/response/v5-spot-leverage-token.d.ts

@@ -0,0 +1,62 @@
+import { LTOrderStatusV5, LTOrderTypeV5, LeverageTokenStatusV5 } from '../v5-shared';
+export interface LeverageTokenInfoV5 {
+    ltCoin: string;
+    ltName: string;
+    maxPurchase: string;
+    minPurchase: string;
+    maxPurchaseDaily: string;
+    maxRedeem: string;
+    minRedeem: string;
+    maxRedeemDaily: string;
+    purchaseFeeRate: string;
+    redeemFeeRate: string;
+    ltStatus: LeverageTokenStatusV5;
+    fundFee: string;
+    fundFeeTime: string;
+    manageFeeRate: string;
+    manageFeeTime: string;
+    value: string;
+    netValue: string;
+    total: string;
+}
+export interface LeveragedTokenMarketResultV5 {
+    ltCoin: string;
+    nav: string;
+    navTime: string;
+    circulation: string;
+    basket: string;
+    leverage: string;
+}
+export interface PurchaseSpotLeveragedTokenResultV5 {
+    ltCoin: string;
+    ltOrderStatus: LTOrderStatusV5;
+    execQty: string;
+    execAmt: string;
+    amount: string;
+    purchaseId: string;
+    serialNo: string;
+    valueCoin: string;
+}
+export interface RedeemSpotLeveragedTokenResultV5 {
+    ltCoin: string;
+    ltOrderStatus: LTOrderStatusV5;
+    quantity: string;
+    execQty: string;
+    execAmt: string;
+    redeemId: string;
+    serialNo: string;
+    valueCoin: string;
+}
+export interface SpotLeveragedTokenOrderHistoryV5 {
+    ltCoin: string;
+    orderId: string;
+    ltOrderType: LTOrderTypeV5;
+    orderTime: number;
+    updateTime: number;
+    ltOrderStatus: LTOrderStatusV5;
+    fee: string;
+    amount: string;
+    value: string;
+    valueCoin: string;
+    serialNo: string;
+}