# coding: utf-8

"""

Gate API

Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501

Contact: support@mail.gate.com

Generated by: https://openapi-generator.tech

"""

from __future__ import absolute_import

import re # noqa: F401

# python 2 and python 3 compatibility library

import six

from gate_api.api_client import ApiClient

from gate_api.exceptions import ( # noqa: F401

ApiTypeError,

ApiValueError

)

class OptionsApi(object):

"""NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech

Do not edit the class manually.

"""

def __init__(self, api_client=None):

if api_client is None:

api_client = ApiClient()

self.api_client = api_client

def list_options_underlyings(self, **kwargs): # noqa: E501

"""List all underlying assets # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_underlyings(async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: list[gate_api.OptionsUnderlying]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_options_underlyings_with_http_info(**kwargs) # noqa: E501

def list_options_underlyings_with_http_info(self, **kwargs): # noqa: E501

"""List all underlying assets # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_underlyings_with_http_info(async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(list[gate_api.OptionsUnderlying], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_options_underlyings" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

collection_formats = {}

path_params = {}

query_params = []

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/underlyings', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[OptionsUnderlying]', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def list_options_expirations(self, underlying, **kwargs): # noqa: E501

"""List all expiration dates # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_expirations(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: list[int]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_options_expirations_with_http_info(underlying, **kwargs) # noqa: E501

def list_options_expirations_with_http_info(self, underlying, **kwargs): # noqa: E501

"""List all expiration dates # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_expirations_with_http_info(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(list[int], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'underlying'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_options_expirations" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'underlying' is set

