TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/tiagosiebler/bitget-api/llms.txt
Use this file to discover all available pages before exploring further.
RestClientV2 class provides a unified interface for all futures markets on Bitget, supporting USDT-margined, coin-margined, and USDC-margined perpetual contracts. Every futures method accepts a productType parameter that routes the request to the correct market. Authenticated methods cover position management, leverage configuration, and the full order lifecycle including plan (trigger) and TP/SL orders.
Product types
Every futures method that is market-specific requires aproductType value from FuturesProductTypeV2:
| Value | Market |
|---|---|
'USDT-FUTURES' | USDT-margined perpetuals (most liquid) |
'COIN-FUTURES' | Coin-margined (inverse) perpetuals |
'USDC-FUTURES' | USDC-margined perpetuals |
'SUSDT-FUTURES' | Simulated USDT-margined (testnet) |
'SCOIN-FUTURES' | Simulated coin-margined (testnet) |
'SUSDC-FUTURES' | Simulated USDC-margined (testnet) |
Market Data
These endpoints are public and do not require authentication.| Method | Description |
|---|---|
getFuturesTicker(params) | Single ticker for a symbol + productType |
getFuturesAllTickers(params) | All tickers for a given productType |
getFuturesCandles(params) | OHLCV candles with optional kLineType (MARKET, MARK, INDEX) |
getFuturesHistoricCandles(params) | Historical candles beyond the rolling window |
getFuturesRecentTrades(params) | Latest trades for a symbol |
getFuturesCurrentFundingRate(params) | Current funding rate for a perpetual contract |
getFuturesHistoricFundingRates(params) | Paginated funding rate history |
getFuturesOpenInterest(params) | Open interest in contracts and notional value |
getFuturesPositionTier(params) | Risk tier configuration (leverage vs. position size) |
getFuturesContractConfig(params) | Contract specifications including minTradeNum |
getFuturesSymbolPrice(params) | Current mark/index price for a symbol |
Account
All account endpoints require authentication.| Method | Description |
|---|---|
getFuturesAccountAsset(params) | Single account asset (requires symbol, marginCoin) |
getFuturesAccountAssets(params) | All assets for a productType |
getFuturesAccountBills(params) | Paginated billing records (PnL, fees, funding) |
setFuturesLeverage(params) | Set leverage for a symbol; specify holdSide for one-way mode |
setFuturesMarginMode(params) | Switch between 'isolated' and 'crossed' margin |
setFuturesPositionMode(params) | Set position mode ('one_way_mode' or 'hedge_mode') |
getFuturesMaxOpenableQuantity(params) | Maximum quantity openable given margin and price |
getFuturesLiquidationPrice(params) | Estimated liquidation price for a hypothetical position |
Positions
| Method | Description |
|---|---|
getFuturesPosition(params) | Single position for a symbol and margin coin |
getFuturesPositions(params) | All open positions for a productType |
getFuturesHistoricPositions(params) | Closed position history with pagination |
setFuturesPositionMargin(params) | Add or reduce margin on an isolated position |
setFuturesPositionAutoMargin(params) | Enable or disable auto-margin ('on' / 'off') |
Orders
| Method | Description |
|---|---|
futuresSubmitOrder(params) | Place a single futures order |
futuresCancelOrder(params) | Cancel an order by orderId or clientOid |
futuresBatchSubmitOrders(params) | Place multiple orders in one request |
futuresBatchCancelOrders(params) | Cancel multiple orders by ID list |
futuresCancelAllOrders(params) | Cancel all open orders for a product type |
futuresFlashClosePositions(params) | Market-close one or all positions instantly |
getFuturesOpenOrders(params) | List currently open orders |
getFuturesHistoricOrders(params) | Paginated order history |
getFuturesOrder(params) | Retrieve a single order |
futuresSubmitTPSLOrder(params) | Place a take-profit / stop-loss order |
futuresSubmitPlanOrder(params) | Place a trigger (plan) order |
futuresCancelPlanOrder(params) | Cancel a plan order |
FuturesPlaceOrderRequestV2 parameters
Contract symbol, e.g.
"BTCUSDT".Market type, e.g.
"USDT-FUTURES".Margin mode.
'crossed' shares margin across positions; 'isolated' limits risk to the allocated margin.Settlement currency, e.g.
"USDT" for USDT-FUTURES.Order direction.
Execution type.
Quantity in contracts (use
minTradeNum from getFuturesContractConfig as the minimum).Required in hedge mode to specify whether this order opens or closes a position.
Limit price. Required when
orderType is 'limit'.When
'YES', the order can only reduce an existing position.Preset take-profit price attached to this entry order.
Preset stop-loss price attached to this entry order.