io.gate.gateapi.api

Class SpotApi.APIlistTradesRequest

java.lang.Object

io.gate.gateapi.api.SpotApi.APIlistTradesRequest

Enclosing class:

SpotApi

public class SpotApi.APIlistTradesRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listTrades
List<Trade>	execute() Execute listTrades request
okhttp3.Call	executeAsync(ApiCallback<List<Trade>> _callback) Execute listTrades request (asynchronously)
ApiResponse<List<Trade>>	executeWithHttpInfo() Execute listTrades request with HTTP info returned
SpotApi.APIlistTradesRequest	from(Long from) Set from
SpotApi.APIlistTradesRequest	lastId(String lastId) Set lastId
SpotApi.APIlistTradesRequest	limit(Integer limit) Set limit
SpotApi.APIlistTradesRequest	page(Integer page) Set page
SpotApi.APIlistTradesRequest	reverse(Boolean reverse) Set reverse
SpotApi.APIlistTradesRequest	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 SpotApi.APIlistTradesRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional, default to 100)

Returns:

APIlistTradesRequest

lastId

public SpotApi.APIlistTradesRequest lastId(String lastId)

Set lastId

Parameters:

lastId - Specify list staring point using the `id` of last record in previous list-query results (optional)

Returns:

APIlistTradesRequest

reverse

public SpotApi.APIlistTradesRequest reverse(Boolean reverse)

Set reverse

Parameters:

reverse - Whether the id of records to be retrieved should be less than the last_id specified. Default to false. When `last_id` is specified. Set `reverse` to `true` to trace back trading history; `false` to retrieve latest tradings. No effect if `last_id` is not specified. (optional, default to false)

Returns:

APIlistTradesRequest

from

public SpotApi.APIlistTradesRequest from(Long from)

Set from

Parameters:

from - Start timestamp of the query (optional)

Returns:

APIlistTradesRequest

to

public SpotApi.APIlistTradesRequest to(Long to)

Set to

Parameters:

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

Returns:

APIlistTradesRequest

page

public SpotApi.APIlistTradesRequest page(Integer page)

Set page

Parameters:

page - Page number (optional, default to 1)

Returns:

APIlistTradesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listTrades

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

Execute listTrades request

Returns:

List<Trade>

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

Execute listTrades request with HTTP info returned

Returns:

ApiResponse<List<Trade>>

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

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