CFDApi.md

gate_api.CFDApi

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

Method	HTTP request	Description
query_mt5_account_info	GET /tradfi/users/mt5-account	Query MT5 account information
query_categories	GET /tradfi/symbols/categories	Query trading symbol categories
query_symbol_commissions	GET /tradfi/symbols/commissions	Query symbol commission rates
query_symbols	GET /tradfi/symbols	Query trading symbol list
query_symbol_detail	GET /tradfi/symbols/detail	Query trading symbol details
query_symbol_kline	GET /tradfi/symbols/{symbol}/klines	Query trading symbol klines
query_symbol_ticker	GET /tradfi/symbols/{symbol}/tickers	Query trading symbol ticker
create_trad_fi_user	POST /tradfi/users	Create CFD user
query_user_assets	GET /tradfi/users/assets	Query account assets
query_transaction	GET /tradfi/transactions	Query Fund Transfer In/Out Records
create_transaction	POST /tradfi/transactions	Fund transfer
query_order_list	GET /tradfi/orders	Query active order list
create_trad_fi_order	POST /tradfi/orders	Create order
update_order	PUT /tradfi/orders/{order_id}	Modify order
delete_order	DELETE /tradfi/orders/{order_id}	Cancel order
query_order_history_list	GET /tradfi/orders/history	Query historical order list
query_order_log	GET /tradfi/orders/log/{log_id}	Get order details by log ID
query_position_list	GET /tradfi/positions	Query active position list
update_position	PUT /tradfi/positions/{position_id}	Modify position
close_position	POST /tradfi/positions/{position_id}/close	Close position
query_position_history_list	GET /tradfi/positions/history	Query historical position list

query_mt5_account_info

Mt5Account query_mt5_account_info()

Query MT5 account information

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query MT5 account informationapi_response=api_instance.query_mt5_account_info()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_mt5_account_info: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

Mt5Account

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_categories

Categories query_categories()

Query trading symbol categories

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query trading symbol categoriesapi_response=api_instance.query_categories()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_categories: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

Categories

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_symbol_commissions

SymbolCommissions query_symbol_commissions(symbols=symbols, category_code=category_code)

Query symbol commission rates

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
symbols='AUDUSD,XAUUSD'# str | List of symbol codes (multiple codes separated by commas). At least one of symbol and category_code is required (optional)category_code='forex-外汇,metal-金属,index-指数,commodity-大宗商品,stock-股票'# str | List of category codes (multiple codes separated by commas). When provided together with symbols, filters symbols by category. At least one of symbol and category_code is required (optional)try:
# Query symbol commission ratesapi_response=api_instance.query_symbol_commissions(symbols=symbols, category_code=category_code)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_symbol_commissions: %s\n"%e)

Parameters

Name	Type	Description	Notes
symbols	str	List of symbol codes (multiple codes separated by commas). At least one of symbol and category_code is required	[optional]
category_code	str	List of category codes (multiple codes separated by commas). When provided together with symbols, filters symbols by category. At least one of symbol and category_code is required	[optional]

Return type

SymbolCommissions

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_symbols

Symbols query_symbols()

Query trading symbol list

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query trading symbol listapi_response=api_instance.query_symbols()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_symbols: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

Symbols

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_symbol_detail

ContractDetail query_symbol_detail(symbols)

Query trading symbol details

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
symbols='EURUSD,XAGUSD'# str | Trading symbol code list (comma-separated, max 10 symbols)try:
# Query trading symbol detailsapi_response=api_instance.query_symbol_detail(symbols)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_symbol_detail: %s\n"%e)

Parameters

Name	Type	Description	Notes
symbols	str	Trading symbol code list (comma-separated, max 10 symbols)

Return type

ContractDetail

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_symbol_kline

Klines query_symbol_kline(symbol, kline_type, begin_time=begin_time, end_time=end_time, limit=limit)

Query trading symbol klines

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
symbol='EURUSD'# str | Trading symbol codekline_type='1m'# str | Kline type (time period)begin_time=1769378400# int | Start time (Unix timestamp in seconds) (optional)end_time=1769464800# int | End time (Unix timestamp in seconds) (optional)limit=100# int | Kline limit (max 500, error if exceeded) (optional)try:
# Query trading symbol klinesapi_response=api_instance.query_symbol_kline(symbol, kline_type, begin_time=begin_time, end_time=end_time, limit=limit)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_symbol_kline: %s\n"%e)

Parameters