if self.api_client.client_side_validation and ('underlying' not in local_var_params or # noqa: E501

local_var_params['underlying'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `underlying` when calling `list_options_expirations`") # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

if 'underlying' in local_var_params and local_var_params['underlying'] is not None: # noqa: E501

query_params.append(('underlying', local_var_params['underlying'])) # noqa: E501

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/expirations', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[int]', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def list_options_contracts(self, underlying, **kwargs): # noqa: E501

"""List all contracts for specified underlying and expiration date # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_contracts(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int expiration: Unix timestamp of expiration date

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: list[gate_api.OptionsContract]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_options_contracts_with_http_info(underlying, **kwargs) # noqa: E501

def list_options_contracts_with_http_info(self, underlying, **kwargs): # noqa: E501

"""List all contracts for specified underlying and expiration date # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_contracts_with_http_info(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int expiration: Unix timestamp of expiration date

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(list[gate_api.OptionsContract], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'underlying',

'expiration'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_options_contracts" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'underlying' is set

if self.api_client.client_side_validation and ('underlying' not in local_var_params or # noqa: E501

local_var_params['underlying'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `underlying` when calling `list_options_contracts`") # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

if 'underlying' in local_var_params and local_var_params['underlying'] is not None: # noqa: E501

query_params.append(('underlying', local_var_params['underlying'])) # noqa: E501

if 'expiration' in local_var_params and local_var_params['expiration'] is not None: # noqa: E501

query_params.append(('expiration', local_var_params['expiration'])) # noqa: E501

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/contracts', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[OptionsContract]', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def get_options_contract(self, contract, **kwargs): # noqa: E501

"""Query specified contract details # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_options_contract(contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: (required)

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: gate_api.OptionsContract

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.get_options_contract_with_http_info(contract, **kwargs) # noqa: E501

def get_options_contract_with_http_info(self, contract, **kwargs): # noqa: E501

"""Query specified contract details # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_options_contract_with_http_info(contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: (required)

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(gate_api.OptionsContract, status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'contract'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method get_options_contract" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and ('contract' not in local_var_params or # noqa: E501

local_var_params['contract'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `contract` when calling `get_options_contract`") # noqa: E501

collection_formats = {}

path_params = {}

if 'contract' in local_var_params:

path_params['contract'] = local_var_params['contract'] # noqa: E501

query_params = []

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/contracts/{contract}', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='OptionsContract', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def list_options_settlements(self, underlying, **kwargs): # noqa: E501

"""List settlement history # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_settlements(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int limit: Maximum number of records returned in a single list

:param int offset: List offset, starting from 0

:param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)

:param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: list[gate_api.OptionsSettlement]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_options_settlements_with_http_info(underlying, **kwargs) # noqa: E501

def list_options_settlements_with_http_info(self, underlying, **kwargs): # noqa: E501

"""List settlement history # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_settlements_with_http_info(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int limit: Maximum number of records returned in a single list

:param int offset: List offset, starting from 0

:param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)

:param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(list[gate_api.OptionsSettlement], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'underlying',

'limit',

'offset',

'_from',

'to'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_options_settlements" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'underlying' is set

if self.api_client.client_side_validation and ('underlying' not in local_var_params or # noqa: E501

local_var_params['underlying'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `underlying` when calling `list_options_settlements`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_options_settlements`, must be a value less than or equal to `1000`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_options_settlements`, must be a value greater than or equal to `1`") # noqa: E501

if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501

raise ApiValueError("Invalid value for parameter `offset` when calling `list_options_settlements`, must be a value greater than or equal to `0`") # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

if 'underlying' in local_var_params and local_var_params['underlying'] is not None: # noqa: E501

query_params.append(('underlying', local_var_params['underlying'])) # noqa: E501

if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501

query_params.append(('limit', local_var_params['limit'])) # noqa: E501

if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501

query_params.append(('offset', local_var_params['offset'])) # noqa: E501

if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501

query_params.append(('from', local_var_params['_from'])) # noqa: E501

if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501

query_params.append(('to', local_var_params['to'])) # noqa: E501

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/settlements', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[OptionsSettlement]', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def get_options_settlement(self, contract, underlying, at, **kwargs): # noqa: E501

"""Get specified contract settlement information # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_options_settlement(contract, underlying, at, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: (required)

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int at: (required)

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: gate_api.OptionsSettlement

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.get_options_settlement_with_http_info(contract, underlying, at, **kwargs) # noqa: E501

def get_options_settlement_with_http_info(self, contract, underlying, at, **kwargs): # noqa: E501

"""Get specified contract settlement information # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_options_settlement_with_http_info(contract, underlying, at, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: (required)

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param int at: (required)

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(gate_api.OptionsSettlement, status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'contract',

'underlying',

'at'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method get_options_settlement" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and ('contract' not in local_var_params or # noqa: E501

local_var_params['contract'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `contract` when calling `get_options_settlement`") # noqa: E501

# verify the required parameter 'underlying' is set

if self.api_client.client_side_validation and ('underlying' not in local_var_params or # noqa: E501

local_var_params['underlying'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `underlying` when calling `get_options_settlement`") # noqa: E501

# verify the required parameter 'at' is set

if self.api_client.client_side_validation and ('at' not in local_var_params or # noqa: E501

local_var_params['at'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `at` when calling `get_options_settlement`") # noqa: E501

collection_formats = {}

path_params = {}

if 'contract' in local_var_params:

path_params['contract'] = local_var_params['contract'] # noqa: E501

query_params = []

if 'underlying' in local_var_params and local_var_params['underlying'] is not None: # noqa: E501

query_params.append(('underlying', local_var_params['underlying'])) # noqa: E501

if 'at' in local_var_params and local_var_params['at'] is not None: # noqa: E501

query_params.append(('at', local_var_params['at'])) # noqa: E501

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = [] # noqa: E501

return self.api_client.call_api(

'/options/settlements/{contract}', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='OptionsSettlement', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def list_my_options_settlements(self, underlying, **kwargs): # noqa: E501

"""Query personal settlement records # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_my_options_settlements(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param str contract: Options contract name

:param int limit: Maximum number of records returned in a single list

:param int offset: List offset, starting from 0

:param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)

:param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: list[gate_api.OptionsMySettlements]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_my_options_settlements_with_http_info(underlying, **kwargs) # noqa: E501

def list_my_options_settlements_with_http_info(self, underlying, **kwargs): # noqa: E501

"""Query personal settlement records # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_my_options_settlements_with_http_info(underlying, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)

:param str contract: Options contract name

:param int limit: Maximum number of records returned in a single list

:param int offset: List offset, starting from 0

:param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)

:param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(list[gate_api.OptionsMySettlements], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'underlying',

'contract',

'limit',

'offset',

'_from',

'to'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_my_options_settlements" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'underlying' is set

if self.api_client.client_side_validation and ('underlying' not in local_var_params or # noqa: E501

local_var_params['underlying'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `underlying` when calling `list_my_options_settlements`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_my_options_settlements`, must be a value less than or equal to `1000`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_my_options_settlements`, must be a value greater than or equal to `1`") # noqa: E501

if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501

raise ApiValueError("Invalid value for parameter `offset` when calling `list_my_options_settlements`, must be a value greater than or equal to `0`") # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

if 'underlying' in local_var_params and local_var_params['underlying'] is not None: # noqa: E501

query_params.append(('underlying', local_var_params['underlying'])) # noqa: E501

if 'contract' in local_var_params and local_var_params['contract'] is not None: # noqa: E501

query_params.append(('contract', local_var_params['contract'])) # noqa: E501

if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501

query_params.append(('limit', local_var_params['limit'])) # noqa: E501

if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501

query_params.append(('offset', local_var_params['offset'])) # noqa: E501

if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501

query_params.append(('from', local_var_params['_from'])) # noqa: E501

if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501

query_params.append(('to', local_var_params['to'])) # noqa: E501

header_params = {}

form_params = []

local_var_files = {}

body_params = None

# HTTP header `Accept`

header_params['Accept'] = self.api_client.select_header_accept(

['application/json']) # noqa: E501

# Authentication setting

auth_settings = ['apiv4'] # noqa: E501

return self.api_client.call_api(

'/options/my_settlements', 'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[OptionsMySettlements]', # noqa: E501

auth_settings=auth_settings,

async_req=local_var_params.get('async_req'),

_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501

_preload_content=local_var_params.get('_preload_content', True),

_request_timeout=local_var_params.get('_request_timeout'),

collection_formats=collection_formats)

def list_options_order_book(self, contract, **kwargs): # noqa: E501

"""Query options contract order book # noqa: E501

Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_order_book(contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: Options contract name (required)

:param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified

:param int limit: Number of depth levels

:param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: gate_api.FuturesOrderBook

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_options_order_book_with_http_info(contract, **kwargs) # noqa: E501

def list_options_order_book_with_http_info(self, contract, **kwargs): # noqa: E501

"""Query options contract order book # noqa: E501

Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501

This method makes a synchronous HTTP request by default. To make an

asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_options_order_book_with_http_info(contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str contract: Options contract name (required)

:param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified

:param int limit: Number of depth levels

:param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes

:param _return_http_data_only: response data without head status code

and headers

:param _preload_content: if False, the urllib3.HTTPResponse object will

be returned without reading/decoding response

data. Default is True.

:param _request_timeout: timeout setting for this request. If one

number provided, it will be total request

timeout. It can also be a pair (tuple) of

(connection, read) timeouts.

:rtype: tuple(gate_api.FuturesOrderBook, status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = [

'contract',

'interval',

'limit',

'with_id'

]

all_params.extend(

[

'async_req',

'_return_http_data_only',

'_preload_content',

'_request_timeout'

]

)

for k, v in six.iteritems(local_var_params['kwargs']):

if k not in all_params:

raise ApiTypeError(

"Got an unexpected keyword argument '%s'"

" to method list_options_order_book" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and ('contract' not in local_var_params or # noqa: E501

local_var_params['contract'] is None): # noqa: E501

raise ApiValueError("Missing the required parameter `contract` when calling `list_options_order_book`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 50: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_options_order_book`, must be a value less than or equal to `50`") # noqa: E501

if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501

raise ApiValueError("Invalid value for parameter `limit` when calling `list_options_order_book`, must be a value greater than or equal to `1`") # noqa: E501

collection_formats = {}

path_params = {}

query_params = []

if 'contract' in local_var_params and local_var_params['contract'] is not None: # noqa: E501

query_params.append(('contract', local_var_params['contract'])) # noqa: E501

if 'interval' in local_var_params and local_var_params['interval'] is not None: # noqa: E501

query_params.append(('interval', local_var_params['interval'])) # noqa: E501

if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501

query_params.append(('limit', local_var_params['limit'])) # noqa: E501

if 'with_id' in local_var_params and local_var_params['with_id'] is not None: # noqa: E501

query_params.append(('with_id', local_var_params['with_id'])) # noqa: E501

header_params = {}

form_params = []