bitget-api 3.1.6 → 3.1.8

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

@@ -1,32 +1,47 @@
+export type StrategyOrderTypeV3 = 'tpsl' | 'trigger';
+export type StrategyOrderStatusV3 = 'pending' | 'success' | 'failed' | 'cancelled' | 'submitting';
+export type StrategyTriggerByV3 = 'market' | 'mark';
+export type StrategyTriggerOrderTypeV3 = 'limit' | 'market';
 export interface PlaceStrategyOrderRequestV3 {
     category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
     symbol: string;
     clientOid?: string;
-    type?: 'tpsl';
+    type?: StrategyOrderTypeV3;
     tpslMode?: 'full' | 'partial';
-    qty: string;
-    posSide: 'long' | 'short';
-    tpTriggerBy?: 'market' | 'mark';
-    slTriggerBy?: 'market' | 'mark';
+    /** Required when tpslMode=partial or for trigger orders */
+    qty?: string;
+    side?: 'buy' | 'sell';
+    posSide?: 'long' | 'short';
+    reduceOnly?: 'yes' | 'no';
+    tpTriggerBy?: StrategyTriggerByV3;
+    slTriggerBy?: StrategyTriggerByV3;
     takeProfit?: string;
     stopLoss?: string;
-    tpOrderType?: 'limit' | 'market';
-    slOrderType?: 'limit' | 'market';
+    tpOrderType?: StrategyTriggerOrderTypeV3;
+    slOrderType?: StrategyTriggerOrderTypeV3;
     tpLimitPrice?: string;
     slLimitPrice?: string;
+    triggerBy?: StrategyTriggerByV3;
+    triggerPrice?: string;
+    triggerOrderType?: StrategyTriggerOrderTypeV3;
+    triggerOrderPrice?: string;
 }
 export interface ModifyStrategyOrderRequestV3 {
     orderId?: string;
     clientOid?: string;
     qty: string;
-    tpTriggerBy?: 'market' | 'mark';
-    slTriggerBy?: 'market' | 'mark';
+    tpTriggerBy?: StrategyTriggerByV3;
+    slTriggerBy?: StrategyTriggerByV3;
     takeProfit?: string;
     stopLoss?: string;
-    tpOrderType?: 'limit' | 'market';
-    slOrderType?: 'limit' | 'market';
+    tpOrderType?: StrategyTriggerOrderTypeV3;
+    slOrderType?: StrategyTriggerOrderTypeV3;
     tpLimitPrice?: string;
     slLimitPrice?: string;
+    triggerBy?: StrategyTriggerByV3;
+    triggerPrice?: string;
+    triggerOrderType?: StrategyTriggerOrderTypeV3;
+    triggerOrderPrice?: string;
 }
 export interface CancelStrategyOrderRequestV3 {
     orderId?: string;
@@ -34,11 +49,11 @@ export interface CancelStrategyOrderRequestV3 {
 }
 export interface GetUnfilledStrategyOrdersRequestV3 {
     category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-    type?: 'tpsl';
+    type?: StrategyOrderTypeV3;
 }
 export interface GetHistoryStrategyOrdersRequestV3 {
     category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
-    type?: 'tpsl';
+    type?: StrategyOrderTypeV3;
     startTime?: string;
     endTime?: string;
     limit?: string;

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

@@ -90,6 +90,7 @@ export interface PlaceBatchOrdersRequestV3 {
     clientOid?: string;
     reduceOnly?: 'yes' | 'no';
 }
+export type FuturesMarginModeV3 = 'crossed' | 'isolated';
 export interface PlaceOrderRequestV3 {
     category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
     symbol: string;
@@ -101,6 +102,8 @@ export interface PlaceOrderRequestV3 {
     posSide?: 'long' | 'short';
     clientOid?: string;
     reduceOnly?: 'yes' | 'no';
+    /** Futures only. Defaults to crossed */
+    marginMode?: FuturesMarginModeV3;
     stpMode?: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
     takeProfitPrice?: string;
     stopLossPrice?: string;

package/dist/cjs/types/response/v2/broker.d.ts

@@ -243,3 +243,101 @@ export interface BrokerRebateInfoV2 {
     clientSpotRebateRatio: string;
     clientFuturesRebateRatio: string;
 }
+/**
+ *
+ * * Broker | Agent (affiliate) customer APIs
+ *
+ */
+export interface AgentCustomerCommissionItemV2 {
+    uid: string;
+    date: string;
+    coin: string;
+    symbol: string;
+    productType: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES' | string;
+    dealAmount: string;
+    fee: string;
+    feeDeduction: string;
+    activityBonusDeduct: string;
+    spotCouponDeduct: string;
+    futuresCouponDeduct: string;
+    spotFeeDiscountDeduct: string;
+    negativeMakerFeeDeduct: string;
+    feePaid: string;
+    rebateAmount: string;
+    userTotalRebateAmount: string;
+    dayTotalRebateAmount: string;
+    totalRebateAmount: string;
+}
+export interface AgentCustomerCommissionsV2 {
+    endId: string;
+    commissionList: AgentCustomerCommissionItemV2[];
+}
+export interface AgentSubCustomerItemV2 {
+    uid: string;
+    registerTime: string;
+}
+export interface AgentSubCustomerListV2 {
+    list: AgentSubCustomerItemV2[];
+    minId: string;
+}
+export interface AgentCustomerTradeVolumeItemV2 {
+    uid: string;
+    /** API field name (Bitget spelling). */
+    volumn: string;
+    spotVolume: string;
+    futuresVolume: string;
+    time: string;
+}
+export interface AgentCustomerListItemV2 {
+    uid: string;
+    registerTime: string;
+}
+export interface AgentCustomerKycItemV2 {
+    uid: string;
+    kycResult: 'passed' | 'not_passed' | string;
+}
+export interface AgentCustomerKycResultV2 {
+    userList: AgentCustomerKycItemV2[];
+    endId: string;
+}
+export interface AgentCustomerDepositItemV2 {
+    orderId: string;
+    uid: string;
+    depositTime: string;
+    depositCoin: string;
+    depositAmount: string;
+}
+export interface AgentCustomerAssetItemV2 {
+    balance: string;
+    uid: string;
+    uTime: string;
+    remark: string;
+}
+export interface AgentCommissionDetailItemV2 {
+    uid: string;
+    bizType: 'spot' | 'futures' | string;
+    subBizType: string;
+    symbol: string;
+    coin: string;
+    fee: string;
+    volume: string;
+    activityBonusDeduct: string;
+    spotCouponDeduct: string;
+    futuresCouponDeduct: string;
+    spotFeeDiscountDeduct: string;
+    negativeMakerFeeDeduct: string;
+    feePaid: string;
+    directCommission: string;
+    subCommission: string;
+    partnerCommission: string;
+    partnerActualCommission: string;
+    traderType: string;
+    apiType: string;
+    status: 'settled' | 'unsettled' | 'notIssued' | string;
+    startCalculationTime: string;
+    endCalculationTime: string;
+}
+export interface AgentCommissionDetailV2 {
+    endId: string;
+    commissionList: AgentCommissionDetailItemV2[];
+}

package/dist/cjs/types/response/v2/common.d.ts

@@ -283,6 +283,14 @@ export interface ModifyVirtualSubAccountApiKeyV2 {
     permList: string[];
     ipList: string[];
 }
+export interface CreateAgentSubaccountV2 {
+    username: string;
+    subUid: string;
+    apiKey: string;
+    secret: string;
+    note: string;
+    createdTime: string;
+}
 export interface SubAccountApiKeyItemV2 {
     subAccountUid: string;
     label: string;

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/types/response/v3/copytrading.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ *
+ * Copy Trading | Futures (UTA)
+ *
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=copytrading.js.map

package/dist/cjs/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/cjs/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/cjs/types/response/v3/earn.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ *
+ *
+ * Earn | On-Chain Elite (UTA)
+ *
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=earn.js.map

package/dist/cjs/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"}