Skip to content

Commit

Permalink
release 4.57.0
Browse files Browse the repository at this point in the history
  • Loading branch information
revilwang committed Oct 23, 2023
1 parent c10eb43 commit b09e6df
Show file tree
Hide file tree
Showing 80 changed files with 2,169 additions and 471 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ APIv4 provides spot, margin and futures trading operations. There are public API

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

- API version: 4.56.0
- Package version: 4.56.0
- API version: 4.57.0
- Package version: 4.57.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)

Expand Down Expand Up @@ -114,6 +114,8 @@ Class | Method | HTTP request | Description
*EarnUniApi* | [**list_uni_lend_records**](docs/EarnUniApi.md#list_uni_lend_records) | **GET** /earn/uni/lend_records | List records of lending
*EarnUniApi* | [**get_uni_interest**](docs/EarnUniApi.md#get_uni_interest) | **GET** /earn/uni/interests/{currency} | Get the user's total interest income of specified currency
*EarnUniApi* | [**list_uni_interest_records**](docs/EarnUniApi.md#list_uni_interest_records) | **GET** /earn/uni/interest_records | List interest records
*EarnUniApi* | [**switch_interest_reinvest**](docs/EarnUniApi.md#switch_interest_reinvest) | **PUT** /earn/uni/interest_reinvest | Set interest reinvestment toggle
*EarnUniApi* | [**get_uni_interest_status**](docs/EarnUniApi.md#get_uni_interest_status) | **GET** /earn/uni/interest_status/{currency} | query currency interest compounding status
*MarginUniApi* | [**list_uni_currency_pairs**](docs/MarginUniApi.md#list_uni_currency_pairs) | **GET** /margin/uni/currency_pairs | List lending markets
*MarginUniApi* | [**get_uni_currency_pair**](docs/MarginUniApi.md#get_uni_currency_pair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get detail of lending market
*MarginUniApi* | [**get_margin_uni_estimate_rate**](docs/MarginUniApi.md#get_margin_uni_estimate_rate) | **GET** /margin/uni/estimate_rate | Estimate interest Rate
Expand Down Expand Up @@ -146,17 +148,17 @@ Class | Method | HTTP request | Description
*AccountApi* | [**create_stp_group**](docs/AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP Group
*AccountApi* | [**list_stp_groups_users**](docs/AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group
*AccountApi* | [**add_stp_group_users**](docs/AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group
*AccountApi* | [**delete_stp_group_users**](docs/AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | STP用户组中删除用户
*CollateralLoanApi* | [**list_collateral_loan_orders**](docs/CollateralLoanApi.md#list_collateral_loan_orders) | **GET** /loan/collateral/orders | 查询抵押借币订单列表
*CollateralLoanApi* | [**create_collateral_loan**](docs/CollateralLoanApi.md#create_collateral_loan) | **POST** /loan/collateral/orders | 抵押借币借贷下单
*AccountApi* | [**delete_stp_group_users**](docs/AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group
*CollateralLoanApi* | [**list_collateral_loan_orders**](docs/CollateralLoanApi.md#list_collateral_loan_orders) | **GET** /loan/collateral/orders | List Orders
*CollateralLoanApi* | [**create_collateral_loan**](docs/CollateralLoanApi.md#create_collateral_loan) | **POST** /loan/collateral/orders | Place order
*CollateralLoanApi* | [**get_collateral_loan_order_detail**](docs/CollateralLoanApi.md#get_collateral_loan_order_detail) | **GET** /loan/collateral/orders/{order_id} | Get a single order
*CollateralLoanApi* | [**repay_collateral_loan**](docs/CollateralLoanApi.md#repay_collateral_loan) | **POST** /loan/collateral/repay | 抵押借币还款
*CollateralLoanApi* | [**list_repay_records**](docs/CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | 查询抵押借币还款记录
*CollateralLoanApi* | [**list_collateral_records**](docs/CollateralLoanApi.md#list_collateral_records) | **GET** /loan/collateral/collaterals | 查询质押物调整记录
*CollateralLoanApi* | [**operate_collateral**](docs/CollateralLoanApi.md#operate_collateral) | **POST** /loan/collateral/collaterals | 增加或赎回质押物
*CollateralLoanApi* | [**get_user_total_amount**](docs/CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | 查询用户总借贷与质押数量
*CollateralLoanApi* | [**get_user_ltv_info**](docs/CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | 查询用户质押率和可借剩余币种
*CollateralLoanApi* | [**list_collateral_currencies**](docs/CollateralLoanApi.md#list_collateral_currencies) | **GET** /loan/collateral/currencies | 查询支持的借款币种和抵押币种
*CollateralLoanApi* | [**repay_collateral_loan**](docs/CollateralLoanApi.md#repay_collateral_loan) | **POST** /loan/collateral/repay | Repayment
*CollateralLoanApi* | [**list_repay_records**](docs/CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | Repayment history
*CollateralLoanApi* | [**list_collateral_records**](docs/CollateralLoanApi.md#list_collateral_records) | **GET** /loan/collateral/collaterals | Query collateral adjustment records
*CollateralLoanApi* | [**operate_collateral**](docs/CollateralLoanApi.md#operate_collateral) | **POST** /loan/collateral/collaterals | Increase or redeem collateral
*CollateralLoanApi* | [**get_user_total_amount**](docs/CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | Query the total borrowing and collateral amount for the user
*CollateralLoanApi* | [**get_user_ltv_info**](docs/CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | Query user's collateralization ratio
*CollateralLoanApi* | [**list_collateral_currencies**](docs/CollateralLoanApi.md#list_collateral_currencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies
*DeliveryApi* | [**list_delivery_contracts**](docs/DeliveryApi.md#list_delivery_contracts) | **GET** /delivery/{settle}/contracts | List all futures contracts
*DeliveryApi* | [**get_delivery_contract**](docs/DeliveryApi.md#get_delivery_contract) | **GET** /delivery/{settle}/contracts/{contract} | Get a single contract
*DeliveryApi* | [**list_delivery_order_book**](docs/DeliveryApi.md#list_delivery_order_book) | **GET** /delivery/{settle}/order_book | Futures order book
Expand Down Expand Up @@ -320,6 +322,7 @@ Class | Method | HTTP request | Description
*SpotApi* | [**list_my_trades**](docs/SpotApi.md#list_my_trades) | **GET** /spot/my_trades | List personal trading history
*SpotApi* | [**get_system_time**](docs/SpotApi.md#get_system_time) | **GET** /spot/time | Get server current time
*SpotApi* | [**countdown_cancel_all_spot**](docs/SpotApi.md#countdown_cancel_all_spot) | **POST** /spot/countdown_cancel_all | Countdown cancel orders
*SpotApi* | [**amend_batch_orders**](docs/SpotApi.md#amend_batch_orders) | **POST** /spot/amend_batch_orders | Batch modification of orders
*SpotApi* | [**list_spot_price_triggered_orders**](docs/SpotApi.md#list_spot_price_triggered_orders) | **GET** /spot/price_orders | Retrieve running auto order list
*SpotApi* | [**create_spot_price_triggered_order**](docs/SpotApi.md#create_spot_price_triggered_order) | **POST** /spot/price_orders | Create a price-triggered order
*SpotApi* | [**cancel_spot_price_triggered_order_list**](docs/SpotApi.md#cancel_spot_price_triggered_order_list) | **DELETE** /spot/price_orders | Cancel all open orders
Expand Down Expand Up @@ -354,8 +357,10 @@ Class | Method | HTTP request | Description
- [AgencyCommissionHistory](docs/AgencyCommissionHistory.md)
- [AgencyTransaction](docs/AgencyTransaction.md)
- [AgencyTransactionHistory](docs/AgencyTransactionHistory.md)
- [AmendOrderResult](docs/AmendOrderResult.md)
- [ApiV4KeyPerm](docs/ApiV4KeyPerm.md)
- [AutoRepaySetting](docs/AutoRepaySetting.md)
- [BatchAmendItem](docs/BatchAmendItem.md)
- [BatchFuturesOrder](docs/BatchFuturesOrder.md)
- [BatchOrder](docs/BatchOrder.md)
- [CancelBatchOrder](docs/CancelBatchOrder.md)
Expand Down Expand Up @@ -495,7 +500,9 @@ Class | Method | HTTP request | Description
- [TriggerOrderResponse](docs/TriggerOrderResponse.md)
- [TriggerTime](docs/TriggerTime.md)
- [UniCurrency](docs/UniCurrency.md)
- [UniCurrencyInterest](docs/UniCurrencyInterest.md)
- [UniCurrencyPair](docs/UniCurrencyPair.md)
- [UniInterestMode](docs/UniInterestMode.md)
- [UniInterestRecord](docs/UniInterestRecord.md)
- [UniLend](docs/UniLend.md)
- [UniLendInterest](docs/UniLendInterest.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Method | HTTP request | Description
[**create_stp_group**](AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP Group
[**list_stp_groups_users**](AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group
[**add_stp_group_users**](AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group
[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | STP用户组中删除用户
[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group


# **get_account_detail**
Expand Down Expand Up @@ -356,9 +356,9 @@ Name | Type | Description | Notes
# **delete_stp_group_users**
> list[StpGroupUser] delete_stp_group_users(stp_id, request_body)
STP用户组中删除用户
Delete the user in the STP group

- 只允许创建此STP组的主账号删除STP用户组用户 - 只允许删除当前主账户下的账户,不允许跨主账户
- Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted

### Example

Expand Down Expand Up @@ -388,7 +388,7 @@ stp_id = 1 # int | STP Group ID
request_body = [[1,2,3]] # list[int] | User ID

try:
# STP用户组中删除用户
# Delete the user in the STP group
api_response = api_instance.delete_stp_group_users(stp_id, request_body)
print(api_response)
except GateApiException as ex:
Expand Down Expand Up @@ -420,7 +420,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | 删除用户成功,返回当前STP组内用户 | - |
**200** | Success | - |

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

18 changes: 18 additions & 0 deletions docs/AmendOrderResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# AmendOrderResult

Batch order modification results
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **str** | Order ID | [optional] [readonly]
**amount** | **str** | Trade amount | [optional] [readonly]
**price** | **str** | Order price | [optional] [readonly]
**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional] [readonly]
**succeeded** | **bool** | Update success status | [optional] [readonly]
**label** | **str** | Error indicator for failed modifications; empty when successful | [optional] [readonly]
**message** | **str** | Error description for failed modifications; empty when successful | [optional] [readonly]
**account** | **str** | Account types, spot - spot account, margin - margin account, portfolio - portfolio margin account, cross_margin - cross margin account.Portfolio margin accounts can only be set to `cross_margin` | [optional] [readonly]

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


2 changes: 1 addition & 1 deletion docs/ApiV4KeyPerm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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- account: Account - portfolio: Portfolio - loan: Loan | [optional]
**read_only** | **bool** | read only | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
16 changes: 16 additions & 0 deletions docs/BatchAmendItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# BatchAmendItem

Order information that needs to be modified
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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). |
**currency_pair** | **str** | Currency pair |
**account** | **str** | Default to spot, portfolio, and margin accounts if not specified. Use 'cross_margin' to query cross margin accounts. Only 'cross_margin' can be specified for portfolio margin accounts. | [optional]
**amount** | **str** | trade amount, only one of amount and price can be specified | [optional]
**price** | **str** | trade price, only one of amount and price can be specified | [optional]
**amend_text** | **str** | Custom info during amending order | [optional]

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


2 changes: 1 addition & 1 deletion docs/BatchOrder.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**status** | **str** | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly]
**currency_pair** | **str** | Currency pair | [optional]
**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
**account** | **str** | Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account | [optional] [default to 'spot']
**account** | **str** | Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account, portfolio - portfolio account | [optional] [default to 'spot']
**side** | **str** | Order side | [optional]
**amount** | **str** | Trade amount | [optional]
**price** | **str** | Order price | [optional]
Expand Down
8 changes: 4 additions & 4 deletions docs/CollateralAlign.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | 订单id |
**collateral_currency** | **str** | 质押币种 |
**collateral_amount** | **str** | 质押数量 |
**type** | **str** | 操作类型, append - 补充 , redeem - 提取 |
**order_id** | **int** | Order ID |
**collateral_currency** | **str** | Collateral |
**collateral_amount** | **str** | Collateral amount |
**type** | **str** | Operation types: append - for adding collateral, redeem - for withdrawing collateral |

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

Expand Down
Loading

0 comments on commit b09e6df

Please sign in to comment.