FuturesApi (gate-api 5.20.0 API)

java.lang.Object
- io.gate.gateapi.api.FuturesApi

```
public class FuturesApi
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`FuturesApi.APIgetMyTradesRequest`
`class`	`FuturesApi.APIlistContractStatsRequest`
`class`	`FuturesApi.APIlistFuturesAccountBookRequest`
`class`	`FuturesApi.APIlistFuturesCandlesticksRequest`
`class`	`FuturesApi.APIlistFuturesFundingRateHistoryRequest`
`class`	`FuturesApi.APIlistFuturesInsuranceLedgerRequest`
`class`	`FuturesApi.APIlistFuturesOrderBookRequest`
`class`	`FuturesApi.APIlistFuturesOrdersRequest`
`class`	`FuturesApi.APIlistFuturesTickersRequest`
`class`	`FuturesApi.APIlistFuturesTradesRequest`
`class`	`FuturesApi.APIlistLiquidatedOrdersRequest`
`class`	`FuturesApi.APIlistLiquidatesRequest`
`class`	`FuturesApi.APIlistPositionCloseRequest`
`class`	`FuturesApi.APIlistPriceTriggeredOrdersRequest`

Constructor Summary

Constructors
Constructor and Description

FuturesApi()

FuturesApi(ApiClient apiClient)

Constructors
Constructor and Description
`FuturesApi()`
`FuturesApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FuturesOrder`	`cancelFuturesOrder(String settle, String orderId)` Cancel a single order
`okhttp3.Call`	`cancelFuturesOrderAsync(String settle, String orderId, ApiCallback<FuturesOrder> _callback)` Cancel a single order (asynchronously)
`okhttp3.Call`	`cancelFuturesOrderCall(String settle, String orderId, ApiCallback _callback)` Build call for cancelFuturesOrder
`List<FuturesOrder>`	`cancelFuturesOrders(String settle, String contract, String side)` Cancel all `open` orders matched Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`cancelFuturesOrdersAsync(String settle, String contract, String side, ApiCallback<List<FuturesOrder>> _callback)` Cancel all `open` orders matched (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`cancelFuturesOrdersCall(String settle, String contract, String side, ApiCallback _callback)` Build call for cancelFuturesOrders
`ApiResponse<List<FuturesOrder>>`	`cancelFuturesOrdersWithHttpInfo(String settle, String contract, String side)` Cancel all `open` orders matched Zero-fill order cannot be retrieved 60 seconds after cancellation
`ApiResponse<FuturesOrder>`	`cancelFuturesOrderWithHttpInfo(String settle, String orderId)` Cancel a single order
`FuturesPriceTriggeredOrder`	`cancelPriceTriggeredOrder(String settle, String orderId)` Cancel a single order
`okhttp3.Call`	`cancelPriceTriggeredOrderAsync(String settle, String orderId, ApiCallback<FuturesPriceTriggeredOrder> _callback)` Cancel a single order (asynchronously)
`okhttp3.Call`	`cancelPriceTriggeredOrderCall(String settle, String orderId, ApiCallback _callback)` Build call for cancelPriceTriggeredOrder
`List<FuturesPriceTriggeredOrder>`	`cancelPriceTriggeredOrderList(String settle, String contract)` Cancel all open orders
`okhttp3.Call`	`cancelPriceTriggeredOrderListAsync(String settle, String contract, ApiCallback<List<FuturesPriceTriggeredOrder>> _callback)` Cancel all open orders (asynchronously)
`okhttp3.Call`	`cancelPriceTriggeredOrderListCall(String settle, String contract, ApiCallback _callback)` Build call for cancelPriceTriggeredOrderList
`ApiResponse<List<FuturesPriceTriggeredOrder>>`	`cancelPriceTriggeredOrderListWithHttpInfo(String settle, String contract)` Cancel all open orders
`ApiResponse<FuturesPriceTriggeredOrder>`	`cancelPriceTriggeredOrderWithHttpInfo(String settle, String orderId)` Cancel a single order
`FuturesOrder`	`createFuturesOrder(String settle, FuturesOrder futuresOrder)` Create a futures order Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`createFuturesOrderAsync(String settle, FuturesOrder futuresOrder, ApiCallback<FuturesOrder> _callback)` Create a futures order (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`createFuturesOrderCall(String settle, FuturesOrder futuresOrder, ApiCallback _callback)` Build call for createFuturesOrder
`ApiResponse<FuturesOrder>`	`createFuturesOrderWithHttpInfo(String settle, FuturesOrder futuresOrder)` Create a futures order Zero-fill order cannot be retrieved 60 seconds after cancellation
`TriggerOrderResponse`	`createPriceTriggeredOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder)` Create a price-triggered order
`okhttp3.Call`	`createPriceTriggeredOrderAsync(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, ApiCallback<TriggerOrderResponse> _callback)` Create a price-triggered order (asynchronously)
`okhttp3.Call`	`createPriceTriggeredOrderCall(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, ApiCallback _callback)` Build call for createPriceTriggeredOrder
`ApiResponse<TriggerOrderResponse>`	`createPriceTriggeredOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder)` Create a price-triggered order
`ApiClient`	`getApiClient()`
`List<Position>`	`getDualModePosition(String settle, String contract)` Retrieve position detail in dual mode
`okhttp3.Call`	`getDualModePositionAsync(String settle, String contract, ApiCallback<List<Position>> _callback)` Retrieve position detail in dual mode (asynchronously)
`okhttp3.Call`	`getDualModePositionCall(String settle, String contract, ApiCallback _callback)` Build call for getDualModePosition
`ApiResponse<List<Position>>`	`getDualModePositionWithHttpInfo(String settle, String contract)` Retrieve position detail in dual mode
`Contract`	`getFuturesContract(String settle, String contract)` Get a single contract
`okhttp3.Call`	`getFuturesContractAsync(String settle, String contract, ApiCallback<Contract> _callback)` Get a single contract (asynchronously)
`okhttp3.Call`	`getFuturesContractCall(String settle, String contract, ApiCallback _callback)` Build call for getFuturesContract
`ApiResponse<Contract>`	`getFuturesContractWithHttpInfo(String settle, String contract)` Get a single contract
`FuturesOrder`	`getFuturesOrder(String settle, String orderId)` Get a single order Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`getFuturesOrderAsync(String settle, String orderId, ApiCallback<FuturesOrder> _callback)` Get a single order (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation
`okhttp3.Call`	`getFuturesOrderCall(String settle, String orderId, ApiCallback _callback)` Build call for getFuturesOrder
`ApiResponse<FuturesOrder>`	`getFuturesOrderWithHttpInfo(String settle, String orderId)` Get a single order Zero-fill order cannot be retrieved 60 seconds after cancellation
`FuturesApi.APIgetMyTradesRequest`	`getMyTrades(String settle)` List personal trading history
`Position`	`getPosition(String settle, String contract)` Get single position
`okhttp3.Call`	`getPositionAsync(String settle, String contract, ApiCallback<Position> _callback)` Get single position (asynchronously)
`okhttp3.Call`	`getPositionCall(String settle, String contract, ApiCallback _callback)` Build call for getPosition
`ApiResponse<Position>`	`getPositionWithHttpInfo(String settle, String contract)` Get single position
`FuturesPriceTriggeredOrder`	`getPriceTriggeredOrder(String settle, String orderId)` Get a single order
`okhttp3.Call`	`getPriceTriggeredOrderAsync(String settle, String orderId, ApiCallback<FuturesPriceTriggeredOrder> _callback)` Get a single order (asynchronously)
`okhttp3.Call`	`getPriceTriggeredOrderCall(String settle, String orderId, ApiCallback _callback)` Build call for getPriceTriggeredOrder
`ApiResponse<FuturesPriceTriggeredOrder>`	`getPriceTriggeredOrderWithHttpInfo(String settle, String orderId)` Get a single order
`FuturesApi.APIlistContractStatsRequest`	`listContractStats(String settle, String contract)` Futures stats
`FuturesApi.APIlistFuturesAccountBookRequest`	`listFuturesAccountBook(String settle)` Query account book
`FuturesAccount`	`listFuturesAccounts(String settle)` Query futures account
`okhttp3.Call`	`listFuturesAccountsAsync(String settle, ApiCallback<FuturesAccount> _callback)` Query futures account (asynchronously)
`okhttp3.Call`	`listFuturesAccountsCall(String settle, ApiCallback _callback)` Build call for listFuturesAccounts
`ApiResponse<FuturesAccount>`	`listFuturesAccountsWithHttpInfo(String settle)` Query futures account
`FuturesApi.APIlistFuturesCandlesticksRequest`	`listFuturesCandlesticks(String settle, String contract)` Get futures candlesticks Return specified contract candlesticks.
`List<Contract>`	`listFuturesContracts(String settle)` List all futures contracts
`okhttp3.Call`	`listFuturesContractsAsync(String settle, ApiCallback<List<Contract>> _callback)` List all futures contracts (asynchronously)
`okhttp3.Call`	`listFuturesContractsCall(String settle, ApiCallback _callback)` Build call for listFuturesContracts
`ApiResponse<List<Contract>>`	`listFuturesContractsWithHttpInfo(String settle)` List all futures contracts
`FuturesApi.APIlistFuturesFundingRateHistoryRequest`	`listFuturesFundingRateHistory(String settle, String contract)` Funding rate history
`FuturesApi.APIlistFuturesInsuranceLedgerRequest`	`listFuturesInsuranceLedger(String settle)` Futures insurance balance history
`FuturesApi.APIlistFuturesOrderBookRequest`	`listFuturesOrderBook(String settle, String contract)` Futures order book Bids will be sorted by price from high to low, while asks sorted reversely
`FuturesApi.APIlistFuturesOrdersRequest`	`listFuturesOrders(String settle, String contract, String status)` List futures orders Zero-fill order cannot be retrieved 60 seconds after cancellation
`FuturesApi.APIlistFuturesTickersRequest`	`listFuturesTickers(String settle)` List futures tickers
`FuturesApi.APIlistFuturesTradesRequest`	`listFuturesTrades(String settle, String contract)` Futures trading history
`FuturesApi.APIlistLiquidatedOrdersRequest`	`listLiquidatedOrders(String settle)` Retrieve liquidation history Interval between `from` and `to` cannot exceeds 3600.
`FuturesApi.APIlistLiquidatesRequest`	`listLiquidates(String settle)` List liquidation history
`FuturesApi.APIlistPositionCloseRequest`	`listPositionClose(String settle)` List position close history
`List<Position>`	`listPositions(String settle)` List all positions of a user
`okhttp3.Call`	`listPositionsAsync(String settle, ApiCallback<List<Position>> _callback)` List all positions of a user (asynchronously)
`okhttp3.Call`	`listPositionsCall(String settle, ApiCallback _callback)` Build call for listPositions
`ApiResponse<List<Position>>`	`listPositionsWithHttpInfo(String settle)` List all positions of a user
`FuturesApi.APIlistPriceTriggeredOrdersRequest`	`listPriceTriggeredOrders(String settle, String status)` List all auto orders
`void`	`setApiClient(ApiClient apiClient)`
`FuturesAccount`	`setDualMode(String settle, Boolean dualMode)` Enable or disable dual mode Before setting dual mode, make sure all positions are closed and no orders are open
`okhttp3.Call`	`setDualModeAsync(String settle, Boolean dualMode, ApiCallback<FuturesAccount> _callback)` Enable or disable dual mode (asynchronously) Before setting dual mode, make sure all positions are closed and no orders are open
`okhttp3.Call`	`setDualModeCall(String settle, Boolean dualMode, ApiCallback _callback)` Build call for setDualMode
`ApiResponse<FuturesAccount>`	`setDualModeWithHttpInfo(String settle, Boolean dualMode)` Enable or disable dual mode Before setting dual mode, make sure all positions are closed and no orders are open
`List<Position>`	`updateDualModePositionLeverage(String settle, String contract, String leverage)` Update position leverage in dual mode
`okhttp3.Call`	`updateDualModePositionLeverageAsync(String settle, String contract, String leverage, ApiCallback<List<Position>> _callback)` Update position leverage in dual mode (asynchronously)
`okhttp3.Call`	`updateDualModePositionLeverageCall(String settle, String contract, String leverage, ApiCallback _callback)` Build call for updateDualModePositionLeverage
`ApiResponse<List<Position>>`	`updateDualModePositionLeverageWithHttpInfo(String settle, String contract, String leverage)` Update position leverage in dual mode
`List<Position>`	`updateDualModePositionMargin(String settle, String contract, String change)` Update position margin in dual mode
`okhttp3.Call`	`updateDualModePositionMarginAsync(String settle, String contract, String change, ApiCallback<List<Position>> _callback)` Update position margin in dual mode (asynchronously)
`okhttp3.Call`	`updateDualModePositionMarginCall(String settle, String contract, String change, ApiCallback _callback)` Build call for updateDualModePositionMargin
`ApiResponse<List<Position>>`	`updateDualModePositionMarginWithHttpInfo(String settle, String contract, String change)` Update position margin in dual mode
`List<Position>`	`updateDualModePositionRiskLimit(String settle, String contract, String riskLimit)` Update position risk limit in dual mode
`okhttp3.Call`	`updateDualModePositionRiskLimitAsync(String settle, String contract, String riskLimit, ApiCallback<List<Position>> _callback)` Update position risk limit in dual mode (asynchronously)
`okhttp3.Call`	`updateDualModePositionRiskLimitCall(String settle, String contract, String riskLimit, ApiCallback _callback)` Build call for updateDualModePositionRiskLimit
`ApiResponse<List<Position>>`	`updateDualModePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit)` Update position risk limit in dual mode
`Position`	`updatePositionLeverage(String settle, String contract, String leverage)` Update position leverage
`okhttp3.Call`	`updatePositionLeverageAsync(String settle, String contract, String leverage, ApiCallback<Position> _callback)` Update position leverage (asynchronously)
`okhttp3.Call`	`updatePositionLeverageCall(String settle, String contract, String leverage, ApiCallback _callback)` Build call for updatePositionLeverage
`ApiResponse<Position>`	`updatePositionLeverageWithHttpInfo(String settle, String contract, String leverage)` Update position leverage
`Position`	`updatePositionMargin(String settle, String contract, String change)` Update position margin
`okhttp3.Call`	`updatePositionMarginAsync(String settle, String contract, String change, ApiCallback<Position> _callback)` Update position margin (asynchronously)
`okhttp3.Call`	`updatePositionMarginCall(String settle, String contract, String change, ApiCallback _callback)` Build call for updatePositionMargin
`ApiResponse<Position>`	`updatePositionMarginWithHttpInfo(String settle, String contract, String change)` Update position margin
`Position`	`updatePositionRiskLimit(String settle, String contract, String riskLimit)` Update position risk limit
`okhttp3.Call`	`updatePositionRiskLimitAsync(String settle, String contract, String riskLimit, ApiCallback<Position> _callback)` Update position risk limit (asynchronously)
`okhttp3.Call`	`updatePositionRiskLimitCall(String settle, String contract, String riskLimit, ApiCallback _callback)` Build call for updatePositionRiskLimit
`ApiResponse<Position>`	`updatePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit)` Update position risk limit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FuturesApi
```
public FuturesApi()
```

FuturesApi

public FuturesApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

listFuturesContractsCall
```
public okhttp3.Call listFuturesContractsCall(String settle,
                                             ApiCallback _callback)
                                      throws ApiException
