bitget-api 2.0.13 → 2.1.0

package/lib/types/request/v2/copytrading.d.ts

@@ -0,0 +1,196 @@
+/**
+ *
+ *
+ * Copy Trading | Future copy trading | Trader Api
+ *
+ *
+ */
+export declare type CopyTradingProductTypeV2 = 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+export interface GetFuturesTraderCurrentOrdersRequestV2 {
+    symbol?: string;
+    productType: CopyTradingProductTypeV2;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idGreaterThan?: string;
+    idLessThan?: string;
+}
+export interface GetFuturesTraderHistoryOrdersRequestV2 {
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    order?: 'asc' | 'desc';
+    symbol?: string;
+    productType: CopyTradingProductTypeV2;
+}
+export interface ModifyFuturesTraderOrderTPSLRequestV2 {
+    trackingNo: string;
+    productType: CopyTradingProductTypeV2;
+    stopSurplusPrice?: string;
+    stopLossPrice?: string;
+}
+export interface GetFuturesTraderProfitShareDetailRequestV2 {
+    coin?: string;
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface FuturesTraderSymbolSettingRequestV2 {
+    symbol: string;
+    productType: CopyTradingProductTypeV2;
+    settingType: 'ADD' | 'DELETE' | 'UPDATE';
+    stopSurplusRatio?: string;
+    stopLossRatio?: string;
+}
+export interface GetFuturesTraderFollowersRequestV2 {
+    pageNo?: string;
+    pageSize?: string;
+    startTime?: string;
+    endTime?: string;
+}
+/**
+ *
+ *
+ * Copy Trading | Future copy trading | Follower Api
+ *
+ *
+ */
+export interface GetFollowerFuturesCurrentTrackingOrdersRequestV2 {
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    symbol?: string;
+    productType: CopyTradingProductTypeV2;
+    traderId?: string;
+}
+export interface GetFollowerFuturesHistoryTrackingOrdersRequestV2 {
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    symbol?: string;
+    productType: CopyTradingProductTypeV2;
+    traderId?: string;
+}
+export interface UpdateFuturesFollowerTPSLRequestV2 {
+    trackingNo: string;
+    symbol?: string;
+    productType: CopyTradingProductTypeV2;
+    stopSurplusPrice?: string;
+    stopLossPrice?: string;
+}
+export declare type AutoCopyOption = 'on' | 'off';
+export declare type FollowMode = 'basic' | 'advanced';
+export declare type LeverageType = 'position' | 'specify' | 'trader';
+export declare type TraceType = 'percent' | 'amount' | 'count';
+export interface FollowerCopyTradeSettingRequestV2 {
+    symbol: string;
+    productType: CopyTradingProductTypeV2;
+    marginType: 'trader' | 'specify';
+    marginCoin?: string;
+    leverType: LeverageType;
+    longLeverage?: string;
+    shortLeverage?: string;
+    traceType: TraceType;
+    traceValue: string;
+    maxHoldSize?: string;
+    stopSurplusRatio?: string;
+    stopLossRatio?: string;
+}
+export interface UpdateFuturesFollowerSettingsRequestV2 {
+    traderId: string;
+    autoCopy?: AutoCopyOption;
+    mode?: FollowMode;
+    settings: FollowerCopyTradeSettingRequestV2[];
+}
+export interface CloseFuturesFollowerPositionsRequestV2 {
+    productType: CopyTradingProductTypeV2;
+    trackingNo?: string;
+    symbol?: string;
+    marginCoin?: string;
+    marginMode?: 'isolated' | 'cross';
+    holdSide?: 'long' | 'short';
+}
+export interface GetFuturesFollowerTradersRequestV2 {
+    startTime?: string;
+    endTime?: string;
+    pageNo?: string;
+    pageSize?: string;
+}
+/**
+ *
+ *
+ * Copy Trading | Spot copy trading | Trader api
+ *
+ *
+ */
+export interface GetSpotTraderHistoryProfitRequestV2 {
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    coin?: string;
+}
+export interface GetSpotTraderHistoryOrdersRequestV2 {
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    symbol?: string;
+}
+export interface GetSpotTraderCurrentOrdersRequestV2 {
+    symbol?: string;
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface GetSpotTraderFollowersRequestV2 {
+    pageNo?: string;
+    pageSize?: string;
+    startTime?: string;
+    endTime?: string;
+}
+/**
+ *
+ *
+ * Copy Trading | Spot copy trading | Follower api
+ *
+ *
+ */
+export interface SpotFollowerCopyTradeSettingV2 {
+    symbol: string;
+    traceType: 'percent' | 'amount' | 'count';
+    maxHoldSize: string;
+    traceValue: string;
+    stopLossRatio?: string;
+    stopSurplusRatio?: string;
+}
+export interface GetSpotFollowerHistoryOrdersRequestV2 {
+    symbol?: string;
+    traderId?: string;
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface GetSpotFollowerOpenOrdersRequestV2 {
+    symbol?: string;
+    traderId?: string;
+    idLessThan?: string;
+    idGreaterThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}

package/lib/types/request/v2/copytrading.js

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

package/lib/types/request/v2/copytrading.js.map

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

package/lib/types/request/v2/earn.d.ts

@@ -0,0 +1,121 @@
+/**
+ *
+ *
+ * Earn | Savings
+ *
+ *
+ */
+export interface GetEarnSavingsAssetsRequestV2 {
+    periodType: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetEarnSavingsRecordsRequestV2 {
+    coin?: string;
+    periodType: string;
+    orderType?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface RedeemSavingsRequestV2 {
+    productId: string;
+    orderId?: string;
+    periodType: string;
+    amount: string;
+}
+/**
+ *
+ *
+ * Earn | Shark Fin
+ *
+ *
+ */
+export interface GetSharkfinAssetsRequestV2 {
+    status: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetSharkfinRecordsRequestV2 {
+    coin?: string;
+    type: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+/**
+ *
+ *
+ * Earn | Loan
+ *
+ *
+ */
+export interface GetLoanEstInterestAndBorrowableRequestV2 {
+    loanCoin: string;
+    pledgeCoin: string;
+    daily: 'SEVEN' | 'THIRTY';
+    pledgeAmount?: string;
+}
+export interface BorrowLoanRequestV2 {
+    loanCoin: string;
+    pledgeCoin: string;
+    daily: 'SEVEN' | 'THIRTY';
+    pledgeAmount?: string;
+    loanAmount?: string;
+}
+export interface RepayLoanRequestV2 {
+    orderId: string;
+    amount?: string;
+    repayUnlock?: string;
+    repayAll: string;
+}
+export interface GetLoanRepayHistoryRequestV2 {
+    orderId?: string;
+    loanCoin?: string;
+    pledgeCoin?: string;
+    startTime: string;
+    endTime: string;
+    pageNo?: string;
+    pageSize?: string;
+}
+export interface ModifyLoanPledgeRateRequestV2 {
+    orderId: string;
+    amount: string;
+    pledgeCoin: string;
+    reviseType: string;
+}
+export interface GetLoanPledgeRateHistoryRequestV2 {
+    orderId?: string;
+    reviseSide?: string;
+    pledgeCoin?: string;
+    startTime: string;
+    endTime: string;
+    pageNo?: string;
+    pageSize?: string;
+}
+export interface GetLoanHistoryRequestV2 {
+    orderId?: string;
+    loanCoin?: string;
+    pledgeCoin?: string;
+    status?: string;
+    startTime: string;
+    endTime: string;
+    pageNo?: string;
+    pageSize?: string;
+}
+export interface GetLiquidationRecordsRequestV2 {
+    orderId?: string;
+    loanCoin?: string;
+    pledgeCoin?: string;
+    status?: string;
+    startTime: string;
+    endTime: string;
+    pageNo?: string;
+    pageSize?: string;
+}

package/lib/types/request/v2/earn.js

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

package/lib/types/request/v2/earn.js.map

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

package/lib/types/request/v2/futures.d.ts

@@ -1,5 +1,5 @@
+import { FuturesPlanTypeV2, FuturesProductTypeV2 } from '../shared';
 import { FuturesKlineInterval } from '../v1/futuresV1';
-export declare type FuturesProductTypeV2 = 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES' | 'SUSDT-FUTURES' | 'SCOIN-FUTURES' | 'SUSDC-FUTURES';
 export declare type FuturesKlineTypeV2 = 'MARKET' | 'MARK' | 'INDEX';
 export interface FuturesAccountBillRequestV2 {
     productType: FuturesProductTypeV2;
@@ -11,6 +11,30 @@ export interface FuturesAccountBillRequestV2 {
     endTime?: string;
     limit?: string;
 }
+/**
+ *
+ * * Futures | Market
+ *
+ */
+export interface FuturesMergeDepthRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    precision?: 'scale0' | 'scale1' | 'scale2' | 'scale3';
+    limit?: '1' | '5' | '15' | '50' | 'max';
+}
+export interface FuturesRecentTradesRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    limit?: string;
+}
+export interface FuturesHistoricTradesRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    limit?: string;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+}
 export interface FuturesCandlesRequestV2 {
     symbol: string;
     productType: FuturesProductTypeV2;
@@ -20,3 +44,320 @@ export interface FuturesCandlesRequestV2 {
     kLineType?: FuturesKlineTypeV2;
     limit?: string;
 }
+/**
+ *
+ * * Futures | Account
+ *
+ */
+export interface FuturesSingleAccountRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+}
+export interface FuturesInterestHistoryRequestV2 {
+    productType: 'USDT-FUTURES' | 'SUSDT-FUTURES';
+    coin?: string;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface FuturesOpenCountRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    openAmount: string;
+    openPrice: string;
+    leverage?: string;
+}
+export interface FuturesSetAutoMarginRequestV2 {
+    symbol: string;
+    autoMargin: 'on' | 'off';
+    marginCoin: string;
+    amount: string;
+    holdSide?: 'long' | 'short';
+}
+export interface FuturesSetLeverageRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    leverage: string;
+    holdSide?: 'long' | 'short';
+}
+export interface FuturesSetPositionMarginRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    holdSide: 'long' | 'short';
+    amount: string;
+}
+export interface FuturesSetMarginModeRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    marginMode: 'isolated' | 'crossed';
+}
+/**
+ *
+ * * Futures | Position
+ *
+ */
+export interface FuturesHistoricalPositionsRequestV2 {
+    symbol?: string;
+    productType?: FuturesProductTypeV2;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+/**
+ *
+ * * Futures | Trade
+ *
+ */
+export interface FuturesPlaceOrderRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginMode: 'isolated' | 'crossed';
+    marginCoin: string;
+    size: string;
+    price?: string;
+    side: 'buy' | 'sell';
+    tradeSide?: 'open' | 'close';
+    orderType: 'limit' | 'market';
+    force?: 'ioc' | 'fok' | 'gtc' | 'post_only';
+    clientOid?: string;
+    reduceOnly?: 'YES' | 'NO';
+    presetStopSurplusPrice?: string;
+    presetStopLossPrice?: string;
+    stpMode?: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+}
+export interface FuturesReversalOrderRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    size: string;
+    side?: 'buy' | 'sell';
+    tradeSide?: 'open' | 'close';
+    clientOid?: string;
+}
+interface FuturesBatchOrderItem {
+    size: string;
+    price?: string;
+    side: 'buy' | 'sell';
+    tradeSide?: 'open' | 'close';
+    orderType: 'limit' | 'market';
+    force?: 'ioc' | 'fok' | 'gtc' | 'post_only';
+    clientOid?: string;
+    reduceOnly?: 'YES' | 'NO';
+    presetStopSurplusPrice?: string;
+    presetStopLossPrice?: string;
+    stpMode?: 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+}
+export interface FuturesBatchOrderRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin: string;
+    marginMode: 'isolated' | 'crossed';
+    orderList: FuturesBatchOrderItem[];
+}
+export interface FuturesModifyOrderRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    newClientOid: string;
+    newSize?: string;
+    newPrice?: string;
+    newPresetStopSurplusPrice?: string;
+    newPresetStopLossPrice?: string;
+}
+export interface FuturesCancelOrderRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginCoin?: string;
+    orderId?: string;
+    clientOid?: string;
+}
+interface FuturesBatchCancelOrderItem {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface FuturesBatchCancelOrderRequestV2 {
+    orderIdList?: FuturesBatchCancelOrderItem[];
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    marginCoin?: string;
+}
+export interface FuturesFlashClosePositionsRequestV2 {
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    holdSide?: 'long' | 'short';
+}
+export interface FuturesGetOrderRequestV2 {
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    orderId?: string;
+    clientOid?: string;
+}
+export interface FuturesGetOrderFillsRequestV2 {
+    orderId?: string;
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface FuturesGetHistoricalFillsRequestV2 {
+    orderId?: string;
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+}
+export interface FuturesGetOpenOrdersRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    status?: 'live' | 'partially_filled';
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export declare type FuturesOrderSourceV2 = 'normal' | 'market' | 'profit_market' | 'loss_market' | 'Trader_delegate' | 'trader_profit' | 'trader_loss' | 'reverse' | 'trader_reverse' | 'profit_limit' | 'loss_limit' | 'liquidation' | 'delivery_close_long' | 'delivery_close_short' | 'pos_profit_limit' | 'pos_profit_market' | 'pos_loss_limit' | 'pos_loss_market';
+export interface FuturesGetHistoryOrdersRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    idLessThan?: string;
+    orderSource?: FuturesOrderSourceV2;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface FuturesCancelAllOrdersRequestV2 {
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    marginCoin?: string;
+    requestTime?: string;
+    receiveWindow?: string;
+}
+/**
+ *
+ * * Futures | Trigger Orders
+ *
+ */
+export declare type FuturesTriggerTypeV2 = 'fill_price' | 'mark_price';
+export declare type FuturesStpModeV2 = 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+export interface FuturesTPSLOrderRequestV2 {
+    marginCoin: string;
+    productType: FuturesProductTypeV2;
+    symbol: string;
+    planType: FuturesPlanTypeV2;
+    triggerPrice: string;
+    triggerType?: FuturesTriggerTypeV2;
+    executePrice?: string;
+    holdSide: 'long' | 'short' | 'buy' | 'sell';
+    size: string;
+    rangeRate?: string;
+    clientOid?: string;
+    stpMode?: FuturesStpModeV2;
+}
+export declare type FuturesTriggerPriceTypeV2 = 'fill_price' | 'mark_price' | 'index_price';
+export interface FuturesPlanOrderRequestV2 {
+    planType: 'normal_plan' | 'track_plan';
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    marginMode: 'isolated' | 'crossed';
+    marginCoin: string;
+    size: string;
+    price?: string;
+    callbackRatio?: string;
+    triggerPrice: string;
+    triggerType: 'mark_price' | 'fill_price';
+    side: 'buy' | 'sell';
+    tradeSide?: 'open' | 'close';
+    orderType: 'limit' | 'market';
+    clientOid?: string;
+    reduceOnly?: 'YES' | 'NO';
+    stopSurplusTriggerPrice?: string;
+    stopSurplusExecutePrice?: string;
+    stopSurplusTriggerType?: FuturesTriggerPriceTypeV2;
+    stopLossTriggerPrice?: string;
+    stopLossExecutePrice?: string;
+    stopLossTriggerType?: FuturesTriggerPriceTypeV2;
+    stpMode?: FuturesStpModeV2;
+}
+export interface FuturesModifyTPSLOrderRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    marginCoin: string;
+    productType: FuturesProductTypeV2;
+    symbol: string;
+    triggerPrice: string;
+    triggerType?: 'fill_price' | 'mark_price';
+    executePrice?: string;
+    size: string;
+    rangeRate?: string;
+}
+export interface FuturesModifyPlanOrderRequestV2 {
+    planType: 'normal_plan' | 'track_plan';
+    orderId?: string;
+    clientOid?: string;
+    symbol: string;
+    productType: FuturesProductTypeV2;
+    newSize?: string;
+    newPrice?: string;
+    newCallbackRatio?: string;
+    newTriggerPrice?: string;
+    newTriggerType?: 'fill_price' | 'mark_price';
+    newStopSurplusTriggerPrice?: string;
+    newStopSurplusExecutePrice?: string;
+    newStopSurplusTriggerType?: FuturesTriggerPriceTypeV2;
+    newStopLossTriggerPrice?: string;
+    newStopLossExecutePrice?: string;
+    newStopLossTriggerType?: FuturesTriggerPriceTypeV2;
+}
+export interface FuturesGetPlanOrdersRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    symbol?: string;
+    planType: 'normal_plan' | 'track_plan' | 'profit_loss';
+    productType: FuturesProductTypeV2;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+interface FuturesCancelPlanOrderItemV2 {
+    orderId?: string;
+    clientOid?: string;
+}
+export declare type FuturesPlanOrderTypeV2 = 'normal_plan' | 'profit_plan' | 'loss_plan' | 'pos_profit' | 'pos_loss' | 'moving_plan';
+export interface FuturesCancelPlanOrderRequestV2 {
+    orderIdList?: FuturesCancelPlanOrderItemV2[];
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    marginCoin?: string;
+    planType?: FuturesPlanOrderTypeV2;
+}
+export declare type FuturesPlanStatusV2 = 'executed' | 'fail_trigger' | 'cancelled';
+export interface FuturesGetHistoryPlanOrdersRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    planType: 'normal_plan' | 'track_plan' | 'profit_loss';
+    planStatus?: FuturesPlanStatusV2;
+    symbol?: string;
+    productType: FuturesProductTypeV2;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export {};