io.gate.gateapi.api

Class SpotApi.APIlistOrdersRequest

java.lang.Object

io.gate.gateapi.api.SpotApi.APIlistOrdersRequest

Enclosing class:

SpotApi

public class SpotApi.APIlistOrdersRequest
extends Object

Method Summary

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

page

public SpotApi.APIlistOrdersRequest page(Integer page)

Set page

Parameters:

page - Page number (optional, default to 1)

Returns:

APIlistOrdersRequest

limit

public SpotApi.APIlistOrdersRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100 (optional, default to 100)

Returns:

APIlistOrdersRequest

account

public SpotApi.APIlistOrdersRequest account(String account)

Set account

Parameters:

account - Specify operation account. Default to spot and margin account if not specified. Set to `cross_margin` to operate against margin account (optional)

Returns:

APIlistOrdersRequest

from

public SpotApi.APIlistOrdersRequest from(Long from)

Set from

Parameters:

from - Start timestamp of the query (optional)

Returns:

APIlistOrdersRequest

to

public SpotApi.APIlistOrdersRequest to(Long to)

Set to

Parameters:

to - Time range ending, default to current time (optional)

Returns:

APIlistOrdersRequest

side

public SpotApi.APIlistOrdersRequest side(String side)

Set side

Parameters:

side - All bids or asks. Both included if not specified (optional)

Returns:

APIlistOrdersRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOrders

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	List retrieved	-

execute

public List<Order> execute()
                    throws ApiException

Execute listOrders request

Returns:

List<Order>

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	List retrieved	-

executeWithHttpInfo

public ApiResponse<List<Order>> executeWithHttpInfo()
                                             throws ApiException

Execute listOrders request with HTTP info returned

Returns:

ApiResponse<List<Order>>

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	List retrieved	-

executeAsync

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

Execute listOrders 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	List retrieved	-