gate_api.FuturesApi

All URIs are relative to https://api.gateio.ws/api/v4

Method	HTTP request	Description
cancel_futures_order	DELETE /futures/{settle}/orders/{order_id}	Cancel a single order
cancel_futures_orders	DELETE /futures/{settle}/orders	Cancel all `open` orders matched
cancel_price_triggered_order	DELETE /futures/{settle}/price_orders/{order_id}	Cancel a single order
cancel_price_triggered_order_list	DELETE /futures/{settle}/price_orders	Cancel all open orders
create_futures_order	POST /futures/{settle}/orders	Create a futures order
create_price_triggered_order	POST /futures/{settle}/price_orders	Create a price-triggered order
get_futures_contract	GET /futures/{settle}/contracts/{contract}	Get a single contract
get_futures_order	GET /futures/{settle}/orders/{order_id}	Get a single order
get_my_trades	GET /futures/{settle}/my_trades	List personal trading history
get_position	GET /futures/{settle}/positions/{contract}	Get single position
get_price_triggered_order	GET /futures/{settle}/price_orders/{order_id}	Get a single order
list_futures_account_book	GET /futures/{settle}/account_book	Query account book
list_futures_accounts	GET /futures/{settle}/accounts	Query futures account
list_futures_candlesticks	GET /futures/{settle}/candlesticks	Get futures candlesticks
list_futures_contracts	GET /futures/{settle}/contracts	List all futures contracts
list_futures_funding_rate_history	GET /futures/{settle}/funding_rate	Funding rate history
list_futures_insurance_ledger	GET /futures/{settle}/insurance	Futures insurance balance history
list_futures_order_book	GET /futures/{settle}/order_book	Futures order book
list_futures_orders	GET /futures/{settle}/orders	List futures orders
list_futures_tickers	GET /futures/{settle}/tickers	List futures tickers
list_futures_trades	GET /futures/{settle}/trades	Futures trading history
list_liquidates	GET /futures/{settle}/liquidates	List liquidation history
list_position_close	GET /futures/{settle}/position_close	List position close history
list_positions	GET /futures/{settle}/positions	List all positions of a user
list_price_triggered_orders	GET /futures/{settle}/price_orders	List all auto orders
update_position_leverage	POST /futures/{settle}/positions/{contract}/leverage	Update position leverage
update_position_margin	POST /futures/{settle}/positions/{contract}/margin	Update position margin
update_position_risk_limit	POST /futures/{settle}/positions/{contract}/risk_limit	Update position risk limit

cancel_futures_order

FuturesOrder cancel_futures_order(settle, order_id)

Cancel a single order

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
order_id = '12345' # str | ID returned on order successfully being created

