io.gate.gateapi.api

Class PortfolioApi

java.lang.Object

io.gate.gateapi.api.PortfolioApi

public class PortfolioApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PortfolioApi.APIlistPortfolioAccountsRequest
class	PortfolioApi.APIlistPortfolioLoanInterestRecordsRequest
class	PortfolioApi.APIlistPortfolioLoanRecordsRequest
class	PortfolioApi.APIlistPortfolioUniLoanInterestRecordsRequest

Constructor Summary

Constructors

Constructor and Description
PortfolioApi()
PortfolioApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	createPortfolioLoan(PortfolioLoan portfolioLoan) Borrow or repay When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user.
okhttp3.Call	createPortfolioLoanAsync(PortfolioLoan portfolioLoan, ApiCallback<Void> _callback) Borrow or repay (asynchronously) When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user.
okhttp3.Call	createPortfolioLoanCall(PortfolioLoan portfolioLoan, ApiCallback _callback) Build call for createPortfolioLoan
ApiResponse<Void>	createPortfolioLoanWithHttpInfo(PortfolioLoan portfolioLoan) Borrow or repay When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user.
ApiClient	getApiClient()
PortfolioBorrowable	getPortfolioBorrowable(String currency) Retrieve the maximum borrowable amount for the account.
okhttp3.Call	getPortfolioBorrowableAsync(String currency, ApiCallback<PortfolioBorrowable> _callback) Retrieve the maximum borrowable amount for the account.
okhttp3.Call	getPortfolioBorrowableCall(String currency, ApiCallback _callback) Build call for getPortfolioBorrowable
ApiResponse<PortfolioBorrowable>	getPortfolioBorrowableWithHttpInfo(String currency) Retrieve the maximum borrowable amount for the account.
PortfolioTransferable	getPortfolioTransferable(String currency) Retrieve the maximum amount that can be transferred out from the account
okhttp3.Call	getPortfolioTransferableAsync(String currency, ApiCallback<PortfolioTransferable> _callback) Retrieve the maximum amount that can be transferred out from the account (asynchronously)
okhttp3.Call	getPortfolioTransferableCall(String currency, ApiCallback _callback) Build call for getPortfolioTransferable
ApiResponse<PortfolioTransferable>	getPortfolioTransferableWithHttpInfo(String currency) Retrieve the maximum amount that can be transferred out from the account
Map<String,Boolean>	listAccountPortfolioMode() Retrieve the account's portfolio mode cross_margin - cross margin
okhttp3.Call	listAccountPortfolioModeAsync(ApiCallback<Map<String,Boolean>> _callback) Retrieve the account's portfolio mode (asynchronously) cross_margin - cross margin
okhttp3.Call	listAccountPortfolioModeCall(ApiCallback _callback) Build call for listAccountPortfolioMode
ApiResponse<Map<String,Boolean>>	listAccountPortfolioModeWithHttpInfo() Retrieve the account's portfolio mode cross_margin - cross margin
PortfolioApi.APIlistPortfolioAccountsRequest	listPortfolioAccounts() Get portfolio account information The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account.
PortfolioApi.APIlistPortfolioLoanInterestRecordsRequest	listPortfolioLoanInterestRecords() List interest records
PortfolioApi.APIlistPortfolioLoanRecordsRequest	listPortfolioLoanRecords() Get load records
PortfolioApi.APIlistPortfolioUniLoanInterestRecordsRequest	listPortfolioUniLoanInterestRecords() List loans
Map<String,Boolean>	setAccountPortfolioMode(PortfolioMode portfolioMode) Configure the account's portfolio mode.
okhttp3.Call	setAccountPortfolioModeAsync(PortfolioMode portfolioMode, ApiCallback<Map<String,Boolean>> _callback) Configure the account's portfolio mode.
okhttp3.Call	setAccountPortfolioModeCall(PortfolioMode portfolioMode, ApiCallback _callback) Build call for setAccountPortfolioMode
ApiResponse<Map<String,Boolean>>	setAccountPortfolioModeWithHttpInfo(PortfolioMode portfolioMode) Configure the account's portfolio mode.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PortfolioApi

public PortfolioApi()

PortfolioApi

public PortfolioApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listPortfolioAccounts

public PortfolioApi.APIlistPortfolioAccountsRequest listPortfolioAccounts()

Get portfolio account information The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation

Returns:

APIlistPortfolioAccountsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listAccountPortfolioModeCall

public okhttp3.Call listAccountPortfolioModeCall(ApiCallback _callback)
                                          throws ApiException

Build call for listAccountPortfolioMode

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

listAccountPortfolioMode

public Map<String,Boolean> listAccountPortfolioMode()
                                             throws ApiException

Retrieve the account's portfolio mode cross_margin - cross margin

Returns:

Map<String, Boolean>

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	-

listAccountPortfolioModeWithHttpInfo

public ApiResponse<Map<String,Boolean>> listAccountPortfolioModeWithHttpInfo()
                                                                      throws ApiException

Retrieve the account's portfolio mode cross_margin - cross margin

Returns:

ApiResponse<Map<String, Boolean>>

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	-

listAccountPortfolioModeAsync

