bitget-api 2.3.6 → 3.0.0

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

@@ -0,0 +1,265 @@
+type SpotKlineIntervalV2 = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1day' | '3day' | '1week' | '1M' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
+export interface SpotCandlesRequestV2 {
+    symbol: string;
+    granularity: SpotKlineIntervalV2;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface SpotHistoricCandlesRequestV2 {
+    symbol: string;
+    granularity: SpotKlineIntervalV2;
+    endTime?: string;
+    limit?: string;
+}
+export interface SpotHistoricTradesRequestV2 {
+    symbol: string;
+    limit?: string;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+}
+/**
+ *
+ * * Spot | Trade
+ *
+ */
+export type SpotOrderSideV2 = 'buy' | 'sell';
+export type SpotOrderTypeV2 = 'limit' | 'market';
+export type SpotOrderForceV2 = 'gtc' | 'post_only' | 'fok' | 'ioc';
+export type SpotTPSLTypeV2 = 'normal' | 'tpsl';
+export type SpotSTPModeV2 = 'none' | 'cancel_taker' | 'cancel_maker' | 'cancel_both';
+export type SpotBatchModeV2 = 'single' | 'multiple';
+export interface SpotOrderRequestV2 {
+    symbol: string;
+    side: SpotOrderSideV2;
+    orderType: SpotOrderTypeV2;
+    force: SpotOrderForceV2;
+    price?: string;
+    size: string;
+    clientOid?: string;
+    triggerPrice?: string;
+    tpslType?: SpotTPSLTypeV2;
+    requestTime?: string;
+    receiveWindow?: string;
+    stpMode?: SpotSTPModeV2;
+    presetTakeProfitPrice?: string;
+    executeTakeProfitPrice?: string;
+    presetStopLossPrice?: string;
+    executeStopLossPrice?: string;
+}
+export interface SpotCancelandSubmitOrderRequestV2 {
+    symbol: string;
+    price: string;
+    size: string;
+    orderId?: string;
+    clientOid?: string;
+    newClientOid?: string;
+    presetTakeProfitPrice?: string;
+    executeTakeProfitPrice?: string;
+    presetStopLossPrice?: string;
+    executeStopLossPrice?: string;
+}
+export interface SpotCancelOrderRequestV2 {
+    symbol: string;
+    tpslType?: SpotTPSLTypeV2;
+    orderId?: string;
+    clientOid?: string;
+}
+export interface SpotBatchOrderRequestItemV2 {
+    symbol?: string;
+    side: SpotOrderSideV2;
+    orderType: SpotOrderTypeV2;
+    force: SpotOrderForceV2;
+    price?: string;
+    size: string;
+    clientOid?: string;
+    stpMode?: SpotSTPModeV2;
+    presetTakeProfitPrice?: string;
+    executeTakeProfitPrice?: string;
+    presetStopLossPrice?: string;
+    executeStopLossPrice?: string;
+}
+export interface SpotBatchOrderRequestV2 {
+    symbol?: string;
+    batchMode?: SpotBatchModeV2;
+    orderList: SpotBatchOrderRequestItemV2[];
+}
+export interface SpotBatchCancelOrderRequestV2 {
+    symbol?: string;
+    batchMode?: SpotBatchModeV2;
+    orderList: {
+        symbol?: string;
+        orderId?: string;
+        clientOid?: string;
+    }[];
+}
+export interface GetSpotOrderInfoRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    requestTime?: string;
+    receiveWindow?: string;
+}
+export interface GetSpotOpenOrdersRequestV2 {
+    symbol?: string;
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    orderId?: string;
+    tpslType?: SpotTPSLTypeV2;
+    requestTime?: string;
+    receiveWindow?: string;
+}
+export interface GetSpotHistoryOrdersRequestV2 {
+    symbol?: string;
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+    orderId?: string;
+    tpslType?: SpotTPSLTypeV2;
+    requestTime?: string;
+    receiveWindow?: string;
+}
+export interface GetSpotFillsRequestV2 {
+    symbol: string;
+    orderId?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+/**
+ *
+ * * Spot | Trigger Orders
+ *
+ */
+export type SpotPlanTypeV2 = 'amount' | 'total';
+export type SpotTriggerTypeV2 = 'fill_price' | 'mark_price';
+export interface SpotPlanOrderRequestV2 {
+    symbol: string;
+    side: SpotOrderSideV2;
+    triggerPrice: string;
+    orderType: SpotOrderTypeV2;
+    executePrice?: string;
+    planType?: SpotPlanTypeV2;
+    size: string;
+    triggerType: SpotTriggerTypeV2;
+    clientOid?: string;
+    force?: SpotOrderForceV2;
+    stpMode?: SpotSTPModeV2;
+}
+export interface SpotModifyPlanOrderRequestV2 {
+    orderId?: string;
+    clientOid?: string;
+    triggerPrice: string;
+    orderType: SpotOrderTypeV2;
+    executePrice?: string;
+    size: string;
+}
+export interface GetSpotCurrentPlanOrdersRequestV2 {
+    symbol: string;
+    limit?: string;
+    idLessThan?: string;
+    startTime?: string;
+    endTime?: string;
+}
+export interface GetSpotHistoryPlanOrdersRequestV2 {
+    symbol: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+}
+/**
+ *
+ * * Spot | Account
+ *
+ */
+export type SpotBillGroupTypeV2 = 'deposit' | 'withdraw' | 'transaction' | 'transfer' | 'other';
+export type SpotBusinessTypeV2 = 'deposit' | 'withdraw' | 'buy' | 'sell' | 'deduction of handling fee' | 'transfer-in' | 'transfer-out' | 'rebate rewards' | 'airdrop rewards' | 'USDT contract rewards' | 'mix contract rewards' | 'system lock' | 'user lock';
+export type SpotAccountTypeV2 = 'spot' | 'p2p' | 'coin_futures' | 'usdt_futures' | 'usdc_futures' | 'crossed_margin' | 'isolated_margin';
+export interface GetSpotAccountBillsRequestV2 {
+    coin?: string;
+    groupType?: SpotBillGroupTypeV2;
+    businessType?: SpotBusinessTypeV2;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface SpotTransferRequestV2 {
+    fromType: SpotAccountTypeV2;
+    toType: SpotAccountTypeV2;
+    amount: string;
+    coin: string;
+    symbol: string;
+    clientOid?: string;
+}
+export interface SpotSubAccountTransferRequestV2 {
+    fromType: SpotAccountTypeV2;
+    toType: SpotAccountTypeV2;
+    amount: string;
+    coin: string;
+    symbol?: string;
+    clientOid?: string;
+    fromUserId: string;
+    toUserId: string;
+}
+export interface SpotWithdrawalRequestV2 {
+    coin: string;
+    transferType: 'on_chain' | 'internal_transfer';
+    address: string;
+    chain?: string;
+    innerToType?: 'email' | 'mobile' | 'uid';
+    areaCode?: string;
+    tag?: string;
+    size: string;
+    remark?: string;
+    clientOid?: string;
+}
+export interface SpotMainSubTransferRecordRequestV2 {
+    coin?: string;
+    role?: 'initiator' | 'receiver';
+    subUid?: string;
+    startTime?: string;
+    endTime?: string;
+    clientOid?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetSpotTransferRecordRequestV2 {
+    coin: string;
+    fromType: SpotAccountTypeV2;
+    startTime?: string;
+    endTime?: string;
+    clientOid?: string;
+    limit?: string;
+    idLessThan?: string;
+}
+export interface GetSpotSubAccountDepositRecordRequestV2 {
+    subUid: string;
+    coin?: string;
+    startTime?: string;
+    endTime?: string;
+    idLessThan?: string;
+    limit?: string;
+}
+export interface GetSpotWithdrawalRecordRequestV2 {
+    coin?: string;
+    clientOid?: string;
+    startTime: string;
+    endTime: string;
+    idLessThan?: string;
+    orderId?: string;
+    limit?: string;
+}
+export interface GetSpotDepositRecordRequestV2 {
+    coin?: string;
+    orderId?: string;
+    startTime: string;
+    endTime: string;
+    idLessThan?: string;
+    limit?: string;
+}
+export {};

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

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

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

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

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

@@ -0,0 +1,162 @@
+export interface SetLeverageRequestV3 {
+    category: 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    leverage: string;
+    coin?: string;
+    posSide?: 'long' | 'short';
+}
+export interface GetConvertRecordsRequestV3 {
+    fromCoin: string;
+    toCoin: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetFinancialRecordsRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    coin?: string;
+    type?: string;
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface RepayRequestV3 {
+    repayableCoinList: string[];
+    paymentCoinList: string[];
+}
+export interface CreateSubAccountApiKeyRequestV3 {
+    subUid: string;
+    note: string;
+    type: 'read_write' | 'read_only';
+    passphrase: string;
+    permissions: string[];
+    ips: string[];
+}
+export interface DeleteSubAccountApiKeyRequestV3 {
+    apiKey: string;
+}
+export interface GetSubAccountApiKeysRequestV3 {
+    subUid: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface UpdateSubAccountApiKeyRequestV3 {
+    apiKey: string;
+    passphrase: string;
+    type?: 'read_write' | 'read_only';
+    permissions?: string[];
+    ips?: string[];
+}
+export interface CreateSubAccountRequestV3 {
+    username: string;
+    accountMode?: 'classic' | 'unified';
+    note?: string;
+}
+export interface FreezeSubAccountRequestV3 {
+    subUid: string;
+    operation: 'freeze' | 'unfreeze';
+}
+export interface GetSubAccountListRequestV3 {
+    limit?: string;
+    cursor?: string;
+}
+export interface TransferRequestV3 {
+    fromType: 'spot' | 'p2p' | 'coin-futures' | 'usdt-futures' | 'usdc-futures' | 'crossed-margin' | 'isolated-margin' | 'uta';
+    toType: 'spot' | 'p2p' | 'coin-futures' | 'usdt-futures' | 'usdc-futures' | 'crossed-margin' | 'isolated-margin' | 'uta';
+    amount: string;
+    coin: string;
+    symbol?: string;
+}
+export interface GetTransferableCoinsRequestV3 {
+    fromType: 'spot' | 'p2p' | 'coin-futures' | 'usdt-futures' | 'usdc-futures' | 'crossed-margin' | 'isolated-margin' | 'uta';
+    toType: 'spot' | 'p2p' | 'coin-futures' | 'usdt-futures' | 'usdc-futures' | 'crossed-margin' | 'isolated-margin' | 'uta';
+}
+export interface GetSubTransferRecordsRequestV3 {
+    subUid?: string;
+    role?: 'initiator' | 'receiver';
+    coin?: string;
+    startTime?: string;
+    endTime?: string;
+    clientOid?: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface SubAccountTransferRequestV3 {
+    fromType: 'spot' | 'p2p' | 'usdt_futures' | 'coin_futures' | 'usdc_futures' | 'crossed_margin' | 'uta';
+    toType: 'spot' | 'p2p' | 'usdt_futures' | 'coin_futures' | 'usdc_futures' | 'crossed_margin' | 'uta';
+    amount: string;
+    coin: string;
+    fromUserId: string;
+    toUserId: string;
+    clientOid: string;
+}
+export interface GetSubUnifiedAssetsRequestV3 {
+    subUid?: string;
+    cursor?: string;
+    limit?: string;
+}
+export interface GetFeeRateRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+}
+export interface GetFundingAssetsRequestV3 {
+    coin?: string;
+}
+export interface SwitchDeductRequestV3 {
+    deduct: 'on' | 'off';
+}
+export interface GetDepositAddressRequestV3 {
+    coin: string;
+    chain?: string;
+    size?: string;
+}
+export interface GetSubDepositAddressRequestV3 {
+    subUid: string;
+    coin: string;
+    chain?: string;
+    size?: string;
+}
+export interface GetDepositRecordsRequestV3 {
+    coin?: string;
+    orderId?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface GetSubDepositRecordsRequestV3 {
+    coin?: string;
+    subUid: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    cursor?: string;
+}
+export interface WithdrawRequestV3 {
+    coin: string;
+    chain?: string;
+    transferType: 'on_chain' | 'internal_transfer';
+    address: string;
+    innerToType?: 'uid' | 'email' | 'mobile';
+    areaCode?: string;
+    tag?: string;
+    size: string;
+    remark?: string;
+    clientOid?: string;
+    memberCode?: 'bithumb' | 'korbit' | 'coinone';
+    identityType?: 'company' | 'user';
+    companyName?: string;
+    firstName?: string;
+    lastName?: string;
+}
+export interface GetWithdrawRecordsRequestV3 {
+    coin?: string;
+    orderId?: string;
+    clientOid?: string;
+    startTime: string;
+    endTime: string;
+    limit?: string;
+    cursor?: string;
+}

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

@@ -0,0 +1,3 @@
+// Account Management Request Types
+export {};
+//# sourceMappingURL=account.js.map

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

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

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

@@ -0,0 +1,31 @@
+export interface GetTransferedRequestV3 {
+    userId?: string;
+    coin: string;
+}
+export interface GetSymbolsRequestV3 {
+    productId: string;
+}
+export interface GetRepaidHistoryRequestV3 {
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+}
+export interface GetProductInfosRequestV3 {
+    productId: string;
+}
+export interface GetLoanOrderRequestV3 {
+    orderId?: string;
+    startTime?: string;
+    endTime?: string;
+}
+export interface GetEnsureCoinsRequestV3 {
+    productId: string;
+}
+export interface BindUidRequestV3 {
+    riskUnitId?: string;
+    uid: string;
+    operate: 'bind' | 'unbind';
+}
+export interface GetLTVConvertRequestV3 {
+    riskUnitId?: string;
+}

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

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

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

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

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

@@ -0,0 +1,65 @@
+export interface GetPublicFillsRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    limit?: string;
+}
+export interface GetCandlesRequestV3 {
+    category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    interval: '1m' | '3m' | '5m' | '15m' | '30m' | '1H' | '4H' | '6H' | '12H' | '1D';
+    startTime?: string;
+    endTime?: string;
+    type?: 'MARKET' | 'MARK' | 'INDEX';
+    limit?: string;
+}
+export interface GetHistoryCandlesRequestV3 {
+    category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    interval: '1m' | '3m' | '5m' | '15m' | '30m' | '1H' | '4H' | '6H' | '12H' | '1D';
+    startTime?: string;
+    endTime?: string;
+    type?: 'MARKET' | 'MARK' | 'INDEX';
+    limit?: string;
+}
+export interface GetContractsOiRequestV3 {
+    symbol?: string;
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+}
+export interface GetCurrentFundingRateRequestV3 {
+    symbol: string;
+}
+export interface GetHistoryFundingRateRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    cursor?: string;
+    limit?: string;
+}
+export interface GetMarginLoansRequestV3 {
+    coin: string;
+}
+export interface GetOpenInterestRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+}
+export interface GetPositionTierRequestV3 {
+    category: 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+    coin?: string;
+}
+export interface GetRiskReserveRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+}
+export interface GetInstrumentsRequestV3 {
+    category: 'SPOT' | 'MARGIN' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+}
+export interface GetOrderBookRequestV3 {
+    category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    limit?: string;
+}
+export interface GetTickersRequestV3 {
+    category: 'SPOT' | 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol?: string;
+}

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

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

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

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

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

@@ -0,0 +1,46 @@
+export interface PlaceStrategyOrderRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    symbol: string;
+    clientOid?: string;
+    type?: 'tpsl';
+    tpslMode?: 'full' | 'partial';
+    qty: string;
+    posSide: 'long' | 'short';
+    tpTriggerBy?: 'market' | 'mark';
+    slTriggerBy?: 'market' | 'mark';
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: 'limit' | 'market';
+    slOrderType?: 'limit' | 'market';
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+}
+export interface ModifyStrategyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+    qty: string;
+    tpTriggerBy?: 'market' | 'mark';
+    slTriggerBy?: 'market' | 'mark';
+    takeProfit?: string;
+    stopLoss?: string;
+    tpOrderType?: 'limit' | 'market';
+    slOrderType?: 'limit' | 'market';
+    tpLimitPrice?: string;
+    slLimitPrice?: string;
+}
+export interface CancelStrategyOrderRequestV3 {
+    orderId?: string;
+    clientOid?: string;
+}
+export interface GetUnfilledStrategyOrdersRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    type?: 'tpsl';
+}
+export interface GetHistoryStrategyOrdersRequestV3 {
+    category: 'USDT-FUTURES' | 'COIN-FUTURES' | 'USDC-FUTURES';
+    type?: 'tpsl';
+    startTime?: string;
+    endTime?: string;
+    limit?: string;
+    cursor?: string;
+}

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

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

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

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