io.gate.gateapi.api

Class WalletApi

java.lang.Object

io.gate.gateapi.api.WalletApi

public class WalletApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WalletApi.APIgetTotalBalanceRequest
class	WalletApi.APIgetTradeFeeRequest
class	WalletApi.APIlistDepositsRequest
class	WalletApi.APIlistSavedAddressRequest
class	WalletApi.APIlistSubAccountBalancesRequest
class	WalletApi.APIlistSubAccountCrossMarginBalancesRequest
class	WalletApi.APIlistSubAccountFuturesBalancesRequest
class	WalletApi.APIlistSubAccountMarginBalancesRequest
class	WalletApi.APIlistSubAccountTransfersRequest
class	WalletApi.APIlistWithdrawalsRequest
class	WalletApi.APIlistWithdrawStatusRequest

Constructor Summary

Constructors

Constructor and Description
WalletApi()
WalletApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
DepositAddress	getDepositAddress(String currency) Generate currency deposit address
okhttp3.Call	getDepositAddressAsync(String currency, ApiCallback<DepositAddress> _callback) Generate currency deposit address (asynchronously)
okhttp3.Call	getDepositAddressCall(String currency, ApiCallback _callback) Build call for getDepositAddress
ApiResponse<DepositAddress>	getDepositAddressWithHttpInfo(String currency) Generate currency deposit address
WalletApi.APIgetTotalBalanceRequest	getTotalBalance() Retrieve user's total balances This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute.
WalletApi.APIgetTradeFeeRequest	getTradeFee() Retrieve personal trading fee
List<CurrencyChain>	listCurrencyChains(String currency) List chains supported for specified currency
okhttp3.Call	listCurrencyChainsAsync(String currency, ApiCallback<List<CurrencyChain>> _callback) List chains supported for specified currency (asynchronously)
okhttp3.Call	listCurrencyChainsCall(String currency, ApiCallback _callback) Build call for listCurrencyChains
ApiResponse<List<CurrencyChain>>	listCurrencyChainsWithHttpInfo(String currency) List chains supported for specified currency
WalletApi.APIlistDepositsRequest	listDeposits() Retrieve deposit records Record time range cannot exceed 30 days
WalletApi.APIlistSavedAddressRequest	listSavedAddress(String currency) Query saved address
WalletApi.APIlistSubAccountBalancesRequest	listSubAccountBalances() Retrieve sub account balances
WalletApi.APIlistSubAccountCrossMarginBalancesRequest	listSubAccountCrossMarginBalances() Query subaccount's cross_margin account info
WalletApi.APIlistSubAccountFuturesBalancesRequest	listSubAccountFuturesBalances() Query sub accounts' futures account balances
WalletApi.APIlistSubAccountMarginBalancesRequest	listSubAccountMarginBalances() Query sub accounts' margin balances
WalletApi.APIlistSubAccountTransfersRequest	listSubAccountTransfers() Retrieve transfer records between main and sub accounts Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved
WalletApi.APIlistWithdrawalsRequest	listWithdrawals() Retrieve withdrawal records Record time range cannot exceed 30 days
WalletApi.APIlistWithdrawStatusRequest	listWithdrawStatus() Retrieve withdrawal status
void	setApiClient(ApiClient apiClient)
void	subAccountToSubAccount(SubAccountToSubAccount subAccountToSubAccount) Sub-account transfers to sub-account
okhttp3.Call	subAccountToSubAccountAsync(SubAccountToSubAccount subAccountToSubAccount, ApiCallback<Void> _callback) Sub-account transfers to sub-account (asynchronously)
okhttp3.Call	subAccountToSubAccountCall(SubAccountToSubAccount subAccountToSubAccount, ApiCallback _callback) Build call for subAccountToSubAccount
ApiResponse<Void>	subAccountToSubAccountWithHttpInfo(SubAccountToSubAccount subAccountToSubAccount) Sub-account transfers to sub-account
TransactionID	transfer(Transfer transfer) Transfer between trading accounts Transfer between different accounts.
okhttp3.Call	transferAsync(Transfer transfer, ApiCallback<TransactionID> _callback) Transfer between trading accounts (asynchronously) Transfer between different accounts.
okhttp3.Call	transferCall(Transfer transfer, ApiCallback _callback) Build call for transfer
ApiResponse<TransactionID>	transferWithHttpInfo(Transfer transfer) Transfer between trading accounts Transfer between different accounts.
void	transferWithSubAccount(SubAccountTransfer subAccountTransfer) Transfer between main and sub accounts Support transferring with sub user's spot or futures account.
okhttp3.Call	transferWithSubAccountAsync(SubAccountTransfer subAccountTransfer, ApiCallback<Void> _callback) Transfer between main and sub accounts (asynchronously) Support transferring with sub user's spot or futures account.
okhttp3.Call	transferWithSubAccountCall(SubAccountTransfer subAccountTransfer, ApiCallback _callback) Build call for transferWithSubAccount
ApiResponse<Void>	transferWithSubAccountWithHttpInfo(SubAccountTransfer subAccountTransfer) Transfer between main and sub accounts Support transferring with sub user's spot or futures account.