Name	Type	Description	Notes
symbol	str	Trading symbol code
kline_type	str	Kline type (time period)
begin_time	int	Start time (Unix timestamp in seconds)	[optional]
end_time	int	End time (Unix timestamp in seconds)	[optional]
limit	int	Kline limit (max 500, error if exceeded)	[optional]

Return type

Klines

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_symbol_ticker

TradFiTicker query_symbol_ticker(symbol)

Query trading symbol ticker

Example

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.configuration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
symbol='EURUSD'# str | Trading symbol codetry:
# Query trading symbol tickerapi_response=api_instance.query_symbol_ticker(symbol)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_symbol_ticker: %s\n"%e)

Parameters

Name	Type	Description	Notes
symbol	str	Trading symbol code

Return type

TradFiTicker

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

create_trad_fi_user

CreateUserResp create_trad_fi_user()

Create CFD user

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Create CFD userapi_response=api_instance.create_trad_fi_user()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->create_trad_fi_user: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

CreateUserResp

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Account opened successfully	-
400	Request failed	-

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

query_user_assets

UserAssetResp query_user_assets()

Query account assets

Query account assets

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query account assetsapi_response=api_instance.query_user_assets()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_user_assets: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

UserAssetResp

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_transaction

TransactionList query_transaction(begin_time=begin_time, end_time=end_time, type=type, page=page, page_size=page_size)

Query Fund Transfer In/Out Records

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
begin_time=1704067200# int | Start Time (Second-level Timestamp) (optional)end_time=1706745599# int | End Time (Second-level Timestamp) (optional)type='withdraw'# str | Transaction Type (deposit - transfer in, withdraw - transfer out, dividend - dividend payment, fill_negative - cover negative balance) (optional)page=1# int | page number (optional)page_size=20# int | Number per page, default 10, maximum 50 (optional)try:
# Query Fund Transfer In/Out Recordsapi_response=api_instance.query_transaction(begin_time=begin_time, end_time=end_time, type=type, page=page, page_size=page_size)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_transaction: %s\n"%e)

Parameters

Name	Type	Description	Notes
begin_time	int	Start Time (Second-level Timestamp)	[optional]
end_time	int	End Time (Second-level Timestamp)	[optional]
type	str	Transaction Type (deposit - transfer in, withdraw - transfer out, dividend - dividend payment, fill_negative - cover negative balance)	[optional]
page	int	page number	[optional]
page_size	int	Number per page, default 10, maximum 50	[optional]

Return type

TransactionList

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

create_transaction

CreateTransaction create_transaction(trad_fi_transaction_request)

Fund transfer

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
trad_fi_transaction_request=gate_api.TradFiTransactionRequest() # TradFiTransactionRequest | try:
# Fund transferapi_response=api_instance.create_transaction(trad_fi_transaction_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->create_transaction: %s\n"%e)

Parameters

Name	Type	Description	Notes
trad_fi_transaction_request	TradFiTransactionRequest

Return type

CreateTransaction

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_order_list

OrderList query_order_list()

Query active order list

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query active order listapi_response=api_instance.query_order_list()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_order_list: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

OrderList

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

create_trad_fi_order

CreateOrder2 create_trad_fi_order(trad_fi_order_request)

Create order

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
trad_fi_order_request=gate_api.TradFiOrderRequest() # TradFiOrderRequest | try:
# Create orderapi_response=api_instance.create_trad_fi_order(trad_fi_order_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->create_trad_fi_order: %s\n"%e)

Parameters

Name	Type	Description	Notes
trad_fi_order_request	TradFiOrderRequest

Return type

CreateOrder2

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Order placed successfully	-
400	Request failed	-

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

update_order

UpdateOrder update_order(order_id, trad_fi_order_update_request)

Modify order

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
order_id=1223# int | Order IDtrad_fi_order_update_request=gate_api.TradFiOrderUpdateRequest() # TradFiOrderUpdateRequest | try:
# Modify orderapi_response=api_instance.update_order(order_id, trad_fi_order_update_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->update_order: %s\n"%e)

Parameters

Name	Type	Description	Notes
order_id	int	Order ID
trad_fi_order_update_request	TradFiOrderUpdateRequest

Return type

UpdateOrder

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

delete_order

object delete_order(order_id)

Cancel order

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
order_id=1223# int | Order IDtry:
# Cancel orderapi_response=api_instance.delete_order(order_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->delete_order: %s\n"%e)

Parameters

