io.gate.gateapi.api

Class OptionsApi

java.lang.Object

io.gate.gateapi.api.OptionsApi

public class OptionsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OptionsApi.APIlistMyOptionsSettlementsRequest
class	OptionsApi.APIlistMyOptionsTradesRequest
class	OptionsApi.APIlistOptionsAccountBookRequest
class	OptionsApi.APIlistOptionsCandlesticksRequest
class	OptionsApi.APIlistOptionsContractsRequest
class	OptionsApi.APIlistOptionsOrderBookRequest
class	OptionsApi.APIlistOptionsOrdersRequest
class	OptionsApi.APIlistOptionsPositionCloseRequest
class	OptionsApi.APIlistOptionsPositionsRequest
class	OptionsApi.APIlistOptionsSettlementsRequest
class	OptionsApi.APIlistOptionsTradesRequest
class	OptionsApi.APIlistOptionsUnderlyingCandlesticksRequest

Constructor Summary

Constructors

Constructor and Description
OptionsApi()
OptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OptionsOrder	cancelOptionsOrder(Long orderId) Cancel a single order
okhttp3.Call	cancelOptionsOrderAsync(Long orderId, ApiCallback<OptionsOrder> _callback) Cancel a single order (asynchronously)
okhttp3.Call	cancelOptionsOrderCall(Long orderId, ApiCallback _callback) Build call for cancelOptionsOrder
List<OptionsOrder>	cancelOptionsOrders(String contract, String underlying, String side) Cancel all `open` orders matched
okhttp3.Call	cancelOptionsOrdersAsync(String contract, String underlying, String side, ApiCallback<List<OptionsOrder>> _callback) Cancel all `open` orders matched (asynchronously)
okhttp3.Call	cancelOptionsOrdersCall(String contract, String underlying, String side, ApiCallback _callback) Build call for cancelOptionsOrders
ApiResponse<List<OptionsOrder>>	cancelOptionsOrdersWithHttpInfo(String contract, String underlying, String side) Cancel all `open` orders matched
ApiResponse<OptionsOrder>	cancelOptionsOrderWithHttpInfo(Long orderId) Cancel a single order
OptionsOrder	createOptionsOrder(OptionsOrder optionsOrder) Create an options order
okhttp3.Call	createOptionsOrderAsync(OptionsOrder optionsOrder, ApiCallback<OptionsOrder> _callback) Create an options order (asynchronously)
okhttp3.Call	createOptionsOrderCall(OptionsOrder optionsOrder, ApiCallback _callback) Build call for createOptionsOrder
ApiResponse<OptionsOrder>	createOptionsOrderWithHttpInfo(OptionsOrder optionsOrder) Create an options order
ApiClient	getApiClient()
OptionsContract	getOptionsContract(String contract) Query specified contract detail
okhttp3.Call	getOptionsContractAsync(String contract, ApiCallback<OptionsContract> _callback) Query specified contract detail (asynchronously)
okhttp3.Call	getOptionsContractCall(String contract, ApiCallback _callback) Build call for getOptionsContract
ApiResponse<OptionsContract>	getOptionsContractWithHttpInfo(String contract) Query specified contract detail
OptionsOrder	getOptionsOrder(Long orderId) Get a single order
okhttp3.Call	getOptionsOrderAsync(Long orderId, ApiCallback<OptionsOrder> _callback) Get a single order (asynchronously)
okhttp3.Call	getOptionsOrderCall(Long orderId, ApiCallback _callback) Build call for getOptionsOrder
ApiResponse<OptionsOrder>	getOptionsOrderWithHttpInfo(Long orderId) Get a single order
OptionsPosition	getOptionsPosition(String contract) Get specified contract position
okhttp3.Call	getOptionsPositionAsync(String contract, ApiCallback<OptionsPosition> _callback) Get specified contract position (asynchronously)
okhttp3.Call	getOptionsPositionCall(String contract, ApiCallback _callback) Build call for getOptionsPosition
ApiResponse<OptionsPosition>	getOptionsPositionWithHttpInfo(String contract) Get specified contract position
OptionsSettlement	getOptionsSettlement(String contract, String underlying, Long at) Get specified contract's settlement
okhttp3.Call	getOptionsSettlementAsync(String contract, String underlying, Long at, ApiCallback<OptionsSettlement> _callback) Get specified contract's settlement (asynchronously)
okhttp3.Call	getOptionsSettlementCall(String contract, String underlying, Long at, ApiCallback _callback) Build call for getOptionsSettlement
ApiResponse<OptionsSettlement>	getOptionsSettlementWithHttpInfo(String contract, String underlying, Long at) Get specified contract's settlement
OptionsApi.APIlistMyOptionsSettlementsRequest	listMyOptionsSettlements(String underlying) List my options settlements
OptionsApi.APIlistMyOptionsTradesRequest	listMyOptionsTrades(String underlying) List personal trading history
OptionsAccount	listOptionsAccount() List options account
okhttp3.Call	listOptionsAccountAsync(ApiCallback<OptionsAccount> _callback) List options account (asynchronously)
OptionsApi.APIlistOptionsAccountBookRequest	listOptionsAccountBook() List account changing history
okhttp3.Call	listOptionsAccountCall(ApiCallback _callback) Build call for listOptionsAccount
ApiResponse<OptionsAccount>	listOptionsAccountWithHttpInfo() List options account
OptionsApi.APIlistOptionsCandlesticksRequest	listOptionsCandlesticks(String contract) Get options candlesticks
OptionsApi.APIlistOptionsContractsRequest	listOptionsContracts(String underlying) List all the contracts with specified underlying and expiration time
List<Long>	listOptionsExpirations(String underlying) List all expiration times
okhttp3.Call	listOptionsExpirationsAsync(String underlying, ApiCallback<List<Long>> _callback) List all expiration times (asynchronously)
okhttp3.Call	listOptionsExpirationsCall(String underlying, ApiCallback _callback) Build call for listOptionsExpirations
ApiResponse<List<Long>>	listOptionsExpirationsWithHttpInfo(String underlying) List all expiration times
OptionsApi.APIlistOptionsOrderBookRequest	listOptionsOrderBook(String contract) Options order book Bids will be sorted by price from high to low, while asks sorted reversely
OptionsApi.APIlistOptionsOrdersRequest	listOptionsOrders(String status) List options orders
OptionsApi.APIlistOptionsPositionCloseRequest	listOptionsPositionClose(String underlying) List user's liquidation history of specified underlying
OptionsApi.APIlistOptionsPositionsRequest	listOptionsPositions() List user's positions of specified underlying
OptionsApi.APIlistOptionsSettlementsRequest	listOptionsSettlements(String underlying) List settlement history
List<OptionsTicker>	listOptionsTickers(String underlying) List tickers of options contracts
okhttp3.Call	listOptionsTickersAsync(String underlying, ApiCallback<List<OptionsTicker>> _callback) List tickers of options contracts (asynchronously)
okhttp3.Call	listOptionsTickersCall(String underlying, ApiCallback _callback) Build call for listOptionsTickers
ApiResponse<List<OptionsTicker>>	listOptionsTickersWithHttpInfo(String underlying) List tickers of options contracts
OptionsApi.APIlistOptionsTradesRequest	listOptionsTrades() Options trade history
OptionsApi.APIlistOptionsUnderlyingCandlesticksRequest	listOptionsUnderlyingCandlesticks(String underlying) Mark price candlesticks of an underlying
List<OptionsUnderlying>	listOptionsUnderlyings() List all underlyings
okhttp3.Call	listOptionsUnderlyingsAsync(ApiCallback<List<OptionsUnderlying>> _callback) List all underlyings (asynchronously)
okhttp3.Call	listOptionsUnderlyingsCall(ApiCallback _callback) Build call for listOptionsUnderlyings
ApiResponse<List<OptionsUnderlying>>	listOptionsUnderlyingsWithHttpInfo() List all underlyings
OptionsUnderlyingTicker	listOptionsUnderlyingTickers(String underlying) Get underlying ticker
okhttp3.Call	listOptionsUnderlyingTickersAsync(String underlying, ApiCallback<OptionsUnderlyingTicker> _callback) Get underlying ticker (asynchronously)
okhttp3.Call	listOptionsUnderlyingTickersCall(String underlying, ApiCallback _callback) Build call for listOptionsUnderlyingTickers
ApiResponse<OptionsUnderlyingTicker>	listOptionsUnderlyingTickersWithHttpInfo(String underlying) Get underlying ticker
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsApi

