Skip to content

Commit dd045c8

Browse files
author
gateio
committed
update to v2.102.0
1 parent 3c8e049 commit dd045c8

File tree

326 files changed

+2015
-1029
lines changed

Some content is hidden

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

326 files changed

+2015
-1029
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# gate-api
22
Welcome to Gate API
3-
4-
APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.
5-
3+
APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces
4+
for implementing API-based automated trading.
65

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

9-
- API version: 4.100.2
10-
- Package version: 6.100.2
8+
- API version: v4.102.0
9+
- Package version: 6.102.0
1110
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
12-
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
11+
For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts)
1312

1413
## Versioning
1514

@@ -158,7 +157,7 @@ Class | Method | HTTP request | Description
158157
*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
159158
*UnifiedApi* | [**list_unified_currencies**](docs/UnifiedApi.md#list_unified_currencies) | **GET** /unified/currencies | List of loan currencies supported by unified account
160159
*UnifiedApi* | [**get_history_loan_rate**](docs/UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | get historical lending rates
161-
*UnifiedApi* | [**set_unified_collateral**](docs/UnifiedApi.md#set_unified_collateral) | **POST** /unified/collateral_currencies | 设置抵押币种
160+
*UnifiedApi* | [**set_unified_collateral**](docs/UnifiedApi.md#set_unified_collateral) | **POST** /unified/collateral_currencies | Set Collateral Currency
162161
*AccountApi* | [**get_account_detail**](docs/AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail
163162
*AccountApi* | [**get_account_rate_limit**](docs/AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information
164163
*AccountApi* | [**list_stp_groups**](docs/AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | List STP Groups
@@ -215,7 +214,7 @@ Class | Method | HTTP request | Description
215214
*EarnApi* | [**list_structured_products**](docs/EarnApi.md#list_structured_products) | **GET** /earn/structured/products | Structured Product List
216215
*EarnApi* | [**list_structured_orders**](docs/EarnApi.md#list_structured_orders) | **GET** /earn/structured/orders | Structured Product Order List
217216
*EarnApi* | [**place_structured_order**](docs/EarnApi.md#place_structured_order) | **POST** /earn/structured/orders | Place Structured Product Order
218-
*EarnApi* | [**find_coin**](docs/EarnApi.md#find_coin) | **GET** /earn/staking/coins | 链上赚币币种
217+
*EarnApi* | [**find_coin**](docs/EarnApi.md#find_coin) | **GET** /earn/staking/coins | Staking Coins
219218
*EarnApi* | [**swap_staking_coin**](docs/EarnApi.md#swap_staking_coin) | **POST** /earn/staking/swap | On-chain Token Swap for Earned Coins
220219
*FlashSwapApi* | [**list_flash_swap_currency_pair**](docs/FlashSwapApi.md#list_flash_swap_currency_pair) | **GET** /flash_swap/currency_pairs | List All Supported Currency Pairs In Flash Swap
221220
*FlashSwapApi* | [**list_flash_swap_orders**](docs/FlashSwapApi.md#list_flash_swap_orders) | **GET** /flash_swap/orders | List all flash swap orders
@@ -265,6 +264,7 @@ Class | Method | HTTP request | Description
265264
*FuturesApi* | [**get_futures_fee**](docs/FuturesApi.md#get_futures_fee) | **GET** /futures/{settle}/fee | Query user trading fee rates
266265
*FuturesApi* | [**cancel_batch_future_orders**](docs/FuturesApi.md#cancel_batch_future_orders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel a batch of orders with an ID list
267266
*FuturesApi* | [**amend_batch_future_orders**](docs/FuturesApi.md#amend_batch_future_orders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders with specified IDs
267+
*FuturesApi* | [**get_futures_risk_limit_table**](docs/FuturesApi.md#get_futures_risk_limit_table) | **GET** /futures/{settle}/risk_limit_table | Query risk limit table by table_id
268268
*FuturesApi* | [**list_price_triggered_orders**](docs/FuturesApi.md#list_price_triggered_orders) | **GET** /futures/{settle}/price_orders | List All Price-triggered Orders
269269
*FuturesApi* | [**create_price_triggered_order**](docs/FuturesApi.md#create_price_triggered_order) | **POST** /futures/{settle}/price_orders | Create a price-triggered order
270270
*FuturesApi* | [**cancel_price_triggered_order_list**](docs/FuturesApi.md#cancel_price_triggered_order_list) | **DELETE** /futures/{settle}/price_orders | Cancel All Price-triggered Orders
@@ -481,6 +481,7 @@ Class | Method | HTTP request | Description
481481
- [FuturesPremiumIndex](docs/FuturesPremiumIndex.md)
482482
- [FuturesPriceTrigger](docs/FuturesPriceTrigger.md)
483483
- [FuturesPriceTriggeredOrder](docs/FuturesPriceTriggeredOrder.md)
484+
- [FuturesRiskLimitTier](docs/FuturesRiskLimitTier.md)
484485
- [FuturesTicker](docs/FuturesTicker.md)
485486
- [FuturesTrade](docs/FuturesTrade.md)
486487
- [IndexConstituent](docs/IndexConstituent.md)
@@ -589,6 +590,7 @@ Class | Method | HTTP request | Description
589590
- [SubCrossMarginAccount](docs/SubCrossMarginAccount.md)
590591
- [SubUserMode](docs/SubUserMode.md)
591592
- [SwapCoin](docs/SwapCoin.md)
593+
- [SwapCoinStruct](docs/SwapCoinStruct.md)
592594
- [SystemTime](docs/SystemTime.md)
593595
- [Ticker](docs/Ticker.md)
594596
- [TotalBalance](docs/TotalBalance.md)
@@ -652,7 +654,7 @@ Class | Method | HTTP request | Description
652654
Authentication with APIv4 key and secret
653655

654656
For details, refer to:
655-
[APIv4 signed request requirements](https://www.gate.io/docs/apiv4/en/index.html#apiv4-signed-request-requirements)
657+
[APIv4 signed request requirements](https://www.gate.com/docs/apiv4/en/index.html#apiv4-signed-request-requirements)
656658

657659

658660
## Author

docs/AccountApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Name | Type | Description | Notes
284284
285285
List users of the STP group
286286

287-
Only the main account that created this STP group is allowed to list the user ID of the STP group
287+
Only the main account that created this STP group can query the account
288288

289289
### Example
290290

docs/AccountDetail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +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]
12+
**copy_trading_role** | **int** | User role: 0 - Normal user 1 - Copy trading leader 2 - Copy trading follower 3 - Both leader and follower | [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

docs/BatchAmendItem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
77
**order_id** | **str** | The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). |
88
**currency_pair** | **str** | Currency pair |
99
**account** | **str** | Default spot, unified account and warehouse-by-store leverage account. | [optional]
10-
**amount** | **str** | trade amount, only one of amount and price can be specified | [optional]
11-
**price** | **str** | trade price, only one of amount and price can be specified | [optional]
10+
**amount** | **str** | Trading Quantity. Only one of amountor pricecan be specified. | [optional]
11+
**price** | **str** | Trading Price. Only one of amountor pricecan be specified. | [optional]
1212
**amend_text** | **str** | Custom info during amending order | [optional]
1313
**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]
1414

docs/BatchOrder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
1717
**update_time_ms** | **int** | Last modification time of order (in milliseconds) | [optional] [readonly]
1818
**status** | **str** | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly]
1919
**currency_pair** | **str** | Currency pair | [optional]
20-
**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
20+
**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
2121
**account** | **str** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] [default to 'spot']
22-
**side** | **str** | Order side | [optional]
22+
**side** | **str** | Buy or sell order | [optional]
2323
**amount** | **str** | Trade amount | [optional]
2424
**price** | **str** | Order price | [optional]
2525
**time_in_force** | **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']

docs/CollateralLoanApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@ configuration = gate_api.Configuration(
664664
api_client = gate_api.ApiClient(configuration)
665665
# Create an instance of the API class
666666
api_instance = gate_api.CollateralLoanApi(api_client)
667-
loan_currency = 'BTC' # str | The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. If loan_currency is provided, the API will return an array of collateral currencies supported for the specified borrowing currency. (optional)
667+
loan_currency = 'BTC' # str | The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. (optional)
668668

669669
try:
670670
# Query supported borrowing and collateral currencies
@@ -680,7 +680,7 @@ except ApiException as e:
680680

681681
Name | Type | Description | Notes
682682
------------- | ------------- | ------------- | -------------
683-
**loan_currency** | **str**| The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. If loan_currency is provided, the API will return an array of collateral currencies supported for the specified borrowing currency. | [optional]
683+
**loan_currency** | **str**| The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. | [optional]
684684

685685
### Return type
686686

docs/Contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
2626
**risk_limit_max** | **str** | Maximum risk limit the contract allowed,deprecated,It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits. | [optional]
2727
**order_size_min** | **int** | Minimum order size the contract allowed | [optional]
2828
**order_size_max** | **int** | Maximum order size the contract allowed | [optional]
29-
**order_price_deviate** | **str** | deviation between order price and current index price. If price of an order is denoted as order_price, it must meet the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
29+
**order_price_deviate** | **str** | deviation between order price and current index price. If price of an order is denoted as order_price, it must meet the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
3030
**ref_discount_rate** | **str** | Referral fee rate discount | [optional]
3131
**ref_rebate_rate** | **str** | Referrer commission rate | [optional]
3232
**orderbook_id** | **int** | Current orderbook ID | [optional]
@@ -41,7 +41,7 @@ Name | Type | Description | Notes
4141
**create_time** | **float** | Created time of the contract | [optional]
4242
**funding_cap_ratio** | **str** | The factor for the maximum of the funding rate. Maximum of funding rate = (1/market maximum leverage - maintenance margin rate) * funding_cap_ratio | [optional]
4343
**status** | **str** | Contract Status Types include: prelaunch, trading, delisting, delisted | [optional]
44-
**launch_time** | **int** | 合约开盘时间 | [optional]
44+
**launch_time** | **int** | Contract expiry timestamp | [optional]
4545

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

docs/CountdownCancelAllFuturesTask.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Countdown cancel task detail
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
7+
**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
88
**contract** | **str** | Futures contract | [optional]
99

1010
[[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/CountdownCancelAllOptionsTask.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Countdown cancel task detail
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
7+
**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
88
**contract** | **str** | Options contract name | [optional]
99
**underlying** | **str** | Underlying | [optional]
1010

docs/CountdownCancelAllSpotTask.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Countdown cancel task detail
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
7+
**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
88
**currency_pair** | **str** | Currency pair | [optional]
99

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

0 commit comments

Comments
 (0)