Skip to content

Commit 40cb7f4

Browse files
revilwangrevilwang
committed
release 4.82.0
1 parent 03cc882 commit 40cb7f4

File tree

156 files changed

+13860
-261
lines changed

Some content is hidden

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

156 files changed

+13860
-261
lines changed

‎README.md

Lines changed: 63 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/AccountApi.md

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_account_detail**](AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail
8+
[**get_account_rate_limit**](AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information
89
[**list_stp_groups**](AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | List STP Groups
910
[**create_stp_group**](AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP Group
1011
[**list_stp_groups_users**](AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group
1112
[**add_stp_group_users**](AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group
1213
[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group
14+
[**get_debit_fee**](AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT deduction configuration.
15+
[**set_debit_fee**](AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Set GT deduction.
1316

1417

1518
# **get_account_detail**
@@ -75,6 +78,69 @@ This endpoint does not need any parameter.
7578

7679
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
7780

81+
# **get_account_rate_limit**
82+
> list[AccountRateLimit] get_account_rate_limit()
83+
84+
Get user transaction rate limit information
85+
86+
### Example
87+
88+
* Api Key Authentication (apiv4):
89+
```python
90+
from __future__ import print_function
91+
import gate_api
92+
from gate_api.exceptions import ApiException, GateApiException
93+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
94+
# See configuration.py for a list of all supported configuration parameters.
95+
# The client must configure the authentication and authorization parameters
96+
# in accordance with the API server security policy.
97+
# Examples for each auth method are provided below, use the example that
98+
# satisfies your auth use case.
99+
100+
# Configure APIv4 key authorization
101+
configuration = gate_api.Configuration(
102+
host = "https://api.gateio.ws/api/v4",
103+
key = "YOU_API_KEY",
104+
secret = "YOUR_API_SECRET"
105+
)
106+
107+
api_client = gate_api.ApiClient(configuration)
108+
# Create an instance of the API class
109+
api_instance = gate_api.AccountApi(api_client)
110+
111+
try:
112+
# Get user transaction rate limit information
113+
api_response = api_instance.get_account_rate_limit()
114+
print(api_response)
115+
except GateApiException as ex:
116+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
117+
except ApiException as e:
118+
print("Exception when calling AccountApi->get_account_rate_limit: %s\n" % e)
119+
```
120+
121+
### Parameters
122+
This endpoint does not need any parameter.
123+
124+
### Return type
125+
126+
[**list[AccountRateLimit]**](AccountRateLimit.md)
127+
128+
### Authorization
129+
130+
[apiv4](../README.md#apiv4)
131+
132+
### HTTP request headers
133+
134+
- **Content-Type**: Not defined
135+
- **Accept**: application/json
136+
137+
### HTTP response details
138+
| Status code | Description | Response headers |
139+
|-------------|-------------|------------------|
140+
**200** | Successful | - |
141+
142+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
143+
78144
# **list_stp_groups**
79145
> list[StpGroup] list_stp_groups(name=name)
80146
@@ -424,3 +490,136 @@ Name | Type | Description | Notes
424490

425491
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
426492

493+
# **get_debit_fee**
494+
> InlineResponse200 get_debit_fee()
495+
496+
Query GT deduction configuration.
497+
498+
Query the current GT deduction configuration for the account.
499+
500+
### Example
501+
502+
* Api Key Authentication (apiv4):
503+
```python
504+
from __future__ import print_function
505+
import gate_api
506+
from gate_api.exceptions import ApiException, GateApiException
507+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
508+
# See configuration.py for a list of all supported configuration parameters.
509+
# The client must configure the authentication and authorization parameters
510+
# in accordance with the API server security policy.
511+
# Examples for each auth method are provided below, use the example that
512+
# satisfies your auth use case.
513+
514+
# Configure APIv4 key authorization
515+
configuration = gate_api.Configuration(
516+
host = "https://api.gateio.ws/api/v4",
517+
key = "YOU_API_KEY",
518+
secret = "YOUR_API_SECRET"
519+
)
520+
521+
api_client = gate_api.ApiClient(configuration)
522+
# Create an instance of the API class
523+
api_instance = gate_api.AccountApi(api_client)
524+
525+
try:
526+
# Query GT deduction configuration.
527+
api_response = api_instance.get_debit_fee()
528+
print(api_response)
529+
except GateApiException as ex:
530+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
531+
except ApiException as e:
532+
print("Exception when calling AccountApi->get_debit_fee: %s\n" % e)
533+
```
534+
535+
### Parameters
536+
This endpoint does not need any parameter.
537+
538+
### Return type
539+
540+
[**InlineResponse200**](InlineResponse200.md)
541+
542+
### Authorization
543+
544+
[apiv4](../README.md#apiv4)
545+
546+
### HTTP request headers
547+
548+
- **Content-Type**: Not defined
549+
- **Accept**: application/json
550+
551+
### HTTP response details
552+
| Status code | Description | Response headers |
553+
|-------------|-------------|------------------|
554+
**200** | Success | - |
555+
556+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
557+
558+
# **set_debit_fee**
559+
> set_debit_fee(inline_object)
560+
561+
Set GT deduction.
562+
563+
Enable or disable GT deduction for the current account.
564+
565+
### Example
566+
567+
* Api Key Authentication (apiv4):
568+
```python
569+
from __future__ import print_function
570+
import gate_api
571+
from gate_api.exceptions import ApiException, GateApiException
572+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
573+
# See configuration.py for a list of all supported configuration parameters.
574+
# The client must configure the authentication and authorization parameters
575+
# in accordance with the API server security policy.
576+
# Examples for each auth method are provided below, use the example that
577+
# satisfies your auth use case.
578+
579+
# Configure APIv4 key authorization
580+
configuration = gate_api.Configuration(
581+
host = "https://api.gateio.ws/api/v4",
582+
key = "YOU_API_KEY",
583+
secret = "YOUR_API_SECRET"
584+
)
585+
586+
api_client = gate_api.ApiClient(configuration)
587+
# Create an instance of the API class
588+
api_instance = gate_api.AccountApi(api_client)
589+
inline_object = gate_api.InlineObject() # InlineObject |
590+
591+
try:
592+
# Set GT deduction.
593+
api_instance.set_debit_fee(inline_object)
594+
except GateApiException as ex:
595+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
596+
except ApiException as e:
597+
print("Exception when calling AccountApi->set_debit_fee: %s\n" % e)
598+
```
599+
600+
### Parameters
601+
602+
Name | Type | Description | Notes
603+
------------- | ------------- | ------------- | -------------
604+
**inline_object** | [**InlineObject**](InlineObject.md)| |
605+
606+
### Return type
607+
608+
void (empty response body)
609+
610+
### Authorization
611+
612+
[apiv4](../README.md#apiv4)
613+
614+
### HTTP request headers
615+
616+
- **Content-Type**: application/json
617+
- **Accept**: Not defined
618+
619+
### HTTP response details
620+
| Status code | Description | Response headers |
621+
|-------------|-------------|------------------|
622+
**200** | Success | - |
623+
624+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
625+

‎docs/AccountDetail.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**user_id** | **int** | User ID | [optional]
1010
**tier** | **int** | User VIP level | [optional]
1111
**key** | [**AccountDetailKey**](AccountDetailKey.md) | | [optional]
12+
**copy_trading_role** | **int** | User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower | [optional]
1213

1314
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1415

‎docs/AccountRateLimit.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# AccountRateLimit
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#成交比率限频)) | [optional]
7+
**ratio** | **str** | Transaction rate | [optional]
8+
**main_ratio** | **str** | Total transaction ratio of main account | [optional]
9+
**updated_at** | **str** | Update time | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/BatchAmendItem.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**amount** | **str** | trade amount, only one of amount and price can be specified | [optional]
1111
**price** | **str** | trade price, only one of amount and price can be specified | [optional]
1212
**amend_text** | **str** | Custom info during amending order | [optional]
13+
**action_mode** | **str** | Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) | [optional]
1314

1415
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1516

‎docs/BatchAmendOrderReq.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# BatchAmendOrderReq
2+
3+
Modify contract order parameters
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**order_id** | **int** | Order id, order_id and text must contain at least one | [optional]
8+
**text** | **str** | User-defined order text, at least one of order_id and text must be passed | [optional]
9+
**size** | **int** | The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. | [optional]
10+
**price** | **str** | New order price. | [optional]
11+
**amend_text** | **str** | Custom info during amending order | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

‎docs/BatchFuturesOrder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**user** | **int** | User ID | [optional] [readonly]
1212
**create_time** | **float** | Creation time of order | [optional] [readonly]
1313
**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 - stp: cancelled because self trade prevention | [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 - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly]
1515
**status** | **str** | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly]
1616
**contract** | **str** | Futures contract | [optional]
1717
**size** | **int** | Order size. Specify positive number to make a bid, and negative number to ask | [optional]

‎docs/CancelOrderResult.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**currency_pair** | **str** | Order currency pair | [optional]
88
**id** | **str** | Order ID | [optional]
9+
**text** | **str** | Custom order information | [optional]
910
**succeeded** | **bool** | Whether cancellation succeeded | [optional]
1011
**label** | **str** | Error label when failed to cancel the order; emtpy if succeeded | [optional]
1112
**message** | **str** | Error message when failed to cancel the order; empty if succeeded | [optional]

‎docs/Contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Name | Type | Description | Notes
3434
**trade_size** | **int** | Historical accumulated trade size | [optional]
3535
**position_size** | **int** | Current total long position size | [optional]
3636
**config_change_time** | **float** | Last changed time of configuration | [optional]
37-
**in_delisting** | **bool** | Contract is delisting | [optional]
37+
**in_delisting** | **bool** | `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline | [optional]
3838
**orders_limit** | **int** | Maximum number of open orders | [optional]
3939
**enable_bonus** | **bool** | Whether bouns is enabled | [optional]
4040
**enable_credit** | **bool** | Whether portfolio margin account is enabled | [optional]

‎docs/ConvertSmallBalance.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Convert Small Balance
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**currency** | **list[str]** | Currency | [optional]
8+
**is_all** | **bool** | Whether to exchange all | [optional]
89

910
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1011

‎docs/CountdownCancelAllOptionsTask.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CountdownCancelAllOptionsTask
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** | Options contract name | [optional]
9+
**underlying** | **str** | Underlying | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/DeliveryApi.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Method | HTTP request | Description
2727
[**list_delivery_position_close**](DeliveryApi.md#list_delivery_position_close) | **GET** /delivery/{settle}/position_close | List position close history
2828
[**list_delivery_liquidates**](DeliveryApi.md#list_delivery_liquidates) | **GET** /delivery/{settle}/liquidates | List liquidation history
2929
[**list_delivery_settlements**](DeliveryApi.md#list_delivery_settlements) | **GET** /delivery/{settle}/settlements | List settlement history
30+
[**list_delivery_risk_limit_tiers**](DeliveryApi.md#list_delivery_risk_limit_tiers) | **GET** /delivery/{settle}/risk_limit_tiers | List risk limit tiers
3031
[**list_price_triggered_delivery_orders**](DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | List all auto orders
3132
[**create_price_triggered_delivery_order**](DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order
3233
[**cancel_price_triggered_delivery_order_list**](DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all open orders
@@ -1630,6 +1631,72 @@ Name | Type | Description | Notes
16301631

16311632
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
16321633

1634+
# **list_delivery_risk_limit_tiers**
1635+
> list[FuturesLimitRiskTiers] list_delivery_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
1636+
1637+
List risk limit tiers
1638+
1639+
When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty.
1640+
1641+
### Example
1642+
1643+
```python
1644+
from __future__ import print_function
1645+
import gate_api
1646+
from gate_api.exceptions import ApiException, GateApiException
1647+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
1648+
# See configuration.py for a list of all supported configuration parameters.
1649+
configuration = gate_api.Configuration(
1650+
host = "https://api.gateio.ws/api/v4"
1651+
)
1652+
1653+
api_client = gate_api.ApiClient(configuration)
1654+
# Create an instance of the API class
1655+
api_instance = gate_api.DeliveryApi(api_client)
1656+
settle = 'usdt' # str | Settle currency
1657+
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
1658+
limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
1659+
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
1660+
1661+
try:
1662+
# List risk limit tiers
1663+
api_response = api_instance.list_delivery_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
1664+
print(api_response)
1665+
except GateApiException as ex:
1666+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
1667+
except ApiException as e:
1668+
print("Exception when calling DeliveryApi->list_delivery_risk_limit_tiers: %s\n" % e)
1669+
```
1670+
1671+
### Parameters
1672+
1673+
Name | Type | Description | Notes
1674+
------------- | ------------- | ------------- | -------------
1675+
**settle** | **str**| Settle currency |
1676+
**contract** | **str**| Futures contract | [optional]
1677+
**limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
1678+
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
1679+
1680+
### Return type
1681+
1682+
[**list[FuturesLimitRiskTiers]**](FuturesLimitRiskTiers.md)
1683+
1684+
### Authorization
1685+
1686+
No authorization required
1687+
1688+
### HTTP request headers
1689+
1690+
- **Content-Type**: Not defined
1691+
- **Accept**: application/json
1692+
1693+
### HTTP response details
1694+
| Status code | Description | Response headers |
1695+
|-------------|-------------|------------------|
1696+
**200** | Successfully retrieved | - |
1697+
1698+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1699+
16331700
# **list_price_triggered_delivery_orders**
16341701
> list[FuturesPriceTriggeredOrder] list_price_triggered_delivery_orders(settle, status, contract=contract, limit=limit, offset=offset)
16351702

0 commit comments

Comments
 (0)