public okhttp3.Call listAccountPortfolioModeAsync(ApiCallback<Map<String,Boolean>> _callback)
                                           throws ApiException

Retrieve the account's portfolio mode (asynchronously) cross_margin - cross margin

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

setAccountPortfolioModeCall

public okhttp3.Call setAccountPortfolioModeCall(PortfolioMode portfolioMode,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for setAccountPortfolioMode

Parameters:

portfolioMode - (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	Success	-

setAccountPortfolioMode

public Map<String,Boolean> setAccountPortfolioMode(PortfolioMode portfolioMode)
                                            throws ApiException

Configure the account's portfolio mode.

Parameters:

portfolioMode - (required)

Returns:

Map<String, Boolean>

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

setAccountPortfolioModeWithHttpInfo

public ApiResponse<Map<String,Boolean>> setAccountPortfolioModeWithHttpInfo(PortfolioMode portfolioMode)
                                                                     throws ApiException

Configure the account's portfolio mode.

Parameters:

portfolioMode - (required)

Returns:

ApiResponse<Map<String, Boolean>>

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

setAccountPortfolioModeAsync

public okhttp3.Call setAccountPortfolioModeAsync(PortfolioMode portfolioMode,
                                                 ApiCallback<Map<String,Boolean>> _callback)
                                          throws ApiException

Configure the account's portfolio mode. (asynchronously)

Parameters:

portfolioMode - (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	Success	-

getPortfolioBorrowableCall

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

Build call for getPortfolioBorrowable

Parameters:

currency - Retrieve data of the specified 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	Successfully retrieved	-

getPortfolioBorrowable

public PortfolioBorrowable getPortfolioBorrowable(String currency)
                                           throws ApiException

Retrieve the maximum borrowable amount for the account.

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

PortfolioBorrowable

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	-

getPortfolioBorrowableWithHttpInfo

public ApiResponse<PortfolioBorrowable> getPortfolioBorrowableWithHttpInfo(String currency)
                                                                    throws ApiException

Retrieve the maximum borrowable amount for the account.

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<PortfolioBorrowable>

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	-

getPortfolioBorrowableAsync

public okhttp3.Call getPortfolioBorrowableAsync(String currency,
                                                ApiCallback<PortfolioBorrowable> _callback)
                                         throws ApiException

Retrieve the maximum borrowable amount for the account. (asynchronously)

Parameters:

currency - Retrieve data of the specified 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	Successfully retrieved	-

getPortfolioTransferableCall

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

Build call for getPortfolioTransferable

Parameters:

currency - Retrieve data of the specified 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	Successfully retrieved	-

getPortfolioTransferable

public PortfolioTransferable getPortfolioTransferable(String currency)
                                               throws ApiException

Retrieve the maximum amount that can be transferred out from the account

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

PortfolioTransferable

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	-

getPortfolioTransferableWithHttpInfo

public ApiResponse<PortfolioTransferable> getPortfolioTransferableWithHttpInfo(String currency)
                                                                        throws ApiException

Retrieve the maximum amount that can be transferred out from the account

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<PortfolioTransferable>

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	-

getPortfolioTransferableAsync

public okhttp3.Call getPortfolioTransferableAsync(String currency,
                                                  ApiCallback<PortfolioTransferable> _callback)
                                           throws ApiException

Retrieve the maximum amount that can be transferred out from the account (asynchronously)

Parameters:

currency - Retrieve data of the specified 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	Successfully retrieved	-

listPortfolioUniLoanInterestRecords

public PortfolioApi.APIlistPortfolioUniLoanInterestRecordsRequest listPortfolioUniLoanInterestRecords()

List loans

Returns:

APIlistPortfolioUniLoanInterestRecordsRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

createPortfolioLoanCall

public okhttp3.Call createPortfolioLoanCall(PortfolioLoan portfolioLoan,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for createPortfolioLoan

Parameters:

portfolioLoan - (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	Operated successfully	-

createPortfolioLoan

public void createPortfolioLoan(PortfolioLoan portfolioLoan)
                         throws ApiException

Borrow or repay When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true`

Parameters:

portfolioLoan - (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	Operated successfully	-

createPortfolioLoanWithHttpInfo

public ApiResponse<Void> createPortfolioLoanWithHttpInfo(PortfolioLoan portfolioLoan)
                                                  throws ApiException

Borrow or repay When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true`

Parameters:

portfolioLoan - (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	Operated successfully	-

createPortfolioLoanAsync

public okhttp3.Call createPortfolioLoanAsync(PortfolioLoan portfolioLoan,
                                             ApiCallback<Void> _callback)
                                      throws ApiException

Borrow or repay (asynchronously) When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true`

Parameters:

portfolioLoan - (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	Operated successfully	-

listPortfolioLoanRecords

public PortfolioApi.APIlistPortfolioLoanRecordsRequest listPortfolioLoanRecords()

Get load records

Returns:

APIlistPortfolioLoanRecordsRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listPortfolioLoanInterestRecords

public PortfolioApi.APIlistPortfolioLoanInterestRecordsRequest listPortfolioLoanInterestRecords()

List interest records

Returns:

APIlistPortfolioLoanInterestRecordsRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-