CfdApi.md

CfdApi

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

Method	HTTP request	Description
queryMt5AccountInfo	GET /tradfi/users/mt5-account	Query MT5 account information
queryCategories	GET /tradfi/symbols/categories	Query trading symbol categories
querySymbolCommissions	GET /tradfi/symbols/commissions	Query symbol commission rates
querySymbols	GET /tradfi/symbols	Query trading symbol list
querySymbolDetail	GET /tradfi/symbols/detail	Query trading symbol details
querySymbolKline	GET /tradfi/symbols/{symbol}/klines	Query trading symbol klines
querySymbolTicker	GET /tradfi/symbols/{symbol}/tickers	Query trading symbol ticker
createTradFiUser	POST /tradfi/users	Create CFD user
queryUserAssets	GET /tradfi/users/assets	Query account assets
queryTransaction	GET /tradfi/transactions	Query Fund Transfer In/Out Records
createTransaction	POST /tradfi/transactions	Fund transfer
queryOrderList	GET /tradfi/orders	Query active order list
createTradFiOrder	POST /tradfi/orders	Create order
updateOrder	PUT /tradfi/orders/{order_id}	Modify order
deleteOrder	DELETE /tradfi/orders/{order_id}	Cancel order
queryOrderHistoryList	GET /tradfi/orders/history	Query historical order list
queryOrderLog	GET /tradfi/orders/log/{log_id}	Get order details by log ID
queryPositionList	GET /tradfi/positions	Query active position list
updatePosition	PUT /tradfi/positions/{position_id}	Modify position
closePosition	POST /tradfi/positions/{position_id}/close	Close position
queryPositionHistoryList	GET /tradfi/positions/history	Query historical position list

queryMt5AccountInfo

Mt5Account queryMt5AccountInfo()

Query MT5 account information

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
Mt5Accountresult = apiInstance.queryMt5AccountInfo();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryMt5AccountInfo");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

queryCategories

Categories queryCategories()

Query trading symbol categories

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
Categoriesresult = apiInstance.queryCategories();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryCategories");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

querySymbolCommissions

SymbolCommissions querySymbolCommissions().symbols(symbols).categoryCode(categoryCode).execute();

Query symbol commission rates

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
Stringsymbols = "AUDUSD,XAUUSD"; // String | List of symbol codes (multiple codes separated by commas). At least one of symbol and category_code is requiredStringcategoryCode = "forex-外汇,metal-金属,index-指数,commodity-大宗商品,stock-股票"; // String | 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 requiredtry {
SymbolCommissionsresult = apiInstance.querySymbolCommissions()
.symbols(symbols)
.categoryCode(categoryCode)
.execute();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#querySymbolCommissions");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
symbols	String	List of symbol codes (multiple codes separated by commas). At least one of symbol and category_code is required	[optional]
categoryCode	String	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	-

querySymbols

Symbols querySymbols()

Query trading symbol list

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
Symbolsresult = apiInstance.querySymbols();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#querySymbols");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

querySymbolDetail

ContractDetail querySymbolDetail(symbols)

Query trading symbol details

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
Stringsymbols = "EURUSD,XAGUSD"; // String | Trading symbol code list (comma-separated, max 10 symbols)try {
ContractDetailresult = apiInstance.querySymbolDetail(symbols);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#querySymbolDetail");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
symbols	String	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	-

querySymbolKline

Klines querySymbolKline(symbol, klineType).beginTime(beginTime).endTime(endTime).limit(limit).execute();

Query trading symbol klines

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
Stringsymbol = "EURUSD"; // String | Trading symbol codeStringklineType = "1m"; // String | Kline type (time period)LongbeginTime = 1769378400L; // Long | Start time (Unix timestamp in seconds)LongendTime = 1769464800L; // Long | End time (Unix timestamp in seconds)Integerlimit = 100; // Integer | Kline limit (max 500, error if exceeded)try {
Klinesresult = apiInstance.querySymbolKline(symbol, klineType)
.beginTime(beginTime)
.endTime(endTime)
.limit(limit)
.execute();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#querySymbolKline");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
symbol	String	Trading symbol code
klineType	String	Kline type (time period)	[enum: 1m, 15m, 1h, 4h, 1d, 7d, 30d]
beginTime	Long	Start time (Unix timestamp in seconds)	[optional]
endTime	Long	End time (Unix timestamp in seconds)	[optional]
limit	Integer	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	-

