io.gate.gateapi.api

Class OptionsApi.APIlistOptionsCandlesticksRequest

java.lang.Object

io.gate.gateapi.api.OptionsApi.APIlistOptionsCandlesticksRequest

Enclosing class:

OptionsApi

public class OptionsApi.APIlistOptionsCandlesticksRequest
extends Object

Method Summary

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

Set limit

Parameters:

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

Returns:

APIlistOptionsCandlesticksRequest

from

public OptionsApi.APIlistOptionsCandlesticksRequest from(Long from)

Set from

Parameters:

from - Start timestamp (optional)

Returns:

APIlistOptionsCandlesticksRequest

to

public OptionsApi.APIlistOptionsCandlesticksRequest to(Long to)

Set to

Parameters:

to - End timestamp (optional)

Returns:

APIlistOptionsCandlesticksRequest

interval

public OptionsApi.APIlistOptionsCandlesticksRequest interval(String interval)

Set interval

Parameters:

interval - Interval time between data points (optional, default to 5m)

Returns:

APIlistOptionsCandlesticksRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOptionsCandlesticks

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

Execute listOptionsCandlesticks request

Returns:

List<OptionsCandlestick>

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

Execute listOptionsCandlesticks request with HTTP info returned

Returns:

ApiResponse<List<OptionsCandlestick>>

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

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