Skip to content

Commit bc2a0ff

Browse files
author
gateio
committed
update to v6.104.3
1 parent 5e8c7a6 commit bc2a0ff

File tree

545 files changed

+6618
-6615
lines changed

Some content is hidden

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

545 files changed

+6618
-6615
lines changed

README.md

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

api/accountApi.ts

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Gate API
3-
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
3+
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
44
*
55
* Contact: support@mail.gate.com
66
*
@@ -36,7 +36,7 @@ export class AccountApi {
3636

3737
/**
3838
*
39-
* @summary Get account detail.
39+
* @summary Retrieve user account information
4040
*/
4141
public async getAccountDetail(): Promise<{ response: AxiosResponse; body: AccountDetail }> {
4242
const localVarPath = this.client.basePath + '/account/detail';
@@ -63,7 +63,7 @@ export class AccountApi {
6363

6464
/**
6565
*
66-
* @summary Get user transaction rate limit information.
66+
* @summary Get user transaction rate limit information
6767
*/
6868
public async getAccountRateLimit(): Promise<{ response: AxiosResponse; body: Array<AccountRateLimit> }> {
6969
const localVarPath = this.client.basePath + '/account/rate_limit';
@@ -89,10 +89,10 @@ export class AccountApi {
8989
}
9090

9191
/**
92-
* Retrieve the list of STP groups created by the main account user only.
93-
* @summary List STP Groups.
92+
* Only query STP user groups created by the current main account
93+
* @summary Query STP user groups created by the user
9494
* @param opts Optional parameters
95-
* @param opts.name Perform a fuzzy search based on the name.
95+
* @param opts.name Fuzzy search by name
9696
*/
9797
public async listSTPGroups(opts: { name?: string }): Promise<{ response: AxiosResponse; body: Array<StpGroup> }> {
9898
const localVarPath = this.client.basePath + '/account/stp_groups';
@@ -123,8 +123,8 @@ export class AccountApi {
123123
}
124124

125125
/**
126-
* Only the main account is allowed to create a new STP user group.
127-
* @summary Create STP Group.
126+
* Only the main account is allowed to create a new STP user group
127+
* @summary Create STP user group
128128
* @param stpGroup
129129
*/
130130
public async createSTPGroup(stpGroup: StpGroup): Promise<{ response: AxiosResponse; body: StpGroup }> {
@@ -157,9 +157,9 @@ export class AccountApi {
157157
}
158158

159159
/**
160-
* Only the main account that created this STP group can query the account.
161-
* @summary List users of the STP group.
162-
* @param stpId STP Group ID.
160+
* Only the main account that created this STP group can query the account ID list in the current STP group
161+
* @summary Query users in the STP user group
162+
* @param stpId STP Group ID
163163
*/
164164
public async listSTPGroupsUsers(stpId: number): Promise<{ response: AxiosResponse; body: Array<StpGroupUser> }> {
165165
const localVarPath =
@@ -192,10 +192,10 @@ export class AccountApi {
192192
}
193193

194194
/**
195-
* - 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
196-
* @summary Add users to the STP group.
197-
* @param stpId STP Group ID.
198-
* @param requestBody User ID.
195+
* - 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
196+
* @summary Add users to the STP user group
197+
* @param stpId STP Group ID
198+
* @param requestBody User ID
199199
*/
200200
public async addSTPGroupUsers(
201201
stpId: number,
@@ -238,9 +238,9 @@ export class AccountApi {
238238

239239
/**
240240
* - 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
241-
* @summary Delete the user in the STP group.
242-
* @param stpId STP Group ID.
243-
* @param userId STP user ID, multiple can be separated by commas.
241+
* @summary Delete users from the STP user group
242+
* @param stpId STP Group ID
243+
* @param userId STP user IDs, multiple IDs can be separated by commas
244244
*/
245245
public async deleteSTPGroupUsers(
246246
stpId: number,
@@ -283,8 +283,8 @@ export class AccountApi {
283283
}
284284

285285
/**
286-
* Query the current GT deduction configuration for the account.
287-
* @summary Query GT deduction configuration.
286+
* Query the GT fee deduction configuration for the current account
287+
* @summary Query GT fee deduction configuration
288288
*/
289289
public async getDebitFee(): Promise<{ response: AxiosResponse; body: DebitFee }> {
290290
const localVarPath = this.client.basePath + '/account/debit_fee';
@@ -310,8 +310,8 @@ export class AccountApi {
310310
}
311311

312312
/**
313-
* Enable or disable GT deduction for the current account.
314-
* @summary Set GT deduction.
313+
* Enable or disable GT fee deduction for the current account
314+
* @summary Configure GT fee deduction
315315
* @param debitFee
316316
*/
317317
public async setDebitFee(debitFee: DebitFee): Promise<{ response: AxiosResponse; body?: any }> {

api/apiClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Gate API
3-
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
3+
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
44
*
55
* Contact: support@mail.gate.com
66
*

api/collateralLoanApi.ts

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Gate API
3-
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
3+
* Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
44
*
55
* Contact: support@mail.gate.com
66
*
@@ -42,12 +42,12 @@ export class CollateralLoanApi {
4242

4343
/**
4444
*
45-
* @summary List Orders.
45+
* @summary Query collateral loan order list
4646
* @param opts Optional parameters
47-
* @param opts.page Page number.
48-
* @param opts.limit Maximum number of records to be returned in a single list.
49-
* @param opts.collateralCurrency Collateral.
50-
* @param opts.borrowCurrency Borrowed currency.
47+
* @param opts.page Page number
48+
* @param opts.limit Maximum number of records returned in a single list
49+
* @param opts.collateralCurrency Collateral currency
50+
* @param opts.borrowCurrency Borrowed currency
5151
*/
5252
public async listCollateralLoanOrders(opts: {
5353
page?: number;
@@ -99,7 +99,7 @@ export class CollateralLoanApi {
9999

100100
/**
101101
*
102-
* @summary Place order.
102+
* @summary Place collateral loan order
103103
* @param createCollateralOrder
104104
*/
105105
public async createCollateralLoan(
@@ -137,8 +137,8 @@ export class CollateralLoanApi {
137137

138138
/**
139139
*
140-
* @summary Get a single order.
141-
* @param orderId Order ID returned on successful order creation.
140+
* @summary Query single order details
141+
* @param orderId Order ID returned when order is successfully created
142142
*/
143143
public async getCollateralLoanOrderDetail(
144144
orderId: number,
@@ -176,7 +176,7 @@ export class CollateralLoanApi {
176176

177177
/**
178178
*
179-
* @summary Repayment.
179+
* @summary Collateral loan repayment
180180
* @param repayLoan
181181
*/
182182
public async repayCollateralLoan(repayLoan: RepayLoan): Promise<{ response: AxiosResponse; body: RepayResp }> {
@@ -210,15 +210,15 @@ export class CollateralLoanApi {
210210

211211
/**
212212
*
213-
* @summary Repayment history.
214-
* @param source Operation type: repay - Regular repayment, liquidate - Liquidation.
213+
* @summary Query collateral loan repayment records
214+
* @param source Operation type: repay - Regular repayment, liquidate - Liquidation
215215
* @param opts Optional parameters
216-
* @param opts.borrowCurrency Borrowed currency.
217-
* @param opts.collateralCurrency Collateral.
218-
* @param opts.page Page number.
219-
* @param opts.limit Maximum number of records to be returned in a single list.
220-
* @param opts.from Start timestamp of the query.
221-
* @param opts.to Time range ending, default to current time.
216+
* @param opts.borrowCurrency Borrowed currency
217+
* @param opts.collateralCurrency Collateral currency
218+
* @param opts.page Page number
219+
* @param opts.limit Maximum number of records returned in a single list
220+
* @param opts.from Start timestamp for the query
221+
* @param opts.to End timestamp for the query, defaults to current time if not specified
222222
*/
223223
public async listRepayRecords(
224224
source: string,
@@ -290,14 +290,14 @@ export class CollateralLoanApi {
290290

291291
/**
292292
*
293-
* @summary Query collateral adjustment records.
293+
* @summary Query collateral adjustment records
294294
* @param opts Optional parameters
295-
* @param opts.page Page number.
296-
* @param opts.limit Maximum number of records to be returned in a single list.
297-
* @param opts.from Start timestamp of the query.
298-
* @param opts.to Time range ending, default to current time.
299-
* @param opts.borrowCurrency Borrowed currency.
300-
* @param opts.collateralCurrency Collateral.
295+
* @param opts.page Page number
296+
* @param opts.limit Maximum number of records returned in a single list
297+
* @param opts.from Start timestamp for the query
298+
* @param opts.to End timestamp for the query, defaults to current time if not specified
299+
* @param opts.borrowCurrency Borrowed currency
300+
* @param opts.collateralCurrency Collateral currency
301301
*/
302302
public async listCollateralRecords(opts: {
303303
page?: number;
@@ -359,7 +359,7 @@ export class CollateralLoanApi {
359359

360360
/**
361361
*
362-
* @summary Increase or redeem collateral.
362+
* @summary Increase or redeem collateral
363363
* @param collateralAlign
364364
*/
365365
public async operateCollateral(collateralAlign: CollateralAlign): Promise<{ response: AxiosResponse; body?: any }> {
@@ -386,7 +386,7 @@ export class CollateralLoanApi {
386386

387387
/**
388388
*
389-
* @summary Query the total borrowing and collateral amount for the user.
389+
* @summary Query user\'s total borrowing and collateral amount
390390
*/
391391
public async getUserTotalAmount(): Promise<{ response: AxiosResponse; body: UserTotalAmount }> {
392392
const localVarPath = this.client.basePath + '/loan/collateral/total_amount';
@@ -413,9 +413,9 @@ export class CollateralLoanApi {
413413

414414
/**
415415
*
416-
* @summary Query user\'s collateralization ratio.
417-
* @param collateralCurrency Collateral.
418-
* @param borrowCurrency Borrowed currency.
416+
* @summary Query user\'s collateralization ratio and remaining borrowable currencies
417+
* @param collateralCurrency Collateral currency
418+
* @param borrowCurrency Borrowed currency
419419
*/
420420
public async getUserLtvInfo(
421421
collateralCurrency: string,
@@ -459,9 +459,9 @@ export class CollateralLoanApi {
459459

460460
/**
461461
*
462-
* @summary Query supported borrowing and collateral currencies.
462+
* @summary Query supported borrowing and collateral currencies
463463
* @param opts Optional parameters
464-
* @param opts.loanCurrency The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies.
464+
* @param opts.loanCurrency Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency
465465
*/
466466
public async listCollateralCurrencies(opts: {
467467
loanCurrency?: string;

0 commit comments

Comments
 (0)