Methods inherited from class java.lang.Object

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

Constructor Detail

WalletApi

public WalletApi()

WalletApi

public WalletApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listCurrencyChainsCall

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

Build call for listCurrencyChains

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	-

listCurrencyChains

public List<CurrencyChain> listCurrencyChains(String currency)
                                       throws ApiException

List chains supported for specified currency

Parameters:

currency - Currency name (required)

Returns:

List<CurrencyChain>

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	-

listCurrencyChainsWithHttpInfo

public ApiResponse<List<CurrencyChain>> listCurrencyChainsWithHttpInfo(String currency)
                                                                throws ApiException

List chains supported for specified currency

Parameters:

currency - Currency name (required)

Returns:

ApiResponse<List<CurrencyChain>>

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	-

listCurrencyChainsAsync

public okhttp3.Call listCurrencyChainsAsync(String currency,
                                            ApiCallback<List<CurrencyChain>> _callback)
                                     throws ApiException

List chains supported for specified 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	-

getDepositAddressCall

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

Build call for getDepositAddress

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	Address successfully generated	-

getDepositAddress

public DepositAddress getDepositAddress(String currency)
                                 throws ApiException

Generate currency deposit address

Parameters:

currency - Currency name (required)

Returns:

DepositAddress

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	Address successfully generated	-

getDepositAddressWithHttpInfo

public ApiResponse<DepositAddress> getDepositAddressWithHttpInfo(String currency)
                                                          throws ApiException

Generate currency deposit address

Parameters:

currency - Currency name (required)

Returns:

ApiResponse<DepositAddress>

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	Address successfully generated	-

getDepositAddressAsync

public okhttp3.Call getDepositAddressAsync(String currency,
                                           ApiCallback<DepositAddress> _callback)
                                    throws ApiException

