io.gate.gateapi.api

Class MarginApi

java.lang.Object

io.gate.gateapi.api.MarginApi

public class MarginApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MarginApi.APIgetMarginBorrowableRequest
class	MarginApi.APIgetMarginTransferableRequest
class	MarginApi.APIlistCrossMarginAccountBookRequest
class	MarginApi.APIlistCrossMarginLoansRequest
class	MarginApi.APIlistCrossMarginRepaymentsRequest
class	MarginApi.APIlistFundingAccountsRequest
class	MarginApi.APIlistLoanRecordsRequest
class	MarginApi.APIlistLoansRequest
class	MarginApi.APIlistMarginAccountBookRequest
class	MarginApi.APIlistMarginAccountsRequest

Constructor Summary

Constructors

Constructor and Description
MarginApi()
MarginApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Loan	cancelLoan(String loanId, String currency) Cancel lending loan Only lent loans can be cancelled
okhttp3.Call	cancelLoanAsync(String loanId, String currency, ApiCallback<Loan> _callback) Cancel lending loan (asynchronously) Only lent loans can be cancelled
okhttp3.Call	cancelLoanCall(String loanId, String currency, ApiCallback _callback) Build call for cancelLoan
ApiResponse<Loan>	cancelLoanWithHttpInfo(String loanId, String currency) Cancel lending loan Only lent loans can be cancelled
CrossMarginLoan	createCrossMarginLoan(CrossMarginLoan crossMarginLoan) Create a cross margin borrow loan Borrow amount cannot be less than currency minimum borrow amount
okhttp3.Call	createCrossMarginLoanAsync(CrossMarginLoan crossMarginLoan, ApiCallback<CrossMarginLoan> _callback) Create a cross margin borrow loan (asynchronously) Borrow amount cannot be less than currency minimum borrow amount
okhttp3.Call	createCrossMarginLoanCall(CrossMarginLoan crossMarginLoan, ApiCallback _callback) Build call for createCrossMarginLoan
ApiResponse<CrossMarginLoan>	createCrossMarginLoanWithHttpInfo(CrossMarginLoan crossMarginLoan) Create a cross margin borrow loan Borrow amount cannot be less than currency minimum borrow amount
Loan	createLoan(Loan loan) Lend or borrow
okhttp3.Call	createLoanAsync(Loan loan, ApiCallback<Loan> _callback) Lend or borrow (asynchronously)
okhttp3.Call	createLoanCall(Loan loan, ApiCallback _callback) Build call for createLoan
ApiResponse<Loan>	createLoanWithHttpInfo(Loan loan) Lend or borrow
ApiClient	getApiClient()
AutoRepaySetting	getAutoRepayStatus() Retrieve user auto repayment setting
okhttp3.Call	getAutoRepayStatusAsync(ApiCallback<AutoRepaySetting> _callback) Retrieve user auto repayment setting (asynchronously)
okhttp3.Call	getAutoRepayStatusCall(ApiCallback _callback) Build call for getAutoRepayStatus
ApiResponse<AutoRepaySetting>	getAutoRepayStatusWithHttpInfo() Retrieve user auto repayment setting
CrossMarginAccount	getCrossMarginAccount() Retrieve cross margin account
okhttp3.Call	getCrossMarginAccountAsync(ApiCallback<CrossMarginAccount> _callback) Retrieve cross margin account (asynchronously)
okhttp3.Call	getCrossMarginAccountCall(ApiCallback _callback) Build call for getCrossMarginAccount
ApiResponse<CrossMarginAccount>	getCrossMarginAccountWithHttpInfo() Retrieve cross margin account
CrossMarginBorrowable	getCrossMarginBorrowable(String currency) Get the max borrowable amount for a specific cross margin currency
okhttp3.Call	getCrossMarginBorrowableAsync(String currency, ApiCallback<CrossMarginBorrowable> _callback) Get the max borrowable amount for a specific cross margin currency (asynchronously)
okhttp3.Call	getCrossMarginBorrowableCall(String currency, ApiCallback _callback) Build call for getCrossMarginBorrowable
ApiResponse<CrossMarginBorrowable>	getCrossMarginBorrowableWithHttpInfo(String currency) Get the max borrowable amount for a specific cross margin currency
CrossMarginCurrency	getCrossMarginCurrency(String currency) Retrieve detail of one single currency supported by cross margin
okhttp3.Call	getCrossMarginCurrencyAsync(String currency, ApiCallback<CrossMarginCurrency> _callback) Retrieve detail of one single currency supported by cross margin (asynchronously)
okhttp3.Call	getCrossMarginCurrencyCall(String currency, ApiCallback _callback) Build call for getCrossMarginCurrency
ApiResponse<CrossMarginCurrency>	getCrossMarginCurrencyWithHttpInfo(String currency) Retrieve detail of one single currency supported by cross margin
CrossMarginLoan	getCrossMarginLoan(String loanId) Retrieve single borrow loan detail
okhttp3.Call	getCrossMarginLoanAsync(String loanId, ApiCallback<CrossMarginLoan> _callback) Retrieve single borrow loan detail (asynchronously)
okhttp3.Call	getCrossMarginLoanCall(String loanId, ApiCallback _callback) Build call for getCrossMarginLoan
ApiResponse<CrossMarginLoan>	getCrossMarginLoanWithHttpInfo(String loanId) Retrieve single borrow loan detail
CrossMarginTransferable	getCrossMarginTransferable(String currency) Get the max transferable amount for a specific cross margin currency
okhttp3.Call	getCrossMarginTransferableAsync(String currency, ApiCallback<CrossMarginTransferable> _callback) Get the max transferable amount for a specific cross margin currency (asynchronously)
okhttp3.Call	getCrossMarginTransferableCall(String currency, ApiCallback _callback) Build call for getCrossMarginTransferable
ApiResponse<CrossMarginTransferable>	getCrossMarginTransferableWithHttpInfo(String currency) Get the max transferable amount for a specific cross margin currency
Loan	getLoan(String loanId, String side) Retrieve one single loan detail
okhttp3.Call	getLoanAsync(String loanId, String side, ApiCallback<Loan> _callback) Retrieve one single loan detail (asynchronously)
okhttp3.Call	getLoanCall(String loanId, String side, ApiCallback _callback) Build call for getLoan
LoanRecord	getLoanRecord(String loanRecordId, String loanId) Get one single loan record
okhttp3.Call	getLoanRecordAsync(String loanRecordId, String loanId, ApiCallback<LoanRecord> _callback) Get one single loan record (asynchronously)
okhttp3.Call	getLoanRecordCall(String loanRecordId, String loanId, ApiCallback _callback) Build call for getLoanRecord
ApiResponse<LoanRecord>	getLoanRecordWithHttpInfo(String loanRecordId, String loanId) Get one single loan record
ApiResponse<Loan>	getLoanWithHttpInfo(String loanId, String side) Retrieve one single loan detail
MarginApi.APIgetMarginBorrowableRequest	getMarginBorrowable(String currency) Get the max borrowable amount for a specific margin currency
MarginCurrencyPair	getMarginCurrencyPair(String currencyPair) Query one single margin currency pair
okhttp3.Call	getMarginCurrencyPairAsync(String currencyPair, ApiCallback<MarginCurrencyPair> _callback) Query one single margin currency pair (asynchronously)
okhttp3.Call	getMarginCurrencyPairCall(String currencyPair, ApiCallback _callback) Build call for getMarginCurrencyPair
ApiResponse<MarginCurrencyPair>	getMarginCurrencyPairWithHttpInfo(String currencyPair) Query one single margin currency pair
MarginApi.APIgetMarginTransferableRequest	getMarginTransferable(String currency) Get the max transferable amount for a specific margin currency
MarginApi.APIlistCrossMarginAccountBookRequest	listCrossMarginAccountBook() Retrieve cross margin account change history Record time range cannot exceed 30 days
List<CrossMarginCurrency>	listCrossMarginCurrencies() Currencies supported by cross margin.
okhttp3.Call	listCrossMarginCurrenciesAsync(ApiCallback<List<CrossMarginCurrency>> _callback) Currencies supported by cross margin.
okhttp3.Call	listCrossMarginCurrenciesCall(ApiCallback _callback) Build call for listCrossMarginCurrencies
ApiResponse<List<CrossMarginCurrency>>	listCrossMarginCurrenciesWithHttpInfo() Currencies supported by cross margin.
MarginApi.APIlistCrossMarginLoansRequest	listCrossMarginLoans(Integer status) List cross margin borrow history Sort by creation time in descending order by default.
MarginApi.APIlistCrossMarginRepaymentsRequest	listCrossMarginRepayments() Retrieve cross margin repayments Sort by creation time in descending order by default.
MarginApi.APIlistFundingAccountsRequest	listFundingAccounts() Funding account list
List<FundingBookItem>	listFundingBook(String currency) Order book of lending loans
okhttp3.Call	listFundingBookAsync(String currency, ApiCallback<List<FundingBookItem>> _callback) Order book of lending loans (asynchronously)
okhttp3.Call	listFundingBookCall(String currency, ApiCallback _callback) Build call for listFundingBook
ApiResponse<List<FundingBookItem>>	listFundingBookWithHttpInfo(String currency) Order book of lending loans
MarginApi.APIlistLoanRecordsRequest	listLoanRecords(String loanId) List repayment records of a specific loan
List<Repayment>	listLoanRepayments(String loanId) List loan repayment records
okhttp3.Call	listLoanRepaymentsAsync(String loanId, ApiCallback<List<Repayment>> _callback) List loan repayment records (asynchronously)
okhttp3.Call	listLoanRepaymentsCall(String loanId, ApiCallback _callback) Build call for listLoanRepayments
ApiResponse<List<Repayment>>	listLoanRepaymentsWithHttpInfo(String loanId) List loan repayment records
MarginApi.APIlistLoansRequest	listLoans(String status, String side) List all loans
MarginApi.APIlistMarginAccountBookRequest	listMarginAccountBook() List margin account balance change history Only transferals from and to margin account are provided for now.
MarginApi.APIlistMarginAccountsRequest	listMarginAccounts() Margin account list
List<MarginCurrencyPair>	listMarginCurrencyPairs() List all supported currency pairs supported in margin trading
okhttp3.Call	listMarginCurrencyPairsAsync(ApiCallback<List<MarginCurrencyPair>> _callback) List all supported currency pairs supported in margin trading (asynchronously)
okhttp3.Call	listMarginCurrencyPairsCall(ApiCallback _callback) Build call for listMarginCurrencyPairs
ApiResponse<List<MarginCurrencyPair>>	listMarginCurrencyPairsWithHttpInfo() List all supported currency pairs supported in margin trading
Loan	mergeLoans(String currency, String ids) Merge multiple lending loans
okhttp3.Call	mergeLoansAsync(String currency, String ids, ApiCallback<Loan> _callback) Merge multiple lending loans (asynchronously)
okhttp3.Call	mergeLoansCall(String currency, String ids, ApiCallback _callback) Build call for mergeLoans
ApiResponse<Loan>	mergeLoansWithHttpInfo(String currency, String ids) Merge multiple lending loans
List<CrossMarginLoan>	repayCrossMarginLoan(CrossMarginRepayRequest crossMarginRepayRequest) Repay cross margin loan
okhttp3.Call	repayCrossMarginLoanAsync(CrossMarginRepayRequest crossMarginRepayRequest, ApiCallback<List<CrossMarginLoan>> _callback) Repay cross margin loan (asynchronously)
okhttp3.Call	repayCrossMarginLoanCall(CrossMarginRepayRequest crossMarginRepayRequest, ApiCallback _callback) Build call for repayCrossMarginLoan
ApiResponse<List<CrossMarginLoan>>	repayCrossMarginLoanWithHttpInfo(CrossMarginRepayRequest crossMarginRepayRequest) Repay cross margin loan
Loan	repayLoan(String loanId, RepayRequest repayRequest) Repay a loan
okhttp3.Call	repayLoanAsync(String loanId, RepayRequest repayRequest, ApiCallback<Loan> _callback) Repay a loan (asynchronously)
okhttp3.Call	repayLoanCall(String loanId, RepayRequest repayRequest, ApiCallback _callback) Build call for repayLoan
ApiResponse<Loan>	repayLoanWithHttpInfo(String loanId, RepayRequest repayRequest) Repay a loan
void	setApiClient(ApiClient apiClient)
AutoRepaySetting	setAutoRepay(String status) Update user's auto repayment setting
okhttp3.Call	setAutoRepayAsync(String status, ApiCallback<AutoRepaySetting> _callback) Update user's auto repayment setting (asynchronously)
okhttp3.Call	setAutoRepayCall(String status, ApiCallback _callback) Build call for setAutoRepay
ApiResponse<AutoRepaySetting>	setAutoRepayWithHttpInfo(String status) Update user's auto repayment setting
Loan	updateLoan(String loanId, LoanPatch loanPatch) Modify a loan Only `auto_renew` modification is supported currently
okhttp3.Call	updateLoanAsync(String loanId, LoanPatch loanPatch, ApiCallback<Loan> _callback) Modify a loan (asynchronously) Only `auto_renew` modification is supported currently
okhttp3.Call	updateLoanCall(String loanId, LoanPatch loanPatch, ApiCallback _callback) Build call for updateLoan
LoanRecord	updateLoanRecord(String loanRecordId, LoanPatch loanPatch) Modify a loan record Only `auto_renew` modification is supported currently
okhttp3.Call	updateLoanRecordAsync(String loanRecordId, LoanPatch loanPatch, ApiCallback<LoanRecord> _callback) Modify a loan record (asynchronously) Only `auto_renew` modification is supported currently
okhttp3.Call	updateLoanRecordCall(String loanRecordId, LoanPatch loanPatch, ApiCallback _callback) Build call for updateLoanRecord
ApiResponse<LoanRecord>	updateLoanRecordWithHttpInfo(String loanRecordId, LoanPatch loanPatch) Modify a loan record Only `auto_renew` modification is supported currently
ApiResponse<Loan>	updateLoanWithHttpInfo(String loanId, LoanPatch loanPatch) Modify a loan Only `auto_renew` modification is supported currently