```
Build call for listFuturesContracts

Parameters:

settle - Settle currency (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesContracts
```
public List<Contract> listFuturesContracts(String settle)
                                    throws ApiException
```
List all futures contracts

Parameters:

settle - Settle currency (required)

Returns:

List<Contract>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesContractsWithHttpInfo
```
public ApiResponse<List<Contract>> listFuturesContractsWithHttpInfo(String settle)
                                                             throws ApiException
```
List all futures contracts

Parameters:

settle - Settle currency (required)

Returns:

ApiResponse<List<Contract>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesContractsAsync
```
public okhttp3.Call listFuturesContractsAsync(String settle,
                                              ApiCallback<List<Contract>> _callback)
                                       throws ApiException
```
List all futures contracts (asynchronously)

Parameters:

settle - Settle currency (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

getFuturesContractCall
```
public okhttp3.Call getFuturesContractCall(String settle,
                                           String contract,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for getFuturesContract

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Contract information -

getFuturesContract
```
public Contract getFuturesContract(String settle,
                                   String contract)
                            throws ApiException
```
Get a single contract

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

Contract

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Contract information -

getFuturesContractWithHttpInfo
```
public ApiResponse<Contract> getFuturesContractWithHttpInfo(String settle,
                                                            String contract)
                                                     throws ApiException
```
Get a single contract

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

ApiResponse<Contract>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Contract information -

getFuturesContractAsync
```
public okhttp3.Call getFuturesContractAsync(String settle,
                                            String contract,
                                            ApiCallback<Contract> _callback)
                                     throws ApiException
```
Get a single contract (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Contract information -

listFuturesOrderBook
```
public FuturesApi.APIlistFuturesOrderBookRequest listFuturesOrderBook(String settle,
                                                                      String contract)
```
Futures order book Bids will be sorted by price from high to low, while asks sorted reversely

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

APIlistFuturesOrderBookRequest

Http Response Details:

Status Code Description Response Headers

200 Order book retrieved -

listFuturesTrades

public FuturesApi.APIlistFuturesTradesRequest listFuturesTrades(String settle,
                                                                String contract)

Futures trading history

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

APIlistFuturesTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listFuturesCandlesticks
```
public FuturesApi.APIlistFuturesCandlesticksRequest listFuturesCandlesticks(String settle,
                                                                            String contract)
```
Get futures candlesticks Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval`

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

APIlistFuturesCandlesticksRequest

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

listFuturesTickers
```
public FuturesApi.APIlistFuturesTickersRequest listFuturesTickers(String settle)
```
List futures tickers

Parameters:

settle - Settle currency (required)

Returns:

APIlistFuturesTickersRequest

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

listFuturesFundingRateHistory

public FuturesApi.APIlistFuturesFundingRateHistoryRequest listFuturesFundingRateHistory(String settle,
                                                                                        String contract)

Funding rate history

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

APIlistFuturesFundingRateHistoryRequest

Http Response Details:

Status Code	Description	Response Headers
200	History retrieved	-

listFuturesInsuranceLedger
```
public FuturesApi.APIlistFuturesInsuranceLedgerRequest listFuturesInsuranceLedger(String settle)
```
Futures insurance balance history

Parameters:

settle - Settle currency (required)

Returns:

APIlistFuturesInsuranceLedgerRequest

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

listContractStats

public FuturesApi.APIlistContractStatsRequest listContractStats(String settle,
                                                                String contract)

Futures stats

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

APIlistContractStatsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listLiquidatedOrders
```
public FuturesApi.APIlistLiquidatedOrdersRequest listLiquidatedOrders(String settle)
```
Retrieve liquidation history Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail.

Parameters:

settle - Settle currency (required)

Returns:

APIlistLiquidatedOrdersRequest

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesAccountsCall
```
public okhttp3.Call listFuturesAccountsCall(String settle,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for listFuturesAccounts

Parameters:

settle - Settle currency (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesAccounts
```
public FuturesAccount listFuturesAccounts(String settle)
                                   throws ApiException
```
Query futures account

Parameters:

settle - Settle currency (required)

Returns:

FuturesAccount

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesAccountsWithHttpInfo
```
public ApiResponse<FuturesAccount> listFuturesAccountsWithHttpInfo(String settle)
                                                            throws ApiException
```
Query futures account

Parameters:

settle - Settle currency (required)

Returns:

ApiResponse<FuturesAccount>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesAccountsAsync
```
public okhttp3.Call listFuturesAccountsAsync(String settle,
                                             ApiCallback<FuturesAccount> _callback)
                                      throws ApiException
```
Query futures account (asynchronously)

Parameters:

settle - Settle currency (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listFuturesAccountBook
```
public FuturesApi.APIlistFuturesAccountBookRequest listFuturesAccountBook(String settle)
```
Query account book

Parameters:

settle - Settle currency (required)

Returns:

APIlistFuturesAccountBookRequest

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listPositionsCall
```
public okhttp3.Call listPositionsCall(String settle,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for listPositions

Parameters:

settle - Settle currency (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listPositions
```
public List<Position> listPositions(String settle)
                             throws ApiException
```
List all positions of a user

Parameters:

settle - Settle currency (required)

Returns:

List<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listPositionsWithHttpInfo
```
public ApiResponse<List<Position>> listPositionsWithHttpInfo(String settle)
                                                      throws ApiException
```
List all positions of a user

Parameters:

settle - Settle currency (required)

Returns:

ApiResponse<List<Position>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listPositionsAsync
```
public okhttp3.Call listPositionsAsync(String settle,
                                       ApiCallback<List<Position>> _callback)
                                throws ApiException
```
List all positions of a user (asynchronously)

Parameters:

settle - Settle currency (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

getPositionCall
```
public okhttp3.Call getPositionCall(String settle,
                                    String contract,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for getPosition

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Position information -

getPosition
```
public Position getPosition(String settle,
                            String contract)
                     throws ApiException
```
Get single position

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

Position

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

getPositionWithHttpInfo
```
public ApiResponse<Position> getPositionWithHttpInfo(String settle,
                                                     String contract)
                                              throws ApiException
```
Get single position

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

ApiResponse<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

getPositionAsync
```
public okhttp3.Call getPositionAsync(String settle,
                                     String contract,
                                     ApiCallback<Position> _callback)
                              throws ApiException
```
Get single position (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionMarginCall
```
public okhttp3.Call updatePositionMarginCall(String settle,
                                             String contract,
                                             String change,
                                             ApiCallback _callback)
                                      throws ApiException
```
Build call for updatePositionMargin

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionMargin
```
public Position updatePositionMargin(String settle,
                                     String contract,
                                     String change)
                              throws ApiException
```
Update position margin

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

Returns:

Position

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionMarginWithHttpInfo
```
public ApiResponse<Position> updatePositionMarginWithHttpInfo(String settle,
                                                              String contract,
                                                              String change)
                                                       throws ApiException
```
Update position margin

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

Returns:

ApiResponse<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionMarginAsync
```
public okhttp3.Call updatePositionMarginAsync(String settle,
                                              String contract,
                                              String change,
                                              ApiCallback<Position> _callback)
                                       throws ApiException
```
Update position margin (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionLeverageCall

public okhttp3.Call updatePositionLeverageCall(String settle,
                                               String contract,
                                               String leverage,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for updatePositionLeverage

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

updatePositionLeverage
```
public Position updatePositionLeverage(String settle,
                                       String contract,
                                       String leverage)
                                throws ApiException
```
Update position leverage

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

Returns:

Position

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionLeverageWithHttpInfo

public ApiResponse<Position> updatePositionLeverageWithHttpInfo(String settle,
                                                                String contract,
                                                                String leverage)
                                                         throws ApiException

Update position leverage

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

Returns:

ApiResponse<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

updatePositionLeverageAsync

public okhttp3.Call updatePositionLeverageAsync(String settle,
                                                String contract,
                                                String leverage,
                                                ApiCallback<Position> _callback)
                                         throws ApiException

Update position leverage (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

updatePositionRiskLimitCall

public okhttp3.Call updatePositionRiskLimitCall(String settle,
                                                String contract,
                                                String riskLimit,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for updatePositionRiskLimit

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

updatePositionRiskLimit
```
public Position updatePositionRiskLimit(String settle,
                                        String contract,
                                        String riskLimit)
                                 throws ApiException
```
Update position risk limit

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

Returns:

Position

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Position information -

updatePositionRiskLimitWithHttpInfo

public ApiResponse<Position> updatePositionRiskLimitWithHttpInfo(String settle,
                                                                 String contract,
                                                                 String riskLimit)
                                                          throws ApiException

Update position risk limit

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

Returns:

ApiResponse<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

updatePositionRiskLimitAsync

public okhttp3.Call updatePositionRiskLimitAsync(String settle,
                                                 String contract,
                                                 String riskLimit,
                                                 ApiCallback<Position> _callback)
                                          throws ApiException

Update position risk limit (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Position information	-

setDualModeCall
```
public okhttp3.Call setDualModeCall(String settle,
                                    Boolean dualMode,
                                    ApiCallback _callback)
                             throws ApiException
```
Build call for setDualMode

Parameters:

settle - Settle currency (required)

dualMode - Whether to enable dual mode (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Updated -

setDualMode
```
public FuturesAccount setDualMode(String settle,
                                  Boolean dualMode)
                           throws ApiException
```
Enable or disable dual mode Before setting dual mode, make sure all positions are closed and no orders are open

Parameters:

settle - Settle currency (required)

dualMode - Whether to enable dual mode (required)

Returns:

FuturesAccount

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Updated -

setDualModeWithHttpInfo
```
public ApiResponse<FuturesAccount> setDualModeWithHttpInfo(String settle,
                                                           Boolean dualMode)
                                                    throws ApiException
```
Enable or disable dual mode Before setting dual mode, make sure all positions are closed and no orders are open

Parameters:

settle - Settle currency (required)

dualMode - Whether to enable dual mode (required)

Returns:

ApiResponse<FuturesAccount>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Updated -

setDualModeAsync
```
public okhttp3.Call setDualModeAsync(String settle,
                                     Boolean dualMode,
                                     ApiCallback<FuturesAccount> _callback)
                              throws ApiException
```
Enable or disable dual mode (asynchronously) Before setting dual mode, make sure all positions are closed and no orders are open

Parameters:

settle - Settle currency (required)

dualMode - Whether to enable dual mode (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Updated -

getDualModePositionCall
```
public okhttp3.Call getDualModePositionCall(String settle,
                                            String contract,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for getDualModePosition

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

getDualModePosition
```
public List<Position> getDualModePosition(String settle,
                                          String contract)
                                   throws ApiException
```
Retrieve position detail in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

List<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

getDualModePositionWithHttpInfo
```
public ApiResponse<List<Position>> getDualModePositionWithHttpInfo(String settle,
                                                                   String contract)
                                                            throws ApiException
```
Retrieve position detail in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

ApiResponse<List<Position>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

getDualModePositionAsync
```
public okhttp3.Call getDualModePositionAsync(String settle,
                                             String contract,
                                             ApiCallback<List<Position>> _callback)
                                      throws ApiException
```
Retrieve position detail in dual mode (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

updateDualModePositionMarginCall

public okhttp3.Call updateDualModePositionMarginCall(String settle,
                                                     String contract,
                                                     String change,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for updateDualModePositionMargin

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionMargin
```
public List<Position> updateDualModePositionMargin(String settle,
                                                   String contract,
                                                   String change)
                                            throws ApiException
```
Update position margin in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

Returns:

List<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

updateDualModePositionMarginWithHttpInfo

public ApiResponse<List<Position>> updateDualModePositionMarginWithHttpInfo(String settle,
                                                                            String contract,
                                                                            String change)
                                                                     throws ApiException

Update position margin in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

Returns:

ApiResponse<List<Position>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionMarginAsync

public okhttp3.Call updateDualModePositionMarginAsync(String settle,
                                                      String contract,
                                                      String change,
                                                      ApiCallback<List<Position>> _callback)
                                               throws ApiException

Update position margin in dual mode (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

change - Margin change. Use positive number to increase margin, negative number otherwise. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionLeverageCall

public okhttp3.Call updateDualModePositionLeverageCall(String settle,
                                                       String contract,
                                                       String leverage,
                                                       ApiCallback _callback)
                                                throws ApiException

Build call for updateDualModePositionLeverage

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionLeverage
```
public List<Position> updateDualModePositionLeverage(String settle,
                                                     String contract,
                                                     String leverage)
                                              throws ApiException
```
Update position leverage in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

Returns:

List<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

updateDualModePositionLeverageWithHttpInfo

public ApiResponse<List<Position>> updateDualModePositionLeverageWithHttpInfo(String settle,
                                                                              String contract,
                                                                              String leverage)
                                                                       throws ApiException

Update position leverage in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

Returns:

ApiResponse<List<Position>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionLeverageAsync

public okhttp3.Call updateDualModePositionLeverageAsync(String settle,
                                                        String contract,
                                                        String leverage,
                                                        ApiCallback<List<Position>> _callback)
                                                 throws ApiException

Update position leverage in dual mode (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

leverage - New position leverage (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionRiskLimitCall

public okhttp3.Call updateDualModePositionRiskLimitCall(String settle,
                                                        String contract,
                                                        String riskLimit,
                                                        ApiCallback _callback)
                                                 throws ApiException

Build call for updateDualModePositionRiskLimit

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionRiskLimit
```
public List<Position> updateDualModePositionRiskLimit(String settle,
                                                      String contract,
                                                      String riskLimit)
                                               throws ApiException
```
Update position risk limit in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

Returns:

List<Position>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Successfully retrieved -

updateDualModePositionRiskLimitWithHttpInfo

public ApiResponse<List<Position>> updateDualModePositionRiskLimitWithHttpInfo(String settle,
                                                                               String contract,
                                                                               String riskLimit)
                                                                        throws ApiException

Update position risk limit in dual mode

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

Returns:

ApiResponse<List<Position>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

updateDualModePositionRiskLimitAsync

public okhttp3.Call updateDualModePositionRiskLimitAsync(String settle,
                                                         String contract,
                                                         String riskLimit,
                                                         ApiCallback<List<Position>> _callback)
                                                  throws ApiException

Update position risk limit in dual mode (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

riskLimit - New position risk limit (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listFuturesOrders

public FuturesApi.APIlistFuturesOrdersRequest listFuturesOrders(String settle,
                                                                String contract,
                                                                String status)

List futures orders Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

status - List orders based on status (required)

Returns:

APIlistFuturesOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified * X-Pagination-Total - Total number matched. Only returned on `count_total` set to 1

createFuturesOrderCall

public okhttp3.Call createFuturesOrderCall(String settle,
                                           FuturesOrder futuresOrder,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for createFuturesOrder

Parameters:

settle - Settle currency (required)

futuresOrder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Order details	-

createFuturesOrder
```
public FuturesOrder createFuturesOrder(String settle,
                                       FuturesOrder futuresOrder)
                                throws ApiException
```
Create a futures order Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

futuresOrder - (required)

Returns:

FuturesOrder

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Order details -

createFuturesOrderWithHttpInfo
```
public ApiResponse<FuturesOrder> createFuturesOrderWithHttpInfo(String settle,
                                                                FuturesOrder futuresOrder)
                                                         throws ApiException
```
Create a futures order Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

futuresOrder - (required)

Returns:

ApiResponse<FuturesOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Order details -

createFuturesOrderAsync
```
public okhttp3.Call createFuturesOrderAsync(String settle,
                                            FuturesOrder futuresOrder,
                                            ApiCallback<FuturesOrder> _callback)
                                     throws ApiException
```
Create a futures order (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

futuresOrder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

201 Order details -

cancelFuturesOrdersCall

public okhttp3.Call cancelFuturesOrdersCall(String settle,
                                            String contract,
                                            String side,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for cancelFuturesOrders

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

side - All bids or asks. Both included in not specified (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	All orders matched cancelled	-

cancelFuturesOrders
```
public List<FuturesOrder> cancelFuturesOrders(String settle,
                                              String contract,
                                              String side)
                                       throws ApiException
```
Cancel all `open` orders matched Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

side - All bids or asks. Both included in not specified (optional)

Returns:

List<FuturesOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 All orders matched cancelled -

cancelFuturesOrdersWithHttpInfo
```
public ApiResponse<List<FuturesOrder>> cancelFuturesOrdersWithHttpInfo(String settle,
                                                                       String contract,
                                                                       String side)
                                                                throws ApiException
```
Cancel all `open` orders matched Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

side - All bids or asks. Both included in not specified (optional)

Returns:

ApiResponse<List<FuturesOrder>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 All orders matched cancelled -

cancelFuturesOrdersAsync
```
public okhttp3.Call cancelFuturesOrdersAsync(String settle,
                                             String contract,
                                             String side,
                                             ApiCallback<List<FuturesOrder>> _callback)
                                      throws ApiException
```
Cancel all `open` orders matched (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

side - All bids or asks. Both included in not specified (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 All orders matched cancelled -

getFuturesOrderCall
```
public okhttp3.Call getFuturesOrderCall(String settle,
                                        String orderId,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for getFuturesOrder

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Order details -

getFuturesOrder
```
public FuturesOrder getFuturesOrder(String settle,
                                    String orderId)
                             throws ApiException
```
Get a single order Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

Returns:

FuturesOrder

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Order details -

getFuturesOrderWithHttpInfo
```
public ApiResponse<FuturesOrder> getFuturesOrderWithHttpInfo(String settle,
                                                             String orderId)
                                                      throws ApiException
```
Get a single order Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

Returns:

ApiResponse<FuturesOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Order details -

getFuturesOrderAsync
```
public okhttp3.Call getFuturesOrderAsync(String settle,
                                         String orderId,
                                         ApiCallback<FuturesOrder> _callback)
                                  throws ApiException
```
Get a single order (asynchronously) Zero-fill order cannot be retrieved 60 seconds after cancellation

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Order details -

cancelFuturesOrderCall
```
public okhttp3.Call cancelFuturesOrderCall(String settle,
                                           String orderId,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for cancelFuturesOrder

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Order details -

cancelFuturesOrder
```
public FuturesOrder cancelFuturesOrder(String settle,
                                       String orderId)
                                throws ApiException
```
Cancel a single order

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

Returns:

FuturesOrder

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Order details -

cancelFuturesOrderWithHttpInfo
```
public ApiResponse<FuturesOrder> cancelFuturesOrderWithHttpInfo(String settle,
                                                                String orderId)
                                                         throws ApiException
```
Cancel a single order

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

Returns:

ApiResponse<FuturesOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Order details -

cancelFuturesOrderAsync
```
public okhttp3.Call cancelFuturesOrderAsync(String settle,
                                            String orderId,
                                            ApiCallback<FuturesOrder> _callback)
                                     throws ApiException
```
Cancel a single order (asynchronously)

Parameters:

settle - Settle currency (required)

orderId - Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID are accepted only in the first 30 minutes after order creation.After that, only order ID is accepted. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Order details -

getMyTrades

public FuturesApi.APIgetMyTradesRequest getMyTrades(String settle)

List personal trading history

Parameters:

settle - Settle currency (required)

Returns:

APIgetMyTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	* X-Pagination-Limit - Request limit specified * X-Pagination-Offset - Request offset specified * X-Pagination-Total - Total number matched. Only returned on `count_total` set to 1

listPositionClose
```
public FuturesApi.APIlistPositionCloseRequest listPositionClose(String settle)
```
List position close history

Parameters:

settle - Settle currency (required)

Returns:

APIlistPositionCloseRequest

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listLiquidates
```
public FuturesApi.APIlistLiquidatesRequest listLiquidates(String settle)
```
List liquidation history

Parameters:

settle - Settle currency (required)

Returns:

APIlistLiquidatesRequest

Http Response Details:

Status Code Description Response Headers

200 List retrieved -

listPriceTriggeredOrders

public FuturesApi.APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle,
                                                                              String status)

List all auto orders

Parameters:

settle - Settle currency (required)

status - List orders based on status (required)

Returns:

APIlistPriceTriggeredOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createPriceTriggeredOrderCall

public okhttp3.Call createPriceTriggeredOrderCall(String settle,
                                                  FuturesPriceTriggeredOrder futuresPriceTriggeredOrder,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for createPriceTriggeredOrder

Parameters:

settle - Settle currency (required)

futuresPriceTriggeredOrder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Order created	-

createPriceTriggeredOrder
```
public TriggerOrderResponse createPriceTriggeredOrder(String settle,
                                                      FuturesPriceTriggeredOrder futuresPriceTriggeredOrder)
                                               throws ApiException
```
Create a price-triggered order

Parameters:

settle - Settle currency (required)

futuresPriceTriggeredOrder - (required)

Returns:

TriggerOrderResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

201 Order created -

createPriceTriggeredOrderWithHttpInfo

public ApiResponse<TriggerOrderResponse> createPriceTriggeredOrderWithHttpInfo(String settle,
                                                                               FuturesPriceTriggeredOrder futuresPriceTriggeredOrder)
                                                                        throws ApiException

Create a price-triggered order

Parameters:

settle - Settle currency (required)

futuresPriceTriggeredOrder - (required)

Returns:

ApiResponse<TriggerOrderResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Order created	-

createPriceTriggeredOrderAsync

public okhttp3.Call createPriceTriggeredOrderAsync(String settle,
                                                   FuturesPriceTriggeredOrder futuresPriceTriggeredOrder,
                                                   ApiCallback<TriggerOrderResponse> _callback)
                                            throws ApiException

Create a price-triggered order (asynchronously)

Parameters:

settle - Settle currency (required)

futuresPriceTriggeredOrder - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Order created	-

cancelPriceTriggeredOrderListCall
```
public okhttp3.Call cancelPriceTriggeredOrderListCall(String settle,
                                                      String contract,
                                                      ApiCallback _callback)
                                               throws ApiException
```
Build call for cancelPriceTriggeredOrderList

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Batch cancellation request accepted. Query order status by listing orders -

cancelPriceTriggeredOrderList
```
public List<FuturesPriceTriggeredOrder> cancelPriceTriggeredOrderList(String settle,
                                                                      String contract)
                                                               throws ApiException
```
Cancel all open orders

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

List<FuturesPriceTriggeredOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Batch cancellation request accepted. Query order status by listing orders -

cancelPriceTriggeredOrderListWithHttpInfo
```
public ApiResponse<List<FuturesPriceTriggeredOrder>> cancelPriceTriggeredOrderListWithHttpInfo(String settle,
                                                                                               String contract)
                                                                                        throws ApiException
```
Cancel all open orders

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

Returns:

ApiResponse<List<FuturesPriceTriggeredOrder>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Batch cancellation request accepted. Query order status by listing orders -

cancelPriceTriggeredOrderListAsync
```
public okhttp3.Call cancelPriceTriggeredOrderListAsync(String settle,
                                                       String contract,
                                                       ApiCallback<List<FuturesPriceTriggeredOrder>> _callback)
                                                throws ApiException
```
Cancel all open orders (asynchronously)

Parameters:

settle - Settle currency (required)

contract - Futures contract (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Batch cancellation request accepted. Query order status by listing orders -

getPriceTriggeredOrderCall
```
public okhttp3.Call getPriceTriggeredOrderCall(String settle,
                                               String orderId,
                                               ApiCallback _callback)
                                        throws ApiException
```
Build call for getPriceTriggeredOrder

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

getPriceTriggeredOrder
```
public FuturesPriceTriggeredOrder getPriceTriggeredOrder(String settle,
                                                         String orderId)
                                                  throws ApiException
```
Get a single order

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

Returns:

FuturesPriceTriggeredOrder

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

getPriceTriggeredOrderWithHttpInfo
```
public ApiResponse<FuturesPriceTriggeredOrder> getPriceTriggeredOrderWithHttpInfo(String settle,
                                                                                  String orderId)
                                                                           throws ApiException
```
Get a single order

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

Returns:

ApiResponse<FuturesPriceTriggeredOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

getPriceTriggeredOrderAsync
```
public okhttp3.Call getPriceTriggeredOrderAsync(String settle,
                                                String orderId,
                                                ApiCallback<FuturesPriceTriggeredOrder> _callback)
                                         throws ApiException
```
Get a single order (asynchronously)

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

cancelPriceTriggeredOrderCall
```
public okhttp3.Call cancelPriceTriggeredOrderCall(String settle,
                                                  String orderId,
                                                  ApiCallback _callback)
                                           throws ApiException
```
Build call for cancelPriceTriggeredOrder

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

cancelPriceTriggeredOrder
```
public FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(String settle,
                                                            String orderId)
                                                     throws ApiException
```
Cancel a single order

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

Returns:

FuturesPriceTriggeredOrder

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

cancelPriceTriggeredOrderWithHttpInfo
```
public ApiResponse<FuturesPriceTriggeredOrder> cancelPriceTriggeredOrderWithHttpInfo(String settle,
                                                                                     String orderId)
                                                                              throws ApiException
```
Cancel a single order

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

Returns:

ApiResponse<FuturesPriceTriggeredOrder>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

cancelPriceTriggeredOrderAsync
```
public okhttp3.Call cancelPriceTriggeredOrderAsync(String settle,
                                                   String orderId,
                                                   ApiCallback<FuturesPriceTriggeredOrder> _callback)
                                            throws ApiException
```
Cancel a single order (asynchronously)

Parameters:

settle - Settle currency (required)

orderId - ID returned on order successfully being created (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code Description Response Headers

200 Auto order detail -

Class FuturesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FuturesApi

FuturesApi

Method Detail

getApiClient

setApiClient

listFuturesContractsCall

listFuturesContracts

listFuturesContractsWithHttpInfo

listFuturesContractsAsync

getFuturesContractCall

getFuturesContract

getFuturesContractWithHttpInfo

getFuturesContractAsync

listFuturesOrderBook

listFuturesTrades

listFuturesCandlesticks

listFuturesTickers

listFuturesFundingRateHistory

listFuturesInsuranceLedger

listContractStats

listLiquidatedOrders

listFuturesAccountsCall

listFuturesAccounts

listFuturesAccountsWithHttpInfo

listFuturesAccountsAsync

listFuturesAccountBook

listPositionsCall

listPositions

listPositionsWithHttpInfo

listPositionsAsync

getPositionCall

getPosition

getPositionWithHttpInfo

getPositionAsync

updatePositionMarginCall

updatePositionMargin

updatePositionMarginWithHttpInfo

updatePositionMarginAsync

updatePositionLeverageCall

updatePositionLeverage

updatePositionLeverageWithHttpInfo

updatePositionLeverageAsync

updatePositionRiskLimitCall

updatePositionRiskLimit

updatePositionRiskLimitWithHttpInfo

updatePositionRiskLimitAsync

setDualModeCall

setDualMode

setDualModeWithHttpInfo

setDualModeAsync

getDualModePositionCall

getDualModePosition

getDualModePositionWithHttpInfo

getDualModePositionAsync

updateDualModePositionMarginCall

updateDualModePositionMargin

updateDualModePositionMarginWithHttpInfo

updateDualModePositionMarginAsync

updateDualModePositionLeverageCall

updateDualModePositionLeverage

updateDualModePositionLeverageWithHttpInfo

updateDualModePositionLeverageAsync

updateDualModePositionRiskLimitCall

updateDualModePositionRiskLimit

updateDualModePositionRiskLimitWithHttpInfo

updateDualModePositionRiskLimitAsync

listFuturesOrders

createFuturesOrderCall

createFuturesOrder

createFuturesOrderWithHttpInfo

createFuturesOrderAsync

cancelFuturesOrdersCall

cancelFuturesOrders

cancelFuturesOrdersWithHttpInfo