bitget-api 3.2.1 → 3.2.3

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

@@ -0,0 +1,141 @@
+/**
+ *
+ *
+ * Stock+ (UTA)
+ *
+ *
+ */
+export interface GetStockPlusOptionQuoteRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusOptionChainInfoRequestV3 {
+    symbol: string;
+    expiryDate: string;
+}
+export interface GetStockPlusOptionExpiryDateRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusOptionVolumeRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusStaticInfoRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusQuoteRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusTradeDetailRequestV3 {
+    symbol: string;
+    count?: string;
+}
+export interface GetStockPlusIntradayRequestV3 {
+    symbol: string;
+}
+export interface GetStockPlusHistoryCandlestickRequestV3 {
+    symbol: string;
+    period: string;
+    count?: string;
+    adjustType?: string;
+    forward?: boolean;
+    time?: string;
+    tradeSessions?: string;
+}
+export interface GetStockPlusCandlestickRequestV3 {
+    symbol: string;
+    period: string;
+    count?: string;
+    adjustType?: string;
+    tradeSessions?: string;
+}
+export interface GetStockPlusDepthRequestV3 {
+    symbol: string;
+}
+export interface PlaceStockPlusOrderRequestV3 {
+    symbol: string;
+    orderType: 'LO' | 'MO' | 'LIT' | 'MIT' | 'TSLPAMT' | 'TSLPPCT';
+    side: 'Buy' | 'Sell';
+    submittedQuantity: string;
+    timeInForce: 'Day' | 'GoodTilCanceled' | 'GoodTilDate';
+    submittedPrice?: string;
+    triggerPrice?: string;
+    limitOffset?: string;
+    trailingAmount?: string;
+    trailingPercent?: string;
+    expireDate?: string;
+    outsideRth?: 'RTHOnly' | 'AnyTime' | 'Overnight';
+    limitDepthLevel?: number;
+    triggerCount?: number;
+    monitorPrice?: string;
+    remark?: string;
+}
+export interface CancelStockPlusOrderRequestV3 {
+    symbol: string;
+    orderId?: string;
+    clientOid?: string;
+}
+export interface ModifyStockPlusOrderRequestV3 {
+    orderId: string;
+    quantity: string;
+    price?: string;
+    triggerPrice?: string;
+    limitOffset?: string;
+    trailingAmount?: string;
+    trailingPercent?: string;
+    limitDepthLevel?: number;
+    triggerCount?: number;
+    monitorPrice?: string;
+    remark?: string;
+}
+export interface GetStockPlusTodayOrdersRequestV3 {
+    symbol?: string;
+    status?: string | string[];
+    side?: string;
+    market?: string;
+    orderId?: string;
+}
+export interface GetStockPlusHistoryOrdersRequestV3 {
+    symbol?: string;
+    status?: string | string[];
+    side?: string;
+    market?: string;
+    startAt?: string;
+    endAt?: string;
+}
+export interface GetStockPlusOrderDetailRequestV3 {
+    orderId: string;
+}
+export interface GetStockPlusTodayExecutionsRequestV3 {
+    symbol?: string;
+    orderId?: string;
+}
+export interface GetStockPlusHistoryExecutionsRequestV3 {
+    symbol?: string;
+    startAt?: string;
+    endAt?: string;
+}
+export interface GetStockPlusAccountRequestV3 {
+    currency?: string;
+}
+export interface GetStockPlusCashFlowRequestV3 {
+    startTime: string;
+    endTime: string;
+    businessType?: string;
+    symbol?: string;
+    page?: string;
+    size?: string;
+}
+export interface GetStockPlusStockPositionRequestV3 {
+    symbol?: string;
+}
+export interface StockPlusTransferRequestV3 {
+    coin?: string;
+    amount?: string;
+    direction?: 'in' | 'out';
+}
+export interface GetStockPlusTransferRecordsRequestV3 {
+    transferId?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}

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

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

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

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

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

