bitget-api 2.3.6 → 3.0.0

package/dist/mjs/types/request/v1/spotV1.d.ts

@@ -0,0 +1,105 @@
+import { OrderTimeInForce } from '../shared.js';
+export type WalletType = 'spot' | 'mix_usdt' | 'mix_usd';
+export type SpotKlineInterval = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1day' | '3day' | '1week' | '1M' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
+export interface NewWalletTransfer {
+    fromType: WalletType;
+    toType: WalletType;
+    amount: string;
+    coin: string;
+    clientOid?: string;
+}
+export interface NewSpotSubTransfer {
+    fromType: WalletType;
+    toType: WalletType;
+    amount: string;
+    coin: string;
+    clientOid: string;
+    fromUserId: string;
+    toUserId: string;
+}
+export interface NewSpotWithdraw {
+    coin: string;
+    address: string;
+    chain: string;
+    tag?: string;
+    amount: string;
+    remark?: string;
+    clientOid?: string;
+}
+export interface NewSpotOrder {
+    symbol: string;
+    side: 'buy' | 'sell';
+    orderType: 'limit' | 'market';
+    force: OrderTimeInForce;
+    price?: string;
+    size?: string;
+    quantity?: string;
+    clientOrderId?: string;
+}
+export type NewBatchSpotOrder = Omit<NewSpotOrder, 'symbol'>;
+export interface CancelSpotOrderV2 {
+    symbol: string;
+    orderId?: string;
+    clientOid?: string;
+}
+export interface BatchCancelSpotOrderV2 {
+    symbol: string;
+    orderIds?: string[];
+    clientOids?: string[];
+}
+export interface NewSpotPlanOrder {
+    symbol: string;
+    side: 'buy' | 'sell';
+    triggerPrice: number;
+    executePrice?: number;
+    size: number;
+    triggerType: 'fill_price' | 'market_price';
+    orderType: 'limit' | 'market';
+    clientOid?: string;
+    timeInForceValue?: string;
+}
+export interface NewSpotPlanOrder {
+    symbol: string;
+    side: 'buy' | 'sell';
+    triggerPrice: number;
+    executePrice?: number;
+    size: number;
+    triggerType: 'fill_price' | 'market_price';
+    orderType: 'limit' | 'market';
+    clientOid?: string;
+    timeInForceValue?: string;
+}
+export interface ModifySpotPlanOrder {
+    orderId?: string;
+    clientOid?: string;
+    triggerPrice: number;
+    executePrice?: number;
+    size?: string;
+    orderType: 'limit' | 'market';
+}
+export interface CancelSpotPlanOrderParams {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface GetSpotPlanOrdersParams {
+    symbol: string;
+    pageSize: string;
+    lastEndId?: string;
+}
+export interface GetHistoricPlanOrdersParams {
+    symbol: string;
+    pageSize: string;
+    lastEndId?: string;
+    startTime: string;
+    endTime: string;
+}
+export interface SpotCandleData {
+    open: string;
+    high: string;
+    low: string;
+    close: string;
+    quoteVol: string;
+    baseVol: string;
+    usdtVol: string;
+    ts: string;
+}

package/dist/mjs/types/request/v1/spotV1.js

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

package/dist/mjs/types/request/v1/spotV1.js.map

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

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

@@ -0,0 +1,69 @@
+/**
+ *
+ * * Broker | Subaccount
+ *
+ */
+export interface GetSubAccountsRequestV2 {
+    limit?: string;
+    idLessThan?: string;
+    status?: 'normal' | 'freeze' | 'del';
+    startTime?: string;
+    endTime?: string;
+}
+export type SubAccountPermissionV2 = 'withdraw' | 'transfer' | 'spot_trade' | 'contract_trade' | 'read' | 'deposit' | 'margin_trade';
+export type SubAccountLanguageV2 = 'en_US' | 'zh_CN' | 'ja_JP' | 'vi_VN' | 'zh_TW' | 'ru_RU' | 'es_ES' | 'tr_TR' | 'fr_FR' | 'de_DE' | 'pt_PT' | 'th_TH';
+export type SubAccountStatusV2 = 'normal' | 'freeze';
+export interface ModifySubRequestV2 {
+    subUid: string;
+    permList: SubAccountPermissionV2[];
+    status: SubAccountStatusV2;
+    language?: SubAccountLanguageV2;
+}
+export interface SubWithdrawalRequestV2 {
+    subUid: string;
+    coin: string;
+    dest: 'on_chain' | 'internal_transfer';
+    chain?: string;
+    address: string;
+    amount: string;
+    tag?: string;
+    clientOid?: string;
+}
+export interface SubDepositRecordsRequestV2 {
+    orderId?: string;
+    userId?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface SubWithdrawalRecordsRequestV2 {
+    orderId?: string;
+    userId?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+/**
+ *
+ * * Broker | Subaccount
+ *
+ */
+export interface CreateSubAccountApiKeyRequestV2 {
+    subUid: string;
+    passphrase: string;
+    label?: string;
+    ipList: string[];
+    permType: string;
+    permList: string[];
+}
+export interface ModifySubAccountApiKeyRequestV2 {
+    subUid: string;
+    apiKey: string;
+    label?: string;
+    passphrase: string;
+    ipList?: string[];
+    permType?: string;
+    permList: string[];
+}

package/dist/mjs/types/request/v2/broker.js

@@ -0,0 +1,7 @@
+/**
+ *
+ * * Broker | Subaccount
+ *
+ */
+export {};
+//# sourceMappingURL=broker.js.map

package/dist/mjs/types/request/v2/broker.js.map

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

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

@@ -0,0 +1,163 @@
+import { FuturesProductTypeV2, MarginType } from '../shared.js';
+/**
+ *
+ * * Common | Notice
+ *
+ */
+export interface GetAnnouncementsRequestV2 {
+    annType?: string;
+    startTime?: string;
+    endTime?: string;
+    language: string;
+}
+/**
+ *
+ * * Common | Public
+ *
+ */
+export interface GetTradeRateRequestV2 {
+    symbol: string;
+    businessType: string;
+}
+/**
+ *
+ * * Common | Tax
+ *
+ */
+export interface GetSpotTransactionsRequestV2 {
+    coin?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetFuturesTransactionsRequestV2 {
+    productType?: FuturesProductTypeV2;
+    marginCoin?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetMarginTransactionsRequestV2 {
+    marginType?: MarginType;
+    coin?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetP2PTransactionsRequestV2 {
+    coin?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}
+/**
+ *
+ * * Common | P2P
+ *
+ */
+export interface GetP2PMerchantsRequestV2 {
+    online?: 'yes' | 'no';
+    idLessThan?: string;
+    limit?: string;
+}
+export interface GetMerchantP2POrdersRequestV2 {
+    startTime: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    status?: string;
+    advNo: string;
+    side?: string;
+    coin?: string;
+    language: string;
+    fiat?: string;
+    orderNo?: string;
+}
+export interface GetMerchantAdvertisementsRequestV2 {
+    startTime: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    status: string;
+    advNo?: string;
+    side: string;
+    coin: string;
+    language?: string;
+    fiat: string;
+    orderBy?: string;
+    payMethodId?: string;
+    sourceType?: string;
+}
+/**
+ *
+ * * Common | Virtual Subaccount
+ *
+ */
+export interface ModifyVirtualSubRequestV2 {
+    subAccountUid: string;
+    permList: string[];
+    status: string;
+}
+export interface CreateVirtualSubRequestV2 {
+    subAccountName: string;
+    passphrase: string;
+    label: string;
+    ipList?: string[];
+    permList?: string[];
+}
+export interface CreateVirtualSubApiKeyRequestV2 {
+    subAccountUid: string;
+    passphrase: string;
+    label: string;
+    ipList?: string[];
+    permList?: string[];
+}
+export interface ModifyVirtualSubApiKeyRequestV2 {
+    subAccountUid: string;
+    subAccountApiKey: string;
+    passphrase: string;
+    label: string;
+    ipList?: string[];
+    permList?: string[];
+}
+/**
+ *
+ * * Common | Convert
+ *
+ */
+export interface ConvertQuoteRequestV2 {
+    fromCoin: string;
+    fromCoinSize?: string;
+    toCoin: string;
+    toCoinSize?: string;
+}
+export interface ConvertRequestV2 {
+    fromCoin: string;
+    fromCoinSize: string;
+    cnvtPrice: string;
+    toCoin: string;
+    toCoinSize: string;
+    traceId: string;
+}
+export interface GetConvertHistoryRequestV2 {
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}
+/**
+ *
+ * * Common | BGB Convert
+ *
+ */
+export interface GetConvertBGBHistoryRequestV2 {
+    orderId?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    idLessThan?: string;
+}

package/dist/mjs/types/request/v2/common.js

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

package/dist/mjs/types/request/v2/common.js.map

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

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

@@ -0,0 +1,196 @@
+/**
+ *
+ *
+ * Copy Trading | Future copy trading | Trader Api
+ *
+ *
+ */
+export 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 type AutoCopyOption = 'on' | 'off';
+export type FollowMode = 'basic' | 'advanced';
+export type LeverageType = 'position' | 'specify' | 'trader';
+export 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/dist/mjs/types/request/v2/copytrading.js

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * Copy Trading | Future copy trading | Trader Api
+ *
+ *
+ */
+export {};
+//# sourceMappingURL=copytrading.js.map

package/dist/mjs/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/dist/mjs/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/dist/mjs/types/request/v2/earn.js

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * Earn | Savings
+ *
+ *
+ */
+export {};
+//# sourceMappingURL=earn.js.map

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