bitget-api 2.3.6 → 3.0.0

package/dist/cjs/types/request/v3/strategy.d.ts

@@ -0,0 +1,46 @@
+export interface PlaceStrategyOrderRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    clientOid?: string;
+    type?: 'tpsl';
+    tpslMode?: 'full' | 'partial';
+    qty: string;
+    posSide: 'long' | 'short';
+    tpTriggerBy?: 'market' | 'mark';
+    slTriggerBy?: 'market' | 'mark';
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: 'limit' | 'market';
+    slOrderType?: 'limit' | 'market';
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+}
+export interface ModifyStrategyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+    qty: string;
+    tpTriggerBy?: 'market' | 'mark';
+    slTriggerBy?: 'market' | 'mark';
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: 'limit' | 'market';
+    slOrderType?: 'limit' | 'market';
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+}
+export interface CancelStrategyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface GetUnfilledStrategyOrdersRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    type?: 'tpsl';
+}
+export interface GetHistoryStrategyOrdersRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    type?: 'tpsl';
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}

package/dist/cjs/types/request/v3/strategy.js

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

package/dist/cjs/types/request/v3/strategy.js.map

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

package/dist/cjs/types/request/v3/trade.d.ts

@@ -0,0 +1,112 @@
+export interface BatchModifyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+    qty?: string;
+    price?: string;
+    autoCancel?: 'yes' | 'no';
+}
+export interface CancelAllOrdersRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+}
+export interface CancelBatchOrdersRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+}
+export interface CloseAllPositionsRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    posSide?: 'long' | 'short';
+}
+export interface CancelOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface GetMaxOpenAvailableRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    orderType: 'limit' | 'market';
+    side: 'buy' | 'sell';
+    price?: string;
+    size?: string;
+}
+export interface GetOrderInfoRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface GetFillsRequestV3 {
+    orderId?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetUnfilledOrdersRequestV3 {
+    category?: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetHistoryOrdersRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetPositionHistoryRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetCurrentPositionRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    posSide?: 'long' | 'short';
+}
+export interface ModifyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+    qty?: string;
+    price?: string;
+    autoCancel?: 'yes' | 'no';
+}
+export interface PlaceBatchOrdersRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    qty: string;
+    price?: string;
+    side: 'buy' | 'sell';
+    orderType: 'limit' | 'market';
+    timeInForce?: 'ioc' | 'fok' | 'gtc' | 'post_only';
+    posSide?: 'long' | 'short';
+    clientOid?: string;
+    reduceOnly?: 'yes' | 'no';
+}
+export interface PlaceOrderRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    qty: string;
+    price?: string;
+    side: 'buy' | 'sell';
+    orderType: 'limit' | 'market';
+    timeInForce?: 'ioc' | 'fok' | 'gtc' | 'post_only';
+    posSide?: 'long' | 'short';
+    clientOid?: string;
+    reduceOnly?: 'yes' | 'no';
+    stpMode?: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+    takeProfitPrice?: string;
+    stopLossPrice?: string;
+    takeProfitTriggerType?: 'mark_price' | 'last_price';
+    stopLossTriggerType?: 'mark_price' | 'last_price';
+}
+export interface CountdownCancelAllRequestV3 {
+    countdown: string;
+}

package/dist/cjs/types/request/v3/trade.js

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

package/dist/cjs/types/request/v3/trade.js.map

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

package/{lib → dist/cjs}/types/response/v1/futures.d.ts

