io.gate.gateapi.api

Class FuturesApi.APIlistFuturesTradesRequest

java.lang.Object

io.gate.gateapi.api.FuturesApi.APIlistFuturesTradesRequest

Enclosing class:

FuturesApi

public class FuturesApi.APIlistFuturesTradesRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listFuturesTrades
List<FuturesTrade>	execute() Execute listFuturesTrades request
okhttp3.Call	executeAsync(ApiCallback<List<FuturesTrade>> _callback) Execute listFuturesTrades request (asynchronously)
ApiResponse<List<FuturesTrade>>	executeWithHttpInfo() Execute listFuturesTrades request with HTTP info returned
FuturesApi.APIlistFuturesTradesRequest	from(Long from) Set from
FuturesApi.APIlistFuturesTradesRequest	lastId(String lastId) Set lastId
FuturesApi.APIlistFuturesTradesRequest	limit(Integer limit) Set limit
FuturesApi.APIlistFuturesTradesRequest	offset(Integer offset) Set offset
FuturesApi.APIlistFuturesTradesRequest	to(Long to) Set to

Methods inherited from class java.lang.Object

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

Method Detail

limit

public FuturesApi.APIlistFuturesTradesRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistFuturesTradesRequest

offset

public FuturesApi.APIlistFuturesTradesRequest offset(Integer offset)

Set offset

Parameters:

offset - List offset, starting from 0 (optional, default to 0)

Returns:

APIlistFuturesTradesRequest

lastId

public FuturesApi.APIlistFuturesTradesRequest lastId(String lastId)

Set lastId

Parameters:

lastId - Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range (optional)

Returns:

APIlistFuturesTradesRequest

from

public FuturesApi.APIlistFuturesTradesRequest from(Long from)

Set from

Parameters:

from - Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. (optional)

Returns:

APIlistFuturesTradesRequest

to

public FuturesApi.APIlistFuturesTradesRequest to(Long to)

Set to

Parameters:

to - Specify end time in Unix seconds, default to current time (optional)

Returns:

APIlistFuturesTradesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listFuturesTrades

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<FuturesTrade> execute()
                           throws ApiException

Execute listFuturesTrades request

Returns:

List<FuturesTrade>

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<FuturesTrade>> executeWithHttpInfo()
                                                    throws ApiException

Execute listFuturesTrades request with HTTP info returned

Returns:

ApiResponse<List<FuturesTrade>>

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<FuturesTrade>> _callback)
                          throws ApiException

Execute listFuturesTrades 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	-