775 lines (594 loc) · 24.8 KB

SubAccountApi

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

Method	HTTP request	Description
listSubAccounts	GET /sub_accounts	List sub-accounts
createSubAccounts	POST /sub_accounts	Create a new sub-account
getSubAccount	GET /sub_accounts/{user_id}	Get sub-account
listSubAccountKeys	GET /sub_accounts/{user_id}/keys	List all API key pairs of the sub-account
createSubAccountKeys	POST /sub_accounts/{user_id}/keys	Create new sub-account API key pair
getSubAccountKey	GET /sub_accounts/{user_id}/keys/{key}	Get specific API key pair of the sub-account
updateSubAccountKeys	PUT /sub_accounts/{user_id}/keys/{key}	Update sub-account API key pair
deleteSubAccountKeys	DELETE /sub_accounts/{user_id}/keys/{key}	Delete sub-account API key pair
lockSubAccount	POST /sub_accounts/{user_id}/lock	Lock sub-account
unlockSubAccount	POST /sub_accounts/{user_id}/unlock	Unlock sub-account
listUnifiedMode	GET /sub_accounts/unified_mode	Get sub-account mode

listSubAccounts

List<SubAccount> listSubAccounts().type(type).execute();

List sub-accounts

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
type	String	Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.	[optional]

Return type

List<SubAccount>

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List retrieved successfully	-

createSubAccounts

SubAccount createSubAccounts(subAccount)

Create a new sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
subAccount	SubAccount

Return type

SubAccount

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created successfully	-

getSubAccount

SubAccount getSubAccount(userId)

Get sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Long	Sub-account user ID

Return type

SubAccount

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

listSubAccountKeys

List<SubAccountKey> listSubAccountKeys(userId)

List all API key pairs of the sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Integer	Sub-account user ID

Return type

List<SubAccountKey>

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List retrieved successfully	-

createSubAccountKeys

SubAccountKey createSubAccountKeys(userId, subAccountKey)

Create new sub-account API key pair

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Long	Sub-account user ID
subAccountKey	SubAccountKey

Return type

SubAccountKey

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Created successfully	-

getSubAccountKey

SubAccountKey getSubAccountKey(userId, key)

Get specific API key pair of the sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Integer	Sub-account user ID
key	String	Sub-account API key

Return type

SubAccountKey

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

updateSubAccountKeys

updateSubAccountKeys(userId, key, subAccountKey)

Update sub-account API key pair

Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description
userId	Integer	Sub-account user ID
key	String	Sub-account API key
subAccountKey	SubAccountKey

Return type

null (empty response body)

Authorization

apiv4

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Updated successfully	-

deleteSubAccountKeys

deleteSubAccountKeys(userId, key)

Delete sub-account API key pair

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Integer	Sub-account user ID
key	String	Sub-account API key

Return type

null (empty response body)

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Deleted successfully	-

lockSubAccount

lockSubAccount(userId)

Lock sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Long	Sub-account user ID

Return type

null (empty response body)

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Locked successfully	-

unlockSubAccount

unlockSubAccount(userId)

Unlock sub-account

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Parameters

Name	Type	Description	Notes
userId	Long	Sub-account user ID

Return type

null (empty response body)

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Unlocked successfully	-

listUnifiedMode

List<SubUserMode> listUnifiedMode()

Get sub-account mode

Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode

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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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

List<SubUserMode>

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Query successful	-

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all

 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
gateapi-java/docs/SubAccountApi.md at master · gate/gateapi-java · GitHub
Skip to contentNavigation Menu
Sign inAppearance settings
AI CODE CREATIONGitHub CopilotWrite better code with AI
GitHub Copilot appDirect agents from issue to merge
MCP RegistryIntegrate external tools
DEVELOPER WORKFLOWSActionsAutomate any workflow
CodespacesInstant dev environments
IssuesPlan and track work
Code ReviewManage code changes
Code QualityEnforce quality at merge
APPLICATION SECURITYGitHub Advanced SecurityFind and fix vulnerabilities
Code securitySecure your code as you build
Secret protectionStop leaks before they start
EXPLOREWhy GitHub
Documentation
Blog
Changelog
Marketplace
View all features
BY COMPANY SIZEEnterprises
Small and medium teams
Startups
Nonprofits
BY USE CASEApp Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRYHealthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
EXPLORE BY TOPICAI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPECustomer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICESDocumentation
Customer support
Community forum
Trust center
Partners
View all resources
COMMUNITYGitHub SponsorsFund open source developers
PROGRAMSSecurity Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIESTopics
Trending
Collections
ENTERPRISE SOLUTIONSEnterprise platformAI-powered developer platform
AVAILABLE ADD-ONSGitHub Advanced SecurityEnterprise-grade security features
Copilot for BusinessEnterprise-grade AI features
Premium SupportEnterprise-grade 24/7 support
Pricing
Sign in
Sign upAppearance settings
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
 Uh oh!
There was an error while loading. Please reload this page.

gate
/gateapi-javaPublic
Notifications
You must be signed in to change notification settings
Fork
2

Star
3
Code
Issues0
Pull requests0
Discussions
Actions
Projects
Security and quality0
Insights
Additional navigation options
Code

Issues

Pull requests

Discussions

Actions

Projects

Security and quality