querySymbolTicker

TradFiTicker querySymbolTicker(symbol)

Query trading symbol ticker

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
CfdApiapiInstance = newCfdApi(defaultClient);
Stringsymbol = "EURUSD"; // String | Trading symbol codetry {
TradFiTickerresult = apiInstance.querySymbolTicker(symbol);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#querySymbolTicker");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
symbol	String	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	-

createTradFiUser

CreateUserResp createTradFiUser()

Create CFD user

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
CreateUserRespresult = apiInstance.createTradFiUser();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#createTradFiUser");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

queryUserAssets

UserAssetResp queryUserAssets()

Query account assets

Query account assets

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
UserAssetRespresult = apiInstance.queryUserAssets();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryUserAssets");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

queryTransaction

TransactionList queryTransaction().beginTime(beginTime).endTime(endTime).type(type).page(page).pageSize(pageSize).execute();

Query Fund Transfer In/Out Records

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
LongbeginTime = 1704067200L; // Long | Start Time (Second-level Timestamp)LongendTime = 1706745599L; // Long | End Time (Second-level Timestamp)Stringtype = "withdraw"; // String | Transaction Type (deposit - transfer in, withdraw - transfer out, dividend - dividend payment, fill_negative - cover negative balance)Integerpage = 1; // Integer | page numberIntegerpageSize = 20; // Integer | Number per page, default 10, maximum 50try {
TransactionListresult = apiInstance.queryTransaction()
.beginTime(beginTime)
.endTime(endTime)
.type(type)
.page(page)
.pageSize(pageSize)
.execute();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryTransaction");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
beginTime	Long	Start Time (Second-level Timestamp)	[optional]
endTime	Long	End Time (Second-level Timestamp)	[optional]
type	String	Transaction Type (deposit - transfer in, withdraw - transfer out, dividend - dividend payment, fill_negative - cover negative balance)	[optional] [enum: deposit, withdraw, dividend, fill_negative]
page	Integer	page number	[optional]
pageSize	Integer	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	-

createTransaction

CreateTransaction createTransaction(tradFiTransactionRequest)

Fund transfer

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
TradFiTransactionRequesttradFiTransactionRequest = newTradFiTransactionRequest(); // TradFiTransactionRequest | try {
CreateTransactionresult = apiInstance.createTransaction(tradFiTransactionRequest);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#createTransaction");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
tradFiTransactionRequest	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	-

queryOrderList

OrderList queryOrderList()

Query active order list

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
OrderListresult = apiInstance.queryOrderList();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryOrderList");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

createTradFiOrder

CreateOrder2 createTradFiOrder(tradFiOrderRequest)

Create order

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
TradFiOrderRequesttradFiOrderRequest = newTradFiOrderRequest(); // TradFiOrderRequest | try {
CreateOrder2result = apiInstance.createTradFiOrder(tradFiOrderRequest);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#createTradFiOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
tradFiOrderRequest	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	-

updateOrder

UpdateOrder updateOrder(orderId, tradFiOrderUpdateRequest)

Modify order

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
IntegerorderId = 1223; // Integer | Order IDTradFiOrderUpdateRequesttradFiOrderUpdateRequest = newTradFiOrderUpdateRequest(); // TradFiOrderUpdateRequest | try {
UpdateOrderresult = apiInstance.updateOrder(orderId, tradFiOrderUpdateRequest);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#updateOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
orderId	Integer	Order ID
tradFiOrderUpdateRequest	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	-

deleteOrder

Object deleteOrder(orderId)

Cancel order

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
IntegerorderId = 1223; // Integer | Order IDtry {
Objectresult = apiInstance.deleteOrder(orderId);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#deleteOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
orderId	Integer	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	-

queryOrderHistoryList

OrderHistoryList queryOrderHistoryList().beginTime(beginTime).endTime(endTime).symbol(symbol).side(side).execute();

