io.gate.gateapi.api

Class OptionsApi.APIlistOptionsTradesRequest

java.lang.Object

io.gate.gateapi.api.OptionsApi.APIlistOptionsTradesRequest

Enclosing class:

OptionsApi

public class OptionsApi.APIlistOptionsTradesRequest
extends Object

Method Summary

Modifier and Type	Method and Description
okhttp3.Call	buildCall(ApiCallback _callback) Build call for listOptionsTrades
OptionsApi.APIlistOptionsTradesRequest	contract(String contract) Set contract
List<FuturesTrade>	execute() Execute listOptionsTrades request
okhttp3.Call	executeAsync(ApiCallback<List<FuturesTrade>> _callback) Execute listOptionsTrades request (asynchronously)
ApiResponse<List<FuturesTrade>>	executeWithHttpInfo() Execute listOptionsTrades request with HTTP info returned
OptionsApi.APIlistOptionsTradesRequest	from(Long from) Set from
OptionsApi.APIlistOptionsTradesRequest	limit(Integer limit) Set limit
OptionsApi.APIlistOptionsTradesRequest	offset(Integer offset) Set offset
OptionsApi.APIlistOptionsTradesRequest	to(Long to) Set to
OptionsApi.APIlistOptionsTradesRequest	type(String type) Set type

Methods inherited from class java.lang.Object

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

Method Detail

contract

public OptionsApi.APIlistOptionsTradesRequest contract(String contract)

Set contract

Parameters:

contract - Options contract name (optional)

Returns:

APIlistOptionsTradesRequest

type

public OptionsApi.APIlistOptionsTradesRequest type(String type)

Set type

Parameters:

type - `C` is call, while `P` is put (optional)

Returns:

APIlistOptionsTradesRequest

limit

public OptionsApi.APIlistOptionsTradesRequest limit(Integer limit)

Set limit

Parameters:

limit - Maximum number of records to be returned in a single list (optional, default to 100)

Returns:

APIlistOptionsTradesRequest

offset

public OptionsApi.APIlistOptionsTradesRequest offset(Integer offset)

Set offset

Parameters:

offset - List offset, starting from 0 (optional, default to 0)

Returns:

APIlistOptionsTradesRequest

from

public OptionsApi.APIlistOptionsTradesRequest from(Long from)

Set from

Parameters:

from - Start timestamp (optional)

Returns:

APIlistOptionsTradesRequest

to

public OptionsApi.APIlistOptionsTradesRequest to(Long to)

Set to

Parameters:

to - End timestamp (optional)

Returns:

APIlistOptionsTradesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listOptionsTrades

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

Execute listOptionsTrades request

Returns:

List<FuturesTrade>

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

Execute listOptionsTrades request with HTTP info returned

Returns:

ApiResponse<List<FuturesTrade>>

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

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