Insights
Expand file tree
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
775 lines (594 loc) · 24.8 KB
Breadcrumbs
gateapi-java
/docs
/SubAccountApi.md
Copy path
File metadata and controls
775 lines (594 loc) · 24.8 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
SubAccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
listSubAccounts GET /sub_accounts List sub-accounts
createSubAccounts POST /sub_accounts Create a new sub-account
getSubAccount GET /sub_accounts/{user_id} Get sub-account
listSubAccountKeys GET /sub_accounts/{user_id}/keys List all API key pairs of the sub-account
createSubAccountKeys POST /sub_accounts/{user_id}/keys Create new sub-account API key pair
getSubAccountKey GET /sub_accounts/{user_id}/keys/{key} Get specific API key pair of the sub-account
updateSubAccountKeys PUT /sub_accounts/{user_id}/keys/{key} Update sub-account API key pair
deleteSubAccountKeys DELETE /sub_accounts/{user_id}/keys/{key} Delete sub-account API key pair
lockSubAccount POST /sub_accounts/{user_id}/lock Lock sub-account
unlockSubAccount POST /sub_accounts/{user_id}/unlock Unlock sub-account
listUnifiedMode GET /sub_accounts/unified_mode Get sub-account mode
listSubAccounts
List<SubAccount> listSubAccounts().type(type).execute();
List sub-accounts
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
Stringtype = "0"; // String | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.try {
List<SubAccount> result = apiInstance.listSubAccounts()
.type(type)
.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 SubAccountApi#listSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
type String Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. [optional]Return type
List<SubAccount>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccounts
SubAccount createSubAccounts(subAccount)
Create a new sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
SubAccountsubAccount = newSubAccount(); // SubAccount | try {
SubAccountresult = apiInstance.createSubAccounts(subAccount);
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 SubAccountApi#createSubAccounts");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
subAccount SubAccount Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
201 Created successfully -
getSubAccount
SubAccount getSubAccount(userId)
Get sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
SubAccountresult = apiInstance.getSubAccount(userId);
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 SubAccountApi#getSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
SubAccount
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
listSubAccountKeys
List<SubAccountKey> listSubAccountKeys(userId)
List all API key pairs of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDtry {
List<SubAccountKey> result = apiInstance.listSubAccountKeys(userId);
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 SubAccountApi#listSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID Return type
List<SubAccountKey>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -
createSubAccountKeys
SubAccountKey createSubAccountKeys(userId, subAccountKey)
Create new sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDSubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
SubAccountKeyresult = apiInstance.createSubAccountKeys(userId, subAccountKey);
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 SubAccountApi#createSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID 
subAccountKey SubAccountKey Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 Created successfully -
getSubAccountKey
SubAccountKey getSubAccountKey(userId, key)
Get specific API key pair of the sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
SubAccountKeyresult = apiInstance.getSubAccountKey(userId, key);
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 SubAccountApi#getSubAccountKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
SubAccountKey
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -
updateSubAccountKeys
updateSubAccountKeys(userId, key, subAccountKey)
Update sub-account API key pair
Modify Sub-account API Key Pair (Note: This interface cannot modify the mode account type attribute)
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keySubAccountKeysubAccountKey = newSubAccountKey(); // SubAccountKey | try {
apiInstance.updateSubAccountKeys(userId, key, subAccountKey);
} 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 SubAccountApi#updateSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key 
subAccountKey SubAccountKey Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Updated successfully -
deleteSubAccountKeys
deleteSubAccountKeys(userId, key)
Delete sub-account API key pair
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
IntegeruserId = 56; // Integer | Sub-account user IDStringkey = "key_example"; // String | Sub-account API keytry {
apiInstance.deleteSubAccountKeys(userId, key);
} 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 SubAccountApi#deleteSubAccountKeys");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Integer Sub-account user ID 
key String Sub-account API key Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Deleted successfully -
lockSubAccount
lockSubAccount(userId)
Lock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.lockSubAccount(userId);
} 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 SubAccountApi#lockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Locked successfully -
unlockSubAccount
unlockSubAccount(userId)
Unlock sub-account
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
LonguserId = 56L; // Long | Sub-account user IDtry {
apiInstance.unlockSubAccount(userId);
} 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 SubAccountApi#unlockSubAccount");
System.err.println("Status code: " + e.getCode());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name Type Description Notes
userId Long Sub-account user ID Return type
null (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: Not defined
HTTP response details
Status code Description Response headers
204 Unlocked successfully -
listUnifiedMode
List<SubUserMode> listUnifiedMode()
Get sub-account mode
Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode
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.SubAccountApi;
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");
SubAccountApiapiInstance = newSubAccountApi(defaultClient);
try {
List<SubUserMode> result = apiInstance.listUnifiedMode();
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 SubAccountApi#listUnifiedMode");
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
List<SubUserMode>
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Query successful -
Footer

© 2026 GitHub, Inc.
Footer navigation
Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.

Uh oh!

FilesExpand file tree

SubAccountApi.md

Latest commit

History

SubAccountApi.md

File metadata and controls

SubAccountApi

listSubAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createSubAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSubAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listSubAccountKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createSubAccountKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getSubAccountKey

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateSubAccountKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteSubAccountKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lockSubAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unlockSubAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listUnifiedMode

Example