io.gate.gateapi.api

Class MarginApi.APIlistMarginAccountBookRequest

java.lang.Object

io.gate.gateapi.api.MarginApi.APIlistMarginAccountBookRequest

Enclosing class:

MarginApi

public class MarginApi.APIlistMarginAccountBookRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listMarginAccountBook
MarginApi.APIlistMarginAccountBookRequest	currency(String currency) Set currency
MarginApi.APIlistMarginAccountBookRequest	currencyPair(String currencyPair) Set currencyPair
List<MarginAccountBook>	execute() Execute listMarginAccountBook request
okhttp3.Call	executeAsync(ApiCallback<List<MarginAccountBook>> _callback) Execute listMarginAccountBook request (asynchronously)
ApiResponse<List<MarginAccountBook>>	executeWithHttpInfo() Execute listMarginAccountBook request with HTTP info returned
MarginApi.APIlistMarginAccountBookRequest	from(Long from) Set from
MarginApi.APIlistMarginAccountBookRequest	limit(Integer limit) Set limit
MarginApi.APIlistMarginAccountBookRequest	page(Integer page) Set page
MarginApi.APIlistMarginAccountBookRequest	to(Long to) Set to
MarginApi.APIlistMarginAccountBookRequest	type(String type) Set type

Methods inherited from class java.lang.Object

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

Method Detail

currency

public MarginApi.APIlistMarginAccountBookRequest currency(String currency)

Set currency

Parameters:

currency - List records related to specified currency only. If specified, `currency_pair` is also required. (optional)

Returns:

APIlistMarginAccountBookRequest

currencyPair

public MarginApi.APIlistMarginAccountBookRequest currencyPair(String currencyPair)

Set currencyPair

Parameters:

currencyPair - List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional)

Returns:

APIlistMarginAccountBookRequest

type

public MarginApi.APIlistMarginAccountBookRequest type(String type)

Set type

Parameters:

type - Only retrieve changes of the specified type. All types will be returned if not specified. (optional)

Returns:

APIlistMarginAccountBookRequest

from

public MarginApi.APIlistMarginAccountBookRequest from(Long from)

Set from

Parameters:

from - Start timestamp of the query (optional)

Returns:

APIlistMarginAccountBookRequest

to

public MarginApi.APIlistMarginAccountBookRequest to(Long to)

Set to

Parameters:

to - Time range ending, default to current time (optional)

Returns:

APIlistMarginAccountBookRequest

page

public MarginApi.APIlistMarginAccountBookRequest page(Integer page)

Set page

Parameters:

page - Page number (optional, default to 1)

Returns:

APIlistMarginAccountBookRequest

limit

public MarginApi.APIlistMarginAccountBookRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned in a single list (optional, default to 100)

Returns:

APIlistMarginAccountBookRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listMarginAccountBook

Parameters:

_callback - ApiCallback API callback

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	-

execute

public List<MarginAccountBook> execute()
                                throws ApiException

Execute listMarginAccountBook request

Returns:

List<MarginAccountBook>

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	-

executeWithHttpInfo

public ApiResponse<List<MarginAccountBook>> executeWithHttpInfo()
                                                         throws ApiException

Execute listMarginAccountBook request with HTTP info returned

Returns:

ApiResponse<List<MarginAccountBook>>

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	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<List<MarginAccountBook>> _callback)
                          throws ApiException

Execute listMarginAccountBook request (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	-