@@ -1,4 +1,4 @@
-import { FuturesHoldMode, FuturesHoldSide, FuturesMarginMode } from '../../request';
+import { FuturesHoldMode, FuturesHoldSide, FuturesMarginMode } from '../../request/v1/futuresV1.js';
 export interface FuturesMarketTrade {
     tradeId: string;
     price: string;

package/dist/cjs/types/response/v1/futures.js.map

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

package/dist/cjs/types/response/v1/shared.js.map

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

package/dist/cjs/types/response/v1/spot.js.map

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

package/dist/cjs/types/response/v2/broker.js.map

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

package/dist/cjs/types/response/v2/common.js.map

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

package/dist/cjs/types/response/v2/copy-trading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copy-trading.js","sourceRoot":"","sources":["../../../../../src/types/response/v2/copy-trading.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG"}

package/dist/cjs/types/response/v2/earn.js.map

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

package/{lib → dist/cjs}/types/response/v2/futures.d.ts

@@ -76,7 +76,7 @@ export interface FuturesFillV2 {
     ts: string;
     symbol: string;
 }
-export declare type FuturesCandlestickV2 = [
+export type FuturesCandlestickV2 = [
     string,
     string,
     string,

package/dist/cjs/types/response/v2/futures.js.map

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

package/dist/cjs/types/response/v2/margin.js.map

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

package/{lib → dist/cjs}/types/response/v2/spot.d.ts

@@ -84,7 +84,7 @@ export interface SpotOrderBookDepthV2 {
     bids: [string, string][];
     ts: string;
 }
-export declare type SpotCandlestickV2 = [
+export type SpotCandlestickV2 = [
     string,
     string,
     string,

package/dist/cjs/types/response/v2/spot.js.map

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

package/dist/cjs/types/response/v3/account.d.ts

@@ -0,0 +1,197 @@
+export interface AccountSymbolConfigV3 {
+    category: string;
+    symbol: string;
+    marginMode: string;
+    leverage: string;
+}
+export interface AccountCoinConfigV3 {
+    coin: string;
+    leverage: string;
+}
+export interface AccountSettingsV3 {
+    assetMode: string;
+    holdMode: string;
+    symbolConfigList: AccountSymbolConfigV3[];
+    coinConfigList: AccountCoinConfigV3[];
+}
+export interface AccountAssetV3 {
+    coin: string;
+    equity: string;
+    usdValue: string;
+    balance: string;
+    available: string;
+    debt: string;
+    locked: string;
+}
+export interface AccountAssetsV3 {
+    accountEquity: string;
+    usdtEquity: string;
+    btcEquity: string;
+    unrealisedPnl: string;
+    usdtUnrealisedPnl: string;
+    btcUnrealizedPnl: string;
+    effEquity: string;
+    mmr: string;
+    imr: string;
+    mgnRatio: string;
+    positionMgnRatio: string;
+    assets: AccountAssetV3[];
+}
+export interface ConvertRecordV3 {
+    fromCoin: string;
+    fromCoinSize: string;
+    toCoin: string;
+    toCoinSize: string;
+    price: string;
+    ts: string;
+}
+export interface FinancialRecordV3 {
+    category: string;
+    id: string;
+    symbol: string;
+    coin: string;
+    type: string;
+    amount: string;
+    fee: string;
+    balance: string;
+    ts: string;
+}
+export interface PaymentCoinV3 {
+    coin: string;
+    size: string;
+    amount: string;
+}
+export interface RepayableCoinV3 {
+    coin: string;
+    size: string;
+    amount: string;
+}
+export interface RepayResponseV3 {
+    result: string;
+    repayAmount: string;
+}
+export interface CreateSubAccountApiKeyResponseV3 {
+    note: string;
+    apiKey: string;
+    secret: string;
+    type: string;
+    permissions: string[];
+    ips: string[];
+}
+export interface SubAccountApiKeyV3 {
+    apiKey: string;
+    note: string;
+    type: string;
+    permissions: string[];
+    ips: string[];
+    ts?: string;
+}
+export interface UpdateSubAccountApiKeyResponseV3 {
+    note: string;
+    apiKey: string;
+    type: string;
+    permissions: string[];
+    ips: string[];
+}
+export interface CreateSubAccountResponseV3 {
+    username: string;
+    subUid: string;
+    status: string;
+    note: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface SubAccountV3 {
+    subUid: string;
+    username: string;
+    status: string;
+    accountMode: string;
+    type: string;
+    note: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface TransferResponseV3 {
+    transferId: string;
+}
+export interface SubTransferRecordV3 {
+    transferId: string;
+    oldTransferId?: string;
+    fromType: string;
+    toType: string;
+    amount: string;
+    coin: string;
+    fromUserId: string;
+    toUserId: string;
+    status: string;
+    clientOid: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface SubUnifiedAssetV3 {
+    coin: string;
+    equity: string;
+    usdValue: string;
+    balance: string;
+    available: string;
+    debt: string;
+    locked: string;
+}
+export interface SubUnifiedAssetV3 {
+    subUid: string;
+    cursor: string;
+    assets: SubUnifiedAssetV3[];
+}
+export interface GetFeeRateResponseV3 {
+    makerFeeRate: string;
+    takerFeeRate: string;
+}
+export interface FundingAssetV3 {
+    coin: string;
+    available: string;
+    frozen: string;
+    balance: string;
+}
+export interface DepositAddressV3 {
+    address: string;
+    chain: string;
+    coin: string;
+    tag: string;
+    url: string;
+}
+export interface DepositRecordV3 {
+    orderId: string;
+    recordId: string;
+    coin: string;
+    type: 'deposit';
+    dest: 'on_chain' | 'internal_transfer';
+    size: string;
+    status: 'pending' | 'success' | 'fail';
+    fromAddress: string;
+    toAddress: string;
+    chain: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface WithdrawResponseV3 {
+    orderId: string;
+    clientOid: string;
+}
+export interface WithdrawRecordV3 {
+    orderId: string;
+    clientOid: string;
+    recordId: string;
+    coin: string;
+    type: 'withdraw';
+    dest: 'on_chain' | 'internal_transfer';
+    size: string;
+    status: 'pending' | 'success' | 'fail';
+    fromAddress: string;
+    toAddress: string;
+    chain: string;
+    fee: string;
+    confirm: string;
+    tag: string;
+    createdTime: string;
+    updatedTime: string;
+}

package/dist/cjs/types/response/v3/account.js

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

package/dist/cjs/types/response/v3/account.js.map

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

package/dist/cjs/types/response/v3/loan.d.ts

@@ -0,0 +1,85 @@
+export interface LoanTransfersV3 {
+    coin: string;
+    transfered: string;
+    userId: string;
+}
+export interface LoanSymbolSettingV3 {
+    symbol: string;
+    leverage: string;
+}
+export interface LoanSymbolsV3 {
+    productId: string;
+    spotSymbols: string[];
+    usdtContractLeverage: string;
+    coinContractLeverage: string;
+    usdcContractLeverage: string;
+    usdtContractSymbols: LoanSymbolSettingV3[];
+    coinContractSymbols: LoanSymbolSettingV3[];
+    usdcContractSymbols: LoanSymbolSettingV3[];
+}
+export interface RepaidHistoryItemV3 {
+    repayOrderId: string;
+    businessType: 'normal' | 'liquidation';
+    repayType: 'all' | 'part';
+    repaidTime: string;
+    coin: string;
+    repayAmount: string;
+    repayInterest: string;
+}
+export interface LoanProductInfoV3 {
+    productId: string;
+    leverage: string;
+    supportUsdtContract: 'YES' | 'NO';
+    supportCoinContract: 'YES' | 'NO';
+    supportUsdcContract: 'YES' | 'NO';
+    transferLine: string;
+    spotBuyLine: string;
+    usdtContractOpenLine: string;
+    coinContractOpenLine: string;
+    usdcContractOpenLine: string;
+    liquidationLine: string;
+    stopLiquidationLine: string;
+}
+export interface LoanOrderV3 {
+    orderId: string;
+    orderProductId: string;
+    uid: string;
+    loanTime: string;
+    loanCoin: string;
+    loanAmount: string;
+    unpaidAmount: string;
+    unpaidInterest: string;
+    repaidAmount: string;
+    repaidInterest: string;
+    reserve: string;
+    status: 'not_paid_off' | 'paid_off';
+}
+export interface CoinInfoV3 {
+    coin: string;
+    convertRatio: string;
+    maxConvertValue: string;
+}
+export interface BindUidResponseV3 {
+    riskUnitId: string;
+    uid: string;
+    operate: 'bind' | 'unbind';
+}
+export interface UnpaidInfoV3 {
+    coin: string;
+    unpaidQty: string;
+    unpaidInterest: string;
+}
+export interface BalanceInfoV3 {
+    coin: string;
+    price: string;
+    amount: string;
+    convertedUsdtAmount: string;
+}
+export interface LTVConvertResponseV3 {
+    ltv: string;
+    subAccountUids: string[];
+    unpaidUsdtAmount: string;
+    usdtBalance: string;
+    unpaidInfo: UnpaidInfoV3[];
+    balanceInfo: BalanceInfoV3[];
+}

package/dist/cjs/types/response/v3/loan.js

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

package/dist/cjs/types/response/v3/loan.js.map

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

package/dist/cjs/types/response/v3/public.d.ts

@@ -0,0 +1,142 @@
+export interface PublicFillV3 {
+    execId: string;
+    price: string;
+    size: string;
+    side: 'sell' | 'buy';
+    ts: string;
+}
+export interface CandlestickV3 extends Array<string> {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+    6: string;
+}
+export interface ContractOiV3 {
+    symbol: string;
+    notionalValue: string;
+    totalNotionalValue: string;
+}
+export interface CurrentFundingRateV3 {
+    symbol: string;
+    fundingRate: string;
+    fundingRateInterval: string;
+    nextUpdate: string;
+    minFundingRate: string;
+    maxFundingRate: string;
+}
+export interface DiscountRateTierV3 {
+    tierStartValue: string;
+    discountRate: string;
+}
+export interface DiscountRateV3 {
+    coin: string;
+    list: DiscountRateTierV3[];
+}
+export interface HistoryFundingRateV3 {
+    symbol: string;
+    fundingRate: string;
+    fundingRateTimestamp: string;
+}
+export interface MarginLoanV3 {
+    dailyInterest: string;
+    annualInterest: string;
+    limit: string;
+}
+export interface OpenInterestItemV3 {
+    symbol: string;
+    openInterest: string;
+}
+export interface OpenInterestV3 {
+    list: OpenInterestItemV3[];
+    ts: string;
+}
+export interface PositionTierV3 {
+    tier: string;
+    minTierValue: string;
+    maxTierValue: string;
+    leverage: string;
+    mmr: string;
+}
+export interface RiskReserveRecordV3 {
+    type: 'in' | 'out';
+    amount: string;
+    ts: string;
+}
+export interface RiskReserveV3 {
+    coin: string;
+    riskReserveRecords: RiskReserveRecordV3[];
+}
+export interface InstrumentV3 {
+    symbol: string;
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    baseCoin: string;
+    quoteCoin: string;
+    buyLimitPriceRatio: string;
+    sellLimitPriceRatio: string;
+    feeRateUpRatio: string;
+    minOrderQty: string;
+    maxOrderQty: string;
+    maxMarketOrderQty: string;
+    pricePrecision: string;
+    quantityPrecision: string;
+    quotePrecision: string;
+    minOrderAmount: string;
+    maxSymbolOrderNum: string;
+    maxProductOrderNum: string;
+    status: 'listed' | 'online' | 'limit_open' | 'offline' | 'restrictedAPI';
+    offTime: string;
+    limitOpenTime: string;
+    maintainTime: string;
+    areaSymbol?: string;
+    makerFeeRate?: string;
+    takerFeeRate?: string;
+    openCostUpRatio?: string;
+    priceMultiplier?: string;
+    quantityMultiplier?: string;
+    symbolType?: 'perpetual' | 'delivery';
+    maxPositionNum?: string;
+    deliveryTime?: string;
+    deliveryStartTime?: string;
+    deliveryPeriod?: string;
+    launchTime?: string;
+    fundInterval?: string;
+    minLeverage?: string;
+    maxLeverage?: string;
+    isIsolatedBaseBorrowable?: 'YES' | 'NO';
+    isIsolatedQuotedBorrowable?: 'YES' | 'NO';
+    warningRiskRatio?: string;
+    liquidationRiskRatio?: string;
+    maxCrossedLeverage?: string;
+    maxIsolatedLeverage?: string;
+    userMinBorrow?: string;
+}
+export interface OrderBookV3 {
+    a: string[][];
+    b: string[][];
+    ts: string;
+}
+export interface TickerV3 {
+    category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    lastPrice: string;
+    openPrice24h: string;
+    highPrice24h: string;
+    lowPrice24h: string;
+    ask1Price: string;
+    bid1Price: string;
+    bid1Size: string;
+    ask1Size: string;
+    price24hPcnt: string;
+    volume24h: string;
+    turnover24h: string;
+    indexPrice?: string;
+    markPrice?: string;
+    fundingRate?: string;
+    openInterest?: string;
+    deliveryStartTime?: string;
+    deliveryTime?: string;
+    deliveryStatus?: string;
+}

package/dist/cjs/types/response/v3/public.js

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

package/dist/cjs/types/response/v3/public.js.map

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