@@ -4,22 +4,22 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
44
55Method | HTTP request | Description
66------------- | ------------- | -------------
7- [ ** getAccountDetail** ] ( AccountApi.md#getAccountDetail ) | ** GET** /account/detail | Get account detail.
8- [ ** getAccountRateLimit** ] ( AccountApi.md#getAccountRateLimit ) | ** GET** /account/rate_limit | Get user transaction rate limit information.
9- [ ** listSTPGroups** ] ( AccountApi.md#listSTPGroups ) | ** GET** /account/stp_groups | List STP Groups.
10- [ ** createSTPGroup** ] ( AccountApi.md#createSTPGroup ) | ** POST** /account/stp_groups | Create STP Group.
11- [ ** listSTPGroupsUsers** ] ( AccountApi.md#listSTPGroupsUsers ) | ** GET** /account/stp_groups/{stp_id}/users | List users of the STP group.
12- [ ** addSTPGroupUsers** ] ( AccountApi.md#addSTPGroupUsers ) | ** POST** /account/stp_groups/{stp_id}/users | Add users to the STP group.
13- [ ** deleteSTPGroupUsers** ] ( AccountApi.md#deleteSTPGroupUsers ) | ** DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group.
14- [ ** getDebitFee** ] ( AccountApi.md#getDebitFee ) | ** GET** /account/debit_fee | Query GT deduction configuration.
15- [ ** setDebitFee** ] ( AccountApi.md#setDebitFee ) | ** POST** /account/debit_fee | Set GT deduction.
7+ [ ** getAccountDetail** ] ( AccountApi.md#getAccountDetail ) | ** GET** /account/detail | Retrieve user account information
8+ [ ** getAccountRateLimit** ] ( AccountApi.md#getAccountRateLimit ) | ** GET** /account/rate_limit | Get user transaction rate limit information
9+ [ ** listSTPGroups** ] ( AccountApi.md#listSTPGroups ) | ** GET** /account/stp_groups | Query STP user groups created by the user
10+ [ ** createSTPGroup** ] ( AccountApi.md#createSTPGroup ) | ** POST** /account/stp_groups | Create STP user group
11+ [ ** listSTPGroupsUsers** ] ( AccountApi.md#listSTPGroupsUsers ) | ** GET** /account/stp_groups/{stp_id}/users | Query users in the STP user group
12+ [ ** addSTPGroupUsers** ] ( AccountApi.md#addSTPGroupUsers ) | ** POST** /account/stp_groups/{stp_id}/users | Add users to the STP user group
13+ [ ** deleteSTPGroupUsers** ] ( AccountApi.md#deleteSTPGroupUsers ) | ** DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group
14+ [ ** getDebitFee** ] ( AccountApi.md#getDebitFee ) | ** GET** /account/debit_fee | Query GT fee deduction configuration
15+ [ ** setDebitFee** ] ( AccountApi.md#setDebitFee ) | ** POST** /account/debit_fee | Configure GT fee deduction
1616
1717
1818<a name =" getAccountDetail " ></a >
1919# ** getAccountDetail**
2020> AccountDetail getAccountDetail()
2121
22- Get account detail.
22+ Retrieve user account information
2323
2424### Example
2525
@@ -77,13 +77,13 @@ This endpoint does not need any parameter.
7777### HTTP response details
7878| Status code | Description | Response headers |
7979| -------------| -------------| ------------------|
80- ** 200** | Successful. | - |
80+ ** 200** | Successfully retrieved | - |
8181
8282<a name =" getAccountRateLimit " ></a >
8383# ** getAccountRateLimit**
8484> List< ; AccountRateLimit> ; getAccountRateLimit()
8585
86- Get user transaction rate limit information.
86+ Get user transaction rate limit information
8787
8888### Example
8989
@@ -141,15 +141,15 @@ This endpoint does not need any parameter.
141141### HTTP response details
142142| Status code | Description | Response headers |
143143| -------------| -------------| ------------------|
144- ** 200** | Successful. | - |
144+ ** 200** | Successfully retrieved | - |
145145
146146<a name =" listSTPGroups " ></a >
147147# ** listSTPGroups**
148148> List< ; StpGroup> ; listSTPGroups().name(name).execute();
149149
150- List STP Groups.
150+ Query STP user groups created by the user
151151
152- Retrieve the list of STP groups created by the main account user only.
152+ Only query STP user groups created by the current main account
153153
154154### Example
155155
@@ -172,7 +172,7 @@ public class Example {
172172 defaultClient. setApiKeySecret(" YOUR_API_KEY" , " YOUR_API_SECRET" );
173173
174174 AccountApi apiInstance = new AccountApi (defaultClient);
175- String name = " group" ; // String | Perform a fuzzy search based on the name.
175+ String name = " group" ; // String | Fuzzy search by name
176176 try {
177177 List<StpGroup > result = apiInstance. listSTPGroups()
178178 .name(name)
@@ -195,7 +195,7 @@ public class Example {
195195
196196Name | Type | Description | Notes
197197------------- | ------------- | ------------- | -------------
198- ** name** | ** String** | Perform a fuzzy search based on the name. | [ optional]
198+ ** name** | ** String** | Fuzzy search by name | [ optional]
199199
200200### Return type
201201
@@ -213,15 +213,15 @@ Name | Type | Description | Notes
213213### HTTP response details
214214| Status code | Description | Response headers |
215215| -------------| -------------| ------------------|
216- ** 200** | List retrieved. | - |
216+ ** 200** | List retrieved successfully | - |
217217
218218<a name =" createSTPGroup " ></a >
219219# ** createSTPGroup**
220220> StpGroup createSTPGroup(stpGroup)
221221
222- Create STP Group.
222+ Create STP user group
223223
224- Only the main account is allowed to create a new STP user group.
224+ Only the main account is allowed to create a new STP user group
225225
226226### Example
227227
@@ -283,15 +283,15 @@ Name | Type | Description | Notes
283283### HTTP response details
284284| Status code | Description | Response headers |
285285| -------------| -------------| ------------------|
286- ** 200** | User added successfully. Returning the current users within the STP group. | - |
286+ ** 200** | User added successfully, returning current users in the STP group | - |
287287
288288<a name =" listSTPGroupsUsers " ></a >
289289# ** listSTPGroupsUsers**
290290> List< ; StpGroupUser> ; listSTPGroupsUsers(stpId)
291291
292- List users of the STP group.
292+ Query users in the STP user group
293293
294- Only the main account that created this STP group can query the account.
294+ Only the main account that created this STP group can query the account ID list in the current STP group
295295
296296### Example
297297
@@ -314,7 +314,7 @@ public class Example {
314314 defaultClient. setApiKeySecret(" YOUR_API_KEY" , " YOUR_API_SECRET" );
315315
316316 AccountApi apiInstance = new AccountApi (defaultClient);
317- Long stpId = 1L ; // Long | STP Group ID.
317+ Long stpId = 1L ; // Long | STP Group ID
318318 try {
319319 List<StpGroupUser > result = apiInstance. listSTPGroupsUsers(stpId);
320320 System . out. println(result);
@@ -335,7 +335,7 @@ public class Example {
335335
336336Name | Type | Description | Notes
337337------------- | ------------- | ------------- | -------------
338- ** stpId** | ** Long** | STP Group ID. |
338+ ** stpId** | ** Long** | STP Group ID |
339339
340340### Return type
341341
@@ -353,15 +353,15 @@ Name | Type | Description | Notes
353353### HTTP response details
354354| Status code | Description | Response headers |
355355| -------------| -------------| ------------------|
356- ** 200** | List retrieved. | - |
356+ ** 200** | List retrieved successfully | - |
357357
358358<a name =" addSTPGroupUsers " ></a >
359359# ** addSTPGroupUsers**
360360> List< ; StpGroupUser> ; addSTPGroupUsers(stpId, requestBody)
361361
362- Add users to the STP group.
362+ Add users to the STP user group
363363
364- - 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
364+ - 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
365365
366366### Example
367367
@@ -384,8 +384,8 @@ public class Example {
384384 defaultClient. setApiKeySecret(" YOUR_API_KEY" , " YOUR_API_SECRET" );
385385
386386 AccountApi apiInstance = new AccountApi (defaultClient);
387- Long stpId = 1L ; // Long | STP Group ID.
388- List<Long > requestBody = Arrays . asList(); // List<Long> | User ID.
387+ Long stpId = 1L ; // Long | STP Group ID
388+ List<Long > requestBody = Arrays . asList(); // List<Long> | User ID
389389 try {
390390 List<StpGroupUser > result = apiInstance. addSTPGroupUsers(stpId, requestBody);
391391 System . out. println(result);
@@ -406,8 +406,8 @@ public class Example {
406406
407407Name | Type | Description | Notes
408408------------- | ------------- | ------------- | -------------
409- ** stpId** | ** Long** | STP Group ID. |
410- ** requestBody** | [ ** List< ; Long> ; ** ] ( Long.md ) | User ID. |
409+ ** stpId** | ** Long** | STP Group ID |
410+ ** requestBody** | [ ** List< ; Long> ; ** ] ( Long.md ) | User ID |
411411
412412### Return type
413413
@@ -425,13 +425,13 @@ Name | Type | Description | Notes
425425### HTTP response details
426426| Status code | Description | Response headers |
427427| -------------| -------------| ------------------|
428- ** 200** | User added successfully. Returning the current users within the STP group. | - |
428+ ** 200** | User added successfully, returning current users in the STP group | - |
429429
430430<a name =" deleteSTPGroupUsers " ></a >
431431# ** deleteSTPGroupUsers**
432432> List< ; StpGroupUser> ; deleteSTPGroupUsers(stpId, userId)
433433
434- Delete the user in the STP group.
434+ Delete users from the STP user group
435435
436436- 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
437437
@@ -456,8 +456,8 @@ public class Example {
456456 defaultClient. setApiKeySecret(" YOUR_API_KEY" , " YOUR_API_SECRET" );
457457
458458 AccountApi apiInstance = new AccountApi (defaultClient);
459- Long stpId = 1L ; // Long | STP Group ID.
460- Long userId = 1L ; // Long | STP user ID , multiple can be separated by commas.
459+ Long stpId = 1L ; // Long | STP Group ID
460+ Long userId = 1L ; // Long | STP user IDs , multiple IDs can be separated by commas
461461 try {
462462 List<StpGroupUser > result = apiInstance. deleteSTPGroupUsers(stpId, userId);
463463 System . out. println(result);
@@ -478,8 +478,8 @@ public class Example {
478478
479479Name | Type | Description | Notes
480480------------- | ------------- | ------------- | -------------
481- ** stpId** | ** Long** | STP Group ID. |
482- ** userId** | ** Long** | STP user ID , multiple can be separated by commas. |
481+ ** stpId** | ** Long** | STP Group ID |
482+ ** userId** | ** Long** | STP user IDs , multiple IDs can be separated by commas |
483483
484484### Return type
485485
@@ -497,15 +497,15 @@ Name | Type | Description | Notes
497497### HTTP response details
498498| Status code | Description | Response headers |
499499| -------------| -------------| ------------------|
500- ** 200** | Success. | - |
500+ ** 200** | Users deleted successfully, returns current users in the STP group | - |
501501
502502<a name =" getDebitFee " ></a >
503503# ** getDebitFee**
504504> DebitFee getDebitFee()
505505
506- Query GT deduction configuration.
506+ Query GT fee deduction configuration
507507
508- Query the current GT deduction configuration for the account.
508+ Query the GT fee deduction configuration for the current account
509509
510510### Example
511511
@@ -563,15 +563,15 @@ This endpoint does not need any parameter.
563563### HTTP response details
564564| Status code | Description | Response headers |
565565| -------------| -------------| ------------------|
566- ** 200** | Success. | - |
566+ ** 200** | Success | - |
567567
568568<a name =" setDebitFee " ></a >
569569# ** setDebitFee**
570570> setDebitFee(debitFee)
571571
572- Set GT deduction.
572+ Configure GT fee deduction
573573
574- Enable or disable GT deduction for the current account.
574+ Enable or disable GT fee deduction for the current account
575575
576576### Example
577577
@@ -632,5 +632,5 @@ null (empty response body)
632632### HTTP response details
633633| Status code | Description | Response headers |
634634| -------------| -------------| ------------------|
635- ** 200** | Success. | - |
635+ ** 200** | Success | - |
636636
0 commit comments