Generate currency deposit address (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	Address successfully generated	-

listWithdrawals

public WalletApi.APIlistWithdrawalsRequest listWithdrawals()

Retrieve withdrawal records Record time range cannot exceed 30 days

Returns:

APIlistWithdrawalsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listDeposits

public WalletApi.APIlistDepositsRequest listDeposits()

Retrieve deposit records Record time range cannot exceed 30 days

Returns:

APIlistDepositsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

transferCall

public okhttp3.Call transferCall(Transfer transfer,
                                 ApiCallback _callback)
                          throws ApiException

Build call for transfer

Parameters:

transfer - (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	Balance transferred	-

transfer

public TransactionID transfer(Transfer transfer)
                       throws ApiException

Transfer between trading accounts Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - cross margin 5. spot - options

Parameters:

transfer - (required)

Returns:

TransactionID

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	Balance transferred	-

transferWithHttpInfo

public ApiResponse<TransactionID> transferWithHttpInfo(Transfer transfer)
                                                throws ApiException

Transfer between trading accounts Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - cross margin 5. spot - options

Parameters:

transfer - (required)

Returns:

ApiResponse<TransactionID>

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	Balance transferred	-

transferAsync

public okhttp3.Call transferAsync(Transfer transfer,
                                  ApiCallback<TransactionID> _callback)
                           throws ApiException

Transfer between trading accounts (asynchronously) Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - cross margin 5. spot - options

Parameters:

transfer - (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	Balance transferred	-

listSubAccountTransfers

public WalletApi.APIlistSubAccountTransfersRequest listSubAccountTransfers()

Retrieve transfer records between main and sub accounts Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved

Returns:

APIlistSubAccountTransfersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

transferWithSubAccountCall

public okhttp3.Call transferWithSubAccountCall(SubAccountTransfer subAccountTransfer,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for transferWithSubAccount

Parameters:

subAccountTransfer - (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
204	Balance transferred	-

transferWithSubAccount

public void transferWithSubAccount(SubAccountTransfer subAccountTransfer)
                            throws ApiException

Transfer between main and sub accounts Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated.

Parameters:

subAccountTransfer - (required)

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
204	Balance transferred	-

transferWithSubAccountWithHttpInfo

public ApiResponse<Void> transferWithSubAccountWithHttpInfo(SubAccountTransfer subAccountTransfer)
                                                     throws ApiException

Transfer between main and sub accounts Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated.

Parameters:

subAccountTransfer - (required)

Returns:

ApiResponse<Void>

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
204	Balance transferred	-

transferWithSubAccountAsync

public okhttp3.Call transferWithSubAccountAsync(SubAccountTransfer subAccountTransfer,
                                                ApiCallback<Void> _callback)
                                         throws ApiException

Transfer between main and sub accounts (asynchronously) Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated.

Parameters:

subAccountTransfer - (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
204	Balance transferred	-

subAccountToSubAccountCall

public okhttp3.Call subAccountToSubAccountCall(SubAccountToSubAccount subAccountToSubAccount,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for subAccountToSubAccount

Parameters:

subAccountToSubAccount - (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
204	Balance transferred	-

subAccountToSubAccount

public void subAccountToSubAccount(SubAccountToSubAccount subAccountToSubAccount)
                            throws ApiException

Sub-account transfers to sub-account

Parameters:

subAccountToSubAccount - (required)

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
204	Balance transferred	-

subAccountToSubAccountWithHttpInfo

public ApiResponse<Void> subAccountToSubAccountWithHttpInfo(SubAccountToSubAccount subAccountToSubAccount)
                                                     throws ApiException

Sub-account transfers to sub-account

Parameters:

subAccountToSubAccount - (required)

Returns:

ApiResponse<Void>

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
204	Balance transferred	-

subAccountToSubAccountAsync

public okhttp3.Call subAccountToSubAccountAsync(SubAccountToSubAccount subAccountToSubAccount,
                                                ApiCallback<Void> _callback)
                                         throws ApiException

Sub-account transfers to sub-account (asynchronously)

Parameters:

subAccountToSubAccount - (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
204	Balance transferred	-

listWithdrawStatus

public WalletApi.APIlistWithdrawStatusRequest listWithdrawStatus()

Retrieve withdrawal status

Returns:

APIlistWithdrawStatusRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSubAccountBalances

public WalletApi.APIlistSubAccountBalancesRequest listSubAccountBalances()

Retrieve sub account balances

Returns:

APIlistSubAccountBalancesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSubAccountMarginBalances

public WalletApi.APIlistSubAccountMarginBalancesRequest listSubAccountMarginBalances()

Query sub accounts' margin balances

Returns:

APIlistSubAccountMarginBalancesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSubAccountFuturesBalances

public WalletApi.APIlistSubAccountFuturesBalancesRequest listSubAccountFuturesBalances()

Query sub accounts' futures account balances

Returns:

APIlistSubAccountFuturesBalancesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSubAccountCrossMarginBalances

public WalletApi.APIlistSubAccountCrossMarginBalancesRequest listSubAccountCrossMarginBalances()

Query subaccount's cross_margin account info

Returns:

APIlistSubAccountCrossMarginBalancesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSavedAddress

public WalletApi.APIlistSavedAddressRequest listSavedAddress(String currency)

Query saved address

Parameters:

currency - Currency (required)

Returns:

APIlistSavedAddressRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getTradeFee

public WalletApi.APIgetTradeFeeRequest getTradeFee()

Retrieve personal trading fee

Returns:

APIgetTradeFeeRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

getTotalBalance

public WalletApi.APIgetTotalBalanceRequest getTotalBalance()

Retrieve user's total balances This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance

Returns:

APIgetTotalBalanceRequest

Http Response Details:

Status Code	Description	Response Headers
200	Request is valid and is successfully responded	-