io.gate.gateapi.api

Class DeliveryApi.APIlistDeliveryOrderBookRequest

java.lang.Object

io.gate.gateapi.api.DeliveryApi.APIlistDeliveryOrderBookRequest

Enclosing class:

DeliveryApi

public class DeliveryApi.APIlistDeliveryOrderBookRequest
extends Object

Method Summary

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

Set interval

Parameters:

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

Returns:

APIlistDeliveryOrderBookRequest

limit

public DeliveryApi.APIlistDeliveryOrderBookRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistDeliveryOrderBookRequest

withId

public DeliveryApi.APIlistDeliveryOrderBookRequest withId(Boolean withId)

Set withId

Parameters:

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

Returns:

APIlistDeliveryOrderBookRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listDeliveryOrderBook

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 listDeliveryOrderBook 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 listDeliveryOrderBook 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 listDeliveryOrderBook 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	-