Methods inherited from class java.lang.Object

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

Constructor Detail

MarginApi

public MarginApi()

MarginApi

public MarginApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listMarginCurrencyPairsCall

public okhttp3.Call listMarginCurrencyPairsCall(ApiCallback _callback)
                                         throws ApiException

Build call for listMarginCurrencyPairs

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	-

listMarginCurrencyPairs

public List<MarginCurrencyPair> listMarginCurrencyPairs()
                                                 throws ApiException

List all supported currency pairs supported in margin trading

Returns:

List<MarginCurrencyPair>

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	-

listMarginCurrencyPairsWithHttpInfo

public ApiResponse<List<MarginCurrencyPair>> listMarginCurrencyPairsWithHttpInfo()
                                                                          throws ApiException

List all supported currency pairs supported in margin trading

Returns:

ApiResponse<List<MarginCurrencyPair>>

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	-

listMarginCurrencyPairsAsync

public okhttp3.Call listMarginCurrencyPairsAsync(ApiCallback<List<MarginCurrencyPair>> _callback)
                                          throws ApiException

List all supported currency pairs supported in margin trading (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	-

getMarginCurrencyPairCall

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

Build call for getMarginCurrencyPair

Parameters:

currencyPair - Margin 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	-

getMarginCurrencyPair

public MarginCurrencyPair getMarginCurrencyPair(String currencyPair)
                                         throws ApiException

Query one single margin currency pair

Parameters:

currencyPair - Margin currency pair (required)

Returns:

MarginCurrencyPair

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	-

getMarginCurrencyPairWithHttpInfo

public ApiResponse<MarginCurrencyPair> getMarginCurrencyPairWithHttpInfo(String currencyPair)
                                                                  throws ApiException

Query one single margin currency pair

Parameters:

currencyPair - Margin currency pair (required)

Returns:

ApiResponse<MarginCurrencyPair>

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	-

getMarginCurrencyPairAsync

public okhttp3.Call getMarginCurrencyPairAsync(String currencyPair,
                                               ApiCallback<MarginCurrencyPair> _callback)
                                        throws ApiException

Query one single margin currency pair (asynchronously)

Parameters:

currencyPair - Margin 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	-

listFundingBookCall

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

Build call for listFundingBook

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	Order book retrieved	-

listFundingBook

public List<FundingBookItem> listFundingBook(String currency)
                                      throws ApiException

Order book of lending loans

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

List<FundingBookItem>

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

listFundingBookWithHttpInfo

public ApiResponse<List<FundingBookItem>> listFundingBookWithHttpInfo(String currency)
                                                               throws ApiException

Order book of lending loans

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<List<FundingBookItem>>

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

listFundingBookAsync

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

Order book of lending loans (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	Order book retrieved	-

listMarginAccounts

public MarginApi.APIlistMarginAccountsRequest listMarginAccounts()

Margin account list

Returns:

APIlistMarginAccountsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listMarginAccountBook

public MarginApi.APIlistMarginAccountBookRequest listMarginAccountBook()

List margin account balance change history Only transferals from and to margin account are provided for now. Time range allows 30 days at most

Returns:

APIlistMarginAccountBookRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listFundingAccounts

public MarginApi.APIlistFundingAccountsRequest listFundingAccounts()

Funding account list

Returns:

APIlistFundingAccountsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listLoans

public MarginApi.APIlistLoansRequest listLoans(String status,
                                               String side)

List all loans

Parameters:

status - Loan status (required)

side - Lend or borrow (required)

Returns:

APIlistLoansRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createLoanCall

public okhttp3.Call createLoanCall(Loan loan,
                                   ApiCallback _callback)
                            throws ApiException

Build call for createLoan

Parameters:

loan - (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	Loan created	-

createLoan

public Loan createLoan(Loan loan)
                throws ApiException

Lend or borrow

Parameters:

loan - (required)

Returns:

Loan

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	Loan created	-

createLoanWithHttpInfo

public ApiResponse<Loan> createLoanWithHttpInfo(Loan loan)
                                         throws ApiException

Lend or borrow

Parameters:

loan - (required)

Returns:

ApiResponse<Loan>

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	Loan created	-

createLoanAsync

public okhttp3.Call createLoanAsync(Loan loan,
                                    ApiCallback<Loan> _callback)
                             throws ApiException

Lend or borrow (asynchronously)

Parameters:

loan - (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	Loan created	-

mergeLoansCall

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

Build call for mergeLoans

Parameters:

currency - Retrieve data of the specified currency (required)

ids - A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (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	Loans merged	-

mergeLoans

public Loan mergeLoans(String currency,
                       String ids)
                throws ApiException

Merge multiple lending loans

Parameters:

currency - Retrieve data of the specified currency (required)

ids - A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (required)

Returns:

Loan

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	Loans merged	-

mergeLoansWithHttpInfo

public ApiResponse<Loan> mergeLoansWithHttpInfo(String currency,
                                                String ids)
                                         throws ApiException

Merge multiple lending loans

Parameters:

currency - Retrieve data of the specified currency (required)

ids - A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (required)

Returns:

ApiResponse<Loan>

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	Loans merged	-

mergeLoansAsync

public okhttp3.Call mergeLoansAsync(String currency,
                                    String ids,
                                    ApiCallback<Loan> _callback)
                             throws ApiException

Merge multiple lending loans (asynchronously)

Parameters:

currency - Retrieve data of the specified currency (required)

ids - A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (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	Loans merged	-

getLoanCall

public okhttp3.Call getLoanCall(String loanId,
                                String side,
                                ApiCallback _callback)
                         throws ApiException

Build call for getLoan

Parameters:

loanId - Loan ID (required)

side - Lend or borrow (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getLoan

public Loan getLoan(String loanId,
                    String side)
             throws ApiException

Retrieve one single loan detail

Parameters:

loanId - Loan ID (required)

side - Lend or borrow (required)

Returns:

Loan

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	-

getLoanWithHttpInfo

public ApiResponse<Loan> getLoanWithHttpInfo(String loanId,
                                             String side)
                                      throws ApiException

Retrieve one single loan detail

Parameters:

loanId - Loan ID (required)

side - Lend or borrow (required)

Returns:

ApiResponse<Loan>

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	-

getLoanAsync

public okhttp3.Call getLoanAsync(String loanId,
                                 String side,
                                 ApiCallback<Loan> _callback)
                          throws ApiException

Retrieve one single loan detail (asynchronously)

Parameters:

loanId - Loan ID (required)

side - Lend or borrow (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

cancelLoanCall

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

Build call for cancelLoan

Parameters:

loanId - Loan ID (required)

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

cancelLoan

public Loan cancelLoan(String loanId,
                       String currency)
                throws ApiException

Cancel lending loan Only lent loans can be cancelled

Parameters:

loanId - Loan ID (required)

currency - Retrieve data of the specified currency (required)

Returns:

Loan

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	-

cancelLoanWithHttpInfo

public ApiResponse<Loan> cancelLoanWithHttpInfo(String loanId,
                                                String currency)
                                         throws ApiException

Cancel lending loan Only lent loans can be cancelled

Parameters:

loanId - Loan ID (required)

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<Loan>

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	-

cancelLoanAsync

public okhttp3.Call cancelLoanAsync(String loanId,
                                    String currency,
                                    ApiCallback<Loan> _callback)
                             throws ApiException

Cancel lending loan (asynchronously) Only lent loans can be cancelled

Parameters:

loanId - Loan ID (required)

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

updateLoanCall

public okhttp3.Call updateLoanCall(String loanId,
                                   LoanPatch loanPatch,
                                   ApiCallback _callback)
                            throws ApiException

Build call for updateLoan

Parameters:

loanId - Loan ID (required)

loanPatch - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Updated	-

updateLoan

public Loan updateLoan(String loanId,
                       LoanPatch loanPatch)
                throws ApiException

Modify a loan Only `auto_renew` modification is supported currently

Parameters:

loanId - Loan ID (required)

loanPatch - (required)

Returns:

Loan

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Updated	-

updateLoanWithHttpInfo

public ApiResponse<Loan> updateLoanWithHttpInfo(String loanId,
                                                LoanPatch loanPatch)
                                         throws ApiException

Modify a loan Only `auto_renew` modification is supported currently

Parameters:

loanId - Loan ID (required)

loanPatch - (required)

Returns:

ApiResponse<Loan>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Updated	-

updateLoanAsync

public okhttp3.Call updateLoanAsync(String loanId,
                                    LoanPatch loanPatch,
                                    ApiCallback<Loan> _callback)
                             throws ApiException

Modify a loan (asynchronously) Only `auto_renew` modification is supported currently

Parameters:

loanId - Loan ID (required)

loanPatch - (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Updated	-

listLoanRepaymentsCall

public okhttp3.Call listLoanRepaymentsCall(String loanId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for listLoanRepayments

Parameters:

loanId - Loan ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listLoanRepayments

public List<Repayment> listLoanRepayments(String loanId)
                                   throws ApiException

List loan repayment records

Parameters:

loanId - Loan ID (required)

Returns:

List<Repayment>

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	-

listLoanRepaymentsWithHttpInfo

public ApiResponse<List<Repayment>> listLoanRepaymentsWithHttpInfo(String loanId)
                                                            throws ApiException

List loan repayment records

Parameters:

loanId - Loan ID (required)

Returns:

ApiResponse<List<Repayment>>

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	-

listLoanRepaymentsAsync

public okhttp3.Call listLoanRepaymentsAsync(String loanId,
                                            ApiCallback<List<Repayment>> _callback)
                                     throws ApiException

List loan repayment records (asynchronously)

Parameters:

loanId - Loan ID (required)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

repayLoanCall

public okhttp3.Call repayLoanCall(String loanId,
                                  RepayRequest repayRequest,
                                  ApiCallback _callback)
                           throws ApiException

Build call for repayLoan

Parameters:

loanId - Loan ID (required)

repayRequest - (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	Loan repaid	-

repayLoan

public Loan repayLoan(String loanId,
                      RepayRequest repayRequest)
               throws ApiException

Repay a loan

Parameters:

loanId - Loan ID (required)

repayRequest - (required)

Returns:

Loan

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	Loan repaid	-

repayLoanWithHttpInfo

public ApiResponse<Loan> repayLoanWithHttpInfo(String loanId,
                                               RepayRequest repayRequest)
                                        throws ApiException

Repay a loan

Parameters:

loanId - Loan ID (required)

repayRequest - (required)

Returns:

ApiResponse<Loan>

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	Loan repaid	-

repayLoanAsync

public okhttp3.Call repayLoanAsync(String loanId,
                                   RepayRequest repayRequest,
                                   ApiCallback<Loan> _callback)
                            throws ApiException

Repay a loan (asynchronously)

Parameters:

loanId - Loan ID (required)

repayRequest - (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	Loan repaid	-

listLoanRecords

public MarginApi.APIlistLoanRecordsRequest listLoanRecords(String loanId)

List repayment records of a specific loan

Parameters:

loanId - Loan ID (required)

Returns:

APIlistLoanRecordsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getLoanRecordCall

public okhttp3.Call getLoanRecordCall(String loanRecordId,
                                      String loanId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getLoanRecord

Parameters:

loanRecordId - Loan record ID (required)

loanId - Loan ID (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	Detail retrieved	-

getLoanRecord

public LoanRecord getLoanRecord(String loanRecordId,
                                String loanId)
                         throws ApiException

Get one single loan record

Parameters:

loanRecordId - Loan record ID (required)

loanId - Loan ID (required)

Returns:

LoanRecord

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	-

getLoanRecordWithHttpInfo

public ApiResponse<LoanRecord> getLoanRecordWithHttpInfo(String loanRecordId,
                                                         String loanId)
                                                  throws ApiException

Get one single loan record

Parameters:

loanRecordId - Loan record ID (required)

loanId - Loan ID (required)

Returns:

ApiResponse<LoanRecord>

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	-

getLoanRecordAsync

public okhttp3.Call getLoanRecordAsync(String loanRecordId,
                                       String loanId,
                                       ApiCallback<LoanRecord> _callback)
                                throws ApiException

Get one single loan record (asynchronously)

Parameters:

loanRecordId - Loan record ID (required)

loanId - Loan ID (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	Detail retrieved	-

updateLoanRecordCall

public okhttp3.Call updateLoanRecordCall(String loanRecordId,
                                         LoanPatch loanPatch,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for updateLoanRecord

Parameters:

loanRecordId - Loan record ID (required)

loanPatch - (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	Loan record updated	-

updateLoanRecord

public LoanRecord updateLoanRecord(String loanRecordId,
                                   LoanPatch loanPatch)
                            throws ApiException

Modify a loan record Only `auto_renew` modification is supported currently

Parameters:

loanRecordId - Loan record ID (required)

loanPatch - (required)

Returns:

LoanRecord

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	Loan record updated	-

updateLoanRecordWithHttpInfo

public ApiResponse<LoanRecord> updateLoanRecordWithHttpInfo(String loanRecordId,
                                                            LoanPatch loanPatch)
                                                     throws ApiException

Modify a loan record Only `auto_renew` modification is supported currently

Parameters:

loanRecordId - Loan record ID (required)

loanPatch - (required)

Returns:

ApiResponse<LoanRecord>

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	Loan record updated	-

updateLoanRecordAsync

public okhttp3.Call updateLoanRecordAsync(String loanRecordId,
                                          LoanPatch loanPatch,
                                          ApiCallback<LoanRecord> _callback)
                                   throws ApiException

Modify a loan record (asynchronously) Only `auto_renew` modification is supported currently

Parameters:

loanRecordId - Loan record ID (required)

loanPatch - (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	Loan record updated	-

getAutoRepayStatusCall

public okhttp3.Call getAutoRepayStatusCall(ApiCallback _callback)
                                    throws ApiException

Build call for getAutoRepayStatus

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	Current auto repayment setting	-

getAutoRepayStatus

public AutoRepaySetting getAutoRepayStatus()
                                    throws ApiException

Retrieve user auto repayment setting

Returns:

AutoRepaySetting

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	Current auto repayment setting	-

getAutoRepayStatusWithHttpInfo

public ApiResponse<AutoRepaySetting> getAutoRepayStatusWithHttpInfo()
                                                             throws ApiException

Retrieve user auto repayment setting

Returns:

ApiResponse<AutoRepaySetting>

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	Current auto repayment setting	-

getAutoRepayStatusAsync

public okhttp3.Call getAutoRepayStatusAsync(ApiCallback<AutoRepaySetting> _callback)
                                     throws ApiException

Retrieve user auto repayment setting (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	Current auto repayment setting	-

setAutoRepayCall

public okhttp3.Call setAutoRepayCall(String status,
                                     ApiCallback _callback)
                              throws ApiException

Build call for setAutoRepay

Parameters:

status - New auto repayment status. `on` - enabled, `off` - disabled (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	Current auto repayment setting	-

setAutoRepay

public AutoRepaySetting setAutoRepay(String status)
                              throws ApiException

Update user's auto repayment setting

Parameters:

status - New auto repayment status. `on` - enabled, `off` - disabled (required)

Returns:

AutoRepaySetting

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	Current auto repayment setting	-

setAutoRepayWithHttpInfo

public ApiResponse<AutoRepaySetting> setAutoRepayWithHttpInfo(String status)
                                                       throws ApiException

Update user's auto repayment setting

Parameters:

status - New auto repayment status. `on` - enabled, `off` - disabled (required)

Returns:

ApiResponse<AutoRepaySetting>

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	Current auto repayment setting	-

setAutoRepayAsync

public okhttp3.Call setAutoRepayAsync(String status,
                                      ApiCallback<AutoRepaySetting> _callback)
                               throws ApiException

Update user's auto repayment setting (asynchronously)

Parameters:

status - New auto repayment status. `on` - enabled, `off` - disabled (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	Current auto repayment setting	-

getMarginTransferable

public MarginApi.APIgetMarginTransferableRequest getMarginTransferable(String currency)

Get the max transferable amount for a specific margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

APIgetMarginTransferableRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

getMarginBorrowable

public MarginApi.APIgetMarginBorrowableRequest getMarginBorrowable(String currency)

Get the max borrowable amount for a specific margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

APIgetMarginBorrowableRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listCrossMarginCurrenciesCall

public okhttp3.Call listCrossMarginCurrenciesCall(ApiCallback _callback)
                                           throws ApiException

Build call for listCrossMarginCurrencies

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	-

listCrossMarginCurrencies

public List<CrossMarginCurrency> listCrossMarginCurrencies()
                                                    throws ApiException

Currencies supported by cross margin.

Returns:

List<CrossMarginCurrency>

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	-

listCrossMarginCurrenciesWithHttpInfo

public ApiResponse<List<CrossMarginCurrency>> listCrossMarginCurrenciesWithHttpInfo()
                                                                             throws ApiException

Currencies supported by cross margin.

Returns:

ApiResponse<List<CrossMarginCurrency>>

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	-

listCrossMarginCurrenciesAsync

public okhttp3.Call listCrossMarginCurrenciesAsync(ApiCallback<List<CrossMarginCurrency>> _callback)
                                            throws ApiException

Currencies supported by cross margin. (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	-

getCrossMarginCurrencyCall

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

Build call for getCrossMarginCurrency

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	-

getCrossMarginCurrency

public CrossMarginCurrency getCrossMarginCurrency(String currency)
                                           throws ApiException

Retrieve detail of one single currency supported by cross margin

Parameters:

currency - Currency name (required)

Returns:

CrossMarginCurrency

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	-

getCrossMarginCurrencyWithHttpInfo

public ApiResponse<CrossMarginCurrency> getCrossMarginCurrencyWithHttpInfo(String currency)
                                                                    throws ApiException

Retrieve detail of one single currency supported by cross margin

Parameters:

currency - Currency name (required)

Returns:

ApiResponse<CrossMarginCurrency>

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	-

getCrossMarginCurrencyAsync

public okhttp3.Call getCrossMarginCurrencyAsync(String currency,
                                                ApiCallback<CrossMarginCurrency> _callback)
                                         throws ApiException

Retrieve detail of one single currency supported by cross margin (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	-

getCrossMarginAccountCall

public okhttp3.Call getCrossMarginAccountCall(ApiCallback _callback)
                                       throws ApiException

Build call for getCrossMarginAccount

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	-

getCrossMarginAccount

public CrossMarginAccount getCrossMarginAccount()
                                         throws ApiException

Retrieve cross margin account

Returns:

CrossMarginAccount

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	-

getCrossMarginAccountWithHttpInfo

public ApiResponse<CrossMarginAccount> getCrossMarginAccountWithHttpInfo()
                                                                  throws ApiException

Retrieve cross margin account

Returns:

ApiResponse<CrossMarginAccount>

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	-

getCrossMarginAccountAsync

public okhttp3.Call getCrossMarginAccountAsync(ApiCallback<CrossMarginAccount> _callback)
                                        throws ApiException

Retrieve cross margin account (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	Successfully retrieved	-

listCrossMarginAccountBook

public MarginApi.APIlistCrossMarginAccountBookRequest listCrossMarginAccountBook()

Retrieve cross margin account change history Record time range cannot exceed 30 days

Returns:

APIlistCrossMarginAccountBookRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listCrossMarginLoans

public MarginApi.APIlistCrossMarginLoansRequest listCrossMarginLoans(Integer status)

List cross margin borrow history Sort by creation time in descending order by default. Set `reverse=false` to return ascending results.

Parameters:

status - Filter by status. Supported values are 2 and 3. (required)

Returns:

APIlistCrossMarginLoansRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

createCrossMarginLoanCall

public okhttp3.Call createCrossMarginLoanCall(CrossMarginLoan crossMarginLoan,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createCrossMarginLoan

Parameters:

crossMarginLoan - (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 borrowed	-

createCrossMarginLoan

public CrossMarginLoan createCrossMarginLoan(CrossMarginLoan crossMarginLoan)
                                      throws ApiException

Create a cross margin borrow loan Borrow amount cannot be less than currency minimum borrow amount

Parameters:

crossMarginLoan - (required)

Returns:

CrossMarginLoan

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

createCrossMarginLoanWithHttpInfo

public ApiResponse<CrossMarginLoan> createCrossMarginLoanWithHttpInfo(CrossMarginLoan crossMarginLoan)
                                                               throws ApiException

Create a cross margin borrow loan Borrow amount cannot be less than currency minimum borrow amount

Parameters:

crossMarginLoan - (required)

Returns:

ApiResponse<CrossMarginLoan>

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

createCrossMarginLoanAsync

public okhttp3.Call createCrossMarginLoanAsync(CrossMarginLoan crossMarginLoan,
                                               ApiCallback<CrossMarginLoan> _callback)
                                        throws ApiException

Create a cross margin borrow loan (asynchronously) Borrow amount cannot be less than currency minimum borrow amount

Parameters:

crossMarginLoan - (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 borrowed	-

getCrossMarginLoanCall

public okhttp3.Call getCrossMarginLoanCall(String loanId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getCrossMarginLoan

Parameters:

loanId - Borrow loan ID (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	-

getCrossMarginLoan

public CrossMarginLoan getCrossMarginLoan(String loanId)
                                   throws ApiException

Retrieve single borrow loan detail

Parameters:

loanId - Borrow loan ID (required)

Returns:

CrossMarginLoan

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	-

getCrossMarginLoanWithHttpInfo

public ApiResponse<CrossMarginLoan> getCrossMarginLoanWithHttpInfo(String loanId)
                                                            throws ApiException

Retrieve single borrow loan detail

Parameters:

loanId - Borrow loan ID (required)

Returns:

ApiResponse<CrossMarginLoan>

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	-

getCrossMarginLoanAsync

public okhttp3.Call getCrossMarginLoanAsync(String loanId,
                                            ApiCallback<CrossMarginLoan> _callback)
                                     throws ApiException

Retrieve single borrow loan detail (asynchronously)

Parameters:

loanId - Borrow loan ID (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	-

listCrossMarginRepayments

public MarginApi.APIlistCrossMarginRepaymentsRequest listCrossMarginRepayments()

Retrieve cross margin repayments Sort by creation time in descending order by default. Set `reverse=false` to return ascending results.

Returns:

APIlistCrossMarginRepaymentsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

repayCrossMarginLoanCall

public okhttp3.Call repayCrossMarginLoanCall(CrossMarginRepayRequest crossMarginRepayRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for repayCrossMarginLoan

Parameters:

crossMarginRepayRequest - (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	Loan repaid	-

repayCrossMarginLoan

public List<CrossMarginLoan> repayCrossMarginLoan(CrossMarginRepayRequest crossMarginRepayRequest)
                                           throws ApiException

Repay cross margin loan

Parameters:

crossMarginRepayRequest - (required)

Returns:

List<CrossMarginLoan>

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	Loan repaid	-

repayCrossMarginLoanWithHttpInfo

public ApiResponse<List<CrossMarginLoan>> repayCrossMarginLoanWithHttpInfo(CrossMarginRepayRequest crossMarginRepayRequest)
                                                                    throws ApiException

Repay cross margin loan

Parameters:

crossMarginRepayRequest - (required)

Returns:

ApiResponse<List<CrossMarginLoan>>

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	Loan repaid	-

repayCrossMarginLoanAsync

public okhttp3.Call repayCrossMarginLoanAsync(CrossMarginRepayRequest crossMarginRepayRequest,
                                              ApiCallback<List<CrossMarginLoan>> _callback)
                                       throws ApiException

Repay cross margin loan (asynchronously)

Parameters:

crossMarginRepayRequest - (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	Loan repaid	-

getCrossMarginTransferableCall

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

Build call for getCrossMarginTransferable

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	-

getCrossMarginTransferable

public CrossMarginTransferable getCrossMarginTransferable(String currency)
                                                   throws ApiException

Get the max transferable amount for a specific cross margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

CrossMarginTransferable

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	-

getCrossMarginTransferableWithHttpInfo

public ApiResponse<CrossMarginTransferable> getCrossMarginTransferableWithHttpInfo(String currency)
                                                                            throws ApiException

Get the max transferable amount for a specific cross margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<CrossMarginTransferable>

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	-

getCrossMarginTransferableAsync

public okhttp3.Call getCrossMarginTransferableAsync(String currency,
                                                    ApiCallback<CrossMarginTransferable> _callback)
                                             throws ApiException

Get the max transferable amount for a specific cross margin currency (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	-

getCrossMarginBorrowableCall

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

Build call for getCrossMarginBorrowable

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	-

getCrossMarginBorrowable

public CrossMarginBorrowable getCrossMarginBorrowable(String currency)
                                               throws ApiException

Get the max borrowable amount for a specific cross margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

CrossMarginBorrowable

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	-

getCrossMarginBorrowableWithHttpInfo

public ApiResponse<CrossMarginBorrowable> getCrossMarginBorrowableWithHttpInfo(String currency)
                                                                        throws ApiException

Get the max borrowable amount for a specific cross margin currency

Parameters:

currency - Retrieve data of the specified currency (required)

Returns:

ApiResponse<CrossMarginBorrowable>

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	-

getCrossMarginBorrowableAsync

public okhttp3.Call getCrossMarginBorrowableAsync(String currency,
                                                  ApiCallback<CrossMarginBorrowable> _callback)
                                           throws ApiException

Get the max borrowable amount for a specific cross margin currency (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	-