try:
    # Cancel a single order
    api_response = api_instance.cancel_futures_order(settle, order_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->cancel_futures_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
order_id	str	ID returned on order successfully being created

Return type

FuturesOrder

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_futures_orders

list[FuturesOrder] cancel_futures_orders(settle, contract, side=side)

Cancel all open orders matched

Zero-fill order cannot be retrieved 60 seconds after cancellation

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
side = 'ask' # str | All bids or asks. Both included in not specified (optional)

try:
    # Cancel all `open` orders matched
    api_response = api_instance.cancel_futures_orders(settle, contract, side=side)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->cancel_futures_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
side	str	All bids or asks. Both included in not specified	[optional]

Return type

list[FuturesOrder]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_price_triggered_order

FuturesPriceTriggeredOrder cancel_price_triggered_order(settle, order_id)

Cancel a single order

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
order_id = 'order_id_example' # str | ID returned on order successfully being created

try:
    # Cancel a single order
    api_response = api_instance.cancel_price_triggered_order(settle, order_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->cancel_price_triggered_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
order_id	str	ID returned on order successfully being created

Return type

FuturesPriceTriggeredOrder

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_price_triggered_order_list

list[FuturesPriceTriggeredOrder] cancel_price_triggered_order_list(settle, contract)

Cancel all open orders

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract

try:
    # Cancel all open orders
    api_response = api_instance.cancel_price_triggered_order_list(settle, contract)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->cancel_price_triggered_order_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract

Return type

list[FuturesPriceTriggeredOrder]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_futures_order

FuturesOrder create_futures_order(settle, futures_order)

Create a futures order

Zero-fill order cannot be retrieved 60 seconds after cancellation

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
futures_order = gate_api.FuturesOrder() # FuturesOrder | 

try:
    # Create a futures order
    api_response = api_instance.create_futures_order(settle, futures_order)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->create_futures_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
futures_order	FuturesOrder

Return type

FuturesOrder

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_price_triggered_order

TriggerOrderResponse create_price_triggered_order(settle, futures_price_triggered_order)

Create a price-triggered order

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
futures_price_triggered_order = gate_api.FuturesPriceTriggeredOrder() # FuturesPriceTriggeredOrder | 

try:
    # Create a price-triggered order
    api_response = api_instance.create_price_triggered_order(settle, futures_price_triggered_order)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->create_price_triggered_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
futures_price_triggered_order	FuturesPriceTriggeredOrder

Return type

TriggerOrderResponse

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_futures_contract

Contract get_futures_contract(settle, contract)

Get a single contract

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract

try:
    # Get a single contract
    api_response = api_instance.get_futures_contract(settle, contract)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->get_futures_contract: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract

Return type

Contract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_futures_order

FuturesOrder get_futures_order(settle, order_id)

Get a single order

Zero-fill order cannot be retrieved 60 seconds after cancellation

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
order_id = '12345' # str | ID returned on order successfully being created

try:
    # Get a single order
    api_response = api_instance.get_futures_order(settle, order_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->get_futures_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
order_id	str	ID returned on order successfully being created

Return type

FuturesOrder

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_my_trades

list[MyFuturesTrade] get_my_trades(settle, contract=contract, order=order, limit=limit, last_id=last_id)

List personal trading history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract, return related data only if specified (optional)
order = 12345 # int | Futures order ID, return related data only if specified (optional)
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)

try:
    # List personal trading history
    api_response = api_instance.get_my_trades(settle, contract=contract, order=order, limit=limit, last_id=last_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->get_my_trades: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract, return related data only if specified	[optional]
order	int	Futures order ID, return related data only if specified	[optional]
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
last_id	str	Specify list staring point using the `id` of last record in previous list-query results	[optional]

Return type

list[MyFuturesTrade]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_position

Position get_position(settle, contract)

Get single position

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract

try:
    # Get single position
    api_response = api_instance.get_position(settle, contract)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->get_position: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract

Return type

Position

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_price_triggered_order

FuturesPriceTriggeredOrder get_price_triggered_order(settle, order_id)

Get a single order

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
order_id = 'order_id_example' # str | ID returned on order successfully being created

try:
    # Get a single order
    api_response = api_instance.get_price_triggered_order(settle, order_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->get_price_triggered_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
order_id	str	ID returned on order successfully being created

Return type

FuturesPriceTriggeredOrder

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_account_book

list[FuturesAccountBook] list_futures_account_book(settle, limit=limit, _from=_from, to=to, type=type)

Query account book

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
_from = 1547706332 # int | Start timestamp (optional)
to = 1547706332 # int | End timestamp (optional)
type = 'dnw' # str | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate (optional)

try:
    # Query account book
    api_response = api_instance.list_futures_account_book(settle, limit=limit, _from=_from, to=to, type=type)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_account_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
_from	int	Start timestamp	[optional]
to	int	End timestamp	[optional]
type	str	Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate	[optional]

Return type

list[FuturesAccountBook]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_accounts

FuturesAccount list_futures_accounts(settle)

Query futures account

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')

try:
    # Query futures account
    api_response = api_instance.list_futures_accounts(settle)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']

Return type

FuturesAccount

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_candlesticks

list[FuturesCandlestick] list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)

Get futures candlesticks

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

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
_from = 1546905600 # float | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
to = 1546935600 # float | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
limit = 100 # int | Maximum recent data points returned. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
interval = '5m' # str | Interval time between data points (optional) (default to '5m')

try:
    # Get futures candlesticks
    api_response = api_instance.list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_candlesticks: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
_from	float	Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified	[optional]
to	float	End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time	[optional]
limit	int	Maximum recent data points returned. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.	[optional] [default to 100]
interval	str	Interval time between data points	[optional] [default to '5m']

Return type

list[FuturesCandlestick]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_contracts

list[Contract] list_futures_contracts(settle)

List all futures contracts

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')

try:
    # List all futures contracts
    api_response = api_instance.list_futures_contracts(settle)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_contracts: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']

Return type

list[Contract]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_funding_rate_history

list[FundingRateRecord] list_futures_funding_rate_history(settle, contract, limit=limit)

Funding rate history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)

try:
    # Funding rate history
    api_response = api_instance.list_futures_funding_rate_history(settle, contract, limit=limit)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_funding_rate_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
limit	int	Maximum number of record returned in one list	[optional] [default to 100]

Return type

list[FundingRateRecord]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_insurance_ledger

list[InsuranceRecord] list_futures_insurance_ledger(settle, limit=limit)

Futures insurance balance history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)

try:
    # Futures insurance balance history
    api_response = api_instance.list_futures_insurance_ledger(settle, limit=limit)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_insurance_ledger: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
limit	int	Maximum number of record returned in one list	[optional] [default to 100]

Return type

list[InsuranceRecord]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_order_book

FuturesOrderBook list_futures_order_book(settle, contract, interval=interval, limit=limit)

Futures order book

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

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)

