Skip to content

Commit 2fafaa2

Browse files
revilwangrevilwang
committed
release 4.34.0
1 parent 92e2d84 commit 2fafaa2

82 files changed

Lines changed: 6579 additions & 371 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 47 additions & 14 deletions
Large diffs are not rendered by default.

‎docs/ApiV4KeyPerm.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApiV4KeyPerm
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | Permission name (all permissions will be removed if no value is passed) - wallet: wallet - spot: spot/margin - futures: perpetual contract - delivery: delivery - earn: earn - options: options | [optional]
7+
**read_only** | **bool** | read only | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/BatchFuturesOrder.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# BatchFuturesOrder
2+
3+
Futures order details
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**succeeded** | **bool** | Whether the batch of orders succeeded | [optional]
8+
**label** | **str** | Error label, only exists if execution fails | [optional]
9+
**detail** | **str** | Error detail, only present if execution failed and details need to be given | [optional]
10+
**id** | **int** | Futures order ID | [optional] [readonly]
11+
**user** | **int** | User ID | [optional] [readonly]
12+
**create_time** | **float** | Creation time of order | [optional] [readonly]
13+
**finish_time** | **float** | Order finished time. Not returned if order is open | [optional] [readonly]
14+
**finish_as** | **str** | 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 of position close | [optional] [readonly]
15+
**status** | **str** | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly]
16+
**contract** | **str** | Futures contract | [optional]
17+
**size** | **int** | Order size. Specify positive number to make a bid, and negative number to ask | [optional]
18+
**iceberg** | **int** | Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size | [optional]
19+
**price** | **str** | Order price. 0 for market order with `tif` set as `ioc` | [optional]
20+
**close** | **bool** | Set as `true` to close the position, with `size` set to 0 | [optional] [default to False]
21+
**is_close** | **bool** | Is the order to close position | [optional] [readonly]
22+
**reduce_only** | **bool** | Set as `true` to be reduce-only order | [optional] [default to False]
23+
**is_reduce_only** | **bool** | Is the order reduce-only | [optional] [readonly]
24+
**is_liq** | **bool** | Is the order for liquidation | [optional] [readonly]
25+
**tif** | **str** | 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] [default to 'gtc']
26+
**left** | **int** | Size left to be traded | [optional] [readonly]
27+
**fill_price** | **str** | Fill price of the order | [optional] [readonly]
28+
**text** | **str** | 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]
29+
**tkfr** | **str** | Taker fee | [optional] [readonly]
30+
**mkfr** | **str** | Maker fee | [optional] [readonly]
31+
**refu** | **int** | Reference user ID | [optional] [readonly]
32+
**auto_size** | **str** | Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 | [optional]
33+
34+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
35+
36+

‎docs/Contract.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contract
22

3-
Contract detail. USD value per contract: - USDT settled contracts： `quanto_multiplier x token price` - BTC settled contracts：`quanto_multiplier x BTC price x token price`
3+
Futures contract details
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------

‎docs/CountdownCancelAllFuturesTask.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CountdownCancelAllFuturesTask
2+
3+
Countdown cancel task detail
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
8+
**contract** | **str** | Futures contract | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/CountdownCancelAllSpotTask.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CountdownCancelAllSpotTask
2+
3+
Countdown cancel task detail
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
8+
**currency_pair** | **str** | Currency pair | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/DeliveryApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Method | HTTP request | Description
3030
[**list_price_triggered_delivery_orders**](DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | List all auto orders
3131
[**create_price_triggered_delivery_order**](DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order
3232
[**cancel_price_triggered_delivery_order_list**](DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all open orders
33-
[**get_price_triggered_delivery_order**](DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a single order
33+
[**get_price_triggered_delivery_order**](DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order
3434
[**cancel_price_triggered_delivery_order**](DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order
3535

3636

@@ -1846,7 +1846,7 @@ Name | Type | Description | Notes
18461846
# **get_price_triggered_delivery_order**
18471847
> FuturesPriceTriggeredOrder get_price_triggered_delivery_order(settle, order_id)
18481848
1849-
Get a single order
1849+
Get a price-triggered order
18501850

18511851
### Example
18521852

@@ -1876,7 +1876,7 @@ settle = 'usdt' # str | Settle currency
18761876
order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
18771877

18781878
try:
1879-
# Get a single order
1879+
# Get a price-triggered order
18801880
api_response = api_instance.get_price_triggered_delivery_order(settle, order_id)
18811881
print(api_response)
18821882
except GateApiException as ex:

‎docs/FuturesAccount.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**total** | **str** | total = position_margin + order_margin + available | [optional]
6+
**total** | **str** | 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]
77
**unrealised_pnl** | **str** | Unrealized PNL | [optional]
88
**position_margin** | **str** | Position margin | [optional]
99
**order_margin** | **str** | Order margin of unfinished orders | [optional]

0 commit comments

Comments
 (0)