Name	Type	Description	Notes
order_id	int	Order ID

Return type

object

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deleted successfully	-
400	Request failed	-

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

query_order_history_list

OrderHistoryList query_order_history_list(begin_time=begin_time, end_time=end_time, symbol=symbol, side=side)

Query historical order list

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
begin_time=1769397000# int | Start time (Unix timestamp in seconds), earliest query is one month ago (optional)end_time=1769398000# int | End time (Unix timestamp in seconds) (optional)symbol='USDCAD'# str | Currency pair (optional)side=2# int | Side (1=sell, 2=buy) (optional)try:
# Query historical order listapi_response=api_instance.query_order_history_list(begin_time=begin_time, end_time=end_time, symbol=symbol, side=side)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_order_history_list: %s\n"%e)

Parameters

Name	Type	Description	Notes
begin_time	int	Start time (Unix timestamp in seconds), earliest query is one month ago	[optional]
end_time	int	End time (Unix timestamp in seconds)	[optional]
symbol	str	Currency pair	[optional]
side	int	Side (1=sell, 2=buy)	[optional]

Return type

OrderHistoryList

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_order_log

OrderLog query_order_log(log_id)

Get order details by log ID

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
log_id=1223# int | log_id returned from the order placement APItry:
# Get order details by log IDapi_response=api_instance.query_order_log(log_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_order_log: %s\n"%e)

Parameters

Name	Type	Description	Notes
log_id	int	log_id returned from the order placement API

Return type

OrderLog

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_position_list

PositionList query_position_list()

Query active position list

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
try:
# Query active position listapi_response=api_instance.query_position_list()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_position_list: %s\n"%e)

Parameters

This endpoint does not need any parameter.

Return type

PositionList

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

update_position

UpdatePosition update_position(position_id, trad_fi_position_update_request)

Modify position

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
position_id=1223# int | Position IDtrad_fi_position_update_request=gate_api.TradFiPositionUpdateRequest() # TradFiPositionUpdateRequest | try:
# Modify positionapi_response=api_instance.update_position(position_id, trad_fi_position_update_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->update_position: %s\n"%e)

Parameters

Name	Type	Description	Notes
position_id	int	Position ID
trad_fi_position_update_request	TradFiPositionUpdateRequest

Return type

UpdatePosition

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

close_position

DeletePosition close_position(position_id, trad_fi_close_position_request)

Close position

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
position_id=1223# int | Position IDtrad_fi_close_position_request=gate_api.TradFiClosePositionRequest() # TradFiClosePositionRequest | try:
# Close positionapi_response=api_instance.close_position(position_id, trad_fi_close_position_request)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->close_position: %s\n"%e)

Parameters

Name	Type	Description	Notes
position_id	int	Position ID
trad_fi_close_position_request	TradFiClosePositionRequest

Return type

DeletePosition

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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

query_position_history_list

PositionHistoryList query_position_history_list(page=page, page_size=page_size, begin_time=begin_time, end_time=end_time, symbol=symbol, position_dir=position_dir)

Query historical position list

Example

• Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.CFDApi(api_client)
page=1# int | Page number; defaults to 1 if omitted. (optional)page_size=10# int | Page size; defaults to 10 if omitted. Maximum 100. (optional)begin_time=56# int | Start Time (Unix Timestamp, seconds). The earliest queryable time is one month ago (optional)end_time=56# int | End time (timestamp in seconds) (optional)symbol='symbol_example'# str | Trading symbol (e.g., EURUSD) (optional)position_dir='position_dir_example'# str | Position direction (Long=long position, Short=short position) (optional)try:
# Query historical position listapi_response=api_instance.query_position_history_list(page=page, page_size=page_size, begin_time=begin_time, end_time=end_time, symbol=symbol, position_dir=position_dir)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling CFDApi->query_position_history_list: %s\n"%e)

Parameters

Name	Type	Description	Notes
page	int	Page number; defaults to 1 if omitted.	[optional]
page_size	int	Page size; defaults to 10 if omitted. Maximum 100.	[optional]
begin_time	int	Start Time (Unix Timestamp, seconds). The earliest queryable time is one month ago	[optional]
end_time	int	End time (timestamp in seconds)	[optional]
symbol	str	Trading symbol (e.g., EURUSD)	[optional]
position_dir	str	Position direction (Long=long position, Short=short position)	[optional]

Return type

PositionHistoryList

Authorization

apiv4

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Request success	-
400	Request failed	-

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