try:
    # Futures order book
    api_response = api_instance.list_futures_order_book(settle, contract, interval=interval, limit=limit)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_order_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
interval	str	Order depth. 0 means no aggregation is applied. default to 0	[optional] [default to '0']
limit	int	Maximum number of order depth data in asks or bids	[optional] [default to 10]

Return type

FuturesOrderBook

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_orders

list[FuturesOrder] list_futures_orders(settle, contract, status, limit=limit, last_id=last_id)

List futures orders

Zero-fill order cannot be retrieved 60 seconds after cancellation

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
status = 'open' # str | List orders based on status
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)

try:
    # List futures orders
    api_response = api_instance.list_futures_orders(settle, contract, status, limit=limit, last_id=last_id)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
status	str	List orders based on status
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
last_id	str	Specify list staring point using the `id` of last record in previous list-query results	[optional]

Return type

list[FuturesOrder]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_tickers

list[FuturesTicker] list_futures_tickers(settle, contract=contract)

List futures tickers

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract, return related data only if specified (optional)

try:
    # List futures tickers
    api_response = api_instance.list_futures_tickers(settle, contract=contract)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_tickers: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract, return related data only if specified	[optional]

Return type

list[FuturesTicker]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_futures_trades

list[FuturesTrade] list_futures_trades(settle, contract, limit=limit, last_id=last_id, _from=_from, to=to)

Futures trading history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

# create an instance of the API class
api_instance = gate_api.FuturesApi()
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
last_id = '12345' # str | Specify list staring point using the id of last record in previous list-query results  This parameter is deprecated. Use `from` and `to` instead to limit time range (optional)
_from = 1546905600 # float | 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.  (optional)
to = 1546935600 # float | Specify end time in Unix seconds, default to current time (optional)

try:
    # Futures trading history
    api_response = api_instance.list_futures_trades(settle, contract, limit=limit, last_id=last_id, _from=_from, to=to)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_futures_trades: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
last_id	str	Specify list staring point using the id of last record in previous list-query results This parameter is deprecated. Use `from` and `to` instead to limit time range	[optional]
_from	float	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.	[optional]
to	float	Specify end time in Unix seconds, default to current time	[optional]

Return type

list[FuturesTrade]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_liquidates

list[FuturesLiquidate] list_liquidates(settle, contract=contract, limit=limit, at=at)

List liquidation history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract, return related data only if specified (optional)
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
at = 0 # int | Specify a liquidation timestamp (optional) (default to 0)

try:
    # List liquidation history
    api_response = api_instance.list_liquidates(settle, contract=contract, limit=limit, at=at)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_liquidates: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract, return related data only if specified	[optional]
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
at	int	Specify a liquidation timestamp	[optional] [default to 0]

