Skip to content

Commit

Permalink
release 4.60.1
Browse files Browse the repository at this point in the history
  • Loading branch information
revilwang committed Dec 6, 2023
1 parent b09e6df commit f3b6eaa
Show file tree
Hide file tree
Showing 78 changed files with 8,653 additions and 99 deletions.
54 changes: 36 additions & 18 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.57.0
- Package version: 4.57.0
- API version: 4.60.1
- Package version: 4.60.1
- 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 @@ -124,15 +124,6 @@ Class | Method | HTTP request | Description
*MarginUniApi* | [**list_uni_loan_records**](docs/MarginUniApi.md#list_uni_loan_records) | **GET** /margin/uni/loan_records | Get load records
*MarginUniApi* | [**list_uni_loan_interest_records**](docs/MarginUniApi.md#list_uni_loan_interest_records) | **GET** /margin/uni/interest_records | List interest records
*MarginUniApi* | [**get_uni_borrowable**](docs/MarginUniApi.md#get_uni_borrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable
*PortfolioApi* | [**list_portfolio_accounts**](docs/PortfolioApi.md#list_portfolio_accounts) | **GET** /portfolio/accounts | Get portfolio account information
*PortfolioApi* | [**list_account_portfolio_mode**](docs/PortfolioApi.md#list_account_portfolio_mode) | **GET** /portfolio/account_mode | Retrieve the account's portfolio mode
*PortfolioApi* | [**set_account_portfolio_mode**](docs/PortfolioApi.md#set_account_portfolio_mode) | **POST** /portfolio/account_mode | Configure the account's portfolio mode.
*PortfolioApi* | [**get_portfolio_borrowable**](docs/PortfolioApi.md#get_portfolio_borrowable) | **GET** /portfolio/borrowable | Retrieve the maximum borrowable amount for the account.
*PortfolioApi* | [**get_portfolio_transferable**](docs/PortfolioApi.md#get_portfolio_transferable) | **GET** /portfolio/transferable | Retrieve the maximum amount that can be transferred out from the account
*PortfolioApi* | [**list_portfolio_uni_loan_interest_records**](docs/PortfolioApi.md#list_portfolio_uni_loan_interest_records) | **GET** /portfolio/loans | List loans
*PortfolioApi* | [**create_portfolio_loan**](docs/PortfolioApi.md#create_portfolio_loan) | **POST** /portfolio/loans | Borrow or repay
*PortfolioApi* | [**list_portfolio_loan_records**](docs/PortfolioApi.md#list_portfolio_loan_records) | **GET** /portfolio/loan_records | Get load records
*PortfolioApi* | [**list_portfolio_loan_interest_records**](docs/PortfolioApi.md#list_portfolio_loan_interest_records) | **GET** /portfolio/interest_records | List interest records
*SubAccountApi* | [**list_sub_accounts**](docs/SubAccountApi.md#list_sub_accounts) | **GET** /sub_accounts | List sub-accounts
*SubAccountApi* | [**create_sub_accounts**](docs/SubAccountApi.md#create_sub_accounts) | **POST** /sub_accounts | Create a new sub-account
*SubAccountApi* | [**get_sub_account**](docs/SubAccountApi.md#get_sub_account) | **GET** /sub_accounts/{user_id} | Get the sub-account
Expand All @@ -143,6 +134,15 @@ Class | Method | HTTP request | Description
*SubAccountApi* | [**delete_sub_account_keys**](docs/SubAccountApi.md#delete_sub_account_keys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete API key of the sub-account
*SubAccountApi* | [**lock_sub_account**](docs/SubAccountApi.md#lock_sub_account) | **POST** /sub_accounts/{user_id}/lock | Lock the sub-account
*SubAccountApi* | [**unlock_sub_account**](docs/SubAccountApi.md#unlock_sub_account) | **POST** /sub_accounts/{user_id}/unlock | Unlock the sub-account
*UnifiedApi* | [**list_unified_accounts**](docs/UnifiedApi.md#list_unified_accounts) | **GET** /unified/accounts | Get unified account information
*UnifiedApi* | [**list_unified_account_mode**](docs/UnifiedApi.md#list_unified_account_mode) | **GET** /unified/account_mode | Query mode of the unified account
*UnifiedApi* | [**set_unified_account_mode**](docs/UnifiedApi.md#set_unified_account_mode) | **POST** /unified/account_mode | Set mode of the unified account
*UnifiedApi* | [**get_unified_borrowable**](docs/UnifiedApi.md#get_unified_borrowable) | **GET** /unified/borrowable | Query about the maximum borrowing for the unified account
*UnifiedApi* | [**get_unified_transferable**](docs/UnifiedApi.md#get_unified_transferable) | **GET** /unified/transferable | Query about the maximum transferable for the unified account
*UnifiedApi* | [**list_unified_loans**](docs/UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | List loans
*UnifiedApi* | [**create_unified_loan**](docs/UnifiedApi.md#create_unified_loan) | **POST** /unified/loans | Borrow or repay
*UnifiedApi* | [**list_unified_loan_records**](docs/UnifiedApi.md#list_unified_loan_records) | **GET** /unified/loan_records | Get load records
*UnifiedApi* | [**list_unified_loan_interest_records**](docs/UnifiedApi.md#list_unified_loan_interest_records) | **GET** /unified/interest_records | List interest records
*AccountApi* | [**get_account_detail**](docs/AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail
*AccountApi* | [**list_stp_groups**](docs/AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | List STP Groups
*AccountApi* | [**create_stp_group**](docs/AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP Group
Expand Down Expand Up @@ -187,6 +187,14 @@ Class | Method | HTTP request | Description
*DeliveryApi* | [**cancel_price_triggered_delivery_order_list**](docs/DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all open orders
*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
*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
*EarnApi* | [**swap_eth2**](docs/EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap
*EarnApi* | [**list_dual_investment_plans**](docs/EarnApi.md#list_dual_investment_plans) | **GET** /earn/dual/investment_plan | Dual Investment product list
*EarnApi* | [**list_dual_orders**](docs/EarnApi.md#list_dual_orders) | **GET** /earn/dual/orders | Dual Investment order list
*EarnApi* | [**place_dual_order**](docs/EarnApi.md#place_dual_order) | **POST** /earn/dual/orders | Place Dual Investment order
*EarnApi* | [**cancel_dual_order**](docs/EarnApi.md#cancel_dual_order) | **DELETE** /earn/dual/orders/{order_id} | Cancel Dual Investment order
*EarnApi* | [**list_structured_products**](docs/EarnApi.md#list_structured_products) | **GET** /earn/structured/products | Structured Product List
*EarnApi* | [**list_structured_orders**](docs/EarnApi.md#list_structured_orders) | **GET** /earn/structured/orders | Structured Product Order List
*EarnApi* | [**place_structured_order**](docs/EarnApi.md#place_structured_order) | **POST** /earn/structured/orders | Place Structured Product Order
*FlashSwapApi* | [**list_flash_swap_currencies**](docs/FlashSwapApi.md#list_flash_swap_currencies) | **GET** /flash_swap/currencies | List All Supported Currencies In Flash Swap (deprecated)
*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
*FlashSwapApi* | [**list_flash_swap_orders**](docs/FlashSwapApi.md#list_flash_swap_orders) | **GET** /flash_swap/orders | List all flash swap orders
Expand Down Expand Up @@ -392,6 +400,9 @@ Class | Method | HTTP request | Description
- [DeliveryContract](docs/DeliveryContract.md)
- [DeliverySettlement](docs/DeliverySettlement.md)
- [DepositAddress](docs/DepositAddress.md)
- [DualGetOrders](docs/DualGetOrders.md)
- [DualGetPlans](docs/DualGetPlans.md)
- [Eth2Swap](docs/Eth2Swap.md)
- [FlashSwapCurrency](docs/FlashSwapCurrency.md)
- [FlashSwapCurrencyPair](docs/FlashSwapCurrencyPair.md)
- [FlashSwapOrder](docs/FlashSwapOrder.md)
Expand Down Expand Up @@ -457,13 +468,7 @@ Class | Method | HTTP request | Description
- [OrderPatch](docs/OrderPatch.md)
- [OrderResp](docs/OrderResp.md)
- [PatchUniLend](docs/PatchUniLend.md)
- [PortfolioAccount](docs/PortfolioAccount.md)
- [PortfolioBorrowable](docs/PortfolioBorrowable.md)
- [PortfolioLoan](docs/PortfolioLoan.md)
- [PortfolioLoanRecord](docs/PortfolioLoanRecord.md)
- [PortfolioMarginBalance](docs/PortfolioMarginBalance.md)
- [PortfolioMode](docs/PortfolioMode.md)
- [PortfolioTransferable](docs/PortfolioTransferable.md)
- [PlaceDualInvestmentOrder](docs/PlaceDualInvestmentOrder.md)
- [Position](docs/Position.md)
- [PositionClose](docs/PositionClose.md)
- [PositionCloseOrder](docs/PositionCloseOrder.md)
Expand All @@ -481,6 +486,11 @@ Class | Method | HTTP request | Description
- [SpotPriceTriggeredOrder](docs/SpotPriceTriggeredOrder.md)
- [StpGroup](docs/StpGroup.md)
- [StpGroupUser](docs/StpGroupUser.md)
- [StructuredBuy](docs/StructuredBuy.md)
- [StructuredGetProjectList](docs/StructuredGetProjectList.md)
- [StructuredGetProjectListRequest](docs/StructuredGetProjectListRequest.md)
- [StructuredOrderList](docs/StructuredOrderList.md)
- [StructuredOrderListRequest](docs/StructuredOrderListRequest.md)
- [SubAccount](docs/SubAccount.md)
- [SubAccountBalance](docs/SubAccountBalance.md)
- [SubAccountCrossMarginBalance](docs/SubAccountCrossMarginBalance.md)
Expand Down Expand Up @@ -510,9 +520,17 @@ Class | Method | HTTP request | Description
- [UniLoan](docs/UniLoan.md)
- [UniLoanInterestRecord](docs/UniLoanInterestRecord.md)
- [UniLoanRecord](docs/UniLoanRecord.md)
- [UnifiedAccount](docs/UnifiedAccount.md)
- [UnifiedBalance](docs/UnifiedBalance.md)
- [UnifiedBorrowable](docs/UnifiedBorrowable.md)
- [UnifiedLoan](docs/UnifiedLoan.md)
- [UnifiedLoanRecord](docs/UnifiedLoanRecord.md)
- [UnifiedMode](docs/UnifiedMode.md)
- [UnifiedTransferable](docs/UnifiedTransferable.md)
- [UserLtvInfo](docs/UserLtvInfo.md)
- [UserTotalAmount](docs/UserTotalAmount.md)
- [WithdrawStatus](docs/WithdrawStatus.md)
- [WithdrawalRecord](docs/WithdrawalRecord.md)


## Documentation For Authorization
Expand Down
1 change: 1 addition & 0 deletions docs/AccountDetail.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**ip_whitelist** | **list[str]** | IP whitelist | [optional]
**currency_pairs** | **list[str]** | CurrencyPair whitelisting | [optional]
**user_id** | **int** | User ID | [optional]
**tier** | **int** | User VIP level | [optional]
**key** | [**AccountDetailKey**](AccountDetailKey.md) | | [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
2 changes: 1 addition & 1 deletion docs/AmendOrderResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
**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]
**account** | **str** | Account types, spot - spot account, margin - margin account, unified - unified 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)

Expand Down
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- account: Account - portfolio: Portfolio - loan: Loan | [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\\m- account: Account - unified: unified - 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
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, portfolio - portfolio account | [optional] [default to 'spot']
**account** | **str** | Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account, unified - unified account | [optional] [default to 'spot']
**side** | **str** | Order side | [optional]
**amount** | **str** | Trade amount | [optional]
**price** | **str** | Order price | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/Contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Name | Type | Description | Notes
**enable_bonus** | **bool** | Whether bouns is enabled | [optional]
**enable_credit** | **bool** | Whether portfolio margin account is enabled | [optional]
**create_time** | **float** | Created time of the contract | [optional]
**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]

[[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
1 change: 1 addition & 0 deletions docs/CrossMarginCurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**user_max_borrow_amount** | **str** | Maximum borrow value allowed per user, in USDT | [optional]
**total_max_borrow_amount** | **str** | Maximum borrow value allowed for this currency, in USDT | [optional]
**price** | **str** | Price change between this currency and USDT | [optional]
**loanable** | **bool** | Whether currency is borrowed | [optional]
**status** | **int** | status - `0` : disable - `1` : enable | [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
2 changes: 2 additions & 0 deletions docs/CurrencyPair.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Name | Type | Description | Notes
**fee** | **str** | Trading fee | [optional]
**min_base_amount** | **str** | Minimum amount of base currency to trade, `null` means no limit | [optional]
**min_quote_amount** | **str** | Minimum amount of quote currency to trade, `null` means no limit | [optional]
**max_base_amount** | **str** | Maximum amount of base currency to trade, `null` means no limit | [optional]
**max_quote_amount** | **str** | Maximum amount of quote currency to trade, `null` means no limit | [optional]
**amount_precision** | **int** | Amount scale | [optional]
**precision** | **int** | Price scale | [optional]
**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]
Expand Down
25 changes: 25 additions & 0 deletions docs/DualGetOrders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# DualGetOrders

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Order ID | [optional]
**plan_id** | **int** | Plan ID | [optional]
**copies** | **str** | Copies | [optional]
**invest_amount** | **str** | Investment Amount | [optional]
**settlement_amount** | **str** | Settlement Amount | [optional]
**create_time** | **int** | Creation time | [optional]
**complete_time** | **int** | Completion Time | [optional]
**status** | **str** | Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed | [optional]
**invest_currency** | **str** | Investment Currency | [optional]
**exercise_currency** | **str** | Strike Currency | [optional]
**exercise_price** | **str** | Strike price | [optional]
**settlement_price** | **str** | settlement price | [optional]
**settlement_currency** | **str** | Settle currency | [optional]
**apy_display** | **str** | APY | [optional]
**apy_settlement** | **str** | Settlement APY | [optional]
**delivery_time** | **int** | Settlement time | [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)


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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Plan ID | [optional]
**instrument_name** | **str** | Instrument Name | [optional]
**invest_currency** | **str** | Investment Currency | [optional]
**exercise_currency** | **str** | Strike Currency | [optional]
**exercise_price** | **float** | Strike price | [optional]
**delivery_time** | **int** | Settlement time | [optional]
**min_copies** | **int** | Minimum Copies | [optional]
**max_copies** | **int** | Maximum Copies | [optional]
**per_value** | **str** | Per Unit Value | [optional]
**apy_display** | **str** | APY | [optional]
**start_time** | **int** | start time | [optional]
**end_time** | **int** | Finished time | [optional]
**status** | **str** | Status: `NOTSTARTED`-not started `ONGOING`-ongoing `ENDED`-ended | [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)


Loading

0 comments on commit f3b6eaa

Please sign in to comment.