Skip to content

Commit 744afea

Browse files
author
gateio
committed
update to v6.104.3
1 parent 6cead1c commit 744afea

File tree

549 files changed

+9712
-9713
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

549 files changed

+9712
-9713
lines changed

README.md

Lines changed: 283 additions & 284 deletions
Large diffs are not rendered by default.

docs/AccountApi.md

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**get_account_detail**](AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail.
8-
[**get_account_rate_limit**](AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information.
9-
[**list_stp_groups**](AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | List STP Groups.
10-
[**create_stp_group**](AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP Group.
11-
[**list_stp_groups_users**](AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group.
12-
[**add_stp_group_users**](AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group.
13-
[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group.
14-
[**get_debit_fee**](AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT deduction configuration.
15-
[**set_debit_fee**](AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Set GT deduction.
7+
[**get_account_detail**](AccountApi.md#get_account_detail) | **GET** /account/detail | Retrieve user account information
8+
[**get_account_rate_limit**](AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information
9+
[**list_stp_groups**](AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | Query STP user groups created by the user
10+
[**create_stp_group**](AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP user group
11+
[**list_stp_groups_users**](AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | Query users in the STP user group
12+
[**add_stp_group_users**](AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP user group
13+
[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group
14+
[**get_debit_fee**](AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT fee deduction configuration
15+
[**set_debit_fee**](AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Configure GT fee deduction
1616

1717

1818
# **get_account_detail**
1919
> AccountDetail get_account_detail()
2020
21-
Get account detail.
21+
Retrieve user account information
2222

2323
### Example
2424

@@ -46,7 +46,7 @@ api_client = gate_api.ApiClient(configuration)
4646
api_instance = gate_api.AccountApi(api_client)
4747

4848
try:
49-
# Get account detail.
49+
# Retrieve user account information
5050
api_response = api_instance.get_account_detail()
5151
print(api_response)
5252
except GateApiException as ex:
@@ -74,14 +74,14 @@ This endpoint does not need any parameter.
7474
### HTTP response details
7575
| Status code | Description | Response headers |
7676
|-------------|-------------|------------------|
77-
**200** | Successful. | - |
77+
**200** | Successfully retrieved | - |
7878

7979
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
8080

8181
# **get_account_rate_limit**
8282
> list[AccountRateLimit] get_account_rate_limit()
8383
84-
Get user transaction rate limit information.
84+
Get user transaction rate limit information
8585

8686
### Example
8787

@@ -109,7 +109,7 @@ api_client = gate_api.ApiClient(configuration)
109109
api_instance = gate_api.AccountApi(api_client)
110110

111111
try:
112-
# Get user transaction rate limit information.
112+
# Get user transaction rate limit information
113113
api_response = api_instance.get_account_rate_limit()
114114
print(api_response)
115115
except GateApiException as ex:
@@ -137,16 +137,16 @@ This endpoint does not need any parameter.
137137
### HTTP response details
138138
| Status code | Description | Response headers |
139139
|-------------|-------------|------------------|
140-
**200** | Successful. | - |
140+
**200** | Successfully retrieved | - |
141141

142142
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
143143

144144
# **list_stp_groups**
145145
> list[StpGroup] list_stp_groups(name=name)
146146
147-
List STP Groups.
147+
Query STP user groups created by the user
148148

149-
Retrieve the list of STP groups created by the main account user only.
149+
Only query STP user groups created by the current main account
150150

151151
### Example
152152

@@ -172,10 +172,10 @@ configuration = gate_api.Configuration(
172172
api_client = gate_api.ApiClient(configuration)
173173
# Create an instance of the API class
174174
api_instance = gate_api.AccountApi(api_client)
175-
name = 'group' # str | Perform a fuzzy search based on the name. (optional)
175+
name = 'group' # str | Fuzzy search by name (optional)
176176

177177
try:
178-
# List STP Groups.
178+
# Query STP user groups created by the user
179179
api_response = api_instance.list_stp_groups(name=name)
180180
print(api_response)
181181
except GateApiException as ex:
@@ -188,7 +188,7 @@ except ApiException as e:
188188

189189
Name | Type | Description | Notes
190190
------------- | ------------- | ------------- | -------------
191-
**name** | **str**| Perform a fuzzy search based on the name. | [optional]
191+
**name** | **str**| Fuzzy search by name | [optional]
192192

193193
### Return type
194194

@@ -206,16 +206,16 @@ Name | Type | Description | Notes
206206
### HTTP response details
207207
| Status code | Description | Response headers |
208208
|-------------|-------------|------------------|
209-
**200** | List retrieved. | - |
209+
**200** | List retrieved successfully | - |
210210

211211
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
212212

213213
# **create_stp_group**
214214
> StpGroup create_stp_group(stp_group)
215215
216-
Create STP Group.
216+
Create STP user group
217217

218-
Only the main account is allowed to create a new STP user group.
218+
Only the main account is allowed to create a new STP user group
219219

220220
### Example
221221

@@ -244,7 +244,7 @@ api_instance = gate_api.AccountApi(api_client)
244244
stp_group = gate_api.StpGroup() # StpGroup |
245245

246246
try:
247-
# Create STP Group.
247+
# Create STP user group
248248
api_response = api_instance.create_stp_group(stp_group)
249249
print(api_response)
250250
except GateApiException as ex:
@@ -275,16 +275,16 @@ Name | Type | Description | Notes
275275
### HTTP response details
276276
| Status code | Description | Response headers |
277277
|-------------|-------------|------------------|
278-
**200** | User added successfully. Returning the current users within the STP group. | - |
278+
**200** | User added successfully, returning current users in the STP group | - |
279279

280280
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
281281

282282
# **list_stp_groups_users**
283283
> list[StpGroupUser] list_stp_groups_users(stp_id)
284284
285-
List users of the STP group.
285+
Query users in the STP user group
286286

287-
Only the main account that created this STP group can query the account.
287+
Only the main account that created this STP group can query the account ID list in the current STP group
288288

289289
### Example
290290

@@ -310,10 +310,10 @@ configuration = gate_api.Configuration(
310310
api_client = gate_api.ApiClient(configuration)
311311
# Create an instance of the API class
312312
api_instance = gate_api.AccountApi(api_client)
313-
stp_id = 1 # int | STP Group ID.
313+
stp_id = 1 # int | STP Group ID
314314

315315
try:
316-
# List users of the STP group.
316+
# Query users in the STP user group
317317
api_response = api_instance.list_stp_groups_users(stp_id)
318318
print(api_response)
319319
except GateApiException as ex:
@@ -326,7 +326,7 @@ except ApiException as e:
326326

327327
Name | Type | Description | Notes
328328
------------- | ------------- | ------------- | -------------
329-
**stp_id** | **int**| STP Group ID. |
329+
**stp_id** | **int**| STP Group ID |
330330

331331
### Return type
332332

@@ -344,16 +344,16 @@ Name | Type | Description | Notes
344344
### HTTP response details
345345
| Status code | Description | Response headers |
346346
|-------------|-------------|------------------|
347-
**200** | List retrieved. | - |
347+
**200** | List retrieved successfully | - |
348348

349349
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
350350

351351
# **add_stp_group_users**
352352
> list[StpGroupUser] add_stp_group_users(stp_id, request_body)
353353
354-
Add users to the STP group.
354+
Add users to the STP user group
355355

356-
- Only the master account that created the STP user group is allowed to add users group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted
356+
- 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
357357

358358
### Example
359359

@@ -379,11 +379,11 @@ configuration = gate_api.Configuration(
379379
api_client = gate_api.ApiClient(configuration)
380380
# Create an instance of the API class
381381
api_instance = gate_api.AccountApi(api_client)
382-
stp_id = 1 # int | STP Group ID.
383-
request_body = [[1,2,3]] # list[int] | User ID.
382+
stp_id = 1 # int | STP Group ID
383+
request_body = [[1,2,3]] # list[int] | User ID
384384

385385
try:
386-
# Add users to the STP group.
386+
# Add users to the STP user group
387387
api_response = api_instance.add_stp_group_users(stp_id, request_body)
388388
print(api_response)
389389
except GateApiException as ex:
@@ -396,8 +396,8 @@ except ApiException as e:
396396

397397
Name | Type | Description | Notes
398398
------------- | ------------- | ------------- | -------------
399-
**stp_id** | **int**| STP Group ID. |
400-
**request_body** | [**list[int]**](int.md)| User ID. |
399+
**stp_id** | **int**| STP Group ID |
400+
**request_body** | [**list[int]**](int.md)| User ID |
401401

402402
### Return type
403403

@@ -415,14 +415,14 @@ Name | Type | Description | Notes
415415
### HTTP response details
416416
| Status code | Description | Response headers |
417417
|-------------|-------------|------------------|
418-
**200** | User added successfully. Returning the current users within the STP group. | - |
418+
**200** | User added successfully, returning current users in the STP group | - |
419419

420420
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
421421

422422
# **delete_stp_group_users**
423423
> list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
424424
425-
Delete the user in the STP group.
425+
Delete users from the STP user group
426426

427427
- 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
428428

@@ -450,11 +450,11 @@ configuration = gate_api.Configuration(
450450
api_client = gate_api.ApiClient(configuration)
451451
# Create an instance of the API class
452452
api_instance = gate_api.AccountApi(api_client)
453-
stp_id = 1 # int | STP Group ID.
454-
user_id = 1 # int | STP user ID, multiple can be separated by commas.
453+
stp_id = 1 # int | STP Group ID
454+
user_id = 1 # int | STP user IDs, multiple IDs can be separated by commas
455455

456456
try:
457-
# Delete the user in the STP group.
457+
# Delete users from the STP user group
458458
api_response = api_instance.delete_stp_group_users(stp_id, user_id)
459459
print(api_response)
460460
except GateApiException as ex:
@@ -467,8 +467,8 @@ except ApiException as e:
467467

468468
Name | Type | Description | Notes
469469
------------- | ------------- | ------------- | -------------
470-
**stp_id** | **int**| STP Group ID. |
471-
**user_id** | **int**| STP user ID, multiple can be separated by commas. |
470+
**stp_id** | **int**| STP Group ID |
471+
**user_id** | **int**| STP user IDs, multiple IDs can be separated by commas |
472472

473473
### Return type
474474

@@ -486,16 +486,16 @@ Name | Type | Description | Notes
486486
### HTTP response details
487487
| Status code | Description | Response headers |
488488
|-------------|-------------|------------------|
489-
**200** | Success. | - |
489+
**200** | Users deleted successfully, returns current users in the STP group | - |
490490

491491
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
492492

493493
# **get_debit_fee**
494494
> DebitFee get_debit_fee()
495495
496-
Query GT deduction configuration.
496+
Query GT fee deduction configuration
497497

498-
Query the current GT deduction configuration for the account.
498+
Query the GT fee deduction configuration for the current account
499499

500500
### Example
501501

@@ -523,7 +523,7 @@ api_client = gate_api.ApiClient(configuration)
523523
api_instance = gate_api.AccountApi(api_client)
524524

525525
try:
526-
# Query GT deduction configuration.
526+
# Query GT fee deduction configuration
527527
api_response = api_instance.get_debit_fee()
528528
print(api_response)
529529
except GateApiException as ex:
@@ -551,16 +551,16 @@ This endpoint does not need any parameter.
551551
### HTTP response details
552552
| Status code | Description | Response headers |
553553
|-------------|-------------|------------------|
554-
**200** | Success. | - |
554+
**200** | Success | - |
555555

556556
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
557557

558558
# **set_debit_fee**
559559
> set_debit_fee(debit_fee)
560560
561-
Set GT deduction.
561+
Configure GT fee deduction
562562

563-
Enable or disable GT deduction for the current account.
563+
Enable or disable GT fee deduction for the current account
564564

565565
### Example
566566

@@ -589,7 +589,7 @@ api_instance = gate_api.AccountApi(api_client)
589589
debit_fee = gate_api.DebitFee() # DebitFee |
590590

591591
try:
592-
# Set GT deduction.
592+
# Configure GT fee deduction
593593
api_instance.set_debit_fee(debit_fee)
594594
except GateApiException as ex:
595595
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -619,7 +619,7 @@ void (empty response body)
619619
### HTTP response details
620620
| Status code | Description | Response headers |
621621
|-------------|-------------|------------------|
622-
**200** | Success. | - |
622+
**200** | Success | - |
623623

624624
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
625625

docs/AccountBalance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# AccountBalance
22

3-
Total balances calculated with specified currency unit.
3+
Total balances calculated with specified currency unit
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**amount** | **str** | Account total balance amount. | [optional]
8-
**currency** | **str** | Currency. | [optional]
7+
**amount** | **str** | Account total balance amount | [optional]
8+
**currency** | **str** | Currency | [optional]
99
**unrealised_pnl** | **str** | Unrealised_pnl, this field will only appear in futures, options, delivery, and total accounts | [optional]
10-
**borrowed** | **str** | Borrowed,this field will only appear in margin and cross_margin accounts. | [optional]
10+
**borrowed** | **str** | Total borrowed amount, this field will only appear in margin and cross_margin accounts | [optional]
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

docs/AccountDetail.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# AccountDetail
22

3-
Account detail.
3+
Account details
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**ip_whitelist** | **list[str]** | IP whitelist. | [optional]
8-
**currency_pairs** | **list[str]** | CurrencyPair whitelisting. | [optional]
9-
**user_id** | **int** | User ID. | [optional]
10-
**tier** | **int** | User VIP level. | [optional]
7+
**ip_whitelist** | **list[str]** | IP Whitelist | [optional]
8+
**currency_pairs** | **list[str]** | Trading pair whitelist | [optional]
9+
**user_id** | **int** | User ID | [optional]
10+
**tier** | **int** | User VIP level | [optional]
1111
**key** | [**AccountDetailKey**](AccountDetailKey.md) | | [optional]
12-
**copy_trading_role** | **int** | User role: 0 - Normal user, 1 - Copy trading leader, follower, 3 - Both leader and follower | [optional]
12+
**copy_trading_role** | **int** | User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower | [optional]
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1515

docs/AccountDetailKey.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# AccountDetailKey
22

3-
API Key detail.
3+
API Key details
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**mode** | **int** | mode: 1 - classic account 2 - portfolio margin account. | [optional]
7+
**mode** | **int** | Mode: 1 - Classic mode, 2 - Legacy unified mode | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

0 commit comments

Comments
 (0)