io.gate.gateapi.api

Class SpotApi.APIlistOrderBookRequest

java.lang.Object

io.gate.gateapi.api.SpotApi.APIlistOrderBookRequest

Enclosing class:

SpotApi

public class SpotApi.APIlistOrderBookRequest
extends Object

Method Summary

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

Set interval

Parameters:

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

Returns:

APIlistOrderBookRequest

limit

public SpotApi.APIlistOrderBookRequest limit(Integer limit)

Set limit

Parameters:

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

Returns:

APIlistOrderBookRequest

withId

public SpotApi.APIlistOrderBookRequest withId(Boolean withId)

Set withId

Parameters:

withId - Return order book ID (optional, default to false)

Returns:

APIlistOrderBookRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOrderBook

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

Execute listOrderBook request

Returns:

OrderBook

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

Execute listOrderBook request with HTTP info returned

Returns:

ApiResponse<OrderBook>

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

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