io.gate.gateapi.api

Class SpotApi.APIlistCandlesticksRequest

java.lang.Object

io.gate.gateapi.api.SpotApi.APIlistCandlesticksRequest

Enclosing class:

SpotApi

public class SpotApi.APIlistCandlesticksRequest
extends Object

Method Summary

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

Set limit

Parameters:

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

Returns:

APIlistCandlesticksRequest

from

public SpotApi.APIlistCandlesticksRequest 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:

APIlistCandlesticksRequest

to

public SpotApi.APIlistCandlesticksRequest to(Long to)

Set to

Parameters:

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

Returns:

APIlistCandlesticksRequest

interval

public SpotApi.APIlistCandlesticksRequest interval(String interval)

Set interval

Parameters:

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

Returns:

APIlistCandlesticksRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listCandlesticks

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

Execute listCandlesticks request

Returns:

List<List<String>>

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

Execute listCandlesticks request with HTTP info returned

Returns:

ApiResponse<List<List<String>>>

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

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