bitget-api 3.1.6 → 3.1.8

package/dist/mjs/types/request/v2/broker.d.ts

@@ -144,3 +144,71 @@ export interface GetBrokerOrderCommissionRequestV2 {
 export interface GetBrokerRebateInfoRequestV2 {
     uid: string;
 }
+/**
+ *
+ * * Broker | Agent (affiliate) customer APIs
+ *
+ */
+export interface GetAgentCustomerCommissionsRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    uid?: string;
+    coin?: string;
+    symbol?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface GetAgentSubCustomerListRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    uid?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface AgentCustomerTradeVolumeRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    pageNo?: string;
+    pageSize?: string;
+    uid?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface AgentCustomerListRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    pageNo?: string;
+    pageSize?: string;
+    uid?: string;
+    referralCode?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface GetAgentCustomerKycResultRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    uid?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface AgentCustomerDepositRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    pageNo?: string;
+    pageSize?: string;
+    uid?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface AgentCustomerAssetRequestV2 {
+    pageNo?: string;
+    pageSize?: string;
+    uid?: string;
+    showSub?: 'yes' | 'no';
+}
+export interface GetAgentCommissionDetailRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}

package/dist/mjs/types/request/v2/common.d.ts

@@ -124,6 +124,13 @@ export interface ModifyVirtualSubApiKeyRequestV2 {
     ipList?: string[];
     permList?: string[];
 }
