Skip to content

Commit 061cc76

Browse files
author
gateio
committed
update to v6.93.0
1 parent 474908b commit 061cc76

22 files changed

+502
-45
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ APIv4 provides spot, margin and futures trading operations. There are public API
55

66
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
77

8-
- API version: 4.92.2
9-
- Package version: 6.92.2
8+
- API version: 4.93.0
9+
- Package version: 6.93.0
1010
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1111
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
1212

@@ -202,6 +202,7 @@ Class | Method | HTTP request | Description
202202
*DeliveryApi* | [**get_price_triggered_delivery_order**](docs/DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order
203203
*DeliveryApi* | [**cancel_price_triggered_delivery_order**](docs/DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order
204204
*EarnApi* | [**swap_eth2**](docs/EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap
205+
*EarnApi* | [**rate_list_eth2**](docs/EarnApi.md#rate_list_eth2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical rate of return query
205206
*EarnApi* | [**list_dual_investment_plans**](docs/EarnApi.md#list_dual_investment_plans) | **GET** /earn/dual/investment_plan | Dual Investment product list
206207
*EarnApi* | [**list_dual_orders**](docs/EarnApi.md#list_dual_orders) | **GET** /earn/dual/orders | Dual Investment order list
207208
*EarnApi* | [**place_dual_order**](docs/EarnApi.md#place_dual_order) | **POST** /earn/dual/orders | Place Dual Investment order
@@ -450,6 +451,7 @@ Class | Method | HTTP request | Description
450451
- [DepositAddress](docs/DepositAddress.md)
451452
- [DualGetOrders](docs/DualGetOrders.md)
452453
- [DualGetPlans](docs/DualGetPlans.md)
454+
- [Eth2RateList](docs/Eth2RateList.md)
453455
- [Eth2Swap](docs/Eth2Swap.md)
454456
- [FlashSwapCurrencyPair](docs/FlashSwapCurrencyPair.md)
455457
- [FlashSwapOrder](docs/FlashSwapOrder.md)

docs/DualGetOrders.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
1919
**apy_display** | **str** | APY | [optional]
2020
**apy_settlement** | **str** | Settlement APY | [optional]
2121
**delivery_time** | **int** | Settlement time | [optional]
22+
**text** | **str** | Custom order information | [optional]
2223

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

docs/EarnApi.md

+86-6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**swap_eth2**](EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap
8+
[**rate_list_eth2**](EarnApi.md#rate_list_eth2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical rate of return query
89
[**list_dual_investment_plans**](EarnApi.md#list_dual_investment_plans) | **GET** /earn/dual/investment_plan | Dual Investment product list
910
[**list_dual_orders**](EarnApi.md#list_dual_orders) | **GET** /earn/dual/orders | Dual Investment order list
1011
[**place_dual_order**](EarnApi.md#place_dual_order) | **POST** /earn/dual/orders | Place Dual Investment order
@@ -79,8 +80,73 @@ void (empty response body)
7980

8081
[[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)
8182

83+
# **rate_list_eth2**
84+
> list[Eth2RateList] rate_list_eth2()
85+
86+
ETH2 historical rate of return query
87+
88+
Check the ETH earnings rate record for the last 31 days
89+
90+
### Example
91+
92+
* Api Key Authentication (apiv4):
93+
```python
94+
from __future__ import print_function
95+
import gate_api
96+
from gate_api.exceptions import ApiException, GateApiException
97+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
98+
# See configuration.py for a list of all supported configuration parameters.
99+
# The client must configure the authentication and authorization parameters
100+
# in accordance with the API server security policy.
101+
# Examples for each auth method are provided below, use the example that
102+
# satisfies your auth use case.
103+
104+
# Configure APIv4 key authorization
105+
configuration = gate_api.Configuration(
106+
host = "https://api.gateio.ws/api/v4",
107+
key = "YOU_API_KEY",
108+
secret = "YOUR_API_SECRET"
109+
)
110+
111+
api_client = gate_api.ApiClient(configuration)
112+
# Create an instance of the API class
113+
api_instance = gate_api.EarnApi(api_client)
114+
115+
try:
116+
# ETH2 historical rate of return query
117+
api_response = api_instance.rate_list_eth2()
118+
print(api_response)
119+
except GateApiException as ex:
120+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
121+
except ApiException as e:
122+
print("Exception when calling EarnApi->rate_list_eth2: %s\n" % e)
123+
```
124+
125+
### Parameters
126+
This endpoint does not need any parameter.
127+
128+
### Return type
129+
130+
[**list[Eth2RateList]**](Eth2RateList.md)
131+
132+
### Authorization
133+
134+
[apiv4](../README.md#apiv4)
135+
136+
### HTTP request headers
137+
138+
- **Content-Type**: Not defined
139+
- **Accept**: application/json
140+
141+
### HTTP response details
142+
| Status code | Description | Response headers |
143+
|-------------|-------------|------------------|
144+
**200** | Successful | - |
145+
146+
[[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)
147+
82148
# **list_dual_investment_plans**
83-
> list[DualGetPlans] list_dual_investment_plans()
149+
> list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
84150
85151
Dual Investment product list
86152

@@ -99,10 +165,11 @@ configuration = gate_api.Configuration(
99165
api_client = gate_api.ApiClient(configuration)
100166
# Create an instance of the API class
101167
api_instance = gate_api.EarnApi(api_client)
168+
plan_id = 1 # int | Financial project id (optional)
102169

103170
try:
104171
# Dual Investment product list
105-
api_response = api_instance.list_dual_investment_plans()
172+
api_response = api_instance.list_dual_investment_plans(plan_id=plan_id)
106173
print(api_response)
107174
except GateApiException as ex:
108175
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -111,7 +178,10 @@ except ApiException as e:
111178
```
112179

113180
### Parameters
114-
This endpoint does not need any parameter.
181+
182+
Name | Type | Description | Notes
183+
------------- | ------------- | ------------- | -------------
184+
**plan_id** | **int**| Financial project id | [optional]
115185

116186
### Return type
117187

@@ -134,7 +204,7 @@ No authorization required
134204
[[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)
135205

136206
# **list_dual_orders**
137-
> list[DualGetOrders] list_dual_orders()
207+
> list[DualGetOrders] list_dual_orders(_from=_from, to=to, page=page, limit=limit)
138208
139209
Dual Investment order list
140210

@@ -162,10 +232,14 @@ configuration = gate_api.Configuration(
162232
api_client = gate_api.ApiClient(configuration)
163233
# Create an instance of the API class
164234
api_instance = gate_api.EarnApi(api_client)
235+
_from = 1740727000 # int | Start checkout time (optional)
236+
to = 1740729000 # int | End settlement time (optional)
237+
page = 1 # int | Page number (optional) (default to 1)
238+
limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
165239

166240
try:
167241
# Dual Investment order list
168-
api_response = api_instance.list_dual_orders()
242+
api_response = api_instance.list_dual_orders(_from=_from, to=to, page=page, limit=limit)
169243
print(api_response)
170244
except GateApiException as ex:
171245
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -174,7 +248,13 @@ except ApiException as e:
174248
```
175249

176250
### Parameters
177-
This endpoint does not need any parameter.
251+
252+
Name | Type | Description | Notes
253+
------------- | ------------- | ------------- | -------------
254+
**_from** | **int**| Start checkout time | [optional]
255+
**to** | **int**| End settlement time | [optional]
256+
**page** | **int**| Page number | [optional] [default to 1]
257+
**limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
178258

179259
### Return type
180260

docs/Eth2RateList.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Eth2RateList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**date_time** | **int** | Date and Time Stamp | [optional]
7+
**date** | **str** | Date | [optional]
8+
**rate** | **str** | percentage | [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/LedgerRecord.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**currency** | **str** | Currency name |
1212
**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
1313
**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
14-
**status** | **str** | Record status. - DONE: done - CANCEL: cancelled - REQUEST: requesting - MANUAL: pending manual approval - BCODE: GateCode operation - EXTPEND: pending confirm after sending - FAIL: pending confirm when fail - INVALID: invalid order - VERIFY: verifying - PROCES: processing - PEND: pending - DMOVE: required manual approval - SPLITPEND: the order is automatically split due to large amount | [optional] [readonly]
14+
**status** | **str** | Record status. - DONE: done - CANCEL: cancelled - REQUEST: requesting - MANUAL: pending manual approval - BCODE: GateCode operation - EXTPEND: pending confirm after sending - FAIL: pending confirm when fail - INVALID: invalid order - VERIFY: verifying - PROCES: processing - PEND: pending - DMOVE: required manual approval | [optional] [readonly]
1515
**chain** | **str** | Name of the chain used in withdrawals |
1616

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

docs/PlaceDualInvestmentOrder.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**copies** | **str** | The number of copies is mutually exclusive with the amount field and will be deprecated soon. It is recommended to use the amount parameter. | [optional]
99
**is_max** | **int** | Whether to purchase at the maximum. Mutually exclusive with the amount field. Will be deprecated soon. It is recommended to use the amount parameter. | [optional]
1010
**amount** | **str** | Subscription amount, mutually exclusive with the copies field |
11+
**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(.) | [optional]
1112

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

docs/SpotApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Method | HTTP request | Description
4343
4444
List all currencies' details
4545

46-
Currency has two forms: 1. Only currency name, e.g., BTC, USDT 2. `<currency>_<chain>`, e.g., `HT_ETH` The latter one occurs when one currency has multiple chains. Currency detail contains a `chain` field whatever the form is. To retrieve all chains of one currency, you can use use all the details which has the name of the currency or name starting with `<currency>_`.
46+
When a currency corresponds to multiple chains, you can query the information of multiple chains through the `chains` field, such as the charging and recharge status, identification, etc. of the chain.
4747

4848
### Example
4949

docs/UnifiedBalance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
1717
**cross_balance** | **str** | Full margin balance is valid in single currency margin mode, and is 0 in other modes such as cross currency margin/combined margin mode | [optional]
1818
**iso_balance** | **str** | Isolated margin balance is valid in single-currency margin mode and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
1919
**im** | **str** | Full-position initial margin is valid in single-currency margin mode and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
20-
**mm** | **str** | Full-position maintenance margin rate is valid in single-currency margin mode and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
20+
**mm** | **str** | The full position maintains margin, which is valid in the single currency margin mode, and other cross-currency margin combination margin mode is 0. | [optional]
2121
**imr** | **str** | Full-position initial margin rate is valid in single-currency margin mode and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
2222
**mmr** | **str** | Full-position maintenance margin rate is valid in single-currency margin mode and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
2323
**margin_balance** | **str** | Full margin balance is valid in single currency margin mode and is 0 in other modes such as cross currency margin/combined margin mode | [optional]

docs/WithdrawalRecord.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**currency** | **str** | Currency name |
1414
**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
1515
**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
16-
**status** | **str** | Transaction status - DONE: Completed (block_number &gt; 0 is considered to be truly completed) - CANCEL: Canceled - REQUEST: Requesting - MANUAL: Pending manual review - BCODE: Recharge code operation - EXTPEND: Sent awaiting confirmation - FAIL: Failure on the chain awaiting confirmation - INVALID: Invalid order - VERIFY: Verifying - PROCES: Processing - PEND: Processing - DMOVE: pending manual review - SPLITPEND: cny withdrawal is greater than 50,000, orders will be split automatically | [optional] [readonly]
16+
**status** | **str** | Transaction status - DONE: Completed (block_number &gt; 0 is considered to be truly completed) - CANCEL: Canceled - REQUEST: Requesting - MANUAL: Pending manual review - BCODE: Recharge code operation - EXTPEND: Sent awaiting confirmation - FAIL: Failure on the chain awaiting confirmation - INVALID: Invalid order - VERIFY: Verifying - PROCES: Processing - PEND: Processing - DMOVE: pending manual review | [optional] [readonly]
1717
**chain** | **str** | Name of the chain used in withdrawals |
1818

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

gate_api/__init__.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
from __future__ import absolute_import
1616

17-
__version__ = "6.92.2"
17+
__version__ = "6.93.0"
1818

1919
# import apis into sdk package
2020
from gate_api.api.earn_uni_api import EarnUniApi
@@ -106,6 +106,7 @@
106106
from gate_api.models.deposit_address import DepositAddress
107107
from gate_api.models.dual_get_orders import DualGetOrders
108108
from gate_api.models.dual_get_plans import DualGetPlans
109+
from gate_api.models.eth2_rate_list import Eth2RateList
109110
from gate_api.models.eth2_swap import Eth2Swap
110111
from gate_api.models.flash_swap_currency_pair import FlashSwapCurrencyPair
111112
from gate_api.models.flash_swap_order import FlashSwapOrder

0 commit comments

Comments
 (0)