@@ -92,6 +92,7 @@ export interface ModifyOrderRequestV3 {
     slLimitPrice?: string;
 }
 export interface PlaceRealityOrderRequestV3 {
+    category?: 'SPOT' | 'MARGIN';
     symbol: string;
     side: 'buy' | 'sell';
     orderType: 'limit' | 'market';
@@ -100,6 +101,7 @@ export interface PlaceRealityOrderRequestV3 {
     clientOid?: string;
 }
 export interface CancelRealityOrderRequestV3 {
+    category?: 'SPOT' | 'MARGIN';
     symbol: string;
     orderId?: string;
     clientOid?: string;

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

@@ -285,6 +285,8 @@ export interface FuturesPositionV2 {
     deductedFee: string;
     marginRatio: string;
     assetMode: string;
+    /** Cash dividend, USDT */
+    cashDividend?: string;
     uTime: string;
     autoMargin: string;
     cTime: string;
@@ -311,6 +313,8 @@ export interface FuturesHistoryPositionV2 {
     totalFunding: string;
     openFee: string;
     closeFee: string;
+    /** Cash dividend, USDT */
+    cashDividend?: string;
     cTime: string;
     uTime: string;
 }

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

@@ -56,6 +56,8 @@ export interface AccountAssetV3 {
     positionValue?: string;
     /** Account leverage (non-negative) */
     leverage?: string;
+    /** USDT bonus amount */
+    bonus?: string;
 }
 export interface AccountAssetsV3 {
     accountEquity: string;
@@ -328,3 +330,54 @@ export interface MovePositionHistoryV3 {
     createdTime: string;
     updatedTime: string;
 }
+export interface EligibleSymbolV3 {
+    symbol: string;
+    category: string;
+    baseCoin: string;
+    quoteCoin: string;
+    symbolType?: string;
+    buyLimitPriceRatio: string;
+    sellLimitPriceRatio: string;
+    minOrderQty: string;
+    maxOrderQty: string;
+    pricePrecision: string;
+    quantityPrecision: string;
+    quotePrecision: string;
+    minOrderAmount: string;
+    maxSymbolOrderNum: string;
+    maxProductOrderNum: string;
+    status: string;
+    maintainTime: string;
+    areaSymbol?: string;
+    maxPositionNum?: string;
+    isReality?: string;
+    launchTime?: string;
+}
+export interface EligibleMarginTierItemV3 {
+    tier: string;
+    minTierValue: string;
+    maxTierValue: string;
+    leverage: string;
+    mmr: string;
+}
+export interface EligibleMarginTierV3 {
+    coin: string;
+    tiers: EligibleMarginTierItemV3[];
+}
+export interface EligibleLoanInfoV3 {
+    limit: string;
+    masterSubLimit: string;
+    /** Bitget spelling */
+    platformRemaingQuota: string;
+}
+export interface RateLimitQuotaItemV3 {
+    uid: string;
+    quota: string;
+}
+export interface RateLimitQuotaV3 {
+    category: 'spot' | 'futures' | string;
+    quotaList: RateLimitQuotaItemV3[];
+    masterSubQuota: string;
+    masterSubCap: string;
+    cursor: string;
+}

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

@@ -39,7 +39,8 @@ export interface CopyFuturesMaxTransferableV3 {
 export interface CopyFuturesTransferResponseV3 {
     transferId: string;
 }
-export type CopyFuturesTransferAccountTypeV3 = 'spot' | 'uta' | 'lead';
+/** May be a single value or comma-separated values */
+export type CopyFuturesTransferAccountTypeV3 = 'spot' | 'uta' | 'lead' | 'otc' | string;
 export interface CopyFuturesTransferRecordV3 {
     transferId: string;
     fromType: CopyFuturesTransferAccountTypeV3;
@@ -52,3 +53,47 @@ export interface CopyFuturesTransferRecordV3 {
 export interface CopyFuturesTransferRecordListV3 {
     list: CopyFuturesTransferRecordV3[];
 }
+export interface CopyFuturesCurrentFollowerV3 {
+    followerName: string;
+    estimateAssets: string;
+    totalProfit: string;
+    totalShareProfit: string;
+    totalInvestment: string;
+    canRemove: 'yes' | 'no';
+    followDays: string;
+    totalAssets: string;
+    startTime: string;
+}
+export interface CopyFuturesCurrentFollowersV3 {
+    list: CopyFuturesCurrentFollowerV3[];
+}
+export interface CopyFuturesHistoryFollowerV3 {
+    followerName: string;
+    totalProfit: string;
+    totalShareProfit: string;
+    totalInvestment: string;
+    startTime: string;
+    endTime: string;
+}
+export interface CopyFuturesHistoryFollowersV3 {
+    list: CopyFuturesHistoryFollowerV3[];
+}
+export interface CopyFuturesProfitSummaryV3 {
+    totalProfit: string;
+    totalAllocatedProfit: string;
+    totalPendingProfit: string;
+}
+export interface CopyFuturesProfitDetailV3 {
+    followerName: string;
+    profit: string;
+    allocatedPnl: string;
+    pendingPnl: string;
+    shareRatio: string;
+    shareProfit: string;
+    reason: 'period' | 'unfollow' | string;
+    settleTime: string;
+}
+export interface CopyFuturesProfitDetailsV3 {
+    list: CopyFuturesProfitDetailV3[];
+    nextCursor: string;
+}

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

@@ -46,6 +46,9 @@ export interface MarginLoanV3 {
     dailyInterest: string;
     annualInterest: string;
     limit: string;
+    masterSubLimit?: string;
+    /** Bitget spelling */
+    platformRemaingQuota?: string;
 }
 export interface OpenInterestItemV3 {
     symbol: string;
@@ -207,6 +210,8 @@ export interface TickerV3 {
     price24hPcnt: string;
     volume24h: string;
     turnover24h: string;
+    /** 24h platform turnover; only available for rtoken */
+    platformTurnover24h?: string;
     indexPrice?: string;
     markPrice?: string;
     fundingRate?: string;

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

@@ -0,0 +1,302 @@
+/**
+ *
+ *
+ * Stock+ (UTA)
+ *
+ *
+ */
+export interface StockPlusOptionQuoteItemV3 {
+    symbol: string;
+    lastDone: string;
+    prevClose: string;
+    open: string;
+    high: string;
+    low: string;
+    timestamp: string;
+    volume: string;
+    turnover: string;
+    tradeStatus: string;
+    impliedVolatility: string;
+    openInterest: string;
+    expiryDate: string;
+    strikePrice: string;
+    contractMultipier: string;
+    contractType: string;
+    contractSize: string;
+    direction: string;
+    historicalVolatility: string;
+    underlyingSymbol: string;
+}
+export interface StockPlusOptionQuoteV3 {
+    secuQuote: StockPlusOptionQuoteItemV3[];
+}
+export interface StockPlusOptionStrikePriceInfoV3 {
+    price: string;
+    callSymbol: string;
+    putSymbol: string;
+    standard: boolean;
+}
+export interface StockPlusOptionChainInfoV3 {
+    strikePriceInfo: StockPlusOptionStrikePriceInfoV3[];
+}
+export interface StockPlusOptionExpiryDateV3 {
+    expiryDate: string[];
+}
+export interface StockPlusOptionVolumeV3 {
+    c: string;
+    p: string;
+}
+export interface StockPlusStaticInfoItemV3 {
+    symbol: string;
+    nameCn: string;
+    nameEn: string;
+    exchange: string;
+    currency: string;
+    lotSize: number | string;
+    totalShares: string | number;
+    circulatingShares: string | number;
+    eps: string | number;
+    epsTtm: string | number;
+    bps: string | number;
+    dividendYield: string | number;
+    stockDerivatives: string[];
+    board: string;
+}
+export interface StockPlusStaticInfoV3 {
+    list: StockPlusStaticInfoItemV3[];
+}
+export interface StockPlusSessionQuoteV3 {
+    lastDone: string | number;
+    timestamp: string;
+    volume: string | number;
+    turnover: string | number;
+    high: string | number;
+    low: string | number;
+    prevClose: string | number;
+}
+export interface StockPlusQuoteItemV3 {
+    symbol: string;
+    lastDone: string | number;
+    prevClose: string | number;
+    open: string | number;
+    high: string | number;
+    low: string | number;
+    timestamp: string;
+    volume: string | number;
+    turnover: string | number;
+    tradeStatus: string;
+    preMarketQuote?: StockPlusSessionQuoteV3 | null;
+    postMarketQuote?: StockPlusSessionQuoteV3 | null;
+    overnightQuote?: StockPlusSessionQuoteV3 | null;
+}
+export interface StockPlusQuoteV3 {
+    list: StockPlusQuoteItemV3[];
+}
+export interface StockPlusTradeDetailItemV3 {
+    price: string | number;
+    volume: string | number;
+    timestamp: string;
+    tradeType: string;
+    direction: string;
+    tradeSession: string;
+}
+export type StockPlusTradeDetailV3 = StockPlusTradeDetailItemV3[];
+export interface StockPlusIntradayItemV3 {
+    price: string | number;
+    timestamp: string;
+    volume: string | number;
+    turnover: string | number;
+    avgPrice: string | number;
+}
+export interface StockPlusIntradayV3 {
+    list: StockPlusIntradayItemV3[];
+}
+export interface StockPlusCandlestickItemV3 {
+    close: string;
+    open: string;
+    low: string;
+    high: string;
+    volume: string;
+    turnover: string;
+    timestamp: string;
+    tradeSession: string;
+}
+export interface StockPlusCandlestickV3 {
+    list: StockPlusCandlestickItemV3[];
+}
+export type StockPlusHistoryCandlestickV3 = StockPlusCandlestickV3;
+export interface StockPlusDepthLevelV3 {
+    position: number;
+    price: string;
+    volume: string;
+    orderNum: number;
+}
+export interface StockPlusDepthV3 {
+    asks: StockPlusDepthLevelV3[];
+    bids: StockPlusDepthLevelV3[];
+}
+export interface StockPlusPlaceOrderResponseV3 {
+    orderId: string;
+    clientOid: string;
+    symbol: string;
+}
+export type StockPlusCancelOrderResponseV3 = StockPlusPlaceOrderResponseV3;
+export type StockPlusModifyOrderResponseV3 = StockPlusPlaceOrderResponseV3;
+export interface StockPlusOrderV3 {
+    orderId: string;
+    status: string;
+    stockName: string;
+    quantity: string | number;
+    executedQuantity: string | number;
+    price: string | number | null;
+    executedPrice: string | number | null;
+    submittedAt: string;
+    side: string;
+    symbol: string;
+    orderType: string;
+    lastDone: string | number | null;
+    triggerPrice: string | number | null;
+    msg: string;
+    tag: string;
+    timeInForce: string;
+    expireDate: string | null;
+    updatedAt: string | null;
+    triggerAt: string | null;
+    trailingAmount: string | number | null;
+    trailingPercent: string | number | null;
+    limitOffset: string | number | null;
+    triggerStatus: string | null;
+    currency: string;
+    outsideRth: string;
+    remark?: string;
+    limitDepthLevel: number | null;
+    triggerCount: number | null;
+    monitorPrice: string | null;
+}
+export interface StockPlusOrdersV3 {
+    orders: StockPlusOrderV3[];
+}
+export interface StockPlusHistoryOrdersV3 {
+    hasMore: boolean;
+    orders: StockPlusOrderV3[];
+}
+export interface StockPlusOrderHistoryItemV3 {
+    price: string | number;
+    quantity: string | number;
+    status: string;
+    msg: string;
+    time: string;
+}
+export interface StockPlusChargeFeeItemV3 {
+    code: string;
+    name: string;
+    amount: number | string;
+    currency: string;
+}
+export interface StockPlusChargeCategoryV3 {
+    code: string;
+    name: string;
+    fees: StockPlusChargeFeeItemV3[];
+}
+export interface StockPlusChargeDetailV3 {
+    totalAmount: number | string;
+    currency: string;
+    items: StockPlusChargeCategoryV3[];
+}
+export interface StockPlusOrderDetailV3 extends StockPlusOrderV3 {
+    freeStatus?: string;
+    freeAmount?: string | null;
+    freeCurrency?: string | null;
+    deductionsStatus?: string;
+    deductionsAmount?: string | null;
+    deductionsCurrency?: string | null;
+    platformDeductedStatus?: string;
+    platformDeductedAmount?: string | null;
+    platformDeductedCurrency?: string | null;
+    history?: StockPlusOrderHistoryItemV3[];
+    chargeDetail?: StockPlusChargeDetailV3;
+}
+export interface StockPlusExecutionV3 {
+    orderId: string;
+    tradeId: string;
+    symbol: string;
+    tradeDoneAt: string;
+    quantity: number | string;
+    price: number | string;
+}
+export interface StockPlusTodayExecutionsV3 {
+    trades: StockPlusExecutionV3[];
+}
+export interface StockPlusHistoryExecutionsV3 {
+    hasMore: boolean;
+    trades: StockPlusExecutionV3[];
+}
+export interface StockPlusCashInfoV3 {
+    withdrawCash: number | string;
+    availableCash: number | string;
+    frozenCash: number | string;
+    settlingCash: number | string;
+    currency: string;
+}
+export interface StockPlusFrozenTransactionFeeV3 {
+    currency?: string;
+    amount?: number | string;
+    [key: string]: unknown;
+}
+export interface StockPlusAccountItemV3 {
+    totalCash: number | string;
+    maxFinanceAmount: number | string;
+    remainingFinanceAmount: number | string;
+    riskLevel: number | string;
+    marginCall: number | string;
+    netAssets: number | string;
+    initMargin: number | string;
+    maintenanceMargin: number | string;
+    currency: string;
+    buyPower: number | string;
+    cashInfos: StockPlusCashInfoV3[];
+    frozenTransactionFees: StockPlusFrozenTransactionFeeV3[];
+}
+export interface StockPlusAccountV3 {
+    list: StockPlusAccountItemV3[];
+}
+export interface StockPlusCashFlowItemV3 {
+    transactionFlowName: string;
+    direction: string;
+    businessType: string;
+    balance: number | string;
+    currency: string;
+    businessTime: string;
+    symbol: string | null;
+    description: string;
+}
+export interface StockPlusCashFlowV3 {
+    list: StockPlusCashFlowItemV3[];
+}
+export interface StockPlusPositionItemV3 {
+    symbol: string;
+    symbolName: string;
+    quantity: number | string;
+    availableQuantity: number | string;
+    currency: string;
+    costPrice: number | string;
+    market: string;
+    initQuantity: number | string;
+}
+export interface StockPlusPositionChannelV3 {
+    accountChannel: string;
+    positions: StockPlusPositionItemV3[];
+}
+export interface StockPlusStockPositionV3 {
+    channels: StockPlusPositionChannelV3[];
+}
+export interface StockPlusTransferResponseV3 {
+    transferId: string;
+}
+export interface StockPlusTransferRecordsV3 {
+    transferId: string;
+    coin: string;
+    amount: string;
+    direction: string;
+    cursor: string;
+}

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

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

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

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

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

@@ -151,6 +151,8 @@ export interface PositionHistoryV3 {
     totalFunding: string;
     openFeeTotal: string;
     closeFeeTotal: string;
+    /** Cash dividend, USDT */
+    cashDividend?: string;
     createdTime: string;
     updatedTime: string;
 }
@@ -178,6 +180,8 @@ export interface CurrentPositionV3 {
     totalFunding: string;
     openFeeTotal: string;
     closeFeeTotal: string;
+    /** Cash dividend, USDT */
+    cashDividend?: string;
     createdTime: string;
     updatedTime: string;
 }

package/dist/cjs/types/websockets/ws-api-request.d.ts

@@ -20,4 +20,6 @@ export interface WSAPIPlaceOrderRequestV3 {
     slOrderType?: 'limit' | 'market';
     tpLimitPrice?: string;
     slLimitPrice?: string;
+    /** Order TTL in ms [10, 60000]. Only effective when requestTime is also set on the envelope */
+    receiveWindow?: string;
 }

package/dist/cjs/types/websockets/ws-api.d.ts

@@ -19,6 +19,8 @@ export interface WSAPIRequestBitgetV3<TWSParams> {
     category: BitgetInstTypeV3;
     topic: WSAPIOperation;
     args: TWSParams | TWSParams[];
+    /** Client-side request timestamp; required for receiveWindow on place-order */
+    requestTime?: string;
 }
 export interface WSAPIRequestFlags {
     /** If true, will skip auth requirement for WS API connection */
@@ -53,6 +55,10 @@ export interface WsRequestOperationBitget<TWSRequestArg> {
     op: WSOperation;
     args?: (TWSRequestArg | string | number)[];
 }
+export interface WSAPIRateLimitV3 {
+    limit: string;
+    remaining: string;
+}
 export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WSAPIOperation = WSAPIOperation> {
     wsKey: WsKey;
     /** Auto-generated */
@@ -66,6 +72,11 @@ export interface WSAPIResponse<TResponseData extends object = object, TOperation
     ts: string;
     /** Connection ID (trade operation responses, May 2026+) */
     connId?: string;
+    /** Gateway receive time, Unix microseconds */
+    receiveTime?: string;
+    /** Gateway push time, Unix microseconds */
+    pushTime?: string;
+    rateLimit?: WSAPIRateLimitV3[];
 }
 /**
  * List of operations supported for this WsKey (connection)