Skip to content

Commit ebe812b

Browse files
author
gateio
committed
update to v6.90.0
1 parent 6b710e0 commit ebe812b

32 files changed

Lines changed: 679 additions & 50 deletions

README.md

Lines changed: 6 additions & 3 deletions
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.89.0
9-
- Package version: 4.89.0
8+
- API version: 4.90.0
9+
- Package version: 4.90.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

@@ -149,7 +149,7 @@ Class | Method | HTTP request | Description
149149
*UnifiedApi* | [**list_currency_discount_tiers**](docs/UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers
150150
*UnifiedApi* | [**list_loan_margin_tiers**](docs/UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers
151151
*UnifiedApi* | [**calculate_portfolio_margin**](docs/UnifiedApi.md#calculate_portfolio_margin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator
152-
*UnifiedApi* | [**get_user_leverage_currency_config**](docs/UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | The maximum and minimum leverage multiples that users can set for a currency type are:
152+
*UnifiedApi* | [**get_user_leverage_currency_config**](docs/UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | Minimum currency leverage that can be set
153153
*UnifiedApi* | [**get_user_leverage_currency_setting**](docs/UnifiedApi.md#get_user_leverage_currency_setting) | **GET** /unified/leverage/user_currency_setting | Get the user's currency leverage. If currency is not passed, query all currencies.
154154
*UnifiedApi* | [**set_user_leverage_currency_setting**](docs/UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set the loan currency leverage
155155
*UnifiedApi* | [**get_history_loan_rate**](docs/UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | get historical lending rates
@@ -327,6 +327,7 @@ Class | Method | HTTP request | Description
327327
*RebateApi* | [**rebate_broker_commission_history**](docs/RebateApi.md#rebate_broker_commission_history) | **GET** /rebate/broker/commission_history | The broker obtains the user's commission rebate records
328328
*RebateApi* | [**rebate_broker_transaction_history**](docs/RebateApi.md#rebate_broker_transaction_history) | **GET** /rebate/broker/transaction_history | The broker obtains the user's trading history
329329
*RebateApi* | [**rebate_user_info**](docs/RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User retrieves rebate information
330+
*RebateApi* | [**user_sub_relation**](docs/RebateApi.md#user_sub_relation) | **GET** /rebate/user/sub_relation | User-subordinate relationship
330331
*SpotApi* | [**list_currencies**](docs/SpotApi.md#list_currencies) | **GET** /spot/currencies | List all currencies' details
331332
*SpotApi* | [**get_currency**](docs/SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Get details of a specific currency
332333
*SpotApi* | [**list_currency_pairs**](docs/SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | List all currency pairs supported
@@ -622,6 +623,8 @@ Class | Method | HTTP request | Description
622623
- [UnifiedSettings](docs/UnifiedSettings.md)
623624
- [UnifiedTransferable](docs/UnifiedTransferable.md)
624625
- [UserLtvInfo](docs/UserLtvInfo.md)
626+
- [UserSub](docs/UserSub.md)
627+
- [UserSubRelation](docs/UserSubRelation.md)
625628
- [UserTotalAmount](docs/UserTotalAmount.md)
626629
- [WithdrawStatus](docs/WithdrawStatus.md)
627630
- [WithdrawalRecord](docs/WithdrawalRecord.md)

docs/AccountRateLimit.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-
**tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#成交比率限频)) | [optional]
6+
**tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) | [optional]
77
**ratio** | **str** | Transaction rate | [optional]
88
**main_ratio** | **str** | Total transaction ratio of main account | [optional]
99
**updated_at** | **str** | Update time | [optional]

docs/CurrencyPair.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**trade_status** | **str** | How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold | [optional]
1818
**sell_start** | **int** | Sell start unix timestamp in seconds | [optional]
1919
**buy_start** | **int** | Buy start unix timestamp in seconds | [optional]
20+
**type** | **str** | Trading pair type, normal: normal, premarket: pre-market | [optional]
2021

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

docs/FuturesLiqOrder.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
66
**time** | **int** | Liquidation time | [optional] [readonly]
77
**contract** | **str** | Futures contract | [optional] [readonly]
88
**size** | **int** | User position size | [optional] [readonly]
9+
**order_size** | **int** | Number of forced liquidation orders | [optional] [readonly]
910
**order_price** | **str** | Liquidation order price | [optional] [readonly]
1011
**fill_price** | **str** | Liquidation order average taker price | [optional] [readonly]
1112
**left** | **int** | System liquidation order maker size | [optional] [readonly]

docs/RebateApi.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Method | HTTP request | Description
1212
[**rebate_broker_commission_history**](RebateApi.md#rebate_broker_commission_history) | **GET** /rebate/broker/commission_history | The broker obtains the user's commission rebate records
1313
[**rebate_broker_transaction_history**](RebateApi.md#rebate_broker_transaction_history) | **GET** /rebate/broker/transaction_history | The broker obtains the user's trading history
1414
[**rebate_user_info**](RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User retrieves rebate information
15+
[**user_sub_relation**](RebateApi.md#user_sub_relation) | **GET** /rebate/user/sub_relation | User-subordinate relationship
1516

1617

1718
# **agency_transaction_history**
@@ -620,3 +621,72 @@ This endpoint does not need any parameter.
620621

621622
[[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)
622623

624+
# **user_sub_relation**
625+
> UserSubRelation user_sub_relation(user_id_list)
626+
627+
User-subordinate relationship
628+
629+
Query whether the specified user is in the system
630+
631+
### Example
632+
633+
* Api Key Authentication (apiv4):
634+
```python
635+
from __future__ import print_function
636+
import gate_api
637+
from gate_api.exceptions import ApiException, GateApiException
638+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
639+
# See configuration.py for a list of all supported configuration parameters.
640+
# The client must configure the authentication and authorization parameters
641+
# in accordance with the API server security policy.
642+
# Examples for each auth method are provided below, use the example that
643+
# satisfies your auth use case.
644+
645+
# Configure APIv4 key authorization
646+
configuration = gate_api.Configuration(
647+
host = "https://api.gateio.ws/api/v4",
648+
key = "YOU_API_KEY",
649+
secret = "YOUR_API_SECRET"
650+
)
651+
652+
api_client = gate_api.ApiClient(configuration)
653+
# Create an instance of the API class
654+
api_instance = gate_api.RebateApi(api_client)
655+
user_id_list = '1, 2, 3' # str | Query the user's ID list, split by,, if there are more than 100, take 100
656+
657+
try:
658+
# User-subordinate relationship
659+
api_response = api_instance.user_sub_relation(user_id_list)
660+
print(api_response)
661+
except GateApiException as ex:
662+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
663+
except ApiException as e:
664+
print("Exception when calling RebateApi->user_sub_relation: %s\n" % e)
665+
```
666+
667+
### Parameters
668+
669+
Name | Type | Description | Notes
670+
------------- | ------------- | ------------- | -------------
671+
**user_id_list** | **str**| Query the user's ID list, split by,, if there are more than 100, take 100 |
672+
673+
### Return type
674+
675+
[**UserSubRelation**](UserSubRelation.md)
676+
677+
### Authorization
678+
679+
[apiv4](../README.md#apiv4)
680+
681+
### HTTP request headers
682+
683+
- **Content-Type**: Not defined
684+
- **Accept**: application/json
685+
686+
### HTTP response details
687+
| Status code | Description | Response headers |
688+
|-------------|-------------|------------------|
689+
**200** | List retrieved | - |
690+
691+
[[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)
692+

docs/SpotApi.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1838,23 +1838,14 @@ Query spot insurance fund historical data
18381838

18391839
### Example
18401840

1841-
* Api Key Authentication (apiv4):
18421841
```python
18431842
from __future__ import print_function
18441843
import gate_api
18451844
from gate_api.exceptions import ApiException, GateApiException
18461845
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
18471846
# See configuration.py for a list of all supported configuration parameters.
1848-
# The client must configure the authentication and authorization parameters
1849-
# in accordance with the API server security policy.
1850-
# Examples for each auth method are provided below, use the example that
1851-
# satisfies your auth use case.
1852-
1853-
# Configure APIv4 key authorization
18541847
configuration = gate_api.Configuration(
1855-
host = "https://api.gateio.ws/api/v4",
1856-
key = "YOU_API_KEY",
1857-
secret = "YOUR_API_SECRET"
1848+
host = "https://api.gateio.ws/api/v4"
18581849
)
18591850

18601851
api_client = gate_api.ApiClient(configuration)
@@ -1894,7 +1885,7 @@ Name | Type | Description | Notes
18941885

18951886
### Authorization
18961887

1897-
[apiv4](../README.md#apiv4)
1888+
No authorization required
18981889

18991890
### HTTP request headers
19001891

docs/UidPushOrder.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**create_time** | **int** | Creation time | [optional]
1212
**status** | **str** | Withdrawal Status - CREATING: Creating - PENDING: Waiting for receiving(Please contact the other party to accept the transfer on the Gate official website) - CANCELLING: Cancelling - CANCELLED: Revoked - REFUSING: Rejection - REFUSED: Rejected - RECEIVING: Receiving - RECEIVED: Success | [optional]
1313
**message** | **str** | PENDING Reason Tips | [optional]
14+
**transaction_type** | **str** | Order Type | [optional]
1415

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

docs/UnifiedApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Method | HTTP request | Description
1818
[**list_currency_discount_tiers**](UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers
1919
[**list_loan_margin_tiers**](UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers
2020
[**calculate_portfolio_margin**](UnifiedApi.md#calculate_portfolio_margin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator
21-
[**get_user_leverage_currency_config**](UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | The maximum and minimum leverage multiples that users can set for a currency type are:
21+
[**get_user_leverage_currency_config**](UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | Minimum currency leverage that can be set
2222
[**get_user_leverage_currency_setting**](UnifiedApi.md#get_user_leverage_currency_setting) | **GET** /unified/leverage/user_currency_setting | Get the user's currency leverage. If currency is not passed, query all currencies.
2323
[**set_user_leverage_currency_setting**](UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set the loan currency leverage
2424
[**get_history_loan_rate**](UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | get historical lending rates
@@ -954,7 +954,7 @@ No authorization required
954954
# **get_user_leverage_currency_config**
955955
> UnifiedLeverageConfig get_user_leverage_currency_config(currency)
956956
957-
The maximum and minimum leverage multiples that users can set for a currency type are:
957+
Minimum currency leverage that can be set
958958

959959
### Example
960960

@@ -983,7 +983,7 @@ api_instance = gate_api.UnifiedApi(api_client)
983983
currency = 'BTC' # str | Currency
984984

985985
try:
986-
# The maximum and minimum leverage multiples that users can set for a currency type are:
986+
# Minimum currency leverage that can be set
987987
api_response = api_instance.get_user_leverage_currency_config(currency)
988988
print(api_response)
989989
except GateApiException as ex:

docs/UnifiedBalance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
1212
**total_freeze** | **str** | Total occupancy (discarded, to be offline field) | [optional]
1313
**total_liab** | **str** | Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
1414
**spot_in_use** | **str** | The amount of spot hedging is valid in the combined margin mode, and is 0 in other margin modes such as single currency and cross-currency margin modes | [optional]
15-
**funding** | **str** | Yubibao financial management amount, effective when Yubibao financial management is turned on as a unified account margin switch | [optional]
15+
**funding** | **str** | Uniloan financial management amount, effective when Uniloan financial management is turned on as a unified account margin switch | [optional]
1616
**funding_version** | **str** | Funding version | [optional]
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]

docs/UnifiedLeverageConfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**debit** | **str** | Current liabilities | [optional]
1010
**available_margin** | **str** | Available Margin | [optional]
1111
**borrowable** | **str** | The current leverage you can choose is | [optional]
12-
**except_leverage_borrowable** | **str** | The maximum amount of margin that can be borrowed and the maximum amount of Yubibao that can be borrowed, whichever is smaller | [optional]
12+
**except_leverage_borrowable** | **str** | The maximum amount of margin that can be borrowed and the maximum amount of Uniloan that can be borrowed, whichever is smaller | [optional]
1313

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

0 commit comments

Comments
 (0)