io.gate.gateapi.api

Class FuturesApi.APIlistFuturesCandlesticksRequest

java.lang.Object

io.gate.gateapi.api.FuturesApi.APIlistFuturesCandlesticksRequest

Enclosing class:

FuturesApi

public class FuturesApi.APIlistFuturesCandlesticksRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listFuturesCandlesticks
List<FuturesCandlestick>	execute() Execute listFuturesCandlesticks request
okhttp3.Call	executeAsync(ApiCallback<List<FuturesCandlestick>> _callback) Execute listFuturesCandlesticks request (asynchronously)
ApiResponse<List<FuturesCandlestick>>	executeWithHttpInfo() Execute listFuturesCandlesticks request with HTTP info returned
FuturesApi.APIlistFuturesCandlesticksRequest	from(Long from) Set from
FuturesApi.APIlistFuturesCandlesticksRequest	interval(String interval) Set interval
FuturesApi.APIlistFuturesCandlesticksRequest	limit(Integer limit) Set limit
FuturesApi.APIlistFuturesCandlesticksRequest	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

from

public FuturesApi.APIlistFuturesCandlesticksRequest from(Long from)

Set from

Parameters:

from - Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)

Returns:

APIlistFuturesCandlesticksRequest

to

public FuturesApi.APIlistFuturesCandlesticksRequest to(Long to)

Set to

Parameters:

to - End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)

Returns:

APIlistFuturesCandlesticksRequest

limit

public FuturesApi.APIlistFuturesCandlesticksRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional, default to 100)

Returns:

APIlistFuturesCandlesticksRequest

interval

public FuturesApi.APIlistFuturesCandlesticksRequest interval(String interval)

Set interval

Parameters:

interval - Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 (optional, default to 5m)

Returns:

APIlistFuturesCandlesticksRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listFuturesCandlesticks

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

execute

public List<FuturesCandlestick> execute()
                                 throws ApiException

Execute listFuturesCandlesticks request

Returns:

List<FuturesCandlestick>

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	-

executeWithHttpInfo

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

Execute listFuturesCandlesticks request with HTTP info returned

Returns:

ApiResponse<List<FuturesCandlestick>>

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	-

executeAsync

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

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