bitget-api 3.1.6 → 3.1.8

package/dist/mjs/types/response/v2/earn.d.ts

@@ -292,3 +292,118 @@ export interface EarnLoanLiquidationRecordsV2 {
     runlockAmount: string;
     repayLoanAmount: string;
 }
+/**
+ *
+ *
+ * Earn | On-Chain Elite
+ *
+ *
+ */
+export interface EarnEliteSubscriptionCoinV2 {
+    subscriptionCoin: string;
+    precision: string;
+    feeRate: string;
+    exchangeRate: string;
+    remainQuota?: string;
+    minAmount?: string;
+}
+export interface EarnEliteProductV2 {
+    productId: string;
+    coin: string;
+    minApr: string;
+    maxApr: string;
+    subscriptionCoinList: EarnEliteSubscriptionCoinV2[];
+    sellOut: 'YES' | 'NO' | string;
+}
+export interface EarnEliteAssetProjectV2 {
+    projectName: string;
+}
+export interface EarnEliteAssetV2 {
+    productId: string;
+    productCoin: string;
+    holdingAmount: string;
+    usdtHoldingAmount: string;
+    exchangeRate: string;
+    apr: string;
+    minApy?: string;
+    maxApy?: string;
+    subscriptionCoin: string;
+    exchangeAmount: string;
+    projectList?: EarnEliteAssetProjectV2[];
+    unsettledBGPoints: string;
+    interestCoin: string;
+    totalProfit: string;
+}
+export interface EarnEliteAssetsV2 {
+    resultList: EarnEliteAssetV2[];
+}
+export interface EarnEliteRecordV2 {
+    recordId: string;
+    productId: string;
+    coin: string;
+    status: string;
+    exchangeRate: string;
+    receivedCoin: string;
+    receivedAmount: string;
+    investAmount: string;
+    feeRate: string;
+    redeemType?: string | string[];
+    receivingAccount: string;
+    actualReceivingAccount: string;
+    paymentAccount?: string[];
+    settlePoints: string;
+    fee: string;
+}
+export interface EarnEliteRecordsV2 {
+    recordList: EarnEliteRecordV2[];
+    endId: string;
+}
+export interface EarnEliteSubscribeInfoV2 {
+    productSubId: string;
+    minAmount: string;
+    remainQuota: string;
+    exchangeRate: string;
+    productCoin: string;
+    interestTime: string;
+    settleTime: string;
+    precision: string;
+    feeRate: string;
+    /** Present for BGUSD per API docs. */
+    subscriptionCoinList?: EarnEliteSubscriptionCoinV2[];
+}
+export interface EarnEliteSubscribeResultV2 {
+    orderId: string;
+}
+export interface EarnEliteSubscribeStatusV2 {
+    result: 'settled' | 'pending' | 'rejected' | string;
+}
+export interface EarnEliteRedeemInfoBgusdReceiveCoinV2 {
+    bgusdReceiveCoin: string;
+    bgusdExchangeRate: string;
+}
+export interface EarnEliteRedeemModeV2 {
+    redeemFeeRate: string;
+    remainQuota: string;
+    redeemType: 'fast' | 'standard' | string;
+    redeemScale: string;
+    redeemDelayDate: string;
+    minRedeemAmount: string;
+    redeemTime: string;
+}
+export interface EarnEliteRedeemInfoV2 {
+    productId: string;
+    productSubId: string;
+    productCoin: string;
+    subscriptionCoin: string;
+    profitCoin: string;
+    exchangeRate: string;
+    totalUnPayInterestAmount: string;
+    preSettleApr: string;
+    receivedCoin: string;
+    unsettledPoints: string;
+    bgusdReceiveCoinList: EarnEliteRedeemInfoBgusdReceiveCoinV2[];
+    redeemModeList: EarnEliteRedeemModeV2[];
+}
+export interface RedeemEarnEliteResultV2 {
+    orderId: string;
+}

package/dist/mjs/types/response/v2/spot.d.ts