public OptionsApi()

OptionsApi

public OptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listOptionsUnderlyingsCall

public okhttp3.Call listOptionsUnderlyingsCall(ApiCallback _callback)
                                        throws ApiException

Build call for listOptionsUnderlyings

Parameters:

_callback - Callback for upload/download progress

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	-

listOptionsUnderlyings

public List<OptionsUnderlying> listOptionsUnderlyings()
                                               throws ApiException

List all underlyings

Returns:

List<OptionsUnderlying>

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	-

listOptionsUnderlyingsWithHttpInfo

public ApiResponse<List<OptionsUnderlying>> listOptionsUnderlyingsWithHttpInfo()
                                                                        throws ApiException

List all underlyings

Returns:

ApiResponse<List<OptionsUnderlying>>

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	-

listOptionsUnderlyingsAsync

public okhttp3.Call listOptionsUnderlyingsAsync(ApiCallback<List<OptionsUnderlying>> _callback)
                                         throws ApiException

List all underlyings (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	-

listOptionsExpirationsCall

public okhttp3.Call listOptionsExpirationsCall(String underlying,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for listOptionsExpirations

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List expiration times of specified underlying	-

listOptionsExpirations

public List<Long> listOptionsExpirations(String underlying)
                                  throws ApiException

List all expiration times

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

List<Long>

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 expiration times of specified underlying	-

listOptionsExpirationsWithHttpInfo

public ApiResponse<List<Long>> listOptionsExpirationsWithHttpInfo(String underlying)
                                                           throws ApiException

List all expiration times

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

ApiResponse<List<Long>>

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 expiration times of specified underlying	-

listOptionsExpirationsAsync

public okhttp3.Call listOptionsExpirationsAsync(String underlying,
                                                ApiCallback<List<Long>> _callback)
                                         throws ApiException

List all expiration times (asynchronously)

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

_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 expiration times of specified underlying	-

listOptionsContracts

public OptionsApi.APIlistOptionsContractsRequest listOptionsContracts(String underlying)

List all the contracts with specified underlying and expiration time

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistOptionsContractsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getOptionsContractCall

public okhttp3.Call getOptionsContractCall(String contract,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getOptionsContract

Parameters:

contract - (required)

_callback - Callback for upload/download progress

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	-

getOptionsContract

public OptionsContract getOptionsContract(String contract)
                                   throws ApiException

Query specified contract detail

Parameters:

contract - (required)

Returns:

OptionsContract

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	-

getOptionsContractWithHttpInfo

public ApiResponse<OptionsContract> getOptionsContractWithHttpInfo(String contract)
                                                            throws ApiException

Query specified contract detail

Parameters:

contract - (required)

Returns:

ApiResponse<OptionsContract>

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	-

getOptionsContractAsync

public okhttp3.Call getOptionsContractAsync(String contract,
                                            ApiCallback<OptionsContract> _callback)
                                     throws ApiException

Query specified contract detail (asynchronously)

Parameters:

contract - (required)

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

listOptionsSettlements

public OptionsApi.APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying)

List settlement history

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistOptionsSettlementsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getOptionsSettlementCall

public okhttp3.Call getOptionsSettlementCall(String contract,
                                             String underlying,
                                             Long at,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getOptionsSettlement

Parameters:

contract - (required)

underlying - Underlying (Obtained by listing underlying endpoint) (required)

at - (required)

_callback - Callback for upload/download progress

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	-

getOptionsSettlement

public OptionsSettlement getOptionsSettlement(String contract,
                                              String underlying,
                                              Long at)
                                       throws ApiException

Get specified contract's settlement

Parameters:

contract - (required)

underlying - Underlying (Obtained by listing underlying endpoint) (required)

at - (required)

Returns:

OptionsSettlement

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	-

getOptionsSettlementWithHttpInfo

public ApiResponse<OptionsSettlement> getOptionsSettlementWithHttpInfo(String contract,
                                                                       String underlying,
                                                                       Long at)
                                                                throws ApiException

Get specified contract's settlement

Parameters:

contract - (required)

underlying - Underlying (Obtained by listing underlying endpoint) (required)

at - (required)

Returns:

ApiResponse<OptionsSettlement>

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	-

getOptionsSettlementAsync

public okhttp3.Call getOptionsSettlementAsync(String contract,
                                              String underlying,
                                              Long at,
                                              ApiCallback<OptionsSettlement> _callback)
                                       throws ApiException

Get specified contract's settlement (asynchronously)

Parameters:

contract - (required)

underlying - Underlying (Obtained by listing underlying endpoint) (required)

at - (required)

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

listMyOptionsSettlements

public OptionsApi.APIlistMyOptionsSettlementsRequest listMyOptionsSettlements(String underlying)

List my options settlements

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistMyOptionsSettlementsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listOptionsOrderBook

public OptionsApi.APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract)

Options order book Bids will be sorted by price from high to low, while asks sorted reversely

Parameters:

contract - Options contract name (required)

Returns:

APIlistOptionsOrderBookRequest

Http Response Details:

Status Code	Description	Response Headers
200	Order book retrieved	-

listOptionsTickersCall

public okhttp3.Call listOptionsTickersCall(String underlying,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for listOptionsTickers

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

_callback - Callback for upload/download progress

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	-

listOptionsTickers

public List<OptionsTicker> listOptionsTickers(String underlying)
                                       throws ApiException

List tickers of options contracts

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

List<OptionsTicker>

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	-

listOptionsTickersWithHttpInfo

public ApiResponse<List<OptionsTicker>> listOptionsTickersWithHttpInfo(String underlying)
                                                                throws ApiException

List tickers of options contracts

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

ApiResponse<List<OptionsTicker>>

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	-

listOptionsTickersAsync

public okhttp3.Call listOptionsTickersAsync(String underlying,
                                            ApiCallback<List<OptionsTicker>> _callback)
                                     throws ApiException

List tickers of options contracts (asynchronously)

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

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

listOptionsUnderlyingTickersCall

public okhttp3.Call listOptionsUnderlyingTickersCall(String underlying,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for listOptionsUnderlyingTickers

Parameters:

underlying - Underlying (required)

_callback - Callback for upload/download progress

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	-

listOptionsUnderlyingTickers

public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying)
                                                     throws ApiException

Get underlying ticker

Parameters:

underlying - Underlying (required)

Returns:

OptionsUnderlyingTicker

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	-

listOptionsUnderlyingTickersWithHttpInfo

public ApiResponse<OptionsUnderlyingTicker> listOptionsUnderlyingTickersWithHttpInfo(String underlying)
                                                                              throws ApiException

Get underlying ticker

Parameters:

underlying - Underlying (required)

Returns:

ApiResponse<OptionsUnderlyingTicker>

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	-

listOptionsUnderlyingTickersAsync

public okhttp3.Call listOptionsUnderlyingTickersAsync(String underlying,
                                                      ApiCallback<OptionsUnderlyingTicker> _callback)
                                               throws ApiException

Get underlying ticker (asynchronously)

Parameters:

underlying - Underlying (required)

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

listOptionsCandlesticks

public OptionsApi.APIlistOptionsCandlesticksRequest listOptionsCandlesticks(String contract)

Get options candlesticks

Parameters:

contract - Options contract name (required)

Returns:

APIlistOptionsCandlesticksRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listOptionsUnderlyingCandlesticks

public OptionsApi.APIlistOptionsUnderlyingCandlesticksRequest listOptionsUnderlyingCandlesticks(String underlying)

Mark price candlesticks of an underlying

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistOptionsUnderlyingCandlesticksRequest

Http Response Details:

Status Code	Description	Response Headers
200	Successfully retrieved	-

listOptionsTrades

public OptionsApi.APIlistOptionsTradesRequest listOptionsTrades()

Options trade history

Returns:

APIlistOptionsTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listOptionsAccountCall

public okhttp3.Call listOptionsAccountCall(ApiCallback _callback)
                                    throws ApiException

Build call for listOptionsAccount

Parameters:

_callback - Callback for upload/download progress

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	-

listOptionsAccount

public OptionsAccount listOptionsAccount()
                                  throws ApiException

List options account

Returns:

OptionsAccount

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	-

listOptionsAccountWithHttpInfo

public ApiResponse<OptionsAccount> listOptionsAccountWithHttpInfo()
                                                           throws ApiException

List options account

Returns:

ApiResponse<OptionsAccount>

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	-

listOptionsAccountAsync

public okhttp3.Call listOptionsAccountAsync(ApiCallback<OptionsAccount> _callback)
                                     throws ApiException

List options account (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	-

listOptionsAccountBook

public OptionsApi.APIlistOptionsAccountBookRequest listOptionsAccountBook()

List account changing history

Returns:

APIlistOptionsAccountBookRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listOptionsPositions

public OptionsApi.APIlistOptionsPositionsRequest listOptionsPositions()

List user's positions of specified underlying

Returns:

APIlistOptionsPositionsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

getOptionsPositionCall

public okhttp3.Call getOptionsPositionCall(String contract,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getOptionsPosition

Parameters:

contract - (required)

_callback - Callback for upload/download progress

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	-

getOptionsPosition

public OptionsPosition getOptionsPosition(String contract)
                                   throws ApiException

Get specified contract position

Parameters:

contract - (required)

Returns:

OptionsPosition

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	-

getOptionsPositionWithHttpInfo

public ApiResponse<OptionsPosition> getOptionsPositionWithHttpInfo(String contract)
                                                            throws ApiException

Get specified contract position

Parameters:

contract - (required)

Returns:

ApiResponse<OptionsPosition>

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	-

getOptionsPositionAsync

public okhttp3.Call getOptionsPositionAsync(String contract,
                                            ApiCallback<OptionsPosition> _callback)
                                     throws ApiException

Get specified contract position (asynchronously)

Parameters:

contract - (required)

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

listOptionsPositionClose

public OptionsApi.APIlistOptionsPositionCloseRequest listOptionsPositionClose(String underlying)

List user's liquidation history of specified underlying

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistOptionsPositionCloseRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listOptionsOrders

public OptionsApi.APIlistOptionsOrdersRequest listOptionsOrders(String status)

List options orders

Parameters:

status - Only list the orders with this status (required)

Returns:

APIlistOptionsOrdersRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createOptionsOrderCall

public okhttp3.Call createOptionsOrderCall(OptionsOrder optionsOrder,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for createOptionsOrder

Parameters:

optionsOrder - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Order detail	-

createOptionsOrder

public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder)
                                throws ApiException

Create an options order

Parameters:

optionsOrder - (required)

Returns:

OptionsOrder

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
201	Order detail	-

createOptionsOrderWithHttpInfo

public ApiResponse<OptionsOrder> createOptionsOrderWithHttpInfo(OptionsOrder optionsOrder)
                                                         throws ApiException

Create an options order

Parameters:

optionsOrder - (required)

Returns:

ApiResponse<OptionsOrder>

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
201	Order detail	-

createOptionsOrderAsync

public okhttp3.Call createOptionsOrderAsync(OptionsOrder optionsOrder,
                                            ApiCallback<OptionsOrder> _callback)
                                     throws ApiException

Create an options order (asynchronously)

Parameters:

optionsOrder - (required)

_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
201	Order detail	-

cancelOptionsOrdersCall

public okhttp3.Call cancelOptionsOrdersCall(String contract,
                                            String underlying,
                                            String side,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for cancelOptionsOrders

Parameters:

contract - Options contract name (optional)

underlying - Underlying (optional)

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	All orders matched cancelled	-

cancelOptionsOrders

public List<OptionsOrder> cancelOptionsOrders(String contract,
                                              String underlying,
                                              String side)
                                       throws ApiException

Cancel all `open` orders matched

Parameters:

contract - Options contract name (optional)

underlying - Underlying (optional)

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

Returns:

List<OptionsOrder>

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	All orders matched cancelled	-

cancelOptionsOrdersWithHttpInfo

public ApiResponse<List<OptionsOrder>> cancelOptionsOrdersWithHttpInfo(String contract,
                                                                       String underlying,
                                                                       String side)
                                                                throws ApiException

Cancel all `open` orders matched

Parameters:

contract - Options contract name (optional)

underlying - Underlying (optional)

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

Returns:

ApiResponse<List<OptionsOrder>>

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	All orders matched cancelled	-

cancelOptionsOrdersAsync

public okhttp3.Call cancelOptionsOrdersAsync(String contract,
                                             String underlying,
                                             String side,
                                             ApiCallback<List<OptionsOrder>> _callback)
                                      throws ApiException

Cancel all `open` orders matched (asynchronously)

Parameters:

contract - Options contract name (optional)

underlying - Underlying (optional)

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

_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	All orders matched cancelled	-

getOptionsOrderCall

public okhttp3.Call getOptionsOrderCall(Long orderId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getOptionsOrder

Parameters:

orderId - Order ID returned on successful order creation (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Order detail	-

getOptionsOrder

public OptionsOrder getOptionsOrder(Long orderId)
                             throws ApiException

Get a single order

Parameters:

orderId - Order ID returned on successful order creation (required)

Returns:

OptionsOrder

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

getOptionsOrderWithHttpInfo

public ApiResponse<OptionsOrder> getOptionsOrderWithHttpInfo(Long orderId)
                                                      throws ApiException

Get a single order

Parameters:

orderId - Order ID returned on successful order creation (required)

Returns:

ApiResponse<OptionsOrder>

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

getOptionsOrderAsync

public okhttp3.Call getOptionsOrderAsync(Long orderId,
                                         ApiCallback<OptionsOrder> _callback)
                                  throws ApiException

Get a single order (asynchronously)

Parameters:

orderId - Order ID returned on successful order creation (required)

_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 detail	-

cancelOptionsOrderCall

public okhttp3.Call cancelOptionsOrderCall(Long orderId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for cancelOptionsOrder

Parameters:

orderId - Order ID returned on successful order creation (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Order detail	-

cancelOptionsOrder

public OptionsOrder cancelOptionsOrder(Long orderId)
                                throws ApiException

Cancel a single order

Parameters:

orderId - Order ID returned on successful order creation (required)

Returns:

OptionsOrder

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

cancelOptionsOrderWithHttpInfo

public ApiResponse<OptionsOrder> cancelOptionsOrderWithHttpInfo(Long orderId)
                                                         throws ApiException

Cancel a single order

Parameters:

orderId - Order ID returned on successful order creation (required)

Returns:

ApiResponse<OptionsOrder>

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

cancelOptionsOrderAsync

public okhttp3.Call cancelOptionsOrderAsync(Long orderId,
                                            ApiCallback<OptionsOrder> _callback)
                                     throws ApiException

Cancel a single order (asynchronously)

Parameters:

orderId - Order ID returned on successful order creation (required)

_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 detail	-

listMyOptionsTrades

public OptionsApi.APIlistMyOptionsTradesRequest listMyOptionsTrades(String underlying)

List personal trading history

Parameters:

underlying - Underlying (Obtained by listing underlying endpoint) (required)

Returns:

APIlistMyOptionsTradesRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-