Query historical order list

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
LongbeginTime = 1769397000L; // Long | Start time (Unix timestamp in seconds), earliest query is one month agoLongendTime = 1769398000L; // Long | End time (Unix timestamp in seconds)Stringsymbol = "USDCAD"; // String | Currency pairIntegerside = 2; // Integer | Side (1=sell, 2=buy)try {
OrderHistoryListresult = apiInstance.queryOrderHistoryList()
.beginTime(beginTime)
.endTime(endTime)
.symbol(symbol)
.side(side)
.execute();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryOrderHistoryList");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
beginTime	Long	Start time (Unix timestamp in seconds), earliest query is one month ago	[optional]
endTime	Long	End time (Unix timestamp in seconds)	[optional]
symbol	String	Currency pair	[optional]
side	Integer	Side (1=sell, 2=buy)	[optional] [enum: 1, 2]

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	-

queryOrderLog

OrderLog queryOrderLog(logId)

Get order details by log ID

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
IntegerlogId = 1223; // Integer | log_id returned from the order placement APItry {
OrderLogresult = apiInstance.queryOrderLog(logId);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryOrderLog");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
logId	Integer	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	-

queryPositionList

PositionList queryPositionList()

Query active position list

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
try {
PositionListresult = apiInstance.queryPositionList();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryPositionList");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

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	-

updatePosition

UpdatePosition updatePosition(positionId, tradFiPositionUpdateRequest)

Modify position

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
IntegerpositionId = 1223; // Integer | Position IDTradFiPositionUpdateRequesttradFiPositionUpdateRequest = newTradFiPositionUpdateRequest(); // TradFiPositionUpdateRequest | try {
UpdatePositionresult = apiInstance.updatePosition(positionId, tradFiPositionUpdateRequest);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#updatePosition");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
positionId	Integer	Position ID
tradFiPositionUpdateRequest	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	-

closePosition

DeletePosition closePosition(positionId, tradFiClosePositionRequest)

Close position

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
IntegerpositionId = 1223; // Integer | Position IDTradFiClosePositionRequesttradFiClosePositionRequest = newTradFiClosePositionRequest(); // TradFiClosePositionRequest | try {
DeletePositionresult = apiInstance.closePosition(positionId, tradFiClosePositionRequest);
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#closePosition");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
positionId	Integer	Position ID
tradFiClosePositionRequest	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	-

queryPositionHistoryList

PositionHistoryList queryPositionHistoryList().page(page).pageSize(pageSize).beginTime(beginTime).endTime(endTime).symbol(symbol).positionDir(positionDir).execute();

Query historical position list

Example

// Import classes:importio.gate.gateapi.ApiClient;
importio.gate.gateapi.ApiException;
importio.gate.gateapi.Configuration;
importio.gate.gateapi.GateApiException;
importio.gate.gateapi.auth.*;
importio.gate.gateapi.models.*;
importio.gate.gateapi.api.CfdApi;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.gateio.ws/api/v4");
// Configure APIv4 authorization: apiv4defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
CfdApiapiInstance = newCfdApi(defaultClient);
Longpage = 1L; // Long | Page number; defaults to 1 if omitted.LongpageSize = 10L; // Long | Page size; defaults to 10 if omitted. Maximum 100.LongbeginTime = 56L; // Long | Start Time (Unix Timestamp, seconds). The earliest queryable time is one month agoLongendTime = 56L; // Long | End time (timestamp in seconds)Stringsymbol = "symbol_example"; // String | Trading symbol (e.g., EURUSD)StringpositionDir = "positionDir_example"; // String | Position direction (Long=long position, Short=short position)try {
PositionHistoryListresult = apiInstance.queryPositionHistoryList()
.page(page)
.pageSize(pageSize)
.beginTime(beginTime)
.endTime(endTime)
.symbol(symbol)
.positionDir(positionDir)
.execute();
System.out.println(result);
} catch (GateApiExceptione) {
System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
e.printStackTrace();
} catch (ApiExceptione) {
System.err.println("Exception when calling CfdApi#queryPositionHistoryList");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

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

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	-