Return type

list[FuturesLiquidate]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_position_close

list[PositionClose] list_position_close(settle, contract=contract, limit=limit)

List position close history

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract, return related data only if specified (optional)
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)

try:
    # List position close history
    api_response = api_instance.list_position_close(settle, contract=contract, limit=limit)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_position_close: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract, return related data only if specified	[optional]
limit	int	Maximum number of record returned in one list	[optional] [default to 100]

Return type

list[PositionClose]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_positions

list[Position] list_positions(settle)

List all positions of a user

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')

try:
    # List all positions of a user
    api_response = api_instance.list_positions(settle)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_positions: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']

Return type

list[Position]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_price_triggered_orders

list[FuturesPriceTriggeredOrder] list_price_triggered_orders(settle, status, contract=contract, limit=limit, offset=offset)

List all auto orders

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
status = 'status_example' # str | List orders based on status
contract = 'BTC_USD' # str | Futures contract, return related data only if specified (optional)
limit = 100 # int | Maximum number of record returned in one list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)

try:
    # List all auto orders
    api_response = api_instance.list_price_triggered_orders(settle, status, contract=contract, limit=limit, offset=offset)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->list_price_triggered_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
status	str	List orders based on status
contract	str	Futures contract, return related data only if specified	[optional]
limit	int	Maximum number of record returned in one list	[optional] [default to 100]
offset	int	List offset, starting from 0	[optional] [default to 0]

Return type

list[FuturesPriceTriggeredOrder]

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_position_leverage

Position update_position_leverage(settle, contract, leverage)

Update position leverage

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
leverage = '10' # str | New position leverage

try:
    # Update position leverage
    api_response = api_instance.update_position_leverage(settle, contract, leverage)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->update_position_leverage: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
leverage	str	New position leverage

Return type

Position

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_position_margin

Position update_position_margin(settle, contract, change)

Update position margin

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
change = '0.01' # str | Margin change. Use positive number to increase margin, negative number otherwise.

try:
    # Update position margin
    api_response = api_instance.update_position_margin(settle, contract, change)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->update_position_margin: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
change	str	Margin change. Use positive number to increase margin, negative number otherwise.

Return type

Position

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_position_risk_limit

Position update_position_risk_limit(settle, contract, risk_limit)

Update position risk limit

Example

from __future__ import print_function
import gate_api
from gate_api.rest import ApiException

configuration = gate_api.Configuration()
configuration.key = 'YOUR_API_KEY'
configuration.secret = 'YOUR_API_SECRET'

# create an instance of the API class
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
settle = 'btc' # str | Settle currency (default to 'btc')
contract = 'BTC_USD' # str | Futures contract
risk_limit = '10' # str | New position risk limit

try:
    # Update position risk limit
    api_response = api_instance.update_position_risk_limit(settle, contract, risk_limit)
    print(api_response)
except ApiException as e:
    print("Exception when calling FuturesApi->update_position_risk_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
settle	str	Settle currency	[default to 'btc']
contract	str	Futures contract
risk_limit	str	New position risk limit

Return type

Position

Authorization

Authentication with API key and secret is required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

FuturesApi.md

Latest commit

History

FuturesApi.md

File metadata and controls

gate_api.FuturesApi

cancel_futures_order

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_futures_orders

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_price_triggered_order

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_price_triggered_order_list

Example

Parameters

Return type

Authorization

HTTP request headers

create_futures_order

Example

Parameters

Return type

Authorization

HTTP request headers

create_price_triggered_order

Example

Parameters

Return type

Authorization

HTTP request headers

get_futures_contract

Example

Parameters

Return type

Authorization

HTTP request headers

get_futures_order

Example

Parameters

Return type

Authorization

HTTP request headers

get_my_trades

Example

Parameters

Return type

Authorization

HTTP request headers

get_position

Example

Parameters

Return type

Authorization

HTTP request headers

get_price_triggered_order

Example

Parameters

Return type

Authorization

HTTP request headers

list_futures_account_book

Example

Parameters

Return type

Authorization

HTTP request headers

list_futures_accounts