691 lines (513 loc) · 22.2 KB

gate_api.AccountApi

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

Method	HTTP request	Description
get_account_detail	GET /account/detail	Retrieve user account information
get_account_main_keys	GET /account/main_keys	Query All Main Account Key Information
get_account_rate_limit	GET /account/rate_limit	Get user transaction rate limit information
list_stp_groups	GET /account/stp_groups	Query STP user groups created by the user
create_stp_group	POST /account/stp_groups	Create STP user group
list_stp_groups_users	GET /account/stp_groups/{stp_id}/users	Query users in the STP user group
add_stp_group_users	POST /account/stp_groups/{stp_id}/users	Add users to the STP user group
delete_stp_group_users	DELETE /account/stp_groups/{stp_id}/users	Delete users from the STP user group
get_debit_fee	GET /account/debit_fee	Query GT fee deduction configuration
set_debit_fee	POST /account/debit_fee	Configure GT fee deduction

get_account_detail

AccountDetail get_account_detail()

Retrieve user account information

Example

Api Key Authentication (apiv4):

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

Parameters

This endpoint does not need any parameter.

Return type

AccountDetail

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

get_account_main_keys

AccountKeyInfo get_account_main_keys()

Query All Main Account Key Information

Example

Api Key Authentication (apiv4):

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

Parameters

This endpoint does not need any parameter.

Return type

AccountKeyInfo

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

get_account_rate_limit

list[AccountRateLimit] get_account_rate_limit()

Get user transaction rate limit information

This interface is not yet open for use

Example

Api Key Authentication (apiv4):

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

Parameters

This endpoint does not need any parameter.

Return type

list[AccountRateLimit]

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully retrieved	-

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

list_stp_groups

list[StpGroup] list_stp_groups(name=name)

Query STP user groups created by the user

Only query STP user groups created by the current main account

Example

Api Key Authentication (apiv4):

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

Parameters

Name	Type	Description	Notes
name	str	Fuzzy search by name	[optional]

Return type

list[StpGroup]

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List retrieved successfully	-

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

create_stp_group

StpGroup create_stp_group(stp_group)

Create STP user group

Only the main account is allowed to create a new STP user group

Example

Api Key Authentication (apiv4):

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

Parameters

Name	Type	Description	Notes
stp_group	StpGroup

Return type

StpGroup

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User added successfully, returning current users in the STP group	-

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

list_stp_groups_users

list[StpGroupUser] list_stp_groups_users(stp_id)

Query users in the STP user group

Only the main account that created this STP group can query the account ID list of the current STP group

Example

Api Key Authentication (apiv4):

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

Parameters

Name	Type	Description	Notes
stp_id	int	STP Group ID

Return type

list[StpGroupUser]

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List retrieved successfully	-

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

add_stp_group_users

list[StpGroupUser] add_stp_group_users(stp_id, request_body)

Add users to the STP user group

Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted

Example

Api Key Authentication (apiv4):

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

Parameters

Name	Type	Description	Notes
stp_id	int	STP Group ID
request_body	list[int]	User ID

Return type

list[StpGroupUser]

Authorization

apiv4

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User added successfully, returning current users in the STP group	-

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

delete_stp_group_users

list[StpGroupUser] delete_stp_group_users(stp_id, user_id)

Delete users from the STP user group

Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted

Example

Api Key Authentication (apiv4):

from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)

Parameters

Name	Type	Description	Notes
stp_id	int	STP Group ID
user_id	int	STP user IDs, multiple IDs can be separated by commas

Return type

list[StpGroupUser]

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Users deleted successfully, returns current users in the STP group	-

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

get_debit_fee

DebitFee get_debit_fee()

Query GT fee deduction configuration

Query the GT fee deduction configuration for the current account

Example

Api Key Authentication (apiv4):

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

Parameters

This endpoint does not need any parameter.

Return type

DebitFee

Authorization

apiv4

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-

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

set_debit_fee

set_debit_fee(debit_fee)

Configure GT fee deduction

Enable or disable GT fee deduction for the current account

Example

Api Key Authentication (apiv4):

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

Parameters

Name	Type	Description	Notes
debit_fee	DebitFee

Return type

void (empty response body)

Authorization

apiv4

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

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

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

 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
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-pythonPublic
Notifications
You must be signed in to change notification settings
Fork
8

