|
1 | 1 | /** |
2 | | - * Gate API v4 |
3 | | - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user\'s behalf. |
| 2 | + * 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. |
4 | 4 | * |
5 | 5 | * Contact: support@mail.gate.com |
6 | 6 | * |
@@ -137,7 +137,7 @@ export class DeliveryApi { |
137 | 137 | * @param opts Optional parameters |
138 | 138 | * @param opts.interval Order depth. 0 means no aggregation is applied. default to 0 |
139 | 139 | * @param opts.limit Maximum number of order depth data in asks or bids |
140 | | - * @param opts.withId Whether the order book update ID will be returned. This ID increases by 1 on every order book update |
| 140 | + * @param opts.withId Whether to return depth update ID. This ID increments by 1 each time. |
141 | 141 | */ |
142 | 142 | public async listDeliveryOrderBook( |
143 | 143 | settle: 'usdt', |
@@ -200,7 +200,7 @@ export class DeliveryApi { |
200 | 200 | * @param contract Futures contract |
201 | 201 | * @param opts Optional parameters |
202 | 202 | * @param opts.limit Maximum number of records to be returned in a single list |
203 | | - * @param opts.lastId Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range |
| 203 | + * @param opts.lastId 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 |
204 | 204 | * @param opts.from Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. |
205 | 205 | * @param opts.to Specify end time in Unix seconds, default to current time |
206 | 206 | */ |
@@ -269,9 +269,9 @@ export class DeliveryApi { |
269 | 269 | * @param contract Futures contract |
270 | 270 | * @param opts Optional parameters |
271 | 271 | * @param opts.from Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified |
272 | | - * @param opts.to End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time |
| 272 | + * @param opts.to Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second |
273 | 273 | * @param opts.limit Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. |
274 | | - * @param opts.interval Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 |
| 274 | + * @param opts.interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek |
275 | 275 | */ |
276 | 276 | public async listDeliveryCandlesticks( |
277 | 277 | settle: 'usdt', |
@@ -488,8 +488,8 @@ export class DeliveryApi { |
488 | 488 | * @param settle Settle currency |
489 | 489 | * @param opts Optional parameters |
490 | 490 | * @param opts.limit Maximum number of records to be returned in a single list |
491 | | - * @param opts.from Start timestamp |
492 | | - * @param opts.to End timestamp |
| 491 | + * @param opts.from Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) |
| 492 | + * @param opts.to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp |
493 | 493 | * @param opts.type Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate |
494 | 494 | */ |
495 | 495 | public async listDeliveryAccountBook( |
@@ -636,7 +636,7 @@ export class DeliveryApi { |
636 | 636 | * @summary Update position margin |
637 | 637 | * @param settle Settle currency |
638 | 638 | * @param contract Futures contract |
639 | | - * @param change Margin change. Use positive number to increase margin, negative number otherwise. |
| 639 | + * @param change Margin change amount, positive number increases, negative number |
640 | 640 | */ |
641 | 641 | public async updateDeliveryPositionMargin( |
642 | 642 | settle: 'usdt', |
@@ -823,7 +823,7 @@ export class DeliveryApi { |
823 | 823 | * @param opts.contract Futures contract |
824 | 824 | * @param opts.limit Maximum number of records to be returned in a single list |
825 | 825 | * @param opts.offset List offset, starting from 0 |
826 | | - * @param opts.lastId Specify list staring point using the `id` of last record in previous list-query results |
| 826 | + * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time. |
827 | 827 | * @param opts.countTotal Whether to return total number matched. Default to 0(no return) |
828 | 828 | */ |
829 | 829 | public async listDeliveryOrders( |
@@ -1088,7 +1088,7 @@ export class DeliveryApi { |
1088 | 1088 | * @param opts.order Futures order ID, return related data only if specified |
1089 | 1089 | * @param opts.limit Maximum number of records to be returned in a single list |
1090 | 1090 | * @param opts.offset List offset, starting from 0 |
1091 | | - * @param opts.lastId Specify list staring point using the `id` of last record in previous list-query results |
| 1091 | + * @param opts.lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time. |
1092 | 1092 | * @param opts.countTotal Whether to return total number matched. Default to 0(no return) |
1093 | 1093 | */ |
1094 | 1094 | public async getMyDeliveryTrades( |
|
0 commit comments