@@ -43,6 +43,8 @@ export interface SpotSymbolInfoV2 {
     sellLimitPriceRatio: string;
     orderQuantity: string;
     areaSymbol: string;
+    maxLimitOrderValue?: string;
+    maxMarketOrderValue?: string;
 }
 export interface SpotVipFeeRateV2 {
     level: number;

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

@@ -8,12 +8,41 @@ export interface AccountCoinConfigV3 {
     coin: string;
     leverage: string;
 }
+export type AccountPermissionV3 = 'uta_mgt' | 'uta_trade' | 'withdraw' | 'copy_futures_position' | 'copy_futures_order';
+export interface AccountInfoV3 {
+    userId: string;
+    inviterId: string;
+    /** Only set when the calling account is a sub-account */
+    parentId: string;
+    channelCode: string;
+    channel: string;
+    ips: string;
+    permType: 'read-only' | 'read-and-write';
+    permissions: AccountPermissionV3[];
+    regisTime: string;
+}
+export type AccountLevelV3 = 'basic' | 'advanced' | 'isolated' | 'delta';
 export interface AccountSettingsV3 {
+    uid: string;
+    accountMode: 'unified' | 'hybrid' | 'upgrading' | 'switching';
     assetMode: string;
+    accountLevel: AccountLevelV3;
     holdMode: string;
+    stpMode: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
     symbolConfigList: AccountSymbolConfigV3[];
     coinConfigList: AccountCoinConfigV3[];
 }
+export interface AccountDeltaCoinPositionV3 {
+    coin: string;
+    positionRatio: string;
+}
+/** Delta-neutral mode metrics. Only available when accountLevel is delta. */
+export interface AccountDeltaInfoV3 {
+    deltaEquityRatio: string;
+    deltaThreshold: string;
+    positionThreshold: string;
+    list: AccountDeltaCoinPositionV3[];
+}
 export interface AccountAssetV3 {
     coin: string;
     equity: string;
@@ -106,11 +135,26 @@ export interface SubAccountV3 {
     username: string;
     status: string;
     accountMode: string;
-    type: string;
+    type: 'normal' | 'virtual' | 'custodian';
     note: string;
     createdTime: string;
     updatedTime: string;
 }
+export interface WithdrawAddressBookEntryV3 {
+    coin: string;
+    chain: string;
+    address: string;
+    countryCode: string;
+    label: string;
+    memo: string;
+    type: 'regular' | 'EVM' | 'universal' | 'internal';
+    internalType: '' | 'uid' | 'mobile' | 'email';
+    createdTime: string;
+}
+export interface WithdrawAddressBookV3 {
+    addressList: WithdrawAddressBookEntryV3[];
+    cursor?: string;
+}
 export interface TransferResponseV3 {
     transferId: string;
 }

package/dist/mjs/types/response/v3/broker.d.ts

@@ -73,7 +73,7 @@ export interface CreateBrokerSubApiKeyResponseV3 {
     label: string;
     apiKey: string;
     secretKey: string;
-    permType: 'read_and_write' | 'readonly';
+    permType: 'read_write' | 'read_only';
     permList: string[];
     ipList: string[] | null;
 }
@@ -81,7 +81,7 @@ export interface ModifyBrokerSubApiKeyResponseV3 {
     subUid: string;
     label: string;
     apiKey: string;
-    permType: 'read_and_write' | 'readonly';
+    permType: 'read_write' | 'read_only';
     permList: string[];
     ipList: string[];
 }
@@ -90,7 +90,7 @@ export interface GetBrokerSubApiKeyResponseV3 {
     label: string;
     apiKey: string;
     secretKey: string;
-    permType: 'read_and_write' | 'readonly';
+    permType: 'read_write' | 'read_only';
     permList: string[];
     ipList: string[] | null;
 }

package/dist/mjs/types/response/v3/copytrading.d.ts

@@ -0,0 +1,54 @@
+/**
+ *
+ *
+ * Copy Trading | Futures (UTA)
+ *
+ *
+ */
+export interface CopyFuturesMarginDetailV3 {
+    marginCoin: string;
+    maxLongCount: string;
+    remainingLongCount: string;
+    maxShortCount: string;
+    remainingShortCount: string;
+}
+export interface CopyFuturesTradingPairV3 {
+    symbol: string;
+    leverage: string;
+    marginDetails: CopyFuturesMarginDetailV3[];
+}
+export interface CopyFuturesPositionSummaryV3 {
+    unrealizedPnl: string;
+    realizedPnl: string;
+    holdSize: string;
+    avgPrice: string;
+    symbol: string;
+    leverage: string;
+    marginMode: string;
+    liqPrice: string;
+    margin: string;
+    holdSide: string;
+    roi: string;
+    markPrice: string;
+    positionValue: string;
+}
+export interface CopyFuturesMaxTransferableV3 {
+    maxTransferable: string;
+    available: string;
+}
+export interface CopyFuturesTransferResponseV3 {
+    transferId: string;
+}
+export type CopyFuturesTransferAccountTypeV3 = 'spot' | 'uta' | 'lead';
+export interface CopyFuturesTransferRecordV3 {
+    transferId: string;
+    fromType: CopyFuturesTransferAccountTypeV3;
+    toType: CopyFuturesTransferAccountTypeV3;
+    amount: string;
+    coin: string;
+    status: 'Successful' | 'Failed' | 'Processing';
+    createdTime: string;
+}
+export interface CopyFuturesTransferRecordListV3 {
+    list: CopyFuturesTransferRecordV3[];
+}

package/dist/mjs/types/response/v3/copytrading.js

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * Copy Trading | Futures (UTA)
+ *
+ *
+ */
+export {};
+//# sourceMappingURL=copytrading.js.map

package/dist/mjs/types/response/v3/copytrading.js.map

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

package/dist/mjs/types/response/v3/earn.d.ts

@@ -0,0 +1,114 @@
+/**
+ *
+ *
+ * Earn | On-Chain Elite (UTA)
+ *
+ *
+ */
+export interface EarnEliteSubscriptionCoinV3 {
+    subscriptionCoin: string;
+    precision: string;
+    feeRate: string;
+    exchangeRate: string;
+    remainQuota?: string;
+    minAmount?: string;
+}
+export interface EarnEliteProductV3 {
+    productId: string;
+    coin: string;
+    minApr: string;
+    maxApr: string;
+    subscriptionCoinList: EarnEliteSubscriptionCoinV3[];
+    sellOut: 'YES' | 'NO' | string;
+}
+export interface EarnEliteAssetProjectV3 {
+    projectName: string;
+}
+export interface EarnEliteAssetV3 {
+    productId: string;
+    productCoin: string;
+    holdingAmount: string;
+    usdtHoldingAmount: string;
+    exchangeRate: string;
+    apr: string;
+    minApy?: string;
+    maxApy?: string;
+    subscriptionCoin: string;
+    exchangeAmount: string;
+    projectList?: EarnEliteAssetProjectV3[];
+    unsettledBGPoints: string;
+    interestCoin: string;
+    totalProfit: string;
+}
+export interface EarnEliteAssetsV3 {
+    resultList: EarnEliteAssetV3[];
+}
+export interface EarnEliteRecordV3 {
+    recordId: string;
+    productId: string;
+    coin: string;
+    status: string;
+    exchangeRate: string;
+    receivedCoin: string;
+    receivedAmount: string;
+    investAmount: string;
+    feeRate: string;
+    redeemType?: string | string[];
+    receivingAccount: string;
+    actualReceivingAccount: string;
+    paymentAccount?: string[];
+    settlePoints: string;
+    fee: string;
+}
+export interface EarnEliteRecordsV3 {
+    recordList: EarnEliteRecordV3[];
+    endId: string;
+}
+export interface EarnEliteSubscribeInfoV3 {
+    productSubId: string;
+    minAmount: string;
+    remainQuota: string;
+    exchangeRate: string;
+    productCoin: string;
+    interestTime: string;
+    settleTime: string;
+    precision: string;
+    feeRate: string;
+    subscriptionCoinList?: EarnEliteSubscriptionCoinV3[];
+}
+export interface EarnEliteSubscribeResultV3 {
+    orderId: string;
+}
+export interface EarnEliteSubscribeStatusV3 {
+    result: 'settled' | 'pending' | 'rejected' | string;
+}
+export interface EarnEliteRedeemInfoBgusdReceiveCoinV3 {
+    bgusdReceiveCoin: string;
+    bgusdExchangeRate: string;
+}
+export interface EarnEliteRedeemModeV3 {
+    redeemFeeRate: string;
+    remainQuota: string;
+    redeemType: 'fast' | 'standard' | string;
+    redeemScale: string;
+    redeemDelayDate: string;
+    minRedeemAmount: string;
+    redeemTime: string;
+}
+export interface EarnEliteRedeemInfoV3 {
+    productId: string;
+    productSubId: string;
+    productCoin: string;
+    subscriptionCoin: string;
+    profitCoin: string;
+    exchangeRate: string;
+    totalUnPayInterestAmount: string;
+    preSettleApr: string;
+    receivedCoin: string;
+    unsettledPoints: string;
+    bgusdReceiveCoinList: EarnEliteRedeemInfoBgusdReceiveCoinV3[];
+    redeemModeList: EarnEliteRedeemModeV3[];
+}
+export interface RedeemEarnEliteResultV3 {
+    orderId: string;
+}

package/dist/mjs/types/response/v3/earn.js

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * Earn | On-Chain Elite (UTA)
+ *
+ *
+ */
+export {};
+//# sourceMappingURL=earn.js.map

package/dist/mjs/types/response/v3/earn.js.map

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

package/dist/mjs/types/response/v3/p2p.d.ts

@@ -0,0 +1,202 @@
+import type { P2pAdStatusV3, P2pMarketTypeV3, P2pOrderStatusV3, P2pPriceTypeV3, P2pSideV3 } from '../../request/v3/p2p.js';
+export interface P2pPayMethodInfoFieldV3 {
+    name: string;
+    type: 'file' | 'number' | 'txt';
+    value: string;
+}
+export interface P2pPayMethodV3 {
+    payMethodId: string;
+    payMethodName: string;
+    payMethodUserName: string;
+    userPayMethodId: string;
+    payMethodInfo: P2pPayMethodInfoFieldV3[];
+}
+export interface P2pTokenDetailV3 {
+    token: string;
+    precision: string;
+}
+export interface P2pFiatPayMethodV3 {
+    payMethodName: string;
+    iconUrl: string;
+    payMethodId: string;
+}
+export interface P2pWithdrawalLimitV3 {
+    withdrawLimitKey: string;
+    withdrawLimitValue: string;
+}
+export interface P2pFiatDetailV3 {
+    fiat: string;
+    precision: string;
+    floatRateMin: string;
+    floatRateMax: string;
+    fixedRateMin: string;
+    fixedRateMax: string;
+    adMinLimit: string;
+    adMaxLimit: string;
+    payMethods: P2pFiatPayMethodV3;
+    withdrawalLimit: P2pWithdrawalLimitV3;
+    payTimeLimit: number[];
+}
+export interface P2pCurrenciesV3 {
+    tokenDetailList: P2pTokenDetailV3[];
+    fiatDetailList: P2pFiatDetailV3[];
+}
+export interface P2pUserEquityDetailV3 {
+    maxAdvSellNum: string;
+    maxAdvSellLimit: string;
+    maxAdvBuyNum: string;
+    maxAdvBuyLimit: string;
+    totalMaxPendingOrder: string;
+    advMaxPendingOrder: string;
+}
+export interface P2pUserInfoV3 {
+    uid: string;
+    nickName: string;
+    accountLevel: 'starter' | 'advanced' | 'master';
+    completedOrderNum: string;
+    positiveRate: string;
+    completedOrderNum30D: string;
+    completedRate30D: string;
+    avgPayTime30D: string;
+    avgReleaseTime30D: string;
+    equityDetail: P2pUserEquityDetailV3;
+    registerTime: string;
+}
+export interface P2pBalanceV3 {
+    token: string;
+    totalBalance: string;
+    frozenBalance: string;
+    availableBalance: string;
+}
+export interface P2pExchangeRateV3 {
+    rate: string;
+}
+export interface P2pFeeSimulateV3 {
+    feeToken: string;
+    feeAmount: string;
+    taxToken: string;
+    taxAmount: string;
+}
+export interface P2pAdLimitV3 {
+    buyMinTokenAmount: string;
+    buyMaxTokenAmount: string;
+    sellMinTokenAmount: string;
+    sellMaxTokenAmount: string;
+}
+export interface P2pCreateAdResponseV3 {
+    advId: string;
+}
+export interface P2pAdPayMethodRefV3 {
+    payMethodId: string;
+    userPayMethodId?: string;
+}
+export interface P2pAdInfoV3 {
+    advId: string;
+    side: P2pSideV3;
+    priceType: P2pPriceTypeV3;
+    token: string;
+    fiat: string;
+    price: string;
+    amount: string;
+    minAmount: string;
+    maxAmount: string;
+    payDuration: string;
+    soldAmount: string;
+    lastAmount: string;
+    premium: string;
+    turnover: string;
+    remark: string;
+    tradeTerm: string;
+    payMethodIds: P2pAdPayMethodRefV3[];
+    tokenPrecision: string;
+    fiatPrecision: string;
+    market: P2pMarketTypeV3;
+    avgTime: string;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface P2pPublicAdListItemV3 {
+    advId: string;
+    merchantId: string;
+    merchantName: string;
+    token: string;
+    fiat: string;
+    side: P2pSideV3;
+    price: string;
+    minAmount: string;
+    maxAmount: string;
+    quantity: string;
+    payMethods: {
+        payMethodId: string;
+        payMethodName: string;
+    }[];
+    completedOrderNum: string;
+    completedRate: string;
+    avgReleaseTime: string;
+    createdTime: string;
+}
+export interface P2pMyAdListItemV3 {
+    advId: string;
+    side: P2pSideV3;
+    priceType: P2pPriceTypeV3;
+    token: string;
+    fiat: string;
+    price: string;
+    soldAmount: string;
+    lastAmount: string;
+    payMethods: {
+        payMethodId: string;
+    }[];
+    status: P2pAdStatusV3;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface P2pCursorListV3<T> {
+    items: T[];
+    nextId?: string;
+}
+export interface P2pOrderListItemV3 {
+    orderId: string;
+    side: P2pSideV3;
+    token: string;
+    fiat: string;
+    price: string;
+    amount: string;
+    quantity: string;
+    fee: string;
+    counterparty: string;
+    status: P2pOrderStatusV3;
+    createdTime: string;
+    updatedTime: string;
+}
+export interface P2pOrderPayMethodDetailV3 {
+    payMethodId: string;
+    payMethodName: string;
+    payMethodUserName: string;
+    postscript: string;
+    payMethodInfo: P2pPayMethodInfoFieldV3[];
+}
+export interface P2pOrderUserInfoV3 {
+    nickName: string;
+    realName: string;
+}
+export interface P2pOrderInfoV3 {
+    orderId: string;
+    side: P2pSideV3;
+    token: string;
+    fiat: string;
+    price: string;
+    quantity: string;
+    amount: string;
+    status: P2pOrderStatusV3;
+    advId: string;
+    remark: string;
+    orderCancelCountdown: string;
+    fee: string;
+    verifyCapital: 'yes' | 'no';
+    payMethodDetail?: P2pOrderPayMethodDetailV3;
+    sellUserInfo: P2pOrderUserInfoV3;
+    buyUserInfo: P2pOrderUserInfoV3;
+    createdTime: string;
+    updatedTime: string;
+}

package/dist/mjs/types/response/v3/p2p.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=p2p.js.map

package/dist/mjs/types/response/v3/p2p.js.map

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

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

@@ -64,11 +64,30 @@ export interface RiskReserveRecordV3 {
     balance: string;
     amount: string;
     ts: string;
+    type?: string;
 }
 export interface RiskReserveV3 {
+    totalBalance?: string;
     coin: string;
     riskReserveRecords: RiskReserveRecordV3[];
 }
+export interface RiskReserveHourRecordV3 {
+    amount: string;
+    balance: string;
+    ts: string;
+}
+export interface RiskReserveHourV3 {
+    coin: string;
+    riskReserveRecords: RiskReserveHourRecordV3[];
+}
+export interface RiskReserveAllItemV3 {
+    symbols: string[];
+    coin: string;
+    balance: string;
+}
+export interface RiskReserveAllV3 {
+    list: RiskReserveAllItemV3[];
+}
 export interface InstrumentV3 {
     symbol: string;
     category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';

package/dist/mjs/types/response/v3/strategy.d.ts

@@ -1,3 +1,4 @@
+import type { StrategyOrderStatusV3, StrategyTriggerByV3, StrategyTriggerOrderTypeV3 } from '../../request/v3/strategy.js';
 export interface PlaceStrategyOrderResponseV3 {
     orderId: string;
     clientOid: string;
@@ -13,14 +14,20 @@ export interface StrategyOrderV3 {
     symbol: string;
     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;
+    status: StrategyOrderStatusV3;
+    triggerType?: 'takeProfit' | 'stopLoss';
+    tpTriggerBy?: StrategyTriggerByV3;
+    slTriggerBy?: StrategyTriggerByV3;
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: StrategyTriggerOrderTypeV3;
+    slOrderType?: StrategyTriggerOrderTypeV3;
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+    triggerBy?: StrategyTriggerByV3;
+    triggerPrice?: string;
+    triggerOrderType?: StrategyTriggerOrderTypeV3;
+    triggerOrderPrice?: string;
     createdTime: string;
     updatedTime: string;
 }