Star
26
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-python
/docs
/AccountApi.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
691 lines (513 loc) · 22.2 KB
Breadcrumbs
gateapi-python
/docs
/AccountApi.md
Copy path
File metadata and controls
691 lines (513 loc) · 22.2 KB
Raw
Copy raw file
Download raw file
OutlineEdit and raw actions
gate_api.AccountApi
All URIs are relative to https://api.gateio.ws/api/v4
Method HTTP request Description
get_account_detail GET /account/detail Retrieve user account information
get_account_main_keys GET /account/main_keys Query All Main Account Key Information
get_account_rate_limit GET /account/rate_limit Get user transaction rate limit information
list_stp_groups GET /account/stp_groups Query STP user groups created by the user
create_stp_group POST /account/stp_groups Create STP user group
list_stp_groups_users GET /account/stp_groups/{stp_id}/users Query users in the STP user group
add_stp_group_users POST /account/stp_groups/{stp_id}/users Add users to the STP user group
delete_stp_group_users DELETE /account/stp_groups/{stp_id}/users Delete users from the STP user group
get_debit_fee GET /account/debit_fee Query GT fee deduction configuration
set_debit_fee POST /account/debit_fee Configure GT fee deductionget_account_detail
AccountDetail get_account_detail()
Retrieve user account information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Retrieve user account informationapi_response=api_instance.get_account_detail()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_detail: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountDetail
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_main_keys
AccountKeyInfo get_account_main_keys()
Query All Main Account Key Information
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query All Main Account Key Informationapi_response=api_instance.get_account_main_keys()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_main_keys: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
AccountKeyInfo
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
get_account_rate_limit
list[AccountRateLimit] get_account_rate_limit()
Get user transaction rate limit information
This interface is not yet open for use
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Get user transaction rate limit informationapi_response=api_instance.get_account_rate_limit()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_account_rate_limit: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
list[AccountRateLimit]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Successfully retrieved -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups
list[StpGroup] list_stp_groups(name=name)
Query STP user groups created by the user
Only query STP user groups created by the current main account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
name='group'# str | Fuzzy search by name (optional)try:
# Query STP user groups created by the userapi_response=api_instance.list_stp_groups(name=name)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups: %s\n"%e)
Parameters
Name Type Description Notes
name str Fuzzy search by name [optional]Return type
list[StpGroup]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
create_stp_group
StpGroup create_stp_group(stp_group)
Create STP user group
Only the main account is allowed to create a new STP user group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_group=gate_api.StpGroup() # StpGroup | try:
# Create STP user groupapi_response=api_instance.create_stp_group(stp_group)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->create_stp_group: %s\n"%e)
Parameters
Name Type Description Notes
stp_group StpGroup Return type
StpGroup
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
list_stp_groups_users
list[StpGroupUser] list_stp_groups_users(stp_id)
Query users in the STP user group
Only the main account that created this STP group can query the account ID list of the current STP group
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDtry:
# Query users in the STP user groupapi_response=api_instance.list_stp_groups_users(stp_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->list_stp_groups_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 List retrieved successfully -[Back to top][Back to API list][Back to Model list][Back to README]
add_stp_group_users
list[StpGroupUser] add_stp_group_users(stp_id, request_body)
Add users to the STP user group
Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDrequest_body= [[1,2,3]] # list[int] | User IDtry:
# Add users to the STP user groupapi_response=api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->add_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
request_body list[int] User ID Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: application/json
HTTP response details
Status code Description Response headers
200 User added successfully, returning current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
delete_stp_group_users
list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
Delete users from the STP user group
Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
stp_id=1# int | STP Group IDuser_id=1# int | STP user IDs, multiple IDs can be separated by commastry:
# Delete users from the STP user groupapi_response=api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->delete_stp_group_users: %s\n"%e)
Parameters
Name Type Description Notes
stp_id int STP Group ID 
user_id int STP user IDs, multiple IDs can be separated by commas Return type
list[StpGroupUser]
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Users deleted successfully, returns current users in the STP group -[Back to top][Back to API list][Back to Model list][Back to README]
get_debit_fee
DebitFee get_debit_fee()
Query GT fee deduction configuration
Query the GT fee deduction configuration for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
try:
# Query GT fee deduction configurationapi_response=api_instance.get_debit_fee()
print(api_response)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->get_debit_fee: %s\n"%e)
Parameters
This endpoint does not need any parameter.
Return type
DebitFee
Authorization
apiv4
HTTP request headers
Content-Type: Not defined
Accept: application/json
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
set_debit_fee
set_debit_fee(debit_fee)
Configure GT fee deduction
Enable or disable GT fee deduction for the current account
Example
Api Key Authentication (apiv4):
from __future__ importprint_functionimportgate_apifromgate_api.exceptionsimportApiException, GateApiException# Defining the host is optional and defaults to https://api.gateio.ws/api/v4# See configuration.py for a list of all supported configuration parameters.# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure APIv4 key authorizationconfiguration=gate_api.Configuration(
host="https://api.gateio.ws/api/v4",
key="YOU_API_KEY",
secret="YOUR_API_SECRET"
)
api_client=gate_api.ApiClient(configuration)
# Create an instance of the API classapi_instance=gate_api.AccountApi(api_client)
debit_fee=gate_api.DebitFee() # DebitFee | try:
# Configure GT fee deductionapi_instance.set_debit_fee(debit_fee)
exceptGateApiExceptionasex:
print("Gate api exception, label: %s, message: %s\n"% (ex.label, ex.message))
exceptApiExceptionase:
print("Exception when calling AccountApi->set_debit_fee: %s\n"%e)
Parameters
Name Type Description Notes
debit_fee DebitFee Return type
void (empty response body)
Authorization
apiv4
HTTP request headers
Content-Type: application/json
Accept: Not defined
HTTP response details
Status code Description Response headers
200 Success -[Back to top][Back to API list][Back to Model list][Back to README]
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

AccountApi.md

Latest commit

History

AccountApi.md

File metadata and controls

gate_api.AccountApi

get_account_detail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_account_main_keys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_account_rate_limit

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_stp_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_stp_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_stp_groups_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_stp_group_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_stp_group_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_debit_fee

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_debit_fee

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree