io.gate.gateapi.api

Class SpotApi

java.lang.Object

io.gate.gateapi.api.SpotApi

public class SpotApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpotApi.APIgetFeeRequest
class	SpotApi.APIlistAllOpenOrdersRequest
class	SpotApi.APIlistCandlesticksRequest
class	SpotApi.APIlistMyTradesRequest
class	SpotApi.APIlistOrderBookRequest
class	SpotApi.APIlistOrdersRequest
class	SpotApi.APIlistSpotAccountsRequest
class	SpotApi.APIlistSpotPriceTriggeredOrdersRequest
class	SpotApi.APIlistTickersRequest
class	SpotApi.APIlistTradesRequest

Constructor Summary

Constructors

Constructor and Description
SpotApi()
SpotApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<CancelOrderResult>	cancelBatchOrders(List<CancelOrder> cancelOrder) Cancel a batch of orders with an ID list Multiple currency pairs can be specified, but maximum 20 orders are allowed per request
okhttp3.Call	cancelBatchOrdersAsync(List<CancelOrder> cancelOrder, ApiCallback<List<CancelOrderResult>> _callback) Cancel a batch of orders with an ID list (asynchronously) Multiple currency pairs can be specified, but maximum 20 orders are allowed per request
okhttp3.Call	cancelBatchOrdersCall(List<CancelOrder> cancelOrder, ApiCallback _callback) Build call for cancelBatchOrders
ApiResponse<List<CancelOrderResult>>	cancelBatchOrdersWithHttpInfo(List<CancelOrder> cancelOrder) Cancel a batch of orders with an ID list Multiple currency pairs can be specified, but maximum 20 orders are allowed per request
Order	cancelOrder(String orderId, String currencyPair, String account) Cancel a single order Spot and margin orders are cancelled by default.
okhttp3.Call	cancelOrderAsync(String orderId, String currencyPair, String account, ApiCallback<Order> _callback) Cancel a single order (asynchronously) Spot and margin orders are cancelled by default.
okhttp3.Call	cancelOrderCall(String orderId, String currencyPair, String account, ApiCallback _callback) Build call for cancelOrder
List<Order>	cancelOrders(String currencyPair, String side, String account) Cancel all `open` orders in specified currency pair If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled.
okhttp3.Call	cancelOrdersAsync(String currencyPair, String side, String account, ApiCallback<List<Order>> _callback) Cancel all `open` orders in specified currency pair (asynchronously) If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled.
okhttp3.Call	cancelOrdersCall(String currencyPair, String side, String account, ApiCallback _callback) Build call for cancelOrders
ApiResponse<List<Order>>	cancelOrdersWithHttpInfo(String currencyPair, String side, String account) Cancel all `open` orders in specified currency pair If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled.
ApiResponse<Order>	cancelOrderWithHttpInfo(String orderId, String currencyPair, String account) Cancel a single order Spot and margin orders are cancelled by default.
SpotPriceTriggeredOrder	cancelSpotPriceTriggeredOrder(String orderId) Cancel a single order
okhttp3.Call	cancelSpotPriceTriggeredOrderAsync(String orderId, ApiCallback<SpotPriceTriggeredOrder> _callback) Cancel a single order (asynchronously)
okhttp3.Call	cancelSpotPriceTriggeredOrderCall(String orderId, ApiCallback _callback) Build call for cancelSpotPriceTriggeredOrder
List<SpotPriceTriggeredOrder>	cancelSpotPriceTriggeredOrderList(String market, String account) Cancel all open orders
okhttp3.Call	cancelSpotPriceTriggeredOrderListAsync(String market, String account, ApiCallback<List<SpotPriceTriggeredOrder>> _callback) Cancel all open orders (asynchronously)
okhttp3.Call	cancelSpotPriceTriggeredOrderListCall(String market, String account, ApiCallback _callback) Build call for cancelSpotPriceTriggeredOrderList
ApiResponse<List<SpotPriceTriggeredOrder>>	cancelSpotPriceTriggeredOrderListWithHttpInfo(String market, String account) Cancel all open orders
ApiResponse<SpotPriceTriggeredOrder>	cancelSpotPriceTriggeredOrderWithHttpInfo(String orderId) Cancel a single order
List<BatchOrder>	createBatchOrders(List<Order> order) Create a batch of orders Batch orders requirements: 1.
okhttp3.Call	createBatchOrdersAsync(List<Order> order, ApiCallback<List<BatchOrder>> _callback) Create a batch of orders (asynchronously) Batch orders requirements: 1.
okhttp3.Call	createBatchOrdersCall(List<Order> order, ApiCallback _callback) Build call for createBatchOrders
ApiResponse<List<BatchOrder>>	createBatchOrdersWithHttpInfo(List<Order> order) Create a batch of orders Batch orders requirements: 1.
Order	createOrder(Order order) Create an order You can place orders with spot, margin or cross margin account through setting the `account `field.
okhttp3.Call	createOrderAsync(Order order, ApiCallback<Order> _callback) Create an order (asynchronously) You can place orders with spot, margin or cross margin account through setting the `account `field.
okhttp3.Call	createOrderCall(Order order, ApiCallback _callback) Build call for createOrder
ApiResponse<Order>	createOrderWithHttpInfo(Order order) Create an order You can place orders with spot, margin or cross margin account through setting the `account `field.
TriggerOrderResponse	createSpotPriceTriggeredOrder(SpotPriceTriggeredOrder spotPriceTriggeredOrder) Create a price-triggered order
okhttp3.Call	createSpotPriceTriggeredOrderAsync(SpotPriceTriggeredOrder spotPriceTriggeredOrder, ApiCallback<TriggerOrderResponse> _callback) Create a price-triggered order (asynchronously)
okhttp3.Call	createSpotPriceTriggeredOrderCall(SpotPriceTriggeredOrder spotPriceTriggeredOrder, ApiCallback _callback) Build call for createSpotPriceTriggeredOrder
ApiResponse<TriggerOrderResponse>	createSpotPriceTriggeredOrderWithHttpInfo(SpotPriceTriggeredOrder spotPriceTriggeredOrder) Create a price-triggered order
ApiClient	getApiClient()
Currency	getCurrency(String currency) Get detail of one particular currency
okhttp3.Call	getCurrencyAsync(String currency, ApiCallback<Currency> _callback) Get detail of one particular currency (asynchronously)
okhttp3.Call	getCurrencyCall(String currency, ApiCallback _callback) Build call for getCurrency
CurrencyPair	getCurrencyPair(String currencyPair) Get detail of one single order
okhttp3.Call	getCurrencyPairAsync(String currencyPair, ApiCallback<CurrencyPair> _callback) Get detail of one single order (asynchronously)
okhttp3.Call	getCurrencyPairCall(String currencyPair, ApiCallback _callback) Build call for getCurrencyPair
ApiResponse<CurrencyPair>	getCurrencyPairWithHttpInfo(String currencyPair) Get detail of one single order
ApiResponse<Currency>	getCurrencyWithHttpInfo(String currency) Get detail of one particular currency
SpotApi.APIgetFeeRequest	getFee() Deprecated.
Order	getOrder(String orderId, String currencyPair, String account) Get a single order Spot and margin orders are queried by default.
okhttp3.Call	getOrderAsync(String orderId, String currencyPair, String account, ApiCallback<Order> _callback) Get a single order (asynchronously) Spot and margin orders are queried by default.
okhttp3.Call	getOrderCall(String orderId, String currencyPair, String account, ApiCallback _callback) Build call for getOrder
ApiResponse<Order>	getOrderWithHttpInfo(String orderId, String currencyPair, String account) Get a single order Spot and margin orders are queried by default.
SpotPriceTriggeredOrder	getSpotPriceTriggeredOrder(String orderId) Get a single order
okhttp3.Call	getSpotPriceTriggeredOrderAsync(String orderId, ApiCallback<SpotPriceTriggeredOrder> _callback) Get a single order (asynchronously)
okhttp3.Call	getSpotPriceTriggeredOrderCall(String orderId, ApiCallback _callback) Build call for getSpotPriceTriggeredOrder
ApiResponse<SpotPriceTriggeredOrder>	getSpotPriceTriggeredOrderWithHttpInfo(String orderId) Get a single order
SpotApi.APIlistAllOpenOrdersRequest	listAllOpenOrders() List all open orders List open orders in all currency pairs.
SpotApi.APIlistCandlesticksRequest	listCandlesticks(String currencyPair) Market candlesticks Maximum of 1000 points are returned in one query.
List<Currency>	listCurrencies() List all currencies' detail
okhttp3.Call	listCurrenciesAsync(ApiCallback<List<Currency>> _callback) List all currencies' detail (asynchronously)
okhttp3.Call	listCurrenciesCall(ApiCallback _callback) Build call for listCurrencies
ApiResponse<List<Currency>>	listCurrenciesWithHttpInfo() List all currencies' detail
List<CurrencyPair>	listCurrencyPairs() List all currency pairs supported
okhttp3.Call	listCurrencyPairsAsync(ApiCallback<List<CurrencyPair>> _callback) List all currency pairs supported (asynchronously)
okhttp3.Call	listCurrencyPairsCall(ApiCallback _callback) Build call for listCurrencyPairs
ApiResponse<List<CurrencyPair>>	listCurrencyPairsWithHttpInfo() List all currency pairs supported
SpotApi.APIlistMyTradesRequest	listMyTrades(String currencyPair) List personal trading history Spot and margin trades are queried by default.
SpotApi.APIlistOrderBookRequest	listOrderBook(String currencyPair) Retrieve order book Order book will be sorted by price from high to low on bids; reversed on asks
SpotApi.APIlistOrdersRequest	listOrders(String currencyPair, String status) List orders Spot and margin orders are returned by default.
SpotApi.APIlistSpotAccountsRequest	listSpotAccounts() List spot accounts
SpotApi.APIlistSpotPriceTriggeredOrdersRequest	listSpotPriceTriggeredOrders(String status) Retrieve running auto order list
SpotApi.APIlistTickersRequest	listTickers() Retrieve ticker information Return only related data if `currency_pair` is specified; otherwise return all of them
SpotApi.APIlistTradesRequest	listTrades(String currencyPair) Retrieve market trades
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpotApi

public SpotApi()

SpotApi

public SpotApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listCurrenciesCall

public okhttp3.Call listCurrenciesCall(ApiCallback _callback)
                                throws ApiException

Build call for listCurrencies

Parameters:

_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	-

listCurrencies

public List<Currency> listCurrencies()
                              throws ApiException

List all currencies' detail

Returns:

List<Currency>

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	-

listCurrenciesWithHttpInfo

public ApiResponse<List<Currency>> listCurrenciesWithHttpInfo()
                                                       throws ApiException

List all currencies' detail

Returns:

ApiResponse<List<Currency>>

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	-

listCurrenciesAsync

public okhttp3.Call listCurrenciesAsync(ApiCallback<List<Currency>> _callback)
                                 throws ApiException

List all currencies' detail (asynchronously)

Parameters:

_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	-

getCurrencyCall

public okhttp3.Call getCurrencyCall(String currency,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getCurrency

Parameters:

currency - Currency name (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	-

getCurrency

public Currency getCurrency(String currency)
                     throws ApiException

Get detail of one particular currency

Parameters:

currency - Currency name (required)

Returns:

Currency

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	-

getCurrencyWithHttpInfo

public ApiResponse<Currency> getCurrencyWithHttpInfo(String currency)
                                              throws ApiException

Get detail of one particular currency

Parameters:

currency - Currency name (required)

Returns:

ApiResponse<Currency>

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	-

getCurrencyAsync

public okhttp3.Call getCurrencyAsync(String currency,
                                     ApiCallback<Currency> _callback)
                              throws ApiException

Get detail of one particular currency (asynchronously)

Parameters:

currency - Currency name (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	-

listCurrencyPairsCall

public okhttp3.Call listCurrencyPairsCall(ApiCallback _callback)
                                   throws ApiException

Build call for listCurrencyPairs

Parameters:

_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 currency pairs retrieved	-

listCurrencyPairs

public List<CurrencyPair> listCurrencyPairs()
                                     throws ApiException

List all currency pairs supported

Returns:

List<CurrencyPair>

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 currency pairs retrieved	-

listCurrencyPairsWithHttpInfo

public ApiResponse<List<CurrencyPair>> listCurrencyPairsWithHttpInfo()
                                                              throws ApiException

List all currency pairs supported

Returns:

ApiResponse<List<CurrencyPair>>

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 currency pairs retrieved	-

listCurrencyPairsAsync

public okhttp3.Call listCurrencyPairsAsync(ApiCallback<List<CurrencyPair>> _callback)
                                    throws ApiException

List all currency pairs supported (asynchronously)

Parameters:

_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 currency pairs retrieved	-

getCurrencyPairCall

public okhttp3.Call getCurrencyPairCall(String currencyPair,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getCurrencyPair

Parameters:

currencyPair - Currency pair (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	-

getCurrencyPair

public CurrencyPair getCurrencyPair(String currencyPair)
                             throws ApiException

Get detail of one single order

Parameters:

currencyPair - Currency pair (required)

Returns:

CurrencyPair

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	-

getCurrencyPairWithHttpInfo

public ApiResponse<CurrencyPair> getCurrencyPairWithHttpInfo(String currencyPair)
                                                      throws ApiException

Get detail of one single order

Parameters:

currencyPair - Currency pair (required)

Returns:

ApiResponse<CurrencyPair>

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	-

getCurrencyPairAsync

public okhttp3.Call getCurrencyPairAsync(String currencyPair,
                                         ApiCallback<CurrencyPair> _callback)
                                  throws ApiException

Get detail of one single order (asynchronously)

Parameters:

currencyPair - Currency pair (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	-

listTickers

public SpotApi.APIlistTickersRequest listTickers()

Retrieve ticker information Return only related data if `currency_pair` is specified; otherwise return all of them

Returns:

APIlistTickersRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listOrderBook

public SpotApi.APIlistOrderBookRequest listOrderBook(String currencyPair)

Retrieve order book Order book will be sorted by price from high to low on bids; reversed on asks

Parameters:

currencyPair - Currency pair (required)

Returns:

APIlistOrderBookRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listTrades

public SpotApi.APIlistTradesRequest listTrades(String currencyPair)

Retrieve market trades

Parameters:

currencyPair - Currency pair (required)

Returns:

APIlistTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listCandlesticks

public SpotApi.APIlistCandlesticksRequest listCandlesticks(String currencyPair)

Market candlesticks Maximum of 1000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval`

Parameters:

currencyPair - Currency pair (required)

Returns:

APIlistCandlesticksRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

getFee

@Deprecated
public SpotApi.APIgetFeeRequest getFee()

Deprecated.

Query user trading fee rates This API is deprecated in favour of new fee retrieving API `/wallet/fee`.

Returns:

APIgetFeeRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listSpotAccounts

public SpotApi.APIlistSpotAccountsRequest listSpotAccounts()

List spot accounts

Returns:

APIlistSpotAccountsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createBatchOrdersCall

public okhttp3.Call createBatchOrdersCall(List<Order> order,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for createBatchOrders

Parameters:

order - (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	Request is completed	-

createBatchOrders

public List<BatchOrder> createBatchOrders(List<Order> order)
                                   throws ApiException

Create a batch of orders Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders

Parameters:

order - (required)

Returns:

List<BatchOrder>

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	Request is completed	-

createBatchOrdersWithHttpInfo

public ApiResponse<List<BatchOrder>> createBatchOrdersWithHttpInfo(List<Order> order)
                                                            throws ApiException

Create a batch of orders Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders

Parameters:

order - (required)

Returns:

ApiResponse<List<BatchOrder>>

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	Request is completed	-

createBatchOrdersAsync

public okhttp3.Call createBatchOrdersAsync(List<Order> order,
                                           ApiCallback<List<BatchOrder>> _callback)
                                    throws ApiException

Create a batch of orders (asynchronously) Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders

Parameters:

order - (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	Request is completed	-

listAllOpenOrders

public SpotApi.APIlistAllOpenOrdersRequest listAllOpenOrders()

List all open orders List open orders in all currency pairs. Note that pagination parameters affect record number in each currency pair's open order list. No pagination is applied to the number of currency pairs returned. All currency pairs with open orders will be returned. Spot and margin orders are returned by default. To list cross margin orders, `account` must be set to `cross_margin`

Returns:

APIlistAllOpenOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listOrders

public SpotApi.APIlistOrdersRequest listOrders(String currencyPair,
                                               String status)

List orders Spot and margin orders are returned by default. If cross margin orders are needed, `account` must be set to `cross_margin`

Parameters:

currencyPair - Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (required)

status - List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled (required)

Returns:

APIlistOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createOrderCall

public okhttp3.Call createOrderCall(Order order,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createOrder

Parameters:

order - (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.	-

createOrder

public Order createOrder(Order order)
                  throws ApiException

Create an order You can place orders with spot, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide totally. Note that the hidden part's fee will be charged using taker's fee rate.

Parameters:

order - (required)

Returns:

Order

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.	-

createOrderWithHttpInfo

public ApiResponse<Order> createOrderWithHttpInfo(Order order)
                                           throws ApiException

Create an order You can place orders with spot, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide totally. Note that the hidden part's fee will be charged using taker's fee rate.

Parameters:

order - (required)

Returns:

ApiResponse<Order>

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.	-

createOrderAsync

public okhttp3.Call createOrderAsync(Order order,
                                     ApiCallback<Order> _callback)
                              throws ApiException

Create an order (asynchronously) You can place orders with spot, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide totally. Note that the hidden part's fee will be charged using taker's fee rate.

Parameters:

order - (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.	-

cancelOrdersCall

public okhttp3.Call cancelOrdersCall(String currencyPair,
                                     String side,
                                     String account,
                                     ApiCallback _callback)
                              throws ApiException

Build call for cancelOrders

Parameters:

currencyPair - Currency pair (required)

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

account - Specify account type. Default to all account types being included (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	Batch cancellation request accepted. Query order status by listing orders	-

cancelOrders

public List<Order> cancelOrders(String currencyPair,
                                String side,
                                String account)
                         throws ApiException

Cancel all `open` orders in specified currency pair If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled. You can set `account` to cancel only orders within the specified account

Parameters:

currencyPair - Currency pair (required)

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

account - Specify account type. Default to all account types being included (optional)

Returns:

List<Order>

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	-

cancelOrdersWithHttpInfo

public ApiResponse<List<Order>> cancelOrdersWithHttpInfo(String currencyPair,
                                                         String side,
                                                         String account)
                                                  throws ApiException

Cancel all `open` orders in specified currency pair If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled. You can set `account` to cancel only orders within the specified account

Parameters:

currencyPair - Currency pair (required)

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

account - Specify account type. Default to all account types being included (optional)

Returns:

ApiResponse<List<Order>>

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	-

cancelOrdersAsync

public okhttp3.Call cancelOrdersAsync(String currencyPair,
                                      String side,
                                      String account,
                                      ApiCallback<List<Order>> _callback)
                               throws ApiException

Cancel all `open` orders in specified currency pair (asynchronously) If `account` is not set, all open orders, including spot, margin and cross margin ones, will be cancelled. You can set `account` to cancel only orders within the specified account

Parameters:

currencyPair - Currency pair (required)

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

account - Specify account type. Default to all account types being included (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	Batch cancellation request accepted. Query order status by listing orders	-

cancelBatchOrdersCall

public okhttp3.Call cancelBatchOrdersCall(List<CancelOrder> cancelOrder,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for cancelBatchOrders

Parameters:

cancelOrder - (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 completed	-

cancelBatchOrders

public List<CancelOrderResult> cancelBatchOrders(List<CancelOrder> cancelOrder)
                                          throws ApiException

Cancel a batch of orders with an ID list Multiple currency pairs can be specified, but maximum 20 orders are allowed per request

Parameters:

cancelOrder - (required)

Returns:

List<CancelOrderResult>

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 completed	-

cancelBatchOrdersWithHttpInfo

public ApiResponse<List<CancelOrderResult>> cancelBatchOrdersWithHttpInfo(List<CancelOrder> cancelOrder)
                                                                   throws ApiException

Cancel a batch of orders with an ID list Multiple currency pairs can be specified, but maximum 20 orders are allowed per request

Parameters:

cancelOrder - (required)

Returns:

ApiResponse<List<CancelOrderResult>>

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 completed	-

cancelBatchOrdersAsync

public okhttp3.Call cancelBatchOrdersAsync(List<CancelOrder> cancelOrder,
                                           ApiCallback<List<CancelOrderResult>> _callback)
                                    throws ApiException

Cancel a batch of orders with an ID list (asynchronously) Multiple currency pairs can be specified, but maximum 20 orders are allowed per request

Parameters:

cancelOrder - (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 completed	-

getOrderCall

public okhttp3.Call getOrderCall(String orderId,
                                 String currencyPair,
                                 String account,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getOrder

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (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	Detail retrieved	-

getOrder

public Order getOrder(String orderId,
                      String currencyPair,
                      String account)
               throws ApiException

Get a single order Spot and margin orders are queried by default. If cross margin orders are needed, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (optional)

Returns:

Order

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	Detail retrieved	-

getOrderWithHttpInfo

public ApiResponse<Order> getOrderWithHttpInfo(String orderId,
                                               String currencyPair,
                                               String account)
                                        throws ApiException

Get a single order Spot and margin orders are queried by default. If cross margin orders are needed, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (optional)

Returns:

ApiResponse<Order>

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	Detail retrieved	-

getOrderAsync

public okhttp3.Call getOrderAsync(String orderId,
                                  String currencyPair,
                                  String account,
                                  ApiCallback<Order> _callback)
                           throws ApiException

Get a single order (asynchronously) Spot and margin orders are queried by default. If cross margin orders are needed, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (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	Detail retrieved	-

cancelOrderCall

public okhttp3.Call cancelOrderCall(String orderId,
                                    String currencyPair,
                                    String account,
                                    ApiCallback _callback)
                             throws ApiException

Build call for cancelOrder

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (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	Order cancelled	-

cancelOrder

public Order cancelOrder(String orderId,
                         String currencyPair,
                         String account)
                  throws ApiException

Cancel a single order Spot and margin orders are cancelled by default. If trying to cancel cross margin orders, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (optional)

Returns:

Order

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 cancelled	-

cancelOrderWithHttpInfo

public ApiResponse<Order> cancelOrderWithHttpInfo(String orderId,
                                                  String currencyPair,
                                                  String account)
                                           throws ApiException

Cancel a single order Spot and margin orders are cancelled by default. If trying to cancel cross margin orders, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (optional)

Returns:

ApiResponse<Order>

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 cancelled	-

cancelOrderAsync

public okhttp3.Call cancelOrderAsync(String orderId,
                                     String currencyPair,
                                     String account,
                                     ApiCallback<Order> _callback)
                              throws ApiException

Cancel a single order (asynchronously) Spot and margin orders are cancelled by default. If trying to cancel cross margin orders, `account` must be set to `cross_margin`

Parameters:

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)

currencyPair - Currency pair (required)

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (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	Order cancelled	-

listMyTrades

public SpotApi.APIlistMyTradesRequest listMyTrades(String currencyPair)

List personal trading history Spot and margin trades are queried by default. If cross margin trades are needed, `account` must be set to `cross_margin`

Parameters:

currencyPair - Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (required)

Returns:

APIlistMyTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSpotPriceTriggeredOrders

public SpotApi.APIlistSpotPriceTriggeredOrdersRequest listSpotPriceTriggeredOrders(String status)

Retrieve running auto order list

Parameters:

status - List orders based on status (required)

Returns:

APIlistSpotPriceTriggeredOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createSpotPriceTriggeredOrderCall

public okhttp3.Call createSpotPriceTriggeredOrderCall(SpotPriceTriggeredOrder spotPriceTriggeredOrder,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for createSpotPriceTriggeredOrder

Parameters:

spotPriceTriggeredOrder - (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	-

createSpotPriceTriggeredOrder

public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrder spotPriceTriggeredOrder)
                                                   throws ApiException

Create a price-triggered order

Parameters:

spotPriceTriggeredOrder - (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	-

createSpotPriceTriggeredOrderWithHttpInfo

public ApiResponse<TriggerOrderResponse> createSpotPriceTriggeredOrderWithHttpInfo(SpotPriceTriggeredOrder spotPriceTriggeredOrder)
                                                                            throws ApiException

Create a price-triggered order

Parameters:

spotPriceTriggeredOrder - (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	-

createSpotPriceTriggeredOrderAsync

public okhttp3.Call createSpotPriceTriggeredOrderAsync(SpotPriceTriggeredOrder spotPriceTriggeredOrder,
                                                       ApiCallback<TriggerOrderResponse> _callback)
                                                throws ApiException

Create a price-triggered order (asynchronously)

Parameters:

spotPriceTriggeredOrder - (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	-

cancelSpotPriceTriggeredOrderListCall

public okhttp3.Call cancelSpotPriceTriggeredOrderListCall(String market,
                                                          String account,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for cancelSpotPriceTriggeredOrderList

Parameters:

market - Currency pair (optional)

account - Trading account (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	Batch cancellation request accepted. Query order status by listing orders	-

cancelSpotPriceTriggeredOrderList

public List<SpotPriceTriggeredOrder> cancelSpotPriceTriggeredOrderList(String market,
                                                                       String account)
                                                                throws ApiException

Cancel all open orders

Parameters:

market - Currency pair (optional)

account - Trading account (optional)

Returns:

List<SpotPriceTriggeredOrder>

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	-

cancelSpotPriceTriggeredOrderListWithHttpInfo

public ApiResponse<List<SpotPriceTriggeredOrder>> cancelSpotPriceTriggeredOrderListWithHttpInfo(String market,
                                                                                                String account)
                                                                                         throws ApiException

Cancel all open orders

Parameters:

market - Currency pair (optional)

account - Trading account (optional)

Returns:

ApiResponse<List<SpotPriceTriggeredOrder>>

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	-

cancelSpotPriceTriggeredOrderListAsync

public okhttp3.Call cancelSpotPriceTriggeredOrderListAsync(String market,
                                                           String account,
                                                           ApiCallback<List<SpotPriceTriggeredOrder>> _callback)
                                                    throws ApiException

Cancel all open orders (asynchronously)

Parameters:

market - Currency pair (optional)

account - Trading account (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	Batch cancellation request accepted. Query order status by listing orders	-

getSpotPriceTriggeredOrderCall

public okhttp3.Call getSpotPriceTriggeredOrderCall(String orderId,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for getSpotPriceTriggeredOrder

Parameters:

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	-

getSpotPriceTriggeredOrder

public SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(String orderId)
                                                   throws ApiException

Get a single order

Parameters:

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

Returns:

SpotPriceTriggeredOrder

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	-

getSpotPriceTriggeredOrderWithHttpInfo

public ApiResponse<SpotPriceTriggeredOrder> getSpotPriceTriggeredOrderWithHttpInfo(String orderId)
                                                                            throws ApiException

Get a single order

Parameters:

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

Returns:

ApiResponse<SpotPriceTriggeredOrder>

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	-

getSpotPriceTriggeredOrderAsync

public okhttp3.Call getSpotPriceTriggeredOrderAsync(String orderId,
                                                    ApiCallback<SpotPriceTriggeredOrder> _callback)
                                             throws ApiException

Get a single order (asynchronously)

Parameters:

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	-

cancelSpotPriceTriggeredOrderCall

public okhttp3.Call cancelSpotPriceTriggeredOrderCall(String orderId,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for cancelSpotPriceTriggeredOrder

Parameters:

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	-

cancelSpotPriceTriggeredOrder

public SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(String orderId)
                                                      throws ApiException

Cancel a single order

Parameters:

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

Returns:

SpotPriceTriggeredOrder

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	-

cancelSpotPriceTriggeredOrderWithHttpInfo

public ApiResponse<SpotPriceTriggeredOrder> cancelSpotPriceTriggeredOrderWithHttpInfo(String orderId)
                                                                               throws ApiException

Cancel a single order

Parameters:

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

Returns:

ApiResponse<SpotPriceTriggeredOrder>

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	-

cancelSpotPriceTriggeredOrderAsync

public okhttp3.Call cancelSpotPriceTriggeredOrderAsync(String orderId,
                                                       ApiCallback<SpotPriceTriggeredOrder> _callback)
                                                throws ApiException

Cancel a single order (asynchronously)

Parameters:

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	-