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
Copy file name to clipboardExpand all lines: README.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
3
3
Gate API
4
4
5
-
- API version: v4.105.30
6
-
- SDK version: 7.1.30
5
+
- API version: v4.106.0
6
+
- SDK version: 7.2.0
7
7
8
8
Welcome to Gate API
9
9
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.
@@ -52,7 +52,7 @@ Add this dependency to your project's POM:
52
52
<dependency>
53
53
<groupId>io.gate</groupId>
54
54
<artifactId>gate-api</artifactId>
55
-
<version>7.1.30</version>
55
+
<version>7.2.0</version>
56
56
<scope>compile</scope>
57
57
</dependency>
58
58
```
@@ -62,7 +62,7 @@ Add this dependency to your project's POM:
62
62
Add this dependency to your project's build file:
63
63
64
64
```groovy
65
-
compile "io.gate:gate-api:7.1.30"
65
+
compile "io.gate:gate-api:7.2.0"
66
66
```
67
67
68
68
### Others
@@ -75,7 +75,7 @@ mvn clean package
75
75
76
76
Then manually install the following JARs:
77
77
78
-
*`target/gate-api-7.1.30.jar`
78
+
*`target/gate-api-7.2.0.jar`
79
79
*`target/lib/*.jar`
80
80
81
81
To install the API client library to your local Maven repository, simply execute:
**orderId** | **Long** | Order id, order_id and text must contain at least one | [optional]
11
11
**text** | **String** | User-defined order text, at least one of order_id and text must be passed | [optional]
12
-
**size** | **Long** | New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. | [optional]
12
+
**size** | **String** | New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. | [optional]
13
13
**price** | **String** | New order price | [optional]
14
14
**amendText** | **String** | Custom info during order amendment | [optional]
Copy file name to clipboardExpand all lines: docs/BatchFuturesOrder.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,16 @@ Name | Type | Description | Notes
17
17
**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional][readonly]
18
18
**status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: Pending - `finished`: Completed | [optional][readonly]
**size** | **Long** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | [optional]
21
-
**iceberg** | **Long** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional]
20
+
**size** | **String** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | [optional]
21
+
**iceberg** | **String** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional]
22
22
**price** | **String** | Order price. Price of 0 with `tif` set to `ioc` represents a market order. | [optional]
23
23
**close** | **Boolean** | Set as `true` to close the position, with `size` set to 0 | [optional]
24
24
**isClose** | **Boolean** | Is the order to close position | [optional][readonly]
25
25
**reduceOnly** | **Boolean** | Set as `true` to be reduce-only order | [optional]
26
26
**isReduceOnly** | **Boolean** | Is the order reduce-only | [optional][readonly]
27
27
**isLiq** | **Boolean** | Is the order for liquidation | [optional][readonly]
28
28
**tif** | [**TifEnum**](#TifEnum) | Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none | [optional]
**fillPrice** | **String** | Fill price | [optional][readonly]
31
31
**text** | **String** | User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance | [optional]
**riskLimitMax** | **String** | Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits | [optional]
30
-
**orderSizeMin** | **Long** | Minimum order size allowed by the contract | [optional]
31
-
**orderSizeMax** | **Long** | Maximum order size allowed by the contract | [optional]
30
+
**orderSizeMin** | **String** | Minimum order size allowed by the contract | [optional]
31
+
**orderSizeMax** | **String** | Maximum order size allowed by the contract | [optional]
32
32
**orderPriceDeviate** | **String** | Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
33
33
**refDiscountRate** | **String** | Trading fee discount for referred users | [optional]
34
34
**refRebateRate** | **String** | Commission rate for referrers | [optional]
35
35
**orderbookId** | **Long** | Orderbook update ID | [optional]
36
36
**tradeId** | **Long** | Current trade ID | [optional]
**positionSize** | **String** | Current total long position size | [optional]
39
39
**configChangeTime** | **Double** | Last configuration update time | [optional]
40
40
**inDelisting** | **Boolean** | `in_delisting=true` and position_size>0 indicates the contract is in delisting transition period `in_delisting=true` and position_size=0 indicates the contract is delisted | [optional]
41
41
**ordersLimit** | **Integer** | Maximum number of pending orders | [optional]
**total** | **String** | total is the balance after the user's accumulated deposit, withdraw, profit and loss (including realized profit and loss, fund, fee and referral rebate), excluding unrealized profit and loss. total = SUM(history_dnw, history_pnl, history_fee, history_refr, history_fund) | [optional]
**positionMargin** | **String** | Position margin | [optional]
11
+
**orderMargin** | **String** | Order margin of unfinished orders | [optional]
12
+
**available** | **String** | Available amount for transfer or trading, which includes credit limits under the unified account (includes experience funds; experience funds cannot be transferred, so when transferring, the transfer amount must deduct experience funds) | [optional]
13
+
**point** | **String** | Point card amount | [optional]
0 commit comments