io.gate.gateapi.api

Class FuturesApi.APIlistFuturesOrderBookRequest

java.lang.Object

io.gate.gateapi.api.FuturesApi.APIlistFuturesOrderBookRequest

Enclosing class:

FuturesApi

public class FuturesApi.APIlistFuturesOrderBookRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listFuturesOrderBook
FuturesOrderBook	execute() Execute listFuturesOrderBook request
okhttp3.Call	executeAsync(ApiCallback<FuturesOrderBook> _callback) Execute listFuturesOrderBook request (asynchronously)
ApiResponse<FuturesOrderBook>	executeWithHttpInfo() Execute listFuturesOrderBook request with HTTP info returned
FuturesApi.APIlistFuturesOrderBookRequest	interval(String interval) Set interval
FuturesApi.APIlistFuturesOrderBookRequest	limit(Integer limit) Set limit
FuturesApi.APIlistFuturesOrderBookRequest	withId(Boolean withId) Set withId

Methods inherited from class java.lang.Object

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

Method Detail

interval

public FuturesApi.APIlistFuturesOrderBookRequest interval(String interval)

Set interval

Parameters:

interval - Order depth. 0 means no aggregation is applied. default to 0 (optional, default to 0)

Returns:

APIlistFuturesOrderBookRequest

limit

public FuturesApi.APIlistFuturesOrderBookRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of order depth data in asks or bids (optional, default to 10)

Returns:

APIlistFuturesOrderBookRequest

withId

public FuturesApi.APIlistFuturesOrderBookRequest withId(Boolean withId)

Set withId

Parameters:

withId - Whether order book update ID would be returned. This ID increments by 1 on every order book update (optional, default to false)

Returns:

APIlistFuturesOrderBookRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listFuturesOrderBook

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	Order book retrieved	-

execute

public FuturesOrderBook execute()
                         throws ApiException

Execute listFuturesOrderBook request

Returns:

FuturesOrderBook

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	Order book retrieved	-

executeWithHttpInfo

public ApiResponse<FuturesOrderBook> executeWithHttpInfo()
                                                  throws ApiException

Execute listFuturesOrderBook request with HTTP info returned

Returns:

ApiResponse<FuturesOrderBook>

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	Order book retrieved	-

executeAsync

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

Execute listFuturesOrderBook 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	Order book retrieved	-