code/bitget-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(): nothing changed, LF/CRLF only

Browse Source
This commit is contained in:
JJ-Cro
2024-12-10 13:21:49 +01:00
parent cf2464a210
commit d7dfaf205c
1 changed files with 441 additions and 441 deletions
Download Patch File Download Diff File Expand all files Collapse all files

882
src/types/request/v2/futures.ts
View File

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