# coding: utf-8

"""

Gate API v4

Welcome to Gate.io API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. # noqa: E501

Contact: support@mail.gate.io

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 ApiTypeError, ApiValueError # noqa: F401

class FuturesApi(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_futures_contracts(self, settle, **kwargs): # noqa: E501

"""List all futures contracts # 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_futures_contracts(settle, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

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

:param int offset: List offset, starting from 0

: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.Contract]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_futures_contracts_with_http_info(settle, **kwargs) # noqa: E501

def list_futures_contracts_with_http_info(self, settle, **kwargs): # noqa: E501

"""List all futures contracts # 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_futures_contracts_with_http_info(settle, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

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

:param int offset: List offset, starting from 0

: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.Contract], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', 'limit', 'offset']

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_futures_contracts" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_contracts`"

) # 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_futures_contracts`, 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_futures_contracts`, 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_futures_contracts`, must be a value greater than or equal to `0`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

query_params = []

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

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(

'/futures/{settle}/contracts',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[Contract]', # 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_futures_contract(self, settle, contract, **kwargs): # noqa: E501

"""Get a single contract # 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_futures_contract(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures 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.Contract

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

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

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

"""Get a single contract # 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_futures_contract_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures 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.Contract, status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', '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_futures_contract" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `get_futures_contract`"

) # noqa: E501

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and (

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

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `contract` when calling `get_futures_contract`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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(

'/futures/{settle}/contracts/{contract}',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='Contract', # 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_futures_order_book(self, settle, contract, **kwargs): # noqa: E501

"""Futures 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_futures_order_book(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param str interval: Order depth. 0 means no aggregation is applied. default to 0

:param int limit: Maximum number of order depth data in asks or bids

:param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update

: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_futures_order_book_with_http_info(settle, contract, **kwargs) # noqa: E501

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

"""Futures 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_futures_order_book_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param str interval: Order depth. 0 means no aggregation is applied. default to 0

:param int limit: Maximum number of order depth data in asks or bids

:param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update

: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 = ['settle', '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_futures_order_book" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_order_book`"

) # noqa: E501

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and (

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

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `contract` when calling `list_futures_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_futures_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_futures_order_book`, must be a value greater than or equal to `1`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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 = []

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(

'/futures/{settle}/order_book',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='FuturesOrderBook', # 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_futures_trades(self, settle, contract, **kwargs): # noqa: E501

"""Futures trading 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_futures_trades(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

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

:param int offset: List offset, starting from 0

:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range

:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.

:param int to: Specify end time in Unix seconds, default to current time

: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.FuturesTrade]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

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

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

"""Futures trading 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_futures_trades_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

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

:param int offset: List offset, starting from 0

:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range

:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.

:param int to: Specify end time in Unix seconds, default to current time

: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.FuturesTrade], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', 'contract', 'limit', 'offset', 'last_id', '_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_futures_trades" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_trades`"

) # noqa: E501

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and (

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

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `contract` when calling `list_futures_trades`"

) # 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_futures_trades`, 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_futures_trades`, 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_futures_trades`, must be a value greater than or equal to `0`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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 '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 'last_id' in local_var_params and local_var_params['last_id'] is not None: # noqa: E501

query_params.append(('last_id', local_var_params['last_id'])) # 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(

'/futures/{settle}/trades',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[FuturesTrade]', # 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_futures_candlesticks(self, settle, contract, **kwargs): # noqa: E501

"""Get futures candlesticks # noqa: E501

Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # 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_futures_candlesticks(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified

:param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time

:param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.

:param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days

: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.FuturesCandlestick]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

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

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

"""Get futures candlesticks # noqa: E501

Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # 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_futures_candlesticks_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified

:param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time

:param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.

:param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days

: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.FuturesCandlestick], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', 'contract', '_from', 'to', 'limit', 'interval']

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_futures_candlesticks" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_candlesticks`"

) # noqa: E501

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and (

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

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `contract` when calling `list_futures_candlesticks`"

) # noqa: E501

if (

self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 2000

): # noqa: E501

raise ApiValueError(

"Invalid value for parameter `limit` when calling `list_futures_candlesticks`, must be a value less than or equal to `2000`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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

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

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(

'/futures/{settle}/candlesticks',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[FuturesCandlestick]', # 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_futures_premium_index(self, settle, contract, **kwargs): # noqa: E501

"""Premium Index K-Line # noqa: E501

Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # 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_futures_premium_index(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified

:param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time

:param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.

:param str interval: Interval time between data points

: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.FuturesPremiumIndex]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

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

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

"""Premium Index K-Line # noqa: E501

Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # 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_futures_premium_index_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified

:param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time

:param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.

:param str interval: Interval time between data points

: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.FuturesPremiumIndex], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', 'contract', '_from', 'to', 'limit', 'interval']

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_futures_premium_index" % k

)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_premium_index`"

) # noqa: E501

# verify the required parameter 'contract' is set

if self.api_client.client_side_validation and (

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

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `contract` when calling `list_futures_premium_index`"

) # noqa: E501

if (

self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 2000

): # noqa: E501

raise ApiValueError(

"Invalid value for parameter `limit` when calling `list_futures_premium_index`, must be a value less than or equal to `2000`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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

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

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(

'/futures/{settle}/premium_index',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[FuturesPremiumIndex]', # 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_futures_tickers(self, settle, **kwargs): # noqa: E501

"""List futures tickers # 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_futures_tickers(settle, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract, return related data only if specified

: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.FuturesTicker]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

return self.list_futures_tickers_with_http_info(settle, **kwargs) # noqa: E501

def list_futures_tickers_with_http_info(self, settle, **kwargs): # noqa: E501

"""List futures tickers # 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_futures_tickers_with_http_info(settle, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract, return related data only if specified

: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.FuturesTicker], status_code(int), headers(HTTPHeaderDict))

:return: If the method is called asynchronously,

returns the request thread.

"""

local_var_params = locals()

all_params = ['settle', '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 list_futures_tickers" % k)

local_var_params[k] = v

del local_var_params['kwargs']

# verify the required parameter 'settle' is set

if self.api_client.client_side_validation and (

'settle' not in local_var_params or local_var_params['settle'] is None # noqa: E501

): # noqa: E501

raise ApiValueError(

"Missing the required parameter `settle` when calling `list_futures_tickers`"

) # noqa: E501

collection_formats = {}

path_params = {}

if 'settle' in local_var_params:

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

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

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(

'/futures/{settle}/tickers',

'GET',

path_params,

query_params,

header_params,

body=body_params,

post_params=form_params,

files=local_var_files,

response_type='list[FuturesTicker]', # 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_futures_funding_rate_history(self, settle, contract, **kwargs): # noqa: E501

"""Funding rate 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_futures_funding_rate_history(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

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

: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.FundingRateRecord]

:return: If the method is called asynchronously,

returns the request thread.

"""

kwargs['_return_http_data_only'] = True

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

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

"""Funding rate 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_futures_funding_rate_history_with_http_info(settle, contract, async_req=True)

>>> result = thread.get()

:param bool async_req: execute request asynchronously

:param str settle: Settle currency (required)

:param str contract: Futures contract (required)

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