+export interface CreateAgentSubaccountRequestV2 {
+    /** Lowercase letters only; max 20 characters */
+    username: string;
+    /** 8–32 characters, letters and numbers */
+    passphrase: string;
+    note?: string;
+}
 /**
  *
  * * Common | Convert

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

@@ -119,3 +119,41 @@ export interface GetLiquidationRecordsRequestV2 {
     pageNo?: string;
     pageSize?: string;
 }
+/**
+ *
+ *
+ * Earn | On-Chain Elite
+ *
+ *
+ */
+export interface GetEarnEliteRecordsRequestV2 {
+    type: 'subscribe' | 'redeem' | 'interest';
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetEarnEliteSubscribeInfoRequestV2 {
+    productId: string;
+}
+export interface EarnEliteSubscribeRequestV2 {
+    productSubId: string;
+    amount: string;
+    coin?: string;
+    paymentAccount?: 'spot' | 'unified';
+}
+export interface GetEarnEliteSubscribeResultRequestV2 {
+    orderId: string;
+}
+export interface GetEarnEliteRedeemInfoRequestV2 {
+    productId: string;
+}
+export interface RedeemEarnEliteRequestV2 {
+    productId: string;
+    productSubId: string;
+    redeemType: 'fast' | 'standard';
+    amount: string;
+    receiveAccount: 'spot' | 'unified';
+    advancedSettle?: 'yes' | 'no';
+    coin?: string;
+}

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

@@ -1,3 +1,9 @@
+export type AccountAdjustModeV3 = 'basic' | 'advanced' | 'delta' | 'isolated';
+export interface AdjustAccountModeRequestV3 {
+    mode: AccountAdjustModeV3;
+    /** Sub-account UID when the master account switches mode for a sub-account */
+    targetUid?: string;
+}
 export interface SetLeverageRequestV3 {
     category: 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
     symbol?: string;
@@ -164,6 +170,16 @@ export interface GetWithdrawRecordsRequestV3 {
     limit?: string;
     cursor?: string;
 }
+export interface GetWithdrawAddressBookRequestV3 {
+    coin?: string;
+    type?: 'EVM' | 'regular' | 'universal' | 'internal';
+    limit?: string;
+    cursor?: string;
+}
+export interface CancelWithdrawalRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+}
 export interface SetDepositAccountRequestV3 {
     coin: string;
     accountType: 'funding' | 'unified' | 'otc';

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

@@ -47,7 +47,7 @@ export interface CreateBrokerSubApiKeyRequestV3 {
     passphrase: string;
     label: string;
     ipList?: string[];
-    permType: 'read_and_write' | 'readonly';
+    permType: 'read_write' | 'read_only';
     permList: string[];
 }
 export interface ModifyBrokerSubApiKeyRequestV3 {
@@ -56,7 +56,7 @@ export interface ModifyBrokerSubApiKeyRequestV3 {
     apiKey: string;
     label?: string;
     ipList?: string[];
-    permType?: 'read_and_write' | 'readonly';
+    permType?: 'read_write' | 'read_only';
     permList?: string[];
 }
 export interface DeleteBrokerSubApiKeyRequestV3 {

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

@@ -0,0 +1,15 @@
+export interface GetCopyFuturesMaxTransferableRequestV3 {
+    coin: string;
+}
+export interface CopyFuturesTransferRequestV3 {
+    type: 'in' | 'out';
+    coin: string;
+    amount: string;
+}
+export interface GetCopyFuturesTransferRecordRequestV3 {
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    /** Pass transferId from the previous page to paginate forward */
+    cursor?: string;
+}

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

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

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

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

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

@@ -0,0 +1,38 @@
+/**
+ *
+ *
+ * Earn | On-Chain Elite (UTA)
+ *
+ *
+ */
+export interface GetEarnEliteRecordsRequestV3 {
+    type: 'subscribe' | 'redeem' | 'interest';
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetEarnEliteSubscribeInfoRequestV3 {
+    productId: string;
+}
+export interface EarnEliteSubscribeRequestV3 {
+    productSubId: string;
+    amount: string;
+    coin?: string;
+    paymentAccount?: 'spot' | 'unified';
+}
+export interface GetEarnEliteSubscribeResultRequestV3 {
+    orderId: string;
+}
+export interface GetEarnEliteRedeemInfoRequestV3 {
+    productId: string;
+}
+export interface RedeemEarnEliteRequestV3 {
+    productId: string;
+    productSubId: string;
+    redeemType: 'fast' | 'standard';
+    amount: string;
+    receiveAccount: 'spot' | 'unified';
+    advancedSettle?: 'yes' | 'no';
+    coin?: string;
+}

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

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

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

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

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

@@ -0,0 +1,105 @@
+export type P2pSideV3 = 'buy' | 'sell';
+export type P2pPriceTypeV3 = 'fixed' | 'floating';
+export type P2pMarketTypeV3 = 'public' | 'private';
+export type P2pAdStatusV3 = 'publish' | 'delist' | 'remove';
+export type P2pAdOperationV3 = 'publish' | 'delist' | 'remove';
+export type P2pOrderStatusV3 = 'pending_payment' | 'pending_release' | 'completed' | 'cancelled' | 'in_appeal';
+export interface P2pPayMethodIdRefV3 {
+    payMethodId: string;
+    userPayMethodId?: string;
+}
+export interface GetP2pAdListRequestV3 {
+    token: string;
+    fiat: string;
+    side: P2pSideV3;
+    amount?: string;
+    pageNum: string;
+    limit: string;
+}
+export interface GetP2pExchangeRateRequestV3 {
+    token: string;
+    fiat: string;
+}
+export interface P2pFeeSimulateRequestV3 {
+    token: string;
+    fiat: string;
+    side: P2pSideV3;
+    marketType: P2pMarketTypeV3;
+    amount: string;
+}
+export interface GetP2pAdLimitRequestV3 {
+    token: string;
+    fiat: string;
+    side: P2pSideV3;
+}
+export interface CreateP2pAdRequestV3 {
+    token: string;
+    fiat: string;
+    side: P2pSideV3;
+    priceType: P2pPriceTypeV3;
+    price?: string;
+    premium?: string;
+    minAmount: string;
+    maxAmount: string;
+    quantity: string;
+    payMethodIds: P2pPayMethodIdRefV3[];
+    remark?: string;
+    tradeTerms?: string;
+    payTimeLimit: string;
+}
+export interface UpdateP2pAdRequestV3 {
+    advId: string;
+    priceType?: P2pPriceTypeV3;
+    price?: string;
+    premium?: string;
+    minAmount?: string;
+    maxAmount?: string;
+    quantity?: string;
+    payMethodIds?: P2pPayMethodIdRefV3[];
+    payTimeLimit?: string;
+    remark?: string;
+    tradeTerms?: string;
+}
+export interface OperateP2pAdRequestV3 {
+    advId: string;
+    operation: P2pAdOperationV3;
+}
+export interface GetP2pAdInfoRequestV3 {
+    advId: string;
+}
+export interface GetP2pMyAdsRequestV3 {
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+    advId?: string;
+    token?: string;
+    fiat?: string;
+    status?: P2pAdStatusV3;
+}
+export interface GetP2pPendingOrdersRequestV3 {
+    orderId?: string;
+    side?: P2pSideV3;
+    startTime?: string;
+    endTime?: string;
+    cursor?: string;
+    limit?: string;
+}
+export interface GetP2pAllOrdersRequestV3 {
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+    orderId?: string;
+    side?: P2pSideV3;
+    status?: P2pOrderStatusV3;
+}
+export interface GetP2pOrderInfoRequestV3 {
+    orderId: string;
+}
+export interface P2pOrderActionRequestV3 {
+    orderId: string;
+}
+export interface GetP2pBalanceRequestV3 {
+    token: string;
+}

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

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

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

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

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

@@ -49,6 +49,10 @@ export interface GetPositionTierRequestV3 {
 export interface GetRiskReserveRequestV3 {
     category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
     symbol: string;
+    marginCoin?: string;
+}
+export interface GetRiskReserveAllRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
 }
 export interface GetInstrumentsRequestV3 {
     category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';

package/dist/mjs/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/mjs/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/mjs/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/mjs/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;