diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
new file mode 100644
index 0000000..e922d81
--- /dev/null
+++ b/.github/workflows/python-publish.yml
@@ -0,0 +1,31 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on: push
+
+jobs:
+ deploy:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: '3.x'
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install setuptools wheel twine
+ - name: Build and publish
+ run: |
+ python setup.py sdist bdist_wheel
+ - name: Publish package
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+ uses: pypa/gh-action-pypi-publish@v1.4.2
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/README.md b/README.md
index a407d5e..802396f 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,13 @@
# gate-api
-Welcome to Gate.io API
-
-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.
+Welcome to Gate API
+APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-- API version: 4.88.0
-- Package version: 4.88.0
+- API version: v4.105.8
+- Package version: 7.1.8
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
-For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
+For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts)
## Versioning
@@ -88,7 +87,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.EarnUniApi(api_client)
try:
- # List currencies for lending
+ # Query lending currency list
api_response = api_instance.list_uni_currencies()
print(api_response)
except GateApiException as ex:
@@ -106,298 +105,285 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
-*EarnUniApi* | [**list_uni_currencies**](docs/EarnUniApi.md#list_uni_currencies) | **GET** /earn/uni/currencies | List currencies for lending
-*EarnUniApi* | [**get_uni_currency**](docs/EarnUniApi.md#get_uni_currency) | **GET** /earn/uni/currencies/{currency} | Get currency detail for lending
-*EarnUniApi* | [**list_user_uni_lends**](docs/EarnUniApi.md#list_user_uni_lends) | **GET** /earn/uni/lends | List user's lending orders
-*EarnUniApi* | [**create_uni_lend**](docs/EarnUniApi.md#create_uni_lend) | **POST** /earn/uni/lends | Lend or redeem
-*EarnUniApi* | [**change_uni_lend**](docs/EarnUniApi.md#change_uni_lend) | **PATCH** /earn/uni/lends | Amend lending order
-*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
+*EarnUniApi* | [**list_uni_currencies**](docs/EarnUniApi.md#list_uni_currencies) | **GET** /earn/uni/currencies | Query lending currency list
+*EarnUniApi* | [**get_uni_currency**](docs/EarnUniApi.md#get_uni_currency) | **GET** /earn/uni/currencies/{currency} | Query single lending currency details
+*EarnUniApi* | [**list_user_uni_lends**](docs/EarnUniApi.md#list_user_uni_lends) | **GET** /earn/uni/lends | Query user's lending order list
+*EarnUniApi* | [**create_uni_lend**](docs/EarnUniApi.md#create_uni_lend) | **POST** /earn/uni/lends | Create lending or redemption
+*EarnUniApi* | [**change_uni_lend**](docs/EarnUniApi.md#change_uni_lend) | **PATCH** /earn/uni/lends | Amend user lending information
+*EarnUniApi* | [**list_uni_lend_records**](docs/EarnUniApi.md#list_uni_lend_records) | **GET** /earn/uni/lend_records | Query lending transaction records
+*EarnUniApi* | [**get_uni_interest**](docs/EarnUniApi.md#get_uni_interest) | **GET** /earn/uni/interests/{currency} | Query user's total interest income for specified currency
+*EarnUniApi* | [**list_uni_interest_records**](docs/EarnUniApi.md#list_uni_interest_records) | **GET** /earn/uni/interest_records | Query user dividend records
+*EarnUniApi* | [**get_uni_interest_status**](docs/EarnUniApi.md#get_uni_interest_status) | **GET** /earn/uni/interest_status/{currency} | Query currency interest compounding status
+*EarnUniApi* | [**list_uni_chart**](docs/EarnUniApi.md#list_uni_chart) | **GET** /earn/uni/chart | UniLoan currency annualized trend chart
+*EarnUniApi* | [**list_uni_rate**](docs/EarnUniApi.md#list_uni_rate) | **GET** /earn/uni/rate | Currency estimated annualized interest rate
*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
-*MarginUniApi* | [**list_uni_loans**](docs/MarginUniApi.md#list_uni_loans) | **GET** /margin/uni/loans | List loans
+*MarginUniApi* | [**get_uni_currency_pair**](docs/MarginUniApi.md#get_uni_currency_pair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get lending market details
+*MarginUniApi* | [**get_margin_uni_estimate_rate**](docs/MarginUniApi.md#get_margin_uni_estimate_rate) | **GET** /margin/uni/estimate_rate | Estimate interest rate for isolated margin currencies
+*MarginUniApi* | [**list_uni_loans**](docs/MarginUniApi.md#list_uni_loans) | **GET** /margin/uni/loans | Query loans
*MarginUniApi* | [**create_uni_loan**](docs/MarginUniApi.md#create_uni_loan) | **POST** /margin/uni/loans | Borrow or repay
-*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
+*MarginUniApi* | [**list_uni_loan_records**](docs/MarginUniApi.md#list_uni_loan_records) | **GET** /margin/uni/loan_records | Query loan records
+*MarginUniApi* | [**list_uni_loan_interest_records**](docs/MarginUniApi.md#list_uni_loan_interest_records) | **GET** /margin/uni/interest_records | Query interest deduction records
+*MarginUniApi* | [**get_uni_borrowable**](docs/MarginUniApi.md#get_uni_borrowable) | **GET** /margin/uni/borrowable | Query maximum borrowable amount by currency
*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
-*SubAccountApi* | [**list_sub_account_keys**](docs/SubAccountApi.md#list_sub_account_keys) | **GET** /sub_accounts/{user_id}/keys | List all API Key of the sub-account
-*SubAccountApi* | [**create_sub_account_keys**](docs/SubAccountApi.md#create_sub_account_keys) | **POST** /sub_accounts/{user_id}/keys | Create API Key of the sub-account
-*SubAccountApi* | [**get_sub_account_key**](docs/SubAccountApi.md#get_sub_account_key) | **GET** /sub_accounts/{user_id}/keys/{key} | Get the API Key of the sub-account
-*SubAccountApi* | [**update_sub_account_keys**](docs/SubAccountApi.md#update_sub_account_keys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update API key of the sub-account
-*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
+*SubAccountApi* | [**get_sub_account**](docs/SubAccountApi.md#get_sub_account) | **GET** /sub_accounts/{user_id} | Get sub-account
+*SubAccountApi* | [**list_sub_account_keys**](docs/SubAccountApi.md#list_sub_account_keys) | **GET** /sub_accounts/{user_id}/keys | List all API key pairs of the sub-account
+*SubAccountApi* | [**create_sub_account_keys**](docs/SubAccountApi.md#create_sub_account_keys) | **POST** /sub_accounts/{user_id}/keys | Create new sub-account API key pair
+*SubAccountApi* | [**get_sub_account_key**](docs/SubAccountApi.md#get_sub_account_key) | **GET** /sub_accounts/{user_id}/keys/{key} | Get specific API key pair of the sub-account
+*SubAccountApi* | [**update_sub_account_keys**](docs/SubAccountApi.md#update_sub_account_keys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update sub-account API key pair
+*SubAccountApi* | [**delete_sub_account_keys**](docs/SubAccountApi.md#delete_sub_account_keys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete sub-account API key pair
+*SubAccountApi* | [**lock_sub_account**](docs/SubAccountApi.md#lock_sub_account) | **POST** /sub_accounts/{user_id}/lock | Lock sub-account
+*SubAccountApi* | [**unlock_sub_account**](docs/SubAccountApi.md#unlock_sub_account) | **POST** /sub_accounts/{user_id}/unlock | Unlock sub-account
*SubAccountApi* | [**list_unified_mode**](docs/SubAccountApi.md#list_unified_mode) | **GET** /sub_accounts/unified_mode | Get sub-account mode
*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 | Inquire about unified account mode (deprecated)
-*UnifiedApi* | [**set_unified_account_mode**](docs/UnifiedApi.md#set_unified_account_mode) | **POST** /unified/account_mode | Set unified account mode (deprecated)
-*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* | [**get_unified_borrowable**](docs/UnifiedApi.md#get_unified_borrowable) | **GET** /unified/borrowable | Query maximum borrowable amount for unified account
+*UnifiedApi* | [**get_unified_transferable**](docs/UnifiedApi.md#get_unified_transferable) | **GET** /unified/transferable | Query maximum transferable amount for unified account
+*UnifiedApi* | [**get_unified_transferables**](docs/UnifiedApi.md#get_unified_transferables) | **GET** /unified/transferables | Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change
+*UnifiedApi* | [**get_unified_borrowable_list**](docs/UnifiedApi.md#get_unified_borrowable_list) | **GET** /unified/batch_borrowable | Batch query unified account maximum borrowable amount
+*UnifiedApi* | [**list_unified_loans**](docs/UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | Query 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
-*UnifiedApi* | [**get_unified_risk_units**](docs/UnifiedApi.md#get_unified_risk_units) | **GET** /unified/risk_units | Retrieve user risk unit details, only valid in portfolio margin mode
+*UnifiedApi* | [**list_unified_loan_records**](docs/UnifiedApi.md#list_unified_loan_records) | **GET** /unified/loan_records | Query loan records
+*UnifiedApi* | [**list_unified_loan_interest_records**](docs/UnifiedApi.md#list_unified_loan_interest_records) | **GET** /unified/interest_records | Query interest deduction records
+*UnifiedApi* | [**get_unified_risk_units**](docs/UnifiedApi.md#get_unified_risk_units) | **GET** /unified/risk_units | Get user risk unit details
*UnifiedApi* | [**get_unified_mode**](docs/UnifiedApi.md#get_unified_mode) | **GET** /unified/unified_mode | Query mode of the unified account
-*UnifiedApi* | [**set_unified_mode**](docs/UnifiedApi.md#set_unified_mode) | **PUT** /unified/unified_mode | Set mode of the unified account
-*UnifiedApi* | [**get_unified_estimate_rate**](docs/UnifiedApi.md#get_unified_estimate_rate) | **GET** /unified/estimate_rate | Get unified estimate rate
-*UnifiedApi* | [**list_currency_discount_tiers**](docs/UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers
-*UnifiedApi* | [**list_loan_margin_tiers**](docs/UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers
+*UnifiedApi* | [**set_unified_mode**](docs/UnifiedApi.md#set_unified_mode) | **PUT** /unified/unified_mode | Set unified account mode
+*UnifiedApi* | [**get_unified_estimate_rate**](docs/UnifiedApi.md#get_unified_estimate_rate) | **GET** /unified/estimate_rate | Query unified account estimated interest rate
+*UnifiedApi* | [**list_currency_discount_tiers**](docs/UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered
+*UnifiedApi* | [**list_loan_margin_tiers**](docs/UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | Query unified account tiered loan margin
*UnifiedApi* | [**calculate_portfolio_margin**](docs/UnifiedApi.md#calculate_portfolio_margin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator
-*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:
-*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.
-*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
-*UnifiedApi* | [**get_history_loan_rate**](docs/UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | get historical lending rates
-*AccountApi* | [**get_account_detail**](docs/AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail
+*UnifiedApi* | [**get_user_leverage_currency_config**](docs/UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set
+*UnifiedApi* | [**get_user_leverage_currency_setting**](docs/UnifiedApi.md#get_user_leverage_currency_setting) | **GET** /unified/leverage/user_currency_setting | Get user currency leverage
+*UnifiedApi* | [**set_user_leverage_currency_setting**](docs/UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set loan currency leverage
+*UnifiedApi* | [**list_unified_currencies**](docs/UnifiedApi.md#list_unified_currencies) | **GET** /unified/currencies | List of loan currencies supported by unified account
+*UnifiedApi* | [**get_history_loan_rate**](docs/UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | Get historical lending rates
+*UnifiedApi* | [**set_unified_collateral**](docs/UnifiedApi.md#set_unified_collateral) | **POST** /unified/collateral_currencies | Set collateral currency
+*AccountApi* | [**get_account_detail**](docs/AccountApi.md#get_account_detail) | **GET** /account/detail | Retrieve user account information
*AccountApi* | [**get_account_rate_limit**](docs/AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information
-*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
-*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 | Delete the user in the STP group
-*AccountApi* | [**get_debit_fee**](docs/AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT deduction configuration.
-*AccountApi* | [**set_debit_fee**](docs/AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Set GT deduction.
-*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 | Repayment
-*CollateralLoanApi* | [**list_repay_records**](docs/CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | Repayment history
+*AccountApi* | [**list_stp_groups**](docs/AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | Query STP user groups created by the user
+*AccountApi* | [**create_stp_group**](docs/AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP user group
+*AccountApi* | [**list_stp_groups_users**](docs/AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | Query users in the STP user 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 user group
+*AccountApi* | [**delete_stp_group_users**](docs/AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group
+*AccountApi* | [**get_debit_fee**](docs/AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT fee deduction configuration
+*AccountApi* | [**set_debit_fee**](docs/AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Configure GT fee deduction
+*CollateralLoanApi* | [**list_collateral_loan_orders**](docs/CollateralLoanApi.md#list_collateral_loan_orders) | **GET** /loan/collateral/orders | Query collateral loan order list
+*CollateralLoanApi* | [**create_collateral_loan**](docs/CollateralLoanApi.md#create_collateral_loan) | **POST** /loan/collateral/orders | Place collateral loan order
+*CollateralLoanApi* | [**get_collateral_loan_order_detail**](docs/CollateralLoanApi.md#get_collateral_loan_order_detail) | **GET** /loan/collateral/orders/{order_id} | Query single order details
+*CollateralLoanApi* | [**repay_collateral_loan**](docs/CollateralLoanApi.md#repay_collateral_loan) | **POST** /loan/collateral/repay | Collateral loan repayment
+*CollateralLoanApi* | [**list_repay_records**](docs/CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | Query collateral loan repayment records
*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* | [**get_user_total_amount**](docs/CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | Query user's total borrowing and collateral amount
+*CollateralLoanApi* | [**get_user_ltv_info**](docs/CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | Query user's collateralization ratio and remaining borrowable currencies
*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
-*DeliveryApi* | [**list_delivery_trades**](docs/DeliveryApi.md#list_delivery_trades) | **GET** /delivery/{settle}/trades | Futures trading history
-*DeliveryApi* | [**list_delivery_candlesticks**](docs/DeliveryApi.md#list_delivery_candlesticks) | **GET** /delivery/{settle}/candlesticks | Get futures candlesticks
-*DeliveryApi* | [**list_delivery_tickers**](docs/DeliveryApi.md#list_delivery_tickers) | **GET** /delivery/{settle}/tickers | List futures tickers
-*DeliveryApi* | [**list_delivery_insurance_ledger**](docs/DeliveryApi.md#list_delivery_insurance_ledger) | **GET** /delivery/{settle}/insurance | Futures insurance balance history
-*DeliveryApi* | [**list_delivery_accounts**](docs/DeliveryApi.md#list_delivery_accounts) | **GET** /delivery/{settle}/accounts | Query futures account
-*DeliveryApi* | [**list_delivery_account_book**](docs/DeliveryApi.md#list_delivery_account_book) | **GET** /delivery/{settle}/account_book | Query account book
-*DeliveryApi* | [**list_delivery_positions**](docs/DeliveryApi.md#list_delivery_positions) | **GET** /delivery/{settle}/positions | List all positions of a user
-*DeliveryApi* | [**get_delivery_position**](docs/DeliveryApi.md#get_delivery_position) | **GET** /delivery/{settle}/positions/{contract} | Get single position
+*DeliveryApi* | [**list_delivery_contracts**](docs/DeliveryApi.md#list_delivery_contracts) | **GET** /delivery/{settle}/contracts | Query all futures contracts
+*DeliveryApi* | [**get_delivery_contract**](docs/DeliveryApi.md#get_delivery_contract) | **GET** /delivery/{settle}/contracts/{contract} | Query single contract information
+*DeliveryApi* | [**list_delivery_order_book**](docs/DeliveryApi.md#list_delivery_order_book) | **GET** /delivery/{settle}/order_book | Query futures market depth information
+*DeliveryApi* | [**list_delivery_trades**](docs/DeliveryApi.md#list_delivery_trades) | **GET** /delivery/{settle}/trades | Futures market transaction records
+*DeliveryApi* | [**list_delivery_candlesticks**](docs/DeliveryApi.md#list_delivery_candlesticks) | **GET** /delivery/{settle}/candlesticks | Futures market K-line chart
+*DeliveryApi* | [**list_delivery_tickers**](docs/DeliveryApi.md#list_delivery_tickers) | **GET** /delivery/{settle}/tickers | Get all futures trading statistics
+*DeliveryApi* | [**list_delivery_insurance_ledger**](docs/DeliveryApi.md#list_delivery_insurance_ledger) | **GET** /delivery/{settle}/insurance | Futures market insurance fund history
+*DeliveryApi* | [**list_delivery_accounts**](docs/DeliveryApi.md#list_delivery_accounts) | **GET** /delivery/{settle}/accounts | Get futures account
+*DeliveryApi* | [**list_delivery_account_book**](docs/DeliveryApi.md#list_delivery_account_book) | **GET** /delivery/{settle}/account_book | Query futures account change history
+*DeliveryApi* | [**list_delivery_positions**](docs/DeliveryApi.md#list_delivery_positions) | **GET** /delivery/{settle}/positions | Get user position list
+*DeliveryApi* | [**get_delivery_position**](docs/DeliveryApi.md#get_delivery_position) | **GET** /delivery/{settle}/positions/{contract} | Get single position information
*DeliveryApi* | [**update_delivery_position_margin**](docs/DeliveryApi.md#update_delivery_position_margin) | **POST** /delivery/{settle}/positions/{contract}/margin | Update position margin
*DeliveryApi* | [**update_delivery_position_leverage**](docs/DeliveryApi.md#update_delivery_position_leverage) | **POST** /delivery/{settle}/positions/{contract}/leverage | Update position leverage
*DeliveryApi* | [**update_delivery_position_risk_limit**](docs/DeliveryApi.md#update_delivery_position_risk_limit) | **POST** /delivery/{settle}/positions/{contract}/risk_limit | Update position risk limit
-*DeliveryApi* | [**list_delivery_orders**](docs/DeliveryApi.md#list_delivery_orders) | **GET** /delivery/{settle}/orders | List futures orders
-*DeliveryApi* | [**create_delivery_order**](docs/DeliveryApi.md#create_delivery_order) | **POST** /delivery/{settle}/orders | Create a futures order
-*DeliveryApi* | [**cancel_delivery_orders**](docs/DeliveryApi.md#cancel_delivery_orders) | **DELETE** /delivery/{settle}/orders | Cancel all `open` orders matched
-*DeliveryApi* | [**get_delivery_order**](docs/DeliveryApi.md#get_delivery_order) | **GET** /delivery/{settle}/orders/{order_id} | Get a single order
-*DeliveryApi* | [**cancel_delivery_order**](docs/DeliveryApi.md#cancel_delivery_order) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel a single order
-*DeliveryApi* | [**get_my_delivery_trades**](docs/DeliveryApi.md#get_my_delivery_trades) | **GET** /delivery/{settle}/my_trades | List personal trading history
-*DeliveryApi* | [**list_delivery_position_close**](docs/DeliveryApi.md#list_delivery_position_close) | **GET** /delivery/{settle}/position_close | List position close history
-*DeliveryApi* | [**list_delivery_liquidates**](docs/DeliveryApi.md#list_delivery_liquidates) | **GET** /delivery/{settle}/liquidates | List liquidation history
-*DeliveryApi* | [**list_delivery_settlements**](docs/DeliveryApi.md#list_delivery_settlements) | **GET** /delivery/{settle}/settlements | List settlement history
-*DeliveryApi* | [**list_delivery_risk_limit_tiers**](docs/DeliveryApi.md#list_delivery_risk_limit_tiers) | **GET** /delivery/{settle}/risk_limit_tiers | List risk limit tiers
-*DeliveryApi* | [**list_price_triggered_delivery_orders**](docs/DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | List all auto orders
-*DeliveryApi* | [**create_price_triggered_delivery_order**](docs/DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order
-*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
+*DeliveryApi* | [**list_delivery_orders**](docs/DeliveryApi.md#list_delivery_orders) | **GET** /delivery/{settle}/orders | Query futures order list
+*DeliveryApi* | [**create_delivery_order**](docs/DeliveryApi.md#create_delivery_order) | **POST** /delivery/{settle}/orders | Place futures order
+*DeliveryApi* | [**cancel_delivery_orders**](docs/DeliveryApi.md#cancel_delivery_orders) | **DELETE** /delivery/{settle}/orders | Cancel all orders with 'open' status
+*DeliveryApi* | [**get_delivery_order**](docs/DeliveryApi.md#get_delivery_order) | **GET** /delivery/{settle}/orders/{order_id} | Query single order details
+*DeliveryApi* | [**cancel_delivery_order**](docs/DeliveryApi.md#cancel_delivery_order) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel single order
+*DeliveryApi* | [**get_my_delivery_trades**](docs/DeliveryApi.md#get_my_delivery_trades) | **GET** /delivery/{settle}/my_trades | Query personal trading records
+*DeliveryApi* | [**list_delivery_position_close**](docs/DeliveryApi.md#list_delivery_position_close) | **GET** /delivery/{settle}/position_close | Query position close history
+*DeliveryApi* | [**list_delivery_liquidates**](docs/DeliveryApi.md#list_delivery_liquidates) | **GET** /delivery/{settle}/liquidates | Query liquidation history
+*DeliveryApi* | [**list_delivery_settlements**](docs/DeliveryApi.md#list_delivery_settlements) | **GET** /delivery/{settle}/settlements | Query settlement records
+*DeliveryApi* | [**list_delivery_risk_limit_tiers**](docs/DeliveryApi.md#list_delivery_risk_limit_tiers) | **GET** /delivery/{settle}/risk_limit_tiers | Query risk limit tiers
+*DeliveryApi* | [**list_price_triggered_delivery_orders**](docs/DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | Query auto order list
+*DeliveryApi* | [**create_price_triggered_delivery_order**](docs/DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create price-triggered order
+*DeliveryApi* | [**cancel_price_triggered_delivery_order_list**](docs/DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all auto orders
+*DeliveryApi* | [**get_price_triggered_delivery_order**](docs/DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Query single auto order details
+*DeliveryApi* | [**cancel_price_triggered_delivery_order**](docs/DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | Cancel single auto order
*EarnApi* | [**swap_eth2**](docs/EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap
+*EarnApi* | [**rate_list_eth2**](docs/EarnApi.md#rate_list_eth2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical return rate query
*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* | [**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)
+*EarnApi* | [**find_coin**](docs/EarnApi.md#find_coin) | **GET** /earn/staking/coins | Staking coins
+*EarnApi* | [**swap_staking_coin**](docs/EarnApi.md#swap_staking_coin) | **POST** /earn/staking/swap | On-chain token swap for earned coins
*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
+*FlashSwapApi* | [**list_flash_swap_orders**](docs/FlashSwapApi.md#list_flash_swap_orders) | **GET** /flash_swap/orders | Query flash swap order list
*FlashSwapApi* | [**create_flash_swap_order**](docs/FlashSwapApi.md#create_flash_swap_order) | **POST** /flash_swap/orders | Create a flash swap order
-*FlashSwapApi* | [**get_flash_swap_order**](docs/FlashSwapApi.md#get_flash_swap_order) | **GET** /flash_swap/orders/{order_id} | Get a single flash swap order's detail
-*FlashSwapApi* | [**preview_flash_swap_order**](docs/FlashSwapApi.md#preview_flash_swap_order) | **POST** /flash_swap/orders/preview | Initiate a flash swap order preview
-*FuturesApi* | [**list_futures_contracts**](docs/FuturesApi.md#list_futures_contracts) | **GET** /futures/{settle}/contracts | List all futures contracts
-*FuturesApi* | [**get_futures_contract**](docs/FuturesApi.md#get_futures_contract) | **GET** /futures/{settle}/contracts/{contract} | Get a single contract
-*FuturesApi* | [**list_futures_order_book**](docs/FuturesApi.md#list_futures_order_book) | **GET** /futures/{settle}/order_book | Futures order book
-*FuturesApi* | [**list_futures_trades**](docs/FuturesApi.md#list_futures_trades) | **GET** /futures/{settle}/trades | Futures trading history
-*FuturesApi* | [**list_futures_candlesticks**](docs/FuturesApi.md#list_futures_candlesticks) | **GET** /futures/{settle}/candlesticks | Get futures candlesticks
-*FuturesApi* | [**list_futures_premium_index**](docs/FuturesApi.md#list_futures_premium_index) | **GET** /futures/{settle}/premium_index | Premium Index K-Line
-*FuturesApi* | [**list_futures_tickers**](docs/FuturesApi.md#list_futures_tickers) | **GET** /futures/{settle}/tickers | List futures tickers
-*FuturesApi* | [**list_futures_funding_rate_history**](docs/FuturesApi.md#list_futures_funding_rate_history) | **GET** /futures/{settle}/funding_rate | Funding rate history
-*FuturesApi* | [**list_futures_insurance_ledger**](docs/FuturesApi.md#list_futures_insurance_ledger) | **GET** /futures/{settle}/insurance | Futures insurance balance history
-*FuturesApi* | [**list_contract_stats**](docs/FuturesApi.md#list_contract_stats) | **GET** /futures/{settle}/contract_stats | Futures stats
-*FuturesApi* | [**get_index_constituents**](docs/FuturesApi.md#get_index_constituents) | **GET** /futures/{settle}/index_constituents/{index} | Get index constituents
-*FuturesApi* | [**list_liquidated_orders**](docs/FuturesApi.md#list_liquidated_orders) | **GET** /futures/{settle}/liq_orders | Retrieve liquidation history
-*FuturesApi* | [**list_futures_risk_limit_tiers**](docs/FuturesApi.md#list_futures_risk_limit_tiers) | **GET** /futures/{settle}/risk_limit_tiers | List risk limit tiers
-*FuturesApi* | [**list_futures_accounts**](docs/FuturesApi.md#list_futures_accounts) | **GET** /futures/{settle}/accounts | Query futures account
-*FuturesApi* | [**list_futures_account_book**](docs/FuturesApi.md#list_futures_account_book) | **GET** /futures/{settle}/account_book | Query account book
-*FuturesApi* | [**list_positions**](docs/FuturesApi.md#list_positions) | **GET** /futures/{settle}/positions | List all positions of a user
-*FuturesApi* | [**get_position**](docs/FuturesApi.md#get_position) | **GET** /futures/{settle}/positions/{contract} | Get single position
+*FlashSwapApi* | [**get_flash_swap_order**](docs/FlashSwapApi.md#get_flash_swap_order) | **GET** /flash_swap/orders/{order_id} | Query single flash swap order
+*FlashSwapApi* | [**preview_flash_swap_order**](docs/FlashSwapApi.md#preview_flash_swap_order) | **POST** /flash_swap/orders/preview | Flash swap order preview
+*FuturesApi* | [**list_futures_contracts**](docs/FuturesApi.md#list_futures_contracts) | **GET** /futures/{settle}/contracts | Query all futures contracts
+*FuturesApi* | [**get_futures_contract**](docs/FuturesApi.md#get_futures_contract) | **GET** /futures/{settle}/contracts/{contract} | Query single contract information
+*FuturesApi* | [**list_futures_order_book**](docs/FuturesApi.md#list_futures_order_book) | **GET** /futures/{settle}/order_book | Query futures market depth information
+*FuturesApi* | [**list_futures_trades**](docs/FuturesApi.md#list_futures_trades) | **GET** /futures/{settle}/trades | Futures market transaction records
+*FuturesApi* | [**list_futures_candlesticks**](docs/FuturesApi.md#list_futures_candlesticks) | **GET** /futures/{settle}/candlesticks | Futures market K-line chart
+*FuturesApi* | [**list_futures_premium_index**](docs/FuturesApi.md#list_futures_premium_index) | **GET** /futures/{settle}/premium_index | Premium Index K-line chart
+*FuturesApi* | [**list_futures_tickers**](docs/FuturesApi.md#list_futures_tickers) | **GET** /futures/{settle}/tickers | Get all futures trading statistics
+*FuturesApi* | [**list_futures_funding_rate_history**](docs/FuturesApi.md#list_futures_funding_rate_history) | **GET** /futures/{settle}/funding_rate | Futures market historical funding rate
+*FuturesApi* | [**list_futures_insurance_ledger**](docs/FuturesApi.md#list_futures_insurance_ledger) | **GET** /futures/{settle}/insurance | Futures market insurance fund history
+*FuturesApi* | [**list_contract_stats**](docs/FuturesApi.md#list_contract_stats) | **GET** /futures/{settle}/contract_stats | Futures statistics
+*FuturesApi* | [**get_index_constituents**](docs/FuturesApi.md#get_index_constituents) | **GET** /futures/{settle}/index_constituents/{index} | Query index constituents
+*FuturesApi* | [**list_liquidated_orders**](docs/FuturesApi.md#list_liquidated_orders) | **GET** /futures/{settle}/liq_orders | Query liquidation order history
+*FuturesApi* | [**list_futures_risk_limit_tiers**](docs/FuturesApi.md#list_futures_risk_limit_tiers) | **GET** /futures/{settle}/risk_limit_tiers | Query risk limit tiers
+*FuturesApi* | [**list_futures_accounts**](docs/FuturesApi.md#list_futures_accounts) | **GET** /futures/{settle}/accounts | Get futures account
+*FuturesApi* | [**list_futures_account_book**](docs/FuturesApi.md#list_futures_account_book) | **GET** /futures/{settle}/account_book | Query futures account change history
+*FuturesApi* | [**list_positions**](docs/FuturesApi.md#list_positions) | **GET** /futures/{settle}/positions | Get user position list
+*FuturesApi* | [**get_position**](docs/FuturesApi.md#get_position) | **GET** /futures/{settle}/positions/{contract} | Get single position information
*FuturesApi* | [**update_position_margin**](docs/FuturesApi.md#update_position_margin) | **POST** /futures/{settle}/positions/{contract}/margin | Update position margin
*FuturesApi* | [**update_position_leverage**](docs/FuturesApi.md#update_position_leverage) | **POST** /futures/{settle}/positions/{contract}/leverage | Update position leverage
+*FuturesApi* | [**update_position_cross_mode**](docs/FuturesApi.md#update_position_cross_mode) | **POST** /futures/{settle}/positions/cross_mode | Switch Position Margin Mode
+*FuturesApi* | [**update_dual_comp_position_cross_mode**](docs/FuturesApi.md#update_dual_comp_position_cross_mode) | **POST** /futures/{settle}/dual_comp/positions/cross_mode | Switch Between Cross and Isolated Margin Modes Under Hedge Mode
*FuturesApi* | [**update_position_risk_limit**](docs/FuturesApi.md#update_position_risk_limit) | **POST** /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit
-*FuturesApi* | [**set_dual_mode**](docs/FuturesApi.md#set_dual_mode) | **POST** /futures/{settle}/dual_mode | Enable or disable dual mode
-*FuturesApi* | [**get_dual_mode_position**](docs/FuturesApi.md#get_dual_mode_position) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Retrieve position detail in dual mode
+*FuturesApi* | [**set_dual_mode**](docs/FuturesApi.md#set_dual_mode) | **POST** /futures/{settle}/dual_mode | Set position mode
+*FuturesApi* | [**get_dual_mode_position**](docs/FuturesApi.md#get_dual_mode_position) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Get position information in dual mode
*FuturesApi* | [**update_dual_mode_position_margin**](docs/FuturesApi.md#update_dual_mode_position_margin) | **POST** /futures/{settle}/dual_comp/positions/{contract}/margin | Update position margin in dual mode
*FuturesApi* | [**update_dual_mode_position_leverage**](docs/FuturesApi.md#update_dual_mode_position_leverage) | **POST** /futures/{settle}/dual_comp/positions/{contract}/leverage | Update position leverage in dual mode
*FuturesApi* | [**update_dual_mode_position_risk_limit**](docs/FuturesApi.md#update_dual_mode_position_risk_limit) | **POST** /futures/{settle}/dual_comp/positions/{contract}/risk_limit | Update position risk limit in dual mode
-*FuturesApi* | [**list_futures_orders**](docs/FuturesApi.md#list_futures_orders) | **GET** /futures/{settle}/orders | List futures orders
-*FuturesApi* | [**create_futures_order**](docs/FuturesApi.md#create_futures_order) | **POST** /futures/{settle}/orders | Create a futures order
-*FuturesApi* | [**cancel_futures_orders**](docs/FuturesApi.md#cancel_futures_orders) | **DELETE** /futures/{settle}/orders | Cancel all `open` orders matched
-*FuturesApi* | [**get_orders_with_time_range**](docs/FuturesApi.md#get_orders_with_time_range) | **GET** /futures/{settle}/orders_timerange | List Futures Orders By Time Range
-*FuturesApi* | [**create_batch_futures_order**](docs/FuturesApi.md#create_batch_futures_order) | **POST** /futures/{settle}/batch_orders | Create a batch of futures orders
-*FuturesApi* | [**get_futures_order**](docs/FuturesApi.md#get_futures_order) | **GET** /futures/{settle}/orders/{order_id} | Get a single order
-*FuturesApi* | [**amend_futures_order**](docs/FuturesApi.md#amend_futures_order) | **PUT** /futures/{settle}/orders/{order_id} | Amend an order
-*FuturesApi* | [**cancel_futures_order**](docs/FuturesApi.md#cancel_futures_order) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel a single order
-*FuturesApi* | [**get_my_trades**](docs/FuturesApi.md#get_my_trades) | **GET** /futures/{settle}/my_trades | List personal trading history
-*FuturesApi* | [**get_my_trades_with_time_range**](docs/FuturesApi.md#get_my_trades_with_time_range) | **GET** /futures/{settle}/my_trades_timerange | List personal trading history by time range
-*FuturesApi* | [**list_position_close**](docs/FuturesApi.md#list_position_close) | **GET** /futures/{settle}/position_close | List position close history
-*FuturesApi* | [**list_liquidates**](docs/FuturesApi.md#list_liquidates) | **GET** /futures/{settle}/liquidates | List liquidation history
-*FuturesApi* | [**list_auto_deleverages**](docs/FuturesApi.md#list_auto_deleverages) | **GET** /futures/{settle}/auto_deleverages | List Auto-Deleveraging History
+*FuturesApi* | [**list_futures_orders**](docs/FuturesApi.md#list_futures_orders) | **GET** /futures/{settle}/orders | Query futures order list
+*FuturesApi* | [**create_futures_order**](docs/FuturesApi.md#create_futures_order) | **POST** /futures/{settle}/orders | Place futures order
+*FuturesApi* | [**cancel_futures_orders**](docs/FuturesApi.md#cancel_futures_orders) | **DELETE** /futures/{settle}/orders | Cancel all orders with 'open' status
+*FuturesApi* | [**get_orders_with_time_range**](docs/FuturesApi.md#get_orders_with_time_range) | **GET** /futures/{settle}/orders_timerange | Query futures order list by time range
+*FuturesApi* | [**create_batch_futures_order**](docs/FuturesApi.md#create_batch_futures_order) | **POST** /futures/{settle}/batch_orders | Place batch futures orders
+*FuturesApi* | [**get_futures_order**](docs/FuturesApi.md#get_futures_order) | **GET** /futures/{settle}/orders/{order_id} | Query single order details
+*FuturesApi* | [**amend_futures_order**](docs/FuturesApi.md#amend_futures_order) | **PUT** /futures/{settle}/orders/{order_id} | Amend single order
+*FuturesApi* | [**cancel_futures_order**](docs/FuturesApi.md#cancel_futures_order) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel single order
+*FuturesApi* | [**get_my_trades**](docs/FuturesApi.md#get_my_trades) | **GET** /futures/{settle}/my_trades | Query personal trading records
+*FuturesApi* | [**get_my_trades_with_time_range**](docs/FuturesApi.md#get_my_trades_with_time_range) | **GET** /futures/{settle}/my_trades_timerange | Query personal trading records by time range
+*FuturesApi* | [**list_position_close**](docs/FuturesApi.md#list_position_close) | **GET** /futures/{settle}/position_close | Query position close history
+*FuturesApi* | [**list_liquidates**](docs/FuturesApi.md#list_liquidates) | **GET** /futures/{settle}/liquidates | Query liquidation history
+*FuturesApi* | [**list_auto_deleverages**](docs/FuturesApi.md#list_auto_deleverages) | **GET** /futures/{settle}/auto_deleverages | Query ADL auto-deleveraging order information
*FuturesApi* | [**countdown_cancel_all_futures**](docs/FuturesApi.md#countdown_cancel_all_futures) | **POST** /futures/{settle}/countdown_cancel_all | Countdown cancel orders
-*FuturesApi* | [**get_futures_fee**](docs/FuturesApi.md#get_futures_fee) | **GET** /futures/{settle}/fee | Query user trading fee rates
-*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
-*FuturesApi* | [**amend_batch_future_orders**](docs/FuturesApi.md#amend_batch_future_orders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders with specified IDs
-*FuturesApi* | [**list_price_triggered_orders**](docs/FuturesApi.md#list_price_triggered_orders) | **GET** /futures/{settle}/price_orders | List all auto orders
-*FuturesApi* | [**create_price_triggered_order**](docs/FuturesApi.md#create_price_triggered_order) | **POST** /futures/{settle}/price_orders | Create a price-triggered order
-*FuturesApi* | [**cancel_price_triggered_order_list**](docs/FuturesApi.md#cancel_price_triggered_order_list) | **DELETE** /futures/{settle}/price_orders | Cancel all open orders
-*FuturesApi* | [**get_price_triggered_order**](docs/FuturesApi.md#get_price_triggered_order) | **GET** /futures/{settle}/price_orders/{order_id} | Get a price-triggered order
-*FuturesApi* | [**cancel_price_triggered_order**](docs/FuturesApi.md#cancel_price_triggered_order) | **DELETE** /futures/{settle}/price_orders/{order_id} | cancel a price-triggered order
+*FuturesApi* | [**get_futures_fee**](docs/FuturesApi.md#get_futures_fee) | **GET** /futures/{settle}/fee | Query futures market trading fee rates
+*FuturesApi* | [**cancel_batch_future_orders**](docs/FuturesApi.md#cancel_batch_future_orders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel batch orders by specified ID list
+*FuturesApi* | [**amend_batch_future_orders**](docs/FuturesApi.md#amend_batch_future_orders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders by specified IDs
+*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
+*FuturesApi* | [**list_price_triggered_orders**](docs/FuturesApi.md#list_price_triggered_orders) | **GET** /futures/{settle}/price_orders | Query auto order list
+*FuturesApi* | [**create_price_triggered_order**](docs/FuturesApi.md#create_price_triggered_order) | **POST** /futures/{settle}/price_orders | Create price-triggered order
+*FuturesApi* | [**cancel_price_triggered_order_list**](docs/FuturesApi.md#cancel_price_triggered_order_list) | **DELETE** /futures/{settle}/price_orders | Cancel all auto orders
+*FuturesApi* | [**get_price_triggered_order**](docs/FuturesApi.md#get_price_triggered_order) | **GET** /futures/{settle}/price_orders/{order_id} | Query single auto order details
+*FuturesApi* | [**cancel_price_triggered_order**](docs/FuturesApi.md#cancel_price_triggered_order) | **DELETE** /futures/{settle}/price_orders/{order_id} | Cancel single auto order
*MarginApi* | [**list_margin_accounts**](docs/MarginApi.md#list_margin_accounts) | **GET** /margin/accounts | Margin account list
-*MarginApi* | [**list_margin_account_book**](docs/MarginApi.md#list_margin_account_book) | **GET** /margin/account_book | List margin account balance change history
+*MarginApi* | [**list_margin_account_book**](docs/MarginApi.md#list_margin_account_book) | **GET** /margin/account_book | Query margin account balance change history
*MarginApi* | [**list_funding_accounts**](docs/MarginApi.md#list_funding_accounts) | **GET** /margin/funding_accounts | Funding account list
-*MarginApi* | [**get_auto_repay_status**](docs/MarginApi.md#get_auto_repay_status) | **GET** /margin/auto_repay | Retrieve user auto repayment setting
-*MarginApi* | [**set_auto_repay**](docs/MarginApi.md#set_auto_repay) | **POST** /margin/auto_repay | Update user's auto repayment setting
-*MarginApi* | [**get_margin_transferable**](docs/MarginApi.md#get_margin_transferable) | **GET** /margin/transferable | Get the max transferable amount for a specific margin currency
-*MarginApi* | [**list_margin_currency_pairs**](docs/MarginApi.md#list_margin_currency_pairs) | **GET** /margin/currency_pairs | List all supported currency pairs supported in margin trading(Deprecated)
-*MarginApi* | [**get_margin_currency_pair**](docs/MarginApi.md#get_margin_currency_pair) | **GET** /margin/currency_pairs/{currency_pair} | Query one single margin currency pair(Deprecated)
-*MarginApi* | [**list_funding_book**](docs/MarginApi.md#list_funding_book) | **GET** /margin/funding_book | Order book of lending loans(Deprecated)
-*MarginApi* | [**list_loans**](docs/MarginApi.md#list_loans) | **GET** /margin/loans | List all loans(Deprecated)
-*MarginApi* | [**create_loan**](docs/MarginApi.md#create_loan) | **POST** /margin/loans | Lend or borrow(Deprecated)
-*MarginApi* | [**merge_loans**](docs/MarginApi.md#merge_loans) | **POST** /margin/merged_loans | Merge multiple lending loans(Deprecated)
-*MarginApi* | [**get_loan**](docs/MarginApi.md#get_loan) | **GET** /margin/loans/{loan_id} | Retrieve one single loan detail(Deprecated)
-*MarginApi* | [**cancel_loan**](docs/MarginApi.md#cancel_loan) | **DELETE** /margin/loans/{loan_id} | Cancel lending loan(Deprecated)
-*MarginApi* | [**update_loan**](docs/MarginApi.md#update_loan) | **PATCH** /margin/loans/{loan_id} | Modify a loan(Deprecated)
-*MarginApi* | [**list_loan_repayments**](docs/MarginApi.md#list_loan_repayments) | **GET** /margin/loans/{loan_id}/repayment | List loan repayment records(Deprecated)
-*MarginApi* | [**repay_loan**](docs/MarginApi.md#repay_loan) | **POST** /margin/loans/{loan_id}/repayment | Repay a loan(Deprecated)
-*MarginApi* | [**list_loan_records**](docs/MarginApi.md#list_loan_records) | **GET** /margin/loan_records | List repayment records of a specific loan(Deprecated)
-*MarginApi* | [**get_loan_record**](docs/MarginApi.md#get_loan_record) | **GET** /margin/loan_records/{loan_record_id} | Get one single loan record(Deprecated)
-*MarginApi* | [**update_loan_record**](docs/MarginApi.md#update_loan_record) | **PATCH** /margin/loan_records/{loan_record_id} | Modify a loan record(Deprecated)
-*MarginApi* | [**get_margin_borrowable**](docs/MarginApi.md#get_margin_borrowable) | **GET** /margin/borrowable | Get the max borrowable amount for a specific margin currency(Deprecated)
-*MarginApi* | [**list_cross_margin_currencies**](docs/MarginApi.md#list_cross_margin_currencies) | **GET** /margin/cross/currencies | Currencies supported by cross margin.
-*MarginApi* | [**get_cross_margin_currency**](docs/MarginApi.md#get_cross_margin_currency) | **GET** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin
-*MarginApi* | [**get_cross_margin_account**](docs/MarginApi.md#get_cross_margin_account) | **GET** /margin/cross/accounts | Retrieve cross margin account
-*MarginApi* | [**list_cross_margin_account_book**](docs/MarginApi.md#list_cross_margin_account_book) | **GET** /margin/cross/account_book | Retrieve cross margin account change history
-*MarginApi* | [**list_cross_margin_loans**](docs/MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | List cross margin borrow history
-*MarginApi* | [**create_cross_margin_loan**](docs/MarginApi.md#create_cross_margin_loan) | **POST** /margin/cross/loans | Create a cross margin borrow loan
-*MarginApi* | [**get_cross_margin_loan**](docs/MarginApi.md#get_cross_margin_loan) | **GET** /margin/cross/loans/{loan_id} | Retrieve single borrow loan detail
-*MarginApi* | [**list_cross_margin_repayments**](docs/MarginApi.md#list_cross_margin_repayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments
-*MarginApi* | [**repay_cross_margin_loan**](docs/MarginApi.md#repay_cross_margin_loan) | **POST** /margin/cross/repayments | Cross margin repayments
-*MarginApi* | [**get_cross_margin_interest_records**](docs/MarginApi.md#get_cross_margin_interest_records) | **GET** /margin/cross/interest_records | Interest records for the cross margin account
-*MarginApi* | [**get_cross_margin_transferable**](docs/MarginApi.md#get_cross_margin_transferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency
-*MarginApi* | [**get_cross_margin_estimate_rate**](docs/MarginApi.md#get_cross_margin_estimate_rate) | **GET** /margin/cross/estimate_rate | Estimated interest rates
-*MarginApi* | [**get_cross_margin_borrowable**](docs/MarginApi.md#get_cross_margin_borrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency
-*MultiCollateralLoanApi* | [**list_multi_collateral_orders**](docs/MultiCollateralLoanApi.md#list_multi_collateral_orders) | **GET** /loan/multi_collateral/orders | List Multi-Collateral Orders
-*MultiCollateralLoanApi* | [**create_multi_collateral**](docs/MultiCollateralLoanApi.md#create_multi_collateral) | **POST** /loan/multi_collateral/orders | Create Multi-Collateral Order
-*MultiCollateralLoanApi* | [**get_multi_collateral_order_detail**](docs/MultiCollateralLoanApi.md#get_multi_collateral_order_detail) | **GET** /loan/multi_collateral/orders/{order_id} | Get Multi-Collateral Order Detail
-*MultiCollateralLoanApi* | [**list_multi_repay_records**](docs/MultiCollateralLoanApi.md#list_multi_repay_records) | **GET** /loan/multi_collateral/repay | List Multi-Collateral Repay Records
-*MultiCollateralLoanApi* | [**repay_multi_collateral_loan**](docs/MultiCollateralLoanApi.md#repay_multi_collateral_loan) | **POST** /loan/multi_collateral/repay | Repay Multi-Collateral Loan
+*MarginApi* | [**get_auto_repay_status**](docs/MarginApi.md#get_auto_repay_status) | **GET** /margin/auto_repay | Query user auto repayment settings
+*MarginApi* | [**set_auto_repay**](docs/MarginApi.md#set_auto_repay) | **POST** /margin/auto_repay | Update user auto repayment settings
+*MarginApi* | [**get_margin_transferable**](docs/MarginApi.md#get_margin_transferable) | **GET** /margin/transferable | Get maximum transferable amount for isolated margin
+*MarginApi* | [**get_user_margin_tier**](docs/MarginApi.md#get_user_margin_tier) | **GET** /margin/user/loan_margin_tiers | Query user's own leverage lending tiers in current market
+*MarginApi* | [**get_market_margin_tier**](docs/MarginApi.md#get_market_margin_tier) | **GET** /margin/loan_margin_tiers | Query current market leverage lending tiers
+*MarginApi* | [**set_user_market_leverage**](docs/MarginApi.md#set_user_market_leverage) | **POST** /margin/leverage/user_market_setting | Set user market leverage multiplier
+*MarginApi* | [**list_margin_user_account**](docs/MarginApi.md#list_margin_user_account) | **GET** /margin/user/account | Query user's isolated margin account list
+*MarginApi* | [**list_cross_margin_loans**](docs/MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | Query cross margin borrow history (deprecated)
+*MarginApi* | [**list_cross_margin_repayments**](docs/MarginApi.md#list_cross_margin_repayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated)
+*MultiCollateralLoanApi* | [**list_multi_collateral_orders**](docs/MultiCollateralLoanApi.md#list_multi_collateral_orders) | **GET** /loan/multi_collateral/orders | Query multi-currency collateral order list
+*MultiCollateralLoanApi* | [**create_multi_collateral**](docs/MultiCollateralLoanApi.md#create_multi_collateral) | **POST** /loan/multi_collateral/orders | Place multi-currency collateral order
+*MultiCollateralLoanApi* | [**get_multi_collateral_order_detail**](docs/MultiCollateralLoanApi.md#get_multi_collateral_order_detail) | **GET** /loan/multi_collateral/orders/{order_id} | Query order details
+*MultiCollateralLoanApi* | [**list_multi_repay_records**](docs/MultiCollateralLoanApi.md#list_multi_repay_records) | **GET** /loan/multi_collateral/repay | Query multi-currency collateral repayment records
+*MultiCollateralLoanApi* | [**repay_multi_collateral_loan**](docs/MultiCollateralLoanApi.md#repay_multi_collateral_loan) | **POST** /loan/multi_collateral/repay | Multi-currency collateral repayment
*MultiCollateralLoanApi* | [**list_multi_collateral_records**](docs/MultiCollateralLoanApi.md#list_multi_collateral_records) | **GET** /loan/multi_collateral/mortgage | Query collateral adjustment records
-*MultiCollateralLoanApi* | [**operate_multi_collateral**](docs/MultiCollateralLoanApi.md#operate_multi_collateral) | **POST** /loan/multi_collateral/mortgage | Operate Multi-Collateral
-*MultiCollateralLoanApi* | [**list_user_currency_quota**](docs/MultiCollateralLoanApi.md#list_user_currency_quota) | **GET** /loan/multi_collateral/currency_quota | List User Currency Quota
-*MultiCollateralLoanApi* | [**list_multi_collateral_currencies**](docs/MultiCollateralLoanApi.md#list_multi_collateral_currencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies in Multi-Collateral
-*MultiCollateralLoanApi* | [**get_multi_collateral_ltv**](docs/MultiCollateralLoanApi.md#get_multi_collateral_ltv) | **GET** /loan/multi_collateral/ltv | Get Multi-Collateral ratio
-*MultiCollateralLoanApi* | [**get_multi_collateral_fix_rate**](docs/MultiCollateralLoanApi.md#get_multi_collateral_fix_rate) | **GET** /loan/multi_collateral/fixed_rate | Query fixed interest rates for the currency for 7 days and 30 days
-*MultiCollateralLoanApi* | [**get_multi_collateral_current_rate**](docs/MultiCollateralLoanApi.md#get_multi_collateral_current_rate) | **GET** /loan/multi_collateral/current_rate | Query the current interest rate of the currency
-*OptionsApi* | [**list_options_underlyings**](docs/OptionsApi.md#list_options_underlyings) | **GET** /options/underlyings | List all underlyings
-*OptionsApi* | [**list_options_expirations**](docs/OptionsApi.md#list_options_expirations) | **GET** /options/expirations | List all expiration times
-*OptionsApi* | [**list_options_contracts**](docs/OptionsApi.md#list_options_contracts) | **GET** /options/contracts | List all the contracts with specified underlying and expiration time
-*OptionsApi* | [**get_options_contract**](docs/OptionsApi.md#get_options_contract) | **GET** /options/contracts/{contract} | Query specified contract detail
+*MultiCollateralLoanApi* | [**operate_multi_collateral**](docs/MultiCollateralLoanApi.md#operate_multi_collateral) | **POST** /loan/multi_collateral/mortgage | Add or withdraw collateral
+*MultiCollateralLoanApi* | [**list_user_currency_quota**](docs/MultiCollateralLoanApi.md#list_user_currency_quota) | **GET** /loan/multi_collateral/currency_quota | Query user's collateral and borrowing currency quota information
+*MultiCollateralLoanApi* | [**list_multi_collateral_currencies**](docs/MultiCollateralLoanApi.md#list_multi_collateral_currencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies for multi-currency collateral
+*MultiCollateralLoanApi* | [**get_multi_collateral_ltv**](docs/MultiCollateralLoanApi.md#get_multi_collateral_ltv) | **GET** /loan/multi_collateral/ltv | Query collateralization ratio information
+*MultiCollateralLoanApi* | [**get_multi_collateral_fix_rate**](docs/MultiCollateralLoanApi.md#get_multi_collateral_fix_rate) | **GET** /loan/multi_collateral/fixed_rate | Query currency's 7-day and 30-day fixed interest rates
+*MultiCollateralLoanApi* | [**get_multi_collateral_current_rate**](docs/MultiCollateralLoanApi.md#get_multi_collateral_current_rate) | **GET** /loan/multi_collateral/current_rate | Query currency's current interest rate
+*OptionsApi* | [**list_options_underlyings**](docs/OptionsApi.md#list_options_underlyings) | **GET** /options/underlyings | List all underlying assets
+*OptionsApi* | [**list_options_expirations**](docs/OptionsApi.md#list_options_expirations) | **GET** /options/expirations | List all expiration dates
+*OptionsApi* | [**list_options_contracts**](docs/OptionsApi.md#list_options_contracts) | **GET** /options/contracts | List all contracts for specified underlying and expiration date
+*OptionsApi* | [**get_options_contract**](docs/OptionsApi.md#get_options_contract) | **GET** /options/contracts/{contract} | Query specified contract details
*OptionsApi* | [**list_options_settlements**](docs/OptionsApi.md#list_options_settlements) | **GET** /options/settlements | List settlement history
-*OptionsApi* | [**get_options_settlement**](docs/OptionsApi.md#get_options_settlement) | **GET** /options/settlements/{contract} | Get specified contract's settlement
-*OptionsApi* | [**list_my_options_settlements**](docs/OptionsApi.md#list_my_options_settlements) | **GET** /options/my_settlements | List my options settlements
-*OptionsApi* | [**list_options_order_book**](docs/OptionsApi.md#list_options_order_book) | **GET** /options/order_book | Options order book
-*OptionsApi* | [**list_options_tickers**](docs/OptionsApi.md#list_options_tickers) | **GET** /options/tickers | List tickers of options contracts
-*OptionsApi* | [**list_options_underlying_tickers**](docs/OptionsApi.md#list_options_underlying_tickers) | **GET** /options/underlying/tickers/{underlying} | Get underlying ticker
-*OptionsApi* | [**list_options_candlesticks**](docs/OptionsApi.md#list_options_candlesticks) | **GET** /options/candlesticks | Get options candlesticks
-*OptionsApi* | [**list_options_underlying_candlesticks**](docs/OptionsApi.md#list_options_underlying_candlesticks) | **GET** /options/underlying/candlesticks | Mark price candlesticks of an underlying
-*OptionsApi* | [**list_options_trades**](docs/OptionsApi.md#list_options_trades) | **GET** /options/trades | Options trade history
-*OptionsApi* | [**list_options_account**](docs/OptionsApi.md#list_options_account) | **GET** /options/accounts | List options account
-*OptionsApi* | [**list_options_account_book**](docs/OptionsApi.md#list_options_account_book) | **GET** /options/account_book | List account changing history
+*OptionsApi* | [**get_options_settlement**](docs/OptionsApi.md#get_options_settlement) | **GET** /options/settlements/{contract} | Get specified contract settlement information
+*OptionsApi* | [**list_my_options_settlements**](docs/OptionsApi.md#list_my_options_settlements) | **GET** /options/my_settlements | Query personal settlement records
+*OptionsApi* | [**list_options_order_book**](docs/OptionsApi.md#list_options_order_book) | **GET** /options/order_book | Query options contract order book
+*OptionsApi* | [**list_options_tickers**](docs/OptionsApi.md#list_options_tickers) | **GET** /options/tickers | Query options market ticker information
+*OptionsApi* | [**list_options_underlying_tickers**](docs/OptionsApi.md#list_options_underlying_tickers) | **GET** /options/underlying/tickers/{underlying} | Query underlying ticker information
+*OptionsApi* | [**list_options_candlesticks**](docs/OptionsApi.md#list_options_candlesticks) | **GET** /options/candlesticks | Options contract market candlestick chart
+*OptionsApi* | [**list_options_underlying_candlesticks**](docs/OptionsApi.md#list_options_underlying_candlesticks) | **GET** /options/underlying/candlesticks | Underlying index price candlestick chart
+*OptionsApi* | [**list_options_trades**](docs/OptionsApi.md#list_options_trades) | **GET** /options/trades | Market trade records
+*OptionsApi* | [**list_options_account**](docs/OptionsApi.md#list_options_account) | **GET** /options/accounts | Query account information
+*OptionsApi* | [**list_options_account_book**](docs/OptionsApi.md#list_options_account_book) | **GET** /options/account_book | Query account change history
*OptionsApi* | [**list_options_positions**](docs/OptionsApi.md#list_options_positions) | **GET** /options/positions | List user's positions of specified underlying
*OptionsApi* | [**get_options_position**](docs/OptionsApi.md#get_options_position) | **GET** /options/positions/{contract} | Get specified contract position
*OptionsApi* | [**list_options_position_close**](docs/OptionsApi.md#list_options_position_close) | **GET** /options/position_close | List user's liquidation history of specified underlying
*OptionsApi* | [**list_options_orders**](docs/OptionsApi.md#list_options_orders) | **GET** /options/orders | List options orders
*OptionsApi* | [**create_options_order**](docs/OptionsApi.md#create_options_order) | **POST** /options/orders | Create an options order
-*OptionsApi* | [**cancel_options_orders**](docs/OptionsApi.md#cancel_options_orders) | **DELETE** /options/orders | Cancel all `open` orders matched
-*OptionsApi* | [**get_options_order**](docs/OptionsApi.md#get_options_order) | **GET** /options/orders/{order_id} | Get a single order
-*OptionsApi* | [**cancel_options_order**](docs/OptionsApi.md#cancel_options_order) | **DELETE** /options/orders/{order_id} | Cancel a single order
+*OptionsApi* | [**cancel_options_orders**](docs/OptionsApi.md#cancel_options_orders) | **DELETE** /options/orders | Cancel all orders with 'open' status
+*OptionsApi* | [**get_options_order**](docs/OptionsApi.md#get_options_order) | **GET** /options/orders/{order_id} | Query single order details
+*OptionsApi* | [**cancel_options_order**](docs/OptionsApi.md#cancel_options_order) | **DELETE** /options/orders/{order_id} | Cancel single order
*OptionsApi* | [**countdown_cancel_all_options**](docs/OptionsApi.md#countdown_cancel_all_options) | **POST** /options/countdown_cancel_all | Countdown cancel orders
-*OptionsApi* | [**list_my_options_trades**](docs/OptionsApi.md#list_my_options_trades) | **GET** /options/my_trades | List personal trading history
-*OptionsApi* | [**get_options_mmp**](docs/OptionsApi.md#get_options_mmp) | **GET** /options/mmp | MMP Query
+*OptionsApi* | [**list_my_options_trades**](docs/OptionsApi.md#list_my_options_trades) | **GET** /options/my_trades | Query personal trading records
+*OptionsApi* | [**get_options_mmp**](docs/OptionsApi.md#get_options_mmp) | **GET** /options/mmp | MMP Query.
*OptionsApi* | [**set_options_mmp**](docs/OptionsApi.md#set_options_mmp) | **POST** /options/mmp | MMP Settings
*OptionsApi* | [**reset_options_mmp**](docs/OptionsApi.md#reset_options_mmp) | **POST** /options/mmp/reset | MMP Reset
-*RebateApi* | [**agency_transaction_history**](docs/RebateApi.md#agency_transaction_history) | **GET** /rebate/agency/transaction_history | The agency obtains the transaction history of the recommended user
-*RebateApi* | [**agency_commissions_history**](docs/RebateApi.md#agency_commissions_history) | **GET** /rebate/agency/commission_history | The agency obtains the commission history of the recommended user
-*RebateApi* | [**partner_transaction_history**](docs/RebateApi.md#partner_transaction_history) | **GET** /rebate/partner/transaction_history | Partner obtains transaction records of recommended users
-*RebateApi* | [**partner_commissions_history**](docs/RebateApi.md#partner_commissions_history) | **GET** /rebate/partner/commission_history | Partner obtains commission records of recommended users
+*RebateApi* | [**agency_transaction_history**](docs/RebateApi.md#agency_transaction_history) | **GET** /rebate/agency/transaction_history | Broker obtains transaction history of recommended users
+*RebateApi* | [**agency_commissions_history**](docs/RebateApi.md#agency_commissions_history) | **GET** /rebate/agency/commission_history | Broker obtains rebate history of recommended users
+*RebateApi* | [**partner_transaction_history**](docs/RebateApi.md#partner_transaction_history) | **GET** /rebate/partner/transaction_history | Partner obtains transaction history of recommended users
+*RebateApi* | [**partner_commissions_history**](docs/RebateApi.md#partner_commissions_history) | **GET** /rebate/partner/commission_history | Partner obtains rebate records of recommended users
*RebateApi* | [**partner_sub_list**](docs/RebateApi.md#partner_sub_list) | **GET** /rebate/partner/sub_list | Partner subordinate list
-*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
-*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
-*RebateApi* | [**rebate_user_info**](docs/RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User retrieves rebate information
-*SpotApi* | [**list_currencies**](docs/SpotApi.md#list_currencies) | **GET** /spot/currencies | List all currencies' details
-*SpotApi* | [**get_currency**](docs/SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Get details of a specific currency
-*SpotApi* | [**list_currency_pairs**](docs/SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | List all currency pairs supported
-*SpotApi* | [**get_currency_pair**](docs/SpotApi.md#get_currency_pair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc currency pair
-*SpotApi* | [**list_tickers**](docs/SpotApi.md#list_tickers) | **GET** /spot/tickers | Retrieve ticker information
-*SpotApi* | [**list_order_book**](docs/SpotApi.md#list_order_book) | **GET** /spot/order_book | Retrieve order book
-*SpotApi* | [**list_trades**](docs/SpotApi.md#list_trades) | **GET** /spot/trades | Retrieve market trades
-*SpotApi* | [**list_candlesticks**](docs/SpotApi.md#list_candlesticks) | **GET** /spot/candlesticks | Market candlesticks
-*SpotApi* | [**get_fee**](docs/SpotApi.md#get_fee) | **GET** /spot/fee | Query user trading fee rates
-*SpotApi* | [**get_batch_spot_fee**](docs/SpotApi.md#get_batch_spot_fee) | **GET** /spot/batch_fee | Query a batch of user trading fee rates
-*SpotApi* | [**list_spot_accounts**](docs/SpotApi.md#list_spot_accounts) | **GET** /spot/accounts | List spot accounts
-*SpotApi* | [**list_spot_account_book**](docs/SpotApi.md#list_spot_account_book) | **GET** /spot/account_book | Query account book
-*SpotApi* | [**create_batch_orders**](docs/SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Create a batch of orders
+*RebateApi* | [**rebate_broker_commission_history**](docs/RebateApi.md#rebate_broker_commission_history) | **GET** /rebate/broker/commission_history | Broker obtains user's rebate records
+*RebateApi* | [**rebate_broker_transaction_history**](docs/RebateApi.md#rebate_broker_transaction_history) | **GET** /rebate/broker/transaction_history | Broker obtains user's trading history
+*RebateApi* | [**rebate_user_info**](docs/RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User obtains rebate information
+*RebateApi* | [**user_sub_relation**](docs/RebateApi.md#user_sub_relation) | **GET** /rebate/user/sub_relation | User subordinate relationship
+*SpotApi* | [**list_currencies**](docs/SpotApi.md#list_currencies) | **GET** /spot/currencies | Query all currency information
+*SpotApi* | [**get_currency**](docs/SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Query single currency information
+*SpotApi* | [**list_currency_pairs**](docs/SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | Query all supported currency pairs
+*SpotApi* | [**get_currency_pair**](docs/SpotApi.md#get_currency_pair) | **GET** /spot/currency_pairs/{currency_pair} | Query single currency pair details
+*SpotApi* | [**list_tickers**](docs/SpotApi.md#list_tickers) | **GET** /spot/tickers | Get currency pair ticker information
+*SpotApi* | [**list_order_book**](docs/SpotApi.md#list_order_book) | **GET** /spot/order_book | Get market depth information
+*SpotApi* | [**list_trades**](docs/SpotApi.md#list_trades) | **GET** /spot/trades | Query market transaction records
+*SpotApi* | [**list_candlesticks**](docs/SpotApi.md#list_candlesticks) | **GET** /spot/candlesticks | Market K-line chart
+*SpotApi* | [**get_fee**](docs/SpotApi.md#get_fee) | **GET** /spot/fee | Query account fee rates
+*SpotApi* | [**get_batch_spot_fee**](docs/SpotApi.md#get_batch_spot_fee) | **GET** /spot/batch_fee | Batch query account fee rates
+*SpotApi* | [**list_spot_accounts**](docs/SpotApi.md#list_spot_accounts) | **GET** /spot/accounts | List spot trading accounts
+*SpotApi* | [**list_spot_account_book**](docs/SpotApi.md#list_spot_account_book) | **GET** /spot/account_book | Query spot account transaction history
+*SpotApi* | [**create_batch_orders**](docs/SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Batch place orders
*SpotApi* | [**list_all_open_orders**](docs/SpotApi.md#list_all_open_orders) | **GET** /spot/open_orders | List all open orders
-*SpotApi* | [**create_cross_liquidate_order**](docs/SpotApi.md#create_cross_liquidate_order) | **POST** /spot/cross_liquidate_orders | close position when cross-currency is disabled
+*SpotApi* | [**create_cross_liquidate_order**](docs/SpotApi.md#create_cross_liquidate_order) | **POST** /spot/cross_liquidate_orders | Close position when cross-currency is disabled
*SpotApi* | [**list_orders**](docs/SpotApi.md#list_orders) | **GET** /spot/orders | List orders
*SpotApi* | [**create_order**](docs/SpotApi.md#create_order) | **POST** /spot/orders | Create an order
*SpotApi* | [**cancel_orders**](docs/SpotApi.md#cancel_orders) | **DELETE** /spot/orders | Cancel all `open` orders in specified currency pair
-*SpotApi* | [**cancel_batch_orders**](docs/SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list
-*SpotApi* | [**get_order**](docs/SpotApi.md#get_order) | **GET** /spot/orders/{order_id} | Get a single order
-*SpotApi* | [**cancel_order**](docs/SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel a single order
-*SpotApi* | [**amend_order**](docs/SpotApi.md#amend_order) | **PATCH** /spot/orders/{order_id} | Amend an order
-*SpotApi* | [**list_my_trades**](docs/SpotApi.md#list_my_trades) | **GET** /spot/my_trades | List personal trading history
+*SpotApi* | [**cancel_batch_orders**](docs/SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel batch orders by specified ID list
+*SpotApi* | [**get_order**](docs/SpotApi.md#get_order) | **GET** /spot/orders/{order_id} | Query single order details
+*SpotApi* | [**cancel_order**](docs/SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel single order
+*SpotApi* | [**amend_order**](docs/SpotApi.md#amend_order) | **PATCH** /spot/orders/{order_id} | Amend single order
+*SpotApi* | [**list_my_trades**](docs/SpotApi.md#list_my_trades) | **GET** /spot/my_trades | Query personal trading records
*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* | [**get_spot_insurance_history**](docs/SpotApi.md#get_spot_insurance_history) | **GET** /spot/insurance_history | Query spot insurance fund historical data
-*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
-*SpotApi* | [**get_spot_price_triggered_order**](docs/SpotApi.md#get_spot_price_triggered_order) | **GET** /spot/price_orders/{order_id} | Get a price-triggered order
-*SpotApi* | [**cancel_spot_price_triggered_order**](docs/SpotApi.md#cancel_spot_price_triggered_order) | **DELETE** /spot/price_orders/{order_id} | cancel a price-triggered order
-*WalletApi* | [**list_currency_chains**](docs/WalletApi.md#list_currency_chains) | **GET** /wallet/currency_chains | List chains supported for specified currency
+*SpotApi* | [**list_spot_price_triggered_orders**](docs/SpotApi.md#list_spot_price_triggered_orders) | **GET** /spot/price_orders | Query running auto order list
+*SpotApi* | [**create_spot_price_triggered_order**](docs/SpotApi.md#create_spot_price_triggered_order) | **POST** /spot/price_orders | Create 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 auto orders
+*SpotApi* | [**get_spot_price_triggered_order**](docs/SpotApi.md#get_spot_price_triggered_order) | **GET** /spot/price_orders/{order_id} | Query single auto order details
+*SpotApi* | [**cancel_spot_price_triggered_order**](docs/SpotApi.md#cancel_spot_price_triggered_order) | **DELETE** /spot/price_orders/{order_id} | Cancel single auto order
+*WalletApi* | [**list_currency_chains**](docs/WalletApi.md#list_currency_chains) | **GET** /wallet/currency_chains | Query chains supported for specified currency
*WalletApi* | [**get_deposit_address**](docs/WalletApi.md#get_deposit_address) | **GET** /wallet/deposit_address | Generate currency deposit address
-*WalletApi* | [**list_withdrawals**](docs/WalletApi.md#list_withdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records
-*WalletApi* | [**list_deposits**](docs/WalletApi.md#list_deposits) | **GET** /wallet/deposits | Retrieve deposit records
+*WalletApi* | [**list_withdrawals**](docs/WalletApi.md#list_withdrawals) | **GET** /wallet/withdrawals | Get withdrawal records
+*WalletApi* | [**list_deposits**](docs/WalletApi.md#list_deposits) | **GET** /wallet/deposits | Get deposit records
*WalletApi* | [**transfer**](docs/WalletApi.md#transfer) | **POST** /wallet/transfers | Transfer between trading accounts
-*WalletApi* | [**list_sub_account_transfers**](docs/WalletApi.md#list_sub_account_transfers) | **GET** /wallet/sub_account_transfers | Retrieve transfer records between main and sub accounts
+*WalletApi* | [**list_sub_account_transfers**](docs/WalletApi.md#list_sub_account_transfers) | **GET** /wallet/sub_account_transfers | Get transfer records between main and sub accounts
*WalletApi* | [**transfer_with_sub_account**](docs/WalletApi.md#transfer_with_sub_account) | **POST** /wallet/sub_account_transfers | Transfer between main and sub accounts
-*WalletApi* | [**sub_account_to_sub_account**](docs/WalletApi.md#sub_account_to_sub_account) | **POST** /wallet/sub_account_to_sub_account | Sub-account transfers to sub-account
+*WalletApi* | [**sub_account_to_sub_account**](docs/WalletApi.md#sub_account_to_sub_account) | **POST** /wallet/sub_account_to_sub_account | Transfer between sub-accounts
*WalletApi* | [**get_transfer_order_status**](docs/WalletApi.md#get_transfer_order_status) | **GET** /wallet/order_status | Transfer status query
-*WalletApi* | [**list_withdraw_status**](docs/WalletApi.md#list_withdraw_status) | **GET** /wallet/withdraw_status | Retrieve withdrawal status
-*WalletApi* | [**list_sub_account_balances**](docs/WalletApi.md#list_sub_account_balances) | **GET** /wallet/sub_account_balances | Retrieve sub account balances
-*WalletApi* | [**list_sub_account_margin_balances**](docs/WalletApi.md#list_sub_account_margin_balances) | **GET** /wallet/sub_account_margin_balances | Query sub accounts' margin balances
-*WalletApi* | [**list_sub_account_futures_balances**](docs/WalletApi.md#list_sub_account_futures_balances) | **GET** /wallet/sub_account_futures_balances | Query sub accounts' futures account balances
-*WalletApi* | [**list_sub_account_cross_margin_balances**](docs/WalletApi.md#list_sub_account_cross_margin_balances) | **GET** /wallet/sub_account_cross_margin_balances | Query subaccount's cross_margin account info
-*WalletApi* | [**list_saved_address**](docs/WalletApi.md#list_saved_address) | **GET** /wallet/saved_address | Query saved address
-*WalletApi* | [**get_trade_fee**](docs/WalletApi.md#get_trade_fee) | **GET** /wallet/fee | Retrieve personal trading fee
-*WalletApi* | [**get_total_balance**](docs/WalletApi.md#get_total_balance) | **GET** /wallet/total_balance | Retrieve user's total balances
-*WalletApi* | [**list_small_balance**](docs/WalletApi.md#list_small_balance) | **GET** /wallet/small_balance | List small balance
-*WalletApi* | [**convert_small_balance**](docs/WalletApi.md#convert_small_balance) | **POST** /wallet/small_balance | Convert small balance
-*WalletApi* | [**list_small_balance_history**](docs/WalletApi.md#list_small_balance_history) | **GET** /wallet/small_balance_history | List small balance history
-*WalletApi* | [**list_push_orders**](docs/WalletApi.md#list_push_orders) | **GET** /wallet/push | Retrieve the UID transfer history
+*WalletApi* | [**list_withdraw_status**](docs/WalletApi.md#list_withdraw_status) | **GET** /wallet/withdraw_status | Query withdrawal status
+*WalletApi* | [**list_sub_account_balances**](docs/WalletApi.md#list_sub_account_balances) | **GET** /wallet/sub_account_balances | Query sub-account balance information
+*WalletApi* | [**list_sub_account_margin_balances**](docs/WalletApi.md#list_sub_account_margin_balances) | **GET** /wallet/sub_account_margin_balances | Query sub-account isolated margin account balance information
+*WalletApi* | [**list_sub_account_futures_balances**](docs/WalletApi.md#list_sub_account_futures_balances) | **GET** /wallet/sub_account_futures_balances | Query sub-account perpetual futures account balance information
+*WalletApi* | [**list_sub_account_cross_margin_balances**](docs/WalletApi.md#list_sub_account_cross_margin_balances) | **GET** /wallet/sub_account_cross_margin_balances | Query sub-account cross margin account balance information
+*WalletApi* | [**list_saved_address**](docs/WalletApi.md#list_saved_address) | **GET** /wallet/saved_address | Query withdrawal address whitelist
+*WalletApi* | [**get_trade_fee**](docs/WalletApi.md#get_trade_fee) | **GET** /wallet/fee | Query personal trading fees
+*WalletApi* | [**get_total_balance**](docs/WalletApi.md#get_total_balance) | **GET** /wallet/total_balance | Query personal account totals
+*WalletApi* | [**list_small_balance**](docs/WalletApi.md#list_small_balance) | **GET** /wallet/small_balance | Get list of convertible small balance currencies
+*WalletApi* | [**convert_small_balance**](docs/WalletApi.md#convert_small_balance) | **POST** /wallet/small_balance | Convert small balance currency
+*WalletApi* | [**list_small_balance_history**](docs/WalletApi.md#list_small_balance_history) | **GET** /wallet/small_balance_history | Get convertible small balance currency history
+*WalletApi* | [**list_push_orders**](docs/WalletApi.md#list_push_orders) | **GET** /wallet/push | Get UID transfer history
*WithdrawalApi* | [**withdraw**](docs/WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw
*WithdrawalApi* | [**withdraw_push_order**](docs/WithdrawalApi.md#withdraw_push_order) | **POST** /withdrawals/push | UID transfer
*WithdrawalApi* | [**cancel_withdrawal**](docs/WithdrawalApi.md#cancel_withdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID
@@ -421,6 +407,7 @@ Class | Method | HTTP request | Description
- [BorrowCurrencyInfo](docs/BorrowCurrencyInfo.md)
- [BrokerCommission](docs/BrokerCommission.md)
- [BrokerCommission1](docs/BrokerCommission1.md)
+ - [BrokerCommissionSubBrokerInfo](docs/BrokerCommissionSubBrokerInfo.md)
- [BrokerTransaction](docs/BrokerTransaction.md)
- [BrokerTransaction1](docs/BrokerTransaction1.md)
- [CancelBatchOrder](docs/CancelBatchOrder.md)
@@ -447,34 +434,31 @@ Class | Method | HTTP request | Description
- [CreateMultiCollateralOrder](docs/CreateMultiCollateralOrder.md)
- [CreateUniLend](docs/CreateUniLend.md)
- [CreateUniLoan](docs/CreateUniLoan.md)
- - [CrossMarginAccount](docs/CrossMarginAccount.md)
- - [CrossMarginAccountBook](docs/CrossMarginAccountBook.md)
- [CrossMarginBalance](docs/CrossMarginBalance.md)
- - [CrossMarginBalance1](docs/CrossMarginBalance1.md)
- - [CrossMarginCurrency](docs/CrossMarginCurrency.md)
- [CrossMarginLoan](docs/CrossMarginLoan.md)
- - [CrossMarginRepayRequest](docs/CrossMarginRepayRequest.md)
- [CrossMarginRepayment](docs/CrossMarginRepayment.md)
- - [CrossMarginTransferable](docs/CrossMarginTransferable.md)
- [Currency](docs/Currency.md)
- [CurrencyChain](docs/CurrencyChain.md)
- [CurrencyPair](docs/CurrencyPair.md)
- [CurrencyQuota](docs/CurrencyQuota.md)
+ - [DebitFee](docs/DebitFee.md)
- [DeliveryCandlestick](docs/DeliveryCandlestick.md)
- [DeliveryContract](docs/DeliveryContract.md)
- [DeliverySettlement](docs/DeliverySettlement.md)
+ - [DeliveryTicker](docs/DeliveryTicker.md)
- [DepositAddress](docs/DepositAddress.md)
+ - [DepositRecord](docs/DepositRecord.md)
- [DualGetOrders](docs/DualGetOrders.md)
- [DualGetPlans](docs/DualGetPlans.md)
+ - [Eth2RateList](docs/Eth2RateList.md)
- [Eth2Swap](docs/Eth2Swap.md)
- - [FlashSwapCurrency](docs/FlashSwapCurrency.md)
+ - [FindCoin](docs/FindCoin.md)
- [FlashSwapCurrencyPair](docs/FlashSwapCurrencyPair.md)
- [FlashSwapOrder](docs/FlashSwapOrder.md)
- [FlashSwapOrderPreview](docs/FlashSwapOrderPreview.md)
- [FlashSwapOrderRequest](docs/FlashSwapOrderRequest.md)
- [FlashSwapPreviewRequest](docs/FlashSwapPreviewRequest.md)
- [FundingAccount](docs/FundingAccount.md)
- - [FundingBookItem](docs/FundingBookItem.md)
- [FundingRateRecord](docs/FundingRateRecord.md)
- [FutureCancelOrderResult](docs/FutureCancelOrderResult.md)
- [FuturesAccount](docs/FuturesAccount.md)
@@ -493,9 +477,11 @@ Class | Method | HTTP request | Description
- [FuturesOrderAmendment](docs/FuturesOrderAmendment.md)
- [FuturesOrderBook](docs/FuturesOrderBook.md)
- [FuturesOrderBookItem](docs/FuturesOrderBookItem.md)
+ - [FuturesPositionCrossMode](docs/FuturesPositionCrossMode.md)
- [FuturesPremiumIndex](docs/FuturesPremiumIndex.md)
- [FuturesPriceTrigger](docs/FuturesPriceTrigger.md)
- [FuturesPriceTriggeredOrder](docs/FuturesPriceTriggeredOrder.md)
+ - [FuturesRiskLimitTier](docs/FuturesRiskLimitTier.md)
- [FuturesTicker](docs/FuturesTicker.md)
- [FuturesTrade](docs/FuturesTrade.md)
- [IndexConstituent](docs/IndexConstituent.md)
@@ -505,14 +491,11 @@ Class | Method | HTTP request | Description
- [InsuranceRecord](docs/InsuranceRecord.md)
- [LedgerRecord](docs/LedgerRecord.md)
- [LiquidateOrder](docs/LiquidateOrder.md)
- - [Loan](docs/Loan.md)
- - [LoanPatch](docs/LoanPatch.md)
- - [LoanRecord](docs/LoanRecord.md)
- [MarginAccount](docs/MarginAccount.md)
- [MarginAccountBook](docs/MarginAccountBook.md)
- [MarginAccountCurrency](docs/MarginAccountCurrency.md)
- - [MarginBorrowable](docs/MarginBorrowable.md)
- - [MarginCurrencyPair](docs/MarginCurrencyPair.md)
+ - [MarginLeverageTier](docs/MarginLeverageTier.md)
+ - [MarginMarketLeverage](docs/MarginMarketLeverage.md)
- [MarginTiers](docs/MarginTiers.md)
- [MarginTransferable](docs/MarginTransferable.md)
- [MaxUniBorrowable](docs/MaxUniBorrowable.md)
@@ -577,15 +560,14 @@ Class | Method | HTTP request | Description
- [RepayRecordLeftInterest](docs/RepayRecordLeftInterest.md)
- [RepayRecordRepaidCurrency](docs/RepayRecordRepaidCurrency.md)
- [RepayRecordTotalInterest](docs/RepayRecordTotalInterest.md)
- - [RepayRequest](docs/RepayRequest.md)
- [RepayResp](docs/RepayResp.md)
- - [Repayment](docs/Repayment.md)
- [RiskUnits](docs/RiskUnits.md)
- [SavedAddress](docs/SavedAddress.md)
- [SmallBalance](docs/SmallBalance.md)
- [SmallBalanceHistory](docs/SmallBalanceHistory.md)
- [SpotAccount](docs/SpotAccount.md)
- [SpotAccountBook](docs/SpotAccountBook.md)
+ - [SpotCurrencyChain](docs/SpotCurrencyChain.md)
- [SpotFee](docs/SpotFee.md)
- [SpotInsuranceHistory](docs/SpotInsuranceHistory.md)
- [SpotPricePutOrder](docs/SpotPricePutOrder.md)
@@ -605,8 +587,11 @@ Class | Method | HTTP request | Description
- [SubAccountMarginBalance](docs/SubAccountMarginBalance.md)
- [SubAccountToSubAccount](docs/SubAccountToSubAccount.md)
- [SubAccountTransfer](docs/SubAccountTransfer.md)
+ - [SubAccountTransferRecordItem](docs/SubAccountTransferRecordItem.md)
- [SubCrossMarginAccount](docs/SubCrossMarginAccount.md)
- [SubUserMode](docs/SubUserMode.md)
+ - [SwapCoin](docs/SwapCoin.md)
+ - [SwapCoinStruct](docs/SwapCoinStruct.md)
- [SystemTime](docs/SystemTime.md)
- [Ticker](docs/Ticker.md)
- [TotalBalance](docs/TotalBalance.md)
@@ -614,6 +599,8 @@ Class | Method | HTTP request | Description
- [TradeFee](docs/TradeFee.md)
- [TransactionID](docs/TransactionID.md)
- [Transfer](docs/Transfer.md)
+ - [TransferOrderStatus](docs/TransferOrderStatus.md)
+ - [TransferablesResult](docs/TransferablesResult.md)
- [TriggerOrderResponse](docs/TriggerOrderResponse.md)
- [TriggerTime](docs/TriggerTime.md)
- [UidPushOrder](docs/UidPushOrder.md)
@@ -622,7 +609,6 @@ Class | Method | HTTP request | Description
- [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)
@@ -633,6 +619,10 @@ Class | Method | HTTP request | Description
- [UnifiedAccount](docs/UnifiedAccount.md)
- [UnifiedBalance](docs/UnifiedBalance.md)
- [UnifiedBorrowable](docs/UnifiedBorrowable.md)
+ - [UnifiedBorrowable1](docs/UnifiedBorrowable1.md)
+ - [UnifiedCollateralReq](docs/UnifiedCollateralReq.md)
+ - [UnifiedCollateralRes](docs/UnifiedCollateralRes.md)
+ - [UnifiedCurrency](docs/UnifiedCurrency.md)
- [UnifiedDiscount](docs/UnifiedDiscount.md)
- [UnifiedDiscountTiers](docs/UnifiedDiscountTiers.md)
- [UnifiedHistoryLoanRate](docs/UnifiedHistoryLoanRate.md)
@@ -641,8 +631,8 @@ Class | Method | HTTP request | Description
- [UnifiedLeverageSetting](docs/UnifiedLeverageSetting.md)
- [UnifiedLoan](docs/UnifiedLoan.md)
- [UnifiedLoanRecord](docs/UnifiedLoanRecord.md)
+ - [UnifiedLoanResult](docs/UnifiedLoanResult.md)
- [UnifiedMarginTiers](docs/UnifiedMarginTiers.md)
- - [UnifiedMode](docs/UnifiedMode.md)
- [UnifiedModeSet](docs/UnifiedModeSet.md)
- [UnifiedPortfolioInput](docs/UnifiedPortfolioInput.md)
- [UnifiedPortfolioOutput](docs/UnifiedPortfolioOutput.md)
@@ -650,6 +640,8 @@ Class | Method | HTTP request | Description
- [UnifiedSettings](docs/UnifiedSettings.md)
- [UnifiedTransferable](docs/UnifiedTransferable.md)
- [UserLtvInfo](docs/UserLtvInfo.md)
+ - [UserSub](docs/UserSub.md)
+ - [UserSubRelation](docs/UserSubRelation.md)
- [UserTotalAmount](docs/UserTotalAmount.md)
- [WithdrawStatus](docs/WithdrawStatus.md)
- [WithdrawalRecord](docs/WithdrawalRecord.md)
@@ -663,11 +655,11 @@ Class | Method | HTTP request | Description
Authentication with APIv4 key and secret
For details, refer to:
-[APIv4 signed request requirements](https://www.gate.io/docs/apiv4/en/index.html#apiv4-signed-request-requirements)
+[APIv4 signed request requirements](https://www.gate.com/docs/apiv4/en/index.html#apiv4-signed-request-requirements)
## Author
-support@mail.gate.io
+support@mail.gate.com
diff --git a/docs/AccountApi.md b/docs/AccountApi.md
index cdc2690..855675f 100644
--- a/docs/AccountApi.md
+++ b/docs/AccountApi.md
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**get_account_detail**](AccountApi.md#get_account_detail) | **GET** /account/detail | Get account detail
+[**get_account_detail**](AccountApi.md#get_account_detail) | **GET** /account/detail | Retrieve user account information
[**get_account_rate_limit**](AccountApi.md#get_account_rate_limit) | **GET** /account/rate_limit | Get user transaction rate limit information
-[**list_stp_groups**](AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | List STP Groups
-[**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 | Delete the user in the STP group
-[**get_debit_fee**](AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT deduction configuration.
-[**set_debit_fee**](AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Set GT deduction.
+[**list_stp_groups**](AccountApi.md#list_stp_groups) | **GET** /account/stp_groups | Query STP user groups created by the user
+[**create_stp_group**](AccountApi.md#create_stp_group) | **POST** /account/stp_groups | Create STP user group
+[**list_stp_groups_users**](AccountApi.md#list_stp_groups_users) | **GET** /account/stp_groups/{stp_id}/users | Query users in the STP user group
+[**add_stp_group_users**](AccountApi.md#add_stp_group_users) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP user group
+[**delete_stp_group_users**](AccountApi.md#delete_stp_group_users) | **DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group
+[**get_debit_fee**](AccountApi.md#get_debit_fee) | **GET** /account/debit_fee | Query GT fee deduction configuration
+[**set_debit_fee**](AccountApi.md#set_debit_fee) | **POST** /account/debit_fee | Configure GT fee deduction
# **get_account_detail**
> AccountDetail get_account_detail()
-Get account detail
+Retrieve user account information
### Example
@@ -46,7 +46,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.AccountApi(api_client)
try:
- # Get account detail
+ # Retrieve user account information
api_response = api_instance.get_account_detail()
print(api_response)
except GateApiException as ex:
@@ -74,7 +74,7 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
@@ -137,16 +137,16 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
# **list_stp_groups**
> list[StpGroup] list_stp_groups(name=name)
-List STP Groups
+Query STP user groups created by the user
-Retrieve the list of STP groups created by the main account user only
+Only query STP user groups created by the current main account
### Example
@@ -172,10 +172,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.AccountApi(api_client)
-name = 'group' # str | Perform a fuzzy search based on the name (optional)
+name = 'group' # str | Fuzzy search by name (optional)
try:
- # List STP Groups
+ # Query STP user groups created by the user
api_response = api_instance.list_stp_groups(name=name)
print(api_response)
except GateApiException as ex:
@@ -188,7 +188,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **name** | **str**| Perform a fuzzy search based on the name | [optional]
+ **name** | **str**| Fuzzy search by name | [optional]
### Return type
@@ -206,14 +206,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_stp_group**
> StpGroup create_stp_group(stp_group)
-Create STP Group
+Create STP user group
Only the main account is allowed to create a new STP user group
@@ -244,7 +244,7 @@ api_instance = gate_api.AccountApi(api_client)
stp_group = gate_api.StpGroup() # StpGroup |
try:
- # Create STP Group
+ # Create STP user group
api_response = api_instance.create_stp_group(stp_group)
print(api_response)
except GateApiException as ex:
@@ -275,16 +275,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | User added successfully. Returning the current users within the STP group. | - |
+**200** | User added successfully, returning current users in the STP group | - |
[[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)
# **list_stp_groups_users**
> list[StpGroupUser] list_stp_groups_users(stp_id)
-List users of the STP group
+Query users in the STP user group
-Only the main account that created this STP group is allowed to list the user ID of the STP group
+Only the main account that created this STP group can query the account ID list in the current STP group
### Example
@@ -313,7 +313,7 @@ api_instance = gate_api.AccountApi(api_client)
stp_id = 1 # int | STP Group ID
try:
- # List users of the STP group
+ # Query users in the STP user group
api_response = api_instance.list_stp_groups_users(stp_id)
print(api_response)
except GateApiException as ex:
@@ -344,16 +344,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **add_stp_group_users**
> list[StpGroupUser] add_stp_group_users(stp_id, request_body)
-Add users to the STP group
+Add users to the STP user group
-- Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted
+- Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted
### Example
@@ -383,7 +383,7 @@ stp_id = 1 # int | STP Group ID
request_body = [[1,2,3]] # list[int] | User ID
try:
- # Add users to the STP group
+ # Add users to the STP user group
api_response = api_instance.add_stp_group_users(stp_id, request_body)
print(api_response)
except GateApiException as ex:
@@ -415,14 +415,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | User added successfully. Returning the current users within the STP group. | - |
+**200** | User added successfully, returning current users in the STP group | - |
[[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)
# **delete_stp_group_users**
> list[StpGroupUser] delete_stp_group_users(stp_id, user_id)
-Delete the user in the STP group
+Delete users from the STP user group
- 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
@@ -451,10 +451,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.AccountApi(api_client)
stp_id = 1 # int | STP Group ID
-user_id = 1 # int | STP user ID, multiple can be separated by commas
+user_id = 1 # int | STP user IDs, multiple IDs can be separated by commas
try:
- # Delete the user in the STP group
+ # Delete users from the STP user group
api_response = api_instance.delete_stp_group_users(stp_id, user_id)
print(api_response)
except GateApiException as ex:
@@ -468,7 +468,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**stp_id** | **int**| STP Group ID |
- **user_id** | **int**| STP user ID, multiple can be separated by commas |
+ **user_id** | **int**| STP user IDs, multiple IDs can be separated by commas |
### Return type
@@ -486,16 +486,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Users deleted successfully, returns current users in the STP group | - |
[[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)
# **get_debit_fee**
-> InlineResponse2001 get_debit_fee()
+> DebitFee get_debit_fee()
-Query GT deduction configuration.
+Query GT fee deduction configuration
-Query the current GT deduction configuration for the account.
+Query the GT fee deduction configuration for the current account
### Example
@@ -523,7 +523,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.AccountApi(api_client)
try:
- # Query GT deduction configuration.
+ # Query GT fee deduction configuration
api_response = api_instance.get_debit_fee()
print(api_response)
except GateApiException as ex:
@@ -537,7 +537,7 @@ This endpoint does not need any parameter.
### Return type
-[**InlineResponse2001**](InlineResponse2001.md)
+[**DebitFee**](DebitFee.md)
### Authorization
@@ -556,11 +556,11 @@ This endpoint does not need any parameter.
[[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)
# **set_debit_fee**
-> set_debit_fee(inline_object)
+> set_debit_fee(debit_fee)
-Set GT deduction.
+Configure GT fee deduction
-Enable or disable GT deduction for the current account.
+Enable or disable GT fee deduction for the current account
### Example
@@ -586,11 +586,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.AccountApi(api_client)
-inline_object = gate_api.InlineObject() # InlineObject |
+debit_fee = gate_api.DebitFee() # DebitFee |
try:
- # Set GT deduction.
- api_instance.set_debit_fee(inline_object)
+ # Configure GT fee deduction
+ api_instance.set_debit_fee(debit_fee)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
@@ -601,7 +601,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **inline_object** | [**InlineObject**](InlineObject.md)| |
+ **debit_fee** | [**DebitFee**](DebitFee.md)| |
### Return type
diff --git a/docs/AccountBalance.md b/docs/AccountBalance.md
index 6e31613..7941688 100644
--- a/docs/AccountBalance.md
+++ b/docs/AccountBalance.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**amount** | **str** | Account total balance amount | [optional]
**currency** | **str** | Currency | [optional]
**unrealised_pnl** | **str** | Unrealised_pnl, this field will only appear in futures, options, delivery, and total accounts | [optional]
-**borrowed** | **str** | Borrowed，this field will only appear in margin and cross_margin accounts | [optional]
+**borrowed** | **str** | Total borrowed amount, this field will only appear in margin and cross_margin accounts | [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)
diff --git a/docs/AccountDetail.md b/docs/AccountDetail.md
index c88e63d..8e01703 100644
--- a/docs/AccountDetail.md
+++ b/docs/AccountDetail.md
@@ -1,15 +1,15 @@
# AccountDetail
-Account detail
+Account details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**ip_whitelist** | **list[str]** | IP whitelist | [optional]
-**currency_pairs** | **list[str]** | CurrencyPair whitelisting | [optional]
+**ip_whitelist** | **list[str]** | IP Whitelist | [optional]
+**currency_pairs** | **list[str]** | Trading pair whitelist | [optional]
**user_id** | **int** | User ID | [optional]
**tier** | **int** | User VIP level | [optional]
**key** | [**AccountDetailKey**](AccountDetailKey.md) | | [optional]
-**copy_trading_role** | **int** | User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower | [optional]
+**copy_trading_role** | **int** | User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower | [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)
diff --git a/docs/AccountDetailKey.md b/docs/AccountDetailKey.md
index e86955d..363513d 100644
--- a/docs/AccountDetailKey.md
+++ b/docs/AccountDetailKey.md
@@ -1,10 +1,10 @@
# AccountDetailKey
-API Key detail
+API Key details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**mode** | **int** | mode: 1 - classic account 2 - portfolio margin account | [optional]
+**mode** | **int** | Mode: 1 - Classic mode, 2 - Legacy unified mode | [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)
diff --git a/docs/AccountRateLimit.md b/docs/AccountRateLimit.md
index 605cdbf..b91882b 100644
--- a/docs/AccountRateLimit.md
+++ b/docs/AccountRateLimit.md
@@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#成交比率限频)) | [optional]
-**ratio** | **str** | Transaction rate | [optional]
-**main_ratio** | **str** | Total transaction ratio of main account | [optional]
+**tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) | [optional]
+**ratio** | **str** | Fill rate | [optional]
+**main_ratio** | **str** | Total fill ratio of main account | [optional]
**updated_at** | **str** | Update 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)
diff --git a/docs/AgencyCommission.md b/docs/AgencyCommission.md
index 85d5907..1151423 100644
--- a/docs/AgencyCommission.md
+++ b/docs/AgencyCommission.md
@@ -3,12 +3,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**commission_time** | **int** | Commission Time. (unix timestamp) | [optional]
+**commission_time** | **int** | Commission time (Unix timestamp in seconds) | [optional]
**user_id** | **int** | User ID | [optional]
**group_name** | **str** | Group name | [optional]
-**commission_amount** | **str** | Commission Amount | [optional]
+**commission_amount** | **str** | Transaction amount | [optional]
**commission_asset** | **str** | Commission Asset | [optional]
-**source** | **str** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional]
+**source** | **str** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [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)
diff --git a/docs/AgencyCommissionHistory.md b/docs/AgencyCommissionHistory.md
index e3558c1..195a454 100644
--- a/docs/AgencyCommissionHistory.md
+++ b/docs/AgencyCommissionHistory.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_pair** | **str** | Currency pair | [optional]
**total** | **int** | Total | [optional]
-**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of comission history | [optional]
+**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of commission history | [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)
diff --git a/docs/AgencyTransaction.md b/docs/AgencyTransaction.md
index e54646f..930d2b7 100644
--- a/docs/AgencyTransaction.md
+++ b/docs/AgencyTransaction.md
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
**fee** | **str** | Fee | [optional]
**fee_asset** | **str** | Fee currency | [optional]
**currency_pair** | **str** | Currency pair | [optional]
-**amount** | **str** | Commission Amount | [optional]
+**amount** | **str** | Transaction amount | [optional]
**amount_asset** | **str** | Commission Asset | [optional]
-**source** | **str** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional]
+**source** | **str** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [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)
diff --git a/docs/AutoRepaySetting.md b/docs/AutoRepaySetting.md
index 14d2c7e..d71d92d 100644
--- a/docs/AutoRepaySetting.md
+++ b/docs/AutoRepaySetting.md
@@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**status** | **str** | Auto repayment status. `on` - enabled, `off` - disabled | [optional]
+**status** | **str** | Auto repayment status: `on` - enabled, `off` - disabled | [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)
diff --git a/docs/BatchAmendItem.md b/docs/BatchAmendItem.md
index d4b35c6..62bc971 100644
--- a/docs/BatchAmendItem.md
+++ b/docs/BatchAmendItem.md
@@ -4,12 +4,12 @@ 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). |
+**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]
+**account** | **str** | Default spot, unified account and warehouse-by-store leverage account | [optional]
+**amount** | **str** | Trading Quantity. Only one of `amount` or `price` can be specified | [optional]
+**price** | **str** | Trading Price. Only one of `amount` or `price` can be specified | [optional]
+**amend_text** | **str** | Custom info during order amendment | [optional]
**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]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/BatchAmendOrderReq.md b/docs/BatchAmendOrderReq.md
index 121b66c..41df706 100644
--- a/docs/BatchAmendOrderReq.md
+++ b/docs/BatchAmendOrderReq.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order id, order_id and text must contain at least one | [optional]
**text** | **str** | User-defined order text, at least one of order_id and text must be passed | [optional]
-**size** | **int** | The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. | [optional]
-**price** | **str** | New order price. | [optional]
-**amend_text** | **str** | Custom info during amending order | [optional]
+**size** | **int** | New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. | [optional]
+**price** | **str** | New order price | [optional]
+**amend_text** | **str** | Custom info during order amendment | [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)
diff --git a/docs/BatchFuturesOrder.md b/docs/BatchFuturesOrder.md
index 538f820..c7599b6 100644
--- a/docs/BatchFuturesOrder.md
+++ b/docs/BatchFuturesOrder.md
@@ -4,33 +4,33 @@ Futures order details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**succeeded** | **bool** | Whether the batch of orders succeeded | [optional]
+**succeeded** | **bool** | Request execution result | [optional]
**label** | **str** | Error label, only exists if execution fails | [optional]
**detail** | **str** | Error detail, only present if execution failed and details need to be given | [optional]
**id** | **int** | Futures order ID | [optional] [readonly]
**user** | **int** | User ID | [optional] [readonly]
**create_time** | **float** | Creation time of order | [optional] [readonly]
**finish_time** | **float** | Order finished time. Not returned if order is open | [optional] [readonly]
-**finish_as** | **str** | How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly]
-**status** | **str** | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly]
+**finish_as** | **str** | How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly]
+**status** | **str** | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly]
**contract** | **str** | Futures contract | [optional]
-**size** | **int** | Order size. Specify positive number to make a bid, and negative number to ask | [optional]
-**iceberg** | **int** | Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size | [optional]
-**price** | **str** | Order price. 0 for market order with `tif` set as `ioc` | [optional]
+**size** | **int** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | [optional]
+**iceberg** | **int** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional]
+**price** | **str** | Order price. Price of 0 with `tif` set to `ioc` represents a market order. | [optional]
**close** | **bool** | Set as `true` to close the position, with `size` set to 0 | [optional] [default to False]
**is_close** | **bool** | Is the order to close position | [optional] [readonly]
**reduce_only** | **bool** | Set as `true` to be reduce-only order | [optional] [default to False]
**is_reduce_only** | **bool** | Is the order reduce-only | [optional] [readonly]
**is_liq** | **bool** | Is the order for liquidation | [optional] [readonly]
**tif** | **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']
-**left** | **int** | Size left to be traded | [optional] [readonly]
-**fill_price** | **str** | Fill price of the order | [optional] [readonly]
+**left** | **int** | Unfilled quantity | [optional] [readonly]
+**fill_price** | **str** | Fill price | [optional] [readonly]
**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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance | [optional]
**tkfr** | **str** | Taker fee | [optional] [readonly]
**mkfr** | **str** | Maker fee | [optional] [readonly]
-**refu** | **int** | Reference user ID | [optional] [readonly]
+**refu** | **int** | Referrer user ID | [optional] [readonly]
**auto_size** | **str** | Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 | [optional]
-**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
+**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled | [optional]
**stp_id** | **int** | Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group` | [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)
diff --git a/docs/BatchOrder.md b/docs/BatchOrder.md
index e88b16c..7840bc6 100644
--- a/docs/BatchOrder.md
+++ b/docs/BatchOrder.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **str** | Order ID | [optional]
**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional]
-**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]
-**succeeded** | **bool** | Whether the batch of orders succeeded | [optional]
+**text** | **str** | Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) | [optional]
+**succeeded** | **bool** | Request execution result | [optional]
**label** | **str** | Error label, if any, otherwise an empty string | [optional]
**message** | **str** | Detailed error message, if any, otherwise an empty string | [optional]
**id** | **str** | Order ID | [optional] [readonly]
@@ -17,17 +17,17 @@ Name | Type | Description | Notes
**update_time_ms** | **int** | Last modification time of order (in milliseconds) | [optional] [readonly]
**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, unified - unified account | [optional] [default to 'spot']
-**side** | **str** | Order side | [optional]
+**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
+**account** | **str** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] [default to 'spot']
+**side** | **str** | Buy or sell order | [optional]
**amount** | **str** | Trade amount | [optional]
**price** | **str** | Order price | [optional]
**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']
-**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional]
-**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional]
-**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional]
+**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional]
+**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional]
+**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order | [optional]
**left** | **str** | Amount left to fill | [optional] [readonly]
-**filled_amount** | **str** | Amount traded to fill | [optional] [readonly]
+**filled_amount** | **str** | Amount filled | [optional] [readonly]
**fill_price** | **str** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly]
**filled_total** | **str** | Total filled in quote currency | [optional] [readonly]
**avg_deal_price** | **str** | Average fill price | [optional] [readonly]
@@ -35,11 +35,11 @@ Name | Type | Description | Notes
**fee_currency** | **str** | Fee currency unit | [optional] [readonly]
**point_fee** | **str** | Points used to deduct fee | [optional] [readonly]
**gt_fee** | **str** | GT used to deduct fee | [optional] [readonly]
-**gt_discount** | **bool** | Whether GT fee discount is used | [optional] [readonly]
+**gt_discount** | **bool** | Whether GT fee deduction is enabled | [optional] [readonly]
**rebated_fee** | **str** | Rebated fee | [optional] [readonly]
**rebated_fee_currency** | **str** | Rebated fee currency unit | [optional] [readonly]
**stp_id** | **int** | Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group` | [optional] [readonly]
-**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
+**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
**finish_as** | **str** | How the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention | [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)
diff --git a/docs/BorrowCurrencyInfo.md b/docs/BorrowCurrencyInfo.md
index c627a30..64ca722 100644
--- a/docs/BorrowCurrencyInfo.md
+++ b/docs/BorrowCurrencyInfo.md
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional]
**index_price** | **str** | Currency Index Price | [optional]
-**left_repay_principal** | **str** | outstanding principal | [optional]
-**left_repay_interest** | **str** | outstanding interest | [optional]
-**left_repay_usdt** | **str** | Value of left total repayments amount in USDT | [optional]
+**left_repay_principal** | **str** | Outstanding principal | [optional]
+**left_repay_interest** | **str** | Outstanding interest | [optional]
+**left_repay_usdt** | **str** | Remaining total outstanding value converted to USDT | [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)
diff --git a/docs/BrokerCommission.md b/docs/BrokerCommission.md
index 4c722fa..0cbfd46 100644
--- a/docs/BrokerCommission.md
+++ b/docs/BrokerCommission.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **int** | Total | [optional]
-**list** | [**list[BrokerCommission1]**](BrokerCommission1.md) | List of comission history | [optional]
+**list** | [**list[BrokerCommission1]**](BrokerCommission1.md) | List of commission history | [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)
diff --git a/docs/BrokerCommission1.md b/docs/BrokerCommission1.md
index c515dea..0382e9c 100644
--- a/docs/BrokerCommission1.md
+++ b/docs/BrokerCommission1.md
@@ -3,15 +3,17 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**commission_time** | **int** | Commission Time. (unix timestamp) | [optional]
+**commission_time** | **int** | Commission time (Unix timestamp in seconds) | [optional]
**user_id** | **int** | User ID | [optional]
**group_name** | **str** | Group name | [optional]
**amount** | **str** | The amount of commission rebates | [optional]
**fee** | **str** | Fee | [optional]
**fee_asset** | **str** | Fee currency | [optional]
**rebate_fee** | **str** | The income from rebates, converted to USDT | [optional]
-**source** | **str** | Rebate Type: Spot、Futures、Options | [optional]
+**source** | **str** | Commission transaction type: Spot, Futures, Options, Alpha | [optional]
**currency_pair** | **str** | Currency pair | [optional]
+**sub_broker_info** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional]
+**alpha_contract_addr** | **str** | Alpha contract address | [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)
diff --git a/docs/BrokerCommissionSubBrokerInfo.md b/docs/BrokerCommissionSubBrokerInfo.md
new file mode 100644
index 0000000..d6a0912
--- /dev/null
+++ b/docs/BrokerCommissionSubBrokerInfo.md
@@ -0,0 +1,14 @@
+# BrokerCommissionSubBrokerInfo
+
+Sub-broker information
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **int** | Sub-broker user ID | [optional]
+**original_commission_rate** | **str** | Sub-broker original commission rate | [optional]
+**relative_commission_rate** | **str** | Sub-broker relative commission rate | [optional]
+**commission_rate** | **str** | Sub-broker actual commission rate | [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)
+
+
diff --git a/docs/BrokerTransaction1.md b/docs/BrokerTransaction1.md
index 299b892..07833a8 100644
--- a/docs/BrokerTransaction1.md
+++ b/docs/BrokerTransaction1.md
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
**transaction_time** | **int** | Transaction Time. (unix timestamp) | [optional]
**user_id** | **int** | User ID | [optional]
**group_name** | **str** | Group name | [optional]
-**fee** | **str** | fee (usdt) | [optional]
+**fee** | **str** | Fee amount (USDT) | [optional]
**currency_pair** | **str** | Currency pair | [optional]
-**amount** | **str** | Commission Amount | [optional]
+**amount** | **str** | Transaction amount | [optional]
**fee_asset** | **str** | Fee currency | [optional]
-**source** | **str** | Rebate Type: Spot、Futures、Options | [optional]
+**source** | **str** | Commission transaction type: Spot, Futures, Options, Alpha | [optional]
+**sub_broker_info** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional]
+**alpha_contract_addr** | **str** | Alpha contract address | [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)
diff --git a/docs/CancelBatchOrder.md b/docs/CancelBatchOrder.md
index 25a9052..4d2953b 100644
--- a/docs/CancelBatchOrder.md
+++ b/docs/CancelBatchOrder.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_pair** | **str** | Order currency pair |
**id** | **str** | Order ID or user custom ID. Custom ID are accepted only within 30 minutes after order creation |
+**account** | **str** | If the canceled order is a unified account apikey, this field must be specified and set to `unified` | [optional]
**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]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/CancelOrderResult.md b/docs/CancelOrderResult.md
index 9c4ad8d..8aa2f77 100644
--- a/docs/CancelOrderResult.md
+++ b/docs/CancelOrderResult.md
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
**text** | **str** | Custom order information | [optional]
**succeeded** | **bool** | Whether cancellation succeeded | [optional]
**label** | **str** | Error label when failed to cancel the order; emtpy if succeeded | [optional]
-**message** | **str** | Error message when failed to cancel the order; empty if succeeded | [optional]
-**account** | **str** | Empty by default. If cancelled order is cross margin order, this field is set to `cross_margin` | [optional]
+**message** | **str** | Error description when cancellation fails, empty if successful | [optional]
+**account** | **str** | Default is empty (deprecated) | [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)
diff --git a/docs/CollateralAdjust.md b/docs/CollateralAdjust.md
index 8392662..945eda4 100644
--- a/docs/CollateralAdjust.md
+++ b/docs/CollateralAdjust.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID |
-**type** | **str** | Operation types: append - for adding collateral, redeem - for withdrawing collateral |
-**collaterals** | [**list[CollateralCurrency]**](CollateralCurrency.md) | Collateral Currency List | [optional]
+**type** | **str** | Operation type: append - add collateral, redeem - withdraw collateral |
+**collaterals** | [**list[CollateralCurrency]**](CollateralCurrency.md) | Collateral currency list | [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)
diff --git a/docs/CollateralAdjustRes.md b/docs/CollateralAdjustRes.md
index 05bd46a..d116036 100644
--- a/docs/CollateralAdjustRes.md
+++ b/docs/CollateralAdjustRes.md
@@ -1,11 +1,11 @@
# CollateralAdjustRes
-Result of multi-collateral adjustment
+Multi-collateral adjustment result
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID | [optional]
-**collateral_currencies** | [**list[CollateralCurrencyRes]**](CollateralCurrencyRes.md) | Collateral Currency Information | [optional]
+**collateral_currencies** | [**list[CollateralCurrencyRes]**](CollateralCurrencyRes.md) | Collateral currency information | [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)
diff --git a/docs/CollateralAlign.md b/docs/CollateralAlign.md
index 52cc64f..4b14840 100644
--- a/docs/CollateralAlign.md
+++ b/docs/CollateralAlign.md
@@ -4,9 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID |
-**collateral_currency** | **str** | Collateral |
+**collateral_currency** | **str** | Collateral currency |
**collateral_amount** | **str** | Collateral amount |
-**type** | **str** | Operation types: append - for adding collateral, redeem - for withdrawing collateral |
+**type** | **str** | Operation type: append - add collateral, redeem - withdraw 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)
diff --git a/docs/CollateralCurrencyInfo.md b/docs/CollateralCurrencyInfo.md
index 222b2fc..0b1e1f4 100644
--- a/docs/CollateralCurrencyInfo.md
+++ b/docs/CollateralCurrencyInfo.md
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional]
**index_price** | **str** | Currency Index Price | [optional]
-**left_collateral** | **str** | Left Collateral Amount | [optional]
-**left_collateral_usdt** | **str** | Value of left collateral amount in USDT | [optional]
+**left_collateral** | **str** | Remaining collateral amount | [optional]
+**left_collateral_usdt** | **str** | Remaining collateral value converted to USDT | [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)
diff --git a/docs/CollateralCurrencyRes.md b/docs/CollateralCurrencyRes.md
index 9dcfeb8..1a64fff 100644
--- a/docs/CollateralCurrencyRes.md
+++ b/docs/CollateralCurrencyRes.md
@@ -4,10 +4,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**succeeded** | **bool** | Update success status | [optional]
-**label** | **str** | Error identifier for unsuccessful operations; empty for successful. | [optional]
-**message** | **str** | Error description in case of operation failure; empty when successful. | [optional]
+**label** | **str** | Error identifier for failed operations; empty when successful | [optional]
+**message** | **str** | Error description for failed operations; empty when successful | [optional]
**currency** | **str** | Currency | [optional]
-**amount** | **str** | Quantity of successful collateral operation; 0 if the operation fails. | [optional]
+**amount** | **str** | Successfully operated collateral quantity; 0 if operation fails | [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)
diff --git a/docs/CollateralCurrentRate.md b/docs/CollateralCurrentRate.md
index 73ba5c8..f9a94d0 100644
--- a/docs/CollateralCurrentRate.md
+++ b/docs/CollateralCurrentRate.md
@@ -1,6 +1,6 @@
# CollateralCurrentRate
-Multi-currency pledge current interest rate
+Multi-collateral current interest rate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/CollateralFixRate.md b/docs/CollateralFixRate.md
index f6e37f8..2f3f84f 100644
--- a/docs/CollateralFixRate.md
+++ b/docs/CollateralFixRate.md
@@ -5,9 +5,9 @@ Multi-collateral fixed interest rate
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional]
-**rate_7d** | **str** | Fixed interest rate for a lending period of 7 days | [optional]
-**rate_30d** | **str** | Fixed interest rate for a lending period of 30 days | [optional]
-**update_time** | **int** | Update time, timestamp, unit in seconds | [optional]
+**rate_7d** | **str** | Fixed interest rate for 7-day lending period | [optional]
+**rate_30d** | **str** | Fixed interest rate for 30-day lending period | [optional]
+**update_time** | **int** | Update time, timestamp in seconds | [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)
diff --git a/docs/CollateralLoanApi.md b/docs/CollateralLoanApi.md
index 5b55826..bfd5ed6 100644
--- a/docs/CollateralLoanApi.md
+++ b/docs/CollateralLoanApi.md
@@ -4,22 +4,22 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_collateral_loan_orders**](CollateralLoanApi.md#list_collateral_loan_orders) | **GET** /loan/collateral/orders | List Orders
-[**create_collateral_loan**](CollateralLoanApi.md#create_collateral_loan) | **POST** /loan/collateral/orders | Place order
-[**get_collateral_loan_order_detail**](CollateralLoanApi.md#get_collateral_loan_order_detail) | **GET** /loan/collateral/orders/{order_id} | Get a single order
-[**repay_collateral_loan**](CollateralLoanApi.md#repay_collateral_loan) | **POST** /loan/collateral/repay | Repayment
-[**list_repay_records**](CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | Repayment history
+[**list_collateral_loan_orders**](CollateralLoanApi.md#list_collateral_loan_orders) | **GET** /loan/collateral/orders | Query collateral loan order list
+[**create_collateral_loan**](CollateralLoanApi.md#create_collateral_loan) | **POST** /loan/collateral/orders | Place collateral loan order
+[**get_collateral_loan_order_detail**](CollateralLoanApi.md#get_collateral_loan_order_detail) | **GET** /loan/collateral/orders/{order_id} | Query single order details
+[**repay_collateral_loan**](CollateralLoanApi.md#repay_collateral_loan) | **POST** /loan/collateral/repay | Collateral loan repayment
+[**list_repay_records**](CollateralLoanApi.md#list_repay_records) | **GET** /loan/collateral/repay_records | Query collateral loan repayment records
[**list_collateral_records**](CollateralLoanApi.md#list_collateral_records) | **GET** /loan/collateral/collaterals | Query collateral adjustment records
[**operate_collateral**](CollateralLoanApi.md#operate_collateral) | **POST** /loan/collateral/collaterals | Increase or redeem collateral
-[**get_user_total_amount**](CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | Query the total borrowing and collateral amount for the user
-[**get_user_ltv_info**](CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | Query user's collateralization ratio
+[**get_user_total_amount**](CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | Query user's total borrowing and collateral amount
+[**get_user_ltv_info**](CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | Query user's collateralization ratio and remaining borrowable currencies
[**list_collateral_currencies**](CollateralLoanApi.md#list_collateral_currencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies
# **list_collateral_loan_orders**
> list[CollateralOrder] list_collateral_loan_orders(page=page, limit=limit, collateral_currency=collateral_currency, borrow_currency=borrow_currency)
-List Orders
+Query collateral loan order list
### Example
@@ -46,12 +46,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.CollateralLoanApi(api_client)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-collateral_currency = 'BTC' # str | Collateral (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+collateral_currency = 'BTC' # str | Collateral currency (optional)
borrow_currency = 'USDT' # str | Borrowed currency (optional)
try:
- # List Orders
+ # Query collateral loan order list
api_response = api_instance.list_collateral_loan_orders(page=page, limit=limit, collateral_currency=collateral_currency, borrow_currency=borrow_currency)
print(api_response)
except GateApiException as ex:
@@ -65,8 +65,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **collateral_currency** | **str**| Collateral | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **collateral_currency** | **str**| Collateral currency | [optional]
**borrow_currency** | **str**| Borrowed currency | [optional]
### Return type
@@ -85,14 +85,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_collateral_loan**
> OrderResp create_collateral_loan(create_collateral_order)
-Place order
+Place collateral loan order
### Example
@@ -121,7 +121,7 @@ api_instance = gate_api.CollateralLoanApi(api_client)
create_collateral_order = gate_api.CreateCollateralOrder() # CreateCollateralOrder |
try:
- # Place order
+ # Place collateral loan order
api_response = api_instance.create_collateral_loan(create_collateral_order)
print(api_response)
except GateApiException as ex:
@@ -152,14 +152,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order placed successfully | - |
[[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)
# **get_collateral_loan_order_detail**
> CollateralOrder get_collateral_loan_order_detail(order_id)
-Get a single order
+Query single order details
### Example
@@ -185,10 +185,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.CollateralLoanApi(api_client)
-order_id = 100001 # int | Order ID returned on successful order creation
+order_id = 100001 # int | Order ID returned when order is successfully created
try:
- # Get a single order
+ # Query single order details
api_response = api_instance.get_collateral_loan_order_detail(order_id)
print(api_response)
except GateApiException as ex:
@@ -201,7 +201,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **int**| Order ID returned on successful order creation |
+ **order_id** | **int**| Order ID returned when order is successfully created |
### Return type
@@ -219,14 +219,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order details queried successfully | - |
[[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)
# **repay_collateral_loan**
> RepayResp repay_collateral_loan(repay_loan)
-Repayment
+Collateral loan repayment
### Example
@@ -255,7 +255,7 @@ api_instance = gate_api.CollateralLoanApi(api_client)
repay_loan = gate_api.RepayLoan() # RepayLoan |
try:
- # Repayment
+ # Collateral loan repayment
api_response = api_instance.repay_collateral_loan(repay_loan)
print(api_response)
except GateApiException as ex:
@@ -286,14 +286,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Operated successfully | - |
+**200** | Operation successful | - |
[[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)
# **list_repay_records**
> list[RepayRecord] list_repay_records(source, borrow_currency=borrow_currency, collateral_currency=collateral_currency, page=page, limit=limit, _from=_from, to=to)
-Repayment history
+Query collateral loan repayment records
### Example
@@ -321,14 +321,14 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.CollateralLoanApi(api_client)
source = 'repay' # str | Operation type: repay - Regular repayment, liquidate - Liquidation
borrow_currency = 'USDT' # str | Borrowed currency (optional)
-collateral_currency = 'BTC' # str | Collateral (optional)
+collateral_currency = 'BTC' # str | Collateral currency (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1609459200 # int | Start timestamp of the query (optional)
-to = 1609459200 # int | Time range ending, default to current time (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1609459200 # int | Start timestamp for the query (optional)
+to = 1609459200 # int | End timestamp for the query, defaults to current time if not specified (optional)
try:
- # Repayment history
+ # Query collateral loan repayment records
api_response = api_instance.list_repay_records(source, borrow_currency=borrow_currency, collateral_currency=collateral_currency, page=page, limit=limit, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -343,11 +343,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**source** | **str**| Operation type: repay - Regular repayment, liquidate - Liquidation |
**borrow_currency** | **str**| Borrowed currency | [optional]
- **collateral_currency** | **str**| Collateral | [optional]
+ **collateral_currency** | **str**| Collateral currency | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
### Return type
@@ -365,7 +365,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -399,11 +399,11 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.CollateralLoanApi(api_client)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1609459200 # int | Start timestamp of the query (optional)
-to = 1609459200 # int | Time range ending, default to current time (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1609459200 # int | Start timestamp for the query (optional)
+to = 1609459200 # int | End timestamp for the query, defaults to current time if not specified (optional)
borrow_currency = 'USDT' # str | Borrowed currency (optional)
-collateral_currency = 'BTC' # str | Collateral (optional)
+collateral_currency = 'BTC' # str | Collateral currency (optional)
try:
# Query collateral adjustment records
@@ -420,11 +420,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
**borrow_currency** | **str**| Borrowed currency | [optional]
- **collateral_currency** | **str**| Collateral | [optional]
+ **collateral_currency** | **str**| Collateral currency | [optional]
### Return type
@@ -442,7 +442,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -508,14 +508,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Operated successfully | - |
+**204** | Operation successful | - |
[[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)
# **get_user_total_amount**
> UserTotalAmount get_user_total_amount()
-Query the total borrowing and collateral amount for the user
+Query user's total borrowing and collateral amount
### Example
@@ -543,7 +543,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.CollateralLoanApi(api_client)
try:
- # Query the total borrowing and collateral amount for the user
+ # Query user's total borrowing and collateral amount
api_response = api_instance.get_user_total_amount()
print(api_response)
except GateApiException as ex:
@@ -571,14 +571,14 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_user_ltv_info**
> UserLtvInfo get_user_ltv_info(collateral_currency, borrow_currency)
-Query user's collateralization ratio
+Query user's collateralization ratio and remaining borrowable currencies
### Example
@@ -604,11 +604,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.CollateralLoanApi(api_client)
-collateral_currency = 'BTC' # str | Collateral
+collateral_currency = 'BTC' # str | Collateral currency
borrow_currency = 'USDT' # str | Borrowed currency
try:
- # Query user's collateralization ratio
+ # Query user's collateralization ratio and remaining borrowable currencies
api_response = api_instance.get_user_ltv_info(collateral_currency, borrow_currency)
print(api_response)
except GateApiException as ex:
@@ -621,7 +621,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **collateral_currency** | **str**| Collateral |
+ **collateral_currency** | **str**| Collateral currency |
**borrow_currency** | **str**| Borrowed currency |
### Return type
@@ -640,7 +640,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -664,7 +664,7 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.CollateralLoanApi(api_client)
-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)
+loan_currency = 'BTC' # str | Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency (optional)
try:
# Query supported borrowing and collateral currencies
@@ -680,7 +680,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **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]
+ **loan_currency** | **str**| Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency | [optional]
### Return type
@@ -698,7 +698,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
diff --git a/docs/CollateralLtv.md b/docs/CollateralLtv.md
index 3e79d8b..5bd7f58 100644
--- a/docs/CollateralLtv.md
+++ b/docs/CollateralLtv.md
@@ -1,12 +1,12 @@
# CollateralLtv
-Collateral Ratio
+Multi-collateral ratio
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**init_ltv** | **str** | The initial collateralization rate | [optional]
-**alert_ltv** | **str** | Warning collateralization ratio | [optional]
-**liquidate_ltv** | **str** | The liquidation collateralization rate | [optional]
+**init_ltv** | **str** | Initial collateralization rate | [optional]
+**alert_ltv** | **str** | Warning collateralization rate | [optional]
+**liquidate_ltv** | **str** | Liquidation collateralization rate | [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)
diff --git a/docs/CollateralOrder.md b/docs/CollateralOrder.md
index 32216b9..b83a7fb 100644
--- a/docs/CollateralOrder.md
+++ b/docs/CollateralOrder.md
@@ -1,25 +1,25 @@
# CollateralOrder
-Collateral Order
+Collateral order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID | [optional]
-**collateral_currency** | **str** | Collateral | [optional]
+**collateral_currency** | **str** | Collateral currency | [optional]
**collateral_amount** | **str** | Collateral amount | [optional]
**borrow_currency** | **str** | Borrowed currency | [optional]
-**borrow_amount** | **str** | Borrowing amount | [optional]
+**borrow_amount** | **str** | Borrowed amount | [optional]
**repaid_amount** | **str** | Repaid amount | [optional]
**repaid_principal** | **str** | Repaid principal | [optional]
**repaid_interest** | **str** | Repaid interest | [optional]
-**init_ltv** | **str** | The initial collateralization rate | [optional]
-**current_ltv** | **str** | The current collateralization rate | [optional]
-**liquidate_ltv** | **str** | The liquidation collateralization rate | [optional]
+**init_ltv** | **str** | Initial collateralization rate | [optional]
+**current_ltv** | **str** | Current collateralization rate | [optional]
+**liquidate_ltv** | **str** | Liquidation collateralization rate | [optional]
**status** | **str** | Order status: - initial: Initial state after placing the order - collateral_deducted: Collateral deduction successful - collateral_returning: Loan failed - Collateral return pending - lent: Loan successful - repaying: Repayment in progress - liquidating: Liquidation in progress - finished: Order completed - closed_liquidated: Liquidation and repayment completed | [optional]
**borrow_time** | **int** | Borrowing time, timestamp in seconds | [optional]
**left_repay_total** | **str** | Outstanding principal and interest (outstanding principal + outstanding interest) | [optional]
-**left_repay_principal** | **str** | outstanding principal | [optional]
-**left_repay_interest** | **str** | outstanding interest | [optional]
+**left_repay_principal** | **str** | Outstanding principal | [optional]
+**left_repay_interest** | **str** | Outstanding interest | [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)
diff --git a/docs/CollateralRecord.md b/docs/CollateralRecord.md
index 5a290c8..f2fbfa7 100644
--- a/docs/CollateralRecord.md
+++ b/docs/CollateralRecord.md
@@ -7,13 +7,13 @@ Name | Type | Description | Notes
**order_id** | **int** | Order ID | [optional]
**record_id** | **int** | Collateral record ID | [optional]
**borrow_currency** | **str** | Borrowed currency | [optional]
-**borrow_amount** | **str** | Borrowing amount | [optional]
-**collateral_currency** | **str** | Collateral | [optional]
-**before_collateral** | **str** | The collateral amount before adjustment | [optional]
-**after_collateral** | **str** | The collateral amount after adjustment | [optional]
-**before_ltv** | **str** | The collateral ratio before adjustment | [optional]
-**after_ltv** | **str** | The collateral ratio after adjustment | [optional]
-**operate_time** | **int** | Timestamp of the operation, in seconds | [optional]
+**borrow_amount** | **str** | Borrowed amount | [optional]
+**collateral_currency** | **str** | Collateral currency | [optional]
+**before_collateral** | **str** | Collateral amount before adjustment | [optional]
+**after_collateral** | **str** | Collateral amount after adjustment | [optional]
+**before_ltv** | **str** | Collateral ratio before adjustment | [optional]
+**after_ltv** | **str** | Collateral ratio after adjustment | [optional]
+**operate_time** | **int** | Operation time, timestamp in seconds | [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)
diff --git a/docs/Contract.md b/docs/Contract.md
index d4bce26..d7adc71 100644
--- a/docs/Contract.md
+++ b/docs/Contract.md
@@ -5,41 +5,45 @@ Futures contract details
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Futures contract | [optional]
-**type** | **str** | Futures contract type | [optional]
+**type** | **str** | Contract type: inverse - inverse contract, direct - direct contract | [optional]
**quanto_multiplier** | **str** | Multiplier used in converting from invoicing to settlement currency | [optional]
**leverage_min** | **str** | Minimum leverage | [optional]
**leverage_max** | **str** | Maximum leverage | [optional]
**maintenance_rate** | **str** | Maintenance rate of margin | [optional]
-**mark_type** | **str** | Mark price type, internal - based on internal trading, index - based on external index price | [optional]
+**mark_type** | **str** | Mark price type: internal - internal trading price, index - external index price | [optional]
**mark_price** | **str** | Current mark price | [optional]
**index_price** | **str** | Current index price | [optional]
**last_price** | **str** | Last trading price | [optional]
-**maker_fee_rate** | **str** | Maker fee rate, where negative means rebate | [optional]
+**maker_fee_rate** | **str** | Maker fee rate, negative values indicate rebates | [optional]
**taker_fee_rate** | **str** | Taker fee rate | [optional]
**order_price_round** | **str** | Minimum order price increment | [optional]
**mark_price_round** | **str** | Minimum mark price increment | [optional]
**funding_rate** | **str** | Current funding rate | [optional]
**funding_interval** | **int** | Funding application interval, unit in seconds | [optional]
**funding_next_apply** | **float** | Next funding time | [optional]
-**risk_limit_base** | **str** | Risk limit base,deprecated | [optional]
-**risk_limit_step** | **str** | Step of adjusting risk limit,deprecated | [optional]
-**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]
-**order_size_min** | **int** | Minimum order size the contract allowed | [optional]
-**order_size_max** | **int** | Maximum order size the contract allowed | [optional]
-**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]
-**ref_discount_rate** | **str** | Referral fee rate discount | [optional]
-**ref_rebate_rate** | **str** | Referrer commission rate | [optional]
-**orderbook_id** | **int** | Current orderbook ID | [optional]
+**risk_limit_base** | **str** | Base risk limit (deprecated) | [optional]
+**risk_limit_step** | **str** | Risk limit adjustment step (deprecated) | [optional]
+**risk_limit_max** | **str** | Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits | [optional]
+**order_size_min** | **int** | Minimum order size allowed by the contract | [optional]
+**order_size_max** | **int** | Maximum order size allowed by the contract | [optional]
+**order_price_deviate** | **str** | Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
+**ref_discount_rate** | **str** | Trading fee discount for referred users | [optional]
+**ref_rebate_rate** | **str** | Commission rate for referrers | [optional]
+**orderbook_id** | **int** | Orderbook update ID | [optional]
**trade_id** | **int** | Current trade ID | [optional]
-**trade_size** | **int** | Historical accumulated trade size | [optional]
+**trade_size** | **int** | Historical cumulative trading volume | [optional]
**position_size** | **int** | Current total long position size | [optional]
-**config_change_time** | **float** | Last changed time of configuration | [optional]
-**in_delisting** | **bool** | `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline | [optional]
-**orders_limit** | **int** | Maximum number of open orders | [optional]
-**enable_bonus** | **bool** | Whether bouns is enabled | [optional]
+**config_change_time** | **float** | Last configuration update time | [optional]
+**in_delisting** | **bool** | `in_delisting=true` and position_size>0 indicates the contract is in delisting transition period `in_delisting=true` and position_size=0 indicates the contract is delisted | [optional]
+**orders_limit** | **int** | Maximum number of pending orders | [optional]
+**enable_bonus** | **bool** | Whether bonus 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]
+**status** | **str** | Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) | [optional]
+**launch_time** | **int** | Contract expiry timestamp | [optional]
+**delisting_time** | **int** | Timestamp when contract enters reduce-only state | [optional]
+**delisted_time** | **int** | Contract delisting 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)
diff --git a/docs/ContractStat.md b/docs/ContractStat.md
index c66586e..f20a520 100644
--- a/docs/ContractStat.md
+++ b/docs/ContractStat.md
@@ -4,18 +4,19 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time** | **int** | Stat timestamp | [optional]
-**lsr_taker** | **float** | Long/short account number ratio | [optional]
-**lsr_account** | **float** | Long/short taker size ratio | [optional]
-**long_liq_size** | **int** | Long liquidation size | [optional]
-**long_liq_amount** | **float** | Long liquidation amount(base currency) | [optional]
-**long_liq_usd** | **float** | Long liquidation volume(quote currency) | [optional]
-**short_liq_size** | **int** | Short liquidation size | [optional]
-**short_liq_amount** | **float** | Short liquidation amount(base currency) | [optional]
-**short_liq_usd** | **float** | Short liquidation volume(quote currency) | [optional]
-**open_interest** | **int** | Open interest size | [optional]
-**open_interest_usd** | **float** | Open interest volume(quote currency) | [optional]
+**lsr_taker** | **float** | Long/short taker ratio | [optional]
+**lsr_account** | **float** | Long/short position user ratio | [optional]
+**long_liq_size** | **int** | Long liquidation size (contracts) | [optional]
+**long_liq_amount** | **float** | Long liquidation amount (base currency) | [optional]
+**long_liq_usd** | **float** | Long liquidation volume (quote currency) | [optional]
+**short_liq_size** | **int** | Short liquidation size (contracts) | [optional]
+**short_liq_amount** | **float** | Short liquidation amount (base currency) | [optional]
+**short_liq_usd** | **float** | Short liquidation volume (quote currency) | [optional]
+**open_interest** | **int** | Total open interest size (contracts) | [optional]
+**open_interest_usd** | **float** | Total open interest volume (quote currency) | [optional]
**top_lsr_account** | **float** | Top trader long/short account ratio | [optional]
**top_lsr_size** | **float** | Top trader long/short position ratio | [optional]
+**mark_price** | **float** | Mark price | [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)
diff --git a/docs/ConvertSmallBalance.md b/docs/ConvertSmallBalance.md
index 3265b4c..e412efb 100644
--- a/docs/ConvertSmallBalance.md
+++ b/docs/ConvertSmallBalance.md
@@ -1,11 +1,11 @@
# ConvertSmallBalance
-Convert Small Balance
+Small Balance Conversion
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **list[str]** | Currency | [optional]
-**is_all** | **bool** | Whether to exchange all | [optional]
+**currency** | **list[str]** | Currency to be converted | [optional]
+**is_all** | **bool** | Whether to convert all | [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)
diff --git a/docs/CountdownCancelAllFuturesTask.md b/docs/CountdownCancelAllFuturesTask.md
index 9e05e8e..5cf1cd3 100644
--- a/docs/CountdownCancelAllFuturesTask.md
+++ b/docs/CountdownCancelAllFuturesTask.md
@@ -1,10 +1,10 @@
# CountdownCancelAllFuturesTask
-Countdown cancel task detail
+Countdown cancel task details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
+**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
**contract** | **str** | Futures contract | [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)
diff --git a/docs/CountdownCancelAllOptionsTask.md b/docs/CountdownCancelAllOptionsTask.md
index b768516..0f50bb0 100644
--- a/docs/CountdownCancelAllOptionsTask.md
+++ b/docs/CountdownCancelAllOptionsTask.md
@@ -1,10 +1,10 @@
# CountdownCancelAllOptionsTask
-Countdown cancel task detail
+Countdown cancel task details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
+**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
**contract** | **str** | Options contract name | [optional]
**underlying** | **str** | Underlying | [optional]
diff --git a/docs/CountdownCancelAllSpotTask.md b/docs/CountdownCancelAllSpotTask.md
index aaab8f8..49c09a8 100644
--- a/docs/CountdownCancelAllSpotTask.md
+++ b/docs/CountdownCancelAllSpotTask.md
@@ -1,10 +1,10 @@
# CountdownCancelAllSpotTask
-Countdown cancel task detail
+Countdown cancel task details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**timeout** | **int** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown |
+**timeout** | **int** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown |
**currency_pair** | **str** | Currency pair | [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)
diff --git a/docs/CreateCollateralOrder.md b/docs/CreateCollateralOrder.md
index d160b3a..41db4cc 100644
--- a/docs/CreateCollateralOrder.md
+++ b/docs/CreateCollateralOrder.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**collateral_amount** | **str** | Collateral amount |
-**collateral_currency** | **str** | Collateral |
-**borrow_amount** | **str** | Borrowing amount |
+**collateral_currency** | **str** | Collateral currency |
+**borrow_amount** | **str** | Borrowed amount |
**borrow_currency** | **str** | Borrowed currency |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/CreateMultiCollateralOrder.md b/docs/CreateMultiCollateralOrder.md
index c98e244..72aa727 100644
--- a/docs/CreateMultiCollateralOrder.md
+++ b/docs/CreateMultiCollateralOrder.md
@@ -4,13 +4,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **str** | Order ID | [optional]
-**order_type** | **str** | current - current, fixed - fixed, if not specified, default to current | [optional]
-**fixed_type** | **str** | Fixed interest rate loan period: 7d - 7 days, 30d - 30 days. Must be provided for fixed | [optional]
-**fixed_rate** | **str** | Fixed interest rate, must be specified for fixed | [optional]
-**auto_renew** | **bool** | Fixed interest rate, automatic renewal | [optional]
-**auto_repay** | **bool** | Fixed interest rate, automatic repayment | [optional]
+**order_type** | **str** | current - current rate, fixed - fixed rate, defaults to current if not specified | [optional]
+**fixed_type** | **str** | Fixed interest rate lending period: 7d - 7 days, 30d - 30 days. Required for fixed rate | [optional]
+**fixed_rate** | **str** | Fixed interest rate, required for fixed rate | [optional]
+**auto_renew** | **bool** | Fixed interest rate, auto-renewal | [optional]
+**auto_repay** | **bool** | Fixed interest rate, auto-repayment | [optional]
**borrow_currency** | **str** | Borrowed currency |
-**borrow_amount** | **str** | Borrowing amount |
+**borrow_amount** | **str** | Borrowed amount |
**collateral_currencies** | [**list[CollateralCurrency]**](CollateralCurrency.md) | Collateral currency and amount | [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)
diff --git a/docs/CreateUniLend.md b/docs/CreateUniLend.md
index c17fc8e..8c9af5a 100644
--- a/docs/CreateUniLend.md
+++ b/docs/CreateUniLend.md
@@ -1,13 +1,13 @@
# CreateUniLend
-Lend or redeem
+Create lending or redemption
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name |
-**amount** | **str** | The amount of currency could be lent |
-**type** | **str** | type: lend - lend, redeem - redeem |
-**min_rate** | **str** | The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. | [optional]
+**amount** | **str** | Amount to deposit into lending pool |
+**type** | **str** | Operation type: lend - Lend, redeem - Redeem |
+**min_rate** | **str** | Minimum interest rate. If set too high, lending may fail and no interest will be earned. Required for lending operations. | [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)
diff --git a/docs/CreateUniLoan.md b/docs/CreateUniLoan.md
index a8f30e1..22ad9da 100644
--- a/docs/CreateUniLoan.md
+++ b/docs/CreateUniLoan.md
@@ -5,9 +5,9 @@ Borrow or repay
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency |
-**type** | **str** | type: borrow - borrow, repay - repay |
-**amount** | **str** | The amount of lending or repaying |
-**repaid_all** | **bool** | Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. | [optional]
+**type** | **str** | Type: `borrow` - borrow, `repay` - repay |
+**amount** | **str** | Borrow or repayment amount |
+**repaid_all** | **bool** | Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount | [optional]
**currency_pair** | **str** | Currency pair |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/CrossMarginAccount.md b/docs/CrossMarginAccount.md
deleted file mode 100644
index 64dc282..0000000
--- a/docs/CrossMarginAccount.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# CrossMarginAccount
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**user_id** | **int** | User ID | [optional]
-**refresh_time** | **int** | Time of the most recent refresh | [optional]
-**locked** | **bool** | Whether account is locked | [optional]
-**balances** | [**dict(str, CrossMarginBalance)**](CrossMarginBalance.md) | | [optional]
-**total** | **str** | Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` | [optional]
-**borrowed** | **str** | Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` | [optional]
-**interest** | **str** | Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional]
-**risk** | **str** | Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional]
-**total_initial_margin** | **str** | Total initial margin | [optional]
-**total_margin_balance** | **str** | Total Margin Balance (∑(positive equity ＊ index price * discount) + ∑(negative equity * index price)) | [optional]
-**total_maintenance_margin** | **str** | Total maintenance margin | [optional]
-**total_initial_margin_rate** | **str** | Total initial margin rate | [optional]
-**total_maintenance_margin_rate** | **str** | Total maintenance margin rate | [optional]
-**total_available_margin** | **str** | Total available margin | [optional]
-**portfolio_margin_total** | **str** | Total amount of the portfolio margin account | [optional]
-**portfolio_margin_total_liab** | **str** | Total liabilities of the portfolio margin account | [optional]
-**portfolio_margin_total_equity** | **str** | Total equity of the portfolio margin account | [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)
-
-
diff --git a/docs/CrossMarginAccountBook.md b/docs/CrossMarginAccountBook.md
deleted file mode 100644
index d02b52f..0000000
--- a/docs/CrossMarginAccountBook.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# CrossMarginAccountBook
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** | Balance change record ID | [optional]
-**time** | **int** | The timestamp of the change (in milliseconds) | [optional]
-**currency** | **str** | Currency changed | [optional]
-**change** | **str** | Amount changed. Positive value means transferring in, while negative out | [optional]
-**balance** | **str** | Balance after change | [optional]
-**type** | **str** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [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)
-
-
diff --git a/docs/CrossMarginBalance.md b/docs/CrossMarginBalance.md
index 275fa85..f4ccc54 100644
--- a/docs/CrossMarginBalance.md
+++ b/docs/CrossMarginBalance.md
@@ -3,15 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**available** | **str** | Available amount | [optional]
-**freeze** | **str** | Locked amount | [optional]
-**borrowed** | **str** | Borrowed amount | [optional]
-**interest** | **str** | Unpaid interests | [optional]
-**negative_liab** | **str** | Negative Liabilities. Formula:Min[available+total+unrealized_pnl,0] | [optional]
-**futures_pos_liab** | **str** | Borrowing to Open Positions in Futures | [optional]
-**equity** | **str** | Equity. Formula: available + freeze - borrowed + futures account's total + unrealized_pnl | [optional]
-**total_freeze** | **str** | Total freeze. Formula: freeze + position_initial_margin + order_margin | [optional]
-**total_liab** | **str** | Total liabilities. Formula: Max[Abs[Min[quity - total_freeze,0], borrowed]] - futures_pos_liab | [optional]
+**available** | **str** | Available balance | [optional]
+**freeze** | **str** | Locked balance | [optional]
+**borrowed** | **str** | Borrowed balance | [optional]
+**interest** | **str** | Unpaid interest | [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)
diff --git a/docs/CrossMarginBalance1.md b/docs/CrossMarginBalance1.md
deleted file mode 100644
index 2db2a14..0000000
--- a/docs/CrossMarginBalance1.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# CrossMarginBalance1
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**available** | **str** | Available amount | [optional]
-**freeze** | **str** | Locked amount | [optional]
-**borrowed** | **str** | Borrowed amount | [optional]
-**interest** | **str** | Unpaid interests | [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)
-
-
diff --git a/docs/CrossMarginCurrency.md b/docs/CrossMarginCurrency.md
deleted file mode 100644
index 0e3038a..0000000
--- a/docs/CrossMarginCurrency.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# CrossMarginCurrency
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **str** | Currency name | [optional]
-**rate** | **str** | Minimum lending rate (hourly rate) | [optional]
-**prec** | **str** | Currency precision | [optional]
-**discount** | **str** | Currency value discount, which is used in total value calculation | [optional]
-**min_borrow_amount** | **str** | Minimum currency borrow amount. Unit is currency itself | [optional]
-**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)
-
-
diff --git a/docs/CrossMarginLoan.md b/docs/CrossMarginLoan.md
index f3f8012..662a94c 100644
--- a/docs/CrossMarginLoan.md
+++ b/docs/CrossMarginLoan.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**status** | **int** | Deprecated. Currently, all statuses have been set to 2. Borrow loan status, which includes: - 1: failed to borrow - 2: borrowed but not repaid - 3: repayment complete | [optional] [readonly]
**repaid** | **str** | Repaid amount | [optional] [readonly]
**repaid_interest** | **str** | Repaid interest | [optional] [readonly]
-**unpaid_interest** | **str** | Outstanding interest yet to be paid | [optional] [readonly]
+**unpaid_interest** | **str** | Unpaid interest | [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)
diff --git a/docs/CrossMarginRepayment.md b/docs/CrossMarginRepayment.md
index 147ccbc..3997879 100644
--- a/docs/CrossMarginRepayment.md
+++ b/docs/CrossMarginRepayment.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**currency** | **str** | Currency name | [optional]
**principal** | **str** | Repaid principal | [optional]
**interest** | **str** | Repaid interest | [optional]
-**repayment_type** | **str** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation | [optional] [readonly]
+**repayment_type** | **str** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment after cancellation | [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)
diff --git a/docs/Currency.md b/docs/Currency.md
index 84ed666..27e0400 100644
--- a/docs/Currency.md
+++ b/docs/Currency.md
@@ -3,14 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Currency name | [optional]
+**currency** | **str** | Currency symbol | [optional]
+**name** | **str** | Currency name | [optional]
**delisted** | **bool** | Whether currency is de-listed | [optional]
-**withdraw_disabled** | **bool** | Whether currency's withdrawal is disabled | [optional]
-**withdraw_delayed** | **bool** | Whether currency's withdrawal is delayed | [optional]
-**deposit_disabled** | **bool** | Whether currency's deposit is disabled | [optional]
+**withdraw_disabled** | **bool** | Whether currency's withdrawal is disabled (deprecated) | [optional]
+**withdraw_delayed** | **bool** | Whether currency's withdrawal is delayed (deprecated) | [optional]
+**deposit_disabled** | **bool** | Whether currency's deposit is disabled (deprecated) | [optional]
**trade_disabled** | **bool** | Whether currency's trading is disabled | [optional]
**fixed_rate** | **str** | Fixed fee rate. Only for fixed rate currencies, not valid for normal currencies | [optional]
-**chain** | **str** | Chain of currency | [optional]
+**chain** | **str** | The main chain corresponding to the coin | [optional]
+**chains** | [**list[SpotCurrencyChain]**](SpotCurrencyChain.md) | All links corresponding to coins | [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)
diff --git a/docs/CurrencyChain.md b/docs/CurrencyChain.md
index e45d973..90a4984 100644
--- a/docs/CurrencyChain.md
+++ b/docs/CurrencyChain.md
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
**name_en** | **str** | Chain name in English | [optional]
**contract_address** | **str** | Smart contract address for the currency; if no address is available, it will be an empty string | [optional]
**is_disabled** | **int** | If it is disabled. 0 means NOT being disabled | [optional]
-**is_deposit_disabled** | **int** | Is deposit disabled. 0 means not | [optional]
-**is_withdraw_disabled** | **int** | Is withdrawal disabled. 0 means not | [optional]
+**is_deposit_disabled** | **int** | Is deposit disabled. 0 means not disabled | [optional]
+**is_withdraw_disabled** | **int** | Is withdrawal disabled. 0 means not disabled | [optional]
**decimal** | **str** | Withdrawal precision | [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)
diff --git a/docs/CurrencyPair.md b/docs/CurrencyPair.md
index 5c4402c..3f5f39f 100644
--- a/docs/CurrencyPair.md
+++ b/docs/CurrencyPair.md
@@ -6,17 +6,23 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Currency pair | [optional]
**base** | **str** | Base currency | [optional]
+**base_name** | **str** | Base currency name | [optional]
**quote** | **str** | Quote currency | [optional]
-**fee** | **str** | Trading fee | [optional]
+**quote_name** | **str** | Quote currency name | [optional]
+**fee** | **str** | Trading fee rate | [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]
+**trade_status** | **str** | Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold | [optional]
**sell_start** | **int** | Sell start unix timestamp in seconds | [optional]
**buy_start** | **int** | Buy start unix timestamp in seconds | [optional]
+**delisting_time** | **int** | Expected time to remove the shelves, Unix timestamp in seconds | [optional]
+**type** | **str** | Trading pair type, normal: normal, premarket: pre-market | [optional]
+**trade_url** | **str** | Transaction link | [optional]
+**st_tag** | **bool** | Whether the trading pair is in ST risk assessment, false - No, true - Yes | [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)
diff --git a/docs/CurrencyQuota.md b/docs/CurrencyQuota.md
index f563b08..656a6a8 100644
--- a/docs/CurrencyQuota.md
+++ b/docs/CurrencyQuota.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional]
**index_price** | **str** | Currency Index Price | [optional]
-**min_quota** | **str** | Minimum borrowing/collateral quota for the currency | [optional]
-**left_quota** | **str** | Remaining borrowing/collateral limit for the currency | [optional]
+**min_quota** | **str** | Minimum borrowing/collateral limit for the currency | [optional]
+**left_quota** | **str** | Remaining borrowing/collateral quota for the currency | [optional]
**left_quote_usdt** | **str** | Remaining currency limit converted to USDT | [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)
diff --git a/docs/CrossMarginRepayRequest.md b/docs/DebitFee.md
similarity index 70%
rename from docs/CrossMarginRepayRequest.md
rename to docs/DebitFee.md
index 9c1ca05..98d0744 100644
--- a/docs/CrossMarginRepayRequest.md
+++ b/docs/DebitFee.md
@@ -1,10 +1,9 @@
-# CrossMarginRepayRequest
+# DebitFee
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Repayment currency |
-**amount** | **str** | Repayment amount |
+**enabled** | **bool** | Whether GT fee deduction is enabled |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/DeliveryApi.md b/docs/DeliveryApi.md
index 6f9a03f..88ac2c5 100644
--- a/docs/DeliveryApi.md
+++ b/docs/DeliveryApi.md
@@ -4,41 +4,41 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_delivery_contracts**](DeliveryApi.md#list_delivery_contracts) | **GET** /delivery/{settle}/contracts | List all futures contracts
-[**get_delivery_contract**](DeliveryApi.md#get_delivery_contract) | **GET** /delivery/{settle}/contracts/{contract} | Get a single contract
-[**list_delivery_order_book**](DeliveryApi.md#list_delivery_order_book) | **GET** /delivery/{settle}/order_book | Futures order book
-[**list_delivery_trades**](DeliveryApi.md#list_delivery_trades) | **GET** /delivery/{settle}/trades | Futures trading history
-[**list_delivery_candlesticks**](DeliveryApi.md#list_delivery_candlesticks) | **GET** /delivery/{settle}/candlesticks | Get futures candlesticks
-[**list_delivery_tickers**](DeliveryApi.md#list_delivery_tickers) | **GET** /delivery/{settle}/tickers | List futures tickers
-[**list_delivery_insurance_ledger**](DeliveryApi.md#list_delivery_insurance_ledger) | **GET** /delivery/{settle}/insurance | Futures insurance balance history
-[**list_delivery_accounts**](DeliveryApi.md#list_delivery_accounts) | **GET** /delivery/{settle}/accounts | Query futures account
-[**list_delivery_account_book**](DeliveryApi.md#list_delivery_account_book) | **GET** /delivery/{settle}/account_book | Query account book
-[**list_delivery_positions**](DeliveryApi.md#list_delivery_positions) | **GET** /delivery/{settle}/positions | List all positions of a user
-[**get_delivery_position**](DeliveryApi.md#get_delivery_position) | **GET** /delivery/{settle}/positions/{contract} | Get single position
+[**list_delivery_contracts**](DeliveryApi.md#list_delivery_contracts) | **GET** /delivery/{settle}/contracts | Query all futures contracts
+[**get_delivery_contract**](DeliveryApi.md#get_delivery_contract) | **GET** /delivery/{settle}/contracts/{contract} | Query single contract information
+[**list_delivery_order_book**](DeliveryApi.md#list_delivery_order_book) | **GET** /delivery/{settle}/order_book | Query futures market depth information
+[**list_delivery_trades**](DeliveryApi.md#list_delivery_trades) | **GET** /delivery/{settle}/trades | Futures market transaction records
+[**list_delivery_candlesticks**](DeliveryApi.md#list_delivery_candlesticks) | **GET** /delivery/{settle}/candlesticks | Futures market K-line chart
+[**list_delivery_tickers**](DeliveryApi.md#list_delivery_tickers) | **GET** /delivery/{settle}/tickers | Get all futures trading statistics
+[**list_delivery_insurance_ledger**](DeliveryApi.md#list_delivery_insurance_ledger) | **GET** /delivery/{settle}/insurance | Futures market insurance fund history
+[**list_delivery_accounts**](DeliveryApi.md#list_delivery_accounts) | **GET** /delivery/{settle}/accounts | Get futures account
+[**list_delivery_account_book**](DeliveryApi.md#list_delivery_account_book) | **GET** /delivery/{settle}/account_book | Query futures account change history
+[**list_delivery_positions**](DeliveryApi.md#list_delivery_positions) | **GET** /delivery/{settle}/positions | Get user position list
+[**get_delivery_position**](DeliveryApi.md#get_delivery_position) | **GET** /delivery/{settle}/positions/{contract} | Get single position information
[**update_delivery_position_margin**](DeliveryApi.md#update_delivery_position_margin) | **POST** /delivery/{settle}/positions/{contract}/margin | Update position margin
[**update_delivery_position_leverage**](DeliveryApi.md#update_delivery_position_leverage) | **POST** /delivery/{settle}/positions/{contract}/leverage | Update position leverage
[**update_delivery_position_risk_limit**](DeliveryApi.md#update_delivery_position_risk_limit) | **POST** /delivery/{settle}/positions/{contract}/risk_limit | Update position risk limit
-[**list_delivery_orders**](DeliveryApi.md#list_delivery_orders) | **GET** /delivery/{settle}/orders | List futures orders
-[**create_delivery_order**](DeliveryApi.md#create_delivery_order) | **POST** /delivery/{settle}/orders | Create a futures order
-[**cancel_delivery_orders**](DeliveryApi.md#cancel_delivery_orders) | **DELETE** /delivery/{settle}/orders | Cancel all `open` orders matched
-[**get_delivery_order**](DeliveryApi.md#get_delivery_order) | **GET** /delivery/{settle}/orders/{order_id} | Get a single order
-[**cancel_delivery_order**](DeliveryApi.md#cancel_delivery_order) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel a single order
-[**get_my_delivery_trades**](DeliveryApi.md#get_my_delivery_trades) | **GET** /delivery/{settle}/my_trades | List personal trading history
-[**list_delivery_position_close**](DeliveryApi.md#list_delivery_position_close) | **GET** /delivery/{settle}/position_close | List position close history
-[**list_delivery_liquidates**](DeliveryApi.md#list_delivery_liquidates) | **GET** /delivery/{settle}/liquidates | List liquidation history
-[**list_delivery_settlements**](DeliveryApi.md#list_delivery_settlements) | **GET** /delivery/{settle}/settlements | List settlement history
-[**list_delivery_risk_limit_tiers**](DeliveryApi.md#list_delivery_risk_limit_tiers) | **GET** /delivery/{settle}/risk_limit_tiers | List risk limit tiers
-[**list_price_triggered_delivery_orders**](DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | List all auto orders
-[**create_price_triggered_delivery_order**](DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order
-[**cancel_price_triggered_delivery_order_list**](DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all open orders
-[**get_price_triggered_delivery_order**](DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order
-[**cancel_price_triggered_delivery_order**](DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order
+[**list_delivery_orders**](DeliveryApi.md#list_delivery_orders) | **GET** /delivery/{settle}/orders | Query futures order list
+[**create_delivery_order**](DeliveryApi.md#create_delivery_order) | **POST** /delivery/{settle}/orders | Place futures order
+[**cancel_delivery_orders**](DeliveryApi.md#cancel_delivery_orders) | **DELETE** /delivery/{settle}/orders | Cancel all orders with 'open' status
+[**get_delivery_order**](DeliveryApi.md#get_delivery_order) | **GET** /delivery/{settle}/orders/{order_id} | Query single order details
+[**cancel_delivery_order**](DeliveryApi.md#cancel_delivery_order) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel single order
+[**get_my_delivery_trades**](DeliveryApi.md#get_my_delivery_trades) | **GET** /delivery/{settle}/my_trades | Query personal trading records
+[**list_delivery_position_close**](DeliveryApi.md#list_delivery_position_close) | **GET** /delivery/{settle}/position_close | Query position close history
+[**list_delivery_liquidates**](DeliveryApi.md#list_delivery_liquidates) | **GET** /delivery/{settle}/liquidates | Query liquidation history
+[**list_delivery_settlements**](DeliveryApi.md#list_delivery_settlements) | **GET** /delivery/{settle}/settlements | Query settlement records
+[**list_delivery_risk_limit_tiers**](DeliveryApi.md#list_delivery_risk_limit_tiers) | **GET** /delivery/{settle}/risk_limit_tiers | Query risk limit tiers
+[**list_price_triggered_delivery_orders**](DeliveryApi.md#list_price_triggered_delivery_orders) | **GET** /delivery/{settle}/price_orders | Query auto order list
+[**create_price_triggered_delivery_order**](DeliveryApi.md#create_price_triggered_delivery_order) | **POST** /delivery/{settle}/price_orders | Create price-triggered order
+[**cancel_price_triggered_delivery_order_list**](DeliveryApi.md#cancel_price_triggered_delivery_order_list) | **DELETE** /delivery/{settle}/price_orders | Cancel all auto orders
+[**get_price_triggered_delivery_order**](DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Query single auto order details
+[**cancel_price_triggered_delivery_order**](DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | Cancel single auto order
# **list_delivery_contracts**
> list[DeliveryContract] list_delivery_contracts(settle)
-List all futures contracts
+Query all futures contracts
### Example
@@ -58,7 +58,7 @@ api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
try:
- # List all futures contracts
+ # Query all futures contracts
api_response = api_instance.list_delivery_contracts(settle)
print(api_response)
except GateApiException as ex:
@@ -89,14 +89,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_delivery_contract**
> DeliveryContract get_delivery_contract(settle, contract)
-Get a single contract
+Query single contract information
### Example
@@ -117,7 +117,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
try:
- # Get a single contract
+ # Query single contract information
api_response = api_instance.get_delivery_contract(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -156,7 +156,7 @@ No authorization required
# **list_delivery_order_book**
> FuturesOrderBook list_delivery_order_book(settle, contract, interval=interval, limit=limit, with_id=with_id)
-Futures order book
+Query futures market depth information
Bids will be sorted by price from high to low, while asks sorted reversely
@@ -177,12 +177,12 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
-interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
-limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)
-with_id = False # bool | Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional) (default to False)
+interval = '0' # str | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional) (default to '0')
+limit = 10 # int | Number of depth levels (optional) (default to 10)
+with_id = False # bool | Whether to return depth update ID. This ID increments by 1 each time depth changes (optional) (default to False)
try:
- # Futures order book
+ # Query futures market depth information
api_response = api_instance.list_delivery_order_book(settle, contract, interval=interval, limit=limit, with_id=with_id)
print(api_response)
except GateApiException as ex:
@@ -197,9 +197,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **interval** | **str**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to '0']
- **limit** | **int**| Maximum number of order depth data in asks or bids | [optional] [default to 10]
- **with_id** | **bool**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to False]
+ **interval** | **str**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to '0']
+ **limit** | **int**| Number of depth levels | [optional] [default to 10]
+ **with_id** | **bool**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to False]
### Return type
@@ -217,14 +217,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Order book retrieved | - |
+**200** | Depth query successful | - |
[[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)
# **list_delivery_trades**
> list[FuturesTrade] list_delivery_trades(settle, contract, limit=limit, last_id=last_id, _from=_from, to=to)
-Futures trading history
+Futures market transaction records
### Example
@@ -243,13 +243,13 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-last_id = '12345' # str | Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+last_id = '12345' # str | Use the ID of the last record in the previous list as the starting point for the next list.This field is no longer supported. For new requests, please use the fromand tofields to specify the time rang (optional)
_from = 1546905600 # int | Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. (optional)
-to = 1546935600 # int | Specify end time in Unix seconds, default to current time (optional)
+to = 1546935600 # int | Specify end time in Unix seconds, default to current time. (optional)
try:
- # Futures trading history
+ # Futures market transaction records
api_response = api_instance.list_delivery_trades(settle, contract, limit=limit, last_id=last_id, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -264,10 +264,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **last_id** | **str**| Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **last_id** | **str**| Use the ID of the last record in the previous list as the starting point for the next list.This field is no longer supported. For new requests, please use the fromand tofields to specify the time rang | [optional]
**_from** | **int**| Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. | [optional]
- **to** | **int**| Specify end time in Unix seconds, default to current time | [optional]
+ **to** | **int**| Specify end time in Unix seconds, default to current time. | [optional]
### Return type
@@ -285,14 +285,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_candlesticks**
> list[DeliveryCandlestick] list_delivery_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
-Get futures candlesticks
+Futures market K-line chart
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval`
@@ -314,12 +314,12 @@ api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
_from = 1546905600 # int | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
-to = 1546935600 # int | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
-limit = 100 # int | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
-interval = '5m' # str | Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 (optional) (default to '5m')
+to = 1546935600 # int | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision (optional)
+limit = 100 # int | Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
+interval = '5m' # str | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time (optional) (default to '5m')
try:
- # Get futures candlesticks
+ # Futures market K-line chart
api_response = api_instance.list_delivery_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
print(api_response)
except GateApiException as ex:
@@ -335,9 +335,9 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
**_from** | **int**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional]
- **to** | **int**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional]
- **limit** | **int**| Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
- **interval** | **str**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 | [optional] [default to '5m']
+ **to** | **int**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision | [optional]
+ **limit** | **int**| Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
+ **interval** | **str**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time | [optional] [default to '5m']
### Return type
@@ -355,14 +355,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_delivery_tickers**
-> list[FuturesTicker] list_delivery_tickers(settle, contract=contract)
+> list[DeliveryTicker] list_delivery_tickers(settle, contract=contract)
-List futures tickers
+Get all futures trading statistics
### Example
@@ -383,7 +383,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
try:
- # List futures tickers
+ # Get all futures trading statistics
api_response = api_instance.list_delivery_tickers(settle, contract=contract)
print(api_response)
except GateApiException as ex:
@@ -401,7 +401,7 @@ Name | Type | Description | Notes
### Return type
-[**list[FuturesTicker]**](FuturesTicker.md)
+[**list[DeliveryTicker]**](DeliveryTicker.md)
### Authorization
@@ -415,14 +415,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_delivery_insurance_ledger**
> list[InsuranceRecord] list_delivery_insurance_ledger(settle, limit=limit)
-Futures insurance balance history
+Futures market insurance fund history
### Example
@@ -440,10 +440,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
- # Futures insurance balance history
+ # Futures market insurance fund history
api_response = api_instance.list_delivery_insurance_ledger(settle, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -457,7 +457,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -475,14 +475,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_delivery_accounts**
> FuturesAccount list_delivery_accounts(settle)
-Query futures account
+Get futures account
### Example
@@ -511,7 +511,7 @@ api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
try:
- # Query futures account
+ # Get futures account
api_response = api_instance.list_delivery_accounts(settle)
print(api_response)
except GateApiException as ex:
@@ -542,14 +542,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_account_book**
> list[FuturesAccountBook] list_delivery_account_book(settle, limit=limit, _from=_from, to=to, type=type)
-Query account book
+Query futures account change history
### Example
@@ -576,13 +576,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-type = 'dnw' # str | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+type = 'dnw' # str | Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates (optional)
try:
- # Query account book
+ # Query futures account change history
api_response = api_instance.list_delivery_account_book(settle, limit=limit, _from=_from, to=to, type=type)
print(api_response)
except GateApiException as ex:
@@ -596,10 +596,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **type** | **str**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **type** | **str**| Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates | [optional]
### Return type
@@ -617,14 +617,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_positions**
> list[Position] list_delivery_positions(settle)
-List all positions of a user
+Get user position list
### Example
@@ -653,7 +653,7 @@ api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
try:
- # List all positions of a user
+ # Get user position list
api_response = api_instance.list_delivery_positions(settle)
print(api_response)
except GateApiException as ex:
@@ -684,14 +684,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_delivery_position**
> Position get_delivery_position(settle, contract)
-Get single position
+Get single position information
### Example
@@ -721,7 +721,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
try:
- # Get single position
+ # Get single position information
api_response = api_instance.get_delivery_position(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -788,7 +788,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
-change = '0.01' # str | Margin change. Use positive number to increase margin, negative number otherwise.
+change = '0.01' # str | Margin change amount, positive number increases, negative number decreases
try:
# Update position margin
@@ -806,7 +806,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **change** | **str**| Margin change. Use positive number to increase margin, negative number otherwise. |
+ **change** | **str**| Margin change amount, positive number increases, negative number decreases |
### Return type
@@ -973,9 +973,9 @@ Name | Type | Description | Notes
# **list_delivery_orders**
> list[FuturesOrder] list_delivery_orders(settle, status, contract=contract, limit=limit, offset=offset, last_id=last_id, count_total=count_total)
-List futures orders
+Query futures order list
-Zero-filled order cannot be retrieved 10 minutes after order cancellation
+Zero-fill orders cannot be retrieved 10 minutes after order cancellation
### Example
@@ -1002,15 +1002,15 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-status = 'open' # str | Only list the orders with this status
+status = 'open' # str | Query order list based on status
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)
-count_total = 0 # int | Whether to return total number matched. Default to 0(no return) (optional) (default to 0)
+last_id = '12345' # str | Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used (optional)
+count_total = 0 # int | Whether to return total number matched, defaults to 0 (no return) (optional) (default to 0)
try:
- # List futures orders
+ # Query futures order list
api_response = api_instance.list_delivery_orders(settle, status, contract=contract, limit=limit, offset=offset, last_id=last_id, count_total=count_total)
print(api_response)
except GateApiException as ex:
@@ -1024,12 +1024,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **status** | **str**| Only list the orders with this status |
+ **status** | **str**| Query order list based on status |
**contract** | **str**| Futures contract | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **last_id** | **str**| Specify list staring point using the `id` of last record in previous list-query results | [optional]
- **count_total** | **int**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0]
+ **last_id** | **str**| Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used | [optional]
+ **count_total** | **int**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0]
### Return type
@@ -1047,16 +1047,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
* X-Pagination-Total - Total number matched. Only returned if `count_total` set to 1
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
* X-Pagination-Total - Total number matched, only returned if `count_total` is set to 1
|
[[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)
# **create_delivery_order**
> FuturesOrder create_delivery_order(settle, futures_order)
-Create a futures order
+Place futures order
-Zero-filled order cannot be retrieved 10 minutes after order cancellation
+Zero-fill orders cannot be retrieved 10 minutes after order cancellation
### Example
@@ -1086,7 +1086,7 @@ settle = 'usdt' # str | Settle currency
futures_order = gate_api.FuturesOrder() # FuturesOrder |
try:
- # Create a futures order
+ # Place futures order
api_response = api_instance.create_delivery_order(settle, futures_order)
print(api_response)
except GateApiException as ex:
@@ -1125,9 +1125,9 @@ Name | Type | Description | Notes
# **cancel_delivery_orders**
> list[FuturesOrder] cancel_delivery_orders(settle, contract, side=side)
-Cancel all `open` orders matched
+Cancel all orders with 'open' status
-Zero-filled order cannot be retrieved 10 minutes after order cancellation
+Zero-fill orders cannot be retrieved 10 minutes after order cancellation
### Example
@@ -1155,10 +1155,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract
-side = 'ask' # str | All bids or asks. Both included if not specified (optional)
+side = 'ask' # str | Specify all bids or all asks, both included if not specified (optional)
try:
- # Cancel all `open` orders matched
+ # Cancel all orders with 'open' status
api_response = api_instance.cancel_delivery_orders(settle, contract, side=side)
print(api_response)
except GateApiException as ex:
@@ -1173,7 +1173,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **side** | **str**| All bids or asks. Both included if not specified | [optional]
+ **side** | **str**| Specify all bids or all asks, both included if not specified | [optional]
### Return type
@@ -1191,16 +1191,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | All orders matched cancelled | - |
+**200** | Batch cancellation successful | - |
[[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)
# **get_delivery_order**
> FuturesOrder get_delivery_order(settle, order_id)
-Get a single order
+Query single order details
-Zero-filled order cannot be retrieved 10 minutes after order cancellation
+Zero-fill orders cannot be retrieved 10 minutes after order cancellation
### Example
@@ -1227,10 +1227,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = '12345' # str | Retrieve the data of the order with the specified ID
+order_id = '12345' # str | ID returned when order is successfully created
try:
- # Get a single order
+ # Query single order details
api_response = api_instance.get_delivery_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -1244,7 +1244,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -1269,7 +1269,7 @@ Name | Type | Description | Notes
# **cancel_delivery_order**
> FuturesOrder cancel_delivery_order(settle, order_id)
-Cancel a single order
+Cancel single order
### Example
@@ -1296,10 +1296,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = '12345' # str | Retrieve the data of the order with the specified ID
+order_id = '12345' # str | ID returned when order is successfully created
try:
- # Cancel a single order
+ # Cancel single order
api_response = api_instance.cancel_delivery_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -1313,7 +1313,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -1338,7 +1338,7 @@ Name | Type | Description | Notes
# **get_my_delivery_trades**
> list[MyFuturesTrade] get_my_delivery_trades(settle, contract=contract, order=order, limit=limit, offset=offset, last_id=last_id, count_total=count_total)
-List personal trading history
+Query personal trading records
### Example
@@ -1367,13 +1367,13 @@ api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
order = 12345 # int | Futures order ID, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)
-count_total = 0 # int | Whether to return total number matched. Default to 0(no return) (optional) (default to 0)
+last_id = '12345' # str | Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used (optional)
+count_total = 0 # int | Whether to return total number matched, defaults to 0 (no return) (optional) (default to 0)
try:
- # List personal trading history
+ # Query personal trading records
api_response = api_instance.get_my_delivery_trades(settle, contract=contract, order=order, limit=limit, offset=offset, last_id=last_id, count_total=count_total)
print(api_response)
except GateApiException as ex:
@@ -1389,10 +1389,10 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract | [optional]
**order** | **int**| Futures order ID, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **last_id** | **str**| Specify list staring point using the `id` of last record in previous list-query results | [optional]
- **count_total** | **int**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0]
+ **last_id** | **str**| Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used | [optional]
+ **count_total** | **int**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0]
### Return type
@@ -1410,14 +1410,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
* X-Pagination-Total - Total number matched. Only returned if `count_total` set to 1
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
* X-Pagination-Total - Total number matched, only returned if `count_total` is set to 1
|
[[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)
# **list_delivery_position_close**
> list[PositionClose] list_delivery_position_close(settle, contract=contract, limit=limit)
-List position close history
+Query position close history
### Example
@@ -1445,10 +1445,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
- # List position close history
+ # Query position close history
api_response = api_instance.list_delivery_position_close(settle, contract=contract, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -1463,7 +1463,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -1481,14 +1481,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_liquidates**
> list[FuturesLiquidate] list_delivery_liquidates(settle, contract=contract, limit=limit, at=at)
-List liquidation history
+Query liquidation history
### Example
@@ -1516,11 +1516,11 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-at = 0 # int | Specify a liquidation timestamp (optional) (default to 0)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+at = 0 # int | Specify liquidation timestamp (optional) (default to 0)
try:
- # List liquidation history
+ # Query liquidation history
api_response = api_instance.list_delivery_liquidates(settle, contract=contract, limit=limit, at=at)
print(api_response)
except GateApiException as ex:
@@ -1535,8 +1535,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **at** | **int**| Specify a liquidation timestamp | [optional] [default to 0]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **at** | **int**| Specify liquidation timestamp | [optional] [default to 0]
### Return type
@@ -1554,14 +1554,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_settlements**
> list[DeliverySettlement] list_delivery_settlements(settle, contract=contract, limit=limit, at=at)
-List settlement history
+Query settlement records
### Example
@@ -1589,11 +1589,11 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-at = 0 # int | Specify a settlement timestamp (optional) (default to 0)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+at = 0 # int | Specify settlement timestamp (optional) (default to 0)
try:
- # List settlement history
+ # Query settlement records
api_response = api_instance.list_delivery_settlements(settle, contract=contract, limit=limit, at=at)
print(api_response)
except GateApiException as ex:
@@ -1608,8 +1608,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **at** | **int**| Specify a settlement timestamp | [optional] [default to 0]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **at** | **int**| Specify settlement timestamp | [optional] [default to 0]
### Return type
@@ -1627,16 +1627,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_delivery_risk_limit_tiers**
> list[FuturesLimitRiskTiers] list_delivery_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
-List risk limit tiers
+Query risk limit tiers
-When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty.
+When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty.
### Example
@@ -1655,11 +1655,11 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT_20200814' # str | Futures contract (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List risk limit tiers
+ # Query risk limit tiers
api_response = api_instance.list_delivery_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -1674,7 +1674,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -1693,14 +1693,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_price_triggered_delivery_orders**
> list[FuturesPriceTriggeredOrder] list_price_triggered_delivery_orders(settle, status, contract=contract, limit=limit, offset=offset)
-List all auto orders
+Query auto order list
### Example
@@ -1727,13 +1727,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-status = 'status_example' # str | Only list the orders with this status
+status = 'status_example' # str | Query order list based on status
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List all auto orders
+ # Query auto order list
api_response = api_instance.list_price_triggered_delivery_orders(settle, status, contract=contract, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -1747,9 +1747,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **status** | **str**| Only list the orders with this status |
+ **status** | **str**| Query order list based on status |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -1768,14 +1768,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_price_triggered_delivery_order**
> TriggerOrderResponse create_price_triggered_delivery_order(settle, futures_price_triggered_order)
-Create a price-triggered order
+Create price-triggered order
### Example
@@ -1805,7 +1805,7 @@ settle = 'usdt' # str | Settle currency
futures_price_triggered_order = gate_api.FuturesPriceTriggeredOrder() # FuturesPriceTriggeredOrder |
try:
- # Create a price-triggered order
+ # Create price-triggered order
api_response = api_instance.create_price_triggered_delivery_order(settle, futures_price_triggered_order)
print(api_response)
except GateApiException as ex:
@@ -1837,14 +1837,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Order created | - |
+**201** | Order created successfully | - |
[[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)
# **cancel_price_triggered_delivery_order_list**
> list[FuturesPriceTriggeredOrder] cancel_price_triggered_delivery_order_list(settle, contract)
-Cancel all open orders
+Cancel all auto orders
### Example
@@ -1874,7 +1874,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
try:
- # Cancel all open orders
+ # Cancel all auto orders
api_response = api_instance.cancel_price_triggered_delivery_order_list(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -1906,14 +1906,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Batch cancellation request accepted. Query order status by listing orders | - |
+**200** | Batch cancellation request accepted and processed, success determined by order list | - |
[[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)
# **get_price_triggered_delivery_order**
> FuturesPriceTriggeredOrder get_price_triggered_delivery_order(settle, order_id)
-Get a price-triggered order
+Query single auto order details
### Example
@@ -1940,10 +1940,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # Get a price-triggered order
+ # Query single auto order details
api_response = api_instance.get_price_triggered_delivery_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -1957,7 +1957,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -1975,14 +1975,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
# **cancel_price_triggered_delivery_order**
> FuturesPriceTriggeredOrder cancel_price_triggered_delivery_order(settle, order_id)
-cancel a price-triggered order
+Cancel single auto order
### Example
@@ -2009,10 +2009,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.DeliveryApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # cancel a price-triggered order
+ # Cancel single auto order
api_response = api_instance.cancel_price_triggered_delivery_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -2026,7 +2026,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -2044,7 +2044,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
diff --git a/docs/DeliveryContract.md b/docs/DeliveryContract.md
index 069eb7b..9675b71 100644
--- a/docs/DeliveryContract.md
+++ b/docs/DeliveryContract.md
@@ -7,16 +7,16 @@ Name | Type | Description | Notes
**name** | **str** | Futures contract | [optional]
**underlying** | **str** | Underlying | [optional]
**cycle** | **str** | Cycle type, e.g. WEEKLY, QUARTERLY | [optional]
-**type** | **str** | Futures contract type | [optional]
+**type** | **str** | Contract type: inverse - inverse contract, direct - direct contract | [optional]
**quanto_multiplier** | **str** | Multiplier used in converting from invoicing to settlement currency | [optional]
**leverage_min** | **str** | Minimum leverage | [optional]
**leverage_max** | **str** | Maximum leverage | [optional]
**maintenance_rate** | **str** | Maintenance rate of margin | [optional]
-**mark_type** | **str** | Mark price type, internal - based on internal trading, index - based on external index price | [optional]
+**mark_type** | **str** | Mark price type: internal - internal trading price, index - external index price | [optional]
**mark_price** | **str** | Current mark price | [optional]
**index_price** | **str** | Current index price | [optional]
**last_price** | **str** | Last trading price | [optional]
-**maker_fee_rate** | **str** | Maker fee rate, where negative means rebate | [optional]
+**maker_fee_rate** | **str** | Maker fee rate, negative values indicate rebates | [optional]
**taker_fee_rate** | **str** | Taker fee rate | [optional]
**order_price_round** | **str** | Minimum order price increment | [optional]
**mark_price_round** | **str** | Minimum mark price increment | [optional]
@@ -30,18 +30,18 @@ Name | Type | Description | Notes
**risk_limit_base** | **str** | Risk limit base | [optional]
**risk_limit_step** | **str** | Step of adjusting risk limit | [optional]
**risk_limit_max** | **str** | Maximum risk limit the contract allowed | [optional]
-**order_size_min** | **int** | Minimum order size the contract allowed | [optional]
-**order_size_max** | **int** | Maximum order size the contract allowed | [optional]
-**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]
-**ref_discount_rate** | **str** | Referral fee rate discount | [optional]
-**ref_rebate_rate** | **str** | Referrer commission rate | [optional]
-**orderbook_id** | **int** | Current orderbook ID | [optional]
+**order_size_min** | **int** | Minimum order size allowed by the contract | [optional]
+**order_size_max** | **int** | Maximum order size allowed by the contract | [optional]
+**order_price_deviate** | **str** | Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate | [optional]
+**ref_discount_rate** | **str** | Trading fee discount for referred users | [optional]
+**ref_rebate_rate** | **str** | Commission rate for referrers | [optional]
+**orderbook_id** | **int** | Orderbook update ID | [optional]
**trade_id** | **int** | Current trade ID | [optional]
-**trade_size** | **int** | Historical accumulated trade size | [optional]
+**trade_size** | **int** | Historical cumulative trading volume | [optional]
**position_size** | **int** | Current total long position size | [optional]
-**config_change_time** | **float** | Last changed time of configuration | [optional]
+**config_change_time** | **float** | Last configuration update time | [optional]
**in_delisting** | **bool** | Contract is delisting | [optional]
-**orders_limit** | **int** | Maximum number of open orders | [optional]
+**orders_limit** | **int** | Maximum number of pending orders | [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)
diff --git a/docs/DeliveryTicker.md b/docs/DeliveryTicker.md
new file mode 100644
index 0000000..b8de016
--- /dev/null
+++ b/docs/DeliveryTicker.md
@@ -0,0 +1,32 @@
+# DeliveryTicker
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contract** | **str** | Futures contract | [optional]
+**last** | **str** | Last trading price | [optional]
+**change_percentage** | **str** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional]
+**total_size** | **str** | Contract total size | [optional]
+**low_24h** | **str** | 24-hour lowest price | [optional]
+**high_24h** | **str** | 24-hour highest price | [optional]
+**volume_24h** | **str** | 24-hour trading volume | [optional]
+**volume_24h_btc** | **str** | 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
+**volume_24h_usd** | **str** | 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
+**volume_24h_base** | **str** | 24-hour trading volume in base currency | [optional]
+**volume_24h_quote** | **str** | 24-hour trading volume in quote currency | [optional]
+**volume_24h_settle** | **str** | 24-hour trading volume in settle currency | [optional]
+**mark_price** | **str** | Recent mark price | [optional]
+**funding_rate** | **str** | Funding rate | [optional]
+**funding_rate_indicative** | **str** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional]
+**index_price** | **str** | Index price | [optional]
+**quanto_base_rate** | **str** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional]
+**basis_rate** | **str** | Basis rate | [optional]
+**basis_value** | **str** | Basis value | [optional]
+**lowest_ask** | **str** | Recent lowest ask | [optional]
+**lowest_size** | **str** | The latest seller's lowest price order quantity | [optional]
+**highest_bid** | **str** | Recent highest bid | [optional]
+**highest_size** | **str** | The latest buyer's highest price order volume | [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)
+
+
diff --git a/docs/DepositRecord.md b/docs/DepositRecord.md
new file mode 100644
index 0000000..e5fa3b5
--- /dev/null
+++ b/docs/DepositRecord.md
@@ -0,0 +1,19 @@
+# DepositRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Record ID | [optional] [readonly]
+**txid** | **str** | Hash record of the withdrawal | [optional] [readonly]
+**withdraw_order_id** | **str** | Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional]
+**timestamp** | **str** | Operation time | [optional] [readonly]
+**amount** | **str** | Token amount |
+**currency** | **str** | Currency name |
+**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
+**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
+**status** | **str** | Trading Status - REVIEW: Recharge review (compliance review) - PEND: Processing - DONE: Waiting for funds to be unlocked - INVALID: Invalid data - TRACK: Track the number of confirmations, waiting to add funds to the user (spot) - BLOCKED: Rejected Recharge - DEP_CREDITED: Recharge to account, withdrawal is not unlocked | [optional] [readonly]
+**chain** | **str** | Name of the chain used in withdrawals |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/DualGetOrders.md b/docs/DualGetOrders.md
index 8f8d577..91f79de 100644
--- a/docs/DualGetOrders.md
+++ b/docs/DualGetOrders.md
@@ -4,21 +4,22 @@
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]
+**plan_id** | **int** | Product ID | [optional]
+**copies** | **str** | Units | [optional]
+**invest_amount** | **str** | Investment Quantity | [optional]
+**settlement_amount** | **str** | Settlement Quantity | [optional]
+**create_time** | **int** | Created time | [optional]
+**complete_time** | **int** | Completed Time | [optional]
+**status** | **str** | Status: `INIT`-Created `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-Settlement Processing `CANCELED`-Canceled `FAILED`-Failed | [optional]
+**invest_currency** | **str** | Investment Token | [optional]
+**exercise_currency** | **str** | Strike Token | [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]
+**settlement_price** | **str** | Settlement price | [optional]
+**settlement_currency** | **str** | Settlement currency | [optional]
+**apy_display** | **str** | Annual Yield | [optional]
+**apy_settlement** | **str** | Settlement Annual Yield | [optional]
**delivery_time** | **int** | Settlement time | [optional]
+**text** | **str** | Custom order information | [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)
diff --git a/docs/DualGetPlans.md b/docs/DualGetPlans.md
index 4bd3850..53b3a58 100644
--- a/docs/DualGetPlans.md
+++ b/docs/DualGetPlans.md
@@ -3,19 +3,19 @@
## 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]
+**id** | **int** | Product ID | [optional]
+**instrument_name** | **str** | Product Name | [optional]
+**invest_currency** | **str** | Investment Token | [optional]
+**exercise_currency** | **str** | Strike Token | [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]
+**min_copies** | **int** | Minimum Units | [optional]
+**max_copies** | **int** | Maximum Units | [optional]
+**per_value** | **str** | Value Per Unit | [optional]
+**apy_display** | **str** | Annual Yield | [optional]
+**start_time** | **int** | Start Time | [optional]
+**end_time** | **int** | End time | [optional]
+**status** | **str** | Status: `NOTSTARTED`-Not Started `ONGOING`-In Progress `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)
diff --git a/docs/EarnApi.md b/docs/EarnApi.md
index 3fc974f..a2b83b8 100644
--- a/docs/EarnApi.md
+++ b/docs/EarnApi.md
@@ -5,12 +5,15 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**swap_eth2**](EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap
+[**rate_list_eth2**](EarnApi.md#rate_list_eth2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical return rate query
[**list_dual_investment_plans**](EarnApi.md#list_dual_investment_plans) | **GET** /earn/dual/investment_plan | Dual Investment product list
[**list_dual_orders**](EarnApi.md#list_dual_orders) | **GET** /earn/dual/orders | Dual Investment order list
[**place_dual_order**](EarnApi.md#place_dual_order) | **POST** /earn/dual/orders | Place Dual Investment order
[**list_structured_products**](EarnApi.md#list_structured_products) | **GET** /earn/structured/products | Structured Product List
[**list_structured_orders**](EarnApi.md#list_structured_orders) | **GET** /earn/structured/orders | Structured Product Order List
[**place_structured_order**](EarnApi.md#place_structured_order) | **POST** /earn/structured/orders | Place Structured Product Order
+[**find_coin**](EarnApi.md#find_coin) | **GET** /earn/staking/coins | Staking coins
+[**swap_staking_coin**](EarnApi.md#swap_staking_coin) | **POST** /earn/staking/swap | On-chain token swap for earned coins
# **swap_eth2**
@@ -75,12 +78,77 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | swap success | - |
+**200** | Swap successful | - |
+
+[[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)
+
+# **rate_list_eth2**
+> list[Eth2RateList] rate_list_eth2()
+
+ETH2 historical return rate query
+
+Query ETH earnings rate records for the last 31 days
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.EarnApi(api_client)
+
+try:
+ # ETH2 historical return rate query
+ api_response = api_instance.rate_list_eth2()
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling EarnApi->rate_list_eth2: %s\n" % e)
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**list[Eth2RateList]**](Eth2RateList.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successfully retrieved | - |
[[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)
# **list_dual_investment_plans**
-> list[DualGetPlans] list_dual_investment_plans()
+> list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id)
Dual Investment product list
@@ -99,10 +167,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnApi(api_client)
+plan_id = 1 # int | Financial project ID (optional)
try:
# Dual Investment product list
- api_response = api_instance.list_dual_investment_plans()
+ api_response = api_instance.list_dual_investment_plans(plan_id=plan_id)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -111,7 +180,10 @@ except ApiException as e:
```
### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **plan_id** | **int**| Financial project ID | [optional]
### Return type
@@ -129,12 +201,12 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
# **list_dual_orders**
-> list[DualGetOrders] list_dual_orders()
+> list[DualGetOrders] list_dual_orders(_from=_from, to=to, page=page, limit=limit)
Dual Investment order list
@@ -162,10 +234,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnApi(api_client)
+_from = 1740727000 # int | Start settlement time (optional)
+to = 1740729000 # int | End settlement time (optional)
+page = 1 # int | Page number (optional) (default to 1)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
# Dual Investment order list
- api_response = api_instance.list_dual_orders()
+ api_response = api_instance.list_dual_orders(_from=_from, to=to, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -174,7 +250,13 @@ except ApiException as e:
```
### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **_from** | **int**| Start settlement time | [optional]
+ **to** | **int**| End settlement time | [optional]
+ **page** | **int**| Page number | [optional] [default to 1]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -192,7 +274,7 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
@@ -258,7 +340,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order placed successfully | - |
[[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)
@@ -282,10 +364,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnApi(api_client)
-status = 'in_process' # str | Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish
-type = 'BullishSharkFin' # str | Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall (optional)
+status = 'in_process' # str | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed
+type = 'BullishSharkFin' # str | Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
# Structured Product List
@@ -301,10 +383,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **status** | **str**| Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish |
- **type** | **str**| Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall | [optional]
+ **status** | **str**| Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed |
+ **type** | **str**| Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -322,7 +404,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
@@ -355,10 +437,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnApi(api_client)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
# Structured Product Order List
@@ -374,10 +456,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -395,7 +477,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
@@ -461,7 +543,141 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order placed successfully | - |
+
+[[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)
+
+# **find_coin**
+> object find_coin(find_coin)
+
+Staking coins
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.EarnApi(api_client)
+find_coin = gate_api.FindCoin() # FindCoin |
+
+try:
+ # Staking coins
+ api_response = api_instance.find_coin(find_coin)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling EarnApi->find_coin: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **find_coin** | [**FindCoin**](FindCoin.md)| |
+
+### Return type
+
+**object**
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successfully retrieved | - |
+
+[[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)
+
+# **swap_staking_coin**
+> SwapCoinStruct swap_staking_coin(swap_coin)
+
+On-chain token swap for earned coins
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.EarnApi(api_client)
+swap_coin = gate_api.SwapCoin() # SwapCoin |
+
+try:
+ # On-chain token swap for earned coins
+ api_response = api_instance.swap_staking_coin(swap_coin)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling EarnApi->swap_staking_coin: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **swap_coin** | [**SwapCoin**](SwapCoin.md)| |
+
+### Return type
+
+[**SwapCoinStruct**](SwapCoinStruct.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Swap successful | - |
[[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)
diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md
index 7c8f77d..5128e5d 100644
--- a/docs/EarnUniApi.md
+++ b/docs/EarnUniApi.md
@@ -4,22 +4,23 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_uni_currencies**](EarnUniApi.md#list_uni_currencies) | **GET** /earn/uni/currencies | List currencies for lending
-[**get_uni_currency**](EarnUniApi.md#get_uni_currency) | **GET** /earn/uni/currencies/{currency} | Get currency detail for lending
-[**list_user_uni_lends**](EarnUniApi.md#list_user_uni_lends) | **GET** /earn/uni/lends | List user's lending orders
-[**create_uni_lend**](EarnUniApi.md#create_uni_lend) | **POST** /earn/uni/lends | Lend or redeem
-[**change_uni_lend**](EarnUniApi.md#change_uni_lend) | **PATCH** /earn/uni/lends | Amend lending order
-[**list_uni_lend_records**](EarnUniApi.md#list_uni_lend_records) | **GET** /earn/uni/lend_records | List records of lending
-[**get_uni_interest**](EarnUniApi.md#get_uni_interest) | **GET** /earn/uni/interests/{currency} | Get the user's total interest income of specified currency
-[**list_uni_interest_records**](EarnUniApi.md#list_uni_interest_records) | **GET** /earn/uni/interest_records | List interest records
-[**switch_interest_reinvest**](EarnUniApi.md#switch_interest_reinvest) | **PUT** /earn/uni/interest_reinvest | Set interest reinvestment toggle
-[**get_uni_interest_status**](EarnUniApi.md#get_uni_interest_status) | **GET** /earn/uni/interest_status/{currency} | query currency interest compounding status
+[**list_uni_currencies**](EarnUniApi.md#list_uni_currencies) | **GET** /earn/uni/currencies | Query lending currency list
+[**get_uni_currency**](EarnUniApi.md#get_uni_currency) | **GET** /earn/uni/currencies/{currency} | Query single lending currency details
+[**list_user_uni_lends**](EarnUniApi.md#list_user_uni_lends) | **GET** /earn/uni/lends | Query user's lending order list
+[**create_uni_lend**](EarnUniApi.md#create_uni_lend) | **POST** /earn/uni/lends | Create lending or redemption
+[**change_uni_lend**](EarnUniApi.md#change_uni_lend) | **PATCH** /earn/uni/lends | Amend user lending information
+[**list_uni_lend_records**](EarnUniApi.md#list_uni_lend_records) | **GET** /earn/uni/lend_records | Query lending transaction records
+[**get_uni_interest**](EarnUniApi.md#get_uni_interest) | **GET** /earn/uni/interests/{currency} | Query user's total interest income for specified currency
+[**list_uni_interest_records**](EarnUniApi.md#list_uni_interest_records) | **GET** /earn/uni/interest_records | Query user dividend records
+[**get_uni_interest_status**](EarnUniApi.md#get_uni_interest_status) | **GET** /earn/uni/interest_status/{currency} | Query currency interest compounding status
+[**list_uni_chart**](EarnUniApi.md#list_uni_chart) | **GET** /earn/uni/chart | UniLoan currency annualized trend chart
+[**list_uni_rate**](EarnUniApi.md#list_uni_rate) | **GET** /earn/uni/rate | Currency estimated annualized interest rate
# **list_uni_currencies**
> list[UniCurrency] list_uni_currencies()
-List currencies for lending
+Query lending currency list
### Example
@@ -38,7 +39,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.EarnUniApi(api_client)
try:
- # List currencies for lending
+ # Query lending currency list
api_response = api_instance.list_uni_currencies()
print(api_response)
except GateApiException as ex:
@@ -66,14 +67,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_uni_currency**
> UniCurrency get_uni_currency(currency)
-Get currency detail for lending
+Query single lending currency details
### Example
@@ -93,7 +94,7 @@ api_instance = gate_api.EarnUniApi(api_client)
currency = 'btc' # str | Currency
try:
- # Get currency detail for lending
+ # Query single lending currency details
api_response = api_instance.get_uni_currency(currency)
print(api_response)
except GateApiException as ex:
@@ -124,14 +125,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_user_uni_lends**
> list[UniLend] list_user_uni_lends(currency=currency, page=page, limit=limit)
-List user's lending orders
+Query user's lending order list
### Example
@@ -157,12 +158,12 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnUniApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
try:
- # List user's lending orders
+ # Query user's lending order list
api_response = api_instance.list_user_uni_lends(currency=currency, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -175,9 +176,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
### Return type
@@ -195,16 +196,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **create_uni_lend**
> create_uni_lend(create_uni_lend)
-Lend or redeem
+Create lending or redemption
-`Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited.
+Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited.
### Example
@@ -233,7 +234,7 @@ api_instance = gate_api.EarnUniApi(api_client)
create_uni_lend = gate_api.CreateUniLend() # CreateUniLend |
try:
- # Lend or redeem
+ # Create lending or redemption
api_instance.create_uni_lend(create_uni_lend)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -263,16 +264,16 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Operated successfully | - |
+**204** | Operation successful | - |
[[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)
# **change_uni_lend**
> change_uni_lend(patch_uni_lend)
-Amend lending order
+Amend user lending information
-Currently only supports amending the minimum interest rate (hour)
+Currently only supports amending minimum interest rate (hourly)
### Example
@@ -301,7 +302,7 @@ api_instance = gate_api.EarnUniApi(api_client)
patch_uni_lend = gate_api.PatchUniLend() # PatchUniLend |
try:
- # Amend lending order
+ # Amend user lending information
api_instance.change_uni_lend(patch_uni_lend)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -331,14 +332,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Updated | - |
+**204** | Updated successfully | - |
[[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)
# **list_uni_lend_records**
> list[UniLendRecord] list_uni_lend_records(currency=currency, page=page, limit=limit, _from=_from, to=to, type=type)
-List records of lending
+Query lending transaction records
### Example
@@ -364,15 +365,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnUniApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-type = 'lend' # str | type: lend - lend, redeem - redeem (optional)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+type = 'lend' # str | Operation type: lend - Lend, redeem - Redeem (optional)
try:
- # List records of lending
+ # Query lending transaction records
api_response = api_instance.list_uni_lend_records(currency=currency, page=page, limit=limit, _from=_from, to=to, type=type)
print(api_response)
except GateApiException as ex:
@@ -385,12 +386,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **type** | **str**| type: lend - lend, redeem - redeem | [optional]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **type** | **str**| Operation type: lend - Lend, redeem - Redeem | [optional]
### Return type
@@ -408,14 +409,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_uni_interest**
> UniLendInterest get_uni_interest(currency)
-Get the user's total interest income of specified currency
+Query user's total interest income for specified currency
### Example
@@ -444,7 +445,7 @@ api_instance = gate_api.EarnUniApi(api_client)
currency = 'btc' # str | Currency
try:
- # Get the user's total interest income of specified currency
+ # Query user's total interest income for specified currency
api_response = api_instance.get_uni_interest(currency)
print(api_response)
except GateApiException as ex:
@@ -475,14 +476,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_uni_interest_records**
> list[UniInterestRecord] list_uni_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to)
-List interest records
+Query user dividend records
### Example
@@ -508,14 +509,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnUniApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # List interest records
+ # Query user dividend records
api_response = api_instance.list_uni_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -528,11 +529,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -550,14 +551,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **switch_interest_reinvest**
-> switch_interest_reinvest(uni_interest_mode)
+# **get_uni_interest_status**
+> UniCurrencyInterest get_uni_interest_status(currency)
-Set interest reinvestment toggle
+Query currency interest compounding status
### Example
@@ -583,26 +584,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnUniApi(api_client)
-uni_interest_mode = gate_api.UniInterestMode() # UniInterestMode |
+currency = 'btc' # str | Currency
try:
- # Set interest reinvestment toggle
- api_instance.switch_interest_reinvest(uni_interest_mode)
+ # Query currency interest compounding status
+ api_response = api_instance.get_uni_interest_status(currency)
+ print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling EarnUniApi->switch_interest_reinvest: %s\n" % e)
+ print("Exception when calling EarnUniApi->get_uni_interest_status: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **uni_interest_mode** | [**UniInterestMode**](UniInterestMode.md)| |
+ **currency** | **str**| Currency |
### Return type
-void (empty response body)
+[**UniCurrencyInterest**](UniCurrencyInterest.md)
### Authorization
@@ -610,20 +612,22 @@ void (empty response body)
### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: Not defined
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Success | - |
+**200** | Query successful | - |
[[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)
-# **get_uni_interest_status**
-> UniCurrencyInterest get_uni_interest_status(currency)
+# **list_uni_chart**
+> list[InlineResponse200] list_uni_chart(_from, to, asset)
-query currency interest compounding status
+UniLoan currency annualized trend chart
+
+Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0
### Example
@@ -649,27 +653,96 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.EarnUniApi(api_client)
-currency = 'btc' # str | Currency
+_from = 1719763200 # int | Start timestamp in seconds, maximum span 30 days
+to = 1722441600 # int | End timestamp in seconds, maximum span 30 days
+asset = 'BTC' # str | Currency name
try:
- # query currency interest compounding status
- api_response = api_instance.get_uni_interest_status(currency)
+ # UniLoan currency annualized trend chart
+ api_response = api_instance.list_uni_chart(_from, to, asset)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling EarnUniApi->get_uni_interest_status: %s\n" % e)
+ print("Exception when calling EarnUniApi->list_uni_chart: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Currency |
+ **_from** | **int**| Start timestamp in seconds, maximum span 30 days |
+ **to** | **int**| End timestamp in seconds, maximum span 30 days |
+ **asset** | **str**| Currency name |
### Return type
-[**UniCurrencyInterest**](UniCurrencyInterest.md)
+[**list[InlineResponse200]**](InlineResponse200.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - |
+
+[[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)
+
+# **list_uni_rate**
+> list[InlineResponse2001] list_uni_rate()
+
+Currency estimated annualized interest rate
+
+Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.EarnUniApi(api_client)
+
+try:
+ # Currency estimated annualized interest rate
+ api_response = api_instance.list_uni_rate()
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling EarnUniApi->list_uni_rate: %s\n" % e)
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**list[InlineResponse2001]**](InlineResponse2001.md)
### Authorization
@@ -683,7 +756,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - |
[[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)
diff --git a/docs/Eth2RateList.md b/docs/Eth2RateList.md
new file mode 100644
index 0000000..574d27a
--- /dev/null
+++ b/docs/Eth2RateList.md
@@ -0,0 +1,12 @@
+# Eth2RateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_time** | **int** | Date Timestamp | [optional]
+**date** | **str** | Date | [optional]
+**rate** | **str** | Percentage Rate | [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)
+
+
diff --git a/docs/Eth2Swap.md b/docs/Eth2Swap.md
index a5ede25..31c2116 100644
--- a/docs/Eth2Swap.md
+++ b/docs/Eth2Swap.md
@@ -1,11 +1,11 @@
# Eth2Swap
-ETH2 Staking
+ETH2 Mining
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**side** | **str** | 1-Forward Swap（ETH -> ETH2）, 2-Reverse Swap（ETH2 -> ETH） |
-**amount** | **str** | amount |
+**side** | **str** | 1-Forward Swap (ETH -> ETH2), 2-Reverse Swap (ETH2 -> ETH) |
+**amount** | **str** | Swap Amount |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/UnifiedMode.md b/docs/FindCoin.md
similarity index 63%
rename from docs/UnifiedMode.md
rename to docs/FindCoin.md
index c99223e..784880a 100644
--- a/docs/UnifiedMode.md
+++ b/docs/FindCoin.md
@@ -1,10 +1,9 @@
-# UnifiedMode
+# FindCoin
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**mode** | **str** | Portfolio mode - cross_margin : cross margin - usdt_futures : usdt futures |
-**enabled** | **bool** | Is it enabled? |
+**cointype** | **str** | Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. | [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)
diff --git a/docs/FlashSwapApi.md b/docs/FlashSwapApi.md
index df1d134..39fd84a 100644
--- a/docs/FlashSwapApi.md
+++ b/docs/FlashSwapApi.md
@@ -4,68 +4,13 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_flash_swap_currencies**](FlashSwapApi.md#list_flash_swap_currencies) | **GET** /flash_swap/currencies | List All Supported Currencies In Flash Swap (deprecated)
[**list_flash_swap_currency_pair**](FlashSwapApi.md#list_flash_swap_currency_pair) | **GET** /flash_swap/currency_pairs | List All Supported Currency Pairs In Flash Swap
-[**list_flash_swap_orders**](FlashSwapApi.md#list_flash_swap_orders) | **GET** /flash_swap/orders | List all flash swap orders
+[**list_flash_swap_orders**](FlashSwapApi.md#list_flash_swap_orders) | **GET** /flash_swap/orders | Query flash swap order list
[**create_flash_swap_order**](FlashSwapApi.md#create_flash_swap_order) | **POST** /flash_swap/orders | Create a flash swap order
-[**get_flash_swap_order**](FlashSwapApi.md#get_flash_swap_order) | **GET** /flash_swap/orders/{order_id} | Get a single flash swap order's detail
-[**preview_flash_swap_order**](FlashSwapApi.md#preview_flash_swap_order) | **POST** /flash_swap/orders/preview | Initiate a flash swap order preview
+[**get_flash_swap_order**](FlashSwapApi.md#get_flash_swap_order) | **GET** /flash_swap/orders/{order_id} | Query single flash swap order
+[**preview_flash_swap_order**](FlashSwapApi.md#preview_flash_swap_order) | **POST** /flash_swap/orders/preview | Flash swap order preview
-# **list_flash_swap_currencies**
-> list[FlashSwapCurrency] list_flash_swap_currencies()
-
-List All Supported Currencies In Flash Swap (deprecated)
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.FlashSwapApi(api_client)
-
-try:
- # List All Supported Currencies In Flash Swap (deprecated)
- api_response = api_instance.list_flash_swap_currencies()
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling FlashSwapApi->list_flash_swap_currencies: %s\n" % e)
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**list[FlashSwapCurrency]**](FlashSwapCurrency.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
# **list_flash_swap_currency_pair**
> list[FlashSwapCurrencyPair] list_flash_swap_currency_pair(currency=currency, page=page, limit=limit)
@@ -88,9 +33,9 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FlashSwapApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 1000 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 1000 (optional) (default to 1000)
+limit = 1000 # int | Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 (optional) (default to 1000)
try:
# List All Supported Currency Pairs In Flash Swap
@@ -106,9 +51,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 1000 | [optional] [default to 1000]
+ **limit** | **int**| Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 | [optional] [default to 1000]
### Return type
@@ -126,14 +71,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_flash_swap_orders**
> list[FlashSwapOrder] list_flash_swap_orders(status=status, sell_currency=sell_currency, buy_currency=buy_currency, reverse=reverse, limit=limit, page=page)
-List all flash swap orders
+Query flash swap order list
### Example
@@ -159,15 +104,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FlashSwapApi(api_client)
-status = 1 # int | Flash swap order status `1` - success `2` - failure (optional)
-sell_currency = 'BTC' # str | Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` (optional)
-buy_currency = 'BTC' # str | Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` (optional)
-reverse = true # bool | If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first) (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+status = 1 # int | Flash swap order status `1` - success `2` - failed (optional)
+sell_currency = 'BTC' # str | Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies (optional)
+buy_currency = 'BTC' # str | Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies (optional)
+reverse = true # bool | Sort by ID in ascending or descending order, default `true` - `true`: ID descending order (most recent data first) - `false`: ID ascending order (oldest data first) (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
page = 1 # int | Page number (optional) (default to 1)
try:
- # List all flash swap orders
+ # Query flash swap order list
api_response = api_instance.list_flash_swap_orders(status=status, sell_currency=sell_currency, buy_currency=buy_currency, reverse=reverse, limit=limit, page=page)
print(api_response)
except GateApiException as ex:
@@ -180,11 +125,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **status** | **int**| Flash swap order status `1` - success `2` - failure | [optional]
- **sell_currency** | **str**| Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional]
- **buy_currency** | **str**| Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional]
- **reverse** | **bool**| If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first) | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **status** | **int**| Flash swap order status `1` - success `2` - failed | [optional]
+ **sell_currency** | **str**| Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies | [optional]
+ **buy_currency** | **str**| Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies | [optional]
+ **reverse** | **bool**| Sort by ID in ascending or descending order, default `true` - `true`: ID descending order (most recent data first) - `false`: ID ascending order (oldest data first) | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**page** | **int**| Page number | [optional] [default to 1]
### Return type
@@ -203,7 +148,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -272,14 +217,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | The flash swap order is created successfully | - |
+**201** | Flash swap order created successfully | - |
[[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)
# **get_flash_swap_order**
> FlashSwapOrder get_flash_swap_order(order_id)
-Get a single flash swap order's detail
+Query single flash swap order
### Example
@@ -308,7 +253,7 @@ api_instance = gate_api.FlashSwapApi(api_client)
order_id = 1 # int | Flash swap order ID
try:
- # Get a single flash swap order's detail
+ # Query single flash swap order
api_response = api_instance.get_flash_swap_order(order_id)
print(api_response)
except GateApiException as ex:
@@ -339,14 +284,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **preview_flash_swap_order**
> FlashSwapOrderPreview preview_flash_swap_order(flash_swap_preview_request)
-Initiate a flash swap order preview
+Flash swap order preview
### Example
@@ -375,7 +320,7 @@ api_instance = gate_api.FlashSwapApi(api_client)
flash_swap_preview_request = gate_api.FlashSwapPreviewRequest() # FlashSwapPreviewRequest |
try:
- # Initiate a flash swap order preview
+ # Flash swap order preview
api_response = api_instance.preview_flash_swap_order(flash_swap_preview_request)
print(api_response)
except GateApiException as ex:
@@ -406,7 +351,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | The flash swap order successfully previewed | - |
+**200** | Flash swap order preview successful | - |
[[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)
diff --git a/docs/FlashSwapCurrency.md b/docs/FlashSwapCurrency.md
deleted file mode 100644
index 29fc81c..0000000
--- a/docs/FlashSwapCurrency.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# FlashSwapCurrency
-
-Currencies supported in flash swap
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency** | **str** | Currency name | [optional] [readonly]
-**min_amount** | **str** | Minimum amount required in flash swap | [optional] [readonly]
-**max_amount** | **str** | Maximum amount allowed in flash swap | [optional] [readonly]
-**swappable** | **list[str]** | Currencies which can be swapped to from this currency | [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)
-
-
diff --git a/docs/FlashSwapCurrencyPair.md b/docs/FlashSwapCurrencyPair.md
index 586c0a3..28eacbc 100644
--- a/docs/FlashSwapCurrencyPair.md
+++ b/docs/FlashSwapCurrencyPair.md
@@ -4,13 +4,13 @@ List all supported currencies in flash swap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency_pair** | **str** | The currency pair, BTC_USDT represents selling Bitcoin (BTC) and buying Tether (USDT). | [optional] [readonly]
-**sell_currency** | **str** | The currency to be sold | [optional] [readonly]
-**buy_currency** | **str** | The currency to be bought | [optional] [readonly]
-**sell_min_amount** | **str** | The minimum quantity required for selling | [optional] [readonly]
-**sell_max_amount** | **str** | The maximum quantity allowed for selling | [optional] [readonly]
-**buy_min_amount** | **str** | The minimum quantity required for buying | [optional] [readonly]
-**buy_max_amount** | **str** | The maximum quantity allowed for buying | [optional] [readonly]
+**currency_pair** | **str** | Currency pair, `BTC_USDT` represents selling `BTC` and buying `USDT` | [optional] [readonly]
+**sell_currency** | **str** | Currency to sell | [optional] [readonly]
+**buy_currency** | **str** | Currency to buy | [optional] [readonly]
+**sell_min_amount** | **str** | Minimum sell quantity | [optional] [readonly]
+**sell_max_amount** | **str** | Maximum sell quantity | [optional] [readonly]
+**buy_min_amount** | **str** | Minimum buy quantity | [optional] [readonly]
+**buy_max_amount** | **str** | Maximum buy quantity | [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)
diff --git a/docs/FlashSwapOrderPreview.md b/docs/FlashSwapOrderPreview.md
index 578ba75..4ee4133 100644
--- a/docs/FlashSwapOrderPreview.md
+++ b/docs/FlashSwapOrderPreview.md
@@ -1,13 +1,13 @@
# FlashSwapOrderPreview
-Initiate a flash swap order preview
+Flash swap order preview
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**preview_id** | **str** | Preview result ID | [optional]
-**sell_currency** | **str** | Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional]
+**sell_currency** | **str** | Name of the sold asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain | [optional]
**sell_amount** | **str** | Amount to sell | [optional]
-**buy_currency** | **str** | Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional]
+**buy_currency** | **str** | Name of the purchased asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain | [optional]
**buy_amount** | **str** | Amount to buy | [optional]
**price** | **str** | Price | [optional]
diff --git a/docs/FlashSwapOrderRequest.md b/docs/FlashSwapOrderRequest.md
index a3e6f8f..aea0466 100644
--- a/docs/FlashSwapOrderRequest.md
+++ b/docs/FlashSwapOrderRequest.md
@@ -5,9 +5,9 @@ Parameters of flash swap order creation
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**preview_id** | **str** | Preview result ID |
-**sell_currency** | **str** | The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. |
+**sell_currency** | **str** | Name of the asset to be sold, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap |
**sell_amount** | **str** | Amount to sell (based on the preview result) |
-**buy_currency** | **str** | The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. |
+**buy_currency** | **str** | Name of the asset to be bought, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap |
**buy_amount** | **str** | Amount to buy (based on the preview result) |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/FlashSwapPreviewRequest.md b/docs/FlashSwapPreviewRequest.md
index ea14e67..3a45a36 100644
--- a/docs/FlashSwapPreviewRequest.md
+++ b/docs/FlashSwapPreviewRequest.md
@@ -4,9 +4,9 @@ Parameters of flash swap order creation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**sell_currency** | **str** | The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. |
+**sell_currency** | **str** | The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs |
**sell_amount** | **str** | Amount to sell. It is required to choose one parameter between `sell_amount` and `buy_amount` | [optional]
-**buy_currency** | **str** | The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. |
+**buy_currency** | **str** | The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs |
**buy_amount** | **str** | Amount to buy. It is required to choose one parameter between `sell_amount` and `buy_amount` | [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)
diff --git a/docs/FutureCancelOrderResult.md b/docs/FutureCancelOrderResult.md
index a27e9e6..865d529 100644
--- a/docs/FutureCancelOrderResult.md
+++ b/docs/FutureCancelOrderResult.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **str** | Order ID | [optional]
**user_id** | **int** | User ID | [optional]
**succeeded** | **bool** | Whether cancellation succeeded | [optional]
-**message** | **str** | Error message when failed to cancel the order; empty if succeeded | [optional]
+**message** | **str** | Error description when cancellation fails, empty if successful | [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)
diff --git a/docs/FuturesAccount.md b/docs/FuturesAccount.md
index af78126..590e0c8 100644
--- a/docs/FuturesAccount.md
+++ b/docs/FuturesAccount.md
@@ -7,23 +7,28 @@ Name | Type | Description | Notes
**unrealised_pnl** | **str** | Unrealized PNL | [optional]
**position_margin** | **str** | Position margin | [optional]
**order_margin** | **str** | Order margin of unfinished orders | [optional]
-**available** | **str** | The available balance for transferring or trading(including bonus. Bonus can't be be withdrawn. The transfer amount needs to deduct the bonus) | [optional]
-**point** | **str** | POINT amount | [optional]
-**currency** | **str** | Settle currency | [optional]
+**available** | **str** | Available balance for transferring or trading (including bonus. Bonus cannot be withdrawn, so transfer amount needs to deduct bonus) | [optional]
+**point** | **str** | Point card amount | [optional]
+**currency** | **str** | Settlement currency | [optional]
**in_dual_mode** | **bool** | Whether dual mode is enabled | [optional]
+**position_mode** | **str** | Position mode: single - one-way, dual - dual-side, split - sub-positions (in_dual_mode is deprecated) | [optional]
**enable_credit** | **bool** | Whether portfolio margin account mode is enabled | [optional]
-**position_initial_margin** | **str** | Initial margin position, applicable to the portfolio margin account model | [optional]
-**maintenance_margin** | **str** | The maintenance deposit occupied by the position is suitable for the new classic account margin model and unified account model | [optional]
-**bonus** | **str** | Perpetual Contract Bonus | [optional]
+**position_initial_margin** | **str** | Initial margin occupied by positions, applicable to unified account mode | [optional]
+**maintenance_margin** | **str** | Maintenance margin occupied by positions, applicable to new classic account margin mode and unified account mode | [optional]
+**bonus** | **str** | Bonus | [optional]
**enable_evolved_classic** | **bool** | Classic account margin mode, true-new mode, false-old mode | [optional]
-**cross_order_margin** | **str** | Full -warehouse hanging order deposit, suitable for the new classic account margin model | [optional]
-**cross_initial_margin** | **str** | The initial security deposit of the full warehouse is suitable for the new classic account margin model | [optional]
-**cross_maintenance_margin** | **str** | Maintain deposit in full warehouse, suitable for new classic account margin models | [optional]
-**cross_unrealised_pnl** | **str** | The full warehouse does not achieve profit and loss, suitable for the new classic account margin model | [optional]
-**cross_available** | **str** | Full warehouse available amount, suitable for the new classic account margin model | [optional]
-**isolated_position_margin** | **str** | Ware -position margin, suitable for the new classic account margin model | [optional]
+**cross_order_margin** | **str** | Cross margin order margin, applicable to new classic account margin mode | [optional]
+**cross_initial_margin** | **str** | Cross margin initial margin, applicable to new classic account margin mode | [optional]
+**cross_maintenance_margin** | **str** | Cross margin maintenance margin, applicable to new classic account margin mode | [optional]
+**cross_unrealised_pnl** | **str** | Cross margin unrealized P&L, applicable to new classic account margin mode | [optional]
+**cross_available** | **str** | Cross margin available balance, applicable to new classic account margin mode | [optional]
+**cross_margin_balance** | **str** | Cross margin balance, applicable to new classic account margin mode | [optional]
+**cross_mmr** | **str** | Cross margin maintenance margin rate, applicable to new classic account margin mode | [optional]
+**cross_imr** | **str** | Cross margin initial margin rate, applicable to new classic account margin mode | [optional]
+**isolated_position_margin** | **str** | Isolated position margin, applicable to new classic account margin mode | [optional]
**enable_new_dual_mode** | **bool** | Whether to open a new two-way position mode | [optional]
**margin_mode** | **int** | Margin mode, 0-classic margin mode, 1-cross-currency margin mode, 2-combined margin mode | [optional]
+**enable_tiered_mm** | **bool** | Whether to enable tiered maintenance margin calculation | [optional]
**history** | [**FuturesAccountHistory**](FuturesAccountHistory.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)
diff --git a/docs/FuturesAccountBook.md b/docs/FuturesAccountBook.md
index eebf328..0056f17 100644
--- a/docs/FuturesAccountBook.md
+++ b/docs/FuturesAccountBook.md
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
**time** | **float** | Change time | [optional]
**change** | **str** | Change amount | [optional]
**balance** | **str** | Balance after change | [optional]
-**type** | **str** | Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional]
+**type** | **str** | Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction | [optional]
**text** | **str** | Comment | [optional]
-**contract** | **str** | Futures contract, the field is only available for data after 2023-10-30. | [optional]
+**contract** | **str** | Futures contract, the field is only available for data after 2023-10-30 | [optional]
**trade_id** | **str** | trade id | [optional]
-**id** | **str** | 账户变更记录 id | [optional]
+**id** | **str** | Account change record ID | [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)
diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md
index 855e500..75ce6fe 100644
--- a/docs/FuturesApi.md
+++ b/docs/FuturesApi.md
@@ -4,59 +4,62 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_futures_contracts**](FuturesApi.md#list_futures_contracts) | **GET** /futures/{settle}/contracts | List all futures contracts
-[**get_futures_contract**](FuturesApi.md#get_futures_contract) | **GET** /futures/{settle}/contracts/{contract} | Get a single contract
-[**list_futures_order_book**](FuturesApi.md#list_futures_order_book) | **GET** /futures/{settle}/order_book | Futures order book
-[**list_futures_trades**](FuturesApi.md#list_futures_trades) | **GET** /futures/{settle}/trades | Futures trading history
-[**list_futures_candlesticks**](FuturesApi.md#list_futures_candlesticks) | **GET** /futures/{settle}/candlesticks | Get futures candlesticks
-[**list_futures_premium_index**](FuturesApi.md#list_futures_premium_index) | **GET** /futures/{settle}/premium_index | Premium Index K-Line
-[**list_futures_tickers**](FuturesApi.md#list_futures_tickers) | **GET** /futures/{settle}/tickers | List futures tickers
-[**list_futures_funding_rate_history**](FuturesApi.md#list_futures_funding_rate_history) | **GET** /futures/{settle}/funding_rate | Funding rate history
-[**list_futures_insurance_ledger**](FuturesApi.md#list_futures_insurance_ledger) | **GET** /futures/{settle}/insurance | Futures insurance balance history
-[**list_contract_stats**](FuturesApi.md#list_contract_stats) | **GET** /futures/{settle}/contract_stats | Futures stats
-[**get_index_constituents**](FuturesApi.md#get_index_constituents) | **GET** /futures/{settle}/index_constituents/{index} | Get index constituents
-[**list_liquidated_orders**](FuturesApi.md#list_liquidated_orders) | **GET** /futures/{settle}/liq_orders | Retrieve liquidation history
-[**list_futures_risk_limit_tiers**](FuturesApi.md#list_futures_risk_limit_tiers) | **GET** /futures/{settle}/risk_limit_tiers | List risk limit tiers
-[**list_futures_accounts**](FuturesApi.md#list_futures_accounts) | **GET** /futures/{settle}/accounts | Query futures account
-[**list_futures_account_book**](FuturesApi.md#list_futures_account_book) | **GET** /futures/{settle}/account_book | Query account book
-[**list_positions**](FuturesApi.md#list_positions) | **GET** /futures/{settle}/positions | List all positions of a user
-[**get_position**](FuturesApi.md#get_position) | **GET** /futures/{settle}/positions/{contract} | Get single position
+[**list_futures_contracts**](FuturesApi.md#list_futures_contracts) | **GET** /futures/{settle}/contracts | Query all futures contracts
+[**get_futures_contract**](FuturesApi.md#get_futures_contract) | **GET** /futures/{settle}/contracts/{contract} | Query single contract information
+[**list_futures_order_book**](FuturesApi.md#list_futures_order_book) | **GET** /futures/{settle}/order_book | Query futures market depth information
+[**list_futures_trades**](FuturesApi.md#list_futures_trades) | **GET** /futures/{settle}/trades | Futures market transaction records
+[**list_futures_candlesticks**](FuturesApi.md#list_futures_candlesticks) | **GET** /futures/{settle}/candlesticks | Futures market K-line chart
+[**list_futures_premium_index**](FuturesApi.md#list_futures_premium_index) | **GET** /futures/{settle}/premium_index | Premium Index K-line chart
+[**list_futures_tickers**](FuturesApi.md#list_futures_tickers) | **GET** /futures/{settle}/tickers | Get all futures trading statistics
+[**list_futures_funding_rate_history**](FuturesApi.md#list_futures_funding_rate_history) | **GET** /futures/{settle}/funding_rate | Futures market historical funding rate
+[**list_futures_insurance_ledger**](FuturesApi.md#list_futures_insurance_ledger) | **GET** /futures/{settle}/insurance | Futures market insurance fund history
+[**list_contract_stats**](FuturesApi.md#list_contract_stats) | **GET** /futures/{settle}/contract_stats | Futures statistics
+[**get_index_constituents**](FuturesApi.md#get_index_constituents) | **GET** /futures/{settle}/index_constituents/{index} | Query index constituents
+[**list_liquidated_orders**](FuturesApi.md#list_liquidated_orders) | **GET** /futures/{settle}/liq_orders | Query liquidation order history
+[**list_futures_risk_limit_tiers**](FuturesApi.md#list_futures_risk_limit_tiers) | **GET** /futures/{settle}/risk_limit_tiers | Query risk limit tiers
+[**list_futures_accounts**](FuturesApi.md#list_futures_accounts) | **GET** /futures/{settle}/accounts | Get futures account
+[**list_futures_account_book**](FuturesApi.md#list_futures_account_book) | **GET** /futures/{settle}/account_book | Query futures account change history
+[**list_positions**](FuturesApi.md#list_positions) | **GET** /futures/{settle}/positions | Get user position list
+[**get_position**](FuturesApi.md#get_position) | **GET** /futures/{settle}/positions/{contract} | Get single position information
[**update_position_margin**](FuturesApi.md#update_position_margin) | **POST** /futures/{settle}/positions/{contract}/margin | Update position margin
[**update_position_leverage**](FuturesApi.md#update_position_leverage) | **POST** /futures/{settle}/positions/{contract}/leverage | Update position leverage
+[**update_position_cross_mode**](FuturesApi.md#update_position_cross_mode) | **POST** /futures/{settle}/positions/cross_mode | Switch Position Margin Mode
+[**update_dual_comp_position_cross_mode**](FuturesApi.md#update_dual_comp_position_cross_mode) | **POST** /futures/{settle}/dual_comp/positions/cross_mode | Switch Between Cross and Isolated Margin Modes Under Hedge Mode
[**update_position_risk_limit**](FuturesApi.md#update_position_risk_limit) | **POST** /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit
-[**set_dual_mode**](FuturesApi.md#set_dual_mode) | **POST** /futures/{settle}/dual_mode | Enable or disable dual mode
-[**get_dual_mode_position**](FuturesApi.md#get_dual_mode_position) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Retrieve position detail in dual mode
+[**set_dual_mode**](FuturesApi.md#set_dual_mode) | **POST** /futures/{settle}/dual_mode | Set position mode
+[**get_dual_mode_position**](FuturesApi.md#get_dual_mode_position) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Get position information in dual mode
[**update_dual_mode_position_margin**](FuturesApi.md#update_dual_mode_position_margin) | **POST** /futures/{settle}/dual_comp/positions/{contract}/margin | Update position margin in dual mode
[**update_dual_mode_position_leverage**](FuturesApi.md#update_dual_mode_position_leverage) | **POST** /futures/{settle}/dual_comp/positions/{contract}/leverage | Update position leverage in dual mode
[**update_dual_mode_position_risk_limit**](FuturesApi.md#update_dual_mode_position_risk_limit) | **POST** /futures/{settle}/dual_comp/positions/{contract}/risk_limit | Update position risk limit in dual mode
-[**list_futures_orders**](FuturesApi.md#list_futures_orders) | **GET** /futures/{settle}/orders | List futures orders
-[**create_futures_order**](FuturesApi.md#create_futures_order) | **POST** /futures/{settle}/orders | Create a futures order
-[**cancel_futures_orders**](FuturesApi.md#cancel_futures_orders) | **DELETE** /futures/{settle}/orders | Cancel all `open` orders matched
-[**get_orders_with_time_range**](FuturesApi.md#get_orders_with_time_range) | **GET** /futures/{settle}/orders_timerange | List Futures Orders By Time Range
-[**create_batch_futures_order**](FuturesApi.md#create_batch_futures_order) | **POST** /futures/{settle}/batch_orders | Create a batch of futures orders
-[**get_futures_order**](FuturesApi.md#get_futures_order) | **GET** /futures/{settle}/orders/{order_id} | Get a single order
-[**amend_futures_order**](FuturesApi.md#amend_futures_order) | **PUT** /futures/{settle}/orders/{order_id} | Amend an order
-[**cancel_futures_order**](FuturesApi.md#cancel_futures_order) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel a single order
-[**get_my_trades**](FuturesApi.md#get_my_trades) | **GET** /futures/{settle}/my_trades | List personal trading history
-[**get_my_trades_with_time_range**](FuturesApi.md#get_my_trades_with_time_range) | **GET** /futures/{settle}/my_trades_timerange | List personal trading history by time range
-[**list_position_close**](FuturesApi.md#list_position_close) | **GET** /futures/{settle}/position_close | List position close history
-[**list_liquidates**](FuturesApi.md#list_liquidates) | **GET** /futures/{settle}/liquidates | List liquidation history
-[**list_auto_deleverages**](FuturesApi.md#list_auto_deleverages) | **GET** /futures/{settle}/auto_deleverages | List Auto-Deleveraging History
+[**list_futures_orders**](FuturesApi.md#list_futures_orders) | **GET** /futures/{settle}/orders | Query futures order list
+[**create_futures_order**](FuturesApi.md#create_futures_order) | **POST** /futures/{settle}/orders | Place futures order
+[**cancel_futures_orders**](FuturesApi.md#cancel_futures_orders) | **DELETE** /futures/{settle}/orders | Cancel all orders with 'open' status
+[**get_orders_with_time_range**](FuturesApi.md#get_orders_with_time_range) | **GET** /futures/{settle}/orders_timerange | Query futures order list by time range
+[**create_batch_futures_order**](FuturesApi.md#create_batch_futures_order) | **POST** /futures/{settle}/batch_orders | Place batch futures orders
+[**get_futures_order**](FuturesApi.md#get_futures_order) | **GET** /futures/{settle}/orders/{order_id} | Query single order details
+[**amend_futures_order**](FuturesApi.md#amend_futures_order) | **PUT** /futures/{settle}/orders/{order_id} | Amend single order
+[**cancel_futures_order**](FuturesApi.md#cancel_futures_order) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel single order
+[**get_my_trades**](FuturesApi.md#get_my_trades) | **GET** /futures/{settle}/my_trades | Query personal trading records
+[**get_my_trades_with_time_range**](FuturesApi.md#get_my_trades_with_time_range) | **GET** /futures/{settle}/my_trades_timerange | Query personal trading records by time range
+[**list_position_close**](FuturesApi.md#list_position_close) | **GET** /futures/{settle}/position_close | Query position close history
+[**list_liquidates**](FuturesApi.md#list_liquidates) | **GET** /futures/{settle}/liquidates | Query liquidation history
+[**list_auto_deleverages**](FuturesApi.md#list_auto_deleverages) | **GET** /futures/{settle}/auto_deleverages | Query ADL auto-deleveraging order information
[**countdown_cancel_all_futures**](FuturesApi.md#countdown_cancel_all_futures) | **POST** /futures/{settle}/countdown_cancel_all | Countdown cancel orders
-[**get_futures_fee**](FuturesApi.md#get_futures_fee) | **GET** /futures/{settle}/fee | Query user trading fee rates
-[**cancel_batch_future_orders**](FuturesApi.md#cancel_batch_future_orders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel a batch of orders with an ID list
-[**amend_batch_future_orders**](FuturesApi.md#amend_batch_future_orders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders with specified IDs
-[**list_price_triggered_orders**](FuturesApi.md#list_price_triggered_orders) | **GET** /futures/{settle}/price_orders | List all auto orders
-[**create_price_triggered_order**](FuturesApi.md#create_price_triggered_order) | **POST** /futures/{settle}/price_orders | Create a price-triggered order
-[**cancel_price_triggered_order_list**](FuturesApi.md#cancel_price_triggered_order_list) | **DELETE** /futures/{settle}/price_orders | Cancel all open orders
-[**get_price_triggered_order**](FuturesApi.md#get_price_triggered_order) | **GET** /futures/{settle}/price_orders/{order_id} | Get a price-triggered order
-[**cancel_price_triggered_order**](FuturesApi.md#cancel_price_triggered_order) | **DELETE** /futures/{settle}/price_orders/{order_id} | cancel a price-triggered order
+[**get_futures_fee**](FuturesApi.md#get_futures_fee) | **GET** /futures/{settle}/fee | Query futures market trading fee rates
+[**cancel_batch_future_orders**](FuturesApi.md#cancel_batch_future_orders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel batch orders by specified ID list
+[**amend_batch_future_orders**](FuturesApi.md#amend_batch_future_orders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders by specified IDs
+[**get_futures_risk_limit_table**](FuturesApi.md#get_futures_risk_limit_table) | **GET** /futures/{settle}/risk_limit_table | Query risk limit table by table_id
+[**list_price_triggered_orders**](FuturesApi.md#list_price_triggered_orders) | **GET** /futures/{settle}/price_orders | Query auto order list
+[**create_price_triggered_order**](FuturesApi.md#create_price_triggered_order) | **POST** /futures/{settle}/price_orders | Create price-triggered order
+[**cancel_price_triggered_order_list**](FuturesApi.md#cancel_price_triggered_order_list) | **DELETE** /futures/{settle}/price_orders | Cancel all auto orders
+[**get_price_triggered_order**](FuturesApi.md#get_price_triggered_order) | **GET** /futures/{settle}/price_orders/{order_id} | Query single auto order details
+[**cancel_price_triggered_order**](FuturesApi.md#cancel_price_triggered_order) | **DELETE** /futures/{settle}/price_orders/{order_id} | Cancel single auto order
# **list_futures_contracts**
> list[Contract] list_futures_contracts(settle, limit=limit, offset=offset)
-List all futures contracts
+Query all futures contracts
### Example
@@ -74,11 +77,11 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List all futures contracts
+ # Query all futures contracts
api_response = api_instance.list_futures_contracts(settle, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -92,7 +95,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -111,14 +114,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_futures_contract**
> Contract get_futures_contract(settle, contract)
-Get a single contract
+Query single contract information
### Example
@@ -139,7 +142,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
try:
- # Get a single contract
+ # Query single contract information
api_response = api_instance.get_futures_contract(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -178,7 +181,7 @@ No authorization required
# **list_futures_order_book**
> FuturesOrderBook list_futures_order_book(settle, contract, interval=interval, limit=limit, with_id=with_id)
-Futures order book
+Query futures market depth information
Bids will be sorted by price from high to low, while asks sorted reversely
@@ -199,12 +202,12 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
-limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)
-with_id = False # bool | Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional) (default to False)
+interval = '0' # str | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional) (default to '0')
+limit = 10 # int | Number of depth levels (optional) (default to 10)
+with_id = False # bool | Whether to return depth update ID. This ID increments by 1 each time depth changes (optional) (default to False)
try:
- # Futures order book
+ # Query futures market depth information
api_response = api_instance.list_futures_order_book(settle, contract, interval=interval, limit=limit, with_id=with_id)
print(api_response)
except GateApiException as ex:
@@ -219,9 +222,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **interval** | **str**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to '0']
- **limit** | **int**| Maximum number of order depth data in asks or bids | [optional] [default to 10]
- **with_id** | **bool**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to False]
+ **interval** | **str**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to '0']
+ **limit** | **int**| Number of depth levels | [optional] [default to 10]
+ **with_id** | **bool**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to False]
### Return type
@@ -239,14 +242,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Order book retrieved | - |
+**200** | Depth query successful | - |
[[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)
# **list_futures_trades**
> list[FuturesTrade] list_futures_trades(settle, contract, limit=limit, offset=offset, last_id=last_id, _from=_from, to=to)
-Futures trading history
+Futures market transaction records
### Example
@@ -265,14 +268,14 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
last_id = '12345' # str | Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range (optional)
_from = 1546905600 # int | Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. (optional)
-to = 1546935600 # int | Specify end time in Unix seconds, default to current time (optional)
+to = 1546935600 # int | Specify end time in Unix seconds, default to current time. (optional)
try:
- # Futures trading history
+ # Futures market transaction records
api_response = api_instance.list_futures_trades(settle, contract, limit=limit, offset=offset, last_id=last_id, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -287,11 +290,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
**last_id** | **str**| Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range | [optional]
**_from** | **int**| Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned. | [optional]
- **to** | **int**| Specify end time in Unix seconds, default to current time | [optional]
+ **to** | **int**| Specify end time in Unix seconds, default to current time. | [optional]
### Return type
@@ -309,14 +312,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_futures_candlesticks**
-> list[FuturesCandlestick] list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
+> list[FuturesCandlestick] list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval, timezone=timezone)
-Get futures candlesticks
+Futures market K-line chart
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval`
@@ -338,13 +341,14 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
_from = 1546905600 # int | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
-to = 1546935600 # int | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
-limit = 100 # int | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
-interval = '5m' # str | Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days (optional) (default to '5m')
+to = 1546935600 # int | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision (optional)
+limit = 100 # int | Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
+interval = '5m' # str | Interval time between data points. Note that `1w` means natural week(Mon-Sun), while `7d` means every 7d since unix 0. 30d represents a natural month, not 30 days (optional) (default to '5m')
+timezone = 'utc0' # str | Time zone: all/utc0/utc8, default utc0 (optional) (default to 'utc0')
try:
- # Get futures candlesticks
- api_response = api_instance.list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
+ # Futures market K-line chart
+ api_response = api_instance.list_futures_candlesticks(settle, contract, _from=_from, to=to, limit=limit, interval=interval, timezone=timezone)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -359,9 +363,10 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
**_from** | **int**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional]
- **to** | **int**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional]
- **limit** | **int**| Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
- **interval** | **str**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days | [optional] [default to '5m']
+ **to** | **int**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision | [optional]
+ **limit** | **int**| Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
+ **interval** | **str**| Interval time between data points. Note that `1w` means natural week(Mon-Sun), while `7d` means every 7d since unix 0. 30d represents a natural month, not 30 days | [optional] [default to '5m']
+ **timezone** | **str**| Time zone: all/utc0/utc8, default utc0 | [optional] [default to 'utc0']
### Return type
@@ -379,14 +384,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_premium_index**
> list[FuturesPremiumIndex] list_futures_premium_index(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
-Premium Index K-Line
+Premium Index K-line chart
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval
@@ -408,12 +413,12 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
_from = 1546905600 # int | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
-to = 1546935600 # int | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
-limit = 100 # int | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
-interval = '5m' # str | Interval time between data points (optional) (default to '5m')
+to = 1546935600 # int | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision (optional)
+limit = 100 # int | Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
+interval = '5m' # str | Time interval between data points (optional) (default to '5m')
try:
- # Premium Index K-Line
+ # Premium Index K-line chart
api_response = api_instance.list_futures_premium_index(settle, contract, _from=_from, to=to, limit=limit, interval=interval)
print(api_response)
except GateApiException as ex:
@@ -429,9 +434,9 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
**_from** | **int**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional]
- **to** | **int**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional]
- **limit** | **int**| Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
- **interval** | **str**| Interval time between data points | [optional] [default to '5m']
+ **to** | **int**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision | [optional]
+ **limit** | **int**| Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
+ **interval** | **str**| Time interval between data points | [optional] [default to '5m']
### Return type
@@ -449,14 +454,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_tickers**
> list[FuturesTicker] list_futures_tickers(settle, contract=contract)
-List futures tickers
+Get all futures trading statistics
### Example
@@ -477,7 +482,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
try:
- # List futures tickers
+ # Get all futures trading statistics
api_response = api_instance.list_futures_tickers(settle, contract=contract)
print(api_response)
except GateApiException as ex:
@@ -509,14 +514,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_funding_rate_history**
> list[FundingRateRecord] list_futures_funding_rate_history(settle, contract, limit=limit, _from=_from, to=to)
-Funding rate history
+Futures market historical funding rate
### Example
@@ -535,12 +540,12 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # Funding rate history
+ # Futures market historical funding rate
api_response = api_instance.list_futures_funding_rate_history(settle, contract, limit=limit, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -555,9 +560,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -575,14 +580,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | History retrieved | - |
+**200** | History query successful | - |
[[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)
# **list_futures_insurance_ledger**
> list[InsuranceRecord] list_futures_insurance_ledger(settle, limit=limit)
-Futures insurance balance history
+Futures market insurance fund history
### Example
@@ -600,10 +605,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
- # Futures insurance balance history
+ # Futures market insurance fund history
api_response = api_instance.list_futures_insurance_ledger(settle, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -617,7 +622,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -635,14 +640,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_contract_stats**
> list[ContractStat] list_contract_stats(settle, contract, _from=_from, interval=interval, limit=limit)
-Futures stats
+Futures statistics
### Example
@@ -666,7 +671,7 @@ interval = '5m' # str | (optional) (default to '5m')
limit = 30 # int | (optional) (default to 30)
try:
- # Futures stats
+ # Futures statistics
api_response = api_instance.list_contract_stats(settle, contract, _from=_from, interval=interval, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -701,14 +706,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_index_constituents**
> FuturesIndexConstituents get_index_constituents(settle, index)
-Get index constituents
+Query index constituents
### Example
@@ -729,7 +734,7 @@ settle = 'usdt' # str | Settle currency
index = 'BTC_USDT' # str | Index name
try:
- # Get index constituents
+ # Query index constituents
api_response = api_instance.get_index_constituents(settle, index)
print(api_response)
except GateApiException as ex:
@@ -761,16 +766,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_liquidated_orders**
> list[FuturesLiqOrder] list_liquidated_orders(settle, contract=contract, _from=_from, to=to, limit=limit)
-Retrieve liquidation history
+Query liquidation order history
-Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail.
+The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details
### Example
@@ -789,12 +794,12 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
- # Retrieve liquidation history
+ # Query liquidation order history
api_response = api_instance.list_liquidated_orders(settle, contract=contract, _from=_from, to=to, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -809,9 +814,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -829,16 +834,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_futures_risk_limit_tiers**
> list[FuturesLimitRiskTiers] list_futures_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
-List risk limit tiers
+Query risk limit tiers
-When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty.
+When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty.
### Example
@@ -857,11 +862,11 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List risk limit tiers
+ # Query risk limit tiers
api_response = api_instance.list_futures_risk_limit_tiers(settle, contract=contract, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -876,7 +881,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -895,14 +900,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_accounts**
> FuturesAccount list_futures_accounts(settle)
-Query futures account
+Get futures account
### Example
@@ -931,7 +936,7 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
try:
- # Query futures account
+ # Get futures account
api_response = api_instance.list_futures_accounts(settle)
print(api_response)
except GateApiException as ex:
@@ -962,16 +967,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_account_book**
> list[FuturesAccountBook] list_futures_account_book(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, type=type)
-Query account book
+Query futures account change history
-If the `contract` field is provided, it can only filter records that include this field after 2023-10-30.
+If the contract field is passed, only records containing this field after 2023-10-30 can be filtered.
### Example
@@ -999,14 +1004,14 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-type = 'dnw' # str | Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+type = 'dnw' # str | Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction (optional)
try:
- # Query account book
+ # Query futures account change history
api_response = api_instance.list_futures_account_book(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, type=type)
print(api_response)
except GateApiException as ex:
@@ -1021,11 +1026,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **type** | **str**| Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **type** | **str**| Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction | [optional]
### Return type
@@ -1043,14 +1048,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_positions**
> list[Position] list_positions(settle, holding=holding, limit=limit, offset=offset)
-List all positions of a user
+Get user position list
### Example
@@ -1077,12 +1082,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-holding = true # bool | Return only real positions - true, return all - false. (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+holding = true # bool | Return only real positions - true, return all - false (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List all positions of a user
+ # Get user position list
api_response = api_instance.list_positions(settle, holding=holding, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -1096,8 +1101,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **holding** | **bool**| Return only real positions - true, return all - false. | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **holding** | **bool**| Return only real positions - true, return all - false | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -1116,14 +1121,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_position**
> Position get_position(settle, contract)
-Get single position
+Get single position information
### Example
@@ -1153,7 +1158,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
try:
- # Get single position
+ # Get single position information
api_response = api_instance.get_position(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -1220,7 +1225,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-change = '0.01' # str | Margin change. Use positive number to increase margin, negative number otherwise.
+change = '0.01' # str | Margin change amount, positive number increases, negative number decreases
try:
# Update position margin
@@ -1238,7 +1243,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **change** | **str**| Margin change. Use positive number to increase margin, negative number otherwise. |
+ **change** | **str**| Margin change amount, positive number increases, negative number decreases |
### Return type
@@ -1261,7 +1266,7 @@ Name | Type | Description | Notes
[[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)
# **update_position_leverage**
-> Position update_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit)
+> Position update_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit, pid=pid)
Update position leverage
@@ -1292,11 +1297,12 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
leverage = '10' # str | New position leverage
-cross_leverage_limit = '10' # str | Cross margin leverage(valid only when `leverage` is 0) (optional)
+cross_leverage_limit = '10' # str | Cross margin leverage (valid only when `leverage` is 0) (optional)
+pid = 1 # int | Product ID (optional)
try:
# Update position leverage
- api_response = api_instance.update_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit)
+ api_response = api_instance.update_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit, pid=pid)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -1311,7 +1317,8 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
**leverage** | **str**| New position leverage |
- **cross_leverage_limit** | **str**| Cross margin leverage(valid only when `leverage` is 0) | [optional]
+ **cross_leverage_limit** | **str**| Cross margin leverage (valid only when `leverage` is 0) | [optional]
+ **pid** | **int**| Product ID | [optional]
### Return type
@@ -1333,6 +1340,144 @@ Name | Type | Description | Notes
[[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)
+# **update_position_cross_mode**
+> Position update_position_cross_mode(settle, futures_position_cross_mode)
+
+Switch Position Margin Mode
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.FuturesApi(api_client)
+settle = 'usdt' # str | Settle currency
+futures_position_cross_mode = gate_api.FuturesPositionCrossMode() # FuturesPositionCrossMode |
+
+try:
+ # Switch Position Margin Mode
+ api_response = api_instance.update_position_cross_mode(settle, futures_position_cross_mode)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling FuturesApi->update_position_cross_mode: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **settle** | **str**| Settle currency |
+ **futures_position_cross_mode** | [**FuturesPositionCrossMode**](FuturesPositionCrossMode.md)| |
+
+### Return type
+
+[**Position**](Position.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Position information | - |
+
+[[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)
+
+# **update_dual_comp_position_cross_mode**
+> list[Position] update_dual_comp_position_cross_mode(settle, inline_object)
+
+Switch Between Cross and Isolated Margin Modes Under Hedge Mode
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.FuturesApi(api_client)
+settle = 'usdt' # str | Settle currency
+inline_object = gate_api.InlineObject() # InlineObject |
+
+try:
+ # Switch Between Cross and Isolated Margin Modes Under Hedge Mode
+ api_response = api_instance.update_dual_comp_position_cross_mode(settle, inline_object)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling FuturesApi->update_dual_comp_position_cross_mode: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **settle** | **str**| Settle currency |
+ **inline_object** | [**InlineObject**](InlineObject.md)| |
+
+### Return type
+
+[**list[Position]**](Position.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Query successful | - |
+
+[[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)
+
# **update_position_risk_limit**
> Position update_position_risk_limit(settle, contract, risk_limit)
@@ -1364,7 +1509,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-risk_limit = '1000000' # str | New Risk Limit Value
+risk_limit = '1000000' # str | New risk limit value
try:
# Update position risk limit
@@ -1382,7 +1527,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **risk_limit** | **str**| New Risk Limit Value |
+ **risk_limit** | **str**| New risk limit value |
### Return type
@@ -1407,9 +1552,9 @@ Name | Type | Description | Notes
# **set_dual_mode**
> FuturesAccount set_dual_mode(settle, dual_mode)
-Enable or disable dual mode
+Set position mode
-Before setting dual mode, make sure all positions are closed and no orders are open
+The prerequisite for changing mode is that all positions have no holdings and no pending orders
### Example
@@ -1439,7 +1584,7 @@ settle = 'usdt' # str | Settle currency
dual_mode = true # bool | Whether to enable dual mode
try:
- # Enable or disable dual mode
+ # Set position mode
api_response = api_instance.set_dual_mode(settle, dual_mode)
print(api_response)
except GateApiException as ex:
@@ -1471,14 +1616,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Updated | - |
+**200** | Updated successfully | - |
[[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)
# **get_dual_mode_position**
> list[Position] get_dual_mode_position(settle, contract)
-Retrieve position detail in dual mode
+Get position information in dual mode
### Example
@@ -1508,7 +1653,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
try:
- # Retrieve position detail in dual mode
+ # Get position information in dual mode
api_response = api_instance.get_dual_mode_position(settle, contract)
print(api_response)
except GateApiException as ex:
@@ -1540,7 +1685,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1575,7 +1720,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-change = '0.01' # str | Margin change. Use positive number to increase margin, negative number otherwise.
+change = '0.01' # str | Margin change amount, positive number increases, negative number decreases
dual_side = 'dual_long' # str | Long or short position
try:
@@ -1594,7 +1739,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **change** | **str**| Margin change. Use positive number to increase margin, negative number otherwise. |
+ **change** | **str**| Margin change amount, positive number increases, negative number decreases |
**dual_side** | **str**| Long or short position |
### Return type
@@ -1613,7 +1758,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1649,7 +1794,7 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
leverage = '10' # str | New position leverage
-cross_leverage_limit = '10' # str | Cross margin leverage(valid only when `leverage` is 0) (optional)
+cross_leverage_limit = '10' # str | Cross margin leverage (valid only when `leverage` is 0) (optional)
try:
# Update position leverage in dual mode
@@ -1668,7 +1813,7 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
**leverage** | **str**| New position leverage |
- **cross_leverage_limit** | **str**| Cross margin leverage(valid only when `leverage` is 0) | [optional]
+ **cross_leverage_limit** | **str**| Cross margin leverage (valid only when `leverage` is 0) | [optional]
### Return type
@@ -1686,7 +1831,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1721,7 +1866,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-risk_limit = '1000000' # str | New Risk Limit Value
+risk_limit = '1000000' # str | New risk limit value
try:
# Update position risk limit in dual mode
@@ -1739,7 +1884,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **risk_limit** | **str**| New Risk Limit Value |
+ **risk_limit** | **str**| New risk limit value |
### Return type
@@ -1757,14 +1902,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_futures_orders**
> list[FuturesOrder] list_futures_orders(settle, status, contract=contract, limit=limit, offset=offset, last_id=last_id)
-List futures orders
+Query futures order list
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/orders_timerange`.
@@ -1793,14 +1938,14 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-status = 'open' # str | Only list the orders with this status
+status = 'open' # str | Query order list based on status
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)
+last_id = '12345' # str | Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used (optional)
try:
- # List futures orders
+ # Query futures order list
api_response = api_instance.list_futures_orders(settle, status, contract=contract, limit=limit, offset=offset, last_id=last_id)
print(api_response)
except GateApiException as ex:
@@ -1814,11 +1959,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **status** | **str**| Only list the orders with this status |
+ **status** | **str**| Query order list based on status |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **last_id** | **str**| Specify list staring point using the `id` of last record in previous list-query results | [optional]
+ **last_id** | **str**| Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used | [optional]
### Return type
@@ -1836,16 +1981,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
|
[[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)
# **create_futures_order**
> FuturesOrder create_futures_order(settle, futures_order, x_gate_exptime=x_gate_exptime)
-Create a futures order
+Place futures order
-- Creating futures orders requires `size`, which is number of contracts instead of currency amount. You can use `quanto_multiplier` in contract detail response to know how much currency 1 size contract represents - Zero-filled order cannot be retrieved 10 minutes after order cancellation. You will get a 404 not found for such orders - Set `reduce_only` to `true` can keep the position from changing side when reducing position size - In single position mode, to close a position, you need to set `size` to 0 and `close` to `true` - In dual position mode, to close one side position, you need to set `auto_size` side, `reduce_only` to true and `size` to 0 - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body
+- When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act`
### Example
@@ -1873,10 +2018,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
futures_order = gate_api.FuturesOrder() # FuturesOrder |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Create a futures order
+ # Place futures order
api_response = api_instance.create_futures_order(settle, futures_order, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -1891,7 +2036,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**futures_order** | [**FuturesOrder**](FuturesOrder.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1914,11 +2059,11 @@ Name | Type | Description | Notes
[[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)
# **cancel_futures_orders**
-> list[FuturesOrder] cancel_futures_orders(settle, contract, x_gate_exptime=x_gate_exptime, side=side)
+> list[FuturesOrder] cancel_futures_orders(settle, contract, x_gate_exptime=x_gate_exptime, side=side, exclude_reduce_only=exclude_reduce_only, text=text)
-Cancel all `open` orders matched
+Cancel all orders with 'open' status
-Zero-filled order cannot be retrieved 10 minutes after order cancellation
+Zero-fill orders cannot be retrieved 10 minutes after order cancellation
### Example
@@ -1946,12 +2091,14 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
-side = 'ask' # str | All bids or asks. Both included if not specified (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+side = 'ask' # str | Specify all buy orders or all sell orders, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell orders (optional)
+exclude_reduce_only = False # bool | Whether to exclude reduce-only orders (optional) (default to False)
+text = 'cancel by user' # str | Remark for order cancellation (optional)
try:
- # Cancel all `open` orders matched
- api_response = api_instance.cancel_futures_orders(settle, contract, x_gate_exptime=x_gate_exptime, side=side)
+ # Cancel all orders with 'open' status
+ api_response = api_instance.cancel_futures_orders(settle, contract, x_gate_exptime=x_gate_exptime, side=side, exclude_reduce_only=exclude_reduce_only, text=text)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -1965,8 +2112,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
- **side** | **str**| All bids or asks. Both included if not specified | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **side** | **str**| Specify all buy orders or all sell orders, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell orders | [optional]
+ **exclude_reduce_only** | **bool**| Whether to exclude reduce-only orders | [optional] [default to False]
+ **text** | **str**| Remark for order cancellation | [optional]
### Return type
@@ -1984,14 +2133,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | All orders matched cancelled | - |
+**200** | Batch cancellation successful | - |
[[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)
# **get_orders_with_time_range**
> list[FuturesOrder] get_orders_with_time_range(settle, contract=contract, _from=_from, to=to, limit=limit, offset=offset)
-List Futures Orders By Time Range
+Query futures order list by time range
### Example
@@ -2019,13 +2168,13 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List Futures Orders By Time Range
+ # Query futures order list by time range
api_response = api_instance.get_orders_with_time_range(settle, contract=contract, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -2040,9 +2189,9 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -2061,14 +2210,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
|
[[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)
# **create_batch_futures_order**
> list[BatchFuturesOrder] create_batch_futures_order(settle, futures_order, x_gate_exptime=x_gate_exptime)
-Create a batch of futures orders
+Place batch futures orders
- Up to 10 orders per request - If any of the order's parameters are missing or in the wrong format, all of them will not be executed, and a http status 400 error will be returned directly - If the parameters are checked and passed, all are executed. Even if there is a business logic error in the middle (such as insufficient funds), it will not affect other execution orders - The returned result is in array format, and the order corresponds to the orders in the request body - In the returned result, the `succeeded` field of type bool indicates whether the execution was successful or not - If the execution is successful, the normal order content is included; if the execution fails, the `label` field is included to indicate the cause of the error - In the rate limiting, each order is counted individually
@@ -2098,10 +2247,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
futures_order = [gate_api.FuturesOrder()] # list[FuturesOrder] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Create a batch of futures orders
+ # Place batch futures orders
api_response = api_instance.create_batch_futures_order(settle, futures_order, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -2116,7 +2265,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**futures_order** | [**list[FuturesOrder]**](FuturesOrder.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -2134,14 +2283,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Request is completed | - |
+**200** | Request execution completed | - |
[[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)
# **get_futures_order**
> FuturesOrder get_futures_order(settle, order_id)
-Get a single order
+Query single order details
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported.
@@ -2170,10 +2319,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
+order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
try:
- # Get a single order
+ # Query single order details
api_response = api_instance.get_futures_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -2187,7 +2336,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
+ **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
### Return type
@@ -2212,7 +2361,7 @@ Name | Type | Description | Notes
# **amend_futures_order**
> FuturesOrder amend_futures_order(settle, order_id, futures_order_amendment, x_gate_exptime=x_gate_exptime)
-Amend an order
+Amend single order
### Example
@@ -2239,12 +2388,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
+order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
futures_order_amendment = gate_api.FuturesOrderAmendment() # FuturesOrderAmendment |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Amend an order
+ # Amend single order
api_response = api_instance.amend_futures_order(settle, order_id, futures_order_amendment, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -2258,9 +2407,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
+ **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
**futures_order_amendment** | [**FuturesOrderAmendment**](FuturesOrderAmendment.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -2285,7 +2434,7 @@ Name | Type | Description | Notes
# **cancel_futures_order**
> FuturesOrder cancel_futures_order(settle, order_id, x_gate_exptime=x_gate_exptime)
-Cancel a single order
+Cancel single order
### Example
@@ -2312,11 +2461,11 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted.
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Cancel a single order
+ # Cancel single order
api_response = api_instance.cancel_futures_order(settle, order_id, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -2330,8 +2479,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. |
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -2356,7 +2505,7 @@ Name | Type | Description | Notes
# **get_my_trades**
> list[MyFuturesTrade] get_my_trades(settle, contract=contract, order=order, limit=limit, offset=offset, last_id=last_id)
-List personal trading history
+Query personal trading records
By default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/my_trades_timerange`.
@@ -2387,12 +2536,12 @@ api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
order = 12345 # int | Futures order ID, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
last_id = '12345' # str | Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. If you need to iterate through and retrieve more records, we recommend using 'GET /futures/{settle}/my_trades_timerange'. (optional)
try:
- # List personal trading history
+ # Query personal trading records
api_response = api_instance.get_my_trades(settle, contract=contract, order=order, limit=limit, offset=offset, last_id=last_id)
print(api_response)
except GateApiException as ex:
@@ -2408,7 +2557,7 @@ Name | Type | Description | Notes
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
**order** | **int**| Futures order ID, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
**last_id** | **str**| Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. If you need to iterate through and retrieve more records, we recommend using 'GET /futures/{settle}/my_trades_timerange'. | [optional]
@@ -2428,14 +2577,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
|
[[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)
# **get_my_trades_with_time_range**
> list[MyFuturesTradeTimeRange] get_my_trades_with_time_range(settle, contract=contract, _from=_from, to=to, limit=limit, offset=offset, role=role)
-List personal trading history by time range
+Query personal trading records by time range
### Example
@@ -2463,14 +2612,14 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-role = 'maker' # str | Query role, maker or taker. (optional)
+role = 'maker' # str | Query role, maker or taker (optional)
try:
- # List personal trading history by time range
+ # Query personal trading records by time range
api_response = api_instance.get_my_trades_with_time_range(settle, contract=contract, _from=_from, to=to, limit=limit, offset=offset, role=role)
print(api_response)
except GateApiException as ex:
@@ -2485,11 +2634,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **role** | **str**| Query role, maker or taker. | [optional]
+ **role** | **str**| Query role, maker or taker | [optional]
### Return type
@@ -2507,14 +2656,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | * X-Pagination-Limit - Request limit specified
* X-Pagination-Offset - Request offset specified
|
+**200** | List retrieved successfully | * X-Pagination-Limit - Limit specified for pagination
* X-Pagination-Offset - Offset specified for pagination
|
[[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)
# **list_position_close**
> list[PositionClose] list_position_close(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, side=side, pnl=pnl)
-List position close history
+Query position close history
### Example
@@ -2542,15 +2691,15 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-side = 'short' # str | Query side. long or shot (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+side = 'short' # str | Query side. long or shot (optional)
pnl = 'profit' # str | Query profit or loss (optional)
try:
- # List position close history
+ # Query position close history
api_response = api_instance.list_position_close(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, side=side, pnl=pnl)
print(api_response)
except GateApiException as ex:
@@ -2565,11 +2714,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **side** | **str**| Query side. long or shot | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **side** | **str**| Query side. long or shot | [optional]
**pnl** | **str**| Query profit or loss | [optional]
### Return type
@@ -2588,14 +2737,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_liquidates**
-> list[FuturesLiquidate] list_liquidates(settle, contract=contract, limit=limit, at=at)
+> list[FuturesLiquidate] list_liquidates(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, at=at)
-List liquidation history
+Query liquidation history
### Example
@@ -2623,12 +2772,15 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-at = 0 # int | Specify a liquidation timestamp (optional) (default to 0)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+at = 0 # int | Specify liquidation timestamp (optional) (default to 0)
try:
- # List liquidation history
- api_response = api_instance.list_liquidates(settle, contract=contract, limit=limit, at=at)
+ # Query liquidation history
+ api_response = api_instance.list_liquidates(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, at=at)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -2642,8 +2794,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **at** | **int**| Specify a liquidation timestamp | [optional] [default to 0]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **at** | **int**| Specify liquidation timestamp | [optional] [default to 0]
### Return type
@@ -2661,14 +2816,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_auto_deleverages**
-> list[FuturesAutoDeleverage] list_auto_deleverages(settle, contract=contract, limit=limit, at=at)
+> list[FuturesAutoDeleverage] list_auto_deleverages(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, at=at)
-List Auto-Deleveraging History
+Query ADL auto-deleveraging order information
### Example
@@ -2696,12 +2851,15 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-at = 0 # int | Specify an auto-deleveraging timestamp (optional) (default to 0)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+at = 0 # int | Specify auto-deleveraging timestamp (optional) (default to 0)
try:
- # List Auto-Deleveraging History
- api_response = api_instance.list_auto_deleverages(settle, contract=contract, limit=limit, at=at)
+ # Query ADL auto-deleveraging order information
+ api_response = api_instance.list_auto_deleverages(settle, contract=contract, limit=limit, offset=offset, _from=_from, to=to, at=at)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -2715,8 +2873,11 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **at** | **int**| Specify an auto-deleveraging timestamp | [optional] [default to 0]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **at** | **int**| Specify auto-deleveraging timestamp | [optional] [default to 0]
### Return type
@@ -2734,7 +2895,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -2743,7 +2904,7 @@ Name | Type | Description | Notes
Countdown cancel orders
-When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled.
+Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled.
### Example
@@ -2805,14 +2966,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Set countdown successfully | - |
+**200** | Countdown set successfully | - |
[[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)
# **get_futures_fee**
> dict(str, FuturesFee) get_futures_fee(settle, contract=contract)
-Query user trading fee rates
+Query futures market trading fee rates
### Example
@@ -2842,7 +3003,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
try:
- # Query user trading fee rates
+ # Query futures market trading fee rates
api_response = api_instance.get_futures_fee(settle, contract=contract)
print(api_response)
except GateApiException as ex:
@@ -2874,16 +3035,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **cancel_batch_future_orders**
> list[FutureCancelOrderResult] cancel_batch_future_orders(settle, request_body, x_gate_exptime=x_gate_exptime)
-Cancel a batch of orders with an ID list
+Cancel batch orders by specified ID list
-Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records.
+Multiple different order IDs can be specified, maximum 20 records per request
### Example
@@ -2911,10 +3072,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
request_body = ['request_body_example'] # list[str] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Cancel a batch of orders with an ID list
+ # Cancel batch orders by specified ID list
api_response = api_instance.cancel_batch_future_orders(settle, request_body, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -2929,7 +3090,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**request_body** | [**list[str]**](str.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -2954,9 +3115,9 @@ Name | Type | Description | Notes
# **amend_batch_future_orders**
> list[BatchFuturesOrder] amend_batch_future_orders(settle, batch_amend_order_req, x_gate_exptime=x_gate_exptime)
-Batch modify orders with specified IDs
+Batch modify orders by specified IDs
-You can specify multiple different order IDs. You can only modify up to 10 orders in one request.
+Multiple different order IDs can be specified, maximum 10 orders per request
### Example
@@ -2984,10 +3145,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
batch_amend_order_req = [gate_api.BatchAmendOrderReq()] # list[BatchAmendOrderReq] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Batch modify orders with specified IDs
+ # Batch modify orders by specified IDs
api_response = api_instance.amend_batch_future_orders(settle, batch_amend_order_req, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -3002,7 +3163,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
**batch_amend_order_req** | [**list[BatchAmendOrderReq]**](BatchAmendOrderReq.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -3020,14 +3181,76 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Request is completed | - |
+**200** | Request execution completed | - |
+
+[[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)
+
+# **get_futures_risk_limit_table**
+> list[FuturesRiskLimitTier] get_futures_risk_limit_table(settle, table_id)
+
+Query risk limit table by table_id
+
+Just pass table_id
+
+### Example
+
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.FuturesApi(api_client)
+settle = 'usdt' # str | Settle currency
+table_id = 'CYBER_USDT_20241122' # str | Risk limit table ID
+
+try:
+ # Query risk limit table by table_id
+ api_response = api_instance.get_futures_risk_limit_table(settle, table_id)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling FuturesApi->get_futures_risk_limit_table: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **settle** | **str**| Settle currency |
+ **table_id** | **str**| Risk limit table ID |
+
+### Return type
+
+[**list[FuturesRiskLimitTier]**](FuturesRiskLimitTier.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Query successful | - |
[[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)
# **list_price_triggered_orders**
> list[FuturesPriceTriggeredOrder] list_price_triggered_orders(settle, status, contract=contract, limit=limit, offset=offset)
-List all auto orders
+Query auto order list
### Example
@@ -3054,13 +3277,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-status = 'status_example' # str | Only list the orders with this status
+status = 'status_example' # str | Query order list based on status
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # List all auto orders
+ # Query auto order list
api_response = api_instance.list_price_triggered_orders(settle, status, contract=contract, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -3074,9 +3297,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **status** | **str**| Only list the orders with this status |
+ **status** | **str**| Query order list based on status |
**contract** | **str**| Futures contract, return related data only if specified | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -3095,14 +3318,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_price_triggered_order**
> TriggerOrderResponse create_price_triggered_order(settle, futures_price_triggered_order)
-Create a price-triggered order
+Create price-triggered order
### Example
@@ -3132,7 +3355,7 @@ settle = 'usdt' # str | Settle currency
futures_price_triggered_order = gate_api.FuturesPriceTriggeredOrder() # FuturesPriceTriggeredOrder |
try:
- # Create a price-triggered order
+ # Create price-triggered order
api_response = api_instance.create_price_triggered_order(settle, futures_price_triggered_order)
print(api_response)
except GateApiException as ex:
@@ -3164,14 +3387,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Order created | - |
+**201** | Order created successfully | - |
[[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)
# **cancel_price_triggered_order_list**
> list[FuturesPriceTriggeredOrder] cancel_price_triggered_order_list(settle, contract=contract)
-Cancel all open orders
+Cancel all auto orders
### Example
@@ -3201,7 +3424,7 @@ settle = 'usdt' # str | Settle currency
contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional)
try:
- # Cancel all open orders
+ # Cancel all auto orders
api_response = api_instance.cancel_price_triggered_order_list(settle, contract=contract)
print(api_response)
except GateApiException as ex:
@@ -3233,14 +3456,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Batch cancellation request accepted. Query order status by listing orders | - |
+**200** | Batch cancellation request accepted and processed, success determined by order list | - |
[[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)
# **get_price_triggered_order**
> FuturesPriceTriggeredOrder get_price_triggered_order(settle, order_id)
-Get a price-triggered order
+Query single auto order details
### Example
@@ -3267,10 +3490,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # Get a price-triggered order
+ # Query single auto order details
api_response = api_instance.get_price_triggered_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -3284,7 +3507,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -3302,14 +3525,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
# **cancel_price_triggered_order**
> FuturesPriceTriggeredOrder cancel_price_triggered_order(settle, order_id)
-cancel a price-triggered order
+Cancel single auto order
### Example
@@ -3336,10 +3559,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.FuturesApi(api_client)
settle = 'usdt' # str | Settle currency
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # cancel a price-triggered order
+ # Cancel single auto order
api_response = api_instance.cancel_price_triggered_order(settle, order_id)
print(api_response)
except GateApiException as ex:
@@ -3353,7 +3576,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**settle** | **str**| Settle currency |
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -3371,7 +3594,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
diff --git a/docs/FuturesAutoDeleverage.md b/docs/FuturesAutoDeleverage.md
index ae4759c..1f2d674 100644
--- a/docs/FuturesAutoDeleverage.md
+++ b/docs/FuturesAutoDeleverage.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**order_id** | **int** | Order ID. Order IDs before 2023-02-20 are null | [optional] [readonly]
**contract** | **str** | Futures contract | [optional] [readonly]
**leverage** | **str** | Position leverage | [optional] [readonly]
-**cross_leverage_limit** | **str** | Cross margin leverage(valid only when `leverage` is 0) | [optional] [readonly]
+**cross_leverage_limit** | **str** | Cross margin leverage (valid only when `leverage` is 0) | [optional] [readonly]
**entry_price** | **str** | Average entry price | [optional] [readonly]
**fill_price** | **str** | Average fill price | [optional] [readonly]
**trade_size** | **int** | Trading size | [optional] [readonly]
diff --git a/docs/FuturesBatchAmendOrderRequest.md b/docs/FuturesBatchAmendOrderRequest.md
index 69bc53f..b8a8467 100644
--- a/docs/FuturesBatchAmendOrderRequest.md
+++ b/docs/FuturesBatchAmendOrderRequest.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order id, order_id and text must contain at least one | [optional]
**text** | **str** | User-defined order text, at least one of order_id and text must be passed | [optional]
-**size** | **int** | The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. | [optional]
-**price** | **str** | New order price. | [optional]
-**amend_text** | **str** | Custom info during amending order | [optional]
+**size** | **int** | New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. | [optional]
+**price** | **str** | New order price | [optional]
+**amend_text** | **str** | Custom info during order amendment | [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)
diff --git a/docs/FuturesFee.md b/docs/FuturesFee.md
index 383ec9e..5b3c0df 100644
--- a/docs/FuturesFee.md
+++ b/docs/FuturesFee.md
@@ -1,6 +1,6 @@
# FuturesFee
-The returned result is a map type, where the key represents the market and the value represents the taker and maker fee rates.
+The returned result is a map type, where the key represents the market and taker and maker fee rates
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/FuturesInitialOrder.md b/docs/FuturesInitialOrder.md
index 3b8b771..6c6dd28 100644
--- a/docs/FuturesInitialOrder.md
+++ b/docs/FuturesInitialOrder.md
@@ -4,13 +4,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**contract** | **str** | Futures contract |
-**size** | **int** | Order size. Positive size means to buy, while negative one means to sell. Set to 0 to close the position | [optional]
+**size** | **int** | Represents the number of contracts that need to be closed, full closing: size=0 Partial closing: plan-close-short-position size>0 Partial closing: plan-close-long-position size<0 | [optional]
**price** | **str** | Order price. Set to 0 to use market price |
-**close** | **bool** | Set to true if trying to close the position | [optional] [default to False]
-**tif** | **str** | Time in force. If using market price, only `ioc` is supported. - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] [default to 'gtc']
-**text** | **str** | The source of the order, including: - web: web - api: api - app: app | [optional]
-**reduce_only** | **bool** | Set to true to create a reduce-only order | [optional] [default to False]
-**auto_size** | **str** | Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 | [optional]
+**close** | **bool** | When all positions are closed in a single position mode, it must be set to true to perform the closing operation When partially closed positions in single-store mode/double-store mode, you can not set close, or close=false | [optional] [default to False]
+**tif** | **str** | Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] [default to 'gtc']
+**text** | **str** | The source of the order, including: - web: Web - api: API call - app: Mobile app | [optional]
+**reduce_only** | **bool** | When set to true, perform automatic position reduction operation. Set to true to ensure that the order will not open a new position, and is only used to close or reduce positions | [optional] [default to False]
+**auto_size** | **str** | Single position mode: auto_size is not required Dual position mode full closing (size=0): auto_size must be set, close_long for closing long positions, close_short for closing short positions Dual position mode partial closing (size≠0): auto_size is not required | [optional]
**is_reduce_only** | **bool** | Is the order reduce-only | [optional] [readonly]
**is_close** | **bool** | Is the order to close position | [optional] [readonly]
diff --git a/docs/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md
index fec6e52..704f833 100644
--- a/docs/FuturesLimitRiskTiers.md
+++ b/docs/FuturesLimitRiskTiers.md
@@ -1,6 +1,6 @@
# FuturesLimitRiskTiers
-Retrieve risk limit configurations for different tiers under a specified contract.
+Retrieve risk limit configurations for different tiers under a specified contract
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -9,7 +9,8 @@ Name | Type | Description | Notes
**initial_rate** | **str** | Initial margin rate | [optional]
**maintenance_rate** | **str** | Maintenance margin rate | [optional]
**leverage_max** | **str** | Maximum leverage | [optional]
-**contract** | **str** | Markets, visible only during market pagination requests | [optional]
+**contract** | **str** | Market, only visible when market pagination is requested | [optional]
+**deduction** | **str** | Maintenance margin quick calculation deduction amount | [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)
diff --git a/docs/FuturesLiqOrder.md b/docs/FuturesLiqOrder.md
index 3cc3b7d..daf3c5e 100644
--- a/docs/FuturesLiqOrder.md
+++ b/docs/FuturesLiqOrder.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
**time** | **int** | Liquidation time | [optional] [readonly]
**contract** | **str** | Futures contract | [optional] [readonly]
**size** | **int** | User position size | [optional] [readonly]
+**order_size** | **int** | Number of forced liquidation orders | [optional] [readonly]
**order_price** | **str** | Liquidation order price | [optional] [readonly]
**fill_price** | **str** | Liquidation order average taker price | [optional] [readonly]
**left** | **int** | System liquidation order maker size | [optional] [readonly]
diff --git a/docs/FuturesLiquidate.md b/docs/FuturesLiquidate.md
index c8575b9..78b62b2 100644
--- a/docs/FuturesLiquidate.md
+++ b/docs/FuturesLiquidate.md
@@ -5,13 +5,13 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time** | **int** | Liquidation time | [optional] [readonly]
**contract** | **str** | Futures contract | [optional] [readonly]
-**leverage** | **str** | Position leverage. Not returned in public endpoints. | [optional] [readonly]
+**leverage** | **str** | Position leverage. Not returned in public endpoints | [optional] [readonly]
**size** | **int** | Position size | [optional] [readonly]
-**margin** | **str** | Position margin. Not returned in public endpoints. | [optional] [readonly]
-**entry_price** | **str** | Average entry price. Not returned in public endpoints. | [optional] [readonly]
-**liq_price** | **str** | Liquidation price. Not returned in public endpoints. | [optional] [readonly]
-**mark_price** | **str** | Mark price. Not returned in public endpoints. | [optional] [readonly]
-**order_id** | **int** | Liquidation order ID. Not returned in public endpoints. | [optional] [readonly]
+**margin** | **str** | Position margin. Not returned in public endpoints | [optional] [readonly]
+**entry_price** | **str** | Average entry price. Not returned in public endpoints | [optional] [readonly]
+**liq_price** | **str** | Liquidation price. Not returned in public endpoints | [optional] [readonly]
+**mark_price** | **str** | Mark price. Not returned in public endpoints | [optional] [readonly]
+**order_id** | **int** | Liquidation order ID. Not returned in public endpoints | [optional] [readonly]
**order_price** | **str** | Liquidation order price | [optional] [readonly]
**fill_price** | **str** | Liquidation order average taker price | [optional] [readonly]
**left** | **int** | Liquidation order maker size | [optional] [readonly]
diff --git a/docs/FuturesOrder.md b/docs/FuturesOrder.md
index 1eeb80a..1d0de6a 100644
--- a/docs/FuturesOrder.md
+++ b/docs/FuturesOrder.md
@@ -7,30 +7,32 @@ Name | Type | Description | Notes
**id** | **int** | Futures order ID | [optional] [readonly]
**user** | **int** | User ID | [optional] [readonly]
**create_time** | **float** | Creation time of order | [optional] [readonly]
+**update_time** | **float** | OrderUpdateTime | [optional] [readonly]
**finish_time** | **float** | Order finished time. Not returned if order is open | [optional] [readonly]
-**finish_as** | **str** | How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly]
-**status** | **str** | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly]
+**finish_as** | **str** | How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly]
+**status** | **str** | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly]
**contract** | **str** | Futures contract |
-**size** | **int** | Order size. Specify positive number to make a bid, and negative number to ask |
-**iceberg** | **int** | Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size | [optional]
-**price** | **str** | Order price. 0 for market order with `tif` set as `ioc` | [optional]
+**size** | **int** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. |
+**iceberg** | **int** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional]
+**price** | **str** | Order price. Price of 0 with `tif` set to `ioc` represents a market order. | [optional]
**close** | **bool** | Set as `true` to close the position, with `size` set to 0 | [optional] [default to False]
**is_close** | **bool** | Is the order to close position | [optional] [readonly]
**reduce_only** | **bool** | Set as `true` to be reduce-only order | [optional] [default to False]
**is_reduce_only** | **bool** | Is the order reduce-only | [optional] [readonly]
**is_liq** | **bool** | Is the order for liquidation | [optional] [readonly]
**tif** | **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']
-**left** | **int** | Size left to be traded | [optional] [readonly]
-**fill_price** | **str** | Fill price of the order | [optional] [readonly]
-**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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance | [optional]
+**left** | **int** | Unfilled quantity | [optional] [readonly]
+**fill_price** | **str** | Fill price | [optional] [readonly]
+**text** | **str** | Custom order 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(.) In addition to user-defined information, the following are internal reserved fields that identify the order source: - web: Web - api: API call - app: Mobile app - auto_deleveraging: Automatic deleveraging - liquidation: Forced liquidation of positions under the old classic mode - liq-xxx: a. Forced liquidation of positions under the new classic mode, including isolated margin, one-way cross margin, and non-hedged positions under two-way cross margin. b. Forced liquidation of isolated positions under the unified account single-currency margin mode - hedge-liq-xxx: Forced liquidation of hedged positions under the new classic mode two-way cross margin, i.e., simultaneously closing long and short positions - pm_liquidate: Forced liquidation under unified account multi-currency margin mode - comb_margin_liquidate: Forced liquidation under unified account portfolio margin mode - scm_liquidate: Forced liquidation of positions under unified account single-currency margin mode - insurance: Insurance | [optional]
**tkfr** | **str** | Taker fee | [optional] [readonly]
**mkfr** | **str** | Maker fee | [optional] [readonly]
-**refu** | **int** | Reference user ID | [optional] [readonly]
+**refu** | **int** | Referrer user ID | [optional] [readonly]
**auto_size** | **str** | Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 | [optional]
**stp_id** | **int** | Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group` | [optional] [readonly]
-**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
+**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled | [optional]
**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional] [readonly]
-**biz_info** | **str** | Additional information | [optional] [readonly]
+**limit_vip** | **int** | Counterparty user's VIP level for limit order fills. Current order will only match with orders whose VIP level is less than or equal to the specified level. Only 11~16 are supported; default is 0 | [optional]
+**pid** | **int** | Position ID | [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)
diff --git a/docs/FuturesOrderAmendment.md b/docs/FuturesOrderAmendment.md
index 72ff6ca..4e3bce2 100644
--- a/docs/FuturesOrderAmendment.md
+++ b/docs/FuturesOrderAmendment.md
@@ -4,10 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **int** | New order size, including filled part. - If new size is less than or equal to filled size, the order will be cancelled. - Order side must be identical to the original one. - Close order size cannot be changed. - For reduce only orders, increasing size may leads to other reduce only orders being cancelled. - If price is not changed, decreasing size will not change its precedence in order book, while increasing will move it to the last at current price. | [optional]
-**price** | **str** | New order price. | [optional]
-**amend_text** | **str** | Custom info during amending order | [optional]
-**biz_info** | **str** | Users can annotate this modification with information. | [optional]
-**bbo** | **str** | Users are able to modify the offer price manually. | [optional]
+**price** | **str** | New order price | [optional]
+**amend_text** | **str** | Custom info during order amendment | [optional]
+**text** | **str** | Internal users can modify information in the text field. | [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)
diff --git a/docs/FuturesOrderBook.md b/docs/FuturesOrderBook.md
index f8ed364..392c531 100644
--- a/docs/FuturesOrderBook.md
+++ b/docs/FuturesOrderBook.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
**id** | **int** | Order Book ID. Increases by 1 on every order book change. Set `with_id=true` to include this field in response | [optional]
**current** | **float** | Response data generation timestamp | [optional]
**update** | **float** | Order book changed timestamp | [optional]
-**asks** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | Asks order depth |
-**bids** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | Bids order depth |
+**asks** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | Ask Depth |
+**bids** | [**list[FuturesOrderBookItem]**](FuturesOrderBookItem.md) | Bid Depth |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/FuturesPositionCrossMode.md b/docs/FuturesPositionCrossMode.md
new file mode 100644
index 0000000..65b0f1d
--- /dev/null
+++ b/docs/FuturesPositionCrossMode.md
@@ -0,0 +1,11 @@
+# FuturesPositionCrossMode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mode** | **str** | Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode |
+**contract** | **str** | Futures market |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/FuturesPremiumIndex.md b/docs/FuturesPremiumIndex.md
index 73effc0..91041ef 100644
--- a/docs/FuturesPremiumIndex.md
+++ b/docs/FuturesPremiumIndex.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**t** | **float** | Unix timestamp in seconds | [optional]
**c** | **str** | Close price | [optional]
**h** | **str** | Highest price | [optional]
-**l** | **str** | Lowest price` | [optional]
+**l** | **str** | Lowest price | [optional]
**o** | **str** | Open price | [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)
diff --git a/docs/FuturesPriceTrigger.md b/docs/FuturesPriceTrigger.md
index 2ae520f..5fd4eeb 100644
--- a/docs/FuturesPriceTrigger.md
+++ b/docs/FuturesPriceTrigger.md
@@ -3,11 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**strategy_type** | **int** | How the order will be triggered - `0`: by price, which means the order will be triggered if price condition is satisfied - `1`: by price gap, which means the order will be triggered if gap of recent two prices of specified `price_type` are satisfied. Only `0` is supported currently | [optional]
-**price_type** | **int** | Price type. 0 - latest deal price, 1 - mark price, 2 - index price | [optional]
-**price** | **str** | Value of price on price triggered, or price gap on price gap triggered | [optional]
-**rule** | **int** | Trigger condition type - `1`: calculated price based on `strategy_type` and `price_type` >= `price` - `2`: calculated price based on `strategy_type` and `price_type` <= `price` | [optional]
-**expiration** | **int** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | [optional]
+**strategy_type** | **int** | Trigger Strategy - 0: Price trigger, triggered when price meets conditions - 1: Price spread trigger, i.e. the difference between the latest price specified in `price_type` and the second-last price Currently only supports 0 (latest transaction price) | [optional]
+**price_type** | **int** | Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price | [optional]
+**price** | **str** | Price value for price trigger, or spread value for spread trigger | [optional]
+**rule** | **int** | Price Condition Type - 1: Trigger when the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price`, while Trigger.Price must > last_price - 2: Trigger when the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price`, and Trigger.Price must < last_price | [optional]
+**expiration** | **int** | Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout | [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)
diff --git a/docs/FuturesPriceTriggeredOrder.md b/docs/FuturesPriceTriggeredOrder.md
index 84f4ef9..d28e980 100644
--- a/docs/FuturesPriceTriggeredOrder.md
+++ b/docs/FuturesPriceTriggeredOrder.md
@@ -1,6 +1,6 @@
# FuturesPriceTriggeredOrder
-Futures order details
+Futures price-triggered order details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -8,14 +8,14 @@ Name | Type | Description | Notes
**trigger** | [**FuturesPriceTrigger**](FuturesPriceTrigger.md) | |
**id** | **int** | Auto order ID | [optional] [readonly]
**user** | **int** | User ID | [optional] [readonly]
-**create_time** | **float** | Creation time | [optional] [readonly]
-**finish_time** | **float** | Finished time | [optional] [readonly]
-**trade_id** | **int** | ID of the newly created order on condition triggered | [optional] [readonly]
-**status** | **str** | Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order | [optional] [readonly]
-**finish_as** | **str** | How order is finished | [optional] [readonly]
-**reason** | **str** | Additional remarks on how the order was finished | [optional] [readonly]
-**order_type** | **str** | Take-profit/stop-loss types, which include: - `close-long-order`: order take-profit/stop-loss, close long position - `close-short-order`: order take-profit/stop-loss, close short position - `close-long-position`: position take-profit/stop-loss, close long position - `close-short-position`: position take-profit/stop-loss, close short position - `plan-close-long-position`: position planned take-profit/stop-loss, close long position - `plan-close-short-position`: position planned take-profit/stop-loss, close short position The order take-profit/stop-loss can not be passed by request. These two types are read only. | [optional]
-**me_order_id** | **int** | Corresponding order ID of order take-profit/stop-loss. | [optional] [readonly]
+**create_time** | **float** | Created time | [optional] [readonly]
+**finish_time** | **float** | End time | [optional] [readonly]
+**trade_id** | **int** | ID of the order created after trigger | [optional] [readonly]
+**status** | **str** | Order status - `open`: Active - `finished`: Finished - `inactive`: Inactive, only applies to order take-profit/stop-loss - `invalid`: Invalid, only applies to order take-profit/stop-loss | [optional] [readonly]
+**finish_as** | **str** | Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired | [optional] [readonly]
+**reason** | **str** | Additional description of how the order was completed | [optional] [readonly]
+**order_type** | **str** | Types of take-profit and stop-loss orders, including: - `close-long-order`: Order take-profit/stop-loss, close long position - `close-short-order`: Order take-profit/stop-loss, close short position - `close-long-position`: Position take-profit/stop-loss, used to close all long positions - `close-short-position`: Position take-profit/stop-loss, used to close all short positions - `plan-close-long-position`: Position plan take-profit/stop-loss, used to close all or partial long positions - `plan-close-short-position`: Position plan take-profit/stop-loss, used to close all or partial short positions The two types of order take-profit/stop-loss are read-only and cannot be passed in requests | [optional]
+**me_order_id** | **int** | Corresponding order ID for order take-profit/stop-loss orders | [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)
diff --git a/docs/FuturesRiskLimitTier.md b/docs/FuturesRiskLimitTier.md
new file mode 100644
index 0000000..10b759a
--- /dev/null
+++ b/docs/FuturesRiskLimitTier.md
@@ -0,0 +1,16 @@
+# FuturesRiskLimitTier
+
+Information for each tier of the gradient risk limit table
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tier** | **int** | Tier | [optional]
+**risk_limit** | **str** | Position risk limit | [optional]
+**initial_rate** | **str** | Initial margin rate | [optional]
+**maintenance_rate** | **str** | Maintenance margin rate | [optional]
+**leverage_max** | **str** | Maximum leverage | [optional]
+**deduction** | **str** | Maintenance margin quick calculation deduction amount | [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)
+
+
diff --git a/docs/FuturesTicker.md b/docs/FuturesTicker.md
index 5e26cdc..d0f8511 100644
--- a/docs/FuturesTicker.md
+++ b/docs/FuturesTicker.md
@@ -5,27 +5,30 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**contract** | **str** | Futures contract | [optional]
**last** | **str** | Last trading price | [optional]
-**change_percentage** | **str** | Change percentage. | [optional]
+**change_percentage** | **str** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional]
**total_size** | **str** | Contract total size | [optional]
-**low_24h** | **str** | Lowest trading price in recent 24h | [optional]
-**high_24h** | **str** | Highest trading price in recent 24h | [optional]
-**volume_24h** | **str** | Trade size in recent 24h | [optional]
-**volume_24h_btc** | **str** | Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
-**volume_24h_usd** | **str** | Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
-**volume_24h_base** | **str** | Trade volume in recent 24h, in base currency | [optional]
-**volume_24h_quote** | **str** | Trade volume in recent 24h, in quote currency | [optional]
-**volume_24h_settle** | **str** | Trade volume in recent 24h, in settle currency | [optional]
+**low_24h** | **str** | 24-hour lowest price | [optional]
+**high_24h** | **str** | 24-hour highest price | [optional]
+**volume_24h** | **str** | 24-hour trading volume | [optional]
+**volume_24h_btc** | **str** | 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
+**volume_24h_usd** | **str** | 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional]
+**volume_24h_base** | **str** | 24-hour trading volume in base currency | [optional]
+**volume_24h_quote** | **str** | 24-hour trading volume in quote currency | [optional]
+**volume_24h_settle** | **str** | 24-hour trading volume in settle currency | [optional]
**mark_price** | **str** | Recent mark price | [optional]
**funding_rate** | **str** | Funding rate | [optional]
-**funding_rate_indicative** | **str** | Indicative Funding rate in next period | [optional]
+**funding_rate_indicative** | **str** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional]
**index_price** | **str** | Index price | [optional]
**quanto_base_rate** | **str** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional]
-**basis_rate** | **str** | Basis rate | [optional]
-**basis_value** | **str** | Basis value | [optional]
**lowest_ask** | **str** | Recent lowest ask | [optional]
**lowest_size** | **str** | The latest seller's lowest price order quantity | [optional]
**highest_bid** | **str** | Recent highest bid | [optional]
**highest_size** | **str** | The latest buyer's highest price order volume | [optional]
+**change_utc0** | **str** | Percentage change at utc0. Negative values indicate a drop, e.g., -7.45% | [optional]
+**change_utc8** | **str** | Percentage change at utc8. Negative values indicate a drop, e.g., -7.45% | [optional]
+**change_price** | **str** | 24h change amount. Negative values indicate a drop, e.g., -7.45 | [optional]
+**change_utc0_price** | **str** | Change amount at utc0. Negative values indicate a drop, e.g., -7.45 | [optional]
+**change_utc8_price** | **str** | Change amount at utc8. Negative values indicate a drop, e.g., -7.45 | [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)
diff --git a/docs/FuturesTrade.md b/docs/FuturesTrade.md
index 57e99c6..af3b9fe 100644
--- a/docs/FuturesTrade.md
+++ b/docs/FuturesTrade.md
@@ -3,13 +3,13 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Trade ID | [optional]
-**create_time** | **float** | Trading time | [optional]
-**create_time_ms** | **float** | Trading time, with milliseconds set to 3 decimal places. | [optional]
+**id** | **int** | Fill ID | [optional]
+**create_time** | **float** | Fill Time | [optional]
+**create_time_ms** | **float** | Trade time, with millisecond precision to 3 decimal places | [optional]
**contract** | **str** | Futures contract | [optional]
**size** | **int** | Trading size | [optional]
-**price** | **str** | Trading price (quote currency) | [optional]
-**is_internal** | **bool** | Whether internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned. | [optional]
+**price** | **str** | Trade price (quote currency) | [optional]
+**is_internal** | **bool** | Whether it is an internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the trade price may deviate from the market, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned | [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)
diff --git a/docs/InlineObject.md b/docs/InlineObject.md
index 9d442b2..dccf5f1 100644
--- a/docs/InlineObject.md
+++ b/docs/InlineObject.md
@@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**enabled** | **bool** | Whether GT fee discount is used |
+**mode** | **str** | Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode |
+**contract** | **str** | Futures market |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/InlineResponse200.md b/docs/InlineResponse200.md
index ce61e58..30030f5 100644
--- a/docs/InlineResponse200.md
+++ b/docs/InlineResponse200.md
@@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**tx_id** | **str** | Order id | [optional]
-**status** | **str** | Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) | [optional]
+**time** | **int** | | [optional]
+**value** | **str** | | [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)
diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md
index 93cc14c..31a5f58 100644
--- a/docs/InlineResponse2001.md
+++ b/docs/InlineResponse2001.md
@@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**enabled** | **bool** | Whether GT fee discount is used | [optional]
+**currency** | **str** | | [optional]
+**est_rate** | **str** | Unconverted percentage | [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)
diff --git a/docs/LedgerRecord.md b/docs/LedgerRecord.md
index 215dba9..869f179 100644
--- a/docs/LedgerRecord.md
+++ b/docs/LedgerRecord.md
@@ -5,13 +5,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Record ID | [optional] [readonly]
**txid** | **str** | Hash record of the withdrawal | [optional] [readonly]
-**withdraw_order_id** | **str** | Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional]
+**withdraw_order_id** | **str** | User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional]
**timestamp** | **str** | Operation time | [optional] [readonly]
-**amount** | **str** | Currency amount |
+**amount** | **str** | Token amount |
**currency** | **str** | Currency name |
**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
-**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]
+**withdraw_id** | **str** | Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled | [optional]
+**asset_class** | **str** | Withdrawal record currency type, empty by default. Supports users to query withdrawal records in main area and innovation area on demand. Valid values: SPOT, PILOT SPOT: Main area PILOT: Innovation area | [optional]
+**status** | **str** | Transaction status - DONE: Completed - CANCEL: Cancelled - REQUEST: Requesting - MANUAL: Pending manual review - BCODE: GateCode operation - EXTPEND: Sent, waiting for confirmation - FAIL: Failed on chain, waiting for confirmation - INVALID: Invalid order - VERIFY: Verifying - PROCES: Processing - PEND: Processing - DMOVE: Pending manual review - REVIEW: Under review | [optional] [readonly]
**chain** | **str** | Name of the chain used in withdrawals |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/LiquidateOrder.md b/docs/LiquidateOrder.md
index cc2d78e..df396e0 100644
--- a/docs/LiquidateOrder.md
+++ b/docs/LiquidateOrder.md
@@ -1,14 +1,14 @@
# LiquidateOrder
-Liquidate Order detail
+Spot liquidation order details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**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]
+**text** | **str** | Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) | [optional]
**currency_pair** | **str** | Currency pair |
**amount** | **str** | Trade amount |
**price** | **str** | Order price |
-**action_mode** | **str** | Processing Mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request, and it is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) | [optional]
+**action_mode** | **str** | Processing mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request and is not included in the response `ACK`: Asynchronous mode, only returns key order fields `RESULT`: No liquidation information `FULL`: Full mode (default) | [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)
diff --git a/docs/Loan.md b/docs/Loan.md
deleted file mode 100644
index dea5d2c..0000000
--- a/docs/Loan.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# Loan
-
-Margin loan details
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** | Loan ID | [optional] [readonly]
-**create_time** | **str** | Creation time | [optional] [readonly]
-**expire_time** | **str** | Repay time of the loan. No value will be returned for lending loan | [optional] [readonly]
-**status** | **str** | Loan status open - not fully loaned loaned - all loaned out for lending loan; loaned in for borrowing side finished - loan is finished, either being all repaid or cancelled by the lender auto_repaid - automatically repaid by the system | [optional] [readonly]
-**side** | **str** | Loan side |
-**currency** | **str** | Loan currency |
-**rate** | **str** | Loan rate. Only rates in [0.0001, 0.01] are supported. Not required in lending. Market rate calculated from recent rates will be used if not set | [optional]
-**amount** | **str** | Loan amount |
-**days** | **int** | Loan days. Only 10 is supported for now | [optional]
-**auto_renew** | **bool** | Whether to auto renew the loan upon expiration | [optional] [default to False]
-**currency_pair** | **str** | Currency pair. Required if borrowing | [optional]
-**left** | **str** | Amount not lent out yet | [optional] [readonly]
-**repaid** | **str** | Repaid amount | [optional] [readonly]
-**paid_interest** | **str** | Repaid interest | [optional] [readonly]
-**unpaid_interest** | **str** | Outstanding interest yet to be paid | [optional] [readonly]
-**fee_rate** | **str** | Loan fee rate | [optional]
-**orig_id** | **str** | Original loan ID of the loan if auto-renewed, otherwise equals to id | [optional]
-**text** | **str** | User defined custom ID | [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)
-
-
diff --git a/docs/LoanPatch.md b/docs/LoanPatch.md
deleted file mode 100644
index 0ba0c58..0000000
--- a/docs/LoanPatch.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# LoanPatch
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency** | **str** | Loan currency |
-**side** | **str** | Loan side. Possible values are `lend` and `borrow`. For `LoanRecord` patching, only `lend` is supported |
-**auto_renew** | **bool** | Auto renew |
-**currency_pair** | **str** | Currency pair. Required if borrowing | [optional]
-**loan_id** | **str** | Loan ID. Required for `LoanRecord` patching | [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)
-
-
diff --git a/docs/LoanRecord.md b/docs/LoanRecord.md
deleted file mode 100644
index d821108..0000000
--- a/docs/LoanRecord.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# LoanRecord
-
-Margin loaned record details
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** | Loan record ID | [optional]
-**loan_id** | **str** | Loan ID the record belongs to | [optional]
-**create_time** | **str** | Loan time | [optional]
-**expire_time** | **str** | Expiration time | [optional]
-**status** | **str** | Loan record status | [optional]
-**borrow_user_id** | **str** | Garbled user ID | [optional]
-**currency** | **str** | Loan currency | [optional]
-**rate** | **str** | Loan rate | [optional]
-**amount** | **str** | Loan amount | [optional]
-**days** | **int** | Loan days | [optional]
-**auto_renew** | **bool** | Whether the record will auto renew on expiration | [optional] [default to False]
-**repaid** | **str** | Repaid amount | [optional]
-**paid_interest** | **str** | Repaid interest | [optional] [readonly]
-**unpaid_interest** | **str** | Outstanding interest yet to be paid | [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)
-
-
diff --git a/docs/MarginAccount.md b/docs/MarginAccount.md
index 826fd90..265656e 100644
--- a/docs/MarginAccount.md
+++ b/docs/MarginAccount.md
@@ -1,12 +1,15 @@
# MarginAccount
-Margin account detail. `base` refers to base currency, while `quotes to quote currency
+Margin account information for a trading pair. `base` corresponds to base currency account information, `quote` corresponds to quote currency account information
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_pair** | **str** | Currency pair | [optional]
-**locked** | **bool** | Whether account is locked | [optional]
-**risk** | **str** | Current risk rate of margin account | [optional]
+**account_type** | **str** | Account type: risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated | [optional]
+**leverage** | **str** | User's current market leverage multiplier | [optional]
+**locked** | **bool** | Whether the account is locked | [optional]
+**risk** | **str** | Current risk rate of the margin account (returned when the account is a risk rate account) | [optional]
+**mmr** | **str** | Leveraged Account Current Maintenance Margin Rate (returned when the Account is Account) | [optional]
**base** | [**MarginAccountCurrency**](MarginAccountCurrency.md) | | [optional]
**quote** | [**MarginAccountCurrency**](MarginAccountCurrency.md) | | [optional]
diff --git a/docs/MarginAccountBook.md b/docs/MarginAccountBook.md
index 9c62f12..f5f8c61 100644
--- a/docs/MarginAccountBook.md
+++ b/docs/MarginAccountBook.md
@@ -4,13 +4,13 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Balance change record ID | [optional]
-**time** | **str** | Balance changed timestamp | [optional]
+**time** | **str** | Account change timestamp | [optional]
**time_ms** | **int** | The timestamp of the change (in milliseconds) | [optional]
**currency** | **str** | Currency changed | [optional]
-**currency_pair** | **str** | Account currency pair | [optional]
+**currency_pair** | **str** | Account trading pair | [optional]
**change** | **str** | Amount changed. Positive value means transferring in, while negative out | [optional]
**balance** | **str** | Balance after change | [optional]
-**type** | **str** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional]
+**type** | **str** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [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)
diff --git a/docs/MarginAccountCurrency.md b/docs/MarginAccountCurrency.md
index 01f80ab..edb06b6 100644
--- a/docs/MarginAccountCurrency.md
+++ b/docs/MarginAccountCurrency.md
@@ -1,14 +1,14 @@
# MarginAccountCurrency
-Account currency details
+Currency account information
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional]
-**available** | **str** | Amount suitable for margin trading. | [optional]
-**locked** | **str** | Locked amount, used in margin trading | [optional]
-**borrowed** | **str** | Borrowed amount | [optional]
-**interest** | **str** | Unpaid interests | [optional]
+**available** | **str** | Amount available for margin trading, available = margin + borrowed | [optional]
+**locked** | **str** | Frozen funds, such as amounts already placed in margin market for order trading | [optional]
+**borrowed** | **str** | Borrowed funds | [optional]
+**interest** | **str** | Unpaid interest | [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)
diff --git a/docs/MarginApi.md b/docs/MarginApi.md
index b059a79..935da57 100644
--- a/docs/MarginApi.md
+++ b/docs/MarginApi.md
@@ -5,39 +5,17 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list_margin_accounts**](MarginApi.md#list_margin_accounts) | **GET** /margin/accounts | Margin account list
-[**list_margin_account_book**](MarginApi.md#list_margin_account_book) | **GET** /margin/account_book | List margin account balance change history
+[**list_margin_account_book**](MarginApi.md#list_margin_account_book) | **GET** /margin/account_book | Query margin account balance change history
[**list_funding_accounts**](MarginApi.md#list_funding_accounts) | **GET** /margin/funding_accounts | Funding account list
-[**get_auto_repay_status**](MarginApi.md#get_auto_repay_status) | **GET** /margin/auto_repay | Retrieve user auto repayment setting
-[**set_auto_repay**](MarginApi.md#set_auto_repay) | **POST** /margin/auto_repay | Update user's auto repayment setting
-[**get_margin_transferable**](MarginApi.md#get_margin_transferable) | **GET** /margin/transferable | Get the max transferable amount for a specific margin currency
-[**list_margin_currency_pairs**](MarginApi.md#list_margin_currency_pairs) | **GET** /margin/currency_pairs | List all supported currency pairs supported in margin trading(Deprecated)
-[**get_margin_currency_pair**](MarginApi.md#get_margin_currency_pair) | **GET** /margin/currency_pairs/{currency_pair} | Query one single margin currency pair(Deprecated)
-[**list_funding_book**](MarginApi.md#list_funding_book) | **GET** /margin/funding_book | Order book of lending loans(Deprecated)
-[**list_loans**](MarginApi.md#list_loans) | **GET** /margin/loans | List all loans(Deprecated)
-[**create_loan**](MarginApi.md#create_loan) | **POST** /margin/loans | Lend or borrow(Deprecated)
-[**merge_loans**](MarginApi.md#merge_loans) | **POST** /margin/merged_loans | Merge multiple lending loans(Deprecated)
-[**get_loan**](MarginApi.md#get_loan) | **GET** /margin/loans/{loan_id} | Retrieve one single loan detail(Deprecated)
-[**cancel_loan**](MarginApi.md#cancel_loan) | **DELETE** /margin/loans/{loan_id} | Cancel lending loan(Deprecated)
-[**update_loan**](MarginApi.md#update_loan) | **PATCH** /margin/loans/{loan_id} | Modify a loan(Deprecated)
-[**list_loan_repayments**](MarginApi.md#list_loan_repayments) | **GET** /margin/loans/{loan_id}/repayment | List loan repayment records(Deprecated)
-[**repay_loan**](MarginApi.md#repay_loan) | **POST** /margin/loans/{loan_id}/repayment | Repay a loan(Deprecated)
-[**list_loan_records**](MarginApi.md#list_loan_records) | **GET** /margin/loan_records | List repayment records of a specific loan(Deprecated)
-[**get_loan_record**](MarginApi.md#get_loan_record) | **GET** /margin/loan_records/{loan_record_id} | Get one single loan record(Deprecated)
-[**update_loan_record**](MarginApi.md#update_loan_record) | **PATCH** /margin/loan_records/{loan_record_id} | Modify a loan record(Deprecated)
-[**get_margin_borrowable**](MarginApi.md#get_margin_borrowable) | **GET** /margin/borrowable | Get the max borrowable amount for a specific margin currency(Deprecated)
-[**list_cross_margin_currencies**](MarginApi.md#list_cross_margin_currencies) | **GET** /margin/cross/currencies | Currencies supported by cross margin.
-[**get_cross_margin_currency**](MarginApi.md#get_cross_margin_currency) | **GET** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin
-[**get_cross_margin_account**](MarginApi.md#get_cross_margin_account) | **GET** /margin/cross/accounts | Retrieve cross margin account
-[**list_cross_margin_account_book**](MarginApi.md#list_cross_margin_account_book) | **GET** /margin/cross/account_book | Retrieve cross margin account change history
-[**list_cross_margin_loans**](MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | List cross margin borrow history
-[**create_cross_margin_loan**](MarginApi.md#create_cross_margin_loan) | **POST** /margin/cross/loans | Create a cross margin borrow loan
-[**get_cross_margin_loan**](MarginApi.md#get_cross_margin_loan) | **GET** /margin/cross/loans/{loan_id} | Retrieve single borrow loan detail
-[**list_cross_margin_repayments**](MarginApi.md#list_cross_margin_repayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments
-[**repay_cross_margin_loan**](MarginApi.md#repay_cross_margin_loan) | **POST** /margin/cross/repayments | Cross margin repayments
-[**get_cross_margin_interest_records**](MarginApi.md#get_cross_margin_interest_records) | **GET** /margin/cross/interest_records | Interest records for the cross margin account
-[**get_cross_margin_transferable**](MarginApi.md#get_cross_margin_transferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency
-[**get_cross_margin_estimate_rate**](MarginApi.md#get_cross_margin_estimate_rate) | **GET** /margin/cross/estimate_rate | Estimated interest rates
-[**get_cross_margin_borrowable**](MarginApi.md#get_cross_margin_borrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency
+[**get_auto_repay_status**](MarginApi.md#get_auto_repay_status) | **GET** /margin/auto_repay | Query user auto repayment settings
+[**set_auto_repay**](MarginApi.md#set_auto_repay) | **POST** /margin/auto_repay | Update user auto repayment settings
+[**get_margin_transferable**](MarginApi.md#get_margin_transferable) | **GET** /margin/transferable | Get maximum transferable amount for isolated margin
+[**get_user_margin_tier**](MarginApi.md#get_user_margin_tier) | **GET** /margin/user/loan_margin_tiers | Query user's own leverage lending tiers in current market
+[**get_market_margin_tier**](MarginApi.md#get_market_margin_tier) | **GET** /margin/loan_margin_tiers | Query current market leverage lending tiers
+[**set_user_market_leverage**](MarginApi.md#set_user_market_leverage) | **POST** /margin/leverage/user_market_setting | Set user market leverage multiplier
+[**list_margin_user_account**](MarginApi.md#list_margin_user_account) | **GET** /margin/user/account | Query user's isolated margin account list
+[**list_cross_margin_loans**](MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | Query cross margin borrow history (deprecated)
+[**list_cross_margin_repayments**](MarginApi.md#list_cross_margin_repayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated)
# **list_margin_accounts**
@@ -103,16 +81,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_margin_account_book**
> list[MarginAccountBook] list_margin_account_book(currency=currency, currency_pair=currency_pair, type=type, _from=_from, to=to, page=page, limit=limit)
-List margin account balance change history
+Query margin account balance change history
-Only transferals from and to margin account are provided for now. Time range allows 30 days at most
+Currently only provides transfer history to and from margin accounts. Query time range cannot exceed 30 days
### Example
@@ -138,16 +116,16 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'currency_example' # str | List records related to specified currency only. If specified, `currency_pair` is also required. (optional)
-currency_pair = 'currency_pair_example' # str | List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional)
-type = 'lend' # str | Only retrieve changes of the specified type. All types will be returned if not specified. (optional)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
+currency = 'currency_example' # str | Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified. (optional)
+currency_pair = 'currency_pair_example' # str | Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified (optional)
+type = 'lend' # str | Query by specified account change type. If not specified, all change types will be included. (optional)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
try:
- # List margin account balance change history
+ # Query margin account balance change history
api_response = api_instance.list_margin_account_book(currency=currency, currency_pair=currency_pair, type=type, _from=_from, to=to, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -160,13 +138,13 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| List records related to specified currency only. If specified, `currency_pair` is also required. | [optional]
- **currency_pair** | **str**| List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided | [optional]
- **type** | **str**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **currency** | **str**| Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified. | [optional]
+ **currency_pair** | **str**| Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified | [optional]
+ **type** | **str**| Query by specified account change type. If not specified, all change types will be included. | [optional]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
### Return type
@@ -184,7 +162,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -217,7 +195,7 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
try:
# Funding account list
@@ -233,7 +211,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
### Return type
@@ -251,14 +229,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_auto_repay_status**
> AutoRepaySetting get_auto_repay_status()
-Retrieve user auto repayment setting
+Query user auto repayment settings
### Example
@@ -286,7 +264,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.MarginApi(api_client)
try:
- # Retrieve user auto repayment setting
+ # Query user auto repayment settings
api_response = api_instance.get_auto_repay_status()
print(api_response)
except GateApiException as ex:
@@ -314,14 +292,14 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Current auto repayment setting | - |
+**200** | User's current auto repayment settings | - |
[[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)
# **set_auto_repay**
> AutoRepaySetting set_auto_repay(status)
-Update user's auto repayment setting
+Update user auto repayment settings
### Example
@@ -347,10 +325,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-status = 'on' # str | New auto repayment status. `on` - enabled, `off` - disabled
+status = 'on' # str | Whether to enable auto repayment: `on` - enabled, `off` - disabled
try:
- # Update user's auto repayment setting
+ # Update user auto repayment settings
api_response = api_instance.set_auto_repay(status)
print(api_response)
except GateApiException as ex:
@@ -363,7 +341,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **status** | **str**| New auto repayment status. `on` - enabled, `off` - disabled |
+ **status** | **str**| Whether to enable auto repayment: `on` - enabled, `off` - disabled |
### Return type
@@ -381,14 +359,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Current auto repayment setting | - |
+**200** | User's current auto repayment settings | - |
[[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)
# **get_margin_transferable**
> MarginTransferable get_margin_transferable(currency, currency_pair=currency_pair)
-Get the max transferable amount for a specific margin currency
+Get maximum transferable amount for isolated margin
### Example
@@ -414,11 +392,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currency = 'BTC' # str | Query by specified currency name
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
try:
- # Get the max transferable amount for a specific margin currency
+ # Get maximum transferable amount for isolated margin
api_response = api_instance.get_margin_transferable(currency, currency_pair=currency_pair)
print(api_response)
except GateApiException as ex:
@@ -431,7 +409,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currency** | **str**| Query by specified currency name |
**currency_pair** | **str**| Currency pair | [optional]
### Return type
@@ -450,1430 +428,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **list_margin_currency_pairs**
-> list[MarginCurrencyPair] list_margin_currency_pairs()
+# **get_user_margin_tier**
+> list[MarginLeverageTier] get_user_margin_tier(currency_pair)
-List all supported currency pairs supported in margin trading(Deprecated)
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-
-try:
- # List all supported currency pairs supported in margin trading(Deprecated)
- api_response = api_instance.list_margin_currency_pairs()
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_margin_currency_pairs: %s\n" % e)
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**list[MarginCurrencyPair]**](MarginCurrencyPair.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **get_margin_currency_pair**
-> MarginCurrencyPair get_margin_currency_pair(currency_pair)
-
-Query one single margin currency pair(Deprecated)
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency_pair = 'BTC_USDT' # str | Margin currency pair
-
-try:
- # Query one single margin currency pair(Deprecated)
- api_response = api_instance.get_margin_currency_pair(currency_pair)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_margin_currency_pair: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Margin currency pair |
-
-### Return type
-
-[**MarginCurrencyPair**](MarginCurrencyPair.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
-# **list_funding_book**
-> list[FundingBookItem] list_funding_book(currency)
-
-Order book of lending loans(Deprecated)
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
-
-try:
- # Order book of lending loans(Deprecated)
- api_response = api_instance.list_funding_book(currency)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_funding_book: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
-
-### Return type
-
-[**list[FundingBookItem]**](FundingBookItem.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Order book retrieved | - |
-
-[[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)
-
-# **list_loans**
-> list[Loan] list_loans(status, side, currency=currency, currency_pair=currency_pair, sort_by=sort_by, reverse_sort=reverse_sort, page=page, limit=limit)
-
-List all loans(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-status = 'open' # str | Loan status
-side = 'lend' # str | Lend or borrow
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
-currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-sort_by = 'rate' # str | Specify which field is used to sort. `create_time` or `rate` is supported. Default to `create_time` (optional)
-reverse_sort = false # bool | Whether to sort in descending order. Default to `true` (optional)
-page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-
-try:
- # List all loans(Deprecated)
- api_response = api_instance.list_loans(status, side, currency=currency, currency_pair=currency_pair, sort_by=sort_by, reverse_sort=reverse_sort, page=page, limit=limit)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_loans: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **status** | **str**| Loan status |
- **side** | **str**| Lend or borrow |
- **currency** | **str**| Retrieve data of the specified currency | [optional]
- **currency_pair** | **str**| Currency pair | [optional]
- **sort_by** | **str**| Specify which field is used to sort. `create_time` or `rate` is supported. Default to `create_time` | [optional]
- **reverse_sort** | **bool**| Whether to sort in descending order. Default to `true` | [optional]
- **page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
-
-### Return type
-
-[**list[Loan]**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **create_loan**
-> Loan create_loan(loan)
-
-Lend or borrow(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan = gate_api.Loan() # Loan |
-
-try:
- # Lend or borrow(Deprecated)
- api_response = api_instance.create_loan(loan)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->create_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan** | [**Loan**](Loan.md)| |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**201** | Loan created | - |
-
-[[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)
-
-# **merge_loans**
-> Loan merge_loans(currency, ids)
-
-Merge multiple lending loans(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
-ids = '123,234,345' # str | A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request
-
-try:
- # Merge multiple lending loans(Deprecated)
- api_response = api_instance.merge_loans(currency, ids)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->merge_loans: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
- **ids** | **str**| A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**201** | Loans merged | - |
-
-[[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)
-
-# **get_loan**
-> Loan get_loan(loan_id, side)
-
-Retrieve one single loan detail(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-side = 'lend' # str | Lend or borrow
-
-try:
- # Retrieve one single loan detail(Deprecated)
- api_response = api_instance.get_loan(loan_id, side)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
- **side** | **str**| Lend or borrow |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **cancel_loan**
-> Loan cancel_loan(loan_id, currency)
-
-Cancel lending loan(Deprecated)
-
-Only lent loans can be cancelled
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-currency = 'BTC' # str | Retrieve data of the specified currency
-
-try:
- # Cancel lending loan(Deprecated)
- api_response = api_instance.cancel_loan(loan_id, currency)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->cancel_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
- **currency** | **str**| Retrieve data of the specified currency |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Order cancelled | - |
-
-[[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)
-
-# **update_loan**
-> Loan update_loan(loan_id, loan_patch)
-
-Modify a loan(Deprecated)
-
-Only `auto_renew` modification is supported currently
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-loan_patch = gate_api.LoanPatch() # LoanPatch |
-
-try:
- # Modify a loan(Deprecated)
- api_response = api_instance.update_loan(loan_id, loan_patch)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->update_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
- **loan_patch** | [**LoanPatch**](LoanPatch.md)| |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Updated | - |
-
-[[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)
-
-# **list_loan_repayments**
-> list[Repayment] list_loan_repayments(loan_id)
-
-List loan repayment records(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-
-try:
- # List loan repayment records(Deprecated)
- api_response = api_instance.list_loan_repayments(loan_id)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_loan_repayments: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
-
-### Return type
-
-[**list[Repayment]**](Repayment.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **repay_loan**
-> Loan repay_loan(loan_id, repay_request)
-
-Repay a loan(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-repay_request = gate_api.RepayRequest() # RepayRequest |
-
-try:
- # Repay a loan(Deprecated)
- api_response = api_instance.repay_loan(loan_id, repay_request)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->repay_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
- **repay_request** | [**RepayRequest**](RepayRequest.md)| |
-
-### Return type
-
-[**Loan**](Loan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Loan repaid | - |
-
-[[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)
-
-# **list_loan_records**
-> list[LoanRecord] list_loan_records(loan_id, status=status, page=page, limit=limit)
-
-List repayment records of a specific loan(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Loan ID
-status = 'loaned' # str | Loan record status (optional)
-page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-
-try:
- # List repayment records of a specific loan(Deprecated)
- api_response = api_instance.list_loan_records(loan_id, status=status, page=page, limit=limit)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_loan_records: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Loan ID |
- **status** | **str**| Loan record status | [optional]
- **page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
-
-### Return type
-
-[**list[LoanRecord]**](LoanRecord.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **get_loan_record**
-> LoanRecord get_loan_record(loan_record_id, loan_id)
-
-Get one single loan record(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_record_id = '12345' # str | Loan record ID
-loan_id = '12345' # str | Loan ID
-
-try:
- # Get one single loan record(Deprecated)
- api_response = api_instance.get_loan_record(loan_record_id, loan_id)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_loan_record: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_record_id** | **str**| Loan record ID |
- **loan_id** | **str**| Loan ID |
-
-### Return type
-
-[**LoanRecord**](LoanRecord.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Detail retrieved | - |
-
-[[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)
-
-# **update_loan_record**
-> LoanRecord update_loan_record(loan_record_id, loan_patch)
-
-Modify a loan record(Deprecated)
-
-Only `auto_renew` modification is supported currently
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-loan_record_id = '12345' # str | Loan record ID
-loan_patch = gate_api.LoanPatch() # LoanPatch |
-
-try:
- # Modify a loan record(Deprecated)
- api_response = api_instance.update_loan_record(loan_record_id, loan_patch)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->update_loan_record: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **loan_record_id** | **str**| Loan record ID |
- **loan_patch** | [**LoanPatch**](LoanPatch.md)| |
-
-### Return type
-
-[**LoanRecord**](LoanRecord.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Loan record updated | - |
-
-[[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)
-
-# **get_margin_borrowable**
-> MarginBorrowable get_margin_borrowable(currency, currency_pair=currency_pair)
-
-Get the max borrowable amount for a specific margin currency(Deprecated)
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
-currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-
-try:
- # Get the max borrowable amount for a specific margin currency(Deprecated)
- api_response = api_instance.get_margin_borrowable(currency, currency_pair=currency_pair)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_margin_borrowable: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
- **currency_pair** | **str**| Currency pair | [optional]
-
-### Return type
-
-[**MarginBorrowable**](MarginBorrowable.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
-# **list_cross_margin_currencies**
-> list[CrossMarginCurrency] list_cross_margin_currencies()
-
-Currencies supported by cross margin.
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-
-try:
- # Currencies supported by cross margin.
- api_response = api_instance.list_cross_margin_currencies()
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_cross_margin_currencies: %s\n" % e)
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**list[CrossMarginCurrency]**](CrossMarginCurrency.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **get_cross_margin_currency**
-> CrossMarginCurrency get_cross_margin_currency(currency)
-
-Retrieve detail of one single currency supported by cross margin
-
-### Example
-
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Currency name
-
-try:
- # Retrieve detail of one single currency supported by cross margin
- api_response = api_instance.get_cross_margin_currency(currency)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_currency: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Currency name |
-
-### Return type
-
-[**CrossMarginCurrency**](CrossMarginCurrency.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
-# **get_cross_margin_account**
-> CrossMarginAccount get_cross_margin_account()
-
-Retrieve cross margin account
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-
-try:
- # Retrieve cross margin account
- api_response = api_instance.get_cross_margin_account()
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_account: %s\n" % e)
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**CrossMarginAccount**](CrossMarginAccount.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
-# **list_cross_margin_account_book**
-> list[CrossMarginAccountBook] list_cross_margin_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type)
-
-Retrieve cross margin account change history
-
-记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'currency_example' # str | Filter by currency (optional)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
-page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-type = 'borrow' # str | Only retrieve changes of the specified type. All types will be returned if not specified. (optional)
-
-try:
- # Retrieve cross margin account change history
- api_response = api_instance.list_cross_margin_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_cross_margin_account_book: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Filter by currency | [optional]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **type** | **str**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional]
-
-### Return type
-
-[**list[CrossMarginAccountBook]**](CrossMarginAccountBook.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | List retrieved | - |
-
-[[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)
-
-# **list_cross_margin_loans**
-> list[CrossMarginLoan] list_cross_margin_loans(status, currency=currency, limit=limit, offset=offset, reverse=reverse)
-
-List cross margin borrow history
-
-Sort by creation time in descending order by default. Set `reverse=false` to return ascending results.
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-status = 56 # int | Filter by status. Supported values are 2 and 3. (deprecated.)
-currency = 'currency_example' # str | Filter by currency (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-reverse = True # bool | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional) (default to True)
-
-try:
- # List cross margin borrow history
- api_response = api_instance.list_cross_margin_loans(status, currency=currency, limit=limit, offset=offset, reverse=reverse)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->list_cross_margin_loans: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **status** | **int**| Filter by status. Supported values are 2 and 3. (deprecated.) |
- **currency** | **str**| Filter by currency | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **reverse** | **bool**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to True]
-
-### Return type
-
-[**list[CrossMarginLoan]**](CrossMarginLoan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
-
-# **create_cross_margin_loan**
-> CrossMarginLoan create_cross_margin_loan(cross_margin_loan)
-
-Create a cross margin borrow loan
-
-Borrow amount cannot be less than currency minimum borrow amount
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-cross_margin_loan = gate_api.CrossMarginLoan() # CrossMarginLoan |
-
-try:
- # Create a cross margin borrow loan
- api_response = api_instance.create_cross_margin_loan(cross_margin_loan)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->create_cross_margin_loan: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **cross_margin_loan** | [**CrossMarginLoan**](CrossMarginLoan.md)| |
-
-### Return type
-
-[**CrossMarginLoan**](CrossMarginLoan.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully borrowed | - |
-
-[[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)
-
-# **get_cross_margin_loan**
-> CrossMarginLoan get_cross_margin_loan(loan_id)
-
-Retrieve single borrow loan detail
+Query user's own leverage lending tiers in current market
### Example
@@ -1899,27 +461,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-loan_id = '12345' # str | Borrow loan ID
+currency_pair = 'BTC_USDT' # str | Currency pair
try:
- # Retrieve single borrow loan detail
- api_response = api_instance.get_cross_margin_loan(loan_id)
+ # Query user's own leverage lending tiers in current market
+ api_response = api_instance.get_user_margin_tier(currency_pair)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_loan: %s\n" % e)
+ print("Exception when calling MarginApi->get_user_margin_tier: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **loan_id** | **str**| Borrow loan ID |
+ **currency_pair** | **str**| Currency pair |
### Return type
-[**CrossMarginLoan**](CrossMarginLoan.md)
+[**list[MarginLeverageTier]**](MarginLeverageTier.md)
### Authorization
@@ -1933,74 +495,55 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **list_cross_margin_repayments**
-> list[CrossMarginRepayment] list_cross_margin_repayments(currency=currency, loan_id=loan_id, limit=limit, offset=offset, reverse=reverse)
-
-Retrieve cross margin repayments
+# **get_market_margin_tier**
+> list[MarginLeverageTier] get_market_margin_tier(currency_pair)
-Sort by creation time in descending order by default. Set `reverse=false` to return ascending results.
+Query current market leverage lending tiers
### Example
-* Api Key Authentication (apiv4):
```python
from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
+ host = "https://api.gateio.ws/api/v4"
)
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | (optional)
-loan_id = '12345' # str | (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-reverse = True # bool | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional) (default to True)
+currency_pair = 'BTC_USDT' # str | Currency pair
try:
- # Retrieve cross margin repayments
- api_response = api_instance.list_cross_margin_repayments(currency=currency, loan_id=loan_id, limit=limit, offset=offset, reverse=reverse)
+ # Query current market leverage lending tiers
+ api_response = api_instance.get_market_margin_tier(currency_pair)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->list_cross_margin_repayments: %s\n" % e)
+ print("Exception when calling MarginApi->get_market_margin_tier: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| | [optional]
- **loan_id** | **str**| | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **reverse** | **bool**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to True]
+ **currency_pair** | **str**| Currency pair |
### Return type
-[**list[CrossMarginRepayment]**](CrossMarginRepayment.md)
+[**list[MarginLeverageTier]**](MarginLeverageTier.md)
### Authorization
-[apiv4](../README.md#apiv4)
+No authorization required
### HTTP request headers
@@ -2010,16 +553,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | Query successful | - |
[[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)
-# **repay_cross_margin_loan**
-> list[CrossMarginLoan] repay_cross_margin_loan(cross_margin_repay_request)
+# **set_user_market_leverage**
+> set_user_market_leverage(margin_market_leverage)
-Cross margin repayments
-
-When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first
+Set user market leverage multiplier
### Example
@@ -2045,27 +586,26 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-cross_margin_repay_request = gate_api.CrossMarginRepayRequest() # CrossMarginRepayRequest |
+margin_market_leverage = gate_api.MarginMarketLeverage() # MarginMarketLeverage |
try:
- # Cross margin repayments
- api_response = api_instance.repay_cross_margin_loan(cross_margin_repay_request)
- print(api_response)
+ # Set user market leverage multiplier
+ api_instance.set_user_market_leverage(margin_market_leverage)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->repay_cross_margin_loan: %s\n" % e)
+ print("Exception when calling MarginApi->set_user_market_leverage: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **cross_margin_repay_request** | [**CrossMarginRepayRequest**](CrossMarginRepayRequest.md)| |
+ **margin_market_leverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| |
### Return type
-[**list[CrossMarginLoan]**](CrossMarginLoan.md)
+void (empty response body)
### Authorization
@@ -2074,94 +614,21 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: application/json
+ - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Loan repaid | - |
+**204** | Set successfully | - |
[[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)
-# **get_cross_margin_interest_records**
-> list[UniLoanInterestRecord] get_cross_margin_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to)
-
-Interest records for the cross margin account
-
-### Example
-
-* Api Key Authentication (apiv4):
-```python
-from __future__ import print_function
-import gate_api
-from gate_api.exceptions import ApiException, GateApiException
-# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
-# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
-configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
-)
-
-api_client = gate_api.ApiClient(configuration)
-# Create an instance of the API class
-api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
-page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-
-try:
- # Interest records for the cross margin account
- api_response = api_instance.get_cross_margin_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to)
- print(api_response)
-except GateApiException as ex:
- print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
-except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_interest_records: %s\n" % e)
-```
-
-### Parameters
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
- **page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
-
-### Return type
-
-[**list[UniLoanInterestRecord]**](UniLoanInterestRecord.md)
-
-### Authorization
-
-[apiv4](../README.md#apiv4)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
-
-[[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)
+# **list_margin_user_account**
+> list[MarginAccount] list_margin_user_account(currency_pair=currency_pair)
-# **get_cross_margin_transferable**
-> CrossMarginTransferable get_cross_margin_transferable(currency)
+Query user's isolated margin account list
-Get the max transferable amount for a specific cross margin currency
+Supports querying risk ratio isolated accounts and margin ratio isolated accounts
### Example
@@ -2187,27 +654,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currency_pair = 'BTC_USDT' # str | Currency pair (optional)
try:
- # Get the max transferable amount for a specific cross margin currency
- api_response = api_instance.get_cross_margin_transferable(currency)
+ # Query user's isolated margin account list
+ api_response = api_instance.list_margin_user_account(currency_pair=currency_pair)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_transferable: %s\n" % e)
+ print("Exception when calling MarginApi->list_margin_user_account: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currency_pair** | **str**| Currency pair | [optional]
### Return type
-[**CrossMarginTransferable**](CrossMarginTransferable.md)
+[**list[MarginAccount]**](MarginAccount.md)
### Authorization
@@ -2221,16 +688,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
-# **get_cross_margin_estimate_rate**
-> dict(str, str) get_cross_margin_estimate_rate(currencies)
+# **list_cross_margin_loans**
+> list[CrossMarginLoan] list_cross_margin_loans(status, currency=currency, limit=limit, offset=offset, reverse=reverse)
-Estimated interest rates
+Query cross margin borrow history (deprecated)
-Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate.
+Sorted by creation time in descending order by default. Set `reverse=false` for ascending order
### Example
@@ -2256,27 +723,35 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currencies = ['[\"BTC\",\"GT\"]'] # list[str] | An array of up to 10 specifying the currency name
+status = 56 # int | Filter by status. Supported values are 2 and 3. (deprecated.)
+currency = 'currency_example' # str | Query by specified currency, includes all currencies if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
+reverse = True # bool | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional) (default to True)
try:
- # Estimated interest rates
- api_response = api_instance.get_cross_margin_estimate_rate(currencies)
+ # Query cross margin borrow history (deprecated)
+ api_response = api_instance.list_cross_margin_loans(status, currency=currency, limit=limit, offset=offset, reverse=reverse)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_estimate_rate: %s\n" % e)
+ print("Exception when calling MarginApi->list_cross_margin_loans: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currencies** | [**list[str]**](str.md)| An array of up to 10 specifying the currency name |
+ **status** | **int**| Filter by status. Supported values are 2 and 3. (deprecated.) |
+ **currency** | **str**| Query by specified currency, includes all currencies if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
+ **reverse** | **bool**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to True]
### Return type
-**dict(str, str)**
+[**list[CrossMarginLoan]**](CrossMarginLoan.md)
### Authorization
@@ -2290,14 +765,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **get_cross_margin_borrowable**
-> UnifiedBorrowable get_cross_margin_borrowable(currency)
+# **list_cross_margin_repayments**
+> list[CrossMarginRepayment] list_cross_margin_repayments(currency=currency, loan_id=loan_id, limit=limit, offset=offset, reverse=reverse)
+
+Retrieve cross margin repayments. (deprecated)
-Get the max borrowable amount for a specific cross margin currency
+Sorted by creation time in descending order by default. Set `reverse=false` for ascending order
### Example
@@ -2323,27 +800,35 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currency = 'BTC' # str | (optional)
+loan_id = '12345' # str | (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
+reverse = True # bool | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional) (default to True)
try:
- # Get the max borrowable amount for a specific cross margin currency
- api_response = api_instance.get_cross_margin_borrowable(currency)
+ # Retrieve cross margin repayments. (deprecated)
+ api_response = api_instance.list_cross_margin_repayments(currency=currency, loan_id=loan_id, limit=limit, offset=offset, reverse=reverse)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling MarginApi->get_cross_margin_borrowable: %s\n" % e)
+ print("Exception when calling MarginApi->list_cross_margin_repayments: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currency** | **str**| | [optional]
+ **loan_id** | **str**| | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
+ **reverse** | **bool**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to True]
### Return type
-[**UnifiedBorrowable**](UnifiedBorrowable.md)
+[**list[CrossMarginRepayment]**](CrossMarginRepayment.md)
### Authorization
@@ -2357,7 +842,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
diff --git a/docs/MarginCurrencyPair.md b/docs/MarginCurrencyPair.md
deleted file mode 100644
index 7826f21..0000000
--- a/docs/MarginCurrencyPair.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# MarginCurrencyPair
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** | Currency pair | [optional]
-**base** | **str** | Base currency | [optional]
-**quote** | **str** | Quote currency | [optional]
-**leverage** | **int** | Leverage | [optional]
-**min_base_amount** | **str** | Minimum base currency to loan, `null` means no limit | [optional]
-**min_quote_amount** | **str** | Minimum quote currency to loan, `null` means no limit | [optional]
-**max_quote_amount** | **str** | Maximum borrowable amount for quote currency. Base currency limit is calculated by quote maximum and market price. `null` means no limit | [optional]
-**status** | **int** | Currency pair status - `0`: disabled - `1`: enabled | [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)
-
-
diff --git a/docs/FundingBookItem.md b/docs/MarginLeverageTier.md
similarity index 54%
rename from docs/FundingBookItem.md
rename to docs/MarginLeverageTier.md
index 83f5d7d..0a36030 100644
--- a/docs/FundingBookItem.md
+++ b/docs/MarginLeverageTier.md
@@ -1,11 +1,12 @@
-# FundingBookItem
+# MarginLeverageTier
+Market gradient information
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**rate** | **str** | Loan rate (daily rate) | [optional]
-**amount** | **str** | Borrowable amount | [optional]
-**days** | **int** | The number of days till the loan repayment's dateline | [optional]
+**upper_limit** | **str** | Maximum loan limit | [optional]
+**mmr** | **str** | Maintenance margin rate | [optional]
+**leverage** | **str** | Maximum leverage multiple | [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)
diff --git a/docs/MarginMarketLeverage.md b/docs/MarginMarketLeverage.md
new file mode 100644
index 0000000..63ce686
--- /dev/null
+++ b/docs/MarginMarketLeverage.md
@@ -0,0 +1,12 @@
+# MarginMarketLeverage
+
+Market leverage settings
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_pair** | **str** | Market | [optional]
+**leverage** | **str** | Position leverage |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md
index 355a750..02afa4e 100644
--- a/docs/MarginUniApi.md
+++ b/docs/MarginUniApi.md
@@ -5,13 +5,13 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list_uni_currency_pairs**](MarginUniApi.md#list_uni_currency_pairs) | **GET** /margin/uni/currency_pairs | List lending markets
-[**get_uni_currency_pair**](MarginUniApi.md#get_uni_currency_pair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get detail of lending market
-[**get_margin_uni_estimate_rate**](MarginUniApi.md#get_margin_uni_estimate_rate) | **GET** /margin/uni/estimate_rate | Estimate interest Rate
-[**list_uni_loans**](MarginUniApi.md#list_uni_loans) | **GET** /margin/uni/loans | List loans
+[**get_uni_currency_pair**](MarginUniApi.md#get_uni_currency_pair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get lending market details
+[**get_margin_uni_estimate_rate**](MarginUniApi.md#get_margin_uni_estimate_rate) | **GET** /margin/uni/estimate_rate | Estimate interest rate for isolated margin currencies
+[**list_uni_loans**](MarginUniApi.md#list_uni_loans) | **GET** /margin/uni/loans | Query loans
[**create_uni_loan**](MarginUniApi.md#create_uni_loan) | **POST** /margin/uni/loans | Borrow or repay
-[**list_uni_loan_records**](MarginUniApi.md#list_uni_loan_records) | **GET** /margin/uni/loan_records | Get load records
-[**list_uni_loan_interest_records**](MarginUniApi.md#list_uni_loan_interest_records) | **GET** /margin/uni/interest_records | List interest records
-[**get_uni_borrowable**](MarginUniApi.md#get_uni_borrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable
+[**list_uni_loan_records**](MarginUniApi.md#list_uni_loan_records) | **GET** /margin/uni/loan_records | Query loan records
+[**list_uni_loan_interest_records**](MarginUniApi.md#list_uni_loan_interest_records) | **GET** /margin/uni/interest_records | Query interest deduction records
+[**get_uni_borrowable**](MarginUniApi.md#get_uni_borrowable) | **GET** /margin/uni/borrowable | Query maximum borrowable amount by currency
# **list_uni_currency_pairs**
@@ -64,14 +64,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_uni_currency_pair**
> UniCurrencyPair get_uni_currency_pair(currency_pair)
-Get detail of lending market
+Get lending market details
### Example
@@ -91,7 +91,7 @@ api_instance = gate_api.MarginUniApi(api_client)
currency_pair = 'AE_USDT' # str | Currency pair
try:
- # Get detail of lending market
+ # Get lending market details
api_response = api_instance.get_uni_currency_pair(currency_pair)
print(api_response)
except GateApiException as ex:
@@ -122,16 +122,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_margin_uni_estimate_rate**
> dict(str, str) get_margin_uni_estimate_rate(currencies)
-Estimate interest Rate
+Estimate interest rate for isolated margin currencies
-Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate.
+Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided.
### Example
@@ -157,10 +157,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginUniApi(api_client)
-currencies = ['[\"BTC\",\"GT\"]'] # list[str] | An array of up to 10 specifying the currency name
+currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Array of currency names to query, maximum 10
try:
- # Estimate interest Rate
+ # Estimate interest rate for isolated margin currencies
api_response = api_instance.get_margin_uni_estimate_rate(currencies)
print(api_response)
except GateApiException as ex:
@@ -173,7 +173,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currencies** | [**list[str]**](str.md)| An array of up to 10 specifying the currency name |
+ **currencies** | [**list[str]**](str.md)| Array of currency names to query, maximum 10 |
### Return type
@@ -191,14 +191,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_uni_loans**
> list[UniLoan] list_uni_loans(currency_pair=currency_pair, currency=currency, page=page, limit=limit)
-List loans
+Query loans
### Example
@@ -225,12 +225,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginUniApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
try:
- # List loans
+ # Query loans
api_response = api_instance.list_uni_loans(currency_pair=currency_pair, currency=currency, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -244,9 +244,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair | [optional]
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
### Return type
@@ -264,7 +264,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -330,14 +330,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Operated successfully | - |
+**204** | Operation successful | - |
[[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)
# **list_uni_loan_records**
> list[UniLoanRecord] list_uni_loan_records(type=type, currency=currency, currency_pair=currency_pair, page=page, limit=limit)
-Get load records
+Query loan records
### Example
@@ -363,14 +363,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginUniApi(api_client)
-type = 'type_example' # str | type: borrow - borrow, repay - repay (optional)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+type = 'type_example' # str | Type: `borrow` - borrow, `repay` - repay (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
try:
- # Get load records
+ # Query loan records
api_response = api_instance.list_uni_loan_records(type=type, currency=currency, currency_pair=currency_pair, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -383,11 +383,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **type** | **str**| type: borrow - borrow, repay - repay | [optional]
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **type** | **str**| Type: `borrow` - borrow, `repay` - repay | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**currency_pair** | **str**| Currency pair | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
### Return type
@@ -405,14 +405,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_uni_loan_interest_records**
> list[UniLoanInterestRecord] list_uni_loan_interest_records(currency_pair=currency_pair, currency=currency, page=page, limit=limit, _from=_from, to=to)
-List interest records
+Query interest deduction records
### Example
@@ -439,14 +439,14 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginUniApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # List interest records
+ # Query interest deduction records
api_response = api_instance.list_uni_loan_interest_records(currency_pair=currency_pair, currency=currency, page=page, limit=limit, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -460,11 +460,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair | [optional]
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -482,14 +482,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_uni_borrowable**
> MaxUniBorrowable get_uni_borrowable(currency, currency_pair)
-Get maximum borrowable
+Query maximum borrowable amount by currency
### Example
@@ -515,11 +515,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MarginUniApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currency = 'BTC' # str | Query by specified currency name
currency_pair = 'BTC_USDT' # str | Currency pair
try:
- # Get maximum borrowable
+ # Query maximum borrowable amount by currency
api_response = api_instance.get_uni_borrowable(currency, currency_pair)
print(api_response)
except GateApiException as ex:
@@ -532,7 +532,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currency** | **str**| Query by specified currency name |
**currency_pair** | **str**| Currency pair |
### Return type
@@ -551,7 +551,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
diff --git a/docs/MockFuturesOrder.md b/docs/MockFuturesOrder.md
index 74f0821..0d03d06 100644
--- a/docs/MockFuturesOrder.md
+++ b/docs/MockFuturesOrder.md
@@ -4,8 +4,8 @@ Futures order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**contract** | **str** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. |
-**size** | **str** | Futures quantity, representing the initial order quantity, not involved in actual settlement. |
+**contract** | **str** | Futures name, currently only supports USDT perpetual contracts for BTC and ETH |
+**size** | **str** | Contract quantity, representing the initial order quantity, not involved in actual settlement |
**left** | **str** | Unfilled contract quantity, involved in actual calculation |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MockFuturesPosition.md b/docs/MockFuturesPosition.md
index 67f559d..f6eccc7 100644
--- a/docs/MockFuturesPosition.md
+++ b/docs/MockFuturesPosition.md
@@ -4,8 +4,8 @@ Futures positions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**contract** | **str** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. |
-**size** | **str** | Position size, measured in contract units. |
+**contract** | **str** | Futures name, currently only supports USDT perpetual contracts for BTC and ETH |
+**size** | **str** | Position size, measured in contract quantity |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MockMarginResult.md b/docs/MockMarginResult.md
index 087826b..0ea3b20 100644
--- a/docs/MockMarginResult.md
+++ b/docs/MockMarginResult.md
@@ -5,7 +5,7 @@ Margin result
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position | [optional]
-**profit_loss_ranges** | [**list[ProfitLossRange]**](ProfitLossRange.md) | The results of 33 pressure scenarios for MR1 | [optional]
+**profit_loss_ranges** | [**list[ProfitLossRange]**](ProfitLossRange.md) | Results of 33 stress scenarios for MR1 | [optional]
**max_loss** | [**ProfitLossRange**](.md) | 最大损失 | [optional]
**mr1** | **str** | Stress testing | [optional]
**mr2** | **str** | Basis spread risk | [optional]
diff --git a/docs/MockOptionsOrder.md b/docs/MockOptionsOrder.md
index 4748585..054d3f4 100644
--- a/docs/MockOptionsOrder.md
+++ b/docs/MockOptionsOrder.md
@@ -4,7 +4,7 @@ Option orders
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**options_name** | **str** | Option name, currently only supports options for BTC and ETH with USDT. |
+**options_name** | **str** | Option name, currently only supports USDT options for BTC and ETH |
**size** | **str** | Initial order quantity, not involved in actual calculation |
**left** | **str** | Unfilled contract quantity, involved in actual calculation |
diff --git a/docs/MockOptionsPosition.md b/docs/MockOptionsPosition.md
index ebecb3c..f7c0e53 100644
--- a/docs/MockOptionsPosition.md
+++ b/docs/MockOptionsPosition.md
@@ -4,8 +4,8 @@ Options positions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**options_name** | **str** | Option name, currently only supports options for BTC and ETH with USDT. |
-**size** | **str** | Position size, measured in contract units. |
+**options_name** | **str** | Option name, currently only supports USDT options for BTC and ETH |
+**size** | **str** | Position size, measured in contract quantity |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MockRiskUnit.md b/docs/MockRiskUnit.md
index d2e5c3c..cf6f234 100644
--- a/docs/MockRiskUnit.md
+++ b/docs/MockRiskUnit.md
@@ -5,7 +5,7 @@ Risk unit
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | Risk unit name | [optional]
-**spot_in_use** | **str** | Spot usage | [optional]
+**spot_in_use** | **str** | Spot hedge usage | [optional]
**maintain_margin** | **str** | Maintenance margin | [optional]
**initial_margin** | **str** | Initial margin | [optional]
**margin_result** | [**list[MockMarginResult]**](MockMarginResult.md) | Margin result | [optional]
diff --git a/docs/MockSpotBalance.md b/docs/MockSpotBalance.md
index c9181a0..54bb762 100644
--- a/docs/MockSpotBalance.md
+++ b/docs/MockSpotBalance.md
@@ -5,7 +5,7 @@ Spot
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name |
-**equity** | **str** | Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. |
+**equity** | **str** | Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports BTC and ETH |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MockSpotOrder.md b/docs/MockSpotOrder.md
index 4327a99..3b3d340 100644
--- a/docs/MockSpotOrder.md
+++ b/docs/MockSpotOrder.md
@@ -4,11 +4,11 @@ Spot orders
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency_pairs** | **str** | Currency pair |
+**currency_pairs** | **str** | Market |
**order_price** | **str** | Price |
-**count** | **str** | Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. | [optional]
-**left** | **str** | Unfilled quantity, involved in actual calculation. |
-**type** | **str** | Order type, sell - sell order, buy - buy order. |
+**count** | **str** | Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports BTC and ETH Currently only supports three currencies: BTC, ETH | [optional]
+**left** | **str** | Unfilled quantity, involved in actual calculation |
+**type** | **str** | Order type, sell - sell order, buy - buy order |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MultiCollateralCurrency.md b/docs/MultiCollateralCurrency.md
index 872dc36..f309656 100644
--- a/docs/MultiCollateralCurrency.md
+++ b/docs/MultiCollateralCurrency.md
@@ -1,6 +1,6 @@
# MultiCollateralCurrency
-Borrowing and collateral currencies supported for Multi-Collateral.
+Borrowing and collateral currencies supported for Multi-Collateral
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md
index 28b5587..ab66f2a 100644
--- a/docs/MultiCollateralLoanApi.md
+++ b/docs/MultiCollateralLoanApi.md
@@ -4,24 +4,24 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_multi_collateral_orders**](MultiCollateralLoanApi.md#list_multi_collateral_orders) | **GET** /loan/multi_collateral/orders | List Multi-Collateral Orders
-[**create_multi_collateral**](MultiCollateralLoanApi.md#create_multi_collateral) | **POST** /loan/multi_collateral/orders | Create Multi-Collateral Order
-[**get_multi_collateral_order_detail**](MultiCollateralLoanApi.md#get_multi_collateral_order_detail) | **GET** /loan/multi_collateral/orders/{order_id} | Get Multi-Collateral Order Detail
-[**list_multi_repay_records**](MultiCollateralLoanApi.md#list_multi_repay_records) | **GET** /loan/multi_collateral/repay | List Multi-Collateral Repay Records
-[**repay_multi_collateral_loan**](MultiCollateralLoanApi.md#repay_multi_collateral_loan) | **POST** /loan/multi_collateral/repay | Repay Multi-Collateral Loan
+[**list_multi_collateral_orders**](MultiCollateralLoanApi.md#list_multi_collateral_orders) | **GET** /loan/multi_collateral/orders | Query multi-currency collateral order list
+[**create_multi_collateral**](MultiCollateralLoanApi.md#create_multi_collateral) | **POST** /loan/multi_collateral/orders | Place multi-currency collateral order
+[**get_multi_collateral_order_detail**](MultiCollateralLoanApi.md#get_multi_collateral_order_detail) | **GET** /loan/multi_collateral/orders/{order_id} | Query order details
+[**list_multi_repay_records**](MultiCollateralLoanApi.md#list_multi_repay_records) | **GET** /loan/multi_collateral/repay | Query multi-currency collateral repayment records
+[**repay_multi_collateral_loan**](MultiCollateralLoanApi.md#repay_multi_collateral_loan) | **POST** /loan/multi_collateral/repay | Multi-currency collateral repayment
[**list_multi_collateral_records**](MultiCollateralLoanApi.md#list_multi_collateral_records) | **GET** /loan/multi_collateral/mortgage | Query collateral adjustment records
-[**operate_multi_collateral**](MultiCollateralLoanApi.md#operate_multi_collateral) | **POST** /loan/multi_collateral/mortgage | Operate Multi-Collateral
-[**list_user_currency_quota**](MultiCollateralLoanApi.md#list_user_currency_quota) | **GET** /loan/multi_collateral/currency_quota | List User Currency Quota
-[**list_multi_collateral_currencies**](MultiCollateralLoanApi.md#list_multi_collateral_currencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies in Multi-Collateral
-[**get_multi_collateral_ltv**](MultiCollateralLoanApi.md#get_multi_collateral_ltv) | **GET** /loan/multi_collateral/ltv | Get Multi-Collateral ratio
-[**get_multi_collateral_fix_rate**](MultiCollateralLoanApi.md#get_multi_collateral_fix_rate) | **GET** /loan/multi_collateral/fixed_rate | Query fixed interest rates for the currency for 7 days and 30 days
-[**get_multi_collateral_current_rate**](MultiCollateralLoanApi.md#get_multi_collateral_current_rate) | **GET** /loan/multi_collateral/current_rate | Query the current interest rate of the currency
+[**operate_multi_collateral**](MultiCollateralLoanApi.md#operate_multi_collateral) | **POST** /loan/multi_collateral/mortgage | Add or withdraw collateral
+[**list_user_currency_quota**](MultiCollateralLoanApi.md#list_user_currency_quota) | **GET** /loan/multi_collateral/currency_quota | Query user's collateral and borrowing currency quota information
+[**list_multi_collateral_currencies**](MultiCollateralLoanApi.md#list_multi_collateral_currencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies for multi-currency collateral
+[**get_multi_collateral_ltv**](MultiCollateralLoanApi.md#get_multi_collateral_ltv) | **GET** /loan/multi_collateral/ltv | Query collateralization ratio information
+[**get_multi_collateral_fix_rate**](MultiCollateralLoanApi.md#get_multi_collateral_fix_rate) | **GET** /loan/multi_collateral/fixed_rate | Query currency's 7-day and 30-day fixed interest rates
+[**get_multi_collateral_current_rate**](MultiCollateralLoanApi.md#get_multi_collateral_current_rate) | **GET** /loan/multi_collateral/current_rate | Query currency's current interest rate
# **list_multi_collateral_orders**
> list[MultiCollateralOrder] list_multi_collateral_orders(page=page, limit=limit, sort=sort, order_type=order_type)
-List Multi-Collateral Orders
+Query multi-currency collateral order list
### Example
@@ -48,12 +48,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MultiCollateralLoanApi(api_client)
page = 1 # int | Page number (optional) (default to 1)
-limit = 10 # int | Maximum number of records to be returned in a single list (optional) (default to 10)
-sort = 'ltv_asc' # str | Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv. (optional)
-order_type = 'current' # str | Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders (optional)
+limit = 10 # int | Maximum number of records returned in a single list (optional) (default to 10)
+sort = 'ltv_asc' # str | Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending. (optional)
+order_type = 'current' # str | Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified (optional)
try:
- # List Multi-Collateral Orders
+ # Query multi-currency collateral order list
api_response = api_instance.list_multi_collateral_orders(page=page, limit=limit, sort=sort, order_type=order_type)
print(api_response)
except GateApiException as ex:
@@ -67,9 +67,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 10]
- **sort** | **str**| Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv. | [optional]
- **order_type** | **str**| Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 10]
+ **sort** | **str**| Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending. | [optional]
+ **order_type** | **str**| Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional]
### Return type
@@ -87,14 +87,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_multi_collateral**
> OrderResp create_multi_collateral(create_multi_collateral_order)
-Create Multi-Collateral Order
+Place multi-currency collateral order
### Example
@@ -123,7 +123,7 @@ api_instance = gate_api.MultiCollateralLoanApi(api_client)
create_multi_collateral_order = gate_api.CreateMultiCollateralOrder() # CreateMultiCollateralOrder |
try:
- # Create Multi-Collateral Order
+ # Place multi-currency collateral order
api_response = api_instance.create_multi_collateral(create_multi_collateral_order)
print(api_response)
except GateApiException as ex:
@@ -154,14 +154,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order placed successfully | - |
[[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)
# **get_multi_collateral_order_detail**
> MultiCollateralOrder get_multi_collateral_order_detail(order_id)
-Get Multi-Collateral Order Detail
+Query order details
### Example
@@ -187,10 +187,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MultiCollateralLoanApi(api_client)
-order_id = '12345' # str | Order ID returned on successful order creation
+order_id = '12345' # str | Order ID returned when order is successfully created
try:
- # Get Multi-Collateral Order Detail
+ # Query order details
api_response = api_instance.get_multi_collateral_order_detail(order_id)
print(api_response)
except GateApiException as ex:
@@ -203,7 +203,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Order ID returned on successful order creation |
+ **order_id** | **str**| Order ID returned when order is successfully created |
### Return type
@@ -221,14 +221,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Order details queried successfully | - |
[[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)
# **list_multi_repay_records**
> list[MultiRepayRecord] list_multi_repay_records(type, borrow_currency=borrow_currency, page=page, limit=limit, _from=_from, to=to)
-List Multi-Collateral Repay Records
+Query multi-currency collateral repayment records
### Example
@@ -257,12 +257,12 @@ api_instance = gate_api.MultiCollateralLoanApi(api_client)
type = 'repay' # str | Operation type: repay - Regular repayment, liquidate - Liquidation
borrow_currency = 'USDT' # str | Borrowed currency (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 10 # int | Maximum number of records to be returned in a single list (optional) (default to 10)
-_from = 1609459200 # int | Start timestamp of the query (optional)
-to = 1609459200 # int | Time range ending, default to current time (optional)
+limit = 10 # int | Maximum number of records returned in a single list (optional) (default to 10)
+_from = 1609459200 # int | Start timestamp for the query (optional)
+to = 1609459200 # int | End timestamp for the query, defaults to current time if not specified (optional)
try:
- # List Multi-Collateral Repay Records
+ # Query multi-currency collateral repayment records
api_response = api_instance.list_multi_repay_records(type, borrow_currency=borrow_currency, page=page, limit=limit, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -278,9 +278,9 @@ Name | Type | Description | Notes
**type** | **str**| Operation type: repay - Regular repayment, liquidate - Liquidation |
**borrow_currency** | **str**| Borrowed currency | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 10]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 10]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
### Return type
@@ -298,14 +298,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **repay_multi_collateral_loan**
> MultiRepayResp repay_multi_collateral_loan(repay_multi_loan)
-Repay Multi-Collateral Loan
+Multi-currency collateral repayment
### Example
@@ -334,7 +334,7 @@ api_instance = gate_api.MultiCollateralLoanApi(api_client)
repay_multi_loan = gate_api.RepayMultiLoan() # RepayMultiLoan |
try:
- # Repay Multi-Collateral Loan
+ # Multi-currency collateral repayment
api_response = api_instance.repay_multi_collateral_loan(repay_multi_loan)
print(api_response)
except GateApiException as ex:
@@ -365,7 +365,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Operated successfully | - |
+**200** | Operation successful | - |
[[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)
@@ -399,10 +399,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MultiCollateralLoanApi(api_client)
page = 1 # int | Page number (optional) (default to 1)
-limit = 10 # int | Maximum number of records to be returned in a single list (optional) (default to 10)
-_from = 1609459200 # int | Start timestamp of the query (optional)
-to = 1609459200 # int | Time range ending, default to current time (optional)
-collateral_currency = 'BTC' # str | Collateral (optional)
+limit = 10 # int | Maximum number of records returned in a single list (optional) (default to 10)
+_from = 1609459200 # int | Start timestamp for the query (optional)
+to = 1609459200 # int | End timestamp for the query, defaults to current time if not specified (optional)
+collateral_currency = 'BTC' # str | Collateral currency (optional)
try:
# Query collateral adjustment records
@@ -419,10 +419,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 10]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **collateral_currency** | **str**| Collateral | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 10]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **collateral_currency** | **str**| Collateral currency | [optional]
### Return type
@@ -440,14 +440,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **operate_multi_collateral**
> CollateralAdjustRes operate_multi_collateral(collateral_adjust)
-Operate Multi-Collateral
+Add or withdraw collateral
### Example
@@ -476,7 +476,7 @@ api_instance = gate_api.MultiCollateralLoanApi(api_client)
collateral_adjust = gate_api.CollateralAdjust() # CollateralAdjust |
try:
- # Operate Multi-Collateral
+ # Add or withdraw collateral
api_response = api_instance.operate_multi_collateral(collateral_adjust)
print(api_response)
except GateApiException as ex:
@@ -507,14 +507,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Operated successfully | - |
+**200** | Operation successful | - |
[[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)
# **list_user_currency_quota**
> list[CurrencyQuota] list_user_currency_quota(type, currency)
-List User Currency Quota
+Query user's collateral and borrowing currency quota information
### Example
@@ -540,11 +540,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MultiCollateralLoanApi(api_client)
-type = 'collateral' # str | Currency types: collateral - collateral currency, borrow - borrowing currency.
-currency = 'BTC' # str | When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided.
+type = 'collateral' # str | Currency type: collateral - Collateral currency, borrow - Borrowing currency
+currency = 'BTC' # str | When it is a collateral currency, multiple currencies can be provided separated by commas; when it is a borrowing currency, only one currency can be provided.
try:
- # List User Currency Quota
+ # Query user's collateral and borrowing currency quota information
api_response = api_instance.list_user_currency_quota(type, currency)
print(api_response)
except GateApiException as ex:
@@ -557,8 +557,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **type** | **str**| Currency types: collateral - collateral currency, borrow - borrowing currency. |
- **currency** | **str**| When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. |
+ **type** | **str**| Currency type: collateral - Collateral currency, borrow - Borrowing currency |
+ **currency** | **str**| When it is a collateral currency, multiple currencies can be provided separated by commas; when it is a borrowing currency, only one currency can be provided. |
### Return type
@@ -576,14 +576,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_multi_collateral_currencies**
> MultiCollateralCurrency list_multi_collateral_currencies()
-Query supported borrowing and collateral currencies in Multi-Collateral
+Query supported borrowing and collateral currencies for multi-currency collateral
### Example
@@ -602,7 +602,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.MultiCollateralLoanApi(api_client)
try:
- # Query supported borrowing and collateral currencies in Multi-Collateral
+ # Query supported borrowing and collateral currencies for multi-currency collateral
api_response = api_instance.list_multi_collateral_currencies()
print(api_response)
except GateApiException as ex:
@@ -630,16 +630,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_multi_collateral_ltv**
> CollateralLtv get_multi_collateral_ltv()
-Get Multi-Collateral ratio
+Query collateralization ratio information
-The Multi-Collateral ratio is fixed, irrespective of the currency.
+Multi-currency collateral ratio is fixed, independent of currency
### Example
@@ -658,7 +658,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.MultiCollateralLoanApi(api_client)
try:
- # Get Multi-Collateral ratio
+ # Query collateralization ratio information
api_response = api_instance.get_multi_collateral_ltv()
print(api_response)
except GateApiException as ex:
@@ -686,14 +686,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_multi_collateral_fix_rate**
> list[CollateralFixRate] get_multi_collateral_fix_rate()
-Query fixed interest rates for the currency for 7 days and 30 days
+Query currency's 7-day and 30-day fixed interest rates
### Example
@@ -712,7 +712,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.MultiCollateralLoanApi(api_client)
try:
- # Query fixed interest rates for the currency for 7 days and 30 days
+ # Query currency's 7-day and 30-day fixed interest rates
api_response = api_instance.get_multi_collateral_fix_rate()
print(api_response)
except GateApiException as ex:
@@ -740,16 +740,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_multi_collateral_current_rate**
> list[CollateralCurrentRate] get_multi_collateral_current_rate(currencies, vip_level=vip_level)
-Query the current interest rate of the currency
+Query currency's current interest rate
-Query the current interest rate of the currency in the last hour. The current interest rate is updated every hour.
+Query currency's current interest rate for the previous hour, current interest rate updates hourly
### Example
@@ -766,11 +766,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.MultiCollateralLoanApi(api_client)
-currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items.
-vip_level = '0' # str | VIP level, defaults to 0 if not transferred (optional) (default to '0')
+currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Specify currency name query array, separated by commas, maximum 100 items
+vip_level = '0' # str | VIP level, defaults to 0 if not specified (optional) (default to '0')
try:
- # Query the current interest rate of the currency
+ # Query currency's current interest rate
api_response = api_instance.get_multi_collateral_current_rate(currencies, vip_level=vip_level)
print(api_response)
except GateApiException as ex:
@@ -783,8 +783,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currencies** | [**list[str]**](str.md)| Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. |
- **vip_level** | **str**| VIP level, defaults to 0 if not transferred | [optional] [default to '0']
+ **currencies** | [**list[str]**](str.md)| Specify currency name query array, separated by commas, maximum 100 items |
+ **vip_level** | **str**| VIP level, defaults to 0 if not specified | [optional] [default to '0']
### Return type
@@ -802,7 +802,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
diff --git a/docs/MultiCollateralOrder.md b/docs/MultiCollateralOrder.md
index 0c5ebee..3162049 100644
--- a/docs/MultiCollateralOrder.md
+++ b/docs/MultiCollateralOrder.md
@@ -6,16 +6,16 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **str** | Order ID | [optional]
**order_type** | **str** | current - current, fixed - fixed | [optional]
-**fixed_type** | **str** | Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days. | [optional]
+**fixed_type** | **str** | Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days | [optional]
**fixed_rate** | **str** | Fixed interest rate | [optional]
-**expire_time** | **int** | Expiration time, timestamp, unit in seconds. | [optional]
-**auto_renew** | **bool** | Fixed interest rate, automatic renewal | [optional]
-**auto_repay** | **bool** | Fixed interest rate, automatic repayment | [optional]
-**current_ltv** | **str** | The current collateralization rate | [optional]
+**expire_time** | **int** | Expiration time, timestamp, unit in seconds | [optional]
+**auto_renew** | **bool** | Fixed interest rate, auto-renewal | [optional]
+**auto_repay** | **bool** | Fixed interest rate, auto-repayment | [optional]
+**current_ltv** | **str** | Current collateralization rate | [optional]
**status** | **str** | Order status: - initial: Initial state after placing the order - collateral_deducted: Collateral deduction successful - collateral_returning: Loan failed - Collateral return pending - lent: Loan successful - repaying: Repayment in progress - liquidating: Liquidation in progress - finished: Order completed - closed_liquidated: Liquidation and repayment completed | [optional]
**borrow_time** | **int** | Borrowing time, timestamp in seconds | [optional]
-**total_left_repay_usdt** | **str** | Value of Left repay amount converted in USDT | [optional]
-**total_left_collateral_usdt** | **str** | Value of Collateral amount in USDT | [optional]
+**total_left_repay_usdt** | **str** | Total outstanding value converted to USDT | [optional]
+**total_left_collateral_usdt** | **str** | Total collateral value converted to USDT | [optional]
**borrow_currencies** | [**list[BorrowCurrencyInfo]**](BorrowCurrencyInfo.md) | Borrowing Currency List | [optional]
**collateral_currencies** | [**list[CollateralCurrencyInfo]**](CollateralCurrencyInfo.md) | Collateral Currency List | [optional]
diff --git a/docs/MultiCollateralRecord.md b/docs/MultiCollateralRecord.md
index 4f79e11..5f48cd6 100644
--- a/docs/MultiCollateralRecord.md
+++ b/docs/MultiCollateralRecord.md
@@ -1,14 +1,14 @@
# MultiCollateralRecord
-Multi-Collateral adjustment record.
+Multi-Collateral adjustment record
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID | [optional]
**record_id** | **int** | Collateral record ID | [optional]
-**before_ltv** | **str** | The collateral ratio before adjustment | [optional]
-**after_ltv** | **str** | The collateral ratio before adjustment | [optional]
-**operate_time** | **int** | Operation time, timestamp in seconds. | [optional]
+**before_ltv** | **str** | Collateral ratio before adjustment | [optional]
+**after_ltv** | **str** | Collateral ratio before adjustment | [optional]
+**operate_time** | **int** | Operation time, timestamp in seconds | [optional]
**borrow_currencies** | [**list[MultiCollateralRecordCurrency]**](MultiCollateralRecordCurrency.md) | Borrowing Currency List | [optional]
**collateral_currencies** | [**list[MultiCollateralRecordCurrency]**](MultiCollateralRecordCurrency.md) | Collateral Currency List | [optional]
diff --git a/docs/MultiCollateralRecordCurrency.md b/docs/MultiCollateralRecordCurrency.md
index 7c622f8..9e3f5e1 100644
--- a/docs/MultiCollateralRecordCurrency.md
+++ b/docs/MultiCollateralRecordCurrency.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
**currency** | **str** | Currency | [optional]
**index_price** | **str** | Currency Index Price | [optional]
**before_amount** | **str** | Amount before the operation | [optional]
-**before_amount_usdt** | **str** | USDT Amount before the operation. | [optional]
-**after_amount** | **str** | Amount after the operation. | [optional]
-**after_amount_usdt** | **str** | USDT Amount after the operation. | [optional]
+**before_amount_usdt** | **str** | USDT Amount before the operation | [optional]
+**after_amount** | **str** | Amount after the operation | [optional]
+**after_amount_usdt** | **str** | USDT Amount after the operation | [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)
diff --git a/docs/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md
index df0f95b..f381f48 100644
--- a/docs/MultiLoanRepayItem.md
+++ b/docs/MultiLoanRepayItem.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Repayment currency | [optional]
**amount** | **str** | Size | [optional]
-**repaid_all** | **bool** | Repayment method, set to true for full repayment, false for partial repayment. | [optional]
+**repaid_all** | **bool** | Repayment method, set to true for full repayment, false for partial repayment |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/MultiRepayRecord.md b/docs/MultiRepayRecord.md
index 715ee36..93e37d8 100644
--- a/docs/MultiRepayRecord.md
+++ b/docs/MultiRepayRecord.md
@@ -1,21 +1,21 @@
# MultiRepayRecord
-Mult Repay Record
+Multi-Collateral Repayment Record
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID | [optional]
**record_id** | **int** | Repayment record ID | [optional]
-**init_ltv** | **str** | The initial collateralization rate | [optional]
+**init_ltv** | **str** | Initial collateralization rate | [optional]
**before_ltv** | **str** | Ltv before the operation | [optional]
**after_ltv** | **str** | Ltv after the operation | [optional]
-**borrow_time** | **int** | Borrowing time, timestamp in seconds. | [optional]
-**repay_time** | **int** | Repayment time, timestamp in seconds. | [optional]
+**borrow_time** | **int** | Borrowing time, timestamp in seconds | [optional]
+**repay_time** | **int** | Repayment time, timestamp in seconds | [optional]
**borrow_currencies** | [**list[RepayRecordCurrency]**](RepayRecordCurrency.md) | List of borrowing information | [optional]
**collateral_currencies** | [**list[RepayRecordCurrency]**](RepayRecordCurrency.md) | List of collateral information | [optional]
**repaid_currencies** | [**list[RepayRecordRepaidCurrency]**](RepayRecordRepaidCurrency.md) | Repay Currency List | [optional]
**total_interest_list** | [**list[RepayRecordTotalInterest]**](RepayRecordTotalInterest.md) | Total Interest List | [optional]
-**left_repay_interest_list** | [**list[RepayRecordLeftInterest]**](RepayRecordLeftInterest.md) | List of left repay interest | [optional]
+**left_repay_interest_list** | [**list[RepayRecordLeftInterest]**](RepayRecordLeftInterest.md) | List of remaining interest to be repaid | [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)
diff --git a/docs/MultiRepayResp.md b/docs/MultiRepayResp.md
index 6315962..2d7ebe0 100644
--- a/docs/MultiRepayResp.md
+++ b/docs/MultiRepayResp.md
@@ -1,6 +1,6 @@
# MultiRepayResp
-Repay Multi-Collateral Loan
+Multi-currency collateral repayment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/MyFuturesTrade.md b/docs/MyFuturesTrade.md
index 431447d..34cc347 100644
--- a/docs/MyFuturesTrade.md
+++ b/docs/MyFuturesTrade.md
@@ -3,17 +3,17 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Trade ID | [optional]
-**create_time** | **float** | Trading time | [optional]
+**id** | **int** | Fill ID | [optional]
+**create_time** | **float** | Fill Time | [optional]
**contract** | **str** | Futures contract | [optional]
-**order_id** | **str** | Order ID related | [optional]
+**order_id** | **str** | Related order ID | [optional]
**size** | **int** | Trading size | [optional]
-**close_size** | **int** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position | [optional]
-**price** | **str** | Trading price | [optional]
-**role** | **str** | Trade role. Available values are `taker` and `maker` | [optional]
-**text** | **str** | User defined information | [optional]
-**fee** | **str** | Fee deducted | [optional]
-**point_fee** | **str** | Points used to deduct fee | [optional]
+**close_size** | **int** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position | [optional]
+**price** | **str** | Fill Price | [optional]
+**role** | **str** | Trade role. taker - taker, maker - maker | [optional]
+**text** | **str** | Order custom information | [optional]
+**fee** | **str** | Trade fee | [optional]
+**point_fee** | **str** | Points used to deduct trade fee | [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)
diff --git a/docs/MyFuturesTradeTimeRange.md b/docs/MyFuturesTradeTimeRange.md
index 14c8d62..ff9e786 100644
--- a/docs/MyFuturesTradeTimeRange.md
+++ b/docs/MyFuturesTradeTimeRange.md
@@ -3,17 +3,17 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**trade_id** | **str** | Trade ID | [optional]
-**create_time** | **float** | Trading time | [optional]
+**trade_id** | **str** | Fill ID | [optional]
+**create_time** | **float** | Fill Time | [optional]
**contract** | **str** | Futures contract | [optional]
-**order_id** | **str** | Order ID related | [optional]
+**order_id** | **str** | Related order ID | [optional]
**size** | **int** | Trading size | [optional]
-**close_size** | **int** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position | [optional]
-**price** | **str** | Trading price | [optional]
-**role** | **str** | Trade role. Available values are `taker` and `maker` | [optional]
-**text** | **str** | User defined information | [optional]
-**fee** | **str** | Fee deducted | [optional]
-**point_fee** | **str** | Points used to deduct fee | [optional]
+**close_size** | **int** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position | [optional]
+**price** | **str** | Fill Price | [optional]
+**role** | **str** | Trade role. taker - taker, maker - maker | [optional]
+**text** | **str** | Order custom information | [optional]
+**fee** | **str** | Trade fee | [optional]
+**point_fee** | **str** | Points used to deduct trade fee | [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)
diff --git a/docs/OpenOrders.md b/docs/OpenOrders.md
index 8c14eb2..ec395b5 100644
--- a/docs/OpenOrders.md
+++ b/docs/OpenOrders.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_pair** | **str** | Currency pair | [optional]
-**total** | **int** | The total number of pending orders for this trading pair on the current page | [optional]
+**total** | **int** | Total number of open orders for this trading pair on the current page | [optional]
**orders** | [**list[Order]**](Order.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)
diff --git a/docs/OptionsAccount.md b/docs/OptionsAccount.md
index 43bd0dc..d9a6eec 100644
--- a/docs/OptionsAccount.md
+++ b/docs/OptionsAccount.md
@@ -4,24 +4,24 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user** | **int** | User ID | [optional]
-**total** | **str** | 账户余额 | [optional]
-**position_value** | **str** | 仓位价值，做多仓位价值为正，做空仓位价值为负 | [optional]
-**equity** | **str** | 账户权益，账户余额与仓位价值的和 | [optional]
+**total** | **str** | Account Balance | [optional]
+**position_value** | **str** | Position value, long position value is positive, short position value is negative | [optional]
+**equity** | **str** | Account equity, the sum of account balance and position value | [optional]
**short_enabled** | **bool** | If the account is allowed to short | [optional]
-**mmp_enabled** | **bool** | 是否启用MMP | [optional]
-**liq_triggered** | **bool** | 是否触发仓位强平 | [optional]
+**mmp_enabled** | **bool** | Whether to enable MMP | [optional]
+**liq_triggered** | **bool** | Whether to trigger position liquidation | [optional]
**margin_mode** | **int** | ｜ 保证金模式： - 0：经典现货保证金模式 - 1：跨币种保证金模式 - 2：组合保证金模式 | [optional]
**unrealised_pnl** | **str** | Unrealized PNL | [optional]
**init_margin** | **str** | Initial position margin | [optional]
**maint_margin** | **str** | Position maintenance margin | [optional]
**order_margin** | **str** | Order margin of unfinished orders | [optional]
-**ask_order_margin** | **str** | 未完成卖单的保证金 | [optional]
-**bid_order_margin** | **str** | 未完成买单的保证金 | [optional]
+**ask_order_margin** | **str** | Margin for outstanding sell orders | [optional]
+**bid_order_margin** | **str** | Margin for outstanding buy orders | [optional]
**available** | **str** | Available balance to transfer out or trade | [optional]
-**point** | **str** | POINT amount | [optional]
-**currency** | **str** | Settle currency | [optional]
-**orders_limit** | **int** | 未完成订单数量上限 | [optional]
-**position_notional_limit** | **int** | 名义价值上限，包含仓位以及未完成订单的名义价值 | [optional]
+**point** | **str** | Point card amount | [optional]
+**currency** | **str** | Settlement currency | [optional]
+**orders_limit** | **int** | Maximum number of outstanding orders | [optional]
+**position_notional_limit** | **int** | Notional value upper limit, including the nominal value of positions and outstanding orders | [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)
diff --git a/docs/OptionsAccountBook.md b/docs/OptionsAccountBook.md
index 2b4a4a5..8ae81ce 100644
--- a/docs/OptionsAccountBook.md
+++ b/docs/OptionsAccountBook.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
**time** | **float** | Change time | [optional]
**change** | **str** | Amount changed (USDT) | [optional]
**balance** | **str** | Account total balance after change (USDT) | [optional]
-**type** | **str** | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional]
-**text** | **str** | custom text | [optional]
+**type** | **str** | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional]
+**text** | **str** | Remark | [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)
diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md
index c72a395..de8bf8b 100644
--- a/docs/OptionsApi.md
+++ b/docs/OptionsApi.md
@@ -4,32 +4,32 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_options_underlyings**](OptionsApi.md#list_options_underlyings) | **GET** /options/underlyings | List all underlyings
-[**list_options_expirations**](OptionsApi.md#list_options_expirations) | **GET** /options/expirations | List all expiration times
-[**list_options_contracts**](OptionsApi.md#list_options_contracts) | **GET** /options/contracts | List all the contracts with specified underlying and expiration time
-[**get_options_contract**](OptionsApi.md#get_options_contract) | **GET** /options/contracts/{contract} | Query specified contract detail
+[**list_options_underlyings**](OptionsApi.md#list_options_underlyings) | **GET** /options/underlyings | List all underlying assets
+[**list_options_expirations**](OptionsApi.md#list_options_expirations) | **GET** /options/expirations | List all expiration dates
+[**list_options_contracts**](OptionsApi.md#list_options_contracts) | **GET** /options/contracts | List all contracts for specified underlying and expiration date
+[**get_options_contract**](OptionsApi.md#get_options_contract) | **GET** /options/contracts/{contract} | Query specified contract details
[**list_options_settlements**](OptionsApi.md#list_options_settlements) | **GET** /options/settlements | List settlement history
-[**get_options_settlement**](OptionsApi.md#get_options_settlement) | **GET** /options/settlements/{contract} | Get specified contract's settlement
-[**list_my_options_settlements**](OptionsApi.md#list_my_options_settlements) | **GET** /options/my_settlements | List my options settlements
-[**list_options_order_book**](OptionsApi.md#list_options_order_book) | **GET** /options/order_book | Options order book
-[**list_options_tickers**](OptionsApi.md#list_options_tickers) | **GET** /options/tickers | List tickers of options contracts
-[**list_options_underlying_tickers**](OptionsApi.md#list_options_underlying_tickers) | **GET** /options/underlying/tickers/{underlying} | Get underlying ticker
-[**list_options_candlesticks**](OptionsApi.md#list_options_candlesticks) | **GET** /options/candlesticks | Get options candlesticks
-[**list_options_underlying_candlesticks**](OptionsApi.md#list_options_underlying_candlesticks) | **GET** /options/underlying/candlesticks | Mark price candlesticks of an underlying
-[**list_options_trades**](OptionsApi.md#list_options_trades) | **GET** /options/trades | Options trade history
-[**list_options_account**](OptionsApi.md#list_options_account) | **GET** /options/accounts | List options account
-[**list_options_account_book**](OptionsApi.md#list_options_account_book) | **GET** /options/account_book | List account changing history
+[**get_options_settlement**](OptionsApi.md#get_options_settlement) | **GET** /options/settlements/{contract} | Get specified contract settlement information
+[**list_my_options_settlements**](OptionsApi.md#list_my_options_settlements) | **GET** /options/my_settlements | Query personal settlement records
+[**list_options_order_book**](OptionsApi.md#list_options_order_book) | **GET** /options/order_book | Query options contract order book
+[**list_options_tickers**](OptionsApi.md#list_options_tickers) | **GET** /options/tickers | Query options market ticker information
+[**list_options_underlying_tickers**](OptionsApi.md#list_options_underlying_tickers) | **GET** /options/underlying/tickers/{underlying} | Query underlying ticker information
+[**list_options_candlesticks**](OptionsApi.md#list_options_candlesticks) | **GET** /options/candlesticks | Options contract market candlestick chart
+[**list_options_underlying_candlesticks**](OptionsApi.md#list_options_underlying_candlesticks) | **GET** /options/underlying/candlesticks | Underlying index price candlestick chart
+[**list_options_trades**](OptionsApi.md#list_options_trades) | **GET** /options/trades | Market trade records
+[**list_options_account**](OptionsApi.md#list_options_account) | **GET** /options/accounts | Query account information
+[**list_options_account_book**](OptionsApi.md#list_options_account_book) | **GET** /options/account_book | Query account change history
[**list_options_positions**](OptionsApi.md#list_options_positions) | **GET** /options/positions | List user's positions of specified underlying
[**get_options_position**](OptionsApi.md#get_options_position) | **GET** /options/positions/{contract} | Get specified contract position
[**list_options_position_close**](OptionsApi.md#list_options_position_close) | **GET** /options/position_close | List user's liquidation history of specified underlying
[**list_options_orders**](OptionsApi.md#list_options_orders) | **GET** /options/orders | List options orders
[**create_options_order**](OptionsApi.md#create_options_order) | **POST** /options/orders | Create an options order
-[**cancel_options_orders**](OptionsApi.md#cancel_options_orders) | **DELETE** /options/orders | Cancel all `open` orders matched
-[**get_options_order**](OptionsApi.md#get_options_order) | **GET** /options/orders/{order_id} | Get a single order
-[**cancel_options_order**](OptionsApi.md#cancel_options_order) | **DELETE** /options/orders/{order_id} | Cancel a single order
+[**cancel_options_orders**](OptionsApi.md#cancel_options_orders) | **DELETE** /options/orders | Cancel all orders with 'open' status
+[**get_options_order**](OptionsApi.md#get_options_order) | **GET** /options/orders/{order_id} | Query single order details
+[**cancel_options_order**](OptionsApi.md#cancel_options_order) | **DELETE** /options/orders/{order_id} | Cancel single order
[**countdown_cancel_all_options**](OptionsApi.md#countdown_cancel_all_options) | **POST** /options/countdown_cancel_all | Countdown cancel orders
-[**list_my_options_trades**](OptionsApi.md#list_my_options_trades) | **GET** /options/my_trades | List personal trading history
-[**get_options_mmp**](OptionsApi.md#get_options_mmp) | **GET** /options/mmp | MMP Query
+[**list_my_options_trades**](OptionsApi.md#list_my_options_trades) | **GET** /options/my_trades | Query personal trading records
+[**get_options_mmp**](OptionsApi.md#get_options_mmp) | **GET** /options/mmp | MMP Query.
[**set_options_mmp**](OptionsApi.md#set_options_mmp) | **POST** /options/mmp | MMP Settings
[**reset_options_mmp**](OptionsApi.md#reset_options_mmp) | **POST** /options/mmp/reset | MMP Reset
@@ -37,7 +37,7 @@ Method | HTTP request | Description
# **list_options_underlyings**
> list[OptionsUnderlying] list_options_underlyings()
-List all underlyings
+List all underlying assets
### Example
@@ -56,7 +56,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.OptionsApi(api_client)
try:
- # List all underlyings
+ # List all underlying assets
api_response = api_instance.list_options_underlyings()
print(api_response)
except GateApiException as ex:
@@ -84,14 +84,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_options_expirations**
> list[int] list_options_expirations(underlying)
-List all expiration times
+List all expiration dates
### Example
@@ -111,7 +111,7 @@ api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
try:
- # List all expiration times
+ # List all expiration dates
api_response = api_instance.list_options_expirations(underlying)
print(api_response)
except GateApiException as ex:
@@ -142,14 +142,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List expiration times of specified underlying | - |
+**200** | List expiration dates for specified underlying | - |
[[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)
# **list_options_contracts**
> list[OptionsContract] list_options_contracts(underlying, expiration=expiration)
-List all the contracts with specified underlying and expiration time
+List all contracts for specified underlying and expiration date
### Example
@@ -167,10 +167,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
-expiration = 1636588800 # int | Unix timestamp of the expiration time (optional)
+expiration = 1636588800 # int | Unix timestamp of expiration date (optional)
try:
- # List all the contracts with specified underlying and expiration time
+ # List all contracts for specified underlying and expiration date
api_response = api_instance.list_options_contracts(underlying, expiration=expiration)
print(api_response)
except GateApiException as ex:
@@ -184,7 +184,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**underlying** | **str**| Underlying (Obtained by listing underlying endpoint) |
- **expiration** | **int**| Unix timestamp of the expiration time | [optional]
+ **expiration** | **int**| Unix timestamp of expiration date | [optional]
### Return type
@@ -202,14 +202,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_options_contract**
> OptionsContract get_options_contract(contract)
-Query specified contract detail
+Query specified contract details
### Example
@@ -229,7 +229,7 @@ api_instance = gate_api.OptionsApi(api_client)
contract = 'BTC_USDT-20211130-65000-C' # str |
try:
- # Query specified contract detail
+ # Query specified contract details
api_response = api_instance.get_options_contract(contract)
print(api_response)
except GateApiException as ex:
@@ -260,7 +260,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -285,10 +285,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
# List settlement history
@@ -305,10 +305,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**underlying** | **str**| Underlying (Obtained by listing underlying endpoint) |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -326,14 +326,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_options_settlement**
> OptionsSettlement get_options_settlement(contract, underlying, at)
-Get specified contract's settlement
+Get specified contract settlement information
### Example
@@ -355,7 +355,7 @@ underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpo
at = 56 # int |
try:
- # Get specified contract's settlement
+ # Get specified contract settlement information
api_response = api_instance.get_options_settlement(contract, underlying, at)
print(api_response)
except GateApiException as ex:
@@ -388,14 +388,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_my_options_settlements**
> list[OptionsMySettlements] list_my_options_settlements(underlying, contract=contract, limit=limit, offset=offset, _from=_from, to=to)
-List my options settlements
+Query personal settlement records
### Example
@@ -423,13 +423,13 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # List my options settlements
+ # Query personal settlement records
api_response = api_instance.list_my_options_settlements(underlying, contract=contract, limit=limit, offset=offset, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -444,10 +444,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**underlying** | **str**| Underlying (Obtained by listing underlying endpoint) |
**contract** | **str**| Options contract name | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -465,14 +465,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_options_order_book**
> FuturesOrderBook list_options_order_book(contract, interval=interval, limit=limit, with_id=with_id)
-Options order book
+Query options contract order book
Bids will be sorted by price from high to low, while asks sorted reversely
@@ -492,12 +492,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name
-interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
-limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)
-with_id = False # bool | Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional) (default to False)
+interval = '0' # str | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional) (default to '0')
+limit = 10 # int | Number of depth levels (optional) (default to 10)
+with_id = False # bool | Whether to return depth update ID. This ID increments by 1 each time depth changes (optional) (default to False)
try:
- # Options order book
+ # Query options contract order book
api_response = api_instance.list_options_order_book(contract, interval=interval, limit=limit, with_id=with_id)
print(api_response)
except GateApiException as ex:
@@ -511,9 +511,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contract** | **str**| Options contract name |
- **interval** | **str**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to '0']
- **limit** | **int**| Maximum number of order depth data in asks or bids | [optional] [default to 10]
- **with_id** | **bool**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to False]
+ **interval** | **str**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to '0']
+ **limit** | **int**| Number of depth levels | [optional] [default to 10]
+ **with_id** | **bool**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to False]
### Return type
@@ -531,14 +531,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Order book retrieved | - |
+**200** | Depth query successful | - |
[[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)
# **list_options_tickers**
> list[OptionsTicker] list_options_tickers(underlying)
-List tickers of options contracts
+Query options market ticker information
### Example
@@ -558,7 +558,7 @@ api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
try:
- # List tickers of options contracts
+ # Query options market ticker information
api_response = api_instance.list_options_tickers(underlying)
print(api_response)
except GateApiException as ex:
@@ -589,14 +589,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_options_underlying_tickers**
> OptionsUnderlyingTicker list_options_underlying_tickers(underlying)
-Get underlying ticker
+Query underlying ticker information
### Example
@@ -616,7 +616,7 @@ api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying
try:
- # Get underlying ticker
+ # Query underlying ticker information
api_response = api_instance.list_options_underlying_tickers(underlying)
print(api_response)
except GateApiException as ex:
@@ -647,14 +647,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_options_candlesticks**
> list[OptionsCandlestick] list_options_candlesticks(contract, limit=limit, _from=_from, to=to, interval=interval)
-Get options candlesticks
+Options contract market candlestick chart
### Example
@@ -672,13 +672,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-interval = '5m' # str | Interval time between data points (optional) (default to '5m')
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+interval = '5m' # str | Time interval between data points (optional) (default to '5m')
try:
- # Get options candlesticks
+ # Options contract market candlestick chart
api_response = api_instance.list_options_candlesticks(contract, limit=limit, _from=_from, to=to, interval=interval)
print(api_response)
except GateApiException as ex:
@@ -692,10 +692,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contract** | **str**| Options contract name |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **interval** | **str**| Interval time between data points | [optional] [default to '5m']
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **interval** | **str**| Time interval between data points | [optional] [default to '5m']
### Return type
@@ -713,14 +713,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_options_underlying_candlesticks**
> list[FuturesCandlestick] list_options_underlying_candlesticks(underlying, limit=limit, _from=_from, to=to, interval=interval)
-Mark price candlesticks of an underlying
+Underlying index price candlestick chart
### Example
@@ -738,13 +738,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-interval = '5m' # str | Interval time between data points (optional) (default to '5m')
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+interval = '5m' # str | Time interval between data points (optional) (default to '5m')
try:
- # Mark price candlesticks of an underlying
+ # Underlying index price candlestick chart
api_response = api_instance.list_options_underlying_candlesticks(underlying, limit=limit, _from=_from, to=to, interval=interval)
print(api_response)
except GateApiException as ex:
@@ -758,10 +758,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**underlying** | **str**| Underlying (Obtained by listing underlying endpoint) |
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **interval** | **str**| Interval time between data points | [optional] [default to '5m']
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **interval** | **str**| Time interval between data points | [optional] [default to '5m']
### Return type
@@ -779,14 +779,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_options_trades**
> list[FuturesTrade] list_options_trades(contract=contract, type=type, limit=limit, offset=offset, _from=_from, to=to)
-Options trade history
+Market trade records
### Example
@@ -804,14 +804,14 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional)
-type = '1546935600' # str | `C` is call, while `P` is put (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+type = '1546935600' # str | `C` for call, `P` for put (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # Options trade history
+ # Market trade records
api_response = api_instance.list_options_trades(contract=contract, type=type, limit=limit, offset=offset, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -825,11 +825,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contract** | **str**| Options contract name | [optional]
- **type** | **str**| `C` is call, while `P` is put | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **type** | **str**| `C` for call, `P` for put | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -847,14 +847,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_options_account**
> OptionsAccount list_options_account()
-List options account
+Query account information
### Example
@@ -882,7 +882,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.OptionsApi(api_client)
try:
- # List options account
+ # Query account information
api_response = api_instance.list_options_account()
print(api_response)
except GateApiException as ex:
@@ -910,14 +910,14 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_options_account_book**
> list[OptionsAccountBook] list_options_account_book(limit=limit, offset=offset, _from=_from, to=to, type=type)
-List account changing history
+Query account change history
### Example
@@ -943,14 +943,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
-type = 'dnw' # str | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
+type = 'dnw' # str | Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L (optional)
try:
- # List account changing history
+ # Query account change history
api_response = api_instance.list_options_account_book(limit=limit, offset=offset, _from=_from, to=to, type=type)
print(api_response)
except GateApiException as ex:
@@ -963,11 +963,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
- **type** | **str**| Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
+ **type** | **str**| Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L | [optional]
### Return type
@@ -985,7 +985,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1052,7 +1052,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1119,7 +1119,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1188,7 +1188,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1221,13 +1221,13 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
-status = 'open' # str | Only list the orders with this status
+status = 'open' # str | Query order list based on status
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional)
underlying = 'BTC_USDT' # str | Underlying (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
# List options orders
@@ -1243,13 +1243,13 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **status** | **str**| Only list the orders with this status |
+ **status** | **str**| Query order list based on status |
**contract** | **str**| Options contract name | [optional]
**underlying** | **str**| Underlying | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -1267,7 +1267,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1341,7 +1341,7 @@ Name | Type | Description | Notes
# **cancel_options_orders**
> list[OptionsOrder] cancel_options_orders(contract=contract, underlying=underlying, side=side)
-Cancel all `open` orders matched
+Cancel all orders with 'open' status
### Example
@@ -1369,10 +1369,10 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.OptionsApi(api_client)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional)
underlying = 'BTC_USDT' # str | Underlying (optional)
-side = 'ask' # str | All bids or asks. Both included if not specified (optional)
+side = 'ask' # str | Specify all bids or all asks, both included if not specified (optional)
try:
- # Cancel all `open` orders matched
+ # Cancel all orders with 'open' status
api_response = api_instance.cancel_options_orders(contract=contract, underlying=underlying, side=side)
print(api_response)
except GateApiException as ex:
@@ -1387,7 +1387,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contract** | **str**| Options contract name | [optional]
**underlying** | **str**| Underlying | [optional]
- **side** | **str**| All bids or asks. Both included if not specified | [optional]
+ **side** | **str**| Specify all bids or all asks, both included if not specified | [optional]
### Return type
@@ -1405,14 +1405,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | All orders matched cancelled | - |
+**200** | Batch cancellation successful | - |
[[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)
# **get_options_order**
> OptionsOrder get_options_order(order_id)
-Get a single order
+Query single order details
### Example
@@ -1438,10 +1438,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
-order_id = 12345 # int | Order ID returned on successful order creation
+order_id = 12345 # int | Order ID returned when order is successfully created
try:
- # Get a single order
+ # Query single order details
api_response = api_instance.get_options_order(order_id)
print(api_response)
except GateApiException as ex:
@@ -1454,7 +1454,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **int**| Order ID returned on successful order creation |
+ **order_id** | **int**| Order ID returned when order is successfully created |
### Return type
@@ -1479,7 +1479,7 @@ Name | Type | Description | Notes
# **cancel_options_order**
> OptionsOrder cancel_options_order(order_id)
-Cancel a single order
+Cancel single order
### Example
@@ -1505,10 +1505,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.OptionsApi(api_client)
-order_id = 12345 # int | Order ID returned on successful order creation
+order_id = 12345 # int | Order ID returned when order is successfully created
try:
- # Cancel a single order
+ # Cancel single order
api_response = api_instance.cancel_options_order(order_id)
print(api_response)
except GateApiException as ex:
@@ -1521,7 +1521,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **int**| Order ID returned on successful order creation |
+ **order_id** | **int**| Order ID returned when order is successfully created |
### Return type
@@ -1548,7 +1548,7 @@ Name | Type | Description | Notes
Countdown cancel orders
-Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled.
+Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled.
### Example
@@ -1608,14 +1608,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Set countdown successfully | - |
+**200** | Countdown set successfully | - |
[[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)
# **list_my_options_trades**
> list[OptionsMyTrade] list_my_options_trades(underlying, contract=contract, limit=limit, offset=offset, _from=_from, to=to)
-List personal trading history
+Query personal trading records
### Example
@@ -1643,13 +1643,13 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint)
contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
-_from = 1547706332 # int | Start timestamp (optional)
-to = 1547706332 # int | End timestamp (optional)
+_from = 1547706332 # int | Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) (optional)
+to = 1547706332 # int | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional)
try:
- # List personal trading history
+ # Query personal trading records
api_response = api_instance.list_my_options_trades(underlying, contract=contract, limit=limit, offset=offset, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -1664,10 +1664,10 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**underlying** | **str**| Underlying (Obtained by listing underlying endpoint) |
**contract** | **str**| Options contract name | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
- **_from** | **int**| Start timestamp | [optional]
- **to** | **int**| End timestamp | [optional]
+ **_from** | **int**| Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit) | [optional]
+ **to** | **int**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional]
### Return type
@@ -1685,14 +1685,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_options_mmp**
> list[OptionsMMP] get_options_mmp(underlying=underlying)
-MMP Query
+MMP Query.
### Example
@@ -1721,7 +1721,7 @@ api_instance = gate_api.OptionsApi(api_client)
underlying = 'BTC_USDT' # str | Underlying (optional)
try:
- # MMP Query
+ # MMP Query.
api_response = api_instance.get_options_mmp(underlying=underlying)
print(api_response)
except GateApiException as ex:
@@ -1752,7 +1752,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
diff --git a/docs/OptionsContract.md b/docs/OptionsContract.md
index ee11273..ea9845a 100644
--- a/docs/OptionsContract.md
+++ b/docs/OptionsContract.md
@@ -1,34 +1,34 @@
# OptionsContract
-Options contract detail
+Options contract details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Options contract name | [optional]
-**tag** | **str** | tag | [optional]
-**create_time** | **float** | Creation time | [optional]
+**tag** | **str** | Tag | [optional]
+**create_time** | **float** | Created time | [optional]
**expiration_time** | **float** | Expiration time | [optional]
-**is_call** | **bool** | `true` means call options, while `false` is put options | [optional]
+**is_call** | **bool** | `true` means call options, `false` means put options | [optional]
**multiplier** | **str** | Multiplier used in converting from invoicing to settlement currency | [optional]
**underlying** | **str** | Underlying | [optional]
**underlying_price** | **str** | Underlying price (quote currency) | [optional]
**last_price** | **str** | Last trading price | [optional]
**mark_price** | **str** | Current mark price (quote currency) | [optional]
**index_price** | **str** | Current index price (quote currency) | [optional]
-**maker_fee_rate** | **str** | Maker fee rate, where negative means rebate | [optional]
+**maker_fee_rate** | **str** | Maker fee rate, negative values indicate rebates | [optional]
**taker_fee_rate** | **str** | Taker fee rate | [optional]
**order_price_round** | **str** | Minimum order price increment | [optional]
**mark_price_round** | **str** | Minimum mark price increment | [optional]
-**order_size_min** | **int** | Minimum order size the contract allowed | [optional]
-**order_size_max** | **int** | Maximum order size the contract allowed | [optional]
-**order_price_deviate** | **str** | The positive and negative offset allowed between the order price and the current mark price, that is, the order price `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders | [optional]
-**ref_discount_rate** | **str** | Referral fee rate discount | [optional]
-**ref_rebate_rate** | **str** | Referrer commission rate | [optional]
-**orderbook_id** | **int** | Current orderbook ID | [optional]
+**order_size_min** | **int** | Minimum order size allowed by the contract | [optional]
+**order_size_max** | **int** | Maximum order size allowed by the contract | [optional]
+**order_price_deviate** | **str** | The positive and negative offset allowed between the order price and the current mark price, that `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders | [optional]
+**ref_discount_rate** | **str** | Trading fee discount for referred users | [optional]
+**ref_rebate_rate** | **str** | Commission rate for referrers | [optional]
+**orderbook_id** | **int** | Orderbook update ID | [optional]
**trade_id** | **int** | Current trade ID | [optional]
-**trade_size** | **int** | Historical accumulated trade size | [optional]
+**trade_size** | **int** | Historical cumulative trading volume | [optional]
**position_size** | **int** | Current total long position size | [optional]
-**orders_limit** | **int** | Maximum number of open orders | [optional]
+**orders_limit** | **int** | Maximum number of pending orders | [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)
diff --git a/docs/OptionsMMP.md b/docs/OptionsMMP.md
index fe31af9..2e8b73f 100644
--- a/docs/OptionsMMP.md
+++ b/docs/OptionsMMP.md
@@ -5,12 +5,12 @@ MMP Settings
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**underlying** | **str** | Underlying |
-**window** | **int** | 时间窗口（毫秒），1-5000之间，0表示停用MMP |
-**frozen_period** | **int** | 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 |
-**qty_limit** | **str** | 成交量上限（正数，至多2位小数） |
-**delta_limit** | **str** | 净delta值上限（正数，至多2位小数） |
-**trigger_time_ms** | **int** | 触发冻结时间（毫秒），0表示没有触发冻结 | [optional] [readonly]
-**frozen_until_ms** | **int** | 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 | [optional] [readonly]
+**window** | **int** | Time window (milliseconds), between 1-5000, 0 means disable MMP |
+**frozen_period** | **int** | Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze |
+**qty_limit** | **str** | Trading volume upper limit (positive number, up to 2 decimal places) |
+**delta_limit** | **str** | Upper limit of net delta value (positive number, up to 2 decimal places) |
+**trigger_time_ms** | **int** | Trigger freeze time (milliseconds), 0 means no freeze is triggered | [optional] [readonly]
+**frozen_until_ms** | **int** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered | [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)
diff --git a/docs/OptionsMMPReset.md b/docs/OptionsMMPReset.md
index 5d70798..1244357 100644
--- a/docs/OptionsMMPReset.md
+++ b/docs/OptionsMMPReset.md
@@ -5,12 +5,12 @@ MMP Reset
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**underlying** | **str** | Underlying |
-**window** | **int** | 时间窗口（毫秒），1-5000之间，0表示停用MMP | [optional] [readonly]
-**frozen_period** | **int** | 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 | [optional] [readonly]
-**qty_limit** | **str** | 成交量上限（正数，至多2位小数） | [optional] [readonly]
-**delta_limit** | **str** | 净delta值上限（正数，至多2位小数） | [optional] [readonly]
-**trigger_time_ms** | **int** | 触发冻结时间（毫秒），0表示没有触发冻结 | [optional] [readonly]
-**frozen_until_ms** | **int** | 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 | [optional] [readonly]
+**window** | **int** | Time window (milliseconds), between 1-5000, 0 means disable MMP | [optional] [readonly]
+**frozen_period** | **int** | Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze | [optional] [readonly]
+**qty_limit** | **str** | Trading volume upper limit (positive number, up to 2 decimal places) | [optional] [readonly]
+**delta_limit** | **str** | Upper limit of net delta value (positive number, up to 2 decimal places) | [optional] [readonly]
+**trigger_time_ms** | **int** | Trigger freeze time (milliseconds), 0 means no freeze is triggered | [optional] [readonly]
+**frozen_until_ms** | **int** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered | [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)
diff --git a/docs/OptionsMySettlements.md b/docs/OptionsMySettlements.md
index fc2ef9d..c6df4a3 100644
--- a/docs/OptionsMySettlements.md
+++ b/docs/OptionsMySettlements.md
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
**contract** | **str** | Options contract name | [optional]
**strike_price** | **str** | Strike price (quote currency) | [optional]
**settle_price** | **str** | Settlement price (quote currency) | [optional]
-**size** | **int** | Size | [optional]
+**size** | **int** | Settlement size | [optional]
**settle_profit** | **str** | Settlement profit (quote currency) | [optional]
-**fee** | **str** | Fee (quote currency) | [optional]
-**realised_pnl** | **str** | The accumulated profit and loss of opening a position, including premium, fee, settlement profit, etc. (quote currency) | [optional]
+**fee** | **str** | Settlement fee (quote currency) | [optional]
+**realised_pnl** | **str** | Accumulated profit and loss from opening positions, including premium, fees, settlement profit, etc. (quote currency) | [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)
diff --git a/docs/OptionsMyTrade.md b/docs/OptionsMyTrade.md
index 44eb069..115f8ca 100644
--- a/docs/OptionsMyTrade.md
+++ b/docs/OptionsMyTrade.md
@@ -3,14 +3,14 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Trade ID | [optional]
-**create_time** | **float** | Trading time | [optional]
+**id** | **int** | Fill ID | [optional]
+**create_time** | **float** | Fill Time | [optional]
**contract** | **str** | Options contract name | [optional]
-**order_id** | **int** | Order ID related | [optional]
+**order_id** | **int** | Related order ID | [optional]
**size** | **int** | Trading size | [optional]
-**price** | **str** | Trading price (quote currency) | [optional]
+**price** | **str** | Trade price (quote currency) | [optional]
**underlying_price** | **str** | Underlying price (quote currency) | [optional]
-**role** | **str** | Trade role. Available values are `taker` and `maker` | [optional]
+**role** | **str** | Trade role. taker - taker, maker - maker | [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)
diff --git a/docs/OptionsOrder.md b/docs/OptionsOrder.md
index 190713b..484b6e0 100644
--- a/docs/OptionsOrder.md
+++ b/docs/OptionsOrder.md
@@ -1,6 +1,6 @@
# OptionsOrder
-Options order detail
+Options order details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -8,26 +8,26 @@ Name | Type | Description | Notes
**user** | **int** | User ID | [optional] [readonly]
**create_time** | **float** | Creation time of order | [optional] [readonly]
**finish_time** | **float** | Order finished time. Not returned if order is open | [optional] [readonly]
-**finish_as** | **str** | 结束方式，包括： - filled: 完全成交 - cancelled: 用户撤销 - liquidated: 强制平仓撤销 - ioc: 未立即完全成交，因为tif设置为ioc - auto_deleveraged: 自动减仓撤销 - reduce_only: 增持仓位撤销，因为设置reduce_only或平仓 - position_closed: 因为仓位平掉了，所以挂单被撤掉 - reduce_out: 只减仓被排除的不容易成交的挂单 - mmp_cancelled: MMP撤销 | [optional] [readonly]
-**status** | **str** | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly]
-**contract** | **str** | Contract name |
-**size** | **int** | Order size. Specify positive number to make a bid, and negative number to ask |
-**iceberg** | **int** | Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size | [optional]
-**price** | **str** | Order price. 0 for market order with `tif` set as `ioc` (USDT) | [optional]
+**finish_as** | **str** | Order finish reason: - filled: Fully filled - cancelled: User cancelled - liquidated: Cancelled due to liquidation - ioc: Not immediately fully filled due to IOC time-in-force setting - auto_deleveraged: Cancelled due to auto-deleveraging - reduce_only: Cancelled due to position increase while reduce-only is set - position_closed: Cancelled because the position was closed - reduce_out: Only reduce positions by excluding hard-to-fill orders - mmp_cancelled: Cancelled by MMP | [optional] [readonly]
+**status** | **str** | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly]
+**contract** | **str** | Options identifier |
+**size** | **int** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. |
+**iceberg** | **int** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional]
+**price** | **str** | Order price. Price of 0 with `tif` set as `ioc` represents market order (quote currency) | [optional]
**close** | **bool** | Set as `true` to close the position, with `size` set to 0 | [optional] [default to False]
**is_close** | **bool** | Is the order to close position | [optional] [readonly]
**reduce_only** | **bool** | Set as `true` to be reduce-only order | [optional] [default to False]
**is_reduce_only** | **bool** | Is the order reduce-only | [optional] [readonly]
**is_liq** | **bool** | Is the order for liquidation | [optional] [readonly]
-**mmp** | **bool** | 设置为 true 的时候，为MMP委托 | [optional] [default to False]
-**is_mmp** | **bool** | 是否为MMP委托。对应请求中的`mmp`。 | [optional] [readonly]
-**tif** | **str** | Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee | [optional] [default to 'gtc']
-**left** | **int** | Size left to be traded | [optional] [readonly]
-**fill_price** | **str** | Fill price of the order | [optional] [readonly]
+**mmp** | **bool** | When set to true, it is an MMP order | [optional] [default to False]
+**is_mmp** | **bool** | Whether it is an MMP order. Corresponds to `mmp` in the request | [optional] [readonly]
+**tif** | **str** | Time in force strategy. Market orders currently only support IOC mode - gtc: Good Till Cancelled - ioc: Immediate Or Cancelled, execute immediately or cancel, taker only - poc: Pending Or Cancelled, passive order, maker only | [optional] [default to 'gtc']
+**left** | **int** | Unfilled quantity | [optional] [readonly]
+**fill_price** | **str** | Fill price | [optional] [readonly]
**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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance | [optional]
**tkfr** | **str** | Taker fee | [optional] [readonly]
**mkfr** | **str** | Maker fee | [optional] [readonly]
-**refu** | **int** | Reference user ID | [optional] [readonly]
+**refu** | **int** | Referrer user ID | [optional] [readonly]
**refr** | **str** | Referrer rebate | [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)
diff --git a/docs/OptionsPosition.md b/docs/OptionsPosition.md
index 282039d..b6dbefe 100644
--- a/docs/OptionsPosition.md
+++ b/docs/OptionsPosition.md
@@ -1,6 +1,6 @@
# OptionsPosition
-Options position information
+Options contract position details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -8,18 +8,18 @@ Name | Type | Description | Notes
**underlying** | **str** | Underlying | [optional] [readonly]
**underlying_price** | **str** | Underlying price (quote currency) | [optional] [readonly]
**contract** | **str** | Options contract name | [optional] [readonly]
-**size** | **int** | Position size (contract size) | [optional] [readonly]
+**size** | **int** | Position size (contract quantity) | [optional] [readonly]
**entry_price** | **str** | Entry size (quote currency) | [optional] [readonly]
**mark_price** | **str** | Current mark price (quote currency) | [optional] [readonly]
**mark_iv** | **str** | Implied volatility | [optional] [readonly]
-**realised_pnl** | **str** | Realized PNL | [optional] [readonly]
+**realised_pnl** | **str** | Realized PnL | [optional] [readonly]
**unrealised_pnl** | **str** | Unrealized PNL | [optional] [readonly]
-**pending_orders** | **int** | Current open orders | [optional] [readonly]
+**pending_orders** | **int** | Current pending order quantity | [optional] [readonly]
**close_order** | [**OptionsPositionCloseOrder**](OptionsPositionCloseOrder.md) | | [optional]
-**delta** | **str** | Delta | [optional] [readonly]
-**gamma** | **str** | Gamma | [optional] [readonly]
-**vega** | **str** | Vega | [optional] [readonly]
-**theta** | **str** | Theta | [optional] [readonly]
+**delta** | **str** | Greek letter delta | [optional] [readonly]
+**gamma** | **str** | Greek letter gamma | [optional] [readonly]
+**vega** | **str** | Greek letter vega | [optional] [readonly]
+**theta** | **str** | Greek letter theta | [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)
diff --git a/docs/OptionsPositionClose.md b/docs/OptionsPositionClose.md
index bf5479d..ea97971 100644
--- a/docs/OptionsPositionClose.md
+++ b/docs/OptionsPositionClose.md
@@ -5,10 +5,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time** | **float** | Position close time | [optional] [readonly]
**contract** | **str** | Options contract name | [optional] [readonly]
-**side** | **str** | Position side, long or short | [optional] [readonly]
-**pnl** | **str** | PNL | [optional] [readonly]
-**text** | **str** | Text of close order | [optional] [readonly]
-**settle_size** | **str** | settlement size | [optional] [readonly]
+**side** | **str** | Position side - `long`: Long position - `short`: Short position | [optional] [readonly]
+**pnl** | **str** | PnL | [optional] [readonly]
+**text** | **str** | Source of close order. See `order.text` field for specific values | [optional] [readonly]
+**settle_size** | **str** | Settlement size | [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)
diff --git a/docs/OptionsPositionCloseOrder.md b/docs/OptionsPositionCloseOrder.md
index 53044b1..77d345c 100644
--- a/docs/OptionsPositionCloseOrder.md
+++ b/docs/OptionsPositionCloseOrder.md
@@ -1,12 +1,12 @@
# OptionsPositionCloseOrder
-Current close order if any, or `null`
+Current close order information, or `null` if no close order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Close order ID | [optional]
-**price** | **str** | Close order price （quote currency) | [optional]
-**is_liq** | **bool** | Is the close order from liquidation | [optional]
+**id** | **int** | Order ID | [optional]
+**price** | **str** | Order price (quote currency) | [optional]
+**is_liq** | **bool** | Whether the close order is from liquidation | [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)
diff --git a/docs/OptionsSettlement.md b/docs/OptionsSettlement.md
index 6e5b8b6..651d917 100644
--- a/docs/OptionsSettlement.md
+++ b/docs/OptionsSettlement.md
@@ -3,10 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**time** | **float** | Last changed time of configuration | [optional]
+**time** | **float** | Last configuration update time | [optional]
**contract** | **str** | Options contract name | [optional]
-**profit** | **str** | Settlement profit per size (quote currency) | [optional]
-**fee** | **str** | Settlement fee per size (quote currency) | [optional]
+**profit** | **str** | Settlement profit per contract (quote currency) | [optional]
+**fee** | **str** | Settlement fee per contract (quote currency) | [optional]
**strike_price** | **str** | Strike price (quote currency) | [optional]
**settle_price** | **str** | Settlement price (quote currency) | [optional]
diff --git a/docs/OptionsTicker.md b/docs/OptionsTicker.md
index 43b4b46..1fef6d8 100644
--- a/docs/OptionsTicker.md
+++ b/docs/OptionsTicker.md
@@ -1,11 +1,11 @@
# OptionsTicker
-Options contract detail
+Options contract details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Options contract name | [optional]
-**last_price** | **str** | Last trading price (quote currency) | [optional]
+**last_price** | **str** | Last trade price (quote currency) | [optional]
**mark_price** | **str** | Current mark price (quote currency) | [optional]
**index_price** | **str** | Current index price (quote currency) | [optional]
**ask1_size** | **int** | Best ask size | [optional]
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
**bid_iv** | **str** | Bid side implied volatility | [optional]
**ask_iv** | **str** | Ask side implied volatility | [optional]
**leverage** | **str** | Current leverage. Formula: underlying_price / mark_price * delta | [optional]
-**delta** | **str** | Delta | [optional]
-**gamma** | **str** | Gamma | [optional]
-**vega** | **str** | Vega | [optional]
-**theta** | **str** | Theta | [optional]
+**delta** | **str** | Greek letter delta | [optional]
+**gamma** | **str** | Greek letter gamma | [optional]
+**vega** | **str** | Greek letter vega | [optional]
+**theta** | **str** | Greek letter theta | [optional]
**rho** | **str** | Rho | [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)
diff --git a/docs/Order.md b/docs/Order.md
index 63015be..7eb5f0a 100644
--- a/docs/Order.md
+++ b/docs/Order.md
@@ -13,17 +13,17 @@ Name | Type | Description | Notes
**update_time_ms** | **int** | Last modification time of order (in milliseconds) | [optional] [readonly]
**status** | **str** | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly]
**currency_pair** | **str** | Currency pair |
-**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
-**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] [default to 'spot']
-**side** | **str** | Order side |
-**amount** | **str** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` |
-**price** | **str** | Price can't be empty when `type`= `limit` | [optional]
+**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
+**account** | **str** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] [default to 'spot']
+**side** | **str** | Buy or sell order |
+**amount** | **str** | Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` |
+**price** | **str** | Trading price, required when `type`=`limit` | [optional]
**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 Only `ioc` and `fok` are supported when `type`=`market` | [optional] [default to 'gtc']
-**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional]
-**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional]
-**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional]
+**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional]
+**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional]
+**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order | [optional]
**left** | **str** | Amount left to fill | [optional] [readonly]
-**filled_amount** | **str** | Amount traded to fill | [optional] [readonly]
+**filled_amount** | **str** | Amount filled | [optional] [readonly]
**fill_price** | **str** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly]
**filled_total** | **str** | Total filled in quote currency | [optional] [readonly]
**avg_deal_price** | **str** | Average fill price | [optional] [readonly]
@@ -31,14 +31,14 @@ Name | Type | Description | Notes
**fee_currency** | **str** | Fee currency unit | [optional] [readonly]
**point_fee** | **str** | Points used to deduct fee | [optional] [readonly]
**gt_fee** | **str** | GT used to deduct fee | [optional] [readonly]
-**gt_maker_fee** | **str** | GT used to deduct maker fee | [optional] [readonly]
-**gt_taker_fee** | **str** | GT used to deduct taker fee | [optional] [readonly]
-**gt_discount** | **bool** | Whether GT fee discount is used | [optional] [readonly]
+**gt_maker_fee** | **str** | GT amount used to deduct maker fee | [optional] [readonly]
+**gt_taker_fee** | **str** | GT amount used to deduct taker fee | [optional] [readonly]
+**gt_discount** | **bool** | Whether GT fee deduction is enabled | [optional] [readonly]
**rebated_fee** | **str** | Rebated fee | [optional] [readonly]
**rebated_fee_currency** | **str** | Rebated fee currency unit | [optional] [readonly]
**stp_id** | **int** | Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group` | [optional] [readonly]
-**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
-**finish_as** | **str** | Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown | [optional] [readonly]
+**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled | [optional]
+**finish_as** | **str** | Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown | [optional] [readonly]
**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]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/OrderBook.md b/docs/OrderBook.md
index 1cd4f55..2bfae72 100644
--- a/docs/OrderBook.md
+++ b/docs/OrderBook.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
**id** | **int** | Order book ID, which is updated whenever the order book is changed. Valid only when `with_id` is set to `true` | [optional]
**current** | **int** | The timestamp of the response data being generated (in milliseconds) | [optional]
**update** | **int** | The timestamp of when the orderbook last changed (in milliseconds) | [optional]
-**asks** | **list[list[str]]** | Asks order depth |
-**bids** | **list[list[str]]** | Bids order depth |
+**asks** | **list[list[str]]** | Ask Depth |
+**bids** | **list[list[str]]** | Bid Depth |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/OrderCancel.md b/docs/OrderCancel.md
index 6178215..0a14fe2 100644
--- a/docs/OrderCancel.md
+++ b/docs/OrderCancel.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**id** | **str** | Order ID | [optional] [readonly]
**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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - 101: from android - 102: from IOS - 103: from IPAD - 104: from webapp - 3: from web - 2: from apiv2 - apiv4: from apiv4 | [optional]
**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional] [readonly]
-**succeeded** | **bool** | Whether the batch of orders succeeded | [optional]
+**succeeded** | **bool** | Request execution result | [optional]
**label** | **str** | Error label, if any, otherwise an empty string | [optional]
**message** | **str** | Detailed error message, if any, otherwise an empty string | [optional]
**create_time** | **str** | Creation time of order | [optional] [readonly]
@@ -16,17 +16,17 @@ Name | Type | Description | Notes
**update_time_ms** | **int** | Last modification time of order (in milliseconds) | [optional] [readonly]
**status** | **str** | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly]
**currency_pair** | **str** | Currency pair |
-**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
-**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] [default to 'spot']
-**side** | **str** | Order side |
-**amount** | **str** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` |
-**price** | **str** | Price can't be empty when `type`= `limit` | [optional]
+**type** | **str** | Order Type - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
+**account** | **str** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] [default to 'spot']
+**side** | **str** | Buy or sell order |
+**amount** | **str** | Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` |
+**price** | **str** | Trading price, required when `type`=`limit` | [optional]
**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 Only `ioc` and `fok` are supported when `type`=`market` | [optional] [default to 'gtc']
-**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional]
-**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional]
-**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional]
+**iceberg** | **str** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional]
+**auto_borrow** | **bool** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional]
+**auto_repay** | **bool** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order | [optional]
**left** | **str** | Amount left to fill | [optional] [readonly]
-**filled_amount** | **str** | Amount traded to fill | [optional] [readonly]
+**filled_amount** | **str** | Amount filled | [optional] [readonly]
**fill_price** | **str** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly]
**filled_total** | **str** | Total filled in quote currency | [optional] [readonly]
**avg_deal_price** | **str** | Average fill price | [optional] [readonly]
@@ -34,13 +34,13 @@ Name | Type | Description | Notes
**fee_currency** | **str** | Fee currency unit | [optional] [readonly]
**point_fee** | **str** | Points used to deduct fee | [optional] [readonly]
**gt_fee** | **str** | GT used to deduct fee | [optional] [readonly]
-**gt_maker_fee** | **str** | GT used to deduct maker fee | [optional] [readonly]
-**gt_taker_fee** | **str** | GT used to deduct taker fee | [optional] [readonly]
-**gt_discount** | **bool** | Whether GT fee discount is used | [optional] [readonly]
+**gt_maker_fee** | **str** | GT amount used to deduct maker fee | [optional] [readonly]
+**gt_taker_fee** | **str** | GT amount used to deduct taker fee | [optional] [readonly]
+**gt_discount** | **bool** | Whether GT fee deduction is enabled | [optional] [readonly]
**rebated_fee** | **str** | Rebated fee | [optional] [readonly]
**rebated_fee_currency** | **str** | Rebated fee currency unit | [optional] [readonly]
**stp_id** | **int** | Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group` | [optional] [readonly]
-**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional]
+**stp_act** | **str** | Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled | [optional]
**finish_as** | **str** | How the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention | [optional] [readonly]
**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]
diff --git a/docs/OrderPatch.md b/docs/OrderPatch.md
index 2e05cd9..f5c838e 100644
--- a/docs/OrderPatch.md
+++ b/docs/OrderPatch.md
@@ -5,10 +5,10 @@ Spot order details
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_pair** | **str** | Currency pair | [optional]
-**account** | **str** | 指定查询账户。 | [optional]
-**amount** | **str** | New order amount. `amount` and `price` must specify one of them | [optional]
-**price** | **str** | New order price. `amount` and `Price` must specify one of them\" | [optional]
-**amend_text** | **str** | Custom info during amending order | [optional]
+**account** | **str** | Specify query account | [optional]
+**amount** | **str** | Trading quantity. Either `amount` or `price` must be specified | [optional]
+**price** | **str** | Trading price. Either `amount` or `price` must be specified | [optional]
+**amend_text** | **str** | Custom info during order amendment | [optional]
**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]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/PartnerCommissionHistory.md b/docs/PartnerCommissionHistory.md
index 06a4443..057575b 100644
--- a/docs/PartnerCommissionHistory.md
+++ b/docs/PartnerCommissionHistory.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **int** | Total | [optional]
-**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of comission history | [optional]
+**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of commission history | [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)
diff --git a/docs/PartnerSub.md b/docs/PartnerSub.md
index bc191d9..9337d3a 100644
--- a/docs/PartnerSub.md
+++ b/docs/PartnerSub.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **int** | User ID | [optional]
-**user_join_time** | **int** | The time when the user joined the system, in seconds Unix timestamp | [optional]
-**type** | **int** | Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) | [optional]
+**user_join_time** | **int** | Time when user joined the system, Unix timestamp in seconds | [optional]
+**type** | **int** | Type (1-Sub-agent 2-Indirect direct customer 3-Direct direct customer) | [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)
diff --git a/docs/PlaceDualInvestmentOrder.md b/docs/PlaceDualInvestmentOrder.md
index af2726f..f957b47 100644
--- a/docs/PlaceDualInvestmentOrder.md
+++ b/docs/PlaceDualInvestmentOrder.md
@@ -1,13 +1,12 @@
# PlaceDualInvestmentOrder
-Dual Investment order
+Dual Investment Order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**plan_id** | **str** | Plan ID |
-**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]
-**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]
-**amount** | **str** | Subscription amount, mutually exclusive with the copies field |
+**plan_id** | **str** | Product ID |
+**amount** | **str** | Subscription amount, mutually exclusive with copies field |
+**text** | **str** | Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) | [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)
diff --git a/docs/Position.md b/docs/Position.md
index 8606015..5c4065b 100644
--- a/docs/Position.md
+++ b/docs/Position.md
@@ -19,22 +19,25 @@ Name | Type | Description | Notes
**initial_margin** | **str** | The initial margin occupied by the position, applicable to the portfolio margin account | [optional] [readonly]
**maintenance_margin** | **str** | Maintenance margin required for the position, applicable to portfolio margin account | [optional] [readonly]
**unrealised_pnl** | **str** | Unrealized PNL | [optional] [readonly]
-**realised_pnl** | **str** | Realized PNL | [optional] [readonly]
+**realised_pnl** | **str** | Realized PnL | [optional] [readonly]
**pnl_pnl** | **str** | Realized PNL - Position P/L | [optional] [readonly]
-**pnl_fund** | **str** | Realized PNL - Funding Fees | [optional] [readonly]
+**pnl_fund** | **str** | Realized PNL - Funding Fees | [optional] [readonly]
**pnl_fee** | **str** | Realized PNL - Transaction Fees | [optional] [readonly]
-**history_pnl** | **str** | History realized PNL | [optional] [readonly]
+**history_pnl** | **str** | Total realized PnL from closed positions | [optional] [readonly]
**last_close_pnl** | **str** | PNL of last position close | [optional] [readonly]
**realised_point** | **str** | Realized POINT PNL | [optional] [readonly]
**history_point** | **str** | History realized POINT PNL | [optional] [readonly]
**adl_ranking** | **int** | Ranking of auto deleveraging, a total of 1-5 grades, `1` is the highest, `5` is the lowest, and `6` is the special case when there is no position held or in liquidation | [optional] [readonly]
-**pending_orders** | **int** | Current open orders | [optional] [readonly]
+**pending_orders** | **int** | Current pending order quantity | [optional] [readonly]
**close_order** | [**PositionCloseOrder**](PositionCloseOrder.md) | | [optional]
-**mode** | **str** | Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode | [optional]
-**cross_leverage_limit** | **str** | Cross margin leverage(valid only when `leverage` is 0) | [optional]
+**mode** | **str** | Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode | [optional]
+**cross_leverage_limit** | **str** | Cross margin leverage (valid only when `leverage` is 0) | [optional]
**update_time** | **int** | Last update time | [optional] [readonly]
-**update_id** | **int** | Update id. Each time the position is updated, the value will be +1. | [optional] [readonly]
+**update_id** | **int** | Update ID. The value increments by 1 each time the position is updated | [optional] [readonly]
**open_time** | **int** | First Open Time | [optional]
+**risk_limit_table** | **str** | Risk limit table ID | [optional] [readonly]
+**average_maintenance_rate** | **str** | Average maintenance margin rate | [optional] [readonly]
+**pid** | **int** | Sub-account position ID | [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)
diff --git a/docs/PositionClose.md b/docs/PositionClose.md
index 196b7b8..93bf9cf 100644
--- a/docs/PositionClose.md
+++ b/docs/PositionClose.md
@@ -5,17 +5,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**time** | **float** | Position close time | [optional] [readonly]
**contract** | **str** | Futures contract | [optional] [readonly]
-**side** | **str** | Position side, long or short | [optional] [readonly]
-**pnl** | **str** | PNL | [optional] [readonly]
+**side** | **str** | Position side - `long`: Long position - `short`: Short position | [optional] [readonly]
+**pnl** | **str** | PnL | [optional] [readonly]
**pnl_pnl** | **str** | PNL - Position P/L | [optional] [readonly]
**pnl_fund** | **str** | PNL - Funding Fees | [optional] [readonly]
**pnl_fee** | **str** | PNL - Transaction Fees | [optional] [readonly]
-**text** | **str** | Text of close order | [optional] [readonly]
+**text** | **str** | Source of close order. See `order.text` field for specific values | [optional] [readonly]
**max_size** | **str** | Max Trade Size | [optional] [readonly]
**accum_size** | **str** | Cumulative closed position volume | [optional] [readonly]
**first_open_time** | **int** | First Open Time | [optional] [readonly]
-**long_price** | **str** | When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price. | [optional] [readonly]
-**short_price** | **str** | When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price | [optional] [readonly]
+**long_price** | **str** | When side is 'long', it indicates the opening average price; when side is 'short', it indicates the closing average price | [optional] [readonly]
+**short_price** | **str** | When side is 'long', it indicates the closing average price; when side is 'short', it indicates the opening average price | [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)
diff --git a/docs/PositionCloseOrder.md b/docs/PositionCloseOrder.md
index 6f5540d..20d1088 100644
--- a/docs/PositionCloseOrder.md
+++ b/docs/PositionCloseOrder.md
@@ -1,12 +1,12 @@
# PositionCloseOrder
-Current close order if any, or `null`
+Current close order information, or `null` if no close order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Close order ID | [optional]
-**price** | **str** | Close order price | [optional]
-**is_liq** | **bool** | Is the close order from liquidation | [optional]
+**id** | **int** | Order ID | [optional]
+**price** | **str** | Order price | [optional]
+**is_liq** | **bool** | Whether the close order is from liquidation | [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)
diff --git a/docs/ProfitLossRange.md b/docs/ProfitLossRange.md
index e48908d..963c54a 100644
--- a/docs/ProfitLossRange.md
+++ b/docs/ProfitLossRange.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**price_percentage** | **str** | Percentage change in price | [optional]
**implied_volatility_percentage** | **str** | Percentage change in implied volatility | [optional]
-**profit_loss** | **str** | PNL | [optional]
+**profit_loss** | **str** | PnL | [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)
diff --git a/docs/RebateApi.md b/docs/RebateApi.md
index 2a0929e..f7e8f50 100644
--- a/docs/RebateApi.md
+++ b/docs/RebateApi.md
@@ -4,22 +4,23 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**agency_transaction_history**](RebateApi.md#agency_transaction_history) | **GET** /rebate/agency/transaction_history | The agency obtains the transaction history of the recommended user
-[**agency_commissions_history**](RebateApi.md#agency_commissions_history) | **GET** /rebate/agency/commission_history | The agency obtains the commission history of the recommended user
-[**partner_transaction_history**](RebateApi.md#partner_transaction_history) | **GET** /rebate/partner/transaction_history | Partner obtains transaction records of recommended users
-[**partner_commissions_history**](RebateApi.md#partner_commissions_history) | **GET** /rebate/partner/commission_history | Partner obtains commission records of recommended users
+[**agency_transaction_history**](RebateApi.md#agency_transaction_history) | **GET** /rebate/agency/transaction_history | Broker obtains transaction history of recommended users
+[**agency_commissions_history**](RebateApi.md#agency_commissions_history) | **GET** /rebate/agency/commission_history | Broker obtains rebate history of recommended users
+[**partner_transaction_history**](RebateApi.md#partner_transaction_history) | **GET** /rebate/partner/transaction_history | Partner obtains transaction history of recommended users
+[**partner_commissions_history**](RebateApi.md#partner_commissions_history) | **GET** /rebate/partner/commission_history | Partner obtains rebate records of recommended users
[**partner_sub_list**](RebateApi.md#partner_sub_list) | **GET** /rebate/partner/sub_list | Partner subordinate list
-[**rebate_broker_commission_history**](RebateApi.md#rebate_broker_commission_history) | **GET** /rebate/broker/commission_history | The broker obtains the user's commission rebate records
-[**rebate_broker_transaction_history**](RebateApi.md#rebate_broker_transaction_history) | **GET** /rebate/broker/transaction_history | The broker obtains the user's trading history
-[**rebate_user_info**](RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User retrieves rebate information
+[**rebate_broker_commission_history**](RebateApi.md#rebate_broker_commission_history) | **GET** /rebate/broker/commission_history | Broker obtains user's rebate records
+[**rebate_broker_transaction_history**](RebateApi.md#rebate_broker_transaction_history) | **GET** /rebate/broker/transaction_history | Broker obtains user's trading history
+[**rebate_user_info**](RebateApi.md#rebate_user_info) | **GET** /rebate/user/info | User obtains rebate information
+[**user_sub_relation**](RebateApi.md#user_sub_relation) | **GET** /rebate/user/sub_relation | User subordinate relationship
# **agency_transaction_history**
> list[AgencyTransactionHistory] agency_transaction_history(currency_pair=currency_pair, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
-The agency obtains the transaction history of the recommended user
+Broker obtains transaction history of recommended users
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -45,15 +46,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-currency_pair = 'BTC_USDT' # str | Specify the currency pair, if not specified, return all currency pairs (optional)
+currency_pair = 'BTC_USDT' # str | Specify the trading pair. If not specified, returns all trading pairs (optional)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # The agency obtains the transaction history of the recommended user
+ # Broker obtains transaction history of recommended users
api_response = api_instance.agency_transaction_history(currency_pair=currency_pair, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -66,11 +67,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Specify the currency pair, if not specified, return all currency pairs | [optional]
+ **currency_pair** | **str**| Specify the trading pair. If not specified, returns all trading pairs | [optional]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -89,16 +90,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **agency_commissions_history**
-> list[AgencyCommissionHistory] agency_commissions_history(currency=currency, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
+> list[AgencyCommissionHistory] agency_commissions_history(currency=currency, commission_type=commission_type, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
-The agency obtains the commission history of the recommended user
+Broker obtains rebate history of recommended users
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -124,16 +125,17 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-currency = 'BTC' # str | Filter by currency. Return all currency records if not specified (optional)
+currency = 'BTC' # str | Specify the currency. If not specified, returns all currencies (optional)
+commission_type = 1 # int | Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate (optional)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # The agency obtains the commission history of the recommended user
- api_response = api_instance.agency_commissions_history(currency=currency, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
+ # Broker obtains rebate history of recommended users
+ api_response = api_instance.agency_commissions_history(currency=currency, commission_type=commission_type, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -145,11 +147,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Filter by currency. Return all currency records if not specified | [optional]
+ **currency** | **str**| Specify the currency. If not specified, returns all currencies | [optional]
+ **commission_type** | **int**| Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate | [optional]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -168,16 +171,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **partner_transaction_history**
> PartnerTransactionHistory partner_transaction_history(currency_pair=currency_pair, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
-Partner obtains transaction records of recommended users
+Partner obtains transaction history of recommended users
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -203,15 +206,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-currency_pair = 'BTC_USDT' # str | Specify the currency pair, if not specified, return all currency pairs (optional)
+currency_pair = 'BTC_USDT' # str | Specify the trading pair. If not specified, returns all trading pairs (optional)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Partner obtains transaction records of recommended users
+ # Partner obtains transaction history of recommended users
api_response = api_instance.partner_transaction_history(currency_pair=currency_pair, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -224,11 +227,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Specify the currency pair, if not specified, return all currency pairs | [optional]
+ **currency_pair** | **str**| Specify the trading pair. If not specified, returns all trading pairs | [optional]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -247,16 +250,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **partner_commissions_history**
> PartnerCommissionHistory partner_commissions_history(currency=currency, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
-Partner obtains commission records of recommended users
+Partner obtains rebate records of recommended users
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -282,15 +285,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-currency = 'BTC' # str | Filter by currency. Return all currency records if not specified (optional)
+currency = 'BTC' # str | Specify the currency. If not specified, returns all currencies (optional)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Partner obtains commission records of recommended users
+ # Partner obtains rebate records of recommended users
api_response = api_instance.partner_commissions_history(currency=currency, user_id=user_id, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -303,11 +306,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Filter by currency. Return all currency records if not specified | [optional]
+ **currency** | **str**| Specify the currency. If not specified, returns all currencies | [optional]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -326,7 +329,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -335,7 +338,7 @@ Name | Type | Description | Notes
Partner subordinate list
-Including sub-agents, direct customers, indirect customers
+Including sub-agents, direct customers, and indirect customers
### Example
@@ -362,7 +365,7 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
@@ -380,7 +383,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -399,16 +402,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **rebate_broker_commission_history**
> list[BrokerCommission] rebate_broker_commission_history(limit=limit, offset=offset, user_id=user_id, _from=_from, to=to)
-The broker obtains the user's commission rebate records
+Broker obtains user's rebate records
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -434,14 +437,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1711929600 # int | The start time of the query record. If not specified, the default is to push forward 30 days from the current time. (optional)
-to = 1714521600 # int | Time range ending, default to current time (optional)
+_from = 1711929600 # int | Start time of the query record. If not specified, defaults to 30 days before the current time (optional)
+to = 1714521600 # int | End timestamp for the query, defaults to current time if not specified (optional)
try:
- # The broker obtains the user's commission rebate records
+ # Broker obtains user's rebate records
api_response = api_instance.rebate_broker_commission_history(limit=limit, offset=offset, user_id=user_id, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -454,11 +457,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| The start time of the query record. If not specified, the default is to push forward 30 days from the current time. | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **_from** | **int**| Start time of the query record. If not specified, defaults to 30 days before the current time | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
### Return type
@@ -476,16 +479,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **rebate_broker_transaction_history**
> list[BrokerTransaction] rebate_broker_transaction_history(limit=limit, offset=offset, user_id=user_id, _from=_from, to=to)
-The broker obtains the user's trading history
+Broker obtains user's trading history
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -511,14 +514,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.RebateApi(api_client)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
user_id = 10003 # int | User ID. If not specified, all user records will be returned (optional)
-_from = 1711929600 # int | The start time of the query record. If not specified, the default is to push forward 30 days from the current time. (optional)
-to = 1714521600 # int | Time range ending, default to current time (optional)
+_from = 1711929600 # int | Start time of the query record. If not specified, defaults to 30 days before the current time (optional)
+to = 1714521600 # int | End timestamp for the query, defaults to current time if not specified (optional)
try:
- # The broker obtains the user's trading history
+ # Broker obtains user's trading history
api_response = api_instance.rebate_broker_transaction_history(limit=limit, offset=offset, user_id=user_id, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -531,11 +534,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
**user_id** | **int**| User ID. If not specified, all user records will be returned | [optional]
- **_from** | **int**| The start time of the query record. If not specified, the default is to push forward 30 days from the current time. | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **_from** | **int**| Start time of the query record. If not specified, defaults to 30 days before the current time | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
### Return type
@@ -553,14 +556,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **rebate_user_info**
> list[RebateUserInfo] rebate_user_info()
-User retrieves rebate information
+User obtains rebate information
### Example
@@ -588,7 +591,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.RebateApi(api_client)
try:
- # User retrieves rebate information
+ # User obtains rebate information
api_response = api_instance.rebate_user_info()
print(api_response)
except GateApiException as ex:
@@ -616,7 +619,76 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
+
+[[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)
+
+# **user_sub_relation**
+> UserSubRelation user_sub_relation(user_id_list)
+
+User subordinate relationship
+
+Query whether the specified user is within the system
+
+### Example
+
+* Api Key Authentication (apiv4):
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure APIv4 key authorization
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4",
+ key = "YOU_API_KEY",
+ secret = "YOUR_API_SECRET"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.RebateApi(api_client)
+user_id_list = '1, 2, 3' # str | Query user ID list, separated by commas. If more than 100, only 100 will be returned
+
+try:
+ # User subordinate relationship
+ api_response = api_instance.user_sub_relation(user_id_list)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling RebateApi->user_sub_relation: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id_list** | **str**| Query user ID list, separated by commas. If more than 100, only 100 will be returned |
+
+### Return type
+
+[**UserSubRelation**](UserSubRelation.md)
+
+### Authorization
+
+[apiv4](../README.md#apiv4)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | List retrieved successfully | - |
[[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)
diff --git a/docs/RepayCurrencyRes.md b/docs/RepayCurrencyRes.md
index dd4ab05..9715d48 100644
--- a/docs/RepayCurrencyRes.md
+++ b/docs/RepayCurrencyRes.md
@@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**succeeded** | **bool** | Has the repayment been successful | [optional]
-**label** | **str** | Error identifier for unsuccessful operations; empty for successful. | [optional]
-**message** | **str** | Error description in case of operation failure; empty when successful. | [optional]
+**succeeded** | **bool** | Whether the repayment was successful | [optional]
+**label** | **str** | Error identifier for failed operations; empty when successful | [optional]
+**message** | **str** | Error description for failed operations; empty when successful | [optional]
**currency** | **str** | Repayment currency | [optional]
**repaid_principal** | **str** | Principal | [optional]
**repaid_interest** | **str** | Principal | [optional]
diff --git a/docs/RepayLoan.md b/docs/RepayLoan.md
index 910e2be..92c8463 100644
--- a/docs/RepayLoan.md
+++ b/docs/RepayLoan.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order_id** | **int** | Order ID |
**repay_amount** | **str** | Repayment amount, it is mandatory when making partial repayments |
-**repaid_all** | **bool** | Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. |
+**repaid_all** | **bool** | Repayment method, set to `true` for full repayment, and `false` for partial repayment; When partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/RepayMultiLoan.md b/docs/RepayMultiLoan.md
index e9be0f0..eb1c0ab 100644
--- a/docs/RepayMultiLoan.md
+++ b/docs/RepayMultiLoan.md
@@ -1,6 +1,6 @@
# RepayMultiLoan
-Repay Multi-Collateral Loan
+Multi-currency collateral repayment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/RepayRecord.md b/docs/RepayRecord.md
index 5137865..a9cf6cf 100644
--- a/docs/RepayRecord.md
+++ b/docs/RepayRecord.md
@@ -8,15 +8,15 @@ Name | Type | Description | Notes
**record_id** | **int** | Repayment record ID | [optional]
**repaid_amount** | **str** | Repayment amount | [optional]
**borrow_currency** | **str** | Borrowed currency | [optional]
-**collateral_currency** | **str** | Collateral | [optional]
-**init_ltv** | **str** | The initial collateralization rate | [optional]
+**collateral_currency** | **str** | Collateral currency | [optional]
+**init_ltv** | **str** | Initial collateralization rate | [optional]
**borrow_time** | **int** | Borrowing time, timestamp | [optional]
**repay_time** | **int** | Repayment time, timestamp | [optional]
**total_interest** | **str** | Total interest | [optional]
**before_left_principal** | **str** | Principal to be repaid before repayment | [optional]
**after_left_principal** | **str** | Principal to be repaid after repayment | [optional]
-**before_left_collateral** | **str** | Collateral quantity before repayment | [optional]
-**after_left_collateral** | **str** | Collateral quantity after repayment | [optional]
+**before_left_collateral** | **str** | Collateral amount before repayment | [optional]
+**after_left_collateral** | **str** | Collateral amount after repayment | [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)
diff --git a/docs/RepayRecordCurrency.md b/docs/RepayRecordCurrency.md
index 0cfa03c..d8a1c90 100644
--- a/docs/RepayRecordCurrency.md
+++ b/docs/RepayRecordCurrency.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
**currency** | **str** | Currency | [optional]
**index_price** | **str** | Currency Index Price | [optional]
**before_amount** | **str** | Amount before the operation | [optional]
-**before_amount_usdt** | **str** | USDT Amount before the operation. | [optional]
-**after_amount** | **str** | Amount after the operation. | [optional]
-**after_amount_usdt** | **str** | USDT Amount after the operation. | [optional]
+**before_amount_usdt** | **str** | USDT Amount before the operation | [optional]
+**after_amount** | **str** | Amount after the operation | [optional]
+**after_amount_usdt** | **str** | USDT Amount after the operation | [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)
diff --git a/docs/RepayRecordRepaidCurrency.md b/docs/RepayRecordRepaidCurrency.md
index 7f111e8..b49320d 100644
--- a/docs/RepayRecordRepaidCurrency.md
+++ b/docs/RepayRecordRepaidCurrency.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**repaid_amount** | **str** | Repayment amount | [optional]
**repaid_principal** | **str** | Principal | [optional]
**repaid_interest** | **str** | Interest | [optional]
-**repaid_amount_usdt** | **str** | Value of the repayment amount in USDT | [optional]
+**repaid_amount_usdt** | **str** | Repayment amount converted to USDT | [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)
diff --git a/docs/RepayRequest.md b/docs/RepayRequest.md
deleted file mode 100644
index 6663e18..0000000
--- a/docs/RepayRequest.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# RepayRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currency_pair** | **str** | Currency pair |
-**currency** | **str** | Loan currency |
-**mode** | **str** | Repay mode. all - repay all; partial - repay only some portion |
-**amount** | **str** | Repay amount. Required in `partial` mode | [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)
-
-
diff --git a/docs/Repayment.md b/docs/Repayment.md
deleted file mode 100644
index a46c5c5..0000000
--- a/docs/Repayment.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Repayment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **str** | Loan record ID | [optional]
-**create_time** | **str** | Repayment time | [optional]
-**principal** | **str** | Repaid principal | [optional]
-**interest** | **str** | Repaid interest | [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)
-
-
diff --git a/docs/RiskUnits.md b/docs/RiskUnits.md
index 7ca433f..dcff46e 100644
--- a/docs/RiskUnits.md
+++ b/docs/RiskUnits.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | Risk unit flag | [optional]
-**spot_in_use** | **str** | Spot hedging utilization | [optional]
+**spot_in_use** | **str** | Spot hedging occupied amount | [optional]
**maintain_margin** | **str** | Maintenance margin for risk unit | [optional]
**initial_margin** | **str** | Initial margin for risk unit | [optional]
**delta** | **str** | Total Delta of risk unit | [optional]
diff --git a/docs/SmallBalance.md b/docs/SmallBalance.md
index 80e11fa..7302d38 100644
--- a/docs/SmallBalance.md
+++ b/docs/SmallBalance.md
@@ -1,6 +1,6 @@
# SmallBalance
-Convert Small Balance
+Small Balance Conversion
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/SmallBalanceHistory.md b/docs/SmallBalanceHistory.md
index ffe1d05..5a5f5b0 100644
--- a/docs/SmallBalanceHistory.md
+++ b/docs/SmallBalanceHistory.md
@@ -1,12 +1,12 @@
# SmallBalanceHistory
-Convert Small Balance
+Small Balance Conversion
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Order ID | [optional] [readonly]
**currency** | **str** | Currency | [optional] [readonly]
-**amount** | **str** | amount | [optional] [readonly]
+**amount** | **str** | Swap Amount | [optional] [readonly]
**gt_amount** | **str** | GT amount | [optional] [readonly]
**create_time** | **int** | Exchange time (in seconds) | [optional] [readonly]
diff --git a/docs/SpotAccountBook.md b/docs/SpotAccountBook.md
index 0af566f..80d34cb 100644
--- a/docs/SpotAccountBook.md
+++ b/docs/SpotAccountBook.md
@@ -8,7 +8,8 @@ Name | Type | Description | Notes
**currency** | **str** | Currency changed | [optional]
**change** | **str** | Amount changed. Positive value means transferring in, while negative out | [optional]
**balance** | **str** | Balance after change | [optional]
-**type** | **str** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional]
+**type** | **str** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional]
+**code** | **str** | Account change code, see [Asset Record Code] (Asset Record Code) | [optional]
**text** | **str** | Additional information | [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)
diff --git a/docs/SpotApi.md b/docs/SpotApi.md
index 6f923ae..9b2c765 100644
--- a/docs/SpotApi.md
+++ b/docs/SpotApi.md
@@ -4,46 +4,46 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_currencies**](SpotApi.md#list_currencies) | **GET** /spot/currencies | List all currencies' details
-[**get_currency**](SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Get details of a specific currency
-[**list_currency_pairs**](SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | List all currency pairs supported
-[**get_currency_pair**](SpotApi.md#get_currency_pair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc currency pair
-[**list_tickers**](SpotApi.md#list_tickers) | **GET** /spot/tickers | Retrieve ticker information
-[**list_order_book**](SpotApi.md#list_order_book) | **GET** /spot/order_book | Retrieve order book
-[**list_trades**](SpotApi.md#list_trades) | **GET** /spot/trades | Retrieve market trades
-[**list_candlesticks**](SpotApi.md#list_candlesticks) | **GET** /spot/candlesticks | Market candlesticks
-[**get_fee**](SpotApi.md#get_fee) | **GET** /spot/fee | Query user trading fee rates
-[**get_batch_spot_fee**](SpotApi.md#get_batch_spot_fee) | **GET** /spot/batch_fee | Query a batch of user trading fee rates
-[**list_spot_accounts**](SpotApi.md#list_spot_accounts) | **GET** /spot/accounts | List spot accounts
-[**list_spot_account_book**](SpotApi.md#list_spot_account_book) | **GET** /spot/account_book | Query account book
-[**create_batch_orders**](SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Create a batch of orders
+[**list_currencies**](SpotApi.md#list_currencies) | **GET** /spot/currencies | Query all currency information
+[**get_currency**](SpotApi.md#get_currency) | **GET** /spot/currencies/{currency} | Query single currency information
+[**list_currency_pairs**](SpotApi.md#list_currency_pairs) | **GET** /spot/currency_pairs | Query all supported currency pairs
+[**get_currency_pair**](SpotApi.md#get_currency_pair) | **GET** /spot/currency_pairs/{currency_pair} | Query single currency pair details
+[**list_tickers**](SpotApi.md#list_tickers) | **GET** /spot/tickers | Get currency pair ticker information
+[**list_order_book**](SpotApi.md#list_order_book) | **GET** /spot/order_book | Get market depth information
+[**list_trades**](SpotApi.md#list_trades) | **GET** /spot/trades | Query market transaction records
+[**list_candlesticks**](SpotApi.md#list_candlesticks) | **GET** /spot/candlesticks | Market K-line chart
+[**get_fee**](SpotApi.md#get_fee) | **GET** /spot/fee | Query account fee rates
+[**get_batch_spot_fee**](SpotApi.md#get_batch_spot_fee) | **GET** /spot/batch_fee | Batch query account fee rates
+[**list_spot_accounts**](SpotApi.md#list_spot_accounts) | **GET** /spot/accounts | List spot trading accounts
+[**list_spot_account_book**](SpotApi.md#list_spot_account_book) | **GET** /spot/account_book | Query spot account transaction history
+[**create_batch_orders**](SpotApi.md#create_batch_orders) | **POST** /spot/batch_orders | Batch place orders
[**list_all_open_orders**](SpotApi.md#list_all_open_orders) | **GET** /spot/open_orders | List all open orders
-[**create_cross_liquidate_order**](SpotApi.md#create_cross_liquidate_order) | **POST** /spot/cross_liquidate_orders | close position when cross-currency is disabled
+[**create_cross_liquidate_order**](SpotApi.md#create_cross_liquidate_order) | **POST** /spot/cross_liquidate_orders | Close position when cross-currency is disabled
[**list_orders**](SpotApi.md#list_orders) | **GET** /spot/orders | List orders
[**create_order**](SpotApi.md#create_order) | **POST** /spot/orders | Create an order
[**cancel_orders**](SpotApi.md#cancel_orders) | **DELETE** /spot/orders | Cancel all `open` orders in specified currency pair
-[**cancel_batch_orders**](SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list
-[**get_order**](SpotApi.md#get_order) | **GET** /spot/orders/{order_id} | Get a single order
-[**cancel_order**](SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel a single order
-[**amend_order**](SpotApi.md#amend_order) | **PATCH** /spot/orders/{order_id} | Amend an order
-[**list_my_trades**](SpotApi.md#list_my_trades) | **GET** /spot/my_trades | List personal trading history
+[**cancel_batch_orders**](SpotApi.md#cancel_batch_orders) | **POST** /spot/cancel_batch_orders | Cancel batch orders by specified ID list
+[**get_order**](SpotApi.md#get_order) | **GET** /spot/orders/{order_id} | Query single order details
+[**cancel_order**](SpotApi.md#cancel_order) | **DELETE** /spot/orders/{order_id} | Cancel single order
+[**amend_order**](SpotApi.md#amend_order) | **PATCH** /spot/orders/{order_id} | Amend single order
+[**list_my_trades**](SpotApi.md#list_my_trades) | **GET** /spot/my_trades | Query personal trading records
[**get_system_time**](SpotApi.md#get_system_time) | **GET** /spot/time | Get server current time
[**countdown_cancel_all_spot**](SpotApi.md#countdown_cancel_all_spot) | **POST** /spot/countdown_cancel_all | Countdown cancel orders
[**amend_batch_orders**](SpotApi.md#amend_batch_orders) | **POST** /spot/amend_batch_orders | Batch modification of orders
[**get_spot_insurance_history**](SpotApi.md#get_spot_insurance_history) | **GET** /spot/insurance_history | Query spot insurance fund historical data
-[**list_spot_price_triggered_orders**](SpotApi.md#list_spot_price_triggered_orders) | **GET** /spot/price_orders | Retrieve running auto order list
-[**create_spot_price_triggered_order**](SpotApi.md#create_spot_price_triggered_order) | **POST** /spot/price_orders | Create a price-triggered order
-[**cancel_spot_price_triggered_order_list**](SpotApi.md#cancel_spot_price_triggered_order_list) | **DELETE** /spot/price_orders | Cancel all open orders
-[**get_spot_price_triggered_order**](SpotApi.md#get_spot_price_triggered_order) | **GET** /spot/price_orders/{order_id} | Get a price-triggered order
-[**cancel_spot_price_triggered_order**](SpotApi.md#cancel_spot_price_triggered_order) | **DELETE** /spot/price_orders/{order_id} | cancel a price-triggered order
+[**list_spot_price_triggered_orders**](SpotApi.md#list_spot_price_triggered_orders) | **GET** /spot/price_orders | Query running auto order list
+[**create_spot_price_triggered_order**](SpotApi.md#create_spot_price_triggered_order) | **POST** /spot/price_orders | Create price-triggered order
+[**cancel_spot_price_triggered_order_list**](SpotApi.md#cancel_spot_price_triggered_order_list) | **DELETE** /spot/price_orders | Cancel all auto orders
+[**get_spot_price_triggered_order**](SpotApi.md#get_spot_price_triggered_order) | **GET** /spot/price_orders/{order_id} | Query single auto order details
+[**cancel_spot_price_triggered_order**](SpotApi.md#cancel_spot_price_triggered_order) | **DELETE** /spot/price_orders/{order_id} | Cancel single auto order
# **list_currencies**
> list[Currency] list_currencies()
-List all currencies' details
+Query all currency information
-Currency has two forms: 1. Only currency name, e.g., BTC, USDT 2. `_`, 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 `_`.
+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
### Example
@@ -62,7 +62,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.SpotApi(api_client)
try:
- # List all currencies' details
+ # Query all currency information
api_response = api_instance.list_currencies()
print(api_response)
except GateApiException as ex:
@@ -90,14 +90,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_currency**
> Currency get_currency(currency)
-Get details of a specific currency
+Query single currency information
### Example
@@ -117,7 +117,7 @@ api_instance = gate_api.SpotApi(api_client)
currency = 'GT' # str | Currency name
try:
- # Get details of a specific currency
+ # Query single currency information
api_response = api_instance.get_currency(currency)
print(api_response)
except GateApiException as ex:
@@ -148,14 +148,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_currency_pairs**
> list[CurrencyPair] list_currency_pairs()
-List all currency pairs supported
+Query all supported currency pairs
### Example
@@ -174,7 +174,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.SpotApi(api_client)
try:
- # List all currency pairs supported
+ # Query all supported currency pairs
api_response = api_instance.list_currency_pairs()
print(api_response)
except GateApiException as ex:
@@ -209,7 +209,7 @@ No authorization required
# **get_currency_pair**
> CurrencyPair get_currency_pair(currency_pair)
-Get details of a specifc currency pair
+Query single currency pair details
### Example
@@ -229,7 +229,7 @@ api_instance = gate_api.SpotApi(api_client)
currency_pair = 'ETH_BTC' # str | Currency pair
try:
- # Get details of a specifc currency pair
+ # Query single currency pair details
api_response = api_instance.get_currency_pair(currency_pair)
print(api_response)
except GateApiException as ex:
@@ -260,16 +260,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_tickers**
> list[Ticker] list_tickers(currency_pair=currency_pair, timezone=timezone)
-Retrieve ticker information
+Get currency pair ticker information
-Return only related data if `currency_pair` is specified; otherwise return all of them
+If `currency_pair` is specified, only query that currency pair; otherwise return all information
### Example
@@ -290,7 +290,7 @@ currency_pair = 'BTC_USDT' # str | Currency pair (optional)
timezone = 'utc0' # str | Timezone (optional)
try:
- # Retrieve ticker information
+ # Get currency pair ticker information
api_response = api_instance.list_tickers(currency_pair=currency_pair, timezone=timezone)
print(api_response)
except GateApiException as ex:
@@ -322,16 +322,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_order_book**
> OrderBook list_order_book(currency_pair, interval=interval, limit=limit, with_id=with_id)
-Retrieve order book
+Get market depth information
-Order book will be sorted by price from high to low on bids; low to high on asks
+Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high
### Example
@@ -349,12 +349,12 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair
-interval = '0' # str | Order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
-limit = 10 # int | Maximum number of order depth data in asks or bids (optional) (default to 10)
-with_id = False # bool | Return order book ID (optional) (default to False)
+interval = '0' # str | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional) (default to '0')
+limit = 10 # int | Number of depth levels (optional) (default to 10)
+with_id = False # bool | Return order book update ID (optional) (default to False)
try:
- # Retrieve order book
+ # Get market depth information
api_response = api_instance.list_order_book(currency_pair, interval=interval, limit=limit, with_id=with_id)
print(api_response)
except GateApiException as ex:
@@ -368,9 +368,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair |
- **interval** | **str**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to '0']
- **limit** | **int**| Maximum number of order depth data in asks or bids | [optional] [default to 10]
- **with_id** | **bool**| Return order book ID | [optional] [default to False]
+ **interval** | **str**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to '0']
+ **limit** | **int**| Number of depth levels | [optional] [default to 10]
+ **with_id** | **bool**| Return order book update ID | [optional] [default to False]
### Return type
@@ -388,16 +388,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_trades**
> list[Trade] list_trades(currency_pair, limit=limit, last_id=last_id, reverse=reverse, _from=_from, to=to, page=page)
-Retrieve market trades
+Query market transaction records
-支持指定 `from` 和 `to` 按时间范围查询或基于 `last_id` 的翻页查询。默认按时间范围查询,查询范围为最近30天。 基于 `last_id` 翻页的查询方式不再推荐继续使用。如果指定 `last_id` ，时间范围查询参数会被忽略。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。
+Supports querying by time range using `from` and `to` parameters or pagination based on `last_id`. By default, queries the last 30 days. Pagination based on `last_id` is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000.
### Example
@@ -415,15 +415,15 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair
-limit = 100 # int | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional) (default to 100)
-last_id = '12345' # str | Specify list staring point using the `id` of last record in previous list-query results (optional)
-reverse = False # bool | Whether the id of records to be retrieved should be less than the last_id specified. Default to false. When `last_id` is specified. Set `reverse` to `true` to trace back trading history; `false` to retrieve latest tradings. No effect if `last_id` is not specified. (optional) (default to False)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
+limit = 100 # int | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 (optional) (default to 100)
+last_id = '12345' # str | Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used (optional)
+reverse = False # bool | Whether to retrieve data less than `last_id`. Default returns records greater than `last_id`. Set to `true` to trace back market trade records, `false` to get latest trades. No effect when `last_id` is not set. (optional) (default to False)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
page = 1 # int | Page number (optional) (default to 1)
try:
- # Retrieve market trades
+ # Query market transaction records
api_response = api_instance.list_trades(currency_pair, limit=limit, last_id=last_id, reverse=reverse, _from=_from, to=to, page=page)
print(api_response)
except GateApiException as ex:
@@ -437,11 +437,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair |
- **limit** | **int**| Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 | [optional] [default to 100]
- **last_id** | **str**| Specify list staring point using the `id` of last record in previous list-query results | [optional]
- **reverse** | **bool**| Whether the id of records to be retrieved should be less than the last_id specified. Default to false. When `last_id` is specified. Set `reverse` to `true` to trace back trading history; `false` to retrieve latest tradings. No effect if `last_id` is not specified. | [optional] [default to False]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **limit** | **int**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100]
+ **last_id** | **str**| Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used | [optional]
+ **reverse** | **bool**| Whether to retrieve data less than `last_id`. Default returns records greater than `last_id`. Set to `true` to trace back market trade records, `false` to get latest trades. No effect when `last_id` is not set. | [optional] [default to False]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
**page** | **int**| Page number | [optional] [default to 1]
### Return type
@@ -460,14 +460,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_candlesticks**
> list[list[str]] list_candlesticks(currency_pair, limit=limit, _from=_from, to=to, interval=interval)
-Market candlesticks
+Market K-line chart
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval
@@ -487,13 +487,13 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair
-limit = 100 # int | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
+limit = 100 # int | Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. (optional) (default to 100)
_from = 1546905600 # int | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified (optional)
-to = 1546935600 # int | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional)
-interval = '30m' # str | Interval time between data points. Note that `30d` means 1 natual month, not 30 days (optional) (default to '30m')
+to = 1546935600 # int | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision (optional)
+interval = '30m' # str | Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days (optional) (default to '30m')
try:
- # Market candlesticks
+ # Market K-line chart
api_response = api_instance.list_candlesticks(currency_pair, limit=limit, _from=_from, to=to, interval=interval)
print(api_response)
except GateApiException as ex:
@@ -507,10 +507,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair |
- **limit** | **int**| Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
+ **limit** | **int**| Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100]
**_from** | **int**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional]
- **to** | **int**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional]
- **interval** | **str**| Interval time between data points. Note that `30d` means 1 natual month, not 30 days | [optional] [default to '30m']
+ **to** | **int**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision | [optional]
+ **interval** | **str**| Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days | [optional] [default to '30m']
### Return type
@@ -528,16 +528,16 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_fee**
> SpotFee get_fee(currency_pair=currency_pair)
-Query user trading fee rates
+Query account fee rates
-This API is deprecated in favour of new fee retrieving API `/wallet/fee`.
+This API is deprecated. The new fee query API is `/wallet/fee`
### Example
@@ -563,10 +563,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-currency_pair = 'BTC_USDT' # str | Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs (optional)
+currency_pair = 'BTC_USDT' # str | Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. (optional)
try:
- # Query user trading fee rates
+ # Query account fee rates
api_response = api_instance.get_fee(currency_pair=currency_pair)
print(api_response)
except GateApiException as ex:
@@ -579,7 +579,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs | [optional]
+ **currency_pair** | **str**| Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. | [optional]
### Return type
@@ -597,14 +597,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_batch_spot_fee**
> dict(str, SpotFee) get_batch_spot_fee(currency_pairs)
-Query a batch of user trading fee rates
+Batch query account fee rates
### Example
@@ -630,10 +630,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-currency_pairs = 'BTC_USDT,ETH_USDT' # str | A request can only query up to 50 currency pairs
+currency_pairs = 'BTC_USDT,ETH_USDT' # str | Maximum 50 currency pairs per request
try:
- # Query a batch of user trading fee rates
+ # Batch query account fee rates
api_response = api_instance.get_batch_spot_fee(currency_pairs)
print(api_response)
except GateApiException as ex:
@@ -646,7 +646,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pairs** | **str**| A request can only query up to 50 currency pairs |
+ **currency_pairs** | **str**| Maximum 50 currency pairs per request |
### Return type
@@ -664,14 +664,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_spot_accounts**
> list[SpotAccount] list_spot_accounts(currency=currency)
-List spot accounts
+List spot trading accounts
### Example
@@ -697,10 +697,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
try:
- # List spot accounts
+ # List spot trading accounts
api_response = api_instance.list_spot_accounts(currency=currency)
print(api_response)
except GateApiException as ex:
@@ -713,7 +713,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
### Return type
@@ -731,16 +731,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_spot_account_book**
-> list[SpotAccountBook] list_spot_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type)
+> list[SpotAccountBook] list_spot_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type, code=code)
-Query account book
+Query spot account transaction history
-记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。
+Record query time range cannot exceed 30 days. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000.
### Example
@@ -766,16 +766,17 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
-type = 'lend' # str | Only retrieve changes of the specified type. All types will be returned if not specified. (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
+type = 'lend' # str | Query by specified account change type. If not specified, all change types will be included. (optional)
+code = 'code_example' # str | Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type` (optional)
try:
- # Query account book
- api_response = api_instance.list_spot_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type)
+ # Query spot account transaction history
+ api_response = api_instance.list_spot_account_book(currency=currency, _from=_from, to=to, page=page, limit=limit, type=type, code=code)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -787,12 +788,13 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
- **type** | **str**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
+ **type** | **str**| Query by specified account change type. If not specified, all change types will be included. | [optional]
+ **code** | **str**| Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type` | [optional]
### Return type
@@ -810,16 +812,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_batch_orders**
> list[BatchOrder] create_batch_orders(order, x_gate_exptime=x_gate_exptime)
-Create a batch of orders
+Batch place orders
-Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders
+Batch order requirements: 1. Custom order field `text` must be specified 2. Up to 4 currency pairs per request, with up to 10 orders per currency pair 3. Spot orders and margin orders cannot be mixed; all `account` fields in the same request must be identical
### Example
@@ -846,10 +848,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
order = [gate_api.Order()] # list[Order] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Create a batch of orders
+ # Batch place orders
api_response = api_instance.create_batch_orders(order, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -863,7 +865,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order** | [**list[Order]**](Order.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -881,7 +883,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Request is completed | - |
+**200** | Request execution completed | - |
[[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)
@@ -890,7 +892,7 @@ Name | Type | Description | Notes
List all open orders
-List open orders in all currency pairs. Note that pagination parameters affect record number in each currency pair's open order list. No pagination is applied to the number of currency pairs returned. All currency pairs with open orders will be returned. Spot,portfolio and margin orders are returned by default. To list cross margin orders, `account` must be set to `cross_margin`
+Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned.
### Example
@@ -918,7 +920,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.SpotApi(api_client)
page = 1 # int | Page number (optional) (default to 1)
limit = 100 # int | Maximum number of records returned in one page in each currency pair (optional) (default to 100)
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
+account = 'spot' # str | Specify query account (optional)
try:
# List all open orders
@@ -936,7 +938,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| Page number | [optional] [default to 1]
**limit** | **int**| Maximum number of records returned in one page in each currency pair | [optional] [default to 100]
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
+ **account** | **str**| Specify query account | [optional]
### Return type
@@ -954,16 +956,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_cross_liquidate_order**
> Order create_cross_liquidate_order(liquidate_order)
-close position when cross-currency is disabled
+Close position when cross-currency is disabled
-Currently, only cross-margin accounts are supported to close position when cross currencies are disabled. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in the order book) / 0.998
+Currently, only cross-margin accounts are supported to place buy orders for disabled currencies. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in pending orders) / 0.998
### Example
@@ -992,7 +994,7 @@ api_instance = gate_api.SpotApi(api_client)
liquidate_order = gate_api.LiquidateOrder() # LiquidateOrder |
try:
- # close position when cross-currency is disabled
+ # Close position when cross-currency is disabled
api_response = api_instance.create_cross_liquidate_order(liquidate_order)
print(api_response)
except GateApiException as ex:
@@ -1023,7 +1025,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | order created | - |
+**201** | Order created successfully | - |
[[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)
@@ -1032,7 +1034,7 @@ Name | Type | Description | Notes
List orders
-Spot, portfolio and margin orders are returned by default. If cross margin orders are needed, `account` must be set to `cross_margin` When `status` is `open`, i.e., listing open orders, only pagination parameters `page` and `limit` are supported and `limit` cannot be larger than 100. Query by `side` and time range parameters `from` and `to` are not supported. When `status` is `finished`, i.e., listing finished orders, pagination parameters, time range parameters `from` and `to`, and `side` parameters are all supported. Time range parameters are handled as order finish time.
+Note that query results default to spot order lists for spot, unified account, and isolated margin accounts. When `status` is set to `open` (i.e., when querying pending order lists), only `page` and `limit` pagination controls are supported. `limit` can only be set to a maximum of 100. The `side` parameter and time range query parameters `from` and `to` are not supported. When `status` is set to `finished` (i.e., when querying historical orders), in addition to pagination queries, `from` and `to` time range queries are also supported. Additionally, the `side` parameter can be set to filter one-sided history. Time range filter parameters are processed according to the order end time.
### Example
@@ -1058,14 +1060,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-currency_pair = 'BTC_USDT' # str | Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones.
+currency_pair = 'BTC_USDT' # str | Query by specified currency pair. Required for open orders, optional for filled orders
status = 'open' # str | List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled
page = 1 # int | Page number (optional) (default to 1)
limit = 100 # int | Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100 (optional) (default to 100)
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
-side = 'sell' # str | All bids or asks. Both included if not specified (optional)
+account = 'spot' # str | Specify query account (optional)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
+side = 'sell' # str | Specify all bids or all asks, both included if not specified (optional)
try:
# List orders
@@ -1081,14 +1083,14 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. |
+ **currency_pair** | **str**| Query by specified currency pair. Required for open orders, optional for filled orders |
**status** | **str**| List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled |
**page** | **int**| Page number | [optional] [default to 1]
**limit** | **int**| Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100 | [optional] [default to 100]
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **side** | **str**| All bids or asks. Both included if not specified | [optional]
+ **account** | **str**| Specify query account | [optional]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **side** | **str**| Specify all bids or all asks, both included if not specified | [optional]
### Return type
@@ -1106,7 +1108,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1115,7 +1117,7 @@ Name | Type | Description | Notes
Create an order
-You can place orders with spot, portfolio, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide the order completely. Note that the hidden part's fee will be charged using taker's fee rate. **Self Trade Prevention** - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body
+Supports spot, margin, leverage, and cross-margin leverage orders. Use different accounts through the `account` field. Default is `spot`, which means using the spot account to place orders. If the user has a `unified` account, the default is to place orders with the unified account. When using leveraged account trading (i.e., when `account` is set to `margin`), you can set `auto_borrow` to `true`. In case of insufficient account balance, the system will automatically execute `POST /margin/uni/loans` to borrow the insufficient amount. Whether assets obtained after leveraged order execution are automatically used to repay borrowing orders of the isolated margin account depends on the automatic repayment settings of the user's isolated margin account. Account automatic repayment settings can be queried and set through `/margin/auto_repay`. When using unified account trading (i.e., when `account` is set to `unified`), `auto_borrow` can also be enabled to realize automatic borrowing of insufficient amounts. However, unlike the isolated margin account, whether unified account orders are automatically repaid depends on the `auto_repay` setting when placing the order. This setting only applies to the current order, meaning only assets obtained after order execution will be used to repay borrowing orders of the cross-margin account. Unified account ordering currently supports enabling both `auto_borrow` and `auto_repay` simultaneously. Auto repayment will be triggered when the order ends, i.e., when `status` is `cancelled` or `closed`. **Order Status** The order status in pending orders is `open`, which remains `open` until all quantity is filled. If fully filled, the order ends and status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of partial fills, the status will become `cancelled`. **Iceberg Orders** `iceberg` is used to set the displayed quantity of iceberg orders and does not support complete hiding. Note that hidden portions are charged according to the taker's fee rate. **Self-Trade Prevention** Set `stp_act` to determine the self-trade prevention strategy to use
### Example
@@ -1142,7 +1144,7 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
order = gate_api.Order() # Order |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
# Create an order
@@ -1159,7 +1161,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order** | [**Order**](Order.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1177,7 +1179,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Order created. | - |
+**201** | Order created | - |
[[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)
@@ -1186,7 +1188,7 @@ Name | Type | Description | Notes
Cancel all `open` orders in specified currency pair
-If `account` is not set, all open orders, including spot, portfolio, margin and cross margin ones, will be cancelled. If `currency_pair` is not specified, all pending orders for trading pairs will be cancelled. You can set `account` to cancel only orders within the specified account
+When the `account` parameter is not specified, all pending orders including spot, unified account, and isolated margin will be cancelled. When `currency_pair` is not specified, all trading pair pending orders will be cancelled. You can specify a particular account to cancel all pending orders under that account
### Example
@@ -1213,10 +1215,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-side = 'sell' # str | All bids or asks. Both included if not specified (optional)
-account = 'spot' # str | Specify account type: - Classic account: Includes all if not specified - Unified account: Specify `unified` - Unified account (legacy): Can only specify `cross_margin` (optional)
-action_mode = 'ACK' # str | Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default) (optional)
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+side = 'sell' # str | Specify all bids or all asks, both included if not specified (optional)
+account = 'spot' # str | Specify account type Classic account: All are included if not specified Unified account: Specify `unified` (optional)
+action_mode = 'ACK' # str | Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default) (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
# Cancel all `open` orders in specified currency pair
@@ -1233,10 +1235,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Currency pair | [optional]
- **side** | **str**| All bids or asks. Both included if not specified | [optional]
- **account** | **str**| Specify account type: - Classic account: Includes all if not specified - Unified account: Specify `unified` - Unified account (legacy): Can only specify `cross_margin` | [optional]
- **action_mode** | **str**| Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default) | [optional]
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **side** | **str**| Specify all bids or all asks, both included if not specified | [optional]
+ **account** | **str**| Specify account type Classic account: All are included if not specified Unified account: Specify `unified` | [optional]
+ **action_mode** | **str**| Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default) | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1254,14 +1256,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Batch cancellation request accepted. Query order status by listing orders | - |
+**200** | Batch cancellation request accepted and processed, success determined by order list | - |
[[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)
# **cancel_batch_orders**
> list[CancelOrderResult] cancel_batch_orders(cancel_batch_order, x_gate_exptime=x_gate_exptime)
-Cancel a batch of orders with an ID list
+Cancel batch orders by specified ID list
Multiple currency pairs can be specified, but maximum 20 orders are allowed per request
@@ -1290,10 +1292,10 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
cancel_batch_order = [gate_api.CancelBatchOrder()] # list[CancelBatchOrder] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Cancel a batch of orders with an ID list
+ # Cancel batch orders by specified ID list
api_response = api_instance.cancel_batch_orders(cancel_batch_order, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -1307,7 +1309,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**cancel_batch_order** | [**list[CancelBatchOrder]**](CancelBatchOrder.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1332,9 +1334,9 @@ Name | Type | Description | Notes
# **get_order**
> Order get_order(order_id, currency_pair, account=account)
-Get a single order
+Query single order details
-Spot, portfolio and margin orders are queried by default. If cross margin orders are needed or portfolio margin account are used, account must be set to cross_margin.
+By default, queries orders for spot, unified account, and isolated margin accounts.
### Example
@@ -1360,12 +1362,12 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted.
-currency_pair = 'BTC_USDT' # str | Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank.
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
+order_id = '12345' # str | The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel)
+currency_pair = 'BTC_USDT' # str | Specify the trading pair to query. This field is required when querying pending order records. This field can be omitted when querying filled order records.
+account = 'spot' # str | Specify query account (optional)
try:
- # Get a single order
+ # Query single order details
api_response = api_instance.get_order(order_id, currency_pair, account=account)
print(api_response)
except GateApiException as ex:
@@ -1378,9 +1380,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. |
- **currency_pair** | **str**| Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. |
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
+ **order_id** | **str**| The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) |
+ **currency_pair** | **str**| Specify the trading pair to query. This field is required when querying pending order records. This field can be omitted when querying filled order records. |
+ **account** | **str**| Specify query account | [optional]
### Return type
@@ -1405,9 +1407,9 @@ Name | Type | Description | Notes
# **cancel_order**
> Order cancel_order(order_id, currency_pair, account=account, action_mode=action_mode, x_gate_exptime=x_gate_exptime)
-Cancel a single order
+Cancel single order
-Spot,portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin
+By default, orders for spot, unified accounts and leveraged accounts are revoked.
### Example
@@ -1433,14 +1435,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted.
+order_id = '12345' # str | The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel)
currency_pair = 'BTC_USDT' # str | Currency pair
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
-action_mode = 'ACK' # str | Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default) (optional)
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+account = 'spot' # str | Specify query account (optional)
+action_mode = 'ACK' # str | Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default) (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Cancel a single order
+ # Cancel single order
api_response = api_instance.cancel_order(order_id, currency_pair, account=account, action_mode=action_mode, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -1453,11 +1455,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. |
+ **order_id** | **str**| The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) |
**currency_pair** | **str**| Currency pair |
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
- **action_mode** | **str**| Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default) | [optional]
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **account** | **str**| Specify query account | [optional]
+ **action_mode** | **str**| Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default) | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1482,9 +1484,9 @@ Name | Type | Description | Notes
# **amend_order**
> Order amend_order(order_id, order_patch, currency_pair=currency_pair, account=account, x_gate_exptime=x_gate_exptime)
-Amend an order
+Amend single order
-By default, the orders of spot, portfolio and margin account are updated. If you need to modify orders of the `cross-margin` account, you must specify account as `cross_margin`. For portfolio margin account, only `cross_margin` account is supported. Currently, both request body and query support currency_pair and account parameter passing, but request body has higher priority Currently, only supports modification of `price` or `amount` fields. Regarding rate limiting: modify order and create order sharing rate limiting rules. Regarding matching priority: Only reducing the quantity without modifying the priority of matching, altering the price or increasing the quantity will adjust the priority to the new price at the end Note: If the modified amount is less than the fill amount, the order will be cancelled.
+Modify orders in spot, unified account and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation operation.
### Example
@@ -1510,14 +1512,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-order_id = '12345' # str | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted.
+order_id = '12345' # str | The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel)
order_patch = gate_api.OrderPatch() # OrderPatch |
currency_pair = 'BTC_USDT' # str | Currency pair (optional)
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+account = 'spot' # str | Specify query account (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
- # Amend an order
+ # Amend single order
api_response = api_instance.amend_order(order_id, order_patch, currency_pair=currency_pair, account=account, x_gate_exptime=x_gate_exptime)
print(api_response)
except GateApiException as ex:
@@ -1530,11 +1532,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. |
+ **order_id** | **str**| The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) |
**order_patch** | [**OrderPatch**](OrderPatch.md)| |
**currency_pair** | **str**| Currency pair | [optional]
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **account** | **str**| Specify query account | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1552,16 +1554,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Updated | - |
+**200** | Updated successfully | - |
[[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)
# **list_my_trades**
> list[Trade] list_my_trades(currency_pair=currency_pair, limit=limit, page=page, order_id=order_id, account=account, _from=_from, to=to)
-List personal trading history
+Query personal trading records
-Spot,portfolio and margin trades are queried by default. If cross margin trades are needed, `account` must be set to `cross_margin` You can also set `from` and(or) `to` to query by time range. If you don't specify `from` and/or `to` parameters, only the last 7 days of data will be retured. The range of `from` and `to` is not alloed to exceed 30 days. Time range parameters are handled as order finish time. When using the limit&page paging function to retrieve data, the maximum number of pages is 100,000, that is, (limit * page - 1) <= 100000.
+By default query of transaction records for spot, unified account and warehouse-by-site leverage accounts. The history within a specified time range can be queried by specifying `from` or (and) `to`. - If no time parameters are specified, only data for the last 7 days can be obtained. - If only any parameter of `from` or `to` is specified, only 7-day data from the start (or end) of the specified time is returned. - The range not allowed to exceed 30 days. The parameters of the time range filter are processed according to the order end time. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0.
### Example
@@ -1588,15 +1590,15 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
currency_pair = 'BTC_USDT' # str | Retrieve results with specified currency pair (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 (optional) (default to 100)
page = 1 # int | Page number (optional) (default to 1)
order_id = '12345' # str | Filter trades with specified order ID. `currency_pair` is also required if this field is present (optional)
-account = 'cross_margin' # str | Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only (optional)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
+account = 'spot' # str | Specify query account (optional)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
try:
- # List personal trading history
+ # Query personal trading records
api_response = api_instance.list_my_trades(currency_pair=currency_pair, limit=limit, page=page, order_id=order_id, account=account, _from=_from, to=to)
print(api_response)
except GateApiException as ex:
@@ -1610,12 +1612,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency_pair** | **str**| Retrieve results with specified currency pair | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100]
**page** | **int**| Page number | [optional] [default to 1]
**order_id** | **str**| Filter trades with specified order ID. `currency_pair` is also required if this field is present | [optional]
- **account** | **str**| Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only | [optional]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
+ **account** | **str**| Specify query account | [optional]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
### Return type
@@ -1633,7 +1635,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -1687,7 +1689,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1696,7 +1698,7 @@ No authorization required
Countdown cancel orders
-When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled.
+Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled.
### Example
@@ -1756,7 +1758,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Set countdown successfully | - |
+**200** | Countdown set successfully | - |
[[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)
@@ -1765,7 +1767,7 @@ Name | Type | Description | Notes
Batch modification of orders
-Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the `account` parameter must be specified as `cross_margin`. For portfolio margin accounts, the `account` parameter can only be specified as `cross_margin`. Currently, only modifications to price or quantity (choose one) are supported. When modifying unfinished orders, a maximum of 5 orders can be batch-modified in one request. The request parameters should be passed in an array format. During batch modification, if one order modification fails, the modification process will continue with the next order. After execution, the response will include corresponding failure information for the failed orders. The sequence of calling for batch order modification should be consistent with the order in the order list. The response content order for batch order modification will also be consistent with the order in the order list.
+Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order.
### Example
@@ -1792,7 +1794,7 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
batch_amend_item = [gate_api.BatchAmendItem()] # list[BatchAmendItem] |
-x_gate_exptime = 1689560679123 # int | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
+x_gate_exptime = '1689560679123' # str | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional)
try:
# Batch modification of orders
@@ -1809,7 +1811,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_amend_item** | [**list[BatchAmendItem]**](BatchAmendItem.md)| |
- **x_gate_exptime** | **int**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
+ **x_gate_exptime** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional]
### Return type
@@ -1838,23 +1840,14 @@ Query spot insurance fund historical data
### Example
-* Api Key Authentication (apiv4):
```python
from __future__ import print_function
import gate_api
from gate_api.exceptions import ApiException, GateApiException
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
# See configuration.py for a list of all supported configuration parameters.
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-# Configure APIv4 key authorization
configuration = gate_api.Configuration(
- host = "https://api.gateio.ws/api/v4",
- key = "YOU_API_KEY",
- secret = "YOUR_API_SECRET"
+ host = "https://api.gateio.ws/api/v4"
)
api_client = gate_api.ApiClient(configuration)
@@ -1862,8 +1855,8 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.SpotApi(api_client)
business = 'margin' # str | Leverage business, margin - position by position; unified - unified account
currency = 'BTC' # str | Currency
-_from = 1547706332 # int | Start timestamp, seconds
-to = 1547706332 # int | End timestamp, in seconds
+_from = 1547706332 # int | Start timestamp in seconds
+to = 1547706332 # int | End timestamp in seconds
page = 1 # int | Page number (optional) (default to 1)
limit = 30 # int | The maximum number of items returned in the list, the default value is 30 (optional) (default to 30)
@@ -1883,8 +1876,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**business** | **str**| Leverage business, margin - position by position; unified - unified account |
**currency** | **str**| Currency |
- **_from** | **int**| Start timestamp, seconds |
- **to** | **int**| End timestamp, in seconds |
+ **_from** | **int**| Start timestamp in seconds |
+ **to** | **int**| End timestamp in seconds |
**page** | **int**| Page number | [optional] [default to 1]
**limit** | **int**| The maximum number of items returned in the list, the default value is 30 | [optional] [default to 30]
@@ -1894,7 +1887,7 @@ Name | Type | Description | Notes
### Authorization
-[apiv4](../README.md#apiv4)
+No authorization required
### HTTP request headers
@@ -1904,14 +1897,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_spot_price_triggered_orders**
> list[SpotPriceTriggeredOrder] list_spot_price_triggered_orders(status, market=market, account=account, limit=limit, offset=offset)
-Retrieve running auto order list
+Query running auto order list
### Example
@@ -1937,14 +1930,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-status = 'status_example' # str | Only list the orders with this status
-market = 'BTC_USDT' # str | Currency pair (optional)
-account = 'account_example' # str | Trading account type. Portfolio margin account must set to `cross_margin` (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+status = 'status_example' # str | Query order list based on status
+market = 'BTC_USDT' # str | Trading market (optional)
+account = 'account_example' # str | Trading account type. Unified account must be set to `unified` (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Retrieve running auto order list
+ # Query running auto order list
api_response = api_instance.list_spot_price_triggered_orders(status, market=market, account=account, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -1957,10 +1950,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **status** | **str**| Only list the orders with this status |
- **market** | **str**| Currency pair | [optional]
- **account** | **str**| Trading account type. Portfolio margin account must set to `cross_margin` | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **status** | **str**| Query order list based on status |
+ **market** | **str**| Trading market | [optional]
+ **account** | **str**| Trading account type. Unified account must be set to `unified` | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -1979,14 +1972,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_spot_price_triggered_order**
> TriggerOrderResponse create_spot_price_triggered_order(spot_price_triggered_order)
-Create a price-triggered order
+Create price-triggered order
### Example
@@ -2015,7 +2008,7 @@ api_instance = gate_api.SpotApi(api_client)
spot_price_triggered_order = gate_api.SpotPriceTriggeredOrder() # SpotPriceTriggeredOrder |
try:
- # Create a price-triggered order
+ # Create price-triggered order
api_response = api_instance.create_spot_price_triggered_order(spot_price_triggered_order)
print(api_response)
except GateApiException as ex:
@@ -2046,14 +2039,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Order created | - |
+**201** | Order created successfully | - |
[[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)
# **cancel_spot_price_triggered_order_list**
> list[SpotPriceTriggeredOrder] cancel_spot_price_triggered_order_list(market=market, account=account)
-Cancel all open orders
+Cancel all auto orders
### Example
@@ -2079,11 +2072,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-market = 'BTC_USDT' # str | Currency pair (optional)
-account = 'account_example' # str | Trading account type. Portfolio margin account must set to `cross_margin` (optional)
+market = 'BTC_USDT' # str | Trading market (optional)
+account = 'account_example' # str | Trading account type. Unified account must be set to `unified` (optional)
try:
- # Cancel all open orders
+ # Cancel all auto orders
api_response = api_instance.cancel_spot_price_triggered_order_list(market=market, account=account)
print(api_response)
except GateApiException as ex:
@@ -2096,8 +2089,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **market** | **str**| Currency pair | [optional]
- **account** | **str**| Trading account type. Portfolio margin account must set to `cross_margin` | [optional]
+ **market** | **str**| Trading market | [optional]
+ **account** | **str**| Trading account type. Unified account must be set to `unified` | [optional]
### Return type
@@ -2115,14 +2108,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Batch cancellation request accepted. Query order status by listing orders | - |
+**200** | Batch cancellation request accepted and processed, success determined by order list | - |
[[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)
# **get_spot_price_triggered_order**
> SpotPriceTriggeredOrder get_spot_price_triggered_order(order_id)
-Get a price-triggered order
+Query single auto order details
### Example
@@ -2148,10 +2141,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # Get a price-triggered order
+ # Query single auto order details
api_response = api_instance.get_spot_price_triggered_order(order_id)
print(api_response)
except GateApiException as ex:
@@ -2164,7 +2157,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -2182,14 +2175,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
# **cancel_spot_price_triggered_order**
> SpotPriceTriggeredOrder cancel_spot_price_triggered_order(order_id)
-cancel a price-triggered order
+Cancel single auto order
### Example
@@ -2215,10 +2208,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SpotApi(api_client)
-order_id = 'order_id_example' # str | Retrieve the data of the order with the specified ID
+order_id = 'order_id_example' # str | ID returned when order is successfully created
try:
- # cancel a price-triggered order
+ # Cancel single auto order
api_response = api_instance.cancel_spot_price_triggered_order(order_id)
print(api_response)
except GateApiException as ex:
@@ -2231,7 +2224,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **order_id** | **str**| Retrieve the data of the order with the specified ID |
+ **order_id** | **str**| ID returned when order is successfully created |
### Return type
@@ -2249,7 +2242,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Auto order detail | - |
+**200** | Auto order details | - |
[[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)
diff --git a/docs/SpotCurrencyChain.md b/docs/SpotCurrencyChain.md
new file mode 100644
index 0000000..d461e15
--- /dev/null
+++ b/docs/SpotCurrencyChain.md
@@ -0,0 +1,14 @@
+# SpotCurrencyChain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Blockchain name | [optional]
+**addr** | **str** | token address | [optional]
+**withdraw_disabled** | **bool** | Whether currency's withdrawal is disabled | [optional]
+**withdraw_delayed** | **bool** | Whether currency's withdrawal is delayed | [optional]
+**deposit_disabled** | **bool** | Whether currency's deposit is disabled | [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)
+
+
diff --git a/docs/SpotFee.md b/docs/SpotFee.md
index 78ff43c..e007cf0 100644
--- a/docs/SpotFee.md
+++ b/docs/SpotFee.md
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
**user_id** | **int** | User ID | [optional]
**taker_fee** | **str** | taker fee rate | [optional]
**maker_fee** | **str** | maker fee rate | [optional]
-**gt_discount** | **bool** | If GT deduction is enabled | [optional]
+**gt_discount** | **bool** | Whether GT deduction discount is enabled | [optional]
**gt_taker_fee** | **str** | Taker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional]
-**gt_maker_fee** | **str** | Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional]
+**gt_maker_fee** | **str** | Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled | [optional]
**loan_fee** | **str** | Loan fee rate of margin lending | [optional]
-**point_type** | **str** | Point type. 0 - Initial version. 1 - new version since 202009 | [optional]
+**point_type** | **str** | Point card type: 0 - Original version, 1 - New version since 202009 | [optional]
**currency_pair** | **str** | Currency pair | [optional]
**debit_fee** | **int** | Deduction types for rates, 1 - GT deduction, 2 - Point card deduction, 3 - VIP rates | [optional]
diff --git a/docs/SpotInsuranceHistory.md b/docs/SpotInsuranceHistory.md
index 288954a..3d1f006 100644
--- a/docs/SpotInsuranceHistory.md
+++ b/docs/SpotInsuranceHistory.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional]
-**balance** | **str** | 余额 | [optional]
+**balance** | **str** | Balance | [optional]
**time** | **int** | Creation time, timestamp, milliseconds | [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)
diff --git a/docs/SpotPricePutOrder.md b/docs/SpotPricePutOrder.md
index 81f097d..899f6d7 100644
--- a/docs/SpotPricePutOrder.md
+++ b/docs/SpotPricePutOrder.md
@@ -6,10 +6,12 @@ Name | Type | Description | Notes
**type** | **str** | Order type，default to `limit` - limit : Limit Order - market : Market Order | [optional] [default to 'limit']
**side** | **str** | Order side - buy: buy side - sell: sell side |
**price** | **str** | Order price |
-**amount** | **str** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` |
-**account** | **str** | Trading account type. Portfolio margin account must set to `cross_margin` - normal: spot trading - margin: margin trading - cross_margin: cross_margin trading | [default to 'normal']
+**amount** | **str** | Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` |
+**account** | **str** | Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account | [default to 'normal']
**time_in_force** | **str** | time_in_force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only | [optional] [default to 'gtc']
-**text** | **str** | The source of the order, including: - web: web - api: api - app: app | [optional]
+**auto_borrow** | **bool** | Whether to borrow coins automatically | [optional] [default to False]
+**auto_repay** | **bool** | Whether to repay the loan automatically | [optional] [default to False]
+**text** | **str** | The source of the order, including: - web: Web - api: API call - app: Mobile app | [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)
diff --git a/docs/SpotPriceTrigger.md b/docs/SpotPriceTrigger.md
index 7ee5505..0208586 100644
--- a/docs/SpotPriceTrigger.md
+++ b/docs/SpotPriceTrigger.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**price** | **str** | Trigger price |
-**rule** | **str** | Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field |
-**expiration** | **int** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. |
+**rule** | **str** | Price trigger condition - `>=`: triggered when market price is greater than or equal to `price` - `<=`: triggered when market price is less than or equal to `price` |
+**expiration** | **int** | Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SpotPriceTriggeredOrder.md b/docs/SpotPriceTriggeredOrder.md
index 4291cb2..5c524ae 100644
--- a/docs/SpotPriceTriggeredOrder.md
+++ b/docs/SpotPriceTriggeredOrder.md
@@ -1,6 +1,6 @@
# SpotPriceTriggeredOrder
-Spot order detail
+Spot price order details
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
**put** | [**SpotPricePutOrder**](SpotPricePutOrder.md) | |
**id** | **int** | Auto order ID | [optional] [readonly]
**user** | **int** | User ID | [optional] [readonly]
-**market** | **str** | Currency pair |
-**ctime** | **int** | Creation time | [optional] [readonly]
-**ftime** | **int** | Finished time | [optional] [readonly]
-**fired_order_id** | **int** | ID of the newly created order on condition triggered | [optional] [readonly]
-**status** | **str** | Status - open: open - cancelled: being manually cancelled - finish: successfully executed - failed: failed to execute - expired - expired | [optional] [readonly]
-**reason** | **str** | Additional remarks on how the order was finished | [optional] [readonly]
+**market** | **str** | Market |
+**ctime** | **int** | Created time | [optional] [readonly]
+**ftime** | **int** | End time | [optional] [readonly]
+**fired_order_id** | **int** | ID of the order created after trigger | [optional] [readonly]
+**status** | **str** | Status - open: Running - cancelled: Manually cancelled - finish: Successfully completed - failed: Failed to execute - expired: Expired | [optional] [readonly]
+**reason** | **str** | Additional description of how the order was completed | [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)
diff --git a/docs/StpGroup.md b/docs/StpGroup.md
index 3ae5da0..8a02186 100644
--- a/docs/StpGroup.md
+++ b/docs/StpGroup.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
**id** | **int** | STP Group ID | [optional]
**name** | **str** | STP Group name |
**creator_id** | **int** | Creator ID | [optional]
-**create_time** | **int** | Creation time | [optional]
+**create_time** | **int** | Created 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)
diff --git a/docs/StpGroupUser.md b/docs/StpGroupUser.md
index a5a103e..2e05e1a 100644
--- a/docs/StpGroupUser.md
+++ b/docs/StpGroupUser.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **int** | User ID | [optional]
**stp_id** | **int** | STP Group ID | [optional]
-**create_time** | **int** | Creation time | [optional]
+**create_time** | **int** | Created 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)
diff --git a/docs/StructuredBuy.md b/docs/StructuredBuy.md
index 4a3e128..2c5428f 100644
--- a/docs/StructuredBuy.md
+++ b/docs/StructuredBuy.md
@@ -1,11 +1,11 @@
# StructuredBuy
-Dual Investment Purchase
+Dual Investment Buy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**pid** | **str** | Plan ID | [optional]
-**amount** | **str** | Purchase Amount | [optional]
+**pid** | **str** | Product ID | [optional]
+**amount** | **str** | Buy Quantity | [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)
diff --git a/docs/StructuredGetProjectList.md b/docs/StructuredGetProjectList.md
index 38e9f37..a98f1a4 100644
--- a/docs/StructuredGetProjectList.md
+++ b/docs/StructuredGetProjectList.md
@@ -1,20 +1,20 @@
# StructuredGetProjectList
-Structured Products
+Structured Investment
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | Plan ID | [optional]
-**type** | **str** | product type: `SharkFin2.0`-Shark Fin2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball | [optional]
-**name_en** | **str** | name | [optional]
-**investment_coin** | **str** | Investment Currency | [optional]
-**investment_period** | **str** | Investment term | [optional]
-**min_annual_rate** | **str** | Minimum annual rate | [optional]
-**mid_annual_rate** | **str** | Intermediate annual rate | [optional]
-**max_annual_rate** | **str** | Maximum annual rate | [optional]
-**watch_market** | **str** | Watch market | [optional]
-**start_time** | **int** | start time | [optional]
-**end_time** | **int** | Finished time | [optional]
+**id** | **int** | Product ID | [optional]
+**type** | **str** | Product Type: `SharkFin2.0`-Shark Fin 2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball | [optional]
+**name_en** | **str** | Product Name | [optional]
+**investment_coin** | **str** | Investment Token | [optional]
+**investment_period** | **str** | Investment Period | [optional]
+**min_annual_rate** | **str** | Minimum Annual Rate | [optional]
+**mid_annual_rate** | **str** | Intermediate Annual Rate | [optional]
+**max_annual_rate** | **str** | Maximum Annual Rate | [optional]
+**watch_market** | **str** | Underlying Market | [optional]
+**start_time** | **int** | Start Time | [optional]
+**end_time** | **int** | End time | [optional]
**status** | **str** | Status: `in_process`-in progress `will_begin`-will begin `wait_settlement`-waiting for settlement `done`-done | [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)
diff --git a/docs/StructuredOrderList.md b/docs/StructuredOrderList.md
index 2886d54..3f52c75 100644
--- a/docs/StructuredOrderList.md
+++ b/docs/StructuredOrderList.md
@@ -5,7 +5,7 @@ Structured order
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | Order ID | [optional]
-**pid** | **str** | Plan ID | [optional]
+**pid** | **str** | Product ID | [optional]
**lock_coin** | **str** | Locked coin | [optional]
**amount** | **str** | Locked amount | [optional]
**status** | **str** | Status: SUCCESS - SUCCESS FAILED - FAILED DONE - DONE | [optional]
diff --git a/docs/SubAccount.md b/docs/SubAccount.md
index 70dbc36..4778a33 100644
--- a/docs/SubAccount.md
+++ b/docs/SubAccount.md
@@ -3,13 +3,13 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**remark** | **str** | custom text | [optional]
-**login_name** | **str** | Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters |
+**remark** | **str** | Remark | [optional]
+**login_name** | **str** | Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters |
**password** | **str** | The sub-account's password. (Default: the same as main account's password) | [optional]
**email** | **str** | The sub-account's email address. (Default: the same as main account's email address) | [optional]
-**state** | **int** | State: 1-normal, 2-locked\" | [optional] [readonly]
-**type** | **int** | \"Sub-account type: 1 - sub-account, 3 - cross margin account | [optional] [readonly]
-**user_id** | **int** | The user id of the sub-account | [optional] [readonly]
+**state** | **int** | Sub-account status: 1-normal, 2-locked | [optional] [readonly]
+**type** | **int** | Sub-account type: 1-Regular sub-account, 3-Cross margin sub-account | [optional] [readonly]
+**user_id** | **int** | Sub-account user ID | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/SubAccountApi.md b/docs/SubAccountApi.md
index 3f938a3..dfae02b 100644
--- a/docs/SubAccountApi.md
+++ b/docs/SubAccountApi.md
@@ -6,14 +6,14 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**list_sub_accounts**](SubAccountApi.md#list_sub_accounts) | **GET** /sub_accounts | List sub-accounts
[**create_sub_accounts**](SubAccountApi.md#create_sub_accounts) | **POST** /sub_accounts | Create a new sub-account
-[**get_sub_account**](SubAccountApi.md#get_sub_account) | **GET** /sub_accounts/{user_id} | Get the sub-account
-[**list_sub_account_keys**](SubAccountApi.md#list_sub_account_keys) | **GET** /sub_accounts/{user_id}/keys | List all API Key of the sub-account
-[**create_sub_account_keys**](SubAccountApi.md#create_sub_account_keys) | **POST** /sub_accounts/{user_id}/keys | Create API Key of the sub-account
-[**get_sub_account_key**](SubAccountApi.md#get_sub_account_key) | **GET** /sub_accounts/{user_id}/keys/{key} | Get the API Key of the sub-account
-[**update_sub_account_keys**](SubAccountApi.md#update_sub_account_keys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update API key of the sub-account
-[**delete_sub_account_keys**](SubAccountApi.md#delete_sub_account_keys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete API key of the sub-account
-[**lock_sub_account**](SubAccountApi.md#lock_sub_account) | **POST** /sub_accounts/{user_id}/lock | Lock the sub-account
-[**unlock_sub_account**](SubAccountApi.md#unlock_sub_account) | **POST** /sub_accounts/{user_id}/unlock | Unlock the sub-account
+[**get_sub_account**](SubAccountApi.md#get_sub_account) | **GET** /sub_accounts/{user_id} | Get sub-account
+[**list_sub_account_keys**](SubAccountApi.md#list_sub_account_keys) | **GET** /sub_accounts/{user_id}/keys | List all API key pairs of the sub-account
+[**create_sub_account_keys**](SubAccountApi.md#create_sub_account_keys) | **POST** /sub_accounts/{user_id}/keys | Create new sub-account API key pair
+[**get_sub_account_key**](SubAccountApi.md#get_sub_account_key) | **GET** /sub_accounts/{user_id}/keys/{key} | Get specific API key pair of the sub-account
+[**update_sub_account_keys**](SubAccountApi.md#update_sub_account_keys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update sub-account API key pair
+[**delete_sub_account_keys**](SubAccountApi.md#delete_sub_account_keys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete sub-account API key pair
+[**lock_sub_account**](SubAccountApi.md#lock_sub_account) | **POST** /sub_accounts/{user_id}/lock | Lock sub-account
+[**unlock_sub_account**](SubAccountApi.md#unlock_sub_account) | **POST** /sub_accounts/{user_id}/unlock | Unlock sub-account
[**list_unified_mode**](SubAccountApi.md#list_unified_mode) | **GET** /sub_accounts/unified_mode | Get sub-account mode
@@ -46,7 +46,7 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-type = '0' # str | `0` to list all types of sub-accounts (currently supporting cross margin accounts and sub-accounts). `1` to list sub-accounts only. If no parameter is passed, only sub-accounts will be listed by default. (optional)
+type = '0' # str | Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. (optional)
try:
# List sub-accounts
@@ -62,7 +62,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **type** | **str**| `0` to list all types of sub-accounts (currently supporting cross margin accounts and sub-accounts). `1` to list sub-accounts only. If no parameter is passed, only sub-accounts will be listed by default. | [optional]
+ **type** | **str**| Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default. | [optional]
### Return type
@@ -80,7 +80,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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,14 +147,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | Created Successfully | - |
+**201** | Created successfully | - |
[[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)
# **get_sub_account**
> SubAccount get_sub_account(user_id)
-Get the sub-account
+Get sub-account
### Example
@@ -180,10 +180,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
+user_id = 56 # int | Sub-account user ID
try:
- # Get the sub-account
+ # Get sub-account
api_response = api_instance.get_sub_account(user_id)
print(api_response)
except GateApiException as ex:
@@ -196,7 +196,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
+ **user_id** | **int**| Sub-account user ID |
### Return type
@@ -214,14 +214,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
# **list_sub_account_keys**
> list[SubAccountKey] list_sub_account_keys(user_id)
-List all API Key of the sub-account
+List all API key pairs of the sub-account
### Example
@@ -247,10 +247,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
+user_id = 56 # int | Sub-account user ID
try:
- # List all API Key of the sub-account
+ # List all API key pairs of the sub-account
api_response = api_instance.list_sub_account_keys(user_id)
print(api_response)
except GateApiException as ex:
@@ -263,7 +263,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
+ **user_id** | **int**| Sub-account user ID |
### Return type
@@ -281,14 +281,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **create_sub_account_keys**
-> list[SubAccountKey] create_sub_account_keys(user_id, sub_account_key)
+> SubAccountKey create_sub_account_keys(user_id, sub_account_key)
-Create API Key of the sub-account
+Create new sub-account API key pair
### Example
@@ -314,11 +314,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
+user_id = 56 # int | Sub-account user ID
sub_account_key = gate_api.SubAccountKey() # SubAccountKey |
try:
- # Create API Key of the sub-account
+ # Create new sub-account API key pair
api_response = api_instance.create_sub_account_keys(user_id, sub_account_key)
print(api_response)
except GateApiException as ex:
@@ -331,12 +331,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
+ **user_id** | **int**| Sub-account user ID |
**sub_account_key** | [**SubAccountKey**](SubAccountKey.md)| |
### Return type
-[**list[SubAccountKey]**](SubAccountKey.md)
+[**SubAccountKey**](SubAccountKey.md)
### Authorization
@@ -350,14 +350,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Created Successfully | - |
+**200** | Created successfully | - |
[[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)
# **get_sub_account_key**
> SubAccountKey get_sub_account_key(user_id, key)
-Get the API Key of the sub-account
+Get specific API key pair of the sub-account
### Example
@@ -383,11 +383,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
-key = 'key_example' # str | The API Key of the sub-account
+user_id = 56 # int | Sub-account user ID
+key = 'key_example' # str | Sub-account API key
try:
- # Get the API Key of the sub-account
+ # Get specific API key pair of the sub-account
api_response = api_instance.get_sub_account_key(user_id, key)
print(api_response)
except GateApiException as ex:
@@ -400,8 +400,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
- **key** | **str**| The API Key of the sub-account |
+ **user_id** | **int**| Sub-account user ID |
+ **key** | **str**| Sub-account API key |
### Return type
@@ -419,14 +419,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successful | - |
+**200** | Successfully retrieved | - |
[[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)
# **update_sub_account_keys**
> update_sub_account_keys(user_id, key, sub_account_key)
-Update API key of the sub-account
+Update sub-account API key pair
### Example
@@ -452,12 +452,12 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
-key = 'key_example' # str | The API Key of the sub-account
+user_id = 56 # int | Sub-account user ID
+key = 'key_example' # str | Sub-account API key
sub_account_key = gate_api.SubAccountKey() # SubAccountKey |
try:
- # Update API key of the sub-account
+ # Update sub-account API key pair
api_instance.update_sub_account_keys(user_id, key, sub_account_key)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -469,8 +469,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
- **key** | **str**| The API Key of the sub-account |
+ **user_id** | **int**| Sub-account user ID |
+ **key** | **str**| Sub-account API key |
**sub_account_key** | [**SubAccountKey**](SubAccountKey.md)| |
### Return type
@@ -489,14 +489,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Updated | - |
+**204** | Updated successfully | - |
[[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)
# **delete_sub_account_keys**
> delete_sub_account_keys(user_id, key)
-Delete API key of the sub-account
+Delete sub-account API key pair
### Example
@@ -522,11 +522,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | Sub-account user id
-key = 'key_example' # str | The API Key of the sub-account
+user_id = 56 # int | Sub-account user ID
+key = 'key_example' # str | Sub-account API key
try:
- # Delete API key of the sub-account
+ # Delete sub-account API key pair
api_instance.delete_sub_account_keys(user_id, key)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -538,8 +538,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| Sub-account user id |
- **key** | **str**| The API Key of the sub-account |
+ **user_id** | **int**| Sub-account user ID |
+ **key** | **str**| Sub-account API key |
### Return type
@@ -557,14 +557,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Delete successfully | - |
+**204** | Deleted successfully | - |
[[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)
# **lock_sub_account**
> lock_sub_account(user_id)
-Lock the sub-account
+Lock sub-account
### Example
@@ -590,10 +590,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | The user id of the sub-account
+user_id = 56 # int | Sub-account user ID
try:
- # Lock the sub-account
+ # Lock sub-account
api_instance.lock_sub_account(user_id)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -605,7 +605,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| The user id of the sub-account |
+ **user_id** | **int**| Sub-account user ID |
### Return type
@@ -623,14 +623,14 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Lock successfully | - |
+**204** | Locked successfully | - |
[[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)
# **unlock_sub_account**
> unlock_sub_account(user_id)
-Unlock the sub-account
+Unlock sub-account
### Example
@@ -656,10 +656,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.SubAccountApi(api_client)
-user_id = 56 # int | The user id of the sub-account
+user_id = 56 # int | Sub-account user ID
try:
- # Unlock the sub-account
+ # Unlock sub-account
api_instance.unlock_sub_account(user_id)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -671,7 +671,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **user_id** | **int**| The user id of the sub-account |
+ **user_id** | **int**| Sub-account user ID |
### Return type
@@ -689,7 +689,7 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Unlock successfully | - |
+**204** | Unlocked successfully | - |
[[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)
@@ -698,7 +698,7 @@ void (empty response body)
Get sub-account mode
-Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode
+Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode
### Example
@@ -754,7 +754,7 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
diff --git a/docs/SubAccountKey.md b/docs/SubAccountKey.md
index dfce92b..54fbdc5 100644
--- a/docs/SubAccountKey.md
+++ b/docs/SubAccountKey.md
@@ -3,16 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**user_id** | **str** | User ID | [optional] [readonly]
+**user_id** | **int** | User ID | [optional] [readonly]
**mode** | **int** | Mode: 1 - classic 2 - portfolio account | [optional]
-**name** | **str** | API key name | [optional]
+**name** | **str** | API Key Name | [optional]
**perms** | [**list[SubAccountKeyPerms]**](SubAccountKeyPerms.md) | | [optional]
-**ip_whitelist** | **list[str]** | ip white list (list will be removed if no value is passed) | [optional]
+**ip_whitelist** | **list[str]** | IP whitelist (list will be cleared if no value is passed) | [optional]
**key** | **str** | API Key | [optional] [readonly]
-**state** | **int** | State 1 - normal 2 - locked 3 - frozen | [optional] [readonly]
-**created_at** | **int** | Creation time | [optional] [readonly]
-**updated_at** | **int** | Last update time | [optional] [readonly]
-**last_access** | **int** | Last access time | [optional] [readonly]
+**state** | **int** | Status: 1-Normal 2-Frozen 3-Locked | [optional] [readonly]
+**created_at** | **int** | Created time | [optional] [readonly]
+**updated_at** | **int** | Last Update Time | [optional] [readonly]
+**last_access** | **int** | Last Access Time | [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)
diff --git a/docs/SubAccountKeyPerms.md b/docs/SubAccountKeyPerms.md
index ed59a5b..1b978be 100644
--- a/docs/SubAccountKeyPerms.md
+++ b/docs/SubAccountKeyPerms.md
@@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **str** | Permission function name (no value will be cleared) - wallet: wallet - spot: spot/leverage - futures: perpetual contract - delivery: delivery contract - earn: financial management - custody: custody - options: options - account: account information - loan: loan - margin: leverage - unified: unified account - copy: copy | [optional]
-**read_only** | **bool** | read only | [optional]
+**name** | **str** | Permission function name (no value will be cleared) - wallet: wallet - spot: spot/margin - futures: perpetual contract - delivery: delivery contract - earn: earn - custody: custody - options: options - account: account information - loan: lending - margin: margin - unified: unified account - copy: copy trading | [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)
diff --git a/docs/SubAccountToSubAccount.md b/docs/SubAccountToSubAccount.md
index cc7b962..ad18faf 100644
--- a/docs/SubAccountToSubAccount.md
+++ b/docs/SubAccountToSubAccount.md
@@ -4,11 +4,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Transfer currency name |
-**sub_account_type** | **str** | Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) | [optional]
+**sub_account_type** | **str** | Transfer from account (deprecated, use `sub_account_from_type` and `sub_account_to_type` instead) | [optional]
**sub_account_from** | **str** | Transfer from the user id of the sub-account |
-**sub_account_from_type** | **str** | The sub-account's outgoing trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account. |
+**sub_account_from_type** | **str** | Source sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account |
**sub_account_to** | **str** | Transfer to the user id of the sub-account |
-**sub_account_to_type** | **str** | The sub-account's incoming trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account |
+**sub_account_to_type** | **str** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account |
**amount** | **str** | Transfer amount |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubAccountTransfer.md b/docs/SubAccountTransfer.md
index 511b3d3..c591078 100644
--- a/docs/SubAccountTransfer.md
+++ b/docs/SubAccountTransfer.md
@@ -3,15 +3,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Transfer currency name |
**sub_account** | **str** | Sub account user ID |
-**direction** | **str** | Transfer direction. to - transfer into sub account; from - transfer out from sub account |
+**sub_account_type** | **str** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account | [optional] [default to 'spot']
+**currency** | **str** | Transfer currency name |
**amount** | **str** | Transfer amount |
-**uid** | **str** | Main account user ID | [optional] [readonly]
-**client_order_id** | **str** | The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters. | [optional]
-**timest** | **str** | Transfer timestamp | [optional] [readonly]
-**source** | **str** | Where the operation is initiated from | [optional] [readonly]
-**sub_account_type** | **str** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account | [optional] [default to 'spot']
+**direction** | **str** | Transfer direction: to - transfer into sub-account, from - transfer out from sub-account |
+**client_order_id** | **str** | Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters | [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)
diff --git a/docs/SubAccountTransferRecordItem.md b/docs/SubAccountTransferRecordItem.md
new file mode 100644
index 0000000..ebfe07e
--- /dev/null
+++ b/docs/SubAccountTransferRecordItem.md
@@ -0,0 +1,19 @@
+# SubAccountTransferRecordItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timest** | **str** | Transfer timestamp | [optional] [readonly]
+**uid** | **str** | Main account user ID | [optional] [readonly]
+**sub_account** | **str** | Sub account user ID |
+**sub_account_type** | **str** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account | [optional] [default to 'spot']
+**currency** | **str** | Transfer currency name |
+**amount** | **str** | Transfer amount |
+**direction** | **str** | Transfer direction: to - transfer into sub-account, from - transfer out from sub-account |
+**source** | **str** | Source of the transfer operation | [optional] [readonly]
+**client_order_id** | **str** | Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters | [optional]
+**status** | **str** | Sub-account transfer record status, currently only 'success' | [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)
+
+
diff --git a/docs/SubCrossMarginAccount.md b/docs/SubCrossMarginAccount.md
index de0d009..b3ab224 100644
--- a/docs/SubCrossMarginAccount.md
+++ b/docs/SubCrossMarginAccount.md
@@ -3,16 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**user_id** | **int** | User ID of the cross margin account. 0 means that the subaccount has not yet opened a cross margin account | [optional]
-**locked** | **bool** | Whether account is locked | [optional]
-**balances** | [**dict(str, CrossMarginBalance1)**](CrossMarginBalance1.md) | | [optional]
+**user_id** | **int** | Cross margin account user ID. 0 means this sub-account has not yet opened a cross margin account | [optional]
+**locked** | **bool** | Whether the account is locked | [optional]
+**balances** | [**dict(str, CrossMarginBalance)**](CrossMarginBalance.md) | | [optional]
**total** | **str** | Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` | [optional]
**borrowed** | **str** | Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` | [optional]
-**borrowed_net** | **str** | Total borrowed value in USDT * borrowed factor | [optional]
+**borrowed_net** | **str** | Total borrowed value in USDT * leverage factor | [optional]
**net** | **str** | Total net assets in USDT | [optional]
**leverage** | **str** | Position leverage | [optional]
-**interest** | **str** | Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional]
-**risk** | **str** | Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional]
+**interest** | **str** | Total unpaid interest in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional]
+**risk** | **str** | Risk rate. When it falls below 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional]
**total_initial_margin** | **str** | Total initial margin | [optional]
**total_margin_balance** | **str** | Total margin balance | [optional]
**total_maintenance_margin** | **str** | Total maintenance margin | [optional]
diff --git a/docs/SubUserMode.md b/docs/SubUserMode.md
index 137ad4b..a1d0c6d 100644
--- a/docs/SubUserMode.md
+++ b/docs/SubUserMode.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **int** | User ID | [optional]
-**is_unified** | **bool** | Is it a unified account? | [optional]
-**mode** | **str** | Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode | [optional]
+**is_unified** | **bool** | Whether it is a unified account | [optional]
+**mode** | **str** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode | [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)
diff --git a/docs/UniInterestMode.md b/docs/SwapCoin.md
similarity index 56%
rename from docs/UniInterestMode.md
rename to docs/SwapCoin.md
index 8084354..3dc278b 100644
--- a/docs/UniInterestMode.md
+++ b/docs/SwapCoin.md
@@ -1,11 +1,13 @@
-# UniInterestMode
+# SwapCoin
-Lend & Earn interest reinvestment toggle
+Blockchain Mining
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Currency |
-**status** | **bool** | Interest toggle settings, true - interest reinvestment, false - regular dividend |
+**coin** | **str** | Currency |
+**side** | **str** | 0 - Stake 1 - Redeem |
+**amount** | **str** | Size |
+**pid** | **int** | DeFi-type Mining Protocol Identifier | [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)
diff --git a/docs/SwapCoinStruct.md b/docs/SwapCoinStruct.md
new file mode 100644
index 0000000..15735e1
--- /dev/null
+++ b/docs/SwapCoinStruct.md
@@ -0,0 +1,24 @@
+# SwapCoinStruct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Order ID | [optional]
+**pid** | **int** | Product ID | [optional]
+**uid** | **int** | User ID | [optional]
+**coin** | **str** | Currency | [optional]
+**type** | **int** | Type 0-Staking 1-Redemption | [optional]
+**subtype** | **str** | SubType | [optional]
+**amount** | **str** | Amount | [optional]
+**exchange_rate** | **str** | Exchange ratio | [optional]
+**exchange_amount** | **str** | Redemption Amount | [optional]
+**update_stamp** | **int** | UpdateTimestamp | [optional]
+**create_stamp** | **int** | Transaction timestamp | [optional]
+**status** | **int** | status 1-success | [optional]
+**protocol_type** | **int** | DEFI Protocol Type | [optional]
+**client_order_id** | **str** | Reference ID | [optional]
+**source** | **str** | Order Origin | [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)
+
+
diff --git a/docs/Ticker.md b/docs/Ticker.md
index 4a104eb..8f0a410 100644
--- a/docs/Ticker.md
+++ b/docs/Ticker.md
@@ -6,19 +6,19 @@ Name | Type | Description | Notes
**currency_pair** | **str** | Currency pair | [optional]
**last** | **str** | Last trading price | [optional]
**lowest_ask** | **str** | Recent lowest ask | [optional]
-**lowest_size** | **str** | The latest seller's lowest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data | [optional]
+**lowest_size** | **str** | Latest seller's lowest price quantity; not available for batch queries; available for single queries, empty if no data | [optional]
**highest_bid** | **str** | Recent highest bid | [optional]
-**highest_size** | **str** | The latest buyer's highest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data | [optional]
-**change_percentage** | **str** | Change percentage in the last 24h | [optional]
-**change_utc0** | **str** | utc0 timezone, the percentage change in the last 24 hours | [optional]
-**change_utc8** | **str** | utc8 timezone, the percentage change in the last 24 hours | [optional]
-**base_volume** | **str** | Base currency trade volume in the last 24h | [optional]
-**quote_volume** | **str** | Quote currency trade volume in the last 24h | [optional]
-**high_24h** | **str** | Highest price in 24h | [optional]
-**low_24h** | **str** | Lowest price in 24h | [optional]
+**highest_size** | **str** | Latest buyer's highest price quantity; not available for batch queries; available for single queries, empty if no data | [optional]
+**change_percentage** | **str** | 24h price change percentage (negative for decrease, e.g., -7.45) | [optional]
+**change_utc0** | **str** | UTC+0 timezone, 24h price change percentage, negative for decline (e.g., -7.45) | [optional]
+**change_utc8** | **str** | UTC+8 timezone, 24h price change percentage, negative for decline (e.g., -7.45) | [optional]
+**base_volume** | **str** | Base currency trading volume in the last 24h | [optional]
+**quote_volume** | **str** | Quote currency trading volume in the last 24h | [optional]
+**high_24h** | **str** | 24h High | [optional]
+**low_24h** | **str** | 24h Low | [optional]
**etf_net_value** | **str** | ETF net value | [optional]
-**etf_pre_net_value** | **str** | ETF previous net value at re-balancing time | [optional]
-**etf_pre_timestamp** | **int** | ETF previous re-balancing time | [optional]
+**etf_pre_net_value** | **str** | ETF net value at previous rebalancing point | [optional]
+**etf_pre_timestamp** | **int** | ETF previous rebalancing time | [optional]
**etf_leverage** | **str** | ETF current leverage | [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)
diff --git a/docs/TotalBalance.md b/docs/TotalBalance.md
index 91b929e..bead2e3 100644
--- a/docs/TotalBalance.md
+++ b/docs/TotalBalance.md
@@ -1,11 +1,11 @@
# TotalBalance
-User's balance in all accounts
+User's total balance information
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | [**AccountBalance**](AccountBalance.md) | | [optional]
-**details** | [**dict(str, AccountBalance)**](AccountBalance.md) | Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: futures account - delivery: delivery account - warrant: warrant account - cbbc: cbbc account | [optional]
+**details** | [**dict(str, AccountBalance)**](AccountBalance.md) | Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: perpetual contract account - delivery: delivery contract account - warrant: warrant account - cbbc: CBBC account | [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)
diff --git a/docs/Trade.md b/docs/Trade.md
index 94cd01e..9fbf77f 100644
--- a/docs/Trade.md
+++ b/docs/Trade.md
@@ -3,22 +3,22 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **str** | Trade ID | [optional]
-**create_time** | **str** | Trading time | [optional]
+**id** | **str** | Fill ID | [optional]
+**create_time** | **str** | Fill Time | [optional]
**create_time_ms** | **str** | Trading time, with millisecond precision | [optional]
**currency_pair** | **str** | Currency pair | [optional]
-**side** | **str** | Order side | [optional]
-**role** | **str** | Trade role. No value in public endpoints | [optional]
+**side** | **str** | Buy or sell order | [optional]
+**role** | **str** | Trade role, not returned in public endpoints | [optional]
**amount** | **str** | Trade amount | [optional]
**price** | **str** | Order price | [optional]
-**order_id** | **str** | Related order ID. No value in public endpoints | [optional]
-**fee** | **str** | Fee deducted. No value in public endpoints | [optional]
-**fee_currency** | **str** | Fee currency unit. No value in public endpoints | [optional]
-**point_fee** | **str** | Points used to deduct fee. No value in public endpoints | [optional]
-**gt_fee** | **str** | GT used to deduct fee. No value in public endpoints | [optional]
+**order_id** | **str** | Related order ID, not returned in public endpoints | [optional]
+**fee** | **str** | Fee deducted, not returned in public endpoints | [optional]
+**fee_currency** | **str** | Fee currency unit, not returned in public endpoints | [optional]
+**point_fee** | **str** | Points used to deduct fee, not returned in public endpoints | [optional]
+**gt_fee** | **str** | GT used to deduct fee, not returned in public endpoints | [optional]
**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional]
-**sequence_id** | **str** | Represents a unique and consecutive trade ID within a single market. It is used to track and identify trades in the specific market | [optional]
-**text** | **str** | User defined information. No value in public endpoints | [optional]
+**sequence_id** | **str** | Consecutive trade ID within a single market. Used to track and identify trades in the specific market | [optional]
+**text** | **str** | User-defined information, not returned in public endpoints | [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)
diff --git a/docs/TradeFee.md b/docs/TradeFee.md
index a75fdab..4914a3f 100644
--- a/docs/TradeFee.md
+++ b/docs/TradeFee.md
@@ -6,15 +6,15 @@ Name | Type | Description | Notes
**user_id** | **int** | User ID | [optional]
**taker_fee** | **str** | taker fee rate | [optional]
**maker_fee** | **str** | maker fee rate | [optional]
-**gt_discount** | **bool** | If GT deduction is enabled | [optional]
+**gt_discount** | **bool** | Whether GT deduction discount is enabled | [optional]
**gt_taker_fee** | **str** | Taker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional]
-**gt_maker_fee** | **str** | Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional]
+**gt_maker_fee** | **str** | Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled | [optional]
**loan_fee** | **str** | Loan fee rate of margin lending | [optional]
-**point_type** | **str** | Point type. 0 - Initial version. 1 - new version since 202009 | [optional]
-**futures_taker_fee** | **str** | Futures trading taker fee | [optional]
-**futures_maker_fee** | **str** | Future trading maker fee | [optional]
-**delivery_taker_fee** | **str** | Delivery trading taker fee | [optional]
-**delivery_maker_fee** | **str** | Delivery trading maker fee | [optional]
+**point_type** | **str** | Point card type: 0 - Original version, 1 - New version since 202009 | [optional]
+**futures_taker_fee** | **str** | Perpetual contract taker fee rate | [optional]
+**futures_maker_fee** | **str** | Perpetual contract maker fee rate | [optional]
+**delivery_taker_fee** | **str** | Delivery contract taker fee rate | [optional]
+**delivery_maker_fee** | **str** | Delivery contract maker fee rate | [optional]
**debit_fee** | **int** | Deduction types for rates, 1 - GT deduction, 2 - Point card deduction, 3 - VIP rates | [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)
diff --git a/docs/TransactionID.md b/docs/TransactionID.md
index 040c3c3..92a681e 100644
--- a/docs/TransactionID.md
+++ b/docs/TransactionID.md
@@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**tx_id** | **int** | Order id | [optional]
+**tx_id** | **int** | Order ID | [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)
diff --git a/docs/Transfer.md b/docs/Transfer.md
index 85415bd..bf9cac3 100644
--- a/docs/Transfer.md
+++ b/docs/Transfer.md
@@ -4,12 +4,12 @@ Accounts available to transfer: - `spot`: spot account - `margin`: margin accou
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency |
+**currency** | **str** | Transfer currency name. For contract accounts, `currency` can be set to `POINT` (points) or supported settlement currencies (e.g., `BTC`, `USDT`) |
**_from** | **str** | Account to transfer from |
**to** | **str** | Account to transfer to |
**amount** | **str** | Transfer amount |
-**currency_pair** | **str** | Margin currency pair. Required if transfer from or to margin account | [optional]
-**settle** | **str** | Futures settle currency. Required if transferring from or to futures account | [optional]
+**currency_pair** | **str** | Margin trading pair. Required when transferring to or from margin account | [optional]
+**settle** | **str** | Contract settlement currency. Required when transferring to or from contract account | [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)
diff --git a/docs/TransferOrderStatus.md b/docs/TransferOrderStatus.md
new file mode 100644
index 0000000..ff17da4
--- /dev/null
+++ b/docs/TransferOrderStatus.md
@@ -0,0 +1,11 @@
+# TransferOrderStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tx_id** | **str** | Order ID | [optional]
+**status** | **str** | Transfer status: PENDING - Processing, SUCCESS - Transfer successful, FAIL - Transfer failed, PARTIAL_SUCCESS - Partially successful (this status appears when transferring between sub-accounts) | [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)
+
+
diff --git a/docs/CrossMarginTransferable.md b/docs/TransferablesResult.md
similarity index 69%
rename from docs/CrossMarginTransferable.md
rename to docs/TransferablesResult.md
index 4e2b0d6..87b8b07 100644
--- a/docs/CrossMarginTransferable.md
+++ b/docs/TransferablesResult.md
@@ -1,10 +1,11 @@
-# CrossMarginTransferable
+# TransferablesResult
+Batch query unified account maximum transferable results
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency detail | [optional]
-**amount** | **str** | Max transferable amount | [optional]
+**amount** | **str** | Maximum transferable amount | [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)
diff --git a/docs/TriggerTime.md b/docs/TriggerTime.md
index 702ff62..a1e5d05 100644
--- a/docs/TriggerTime.md
+++ b/docs/TriggerTime.md
@@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**trigger_time** | **int** | Timestamp of the end of the countdown, in milliseconds | [optional]
+**trigger_time** | **int** | Timestamp when countdown ends, in milliseconds | [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)
diff --git a/docs/UidPushOrder.md b/docs/UidPushOrder.md
index fd0cc8c..25eb840 100644
--- a/docs/UidPushOrder.md
+++ b/docs/UidPushOrder.md
@@ -8,9 +8,10 @@ Name | Type | Description | Notes
**receive_uid** | **int** | Recipient User ID | [optional]
**currency** | **str** | Currency name | [optional]
**amount** | **str** | Transfer amount | [optional]
-**create_time** | **int** | Creation time | [optional]
-**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]
-**message** | **str** | PENDING Reason Tips | [optional]
+**create_time** | **int** | Created time | [optional]
+**status** | **str** | Withdrawal status: - CREATING: Creating - PENDING: Waiting for recipient (Please contact the recipient to accept the transfer on Gate official website) - CANCELLING: Cancelling - CANCELLED: Cancelled - REFUSING: Refusing - REFUSED: Refused - RECEIVING: Receiving - RECEIVED: Success | [optional]
+**message** | **str** | PENDING reason tips | [optional]
+**transaction_type** | **str** | Order Type | [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)
diff --git a/docs/UniCurrency.md b/docs/UniCurrency.md
index 6810b7e..02ea971 100644
--- a/docs/UniCurrency.md
+++ b/docs/UniCurrency.md
@@ -5,7 +5,7 @@ Currency detail
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional] [readonly]
-**min_lend_amount** | **str** | The minimum lending amount, in the unit of the currency. | [optional] [readonly]
+**min_lend_amount** | **str** | The minimum lending amount, in the unit of the currency | [optional] [readonly]
**max_lend_amount** | **str** | The total maximum lending amount, in USDT | [optional] [readonly]
**max_rate** | **str** | Maximum rate (Hourly) | [optional] [readonly]
**min_rate** | **str** | Minimum rate (Hourly) | [optional] [readonly]
diff --git a/docs/UniCurrencyInterest.md b/docs/UniCurrencyInterest.md
index bd58430..96c01fc 100644
--- a/docs/UniCurrencyInterest.md
+++ b/docs/UniCurrencyInterest.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional] [readonly]
-**interest_status** | **str** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly]
+**interest_status** | **str** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [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)
diff --git a/docs/UniInterestRecord.md b/docs/UniInterestRecord.md
index 1859976..9486ec0 100644
--- a/docs/UniInterestRecord.md
+++ b/docs/UniInterestRecord.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**currency** | **str** | Currency | [optional] [readonly]
**actual_rate** | **str** | Actual Rate | [optional] [readonly]
**interest** | **str** | Interest | [optional] [readonly]
-**interest_status** | **str** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly]
+**interest_status** | **str** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/UniLend.md b/docs/UniLend.md
index a6caff9..7080ac5 100644
--- a/docs/UniLend.md
+++ b/docs/UniLend.md
@@ -6,14 +6,14 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional] [readonly]
**current_amount** | **str** | Current amount | [optional] [readonly]
-**amount** | **str** | Total amount | [optional] [readonly]
-**lent_amount** | **str** | Lent amount | [optional] [readonly]
-**frozen_amount** | **str** | Frozen amount | [optional] [readonly]
+**amount** | **str** | Total Lending Amount | [optional] [readonly]
+**lent_amount** | **str** | Lent Amount | [optional] [readonly]
+**frozen_amount** | **str** | Pending Redemption Amount | [optional] [readonly]
**min_rate** | **str** | Minimum interest rate | [optional] [readonly]
-**interest_status** | **str** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly]
-**reinvest_left_amount** | **str** | Amount not reinvested | [optional] [readonly]
-**create_time** | **int** | Created time of the lending order | [optional] [readonly]
-**update_time** | **int** | Upated time of the lending order | [optional] [readonly]
+**interest_status** | **str** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly]
+**reinvest_left_amount** | **str** | Non-reinvested Amount | [optional] [readonly]
+**create_time** | **int** | Lending Order Creation Time | [optional] [readonly]
+**update_time** | **int** | Lending Order Last Update Time | [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)
diff --git a/docs/UniLendInterest.md b/docs/UniLendInterest.md
index 18a0815..899acfb 100644
--- a/docs/UniLendInterest.md
+++ b/docs/UniLendInterest.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional] [readonly]
-**interest** | **str** | Interest | [optional] [readonly]
+**interest** | **str** | Interest income | [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)
diff --git a/docs/UniLendRecord.md b/docs/UniLendRecord.md
index 294f6d8..39c187a 100644
--- a/docs/UniLendRecord.md
+++ b/docs/UniLendRecord.md
@@ -1,15 +1,15 @@
# UniLendRecord
-Interest Record
+Lending Record
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional] [readonly]
-**amount** | **str** | current amount | [optional] [readonly]
-**last_wallet_amount** | **str** | Last wallet amount | [optional] [readonly]
-**last_lent_amount** | **str** | Last lent amount | [optional] [readonly]
-**last_frozen_amount** | **str** | Last frozen amount | [optional] [readonly]
-**type** | **str** | Record type: lend - lend, redeem - redeem | [optional] [readonly]
+**amount** | **str** | Current Amount | [optional] [readonly]
+**last_wallet_amount** | **str** | Previous Available Amount | [optional] [readonly]
+**last_lent_amount** | **str** | Previous Lent Amount | [optional] [readonly]
+**last_frozen_amount** | **str** | Previous Frozen Amount | [optional] [readonly]
+**type** | **str** | Record Type: lend - Lend, redeem - Redeem | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/UniLoan.md b/docs/UniLoan.md
index 6e28454..6293d5f 100644
--- a/docs/UniLoan.md
+++ b/docs/UniLoan.md
@@ -1,15 +1,15 @@
# UniLoan
-Loan
+Borrowing
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency | [optional] [readonly]
**currency_pair** | **str** | Currency pair | [optional] [readonly]
-**amount** | **str** | amount | [optional] [readonly]
-**type** | **str** | Loan type, platform - platform, margin - margin | [optional] [readonly]
+**amount** | **str** | Amount to Repay | [optional] [readonly]
+**type** | **str** | Loan type: platform borrowing - platform, margin borrowing - margin | [optional] [readonly]
**create_time** | **int** | Created time | [optional] [readonly]
-**update_time** | **int** | Updated time | [optional] [readonly]
+**update_time** | **int** | Last Update Time | [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)
diff --git a/docs/UniLoanInterestRecord.md b/docs/UniLoanInterestRecord.md
index 01c41f8..e93539b 100644
--- a/docs/UniLoanInterestRecord.md
+++ b/docs/UniLoanInterestRecord.md
@@ -1,15 +1,15 @@
# UniLoanInterestRecord
-Interest record
+Interest Deduction Record
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional] [readonly]
**currency_pair** | **str** | Currency pair | [optional] [readonly]
-**actual_rate** | **str** | Actual rate | [optional] [readonly]
+**actual_rate** | **str** | Actual Rate | [optional] [readonly]
**interest** | **str** | Interest | [optional] [readonly]
**status** | **int** | Status: 0 - fail, 1 - success | [optional] [readonly]
-**type** | **str** | Type, platform - platform，margin - margin | [optional] [readonly]
+**type** | **str** | Type: platform - Platform borrowing, margin - Margin borrowing | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/UniLoanRecord.md b/docs/UniLoanRecord.md
index 93fd89e..b34be2c 100644
--- a/docs/UniLoanRecord.md
+++ b/docs/UniLoanRecord.md
@@ -1,13 +1,13 @@
# UniLoanRecord
-Loan records
+Borrowing Records
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**type** | **str** | type: borrow - borrow, repay - repay | [optional] [readonly]
+**type** | **str** | Type: `borrow` - borrow, `repay` - repay | [optional] [readonly]
**currency_pair** | **str** | Currency pair | [optional] [readonly]
**currency** | **str** | Currency | [optional] [readonly]
-**amount** | **str** | The amount of lending or repaying | [optional] [readonly]
+**amount** | **str** | Borrow or repayment amount | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/UnifiedAccount.md b/docs/UnifiedAccount.md
index e017e2a..4d2d24b 100644
--- a/docs/UnifiedAccount.md
+++ b/docs/UnifiedAccount.md
@@ -4,24 +4,25 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **int** | User ID | [optional]
-**refresh_time** | **int** | Time of the most recent refresh | [optional]
+**refresh_time** | **int** | Last refresh time | [optional]
**locked** | **bool** | Whether the account is locked, valid in cross-currency margin/combined margin mode, false in other modes such as single-currency margin mode | [optional]
**balances** | [**dict(str, UnifiedBalance)**](UnifiedBalance.md) | | [optional]
-**total** | **str** | Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be deprecated, replaced by unified_account_total) | [optional]
-**borrowed** | **str** | The total borrowed amount of the account converted into USD, i.e. the sum of `borrowed * price` of all currencies (excluding Point Cards). It is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode. | [optional]
+**total** | **str** | Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be removed, replaced by unified_account_total) | [optional]
+**borrowed** | **str** | Total borrowed amount converted to USD, i.e. the sum of `borrowed * price` of all currencies (excluding point cards), valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**total_initial_margin** | **str** | Total initial margin, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**total_margin_balance** | **str** | Total margin balance, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**total_maintenance_margin** | **str** | Total maintenance margin is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode | [optional]
**total_initial_margin_rate** | **str** | Total initial margin rate, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**total_maintenance_margin_rate** | **str** | Total maintenance margin rate, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**total_available_margin** | **str** | Available margin amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
-**unified_account_total** | **str** | Unify the total account assets, valid in single currency margin/cross-currency margin/combined margin mode | [optional]
-**unified_account_total_liab** | **str** | Unify the total loan of the account, valid in the cross-currency margin/combined margin mode, and 0 in other modes such as single-currency margin mode | [optional]
-**unified_account_total_equity** | **str** | Unify the total account equity, valid in single currency margin/cross-currency margin/combined margin mode | [optional]
-**leverage** | **str** | Actual leverage, valid in cross-currency margin/combined margin mode | [optional] [readonly]
+**unified_account_total** | **str** | Total unified account assets, valid in single currency margin/cross-currency margin/combined margin mode | [optional]
+**unified_account_total_liab** | **str** | Total unified account borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
+**unified_account_total_equity** | **str** | Total unified account equity, valid in single currency margin/cross-currency margin/combined margin mode | [optional]
+**leverage** | **str** | Actual leverage ratio, valid in cross-currency margin/combined margin mode | [optional] [readonly]
**spot_order_loss** | **str** | Total pending order loss, in USDT, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
-**spot_hedge** | **bool** | Spot hedging status, true - enabled, false - not enabled. | [optional]
-**use_funding** | **bool** | Whether to use funds as margin | [optional]
+**spot_hedge** | **bool** | Spot hedging status: true - enabled, false - disabled | [optional]
+**use_funding** | **bool** | Whether to use Earn funds as margin | [optional]
+**is_all_collateral** | **bool** | Whether all currencies are used as margin: true - all currencies as margin, false - no | [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)
diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md
index 6555fd4..5c23e08 100644
--- a/docs/UnifiedApi.md
+++ b/docs/UnifiedApi.md
@@ -5,33 +5,35 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
[**list_unified_accounts**](UnifiedApi.md#list_unified_accounts) | **GET** /unified/accounts | Get unified account information
-[**list_unified_account_mode**](UnifiedApi.md#list_unified_account_mode) | **GET** /unified/account_mode | Inquire about unified account mode (deprecated)
-[**set_unified_account_mode**](UnifiedApi.md#set_unified_account_mode) | **POST** /unified/account_mode | Set unified account mode (deprecated)
-[**get_unified_borrowable**](UnifiedApi.md#get_unified_borrowable) | **GET** /unified/borrowable | Query about the maximum borrowing for the unified account
-[**get_unified_transferable**](UnifiedApi.md#get_unified_transferable) | **GET** /unified/transferable | Query about the maximum transferable for the unified account
-[**list_unified_loans**](UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | List loans
+[**get_unified_borrowable**](UnifiedApi.md#get_unified_borrowable) | **GET** /unified/borrowable | Query maximum borrowable amount for unified account
+[**get_unified_transferable**](UnifiedApi.md#get_unified_transferable) | **GET** /unified/transferable | Query maximum transferable amount for unified account
+[**get_unified_transferables**](UnifiedApi.md#get_unified_transferables) | **GET** /unified/transferables | Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change
+[**get_unified_borrowable_list**](UnifiedApi.md#get_unified_borrowable_list) | **GET** /unified/batch_borrowable | Batch query unified account maximum borrowable amount
+[**list_unified_loans**](UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | Query loans
[**create_unified_loan**](UnifiedApi.md#create_unified_loan) | **POST** /unified/loans | Borrow or repay
-[**list_unified_loan_records**](UnifiedApi.md#list_unified_loan_records) | **GET** /unified/loan_records | Get load records
-[**list_unified_loan_interest_records**](UnifiedApi.md#list_unified_loan_interest_records) | **GET** /unified/interest_records | List interest records
-[**get_unified_risk_units**](UnifiedApi.md#get_unified_risk_units) | **GET** /unified/risk_units | Retrieve user risk unit details, only valid in portfolio margin mode
+[**list_unified_loan_records**](UnifiedApi.md#list_unified_loan_records) | **GET** /unified/loan_records | Query loan records
+[**list_unified_loan_interest_records**](UnifiedApi.md#list_unified_loan_interest_records) | **GET** /unified/interest_records | Query interest deduction records
+[**get_unified_risk_units**](UnifiedApi.md#get_unified_risk_units) | **GET** /unified/risk_units | Get user risk unit details
[**get_unified_mode**](UnifiedApi.md#get_unified_mode) | **GET** /unified/unified_mode | Query mode of the unified account
-[**set_unified_mode**](UnifiedApi.md#set_unified_mode) | **PUT** /unified/unified_mode | Set mode of the unified account
-[**get_unified_estimate_rate**](UnifiedApi.md#get_unified_estimate_rate) | **GET** /unified/estimate_rate | Get unified estimate rate
-[**list_currency_discount_tiers**](UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers
-[**list_loan_margin_tiers**](UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers
+[**set_unified_mode**](UnifiedApi.md#set_unified_mode) | **PUT** /unified/unified_mode | Set unified account mode
+[**get_unified_estimate_rate**](UnifiedApi.md#get_unified_estimate_rate) | **GET** /unified/estimate_rate | Query unified account estimated interest rate
+[**list_currency_discount_tiers**](UnifiedApi.md#list_currency_discount_tiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered
+[**list_loan_margin_tiers**](UnifiedApi.md#list_loan_margin_tiers) | **GET** /unified/loan_margin_tiers | Query unified account tiered loan margin
[**calculate_portfolio_margin**](UnifiedApi.md#calculate_portfolio_margin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator
-[**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:
-[**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.
-[**set_user_leverage_currency_setting**](UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set the loan currency leverage
-[**get_history_loan_rate**](UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | get historical lending rates
+[**get_user_leverage_currency_config**](UnifiedApi.md#get_user_leverage_currency_config) | **GET** /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set
+[**get_user_leverage_currency_setting**](UnifiedApi.md#get_user_leverage_currency_setting) | **GET** /unified/leverage/user_currency_setting | Get user currency leverage
+[**set_user_leverage_currency_setting**](UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set loan currency leverage
+[**list_unified_currencies**](UnifiedApi.md#list_unified_currencies) | **GET** /unified/currencies | List of loan currencies supported by unified account
+[**get_history_loan_rate**](UnifiedApi.md#get_history_loan_rate) | **GET** /unified/history_loan_rate | Get historical lending rates
+[**set_unified_collateral**](UnifiedApi.md#set_unified_collateral) | **POST** /unified/collateral_currencies | Set collateral currency
# **list_unified_accounts**
-> UnifiedAccount list_unified_accounts(currency=currency)
+> UnifiedAccount list_unified_accounts(currency=currency, sub_uid=sub_uid)
Get unified account information
-The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation
+The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. For specific formulas, please refer to [Margin Formula](#margin-formula)
### Example
@@ -57,11 +59,12 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
+sub_uid = '10001' # str | Sub account user ID (optional)
try:
# Get unified account information
- api_response = api_instance.list_unified_accounts(currency=currency)
+ api_response = api_instance.list_unified_accounts(currency=currency, sub_uid=sub_uid)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -73,7 +76,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
+ **sub_uid** | **str**| Sub account user ID | [optional]
### Return type
@@ -91,16 +95,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
-# **list_unified_account_mode**
-> dict(str, bool) list_unified_account_mode()
-
-Inquire about unified account mode (deprecated)
+# **get_unified_borrowable**
+> UnifiedBorrowable get_unified_borrowable(currency)
-cross_margin - Spot full-margin trading, usdt_futures - USDT perpetual futures
+Query maximum borrowable amount for unified account
### Example
@@ -126,23 +128,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
+currency = 'BTC' # str | Query by specified currency name
try:
- # Inquire about unified account mode (deprecated)
- api_response = api_instance.list_unified_account_mode()
+ # Query maximum borrowable amount for unified account
+ api_response = api_instance.get_unified_borrowable(currency)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling UnifiedApi->list_unified_account_mode: %s\n" % e)
+ print("Exception when calling UnifiedApi->get_unified_borrowable: %s\n" % e)
```
### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **currency** | **str**| Query by specified currency name |
### Return type
-**dict(str, bool)**
+[**UnifiedBorrowable**](UnifiedBorrowable.md)
### Authorization
@@ -156,14 +162,14 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **set_unified_account_mode**
-> dict(str, bool) set_unified_account_mode(unified_mode)
+# **get_unified_transferable**
+> UnifiedTransferable get_unified_transferable(currency)
-Set unified account mode (deprecated)
+Query maximum transferable amount for unified account
### Example
@@ -189,27 +195,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-unified_mode = gate_api.UnifiedMode() # UnifiedMode |
+currency = 'BTC' # str | Query by specified currency name
try:
- # Set unified account mode (deprecated)
- api_response = api_instance.set_unified_account_mode(unified_mode)
+ # Query maximum transferable amount for unified account
+ api_response = api_instance.get_unified_transferable(currency)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling UnifiedApi->set_unified_account_mode: %s\n" % e)
+ print("Exception when calling UnifiedApi->get_unified_transferable: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **unified_mode** | [**UnifiedMode**](UnifiedMode.md)| |
+ **currency** | **str**| Query by specified currency name |
### Return type
-**dict(str, bool)**
+[**UnifiedTransferable**](UnifiedTransferable.md)
### Authorization
@@ -217,20 +223,20 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Success | - |
+**200** | Query successful | - |
[[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)
-# **get_unified_borrowable**
-> UnifiedBorrowable get_unified_borrowable(currency)
+# **get_unified_transferables**
+> list[TransferablesResult] get_unified_transferables(currencies)
-Query about the maximum borrowing for the unified account
+Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change
### Example
@@ -256,27 +262,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currencies = 'BTC,ETH' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time
try:
- # Query about the maximum borrowing for the unified account
- api_response = api_instance.get_unified_borrowable(currency)
+ # Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change
+ api_response = api_instance.get_unified_transferables(currencies)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling UnifiedApi->get_unified_borrowable: %s\n" % e)
+ print("Exception when calling UnifiedApi->get_unified_transferables: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currencies** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time |
### Return type
-[**UnifiedBorrowable**](UnifiedBorrowable.md)
+[**list[TransferablesResult]**](TransferablesResult.md)
### Authorization
@@ -290,14 +296,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
-# **get_unified_transferable**
-> UnifiedTransferable get_unified_transferable(currency)
+# **get_unified_borrowable_list**
+> list[UnifiedBorrowable1] get_unified_borrowable_list(currencies)
-Query about the maximum transferable for the unified account
+Batch query unified account maximum borrowable amount
### Example
@@ -323,27 +329,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency
+currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Specify currency names for querying in an array, separated by commas, maximum 10 currencies
try:
- # Query about the maximum transferable for the unified account
- api_response = api_instance.get_unified_transferable(currency)
+ # Batch query unified account maximum borrowable amount
+ api_response = api_instance.get_unified_borrowable_list(currencies)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling UnifiedApi->get_unified_transferable: %s\n" % e)
+ print("Exception when calling UnifiedApi->get_unified_borrowable_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency |
+ **currencies** | [**list[str]**](str.md)| Specify currency names for querying in an array, separated by commas, maximum 10 currencies |
### Return type
-[**UnifiedTransferable**](UnifiedTransferable.md)
+[**list[UnifiedBorrowable1]**](UnifiedBorrowable1.md)
### Authorization
@@ -357,14 +363,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_unified_loans**
> list[UniLoan] list_unified_loans(currency=currency, page=page, limit=limit, type=type)
-List loans
+Query loans
### Example
@@ -390,13 +396,13 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
-type = 'platform' # str | Loan type, platform - platform, margin - margin (optional)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
+type = 'platform' # str | Loan type: platform borrowing - platform, margin borrowing - margin (optional)
try:
- # List loans
+ # Query loans
api_response = api_instance.list_unified_loans(currency=currency, page=page, limit=limit, type=type)
print(api_response)
except GateApiException as ex:
@@ -409,10 +415,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
- **type** | **str**| Loan type, platform - platform, margin - margin | [optional]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
+ **type** | **str**| Loan type: platform borrowing - platform, margin borrowing - margin | [optional]
### Return type
@@ -430,16 +436,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **create_unified_loan**
-> create_unified_loan(unified_loan)
+> UnifiedLoanResult create_unified_loan(unified_loan)
Borrow or repay
-When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true`
+When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts
### Example
@@ -469,7 +475,8 @@ unified_loan = gate_api.UnifiedLoan() # UnifiedLoan |
try:
# Borrow or repay
- api_instance.create_unified_loan(unified_loan)
+ api_response = api_instance.create_unified_loan(unified_loan)
+ print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
@@ -484,7 +491,7 @@ Name | Type | Description | Notes
### Return type
-void (empty response body)
+[**UnifiedLoanResult**](UnifiedLoanResult.md)
### Authorization
@@ -493,19 +500,19 @@ void (empty response body)
### HTTP request headers
- **Content-Type**: application/json
- - **Accept**: Not defined
+ - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Operated successfully | - |
+**200** | Operation successful | - |
[[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)
# **list_unified_loan_records**
> list[UnifiedLoanRecord] list_unified_loan_records(type=type, currency=currency, page=page, limit=limit)
-Get load records
+Query loan records
### Example
@@ -531,13 +538,13 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-type = 'type_example' # str | The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds (optional)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+type = 'type_example' # str | Loan record type: borrow - borrowing, repay - repayment (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
try:
- # Get load records
+ # Query loan records
api_response = api_instance.list_unified_loan_records(type=type, currency=currency, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -550,10 +557,10 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **type** | **str**| The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds | [optional]
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **type** | **str**| Loan record type: borrow - borrowing, repay - repayment | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
### Return type
@@ -571,14 +578,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_unified_loan_interest_records**
> list[UniLoanInterestRecord] list_unified_loan_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to, type=type)
-List interest records
+Query interest deduction records
### Example
@@ -604,15 +611,15 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
-_from = 1627706330 # int | Start timestamp of the query (optional)
-to = 1635329650 # int | Time range ending, default to current time (optional)
-type = 'platform' # str | Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin (optional)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
+_from = 1627706330 # int | Start timestamp for the query (optional)
+to = 1635329650 # int | End timestamp for the query, defaults to current time if not specified (optional)
+type = 'platform' # str | Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified (optional)
try:
- # List interest records
+ # Query interest deduction records
api_response = api_instance.list_unified_loan_interest_records(currency=currency, page=page, limit=limit, _from=_from, to=to, type=type)
print(api_response)
except GateApiException as ex:
@@ -625,12 +632,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
- **_from** | **int**| Start timestamp of the query | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **type** | **str**| Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin | [optional]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
+ **_from** | **int**| Start timestamp for the query | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **type** | **str**| Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified | [optional]
### Return type
@@ -648,14 +655,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_unified_risk_units**
> UnifiedRiskUnits get_unified_risk_units()
-Retrieve user risk unit details, only valid in portfolio margin mode
+Get user risk unit details
+
+Get user risk unit details, only valid in portfolio margin mode
### Example
@@ -683,7 +692,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.UnifiedApi(api_client)
try:
- # Retrieve user risk unit details, only valid in portfolio margin mode
+ # Get user risk unit details
api_response = api_instance.get_unified_risk_units()
print(api_response)
except GateApiException as ex:
@@ -711,7 +720,7 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -776,16 +785,16 @@ This endpoint does not need any parameter.
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **set_unified_mode**
> set_unified_mode(unified_mode_set)
-Set mode of the unified account
+Set unified account mode
-每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通组合保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ```
+Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ```
### Example
@@ -814,7 +823,7 @@ api_instance = gate_api.UnifiedApi(api_client)
unified_mode_set = gate_api.UnifiedModeSet() # UnifiedModeSet |
try:
- # Set mode of the unified account
+ # Set unified account mode
api_instance.set_unified_mode(unified_mode_set)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -844,16 +853,16 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Success | - |
+**204** | Set successfully | - |
[[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)
# **get_unified_estimate_rate**
> dict(str, str) get_unified_estimate_rate(currencies)
-Get unified estimate rate
+Query unified account estimated interest rate
-Due to fluctuations in lending depth, hourly interest rates may vary, and thus, I cannot provide exact rates. When a currency is not supported, the interest rate returned will be an empty string.
+Interest rates fluctuate hourly based on lending depth, so exact rates cannot be provided. When a currency is not supported, the interest rate returned will be an empty string
### Example
@@ -879,10 +888,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies.
+currencies = ['[\"BTC\",\"GT\"]'] # list[str] | Specify currency names for querying in an array, separated by commas, maximum 10 currencies
try:
- # Get unified estimate rate
+ # Query unified account estimated interest rate
api_response = api_instance.get_unified_estimate_rate(currencies)
print(api_response)
except GateApiException as ex:
@@ -895,7 +904,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currencies** | [**list[str]**](str.md)| Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. |
+ **currencies** | [**list[str]**](str.md)| Specify currency names for querying in an array, separated by commas, maximum 10 currencies |
### Return type
@@ -913,14 +922,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_currency_discount_tiers**
> list[UnifiedDiscount] list_currency_discount_tiers()
-List currency discount tiers
+Query unified account tiered
### Example
@@ -939,7 +948,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.UnifiedApi(api_client)
try:
- # List currency discount tiers
+ # Query unified account tiered
api_response = api_instance.list_currency_discount_tiers()
print(api_response)
except GateApiException as ex:
@@ -967,14 +976,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **list_loan_margin_tiers**
> list[UnifiedMarginTiers] list_loan_margin_tiers()
-List loan margin tiers
+Query unified account tiered loan margin
### Example
@@ -993,7 +1002,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.UnifiedApi(api_client)
try:
- # List loan margin tiers
+ # Query unified account tiered loan margin
api_response = api_instance.list_loan_margin_tiers()
print(api_response)
except GateApiException as ex:
@@ -1021,7 +1030,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -1030,7 +1039,7 @@ No authorization required
Portfolio margin calculator
-Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included.
+Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included.
### Example
@@ -1081,14 +1090,14 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_user_leverage_currency_config**
> UnifiedLeverageConfig get_user_leverage_currency_config(currency)
-The maximum and minimum leverage multiples that users can set for a currency type are:
+Maximum and minimum currency leverage that can be set
### Example
@@ -1117,7 +1126,7 @@ api_instance = gate_api.UnifiedApi(api_client)
currency = 'BTC' # str | Currency
try:
- # The maximum and minimum leverage multiples that users can set for a currency type are:
+ # Maximum and minimum currency leverage that can be set
api_response = api_instance.get_user_leverage_currency_config(currency)
print(api_response)
except GateApiException as ex:
@@ -1148,14 +1157,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_user_leverage_currency_setting**
-> UnifiedLeverageSetting get_user_leverage_currency_setting(currency=currency)
+> list[UnifiedLeverageSetting] get_user_leverage_currency_setting(currency=currency)
+
+Get user currency leverage
-Get the user's currency leverage. If currency is not passed, query all currencies.
+Get user currency leverage. If currency is not specified, query all currencies
### Example
@@ -1184,7 +1195,7 @@ api_instance = gate_api.UnifiedApi(api_client)
currency = 'BTC' # str | Currency (optional)
try:
- # Get the user's currency leverage. If currency is not passed, query all currencies.
+ # Get user currency leverage
api_response = api_instance.get_user_leverage_currency_setting(currency=currency)
print(api_response)
except GateApiException as ex:
@@ -1201,7 +1212,7 @@ Name | Type | Description | Notes
### Return type
-[**UnifiedLeverageSetting**](UnifiedLeverageSetting.md)
+[**list[UnifiedLeverageSetting]**](UnifiedLeverageSetting.md)
### Authorization
@@ -1215,14 +1226,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **set_user_leverage_currency_setting**
-> set_user_leverage_currency_setting(unified_leverage_setting=unified_leverage_setting)
+> set_user_leverage_currency_setting(unified_leverage_setting)
-Set the loan currency leverage
+Set loan currency leverage
### Example
@@ -1248,11 +1259,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-unified_leverage_setting = gate_api.UnifiedLeverageSetting() # UnifiedLeverageSetting | (optional)
+unified_leverage_setting = gate_api.UnifiedLeverageSetting() # UnifiedLeverageSetting |
try:
- # Set the loan currency leverage
- api_instance.set_user_leverage_currency_setting(unified_leverage_setting=unified_leverage_setting)
+ # Set loan currency leverage
+ api_instance.set_user_leverage_currency_setting(unified_leverage_setting)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
@@ -1263,7 +1274,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **unified_leverage_setting** | [**UnifiedLeverageSetting**](UnifiedLeverageSetting.md)| | [optional]
+ **unified_leverage_setting** | [**UnifiedLeverageSetting**](UnifiedLeverageSetting.md)| |
### Return type
@@ -1281,14 +1292,136 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**204** | Success | - |
+**204** | Set successfully | - |
+
+[[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)
+
+# **list_unified_currencies**
+> list[UnifiedCurrency] list_unified_currencies(currency=currency)
+
+List of loan currencies supported by unified account
+
+### Example
+
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.UnifiedApi(api_client)
+currency = 'BTC' # str | Currency (optional)
+
+try:
+ # List of loan currencies supported by unified account
+ api_response = api_instance.list_unified_currencies(currency=currency)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling UnifiedApi->list_unified_currencies: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **currency** | **str**| Currency | [optional]
+
+### Return type
+
+[**list[UnifiedCurrency]**](UnifiedCurrency.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | List retrieved successfully | - |
[[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)
# **get_history_loan_rate**
> UnifiedHistoryLoanRate get_history_loan_rate(currency, tier=tier, page=page, limit=limit)
-get historical lending rates
+Get historical lending rates
+
+### Example
+
+```python
+from __future__ import print_function
+import gate_api
+from gate_api.exceptions import ApiException, GateApiException
+# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
+# See configuration.py for a list of all supported configuration parameters.
+configuration = gate_api.Configuration(
+ host = "https://api.gateio.ws/api/v4"
+)
+
+api_client = gate_api.ApiClient(configuration)
+# Create an instance of the API class
+api_instance = gate_api.UnifiedApi(api_client)
+currency = 'USDT' # str | Currency
+tier = '1' # str | VIP level for the floating rate to be queried (optional)
+page = 1 # int | Page number (optional) (default to 1)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
+
+try:
+ # Get historical lending rates
+ api_response = api_instance.get_history_loan_rate(currency, tier=tier, page=page, limit=limit)
+ print(api_response)
+except GateApiException as ex:
+ print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
+except ApiException as e:
+ print("Exception when calling UnifiedApi->get_history_loan_rate: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **currency** | **str**| Currency |
+ **tier** | **str**| VIP level for the floating rate to be queried | [optional]
+ **page** | **int**| Page number | [optional] [default to 1]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
+
+### Return type
+
+[**UnifiedHistoryLoanRate**](UnifiedHistoryLoanRate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Query successful | - |
+
+[[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)
+
+# **set_unified_collateral**
+> UnifiedCollateralRes set_unified_collateral(unified_collateral_req)
+
+Set collateral currency
### Example
@@ -1314,33 +1447,27 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.UnifiedApi(api_client)
-currency = 'USDT' # str | Currency
-tier = '1' # str | The VIP level of the floating rate that needs to be queried (optional)
-page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+unified_collateral_req = gate_api.UnifiedCollateralReq() # UnifiedCollateralReq |
try:
- # get historical lending rates
- api_response = api_instance.get_history_loan_rate(currency, tier=tier, page=page, limit=limit)
+ # Set collateral currency
+ api_response = api_instance.set_unified_collateral(unified_collateral_req)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
except ApiException as e:
- print("Exception when calling UnifiedApi->get_history_loan_rate: %s\n" % e)
+ print("Exception when calling UnifiedApi->set_unified_collateral: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Currency |
- **tier** | **str**| The VIP level of the floating rate that needs to be queried | [optional]
- **page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **unified_collateral_req** | [**UnifiedCollateralReq**](UnifiedCollateralReq.md)| |
### Return type
-[**UnifiedHistoryLoanRate**](UnifiedHistoryLoanRate.md)
+[**UnifiedCollateralRes**](UnifiedCollateralRes.md)
### Authorization
@@ -1348,13 +1475,13 @@ Name | Type | Description | Notes
### HTTP request headers
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Updated successfully | - |
[[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)
diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md
index 2040f0b..748cf98 100644
--- a/docs/UnifiedBalance.md
+++ b/docs/UnifiedBalance.md
@@ -3,25 +3,26 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**available** | **str** | Available amount is valid in single currency margin/cross-currency margin/combined margin mode, and the calculation is different in different modes | [optional]
-**freeze** | **str** | The locked amount is valid in single currency margin/cross-currency margin/combined margin mode | [optional]
-**borrowed** | **str** | Borrow limit, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
-**negative_liab** | **str** | Negative balance loan is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode | [optional]
+**available** | **str** | Available balance, valid in single currency margin/cross-currency margin/combined margin mode, calculation varies by mode | [optional]
+**freeze** | **str** | Locked balance, valid in single currency margin/cross-currency margin/combined margin mode | [optional]
+**borrowed** | **str** | Borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
+**negative_liab** | **str** | Negative balance borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**futures_pos_liab** | **str** | Contract opening position borrowing currency (abandoned, to be offline field) | [optional]
**equity** | **str** | Equity, valid in single currency margin/cross currency margin/combined margin mode | [optional]
-**total_freeze** | **str** | Total occupancy (discarded, to be offline field) | [optional]
-**total_liab** | **str** | Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
+**total_freeze** | **str** | Total frozen (deprecated, to be removed) | [optional]
+**total_liab** | **str** | Total borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional]
**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]
-**funding** | **str** | Yubibao financial management amount, effective when Yubibao financial management is turned on as a unified account margin switch | [optional]
+**funding** | **str** | Uniloan financial management amount, effective when turned on as a unified account margin switch | [optional]
**funding_version** | **str** | Funding version | [optional]
**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]
**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]
**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]
-**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]
+**mm** | **str** | Cross margin maintenance margin, valid in single-currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode | [optional]
**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]
**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]
**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]
-**available_margin** | **str** | Full margin available for full position is valid in single currency margin mode, and is 0 in other modes such as cross-currency margin/combined margin mode | [optional]
+**available_margin** | **str** | Cross margin available balance, valid in single currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode | [optional]
+**enabled_collateral** | **bool** | Currency enabled as margin: true - Enabled, false - Disabled | [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)
diff --git a/docs/MarginBorrowable.md b/docs/UnifiedBorrowable1.md
similarity index 70%
rename from docs/MarginBorrowable.md
rename to docs/UnifiedBorrowable1.md
index 6cd64a5..81b38b3 100644
--- a/docs/MarginBorrowable.md
+++ b/docs/UnifiedBorrowable1.md
@@ -1,11 +1,11 @@
-# MarginBorrowable
+# UnifiedBorrowable1
+Batch query unified account maximum borrowable results
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency detail | [optional]
-**currency_pair** | **str** | Currency pair | [optional]
-**amount** | **str** | Max borrowable amount | [optional]
+**amount** | **str** | Maximum borrowable amount | [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)
diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md
new file mode 100644
index 0000000..fc1976a
--- /dev/null
+++ b/docs/UnifiedCollateralReq.md
@@ -0,0 +1,12 @@
+# UnifiedCollateralReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collateral_type** | **int** | User-set collateral mode: 0(all)-All currencies as collateral, 1(custom)-Custom currencies as collateral. When collateral_type is 0(all), enable_list and disable_list parameters are invalid | [optional]
+**enable_list** | **list[str]** | Currency list, where collateral_type=1(custom) indicates the addition logic | [optional]
+**disable_list** | **list[str]** | Disable list, indicating the disable logic | [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)
+
+
diff --git a/docs/UnifiedCollateralRes.md b/docs/UnifiedCollateralRes.md
new file mode 100644
index 0000000..7432c38
--- /dev/null
+++ b/docs/UnifiedCollateralRes.md
@@ -0,0 +1,11 @@
+# UnifiedCollateralRes
+
+Unified account collateral mode settings response
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_success** | **bool** | Whether the setting was successful | [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)
+
+
diff --git a/docs/UnifiedCurrency.md b/docs/UnifiedCurrency.md
new file mode 100644
index 0000000..db33f77
--- /dev/null
+++ b/docs/UnifiedCurrency.md
@@ -0,0 +1,15 @@
+# UnifiedCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Currency name | [optional]
+**prec** | **str** | Currency precision | [optional]
+**min_borrow_amount** | **str** | Minimum borrowable limit, in currency units | [optional]
+**user_max_borrow_amount** | **str** | User's maximum borrowable limit, in USDT | [optional]
+**total_max_borrow_amount** | **str** | Platform's maximum borrowable limit, in USDT | [optional]
+**loan_status** | **str** | Lending status - `disable` : Lending prohibited - `enable` : Lending supported | [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)
+
+
diff --git a/docs/UnifiedDiscount.md b/docs/UnifiedDiscount.md
index a75f59f..a242849 100644
--- a/docs/UnifiedDiscount.md
+++ b/docs/UnifiedDiscount.md
@@ -1,6 +1,6 @@
# UnifiedDiscount
-Currency discount tiers
+Unified account tiered discount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
diff --git a/docs/UnifiedDiscountTiers.md b/docs/UnifiedDiscountTiers.md
index b6d7f19..ba78cc7 100644
--- a/docs/UnifiedDiscountTiers.md
+++ b/docs/UnifiedDiscountTiers.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
**tier** | **str** | Tier | [optional]
**discount** | **str** | Discount | [optional]
**lower_limit** | **str** | Lower limit | [optional]
-**upper_limit** | **str** | Upper limit,＋ indicates positive infinity | [optional]
+**upper_limit** | **str** | Upper limit, + indicates positive infinity | [optional]
**leverage** | **str** | Position leverage | [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)
diff --git a/docs/UnifiedHistoryLoanRate.md b/docs/UnifiedHistoryLoanRate.md
index 9d9d670..4414cf5 100644
--- a/docs/UnifiedHistoryLoanRate.md
+++ b/docs/UnifiedHistoryLoanRate.md
@@ -4,9 +4,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional]
-**tier** | **str** | The VIP level of the floating rate required | [optional]
-**tier_up_rate** | **str** | VIP level corresponding floating rate | [optional]
-**rates** | [**list[UnifiedHistoryLoanRateRates]**](UnifiedHistoryLoanRateRates.md) | Historical interest rate information, one data per hour, the array size is determined by the page and limit parameters provided by the interface request parameters, sorted from recent to far in time | [optional]
+**tier** | **str** | VIP level for the floating rate to be retrieved | [optional]
+**tier_up_rate** | **str** | Floating rate corresponding to VIP level | [optional]
+**rates** | [**list[UnifiedHistoryLoanRateRates]**](UnifiedHistoryLoanRateRates.md) | Historical interest rate information, one data point per hour, array size determined by page and limit parameters from the API request, sorted by time from recent to distant | [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)
diff --git a/docs/UnifiedHistoryLoanRateRates.md b/docs/UnifiedHistoryLoanRateRates.md
index af73623..2cc9c85 100644
--- a/docs/UnifiedHistoryLoanRateRates.md
+++ b/docs/UnifiedHistoryLoanRateRates.md
@@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**time** | **int** | The hourly timestamp corresponding to the interest rate, in milliseconds | [optional]
-**rate** | **str** | Historical interest rates for this hour | [optional]
+**time** | **int** | Hourly timestamp corresponding to this interest rate, in milliseconds | [optional]
+**rate** | **str** | Historical interest rate for this hour | [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)
diff --git a/docs/UnifiedLeverageConfig.md b/docs/UnifiedLeverageConfig.md
index fd550f7..4f70f0d 100644
--- a/docs/UnifiedLeverageConfig.md
+++ b/docs/UnifiedLeverageConfig.md
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
**max_leverage** | **str** | Maximum adjustable leverage ratio | [optional]
**debit** | **str** | Current liabilities | [optional]
**available_margin** | **str** | Available Margin | [optional]
-**borrowable** | **str** | The current leverage you can choose is | [optional]
-**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]
+**borrowable** | **str** | Maximum borrowable amount at current leverage | [optional]
+**except_leverage_borrowable** | **str** | Maximum borrowable from margin and maximum borrowable from Earn, whichever is smaller | [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)
diff --git a/docs/UnifiedLeverageSetting.md b/docs/UnifiedLeverageSetting.md
index 8d8339f..63a8b10 100644
--- a/docs/UnifiedLeverageSetting.md
+++ b/docs/UnifiedLeverageSetting.md
@@ -1,10 +1,11 @@
# UnifiedLeverageSetting
+Leverage multiplier for borrowing currency
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**currency** | **str** | Currency name | [optional]
-**leverage** | **str** | multiple | [optional]
+**currency** | **str** | Currency name |
+**leverage** | **str** | Multiplier |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/UnifiedLoan.md b/docs/UnifiedLoan.md
index 9bc0760..0f950f3 100644
--- a/docs/UnifiedLoan.md
+++ b/docs/UnifiedLoan.md
@@ -5,9 +5,9 @@ Borrow or repay
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency |
-**type** | **str** | type: borrow - borrow, repay - repay |
-**amount** | **str** | The amount of lending or repaying |
-**repaid_all** | **bool** | Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. | [optional]
+**type** | **str** | Type: `borrow` - borrow, `repay` - repay |
+**amount** | **str** | Borrow or repayment amount |
+**repaid_all** | **bool** | Full repayment, only used for repayment operations. When set to `true`, overrides `amount` and directly repays the full amount | [optional]
**text** | **str** | User defined custom ID | [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)
diff --git a/docs/UnifiedLoanRecord.md b/docs/UnifiedLoanRecord.md
index cc292fa..29d2159 100644
--- a/docs/UnifiedLoanRecord.md
+++ b/docs/UnifiedLoanRecord.md
@@ -1,16 +1,16 @@
# UnifiedLoanRecord
-Loan records
+Borrowing Records
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **int** | id | [optional] [readonly]
-**type** | **str** | type: borrow - borrow, repay - repay | [optional] [readonly]
-**repayment_type** | **str** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation | [optional] [readonly]
-**borrow_type** | **str** | Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment | [optional]
+**id** | **int** | ID | [optional] [readonly]
+**type** | **str** | Type: `borrow` - borrow, `repay` - repay | [optional] [readonly]
+**repayment_type** | **str** | Repayment type: none - No repayment type, manual_repay - Manual repayment, auto_repay - Automatic repayment, cancel_auto_repay - Automatic repayment after order cancellation, different_currencies_repayment - Cross-currency repayment | [optional] [readonly]
+**borrow_type** | **str** | Borrowing type, returned when querying loan records: manual_borrow - Manual borrowing, auto_borrow - Automatic borrowing | [optional]
**currency_pair** | **str** | Currency pair | [optional] [readonly]
**currency** | **str** | Currency | [optional] [readonly]
-**amount** | **str** | The amount of lending or repaying | [optional] [readonly]
+**amount** | **str** | Borrow or repayment amount | [optional] [readonly]
**create_time** | **int** | Created time | [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)
diff --git a/docs/UnifiedLoanResult.md b/docs/UnifiedLoanResult.md
new file mode 100644
index 0000000..8db1d72
--- /dev/null
+++ b/docs/UnifiedLoanResult.md
@@ -0,0 +1,11 @@
+# UnifiedLoanResult
+
+Unified account borrowing and repayment response result
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tran_id** | **int** | Transaction ID | [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)
+
+
diff --git a/docs/UnifiedMarginTiers.md b/docs/UnifiedMarginTiers.md
index 2fb5930..2f2cad9 100644
--- a/docs/UnifiedMarginTiers.md
+++ b/docs/UnifiedMarginTiers.md
@@ -1,11 +1,11 @@
# UnifiedMarginTiers
-Unified margin tiers
+Unified account borrowing margin tiers
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency name | [optional]
-**margin_tiers** | [**list[MarginTiers]**](MarginTiers.md) | Margin tiers | [optional]
+**margin_tiers** | [**list[MarginTiers]**](MarginTiers.md) | Tiered margin | [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)
diff --git a/docs/UnifiedModeSet.md b/docs/UnifiedModeSet.md
index 7d564ce..bdfbaa0 100644
--- a/docs/UnifiedModeSet.md
+++ b/docs/UnifiedModeSet.md
@@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**mode** | **str** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model |
+**mode** | **str** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode |
**settings** | [**UnifiedSettings**](UnifiedSettings.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)
diff --git a/docs/UnifiedPortfolioInput.md b/docs/UnifiedPortfolioInput.md
index 296fdb1..465188f 100644
--- a/docs/UnifiedPortfolioInput.md
+++ b/docs/UnifiedPortfolioInput.md
@@ -1,6 +1,6 @@
# UnifiedPortfolioInput
-Input for the portfolio margin calculator.
+Portfolio margin calculator input
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**futures_orders** | [**list[MockFuturesOrder]**](MockFuturesOrder.md) | Futures order | [optional]
**options_positions** | [**list[MockOptionsPosition]**](MockOptionsPosition.md) | Options positions | [optional]
**options_orders** | [**list[MockOptionsOrder]**](MockOptionsOrder.md) | Option orders | [optional]
-**spot_hedge** | **bool** | Whether to enable spot hedging. | [optional]
+**spot_hedge** | **bool** | Whether to enable spot hedging | [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)
diff --git a/docs/UnifiedPortfolioOutput.md b/docs/UnifiedPortfolioOutput.md
index 11447de..08d671a 100644
--- a/docs/UnifiedPortfolioOutput.md
+++ b/docs/UnifiedPortfolioOutput.md
@@ -1,12 +1,12 @@
# UnifiedPortfolioOutput
-The output of the portfolio margin calculator.
+Portfolio margin calculator output
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**maintain_margin_total** | **str** | Total maintenance margin, including only the portfolio margin calculation results for positions in the risk unit, excluding borrowed margin. If borrowing exists, conventional borrowing margin requirements will still apply. | [optional]
-**initial_margin_total** | **str** | Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders. | [optional]
-**calculate_time** | **int** | Calculate time | [optional]
+**maintain_margin_total** | **str** | Total maintenance margin, including only portfolio margin calculation results for positions in risk units, excluding borrowing margin. If borrowing exists, conventional borrowing margin requirements will still apply | [optional]
+**initial_margin_total** | **str** | Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders | [optional]
+**calculate_time** | **int** | Calculation time | [optional]
**risk_unit** | [**list[MockRiskUnit]**](MockRiskUnit.md) | Risk unit | [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)
diff --git a/docs/UnifiedRiskUnits.md b/docs/UnifiedRiskUnits.md
index 8765dbf..ef263da 100644
--- a/docs/UnifiedRiskUnits.md
+++ b/docs/UnifiedRiskUnits.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_id** | **int** | User ID | [optional]
-**spot_hedge** | **bool** | Spot hedging status, true - enabled, false - not enabled. | [optional]
+**spot_hedge** | **bool** | Spot hedging status: true - enabled, false - disabled | [optional]
**risk_units** | [**list[RiskUnits]**](RiskUnits.md) | Risk unit | [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)
diff --git a/docs/UnifiedSettings.md b/docs/UnifiedSettings.md
index 9ca3de2..96fe971 100644
--- a/docs/UnifiedSettings.md
+++ b/docs/UnifiedSettings.md
@@ -3,10 +3,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**usdt_futures** | **bool** | USDT contract switch. In cross-currency margin mode, it can only be turned on and not off | [optional]
-**spot_hedge** | **bool** | 现货对冲开关。 | [optional]
-**use_funding** | **bool** | When the mode is set to combined margin mode, will funds be used as margin | [optional]
-**options** | **bool** | Option switch. In cross-currency margin mode, it can only be turned on and not off | [optional]
+**usdt_futures** | **bool** | USDT futures switch. In cross-currency margin mode, can only be enabled and cannot be disabled | [optional]
+**spot_hedge** | **bool** | Spot hedging switch | [optional]
+**use_funding** | **bool** | Earn switch, when mode is cross-currency margin mode, whether to use Earn funds as margin | [optional]
+**options** | **bool** | Options switch. In cross-currency margin mode, can only be enabled and cannot be disabled | [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)
diff --git a/docs/UnifiedTransferable.md b/docs/UnifiedTransferable.md
index 69f9b19..1d07c53 100644
--- a/docs/UnifiedTransferable.md
+++ b/docs/UnifiedTransferable.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | **str** | Currency detail | [optional]
-**amount** | **str** | The maximum amount that can be transferred out | [optional]
+**amount** | **str** | Maximum transferable amount | [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)
diff --git a/docs/UserLtvInfo.md b/docs/UserLtvInfo.md
index f267508..1483aff 100644
--- a/docs/UserLtvInfo.md
+++ b/docs/UserLtvInfo.md
@@ -4,11 +4,11 @@ User's currency statistics data
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**collateral_currency** | **str** | Collateral | [optional]
+**collateral_currency** | **str** | Collateral currency | [optional]
**borrow_currency** | **str** | Borrowed currency | [optional]
-**init_ltv** | **str** | The initial collateralization rate | [optional]
-**alert_ltv** | **str** | Warning collateralization ratio | [optional]
-**liquidate_ltv** | **str** | The liquidation collateralization rate | [optional]
+**init_ltv** | **str** | Initial collateralization rate | [optional]
+**alert_ltv** | **str** | Warning collateralization rate | [optional]
+**liquidate_ltv** | **str** | Liquidation collateralization rate | [optional]
**min_borrow_amount** | **str** | Minimum borrowable amount for the loan currency | [optional]
**left_borrowable_amount** | **str** | Remaining borrowable amount for the loan currency | [optional]
diff --git a/docs/UserSub.md b/docs/UserSub.md
new file mode 100644
index 0000000..c5432f0
--- /dev/null
+++ b/docs/UserSub.md
@@ -0,0 +1,13 @@
+# UserSub
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **int** | User ID | [optional]
+**belong** | **str** | User's system affiliation (partner/referral). Empty means not belonging to any system | [optional]
+**type** | **int** | Type (0-Not in system 1-Direct subordinate agent 2-Indirect subordinate agent 3-Direct direct customer 4-Indirect direct customer 5-Regular user) | [optional]
+**ref_uid** | **int** | Inviter user ID | [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)
+
+
diff --git a/docs/UserSubRelation.md b/docs/UserSubRelation.md
new file mode 100644
index 0000000..912227c
--- /dev/null
+++ b/docs/UserSubRelation.md
@@ -0,0 +1,10 @@
+# UserSubRelation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**list[UserSub]**](UserSub.md) | Subordinate relationship list | [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)
+
+
diff --git a/docs/UserTotalAmount.md b/docs/UserTotalAmount.md
index 38d1b41..87460d1 100644
--- a/docs/UserTotalAmount.md
+++ b/docs/UserTotalAmount.md
@@ -1,11 +1,11 @@
# UserTotalAmount
-Total borrowed amount and pledged collateral amount by the user
+User's total borrowing and collateral amount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**borrow_amount** | **str** | Total borrowing amount, calculated in USDT | [optional]
-**collateral_amount** | **str** | Total collateral amount, calculated in USDT | [optional]
+**borrow_amount** | **str** | Total borrowing amount in USDT | [optional]
+**collateral_amount** | **str** | Total collateral amount in USDT | [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)
diff --git a/docs/WalletApi.md b/docs/WalletApi.md
index d7bae45..e137cb6 100644
--- a/docs/WalletApi.md
+++ b/docs/WalletApi.md
@@ -4,33 +4,33 @@ All URIs are relative to *https://api.gateio.ws/api/v4*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**list_currency_chains**](WalletApi.md#list_currency_chains) | **GET** /wallet/currency_chains | List chains supported for specified currency
+[**list_currency_chains**](WalletApi.md#list_currency_chains) | **GET** /wallet/currency_chains | Query chains supported for specified currency
[**get_deposit_address**](WalletApi.md#get_deposit_address) | **GET** /wallet/deposit_address | Generate currency deposit address
-[**list_withdrawals**](WalletApi.md#list_withdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records
-[**list_deposits**](WalletApi.md#list_deposits) | **GET** /wallet/deposits | Retrieve deposit records
+[**list_withdrawals**](WalletApi.md#list_withdrawals) | **GET** /wallet/withdrawals | Get withdrawal records
+[**list_deposits**](WalletApi.md#list_deposits) | **GET** /wallet/deposits | Get deposit records
[**transfer**](WalletApi.md#transfer) | **POST** /wallet/transfers | Transfer between trading accounts
-[**list_sub_account_transfers**](WalletApi.md#list_sub_account_transfers) | **GET** /wallet/sub_account_transfers | Retrieve transfer records between main and sub accounts
+[**list_sub_account_transfers**](WalletApi.md#list_sub_account_transfers) | **GET** /wallet/sub_account_transfers | Get transfer records between main and sub accounts
[**transfer_with_sub_account**](WalletApi.md#transfer_with_sub_account) | **POST** /wallet/sub_account_transfers | Transfer between main and sub accounts
-[**sub_account_to_sub_account**](WalletApi.md#sub_account_to_sub_account) | **POST** /wallet/sub_account_to_sub_account | Sub-account transfers to sub-account
+[**sub_account_to_sub_account**](WalletApi.md#sub_account_to_sub_account) | **POST** /wallet/sub_account_to_sub_account | Transfer between sub-accounts
[**get_transfer_order_status**](WalletApi.md#get_transfer_order_status) | **GET** /wallet/order_status | Transfer status query
-[**list_withdraw_status**](WalletApi.md#list_withdraw_status) | **GET** /wallet/withdraw_status | Retrieve withdrawal status
-[**list_sub_account_balances**](WalletApi.md#list_sub_account_balances) | **GET** /wallet/sub_account_balances | Retrieve sub account balances
-[**list_sub_account_margin_balances**](WalletApi.md#list_sub_account_margin_balances) | **GET** /wallet/sub_account_margin_balances | Query sub accounts' margin balances
-[**list_sub_account_futures_balances**](WalletApi.md#list_sub_account_futures_balances) | **GET** /wallet/sub_account_futures_balances | Query sub accounts' futures account balances
-[**list_sub_account_cross_margin_balances**](WalletApi.md#list_sub_account_cross_margin_balances) | **GET** /wallet/sub_account_cross_margin_balances | Query subaccount's cross_margin account info
-[**list_saved_address**](WalletApi.md#list_saved_address) | **GET** /wallet/saved_address | Query saved address
-[**get_trade_fee**](WalletApi.md#get_trade_fee) | **GET** /wallet/fee | Retrieve personal trading fee
-[**get_total_balance**](WalletApi.md#get_total_balance) | **GET** /wallet/total_balance | Retrieve user's total balances
-[**list_small_balance**](WalletApi.md#list_small_balance) | **GET** /wallet/small_balance | List small balance
-[**convert_small_balance**](WalletApi.md#convert_small_balance) | **POST** /wallet/small_balance | Convert small balance
-[**list_small_balance_history**](WalletApi.md#list_small_balance_history) | **GET** /wallet/small_balance_history | List small balance history
-[**list_push_orders**](WalletApi.md#list_push_orders) | **GET** /wallet/push | Retrieve the UID transfer history
+[**list_withdraw_status**](WalletApi.md#list_withdraw_status) | **GET** /wallet/withdraw_status | Query withdrawal status
+[**list_sub_account_balances**](WalletApi.md#list_sub_account_balances) | **GET** /wallet/sub_account_balances | Query sub-account balance information
+[**list_sub_account_margin_balances**](WalletApi.md#list_sub_account_margin_balances) | **GET** /wallet/sub_account_margin_balances | Query sub-account isolated margin account balance information
+[**list_sub_account_futures_balances**](WalletApi.md#list_sub_account_futures_balances) | **GET** /wallet/sub_account_futures_balances | Query sub-account perpetual futures account balance information
+[**list_sub_account_cross_margin_balances**](WalletApi.md#list_sub_account_cross_margin_balances) | **GET** /wallet/sub_account_cross_margin_balances | Query sub-account cross margin account balance information
+[**list_saved_address**](WalletApi.md#list_saved_address) | **GET** /wallet/saved_address | Query withdrawal address whitelist
+[**get_trade_fee**](WalletApi.md#get_trade_fee) | **GET** /wallet/fee | Query personal trading fees
+[**get_total_balance**](WalletApi.md#get_total_balance) | **GET** /wallet/total_balance | Query personal account totals
+[**list_small_balance**](WalletApi.md#list_small_balance) | **GET** /wallet/small_balance | Get list of convertible small balance currencies
+[**convert_small_balance**](WalletApi.md#convert_small_balance) | **POST** /wallet/small_balance | Convert small balance currency
+[**list_small_balance_history**](WalletApi.md#list_small_balance_history) | **GET** /wallet/small_balance_history | Get convertible small balance currency history
+[**list_push_orders**](WalletApi.md#list_push_orders) | **GET** /wallet/push | Get UID transfer history
# **list_currency_chains**
> list[CurrencyChain] list_currency_chains(currency)
-List chains supported for specified currency
+Query chains supported for specified currency
### Example
@@ -50,7 +50,7 @@ api_instance = gate_api.WalletApi(api_client)
currency = 'GT' # str | Currency name
try:
- # List chains supported for specified currency
+ # Query chains supported for specified currency
api_response = api_instance.list_currency_chains(currency)
print(api_response)
except GateApiException as ex:
@@ -81,7 +81,7 @@ No authorization required
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
@@ -153,11 +153,11 @@ Name | Type | Description | Notes
[[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)
# **list_withdrawals**
-> list[WithdrawalRecord] list_withdrawals(currency=currency, _from=_from, to=to, limit=limit, offset=offset)
+> list[WithdrawalRecord] list_withdrawals(currency=currency, withdraw_id=withdraw_id, asset_class=asset_class, withdraw_order_id=withdraw_order_id, _from=_from, to=to, limit=limit, offset=offset)
-Retrieve withdrawal records
+Get withdrawal records
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -183,15 +183,18 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency = 'BTC' # str | Filter by currency. Return all currency records if not specified (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+currency = 'BTC' # str | Specify the currency. If not specified, returns all currencies (optional)
+withdraw_id = 'withdraw_id_example' # str | Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled (optional)
+asset_class = 'asset_class_example' # str | Currency type of withdrawal record, empty by default. Supports querying withdrawal records in main zone and innovation zone on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone (optional)
+withdraw_order_id = 'withdraw_order_id_example' # str | User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried (optional)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Retrieve withdrawal records
- api_response = api_instance.list_withdrawals(currency=currency, _from=_from, to=to, limit=limit, offset=offset)
+ # Get withdrawal records
+ api_response = api_instance.list_withdrawals(currency=currency, withdraw_id=withdraw_id, asset_class=asset_class, withdraw_order_id=withdraw_order_id, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -203,10 +206,13 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Filter by currency. Return all currency records if not specified | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **currency** | **str**| Specify the currency. If not specified, returns all currencies | [optional]
+ **withdraw_id** | **str**| Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled | [optional]
+ **asset_class** | **str**| Currency type of withdrawal record, empty by default. Supports querying withdrawal records in main zone and innovation zone on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone | [optional]
+ **withdraw_order_id** | **str**| User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
@@ -225,16 +231,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_deposits**
-> list[LedgerRecord] list_deposits(currency=currency, _from=_from, to=to, limit=limit, offset=offset)
+> list[DepositRecord] list_deposits(currency=currency, _from=_from, to=to, limit=limit, offset=offset)
-Retrieve deposit records
+Get deposit records
-Record time range cannot exceed 30 days
+Record query time range cannot exceed 30 days
### Example
@@ -260,14 +266,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency = 'BTC' # str | Filter by currency. Return all currency records if not specified (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | The maximum number of entries returned in the list is limited to 500 transactions. (optional) (default to 100)
+currency = 'BTC' # str | Specify the currency. If not specified, returns all currencies (optional)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of entries returned in the list, limited to 500 transactions (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Retrieve deposit records
+ # Get deposit records
api_response = api_instance.list_deposits(currency=currency, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -280,15 +286,15 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Filter by currency. Return all currency records if not specified | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| The maximum number of entries returned in the list is limited to 500 transactions. | [optional] [default to 100]
+ **currency** | **str**| Specify the currency. If not specified, returns all currencies | [optional]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of entries returned in the list, limited to 500 transactions | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
-[**list[LedgerRecord]**](LedgerRecord.md)
+[**list[DepositRecord]**](DepositRecord.md)
### Authorization
@@ -302,7 +308,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -311,7 +317,7 @@ Name | Type | Description | Notes
Transfer between trading accounts
-Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options
+Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account
### Example
@@ -371,16 +377,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Balance transferred | - |
+**200** | Transfer operation successful | - |
[[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)
# **list_sub_account_transfers**
-> list[SubAccountTransfer] list_sub_account_transfers(sub_uid=sub_uid, _from=_from, to=to, limit=limit, offset=offset)
+> list[SubAccountTransferRecordItem] list_sub_account_transfers(sub_uid=sub_uid, _from=_from, to=to, limit=limit, offset=offset)
-Retrieve transfer records between main and sub accounts
+Get transfer records between main and sub accounts
-Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved
+Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved
### Example
@@ -406,14 +412,14 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-sub_uid = '10003' # str | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts (optional)
-_from = 1602120000 # int | Time range beginning, default to 7 days before current time (optional)
-to = 1602123600 # int | Time range ending, default to current time (optional)
-limit = 100 # int | Maximum number of records to be returned in a single list (optional) (default to 100)
+sub_uid = '10003' # str | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional)
+_from = 1602120000 # int | Start time for querying records, defaults to 7 days before current time if not specified (optional)
+to = 1602123600 # int | End timestamp for the query, defaults to current time if not specified (optional)
+limit = 100 # int | Maximum number of records returned in a single list (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
try:
- # Retrieve transfer records between main and sub accounts
+ # Get transfer records between main and sub accounts
api_response = api_instance.list_sub_account_transfers(sub_uid=sub_uid, _from=_from, to=to, limit=limit, offset=offset)
print(api_response)
except GateApiException as ex:
@@ -426,15 +432,15 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **sub_uid** | **str**| User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts | [optional]
- **_from** | **int**| Time range beginning, default to 7 days before current time | [optional]
- **to** | **int**| Time range ending, default to current time | [optional]
- **limit** | **int**| Maximum number of records to be returned in a single list | [optional] [default to 100]
+ **sub_uid** | **str**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional]
+ **_from** | **int**| Start time for querying records, defaults to 7 days before current time if not specified | [optional]
+ **to** | **int**| End timestamp for the query, defaults to current time if not specified | [optional]
+ **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
### Return type
-[**list[SubAccountTransfer]**](SubAccountTransfer.md)
+[**list[SubAccountTransferRecordItem]**](SubAccountTransferRecordItem.md)
### Authorization
@@ -448,7 +454,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
@@ -457,7 +463,7 @@ Name | Type | Description | Notes
Transfer between main and sub accounts
-Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated.
+Supports transfers to/from sub-account's spot or futures accounts. Note that regardless of which sub-account is operated, only the main account's spot account is used
### Example
@@ -517,16 +523,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Balance transferred | - |
+**200** | Transfer operation successful | - |
[[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)
# **sub_account_to_sub_account**
> TransactionID sub_account_to_sub_account(sub_account_to_sub_account)
-Sub-account transfers to sub-account
+Transfer between sub-accounts
-It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer.
+Supports balance transfers between two sub-accounts under the same main account. You can use either the main account's API Key or the source sub-account's API Key to perform the operation
### Example
@@ -555,7 +561,7 @@ api_instance = gate_api.WalletApi(api_client)
sub_account_to_sub_account = gate_api.SubAccountToSubAccount() # SubAccountToSubAccount |
try:
- # Sub-account transfers to sub-account
+ # Transfer between sub-accounts
api_response = api_instance.sub_account_to_sub_account(sub_account_to_sub_account)
print(api_response)
except GateApiException as ex:
@@ -586,16 +592,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Balance transferred | - |
+**200** | Transfer operation successful | - |
[[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)
# **get_transfer_order_status**
-> InlineResponse200 get_transfer_order_status(client_order_id=client_order_id, tx_id=tx_id)
+> TransferOrderStatus get_transfer_order_status(client_order_id=client_order_id, tx_id=tx_id)
Transfer status query
-Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface
+Supports querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface
### Example
@@ -621,8 +627,8 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-client_order_id = 'da3ce7a088c8b0372b741419c7829033' # str | The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters. (optional)
-tx_id = '59636381286' # str | The transfer operation number and client_order_id cannot be empty at the same time (optional)
+client_order_id = 'da3ce7a088c8b0372b741419c7829033' # str | Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters (optional)
+tx_id = '59636381286' # str | Transfer operation number, cannot be empty at the same time as client_order_id (optional)
try:
# Transfer status query
@@ -638,12 +644,12 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **client_order_id** | **str**| The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters. | [optional]
- **tx_id** | **str**| The transfer operation number and client_order_id cannot be empty at the same time | [optional]
+ **client_order_id** | **str**| Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters | [optional]
+ **tx_id** | **str**| Transfer operation number, cannot be empty at the same time as client_order_id | [optional]
### Return type
-[**InlineResponse200**](InlineResponse200.md)
+[**TransferOrderStatus**](TransferOrderStatus.md)
### Authorization
@@ -657,14 +663,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Transfer status obtained successfully | - |
+**200** | Transfer status retrieved successfully | - |
[[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)
# **list_withdraw_status**
> list[WithdrawStatus] list_withdraw_status(currency=currency)
-Retrieve withdrawal status
+Query withdrawal status
### Example
@@ -690,10 +696,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency = 'BTC' # str | Retrieve data of the specified currency (optional)
+currency = 'BTC' # str | Query by specified currency name (optional)
try:
- # Retrieve withdrawal status
+ # Query withdrawal status
api_response = api_instance.list_withdraw_status(currency=currency)
print(api_response)
except GateApiException as ex:
@@ -706,7 +712,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Retrieve data of the specified currency | [optional]
+ **currency** | **str**| Query by specified currency name | [optional]
### Return type
@@ -724,14 +730,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_sub_account_balances**
> list[SubAccountBalance] list_sub_account_balances(sub_uid=sub_uid)
-Retrieve sub account balances
+Query sub-account balance information
### Example
@@ -757,10 +763,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-sub_uid = '10003' # str | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts (optional)
+sub_uid = '10003' # str | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional)
try:
- # Retrieve sub account balances
+ # Query sub-account balance information
api_response = api_instance.list_sub_account_balances(sub_uid=sub_uid)
print(api_response)
except GateApiException as ex:
@@ -773,7 +779,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **sub_uid** | **str**| User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts | [optional]
+ **sub_uid** | **str**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional]
### Return type
@@ -791,14 +797,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_sub_account_margin_balances**
> list[SubAccountMarginBalance] list_sub_account_margin_balances(sub_uid=sub_uid)
-Query sub accounts' margin balances
+Query sub-account isolated margin account balance information
### Example
@@ -824,10 +830,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-sub_uid = '10003' # str | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts (optional)
+sub_uid = '10003' # str | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional)
try:
- # Query sub accounts' margin balances
+ # Query sub-account isolated margin account balance information
api_response = api_instance.list_sub_account_margin_balances(sub_uid=sub_uid)
print(api_response)
except GateApiException as ex:
@@ -840,7 +846,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **sub_uid** | **str**| User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts | [optional]
+ **sub_uid** | **str**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional]
### Return type
@@ -858,14 +864,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_sub_account_futures_balances**
> list[SubAccountFuturesBalance] list_sub_account_futures_balances(sub_uid=sub_uid, settle=settle)
-Query sub accounts' futures account balances
+Query sub-account perpetual futures account balance information
### Example
@@ -891,11 +897,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-sub_uid = '10003' # str | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts (optional)
-settle = 'usdt' # str | Query only balances of specified settle currency (optional)
+sub_uid = '10003' # str | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional)
+settle = 'usdt' # str | Query balance of specified settlement currency (optional)
try:
- # Query sub accounts' futures account balances
+ # Query sub-account perpetual futures account balance information
api_response = api_instance.list_sub_account_futures_balances(sub_uid=sub_uid, settle=settle)
print(api_response)
except GateApiException as ex:
@@ -908,8 +914,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **sub_uid** | **str**| User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts | [optional]
- **settle** | **str**| Query only balances of specified settle currency | [optional]
+ **sub_uid** | **str**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional]
+ **settle** | **str**| Query balance of specified settlement currency | [optional]
### Return type
@@ -927,14 +933,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_sub_account_cross_margin_balances**
> list[SubAccountCrossMarginBalance] list_sub_account_cross_margin_balances(sub_uid=sub_uid)
-Query subaccount's cross_margin account info
+Query sub-account cross margin account balance information
### Example
@@ -960,10 +966,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-sub_uid = '10003' # str | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts (optional)
+sub_uid = '10003' # str | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional)
try:
- # Query subaccount's cross_margin account info
+ # Query sub-account cross margin account balance information
api_response = api_instance.list_sub_account_cross_margin_balances(sub_uid=sub_uid)
print(api_response)
except GateApiException as ex:
@@ -976,7 +982,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **sub_uid** | **str**| User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts | [optional]
+ **sub_uid** | **str**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional]
### Return type
@@ -994,14 +1000,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **list_saved_address**
> list[SavedAddress] list_saved_address(currency, chain=chain, limit=limit, page=page)
-Query saved address
+Query withdrawal address whitelist
### Example
@@ -1029,11 +1035,11 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.WalletApi(api_client)
currency = 'USDT' # str | Currency
chain = '' # str | Chain name (optional) (default to '')
-limit = '50' # str | Maximum number returned, 100 at most (optional) (default to '50')
+limit = '50' # str | Maximum number returned, up to 100 (optional) (default to '50')
page = 1 # int | Page number (optional) (default to 1)
try:
- # Query saved address
+ # Query withdrawal address whitelist
api_response = api_instance.list_saved_address(currency, chain=chain, limit=limit, page=page)
print(api_response)
except GateApiException as ex:
@@ -1048,7 +1054,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **str**| Currency |
**chain** | **str**| Chain name | [optional] [default to '']
- **limit** | **str**| Maximum number returned, 100 at most | [optional] [default to '50']
+ **limit** | **str**| Maximum number returned, up to 100 | [optional] [default to '50']
**page** | **int**| Page number | [optional] [default to 1]
### Return type
@@ -1067,14 +1073,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | List retrieved | - |
+**200** | List retrieved successfully | - |
[[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)
# **get_trade_fee**
> TradeFee get_trade_fee(currency_pair=currency_pair, settle=settle)
-Retrieve personal trading fee
+Query personal trading fees
### Example
@@ -1100,11 +1106,11 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency_pair = 'BTC_USDT' # str | Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs (optional)
-settle = 'BTC' # str | Specify the settlement currency of the contract to get more accurate rate settings This field is optional. Generally, the rate settings for all settlement currencies are the same. (optional)
+currency_pair = 'BTC_USDT' # str | Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. (optional)
+settle = 'BTC' # str | Specify the settlement currency of the contract to get more accurate fee settings. This field is optional. Generally, the fee settings for all settlement currencies are the same. (optional)
try:
- # Retrieve personal trading fee
+ # Query personal trading fees
api_response = api_instance.get_trade_fee(currency_pair=currency_pair, settle=settle)
print(api_response)
except GateApiException as ex:
@@ -1117,8 +1123,8 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency_pair** | **str**| Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs | [optional]
- **settle** | **str**| Specify the settlement currency of the contract to get more accurate rate settings This field is optional. Generally, the rate settings for all settlement currencies are the same. | [optional]
+ **currency_pair** | **str**| Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. | [optional]
+ **settle** | **str**| Specify the settlement currency of the contract to get more accurate fee settings. This field is optional. Generally, the fee settings for all settlement currencies are the same. | [optional]
### Return type
@@ -1136,16 +1142,16 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Successfully retrieved | - |
+**200** | Query successful | - |
[[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)
# **get_total_balance**
> TotalBalance get_total_balance(currency=currency)
-Retrieve user's total balances
+Query personal account totals
-This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance
+This query endpoint returns the total *estimated value* of all currencies in each account converted to the input currency. Exchange rates and related account balance information may be cached for up to 1 minute. It is not recommended to use this interface data for real-time calculations. For real-time calculations, query the corresponding balance interface based on account type, such as: - `GET /spot/accounts` to query spot account - `GET /margin/accounts` to query margin account - `GET /futures/{settle}/accounts` to query futures account
### Example
@@ -1171,10 +1177,10 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency = 'USDT' # str | Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default. (optional) (default to 'USDT')
+currency = 'USDT' # str | Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value (optional) (default to 'USDT')
try:
- # Retrieve user's total balances
+ # Query personal account totals
api_response = api_instance.get_total_balance(currency=currency)
print(api_response)
except GateApiException as ex:
@@ -1187,7 +1193,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default. | [optional] [default to 'USDT']
+ **currency** | **str**| Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value | [optional] [default to 'USDT']
### Return type
@@ -1205,14 +1211,14 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Request is valid and is successfully responded | - |
+**200** | Request is valid and successfully returned | - |
[[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)
# **list_small_balance**
> list[SmallBalance] list_small_balance()
-List small balance
+Get list of convertible small balance currencies
### Example
@@ -1240,7 +1246,7 @@ api_client = gate_api.ApiClient(configuration)
api_instance = gate_api.WalletApi(api_client)
try:
- # List small balance
+ # Get list of convertible small balance currencies
api_response = api_instance.list_small_balance()
print(api_response)
except GateApiException as ex:
@@ -1275,7 +1281,7 @@ This endpoint does not need any parameter.
# **convert_small_balance**
> convert_small_balance(convert_small_balance)
-Convert small balance
+Convert small balance currency
### Example
@@ -1304,7 +1310,7 @@ api_instance = gate_api.WalletApi(api_client)
convert_small_balance = gate_api.ConvertSmallBalance() # ConvertSmallBalance |
try:
- # Convert small balance
+ # Convert small balance currency
api_instance.convert_small_balance(convert_small_balance)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -1341,7 +1347,7 @@ void (empty response body)
# **list_small_balance_history**
> list[SmallBalanceHistory] list_small_balance_history(currency=currency, page=page, limit=limit)
-List small balance history
+Get convertible small balance currency history
### Example
@@ -1367,12 +1373,12 @@ configuration = gate_api.Configuration(
api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
-currency = 'currency_example' # str | Currency (optional)
+currency = 'currency_example' # str | Currency to convert (optional)
page = 1 # int | Page number (optional) (default to 1)
-limit = 100 # int | Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional) (default to 100)
+limit = 100 # int | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional) (default to 100)
try:
- # List small balance history
+ # Get convertible small balance currency history
api_response = api_instance.list_small_balance_history(currency=currency, page=page, limit=limit)
print(api_response)
except GateApiException as ex:
@@ -1385,9 +1391,9 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **currency** | **str**| Currency | [optional]
+ **currency** | **str**| Currency to convert | [optional]
**page** | **int**| Page number | [optional] [default to 1]
- **limit** | **int**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100]
+ **limit** | **int**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100]
### Return type
@@ -1410,9 +1416,9 @@ Name | Type | Description | Notes
[[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)
# **list_push_orders**
-> list[UidPushOrder] list_push_orders(id=id, _from=_from, to=to, limit=limit, offset=offset)
+> list[UidPushOrder] list_push_orders(id=id, _from=_from, to=to, limit=limit, offset=offset, transaction_type=transaction_type)
-Retrieve the UID transfer history
+Get UID transfer history
### Example
@@ -1439,14 +1445,15 @@ api_client = gate_api.ApiClient(configuration)
# Create an instance of the API class
api_instance = gate_api.WalletApi(api_client)
id = 56 # int | Order ID (optional)
-_from = 56 # int | The start time of the query record. If not specified, it defaults to 7 days forward from the current time, in seconds Unix timestamp (optional)
-to = 56 # int | The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds. (optional)
-limit = 100 # int | The maximum number of items returned in the list, the default value is 100 (optional) (default to 100)
+_from = 56 # int | Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds (optional)
+to = 56 # int | End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds (optional)
+limit = 100 # int | Maximum number of items returned in the list, default value is 100 (optional) (default to 100)
offset = 0 # int | List offset, starting from 0 (optional) (default to 0)
+transaction_type = 'withdraw' # str | Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. (optional) (default to 'withdraw')
try:
- # Retrieve the UID transfer history
- api_response = api_instance.list_push_orders(id=id, _from=_from, to=to, limit=limit, offset=offset)
+ # Get UID transfer history
+ api_response = api_instance.list_push_orders(id=id, _from=_from, to=to, limit=limit, offset=offset, transaction_type=transaction_type)
print(api_response)
except GateApiException as ex:
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
@@ -1459,10 +1466,11 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| Order ID | [optional]
- **_from** | **int**| The start time of the query record. If not specified, it defaults to 7 days forward from the current time, in seconds Unix timestamp | [optional]
- **to** | **int**| The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds. | [optional]
- **limit** | **int**| The maximum number of items returned in the list, the default value is 100 | [optional] [default to 100]
+ **_from** | **int**| Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds | [optional]
+ **to** | **int**| End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds | [optional]
+ **limit** | **int**| Maximum number of items returned in the list, default value is 100 | [optional] [default to 100]
**offset** | **int**| List offset, starting from 0 | [optional] [default to 0]
+ **transaction_type** | **str**| Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. | [optional] [default to 'withdraw']
### Return type
diff --git a/docs/WithdrawStatus.md b/docs/WithdrawStatus.md
index 2b8e5de..38ade7b 100644
--- a/docs/WithdrawStatus.md
+++ b/docs/WithdrawStatus.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
**currency** | **str** | Currency | [optional]
**name** | **str** | Currency name | [optional]
**name_cn** | **str** | Currency Chinese name | [optional]
-**deposit** | **str** | Deposits fee | [optional]
+**deposit** | **str** | Deposit fee | [optional]
**withdraw_percent** | **str** | Withdrawal fee rate percentage | [optional]
**withdraw_fix** | **str** | Fixed withdrawal fee | [optional]
**withdraw_day_limit** | **str** | Daily allowed withdrawal amount | [optional]
diff --git a/docs/WithdrawalApi.md b/docs/WithdrawalApi.md
index 7a118ce..1c49178 100644
--- a/docs/WithdrawalApi.md
+++ b/docs/WithdrawalApi.md
@@ -14,7 +14,7 @@ Method | HTTP request | Description
Withdraw
-Withdrawals to Gate addresses do not incur transaction fees.
+If the recipient's on-chain address is also Gate, no transaction fee will be charged
### Example
@@ -74,7 +74,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | Withdraw request is accepted. Refer to withdrawal records for status | - |
+**200** | Withdrawal request accepted. Check withdrawal record status for processing result | - |
[[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)
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
UID transfer
-Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts
+Transfers between main spot accounts. Both parties cannot be sub-accounts
### Example
@@ -143,7 +143,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | The request has been accepted. Check the withdrawal record status for the processing result. | - |
+**200** | Request accepted. Check withdrawal record status for processing result | - |
[[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)
@@ -210,7 +210,7 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**202** | Cancellation accepted. Refer to record status for the cancellation result | - |
+**202** | Cancellation request accepted. Check record status for cancellation result | - |
[[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)
diff --git a/docs/WithdrawalRecord.md b/docs/WithdrawalRecord.md
index 3dca598..9cb30af 100644
--- a/docs/WithdrawalRecord.md
+++ b/docs/WithdrawalRecord.md
@@ -5,15 +5,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Record ID | [optional] [readonly]
**txid** | **str** | Hash record of the withdrawal | [optional] [readonly]
-**block_number** | **str** | 区块编号 | [optional] [readonly]
+**block_number** | **str** | Block Number | [optional] [readonly]
**withdraw_order_id** | **str** | Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional]
**timestamp** | **str** | Operation time | [optional] [readonly]
-**amount** | **str** | Currency amount |
+**amount** | **str** | Token amount |
**fee** | **str** | fee | [optional] [readonly]
**currency** | **str** | Currency name |
-**address** | **str** | Withdrawal address. Required for withdrawals | [optional]
+**address** | **str** | Withdrawal address | [optional]
+**fail_reason** | **str** | Reason for withdrawal failure. Has a value when status = CANCEL, empty for all other statuses | [optional]
+**timestamp2** | **str** | Withdrawal final time, i.e.: withdrawal cancellation time or withdrawal success time When status = CANCEL, corresponds to cancellation time When status = DONE and block_number > 0, it is the withdrawal success time | [optional]
**memo** | **str** | Additional remarks with regards to the withdrawal | [optional]
-**status** | **str** | 交易状态 - DONE: 完成 (block_number > 0 才算真的上链完成) - CANCEL: 已取消 - REQUEST: 请求中 - MANUAL: 待人工审核 - BCODE: 充值码操作 - EXTPEND: 已经发送等待确认 - FAIL: 链上失败等待确认 - INVALID: 无效订单 - VERIFY: 验证中 - PROCES: 处理中 - PEND: 处理中 - DMOVE: 待人工审核 - SPLITPEND: cny提现大于5w,自动分单 | [optional] [readonly]
+**status** | **str** | Transaction status - DONE: Completed (block_number > 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 - REVIEW: Under review | [optional] [readonly]
**chain** | **str** | Name of the chain used in withdrawals |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/gate_api/__init__.py b/gate_api/__init__.py
index e5eb129..060b069 100644
--- a/gate_api/__init__.py
+++ b/gate_api/__init__.py
@@ -3,18 +3,18 @@
# flake8: noqa
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
from __future__ import absolute_import
-__version__ = "4.88.0"
+__version__ = "7.1.8"
# import apis into sdk package
from gate_api.api.earn_uni_api import EarnUniApi
@@ -60,6 +60,7 @@
from gate_api.models.borrow_currency_info import BorrowCurrencyInfo
from gate_api.models.broker_commission import BrokerCommission
from gate_api.models.broker_commission1 import BrokerCommission1
+from gate_api.models.broker_commission_sub_broker_info import BrokerCommissionSubBrokerInfo
from gate_api.models.broker_transaction import BrokerTransaction
from gate_api.models.broker_transaction1 import BrokerTransaction1
from gate_api.models.cancel_batch_order import CancelBatchOrder
@@ -86,34 +87,31 @@
from gate_api.models.create_multi_collateral_order import CreateMultiCollateralOrder
from gate_api.models.create_uni_lend import CreateUniLend
from gate_api.models.create_uni_loan import CreateUniLoan
-from gate_api.models.cross_margin_account import CrossMarginAccount
-from gate_api.models.cross_margin_account_book import CrossMarginAccountBook
from gate_api.models.cross_margin_balance import CrossMarginBalance
-from gate_api.models.cross_margin_balance1 import CrossMarginBalance1
-from gate_api.models.cross_margin_currency import CrossMarginCurrency
from gate_api.models.cross_margin_loan import CrossMarginLoan
-from gate_api.models.cross_margin_repay_request import CrossMarginRepayRequest
from gate_api.models.cross_margin_repayment import CrossMarginRepayment
-from gate_api.models.cross_margin_transferable import CrossMarginTransferable
from gate_api.models.currency import Currency
from gate_api.models.currency_chain import CurrencyChain
from gate_api.models.currency_pair import CurrencyPair
from gate_api.models.currency_quota import CurrencyQuota
+from gate_api.models.debit_fee import DebitFee
from gate_api.models.delivery_candlestick import DeliveryCandlestick
from gate_api.models.delivery_contract import DeliveryContract
from gate_api.models.delivery_settlement import DeliverySettlement
+from gate_api.models.delivery_ticker import DeliveryTicker
from gate_api.models.deposit_address import DepositAddress
+from gate_api.models.deposit_record import DepositRecord
from gate_api.models.dual_get_orders import DualGetOrders
from gate_api.models.dual_get_plans import DualGetPlans
+from gate_api.models.eth2_rate_list import Eth2RateList
from gate_api.models.eth2_swap import Eth2Swap
-from gate_api.models.flash_swap_currency import FlashSwapCurrency
+from gate_api.models.find_coin import FindCoin
from gate_api.models.flash_swap_currency_pair import FlashSwapCurrencyPair
from gate_api.models.flash_swap_order import FlashSwapOrder
from gate_api.models.flash_swap_order_preview import FlashSwapOrderPreview
from gate_api.models.flash_swap_order_request import FlashSwapOrderRequest
from gate_api.models.flash_swap_preview_request import FlashSwapPreviewRequest
from gate_api.models.funding_account import FundingAccount
-from gate_api.models.funding_book_item import FundingBookItem
from gate_api.models.funding_rate_record import FundingRateRecord
from gate_api.models.future_cancel_order_result import FutureCancelOrderResult
from gate_api.models.futures_account import FuturesAccount
@@ -132,9 +130,11 @@
from gate_api.models.futures_order_amendment import FuturesOrderAmendment
from gate_api.models.futures_order_book import FuturesOrderBook
from gate_api.models.futures_order_book_item import FuturesOrderBookItem
+from gate_api.models.futures_position_cross_mode import FuturesPositionCrossMode
from gate_api.models.futures_premium_index import FuturesPremiumIndex
from gate_api.models.futures_price_trigger import FuturesPriceTrigger
from gate_api.models.futures_price_triggered_order import FuturesPriceTriggeredOrder
+from gate_api.models.futures_risk_limit_tier import FuturesRiskLimitTier
from gate_api.models.futures_ticker import FuturesTicker
from gate_api.models.futures_trade import FuturesTrade
from gate_api.models.index_constituent import IndexConstituent
@@ -144,14 +144,11 @@
from gate_api.models.insurance_record import InsuranceRecord
from gate_api.models.ledger_record import LedgerRecord
from gate_api.models.liquidate_order import LiquidateOrder
-from gate_api.models.loan import Loan
-from gate_api.models.loan_patch import LoanPatch
-from gate_api.models.loan_record import LoanRecord
from gate_api.models.margin_account import MarginAccount
from gate_api.models.margin_account_book import MarginAccountBook
from gate_api.models.margin_account_currency import MarginAccountCurrency
-from gate_api.models.margin_borrowable import MarginBorrowable
-from gate_api.models.margin_currency_pair import MarginCurrencyPair
+from gate_api.models.margin_leverage_tier import MarginLeverageTier
+from gate_api.models.margin_market_leverage import MarginMarketLeverage
from gate_api.models.margin_tiers import MarginTiers
from gate_api.models.margin_transferable import MarginTransferable
from gate_api.models.max_uni_borrowable import MaxUniBorrowable
@@ -216,15 +213,14 @@
from gate_api.models.repay_record_left_interest import RepayRecordLeftInterest
from gate_api.models.repay_record_repaid_currency import RepayRecordRepaidCurrency
from gate_api.models.repay_record_total_interest import RepayRecordTotalInterest
-from gate_api.models.repay_request import RepayRequest
from gate_api.models.repay_resp import RepayResp
-from gate_api.models.repayment import Repayment
from gate_api.models.risk_units import RiskUnits
from gate_api.models.saved_address import SavedAddress
from gate_api.models.small_balance import SmallBalance
from gate_api.models.small_balance_history import SmallBalanceHistory
from gate_api.models.spot_account import SpotAccount
from gate_api.models.spot_account_book import SpotAccountBook
+from gate_api.models.spot_currency_chain import SpotCurrencyChain
from gate_api.models.spot_fee import SpotFee
from gate_api.models.spot_insurance_history import SpotInsuranceHistory
from gate_api.models.spot_price_put_order import SpotPricePutOrder
@@ -244,8 +240,11 @@
from gate_api.models.sub_account_margin_balance import SubAccountMarginBalance
from gate_api.models.sub_account_to_sub_account import SubAccountToSubAccount
from gate_api.models.sub_account_transfer import SubAccountTransfer
+from gate_api.models.sub_account_transfer_record_item import SubAccountTransferRecordItem
from gate_api.models.sub_cross_margin_account import SubCrossMarginAccount
from gate_api.models.sub_user_mode import SubUserMode
+from gate_api.models.swap_coin import SwapCoin
+from gate_api.models.swap_coin_struct import SwapCoinStruct
from gate_api.models.system_time import SystemTime
from gate_api.models.ticker import Ticker
from gate_api.models.total_balance import TotalBalance
@@ -253,6 +252,8 @@
from gate_api.models.trade_fee import TradeFee
from gate_api.models.transaction_id import TransactionID
from gate_api.models.transfer import Transfer
+from gate_api.models.transfer_order_status import TransferOrderStatus
+from gate_api.models.transferables_result import TransferablesResult
from gate_api.models.trigger_order_response import TriggerOrderResponse
from gate_api.models.trigger_time import TriggerTime
from gate_api.models.uid_push_order import UidPushOrder
@@ -261,7 +262,6 @@
from gate_api.models.uni_currency import UniCurrency
from gate_api.models.uni_currency_interest import UniCurrencyInterest
from gate_api.models.uni_currency_pair import UniCurrencyPair
-from gate_api.models.uni_interest_mode import UniInterestMode
from gate_api.models.uni_interest_record import UniInterestRecord
from gate_api.models.uni_lend import UniLend
from gate_api.models.uni_lend_interest import UniLendInterest
@@ -272,6 +272,10 @@
from gate_api.models.unified_account import UnifiedAccount
from gate_api.models.unified_balance import UnifiedBalance
from gate_api.models.unified_borrowable import UnifiedBorrowable
+from gate_api.models.unified_borrowable1 import UnifiedBorrowable1
+from gate_api.models.unified_collateral_req import UnifiedCollateralReq
+from gate_api.models.unified_collateral_res import UnifiedCollateralRes
+from gate_api.models.unified_currency import UnifiedCurrency
from gate_api.models.unified_discount import UnifiedDiscount
from gate_api.models.unified_discount_tiers import UnifiedDiscountTiers
from gate_api.models.unified_history_loan_rate import UnifiedHistoryLoanRate
@@ -280,8 +284,8 @@
from gate_api.models.unified_leverage_setting import UnifiedLeverageSetting
from gate_api.models.unified_loan import UnifiedLoan
from gate_api.models.unified_loan_record import UnifiedLoanRecord
+from gate_api.models.unified_loan_result import UnifiedLoanResult
from gate_api.models.unified_margin_tiers import UnifiedMarginTiers
-from gate_api.models.unified_mode import UnifiedMode
from gate_api.models.unified_mode_set import UnifiedModeSet
from gate_api.models.unified_portfolio_input import UnifiedPortfolioInput
from gate_api.models.unified_portfolio_output import UnifiedPortfolioOutput
@@ -289,6 +293,8 @@
from gate_api.models.unified_settings import UnifiedSettings
from gate_api.models.unified_transferable import UnifiedTransferable
from gate_api.models.user_ltv_info import UserLtvInfo
+from gate_api.models.user_sub import UserSub
+from gate_api.models.user_sub_relation import UserSubRelation
from gate_api.models.user_total_amount import UserTotalAmount
from gate_api.models.withdraw_status import WithdrawStatus
from gate_api.models.withdrawal_record import WithdrawalRecord
diff --git a/gate_api/api/account_api.py b/gate_api/api/account_api.py
index 3e4f95c..5f381d6 100644
--- a/gate_api/api/account_api.py
+++ b/gate_api/api/account_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def get_account_detail(self, **kwargs): # noqa: E501
- """Get account detail # noqa: E501
+ """Retrieve user account information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -60,7 +60,7 @@ def get_account_detail(self, **kwargs): # noqa: E501
return self.get_account_detail_with_http_info(**kwargs) # noqa: E501
def get_account_detail_with_http_info(self, **kwargs): # noqa: E501
- """Get account detail # noqa: E501
+ """Retrieve user account information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -243,16 +243,16 @@ def get_account_rate_limit_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_stp_groups(self, **kwargs): # noqa: E501
- """List STP Groups # noqa: E501
+ """Query STP user groups created by the user # noqa: E501
- Retrieve the list of STP groups created by the main account user only # noqa: E501
+ Only query STP user groups created by the current main account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_stp_groups(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str name: Perform a fuzzy search based on the name
+ :param str name: Fuzzy search by name
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -268,16 +268,16 @@ def list_stp_groups(self, **kwargs): # noqa: E501
return self.list_stp_groups_with_http_info(**kwargs) # noqa: E501
def list_stp_groups_with_http_info(self, **kwargs): # noqa: E501
- """List STP Groups # noqa: E501
+ """Query STP user groups created by the user # noqa: E501
- Retrieve the list of STP groups created by the main account user only # noqa: E501
+ Only query STP user groups created by the current main account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_stp_groups_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str name: Perform a fuzzy search based on the name
+ :param str name: Fuzzy search by name
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -353,7 +353,7 @@ def list_stp_groups_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_stp_group(self, stp_group, **kwargs): # noqa: E501
- """Create STP Group # noqa: E501
+ """Create STP user group # noqa: E501
Only the main account is allowed to create a new STP user group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -378,7 +378,7 @@ def create_stp_group(self, stp_group, **kwargs): # noqa: E501
return self.create_stp_group_with_http_info(stp_group, **kwargs) # noqa: E501
def create_stp_group_with_http_info(self, stp_group, **kwargs): # noqa: E501
- """Create STP Group # noqa: E501
+ """Create STP user group # noqa: E501
Only the main account is allowed to create a new STP user group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -471,9 +471,9 @@ def create_stp_group_with_http_info(self, stp_group, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_stp_groups_users(self, stp_id, **kwargs): # noqa: E501
- """List users of the STP group # noqa: E501
+ """Query users in the STP user group # noqa: E501
- Only the main account that created this STP group is allowed to list the user ID of the STP group # noqa: E501
+ Only the main account that created this STP group can query the account ID list in the current STP group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_stp_groups_users(stp_id, async_req=True)
@@ -496,9 +496,9 @@ def list_stp_groups_users(self, stp_id, **kwargs): # noqa: E501
return self.list_stp_groups_users_with_http_info(stp_id, **kwargs) # noqa: E501
def list_stp_groups_users_with_http_info(self, stp_id, **kwargs): # noqa: E501
- """List users of the STP group # noqa: E501
+ """Query users in the STP user group # noqa: E501
- Only the main account that created this STP group is allowed to list the user ID of the STP group # noqa: E501
+ Only the main account that created this STP group can query the account ID list in the current STP group # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_stp_groups_users_with_http_info(stp_id, async_req=True)
@@ -585,9 +585,9 @@ def list_stp_groups_users_with_http_info(self, stp_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def add_stp_group_users(self, stp_id, request_body, **kwargs): # noqa: E501
- """Add users to the STP group # noqa: E501
+ """Add users to the STP user group # noqa: E501
- - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted # noqa: E501
+ - Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_stp_group_users(stp_id, request_body, async_req=True)
@@ -611,9 +611,9 @@ def add_stp_group_users(self, stp_id, request_body, **kwargs): # noqa: E501
return self.add_stp_group_users_with_http_info(stp_id, request_body, **kwargs) # noqa: E501
def add_stp_group_users_with_http_info(self, stp_id, request_body, **kwargs): # noqa: E501
- """Add users to the STP group # noqa: E501
+ """Add users to the STP user group # noqa: E501
- - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted # noqa: E501
+ - Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_stp_group_users_with_http_info(stp_id, request_body, async_req=True)
@@ -712,7 +712,7 @@ def add_stp_group_users_with_http_info(self, stp_id, request_body, **kwargs): #
collection_formats=collection_formats)
def delete_stp_group_users(self, stp_id, user_id, **kwargs): # noqa: E501
- """Delete the user in the STP group # noqa: E501
+ """Delete users from the STP user group # noqa: E501
- 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 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -722,7 +722,7 @@ def delete_stp_group_users(self, stp_id, user_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int stp_id: STP Group ID (required)
- :param int user_id: STP user ID, multiple can be separated by commas (required)
+ :param int user_id: STP user IDs, multiple IDs can be separated by commas (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -738,7 +738,7 @@ def delete_stp_group_users(self, stp_id, user_id, **kwargs): # noqa: E501
return self.delete_stp_group_users_with_http_info(stp_id, user_id, **kwargs) # noqa: E501
def delete_stp_group_users_with_http_info(self, stp_id, user_id, **kwargs): # noqa: E501
- """Delete the user in the STP group # noqa: E501
+ """Delete users from the STP user group # noqa: E501
- 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 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -748,7 +748,7 @@ def delete_stp_group_users_with_http_info(self, stp_id, user_id, **kwargs): # n
:param bool async_req: execute request asynchronously
:param int stp_id: STP Group ID (required)
- :param int user_id: STP user ID, multiple can be separated by commas (required)
+ :param int user_id: STP user IDs, multiple IDs can be separated by commas (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -835,9 +835,9 @@ def delete_stp_group_users_with_http_info(self, stp_id, user_id, **kwargs): # n
collection_formats=collection_formats)
def get_debit_fee(self, **kwargs): # noqa: E501
- """Query GT deduction configuration. # noqa: E501
+ """Query GT fee deduction configuration # noqa: E501
- Query the current GT deduction configuration for the account. # noqa: E501
+ Query the GT fee deduction configuration for the current account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_debit_fee(async_req=True)
@@ -851,7 +851,7 @@ def get_debit_fee(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.InlineResponse2001
+ :rtype: gate_api.DebitFee
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -859,9 +859,9 @@ def get_debit_fee(self, **kwargs): # noqa: E501
return self.get_debit_fee_with_http_info(**kwargs) # noqa: E501
def get_debit_fee_with_http_info(self, **kwargs): # noqa: E501
- """Query GT deduction configuration. # noqa: E501
+ """Query GT fee deduction configuration # noqa: E501
- Query the current GT deduction configuration for the account. # noqa: E501
+ Query the GT fee deduction configuration for the current account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_debit_fee_with_http_info(async_req=True)
@@ -877,7 +877,7 @@ def get_debit_fee_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.InlineResponse2001, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(gate_api.DebitFee, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -931,7 +931,7 @@ def get_debit_fee_with_http_info(self, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='InlineResponse2001', # noqa: E501
+ response_type='DebitFee', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -939,17 +939,17 @@ def get_debit_fee_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def set_debit_fee(self, inline_object, **kwargs): # noqa: E501
- """Set GT deduction. # noqa: E501
+ def set_debit_fee(self, debit_fee, **kwargs): # noqa: E501
+ """Configure GT fee deduction # noqa: E501
- Enable or disable GT deduction for the current account. # noqa: E501
+ Enable or disable GT fee deduction for the current account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_debit_fee(inline_object, async_req=True)
+ >>> thread = api.set_debit_fee(debit_fee, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param InlineObject inline_object: (required)
+ :param DebitFee debit_fee: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -962,19 +962,19 @@ def set_debit_fee(self, inline_object, **kwargs): # noqa: E501
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.set_debit_fee_with_http_info(inline_object, **kwargs) # noqa: E501
+ return self.set_debit_fee_with_http_info(debit_fee, **kwargs) # noqa: E501
- def set_debit_fee_with_http_info(self, inline_object, **kwargs): # noqa: E501
- """Set GT deduction. # noqa: E501
+ def set_debit_fee_with_http_info(self, debit_fee, **kwargs): # noqa: E501
+ """Configure GT fee deduction # noqa: E501
- Enable or disable GT deduction for the current account. # noqa: E501
+ Enable or disable GT fee deduction for the current account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_debit_fee_with_http_info(inline_object, async_req=True)
+ >>> thread = api.set_debit_fee_with_http_info(debit_fee, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param InlineObject inline_object: (required)
+ :param DebitFee debit_fee: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -992,7 +992,7 @@ def set_debit_fee_with_http_info(self, inline_object, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
- 'inline_object'
+ 'debit_fee'
]
all_params.extend(
[
@@ -1011,10 +1011,10 @@ def set_debit_fee_with_http_info(self, inline_object, **kwargs): # noqa: E501
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'inline_object' is set
- if self.api_client.client_side_validation and ('inline_object' not in local_var_params or # noqa: E501
- local_var_params['inline_object'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `inline_object` when calling `set_debit_fee`") # noqa: E501
+ # verify the required parameter 'debit_fee' is set
+ if self.api_client.client_side_validation and ('debit_fee' not in local_var_params or # noqa: E501
+ local_var_params['debit_fee'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `debit_fee` when calling `set_debit_fee`") # noqa: E501
collection_formats = {}
@@ -1028,8 +1028,8 @@ def set_debit_fee_with_http_info(self, inline_object, **kwargs): # noqa: E501
local_var_files = {}
body_params = None
- if 'inline_object' in local_var_params:
- body_params = local_var_params['inline_object']
+ if 'debit_fee' in local_var_params:
+ body_params = local_var_params['debit_fee']
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
diff --git a/gate_api/api/collateral_loan_api.py b/gate_api/api/collateral_loan_api.py
index 861d48e..a96b375 100644
--- a/gate_api/api/collateral_loan_api.py
+++ b/gate_api/api/collateral_loan_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_collateral_loan_orders(self, **kwargs): # noqa: E501
- """List Orders # noqa: E501
+ """Query collateral loan order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -46,8 +46,8 @@ def list_collateral_loan_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str collateral_currency: Collateral
+ :param int limit: Maximum number of records returned in a single list
+ :param str collateral_currency: Collateral currency
:param str borrow_currency: Borrowed currency
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -64,7 +64,7 @@ def list_collateral_loan_orders(self, **kwargs): # noqa: E501
return self.list_collateral_loan_orders_with_http_info(**kwargs) # noqa: E501
def list_collateral_loan_orders_with_http_info(self, **kwargs): # noqa: E501
- """List Orders # noqa: E501
+ """Query collateral loan order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -73,8 +73,8 @@ def list_collateral_loan_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str collateral_currency: Collateral
+ :param int limit: Maximum number of records returned in a single list
+ :param str collateral_currency: Collateral currency
:param str borrow_currency: Borrowed currency
:param _return_http_data_only: response data without head status code
and headers
@@ -166,7 +166,7 @@ def list_collateral_loan_orders_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_collateral_loan(self, create_collateral_order, **kwargs): # noqa: E501
- """Place order # noqa: E501
+ """Place collateral loan order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -190,7 +190,7 @@ def create_collateral_loan(self, create_collateral_order, **kwargs): # noqa: E5
return self.create_collateral_loan_with_http_info(create_collateral_order, **kwargs) # noqa: E501
def create_collateral_loan_with_http_info(self, create_collateral_order, **kwargs): # noqa: E501
- """Place order # noqa: E501
+ """Place collateral loan order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -282,7 +282,7 @@ def create_collateral_loan_with_http_info(self, create_collateral_order, **kwarg
collection_formats=collection_formats)
def get_collateral_loan_order_detail(self, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -290,7 +290,7 @@ def get_collateral_loan_order_detail(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -306,7 +306,7 @@ def get_collateral_loan_order_detail(self, order_id, **kwargs): # noqa: E501
return self.get_collateral_loan_order_detail_with_http_info(order_id, **kwargs) # noqa: E501
def get_collateral_loan_order_detail_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -314,7 +314,7 @@ def get_collateral_loan_order_detail_with_http_info(self, order_id, **kwargs):
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -394,7 +394,7 @@ def get_collateral_loan_order_detail_with_http_info(self, order_id, **kwargs):
collection_formats=collection_formats)
def repay_collateral_loan(self, repay_loan, **kwargs): # noqa: E501
- """Repayment # noqa: E501
+ """Collateral loan repayment # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -418,7 +418,7 @@ def repay_collateral_loan(self, repay_loan, **kwargs): # noqa: E501
return self.repay_collateral_loan_with_http_info(repay_loan, **kwargs) # noqa: E501
def repay_collateral_loan_with_http_info(self, repay_loan, **kwargs): # noqa: E501
- """Repayment # noqa: E501
+ """Collateral loan repayment # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -510,7 +510,7 @@ def repay_collateral_loan_with_http_info(self, repay_loan, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_repay_records(self, source, **kwargs): # noqa: E501
- """Repayment history # noqa: E501
+ """Query collateral loan repayment records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -520,11 +520,11 @@ def list_repay_records(self, source, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str source: Operation type: repay - Regular repayment, liquidate - Liquidation (required)
:param str borrow_currency: Borrowed currency
- :param str collateral_currency: Collateral
+ :param str collateral_currency: Collateral currency
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -540,7 +540,7 @@ def list_repay_records(self, source, **kwargs): # noqa: E501
return self.list_repay_records_with_http_info(source, **kwargs) # noqa: E501
def list_repay_records_with_http_info(self, source, **kwargs): # noqa: E501
- """Repayment history # noqa: E501
+ """Query collateral loan repayment records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -550,11 +550,11 @@ def list_repay_records_with_http_info(self, source, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str source: Operation type: repay - Regular repayment, liquidate - Liquidation (required)
:param str borrow_currency: Borrowed currency
- :param str collateral_currency: Collateral
+ :param str collateral_currency: Collateral currency
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -667,11 +667,11 @@ def list_collateral_records(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param str borrow_currency: Borrowed currency
- :param str collateral_currency: Collateral
+ :param str collateral_currency: Collateral currency
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -696,11 +696,11 @@ def list_collateral_records_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param str borrow_currency: Borrowed currency
- :param str collateral_currency: Collateral
+ :param str collateral_currency: Collateral currency
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -909,7 +909,7 @@ def operate_collateral_with_http_info(self, collateral_align, **kwargs): # noqa
collection_formats=collection_formats)
def get_user_total_amount(self, **kwargs): # noqa: E501
- """Query the total borrowing and collateral amount for the user # noqa: E501
+ """Query user's total borrowing and collateral amount # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -932,7 +932,7 @@ def get_user_total_amount(self, **kwargs): # noqa: E501
return self.get_user_total_amount_with_http_info(**kwargs) # noqa: E501
def get_user_total_amount_with_http_info(self, **kwargs): # noqa: E501
- """Query the total borrowing and collateral amount for the user # noqa: E501
+ """Query user's total borrowing and collateral amount # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1012,7 +1012,7 @@ def get_user_total_amount_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_user_ltv_info(self, collateral_currency, borrow_currency, **kwargs): # noqa: E501
- """Query user's collateralization ratio # noqa: E501
+ """Query user's collateralization ratio and remaining borrowable currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1020,7 +1020,7 @@ def get_user_ltv_info(self, collateral_currency, borrow_currency, **kwargs): #
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str collateral_currency: Collateral (required)
+ :param str collateral_currency: Collateral currency (required)
:param str borrow_currency: Borrowed currency (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1037,7 +1037,7 @@ def get_user_ltv_info(self, collateral_currency, borrow_currency, **kwargs): #
return self.get_user_ltv_info_with_http_info(collateral_currency, borrow_currency, **kwargs) # noqa: E501
def get_user_ltv_info_with_http_info(self, collateral_currency, borrow_currency, **kwargs): # noqa: E501
- """Query user's collateralization ratio # noqa: E501
+ """Query user's collateralization ratio and remaining borrowable currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1045,7 +1045,7 @@ def get_user_ltv_info_with_http_info(self, collateral_currency, borrow_currency,
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str collateral_currency: Collateral (required)
+ :param str collateral_currency: Collateral currency (required)
:param str borrow_currency: Borrowed currency (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -1141,7 +1141,7 @@ def list_collateral_currencies(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str loan_currency: 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.
+ :param str loan_currency: Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1165,7 +1165,7 @@ def list_collateral_currencies_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str loan_currency: 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.
+ :param str loan_currency: Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/gate_api/api/delivery_api.py b/gate_api/api/delivery_api.py
index 674f2b3..4979aa5 100644
--- a/gate_api/api/delivery_api.py
+++ b/gate_api/api/delivery_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_delivery_contracts(self, settle, **kwargs): # noqa: E501
- """List all futures contracts # noqa: E501
+ """Query all futures contracts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -61,7 +61,7 @@ def list_delivery_contracts(self, settle, **kwargs): # noqa: E501
return self.list_delivery_contracts_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_contracts_with_http_info(self, settle, **kwargs): # noqa: E501
- """List all futures contracts # noqa: E501
+ """Query all futures contracts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -149,7 +149,7 @@ def list_delivery_contracts_with_http_info(self, settle, **kwargs): # noqa: E50
collection_formats=collection_formats)
def get_delivery_contract(self, settle, contract, **kwargs): # noqa: E501
- """Get a single contract # noqa: E501
+ """Query single contract information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -174,7 +174,7 @@ def get_delivery_contract(self, settle, contract, **kwargs): # noqa: E501
return self.get_delivery_contract_with_http_info(settle, contract, **kwargs) # noqa: E501
def get_delivery_contract_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get a single contract # noqa: E501
+ """Query single contract information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -270,7 +270,7 @@ def get_delivery_contract_with_http_info(self, settle, contract, **kwargs): # n
collection_formats=collection_formats)
def list_delivery_order_book(self, settle, contract, **kwargs): # noqa: E501
- """Futures order book # noqa: E501
+ """Query futures market depth information # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -281,9 +281,9 @@ def list_delivery_order_book(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -299,7 +299,7 @@ def list_delivery_order_book(self, settle, contract, **kwargs): # noqa: E501
return self.list_delivery_order_book_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_delivery_order_book_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Futures order book # noqa: E501
+ """Query futures market depth information # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -310,9 +310,9 @@ def list_delivery_order_book_with_http_info(self, settle, contract, **kwargs):
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -412,7 +412,7 @@ def list_delivery_order_book_with_http_info(self, settle, contract, **kwargs):
collection_formats=collection_formats)
def list_delivery_trades(self, settle, contract, **kwargs): # noqa: E501
- """Futures trading history # noqa: E501
+ """Futures market transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -422,10 +422,10 @@ def list_delivery_trades(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range
+ :param int limit: Maximum number of records returned in a single list
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list.This field is no longer supported. For new requests, please use the fromand tofields to specify the time rang
:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.
- :param int to: Specify end time in Unix seconds, default to current time
+ :param int to: Specify end time in Unix seconds, default to current time.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -441,7 +441,7 @@ def list_delivery_trades(self, settle, contract, **kwargs): # noqa: E501
return self.list_delivery_trades_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_delivery_trades_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Futures trading history # noqa: E501
+ """Futures market transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -451,10 +451,10 @@ def list_delivery_trades_with_http_info(self, settle, contract, **kwargs): # no
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range
+ :param int limit: Maximum number of records returned in a single list
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list.This field is no longer supported. For new requests, please use the fromand tofields to specify the time rang
:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.
- :param int to: Specify end time in Unix seconds, default to current time
+ :param int to: Specify end time in Unix seconds, default to current time.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -557,7 +557,7 @@ def list_delivery_trades_with_http_info(self, settle, contract, **kwargs): # no
collection_formats=collection_formats)
def list_delivery_candlesticks(self, settle, contract, **kwargs): # noqa: E501
- """Get futures candlesticks # noqa: E501
+ """Futures market K-line chart # noqa: E501
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -569,9 +569,9 @@ def list_delivery_candlesticks(self, settle, contract, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -587,7 +587,7 @@ def list_delivery_candlesticks(self, settle, contract, **kwargs): # noqa: E501
return self.list_delivery_candlesticks_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_delivery_candlesticks_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get futures candlesticks # noqa: E501
+ """Futures market K-line chart # noqa: E501
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -599,9 +599,9 @@ def list_delivery_candlesticks_with_http_info(self, settle, contract, **kwargs):
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -702,7 +702,7 @@ def list_delivery_candlesticks_with_http_info(self, settle, contract, **kwargs):
collection_formats=collection_formats)
def list_delivery_tickers(self, settle, **kwargs): # noqa: E501
- """List futures tickers # noqa: E501
+ """Get all futures trading statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -719,7 +719,7 @@ def list_delivery_tickers(self, settle, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.FuturesTicker]
+ :rtype: list[gate_api.DeliveryTicker]
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -727,7 +727,7 @@ def list_delivery_tickers(self, settle, **kwargs): # noqa: E501
return self.list_delivery_tickers_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
- """List futures tickers # noqa: E501
+ """Get all futures trading statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -746,7 +746,7 @@ def list_delivery_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.FuturesTicker], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.DeliveryTicker], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -810,7 +810,7 @@ def list_delivery_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[FuturesTicker]', # noqa: E501
+ response_type='list[DeliveryTicker]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -819,7 +819,7 @@ def list_delivery_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_delivery_insurance_ledger(self, settle, **kwargs): # noqa: E501
- """Futures insurance balance history # noqa: E501
+ """Futures market insurance fund history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -828,7 +828,7 @@ def list_delivery_insurance_ledger(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -844,7 +844,7 @@ def list_delivery_insurance_ledger(self, settle, **kwargs): # noqa: E501
return self.list_delivery_insurance_ledger_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_insurance_ledger_with_http_info(self, settle, **kwargs): # noqa: E501
- """Futures insurance balance history # noqa: E501
+ """Futures market insurance fund history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -853,7 +853,7 @@ def list_delivery_insurance_ledger_with_http_info(self, settle, **kwargs): # no
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -940,7 +940,7 @@ def list_delivery_insurance_ledger_with_http_info(self, settle, **kwargs): # no
collection_formats=collection_formats)
def list_delivery_accounts(self, settle, **kwargs): # noqa: E501
- """Query futures account # noqa: E501
+ """Get futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -964,7 +964,7 @@ def list_delivery_accounts(self, settle, **kwargs): # noqa: E501
return self.list_delivery_accounts_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_accounts_with_http_info(self, settle, **kwargs): # noqa: E501
- """Query futures account # noqa: E501
+ """Get futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1052,7 +1052,7 @@ def list_delivery_accounts_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_delivery_account_book(self, settle, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query futures account change history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1061,10 +1061,10 @@ def list_delivery_account_book(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1080,7 +1080,7 @@ def list_delivery_account_book(self, settle, **kwargs): # noqa: E501
return self.list_delivery_account_book_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_account_book_with_http_info(self, settle, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query futures account change history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1089,10 +1089,10 @@ def list_delivery_account_book_with_http_info(self, settle, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1188,7 +1188,7 @@ def list_delivery_account_book_with_http_info(self, settle, **kwargs): # noqa:
collection_formats=collection_formats)
def list_delivery_positions(self, settle, **kwargs): # noqa: E501
- """List all positions of a user # noqa: E501
+ """Get user position list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1212,7 +1212,7 @@ def list_delivery_positions(self, settle, **kwargs): # noqa: E501
return self.list_delivery_positions_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_positions_with_http_info(self, settle, **kwargs): # noqa: E501
- """List all positions of a user # noqa: E501
+ """Get user position list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1300,7 +1300,7 @@ def list_delivery_positions_with_http_info(self, settle, **kwargs): # noqa: E50
collection_formats=collection_formats)
def get_delivery_position(self, settle, contract, **kwargs): # noqa: E501
- """Get single position # noqa: E501
+ """Get single position information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1325,7 +1325,7 @@ def get_delivery_position(self, settle, contract, **kwargs): # noqa: E501
return self.get_delivery_position_with_http_info(settle, contract, **kwargs) # noqa: E501
def get_delivery_position_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get single position # noqa: E501
+ """Get single position information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1431,7 +1431,7 @@ def update_delivery_position_margin(self, settle, contract, change, **kwargs):
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1457,7 +1457,7 @@ def update_delivery_position_margin_with_http_info(self, settle, contract, chang
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1811,9 +1811,9 @@ def update_delivery_position_risk_limit_with_http_info(self, settle, contract, r
collection_formats=collection_formats)
def list_delivery_orders(self, settle, status, **kwargs): # noqa: E501
- """List futures orders # noqa: E501
+ """Query futures order list # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_delivery_orders(settle, status, async_req=True)
@@ -1821,12 +1821,12 @@ def list_delivery_orders(self, settle, status, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param int count_total: Whether to return total number matched. Default to 0(no return)
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param int count_total: Whether to return total number matched, defaults to 0 (no return)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1842,9 +1842,9 @@ def list_delivery_orders(self, settle, status, **kwargs): # noqa: E501
return self.list_delivery_orders_with_http_info(settle, status, **kwargs) # noqa: E501
def list_delivery_orders_with_http_info(self, settle, status, **kwargs): # noqa: E501
- """List futures orders # noqa: E501
+ """Query futures order list # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_delivery_orders_with_http_info(settle, status, async_req=True)
@@ -1852,12 +1852,12 @@ def list_delivery_orders_with_http_info(self, settle, status, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param int count_total: Whether to return total number matched. Default to 0(no return)
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param int count_total: Whether to return total number matched, defaults to 0 (no return)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1965,9 +1965,9 @@ def list_delivery_orders_with_http_info(self, settle, status, **kwargs): # noqa
collection_formats=collection_formats)
def create_delivery_order(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a futures order # noqa: E501
+ """Place futures order # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_delivery_order(settle, futures_order, async_req=True)
@@ -1991,9 +1991,9 @@ def create_delivery_order(self, settle, futures_order, **kwargs): # noqa: E501
return self.create_delivery_order_with_http_info(settle, futures_order, **kwargs) # noqa: E501
def create_delivery_order_with_http_info(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a futures order # noqa: E501
+ """Place futures order # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_delivery_order_with_http_info(settle, futures_order, async_req=True)
@@ -2092,9 +2092,9 @@ def create_delivery_order_with_http_info(self, settle, futures_order, **kwargs):
collection_formats=collection_formats)
def cancel_delivery_orders(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_delivery_orders(settle, contract, async_req=True)
@@ -2103,7 +2103,7 @@ def cancel_delivery_orders(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str side: All bids or asks. Both included if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2119,9 +2119,9 @@ def cancel_delivery_orders(self, settle, contract, **kwargs): # noqa: E501
return self.cancel_delivery_orders_with_http_info(settle, contract, **kwargs) # noqa: E501
def cancel_delivery_orders_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_delivery_orders_with_http_info(settle, contract, async_req=True)
@@ -2130,7 +2130,7 @@ def cancel_delivery_orders_with_http_info(self, settle, contract, **kwargs): #
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str side: All bids or asks. Both included if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2220,9 +2220,9 @@ def cancel_delivery_orders_with_http_info(self, settle, contract, **kwargs): #
collection_formats=collection_formats)
def get_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_order(settle, order_id, async_req=True)
@@ -2230,7 +2230,7 @@ def get_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2246,9 +2246,9 @@ def get_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
return self.get_delivery_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def get_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_delivery_order_with_http_info(settle, order_id, async_req=True)
@@ -2256,7 +2256,7 @@ def get_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2343,7 +2343,7 @@ def get_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa
collection_formats=collection_formats)
def cancel_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2352,7 +2352,7 @@ def cancel_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2368,7 +2368,7 @@ def cancel_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
return self.cancel_delivery_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def cancel_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2377,7 +2377,7 @@ def cancel_delivery_order_with_http_info(self, settle, order_id, **kwargs): # n
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2464,7 +2464,7 @@ def cancel_delivery_order_with_http_info(self, settle, order_id, **kwargs): # n
collection_formats=collection_formats)
def get_my_delivery_trades(self, settle, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2475,10 +2475,10 @@ def get_my_delivery_trades(self, settle, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract
:param int order: Futures order ID, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param int count_total: Whether to return total number matched. Default to 0(no return)
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param int count_total: Whether to return total number matched, defaults to 0 (no return)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2494,7 +2494,7 @@ def get_my_delivery_trades(self, settle, **kwargs): # noqa: E501
return self.get_my_delivery_trades_with_http_info(settle, **kwargs) # noqa: E501
def get_my_delivery_trades_with_http_info(self, settle, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2505,10 +2505,10 @@ def get_my_delivery_trades_with_http_info(self, settle, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract
:param int order: Futures order ID, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param int count_total: Whether to return total number matched. Default to 0(no return)
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param int count_total: Whether to return total number matched, defaults to 0 (no return)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2612,7 +2612,7 @@ def get_my_delivery_trades_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_delivery_position_close(self, settle, **kwargs): # noqa: E501
- """List position close history # noqa: E501
+ """Query position close history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2622,7 +2622,7 @@ def list_delivery_position_close(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2638,7 +2638,7 @@ def list_delivery_position_close(self, settle, **kwargs): # noqa: E501
return self.list_delivery_position_close_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_position_close_with_http_info(self, settle, **kwargs): # noqa: E501
- """List position close history # noqa: E501
+ """Query position close history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2648,7 +2648,7 @@ def list_delivery_position_close_with_http_info(self, settle, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2738,7 +2738,7 @@ def list_delivery_position_close_with_http_info(self, settle, **kwargs): # noqa
collection_formats=collection_formats)
def list_delivery_liquidates(self, settle, **kwargs): # noqa: E501
- """List liquidation history # noqa: E501
+ """Query liquidation history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2748,8 +2748,8 @@ def list_delivery_liquidates(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a liquidation timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int at: Specify liquidation timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2765,7 +2765,7 @@ def list_delivery_liquidates(self, settle, **kwargs): # noqa: E501
return self.list_delivery_liquidates_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
- """List liquidation history # noqa: E501
+ """Query liquidation history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2775,8 +2775,8 @@ def list_delivery_liquidates_with_http_info(self, settle, **kwargs): # noqa: E5
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a liquidation timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int at: Specify liquidation timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2869,7 +2869,7 @@ def list_delivery_liquidates_with_http_info(self, settle, **kwargs): # noqa: E5
collection_formats=collection_formats)
def list_delivery_settlements(self, settle, **kwargs): # noqa: E501
- """List settlement history # noqa: E501
+ """Query settlement records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2879,8 +2879,8 @@ def list_delivery_settlements(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a settlement timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int at: Specify settlement timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2896,7 +2896,7 @@ def list_delivery_settlements(self, settle, **kwargs): # noqa: E501
return self.list_delivery_settlements_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_settlements_with_http_info(self, settle, **kwargs): # noqa: E501
- """List settlement history # noqa: E501
+ """Query settlement records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2906,8 +2906,8 @@ def list_delivery_settlements_with_http_info(self, settle, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a settlement timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int at: Specify settlement timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3000,9 +3000,9 @@ def list_delivery_settlements_with_http_info(self, settle, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_delivery_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
- """List risk limit tiers # noqa: E501
+ """Query risk limit tiers # noqa: E501
- When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. # noqa: E501
+ When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_delivery_risk_limit_tiers(settle, async_req=True)
@@ -3011,7 +3011,7 @@ def list_delivery_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -3028,9 +3028,9 @@ def list_delivery_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
return self.list_delivery_risk_limit_tiers_with_http_info(settle, **kwargs) # noqa: E501
def list_delivery_risk_limit_tiers_with_http_info(self, settle, **kwargs): # noqa: E501
- """List risk limit tiers # noqa: E501
+ """Query risk limit tiers # noqa: E501
- When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. # noqa: E501
+ When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_delivery_risk_limit_tiers_with_http_info(settle, async_req=True)
@@ -3039,7 +3039,7 @@ def list_delivery_risk_limit_tiers_with_http_info(self, settle, **kwargs): # no
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -3135,7 +3135,7 @@ def list_delivery_risk_limit_tiers_with_http_info(self, settle, **kwargs): # no
collection_formats=collection_formats)
def list_price_triggered_delivery_orders(self, settle, status, **kwargs): # noqa: E501
- """List all auto orders # noqa: E501
+ """Query auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3144,9 +3144,9 @@ def list_price_triggered_delivery_orders(self, settle, status, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -3163,7 +3163,7 @@ def list_price_triggered_delivery_orders(self, settle, status, **kwargs): # noq
return self.list_price_triggered_delivery_orders_with_http_info(settle, status, **kwargs) # noqa: E501
def list_price_triggered_delivery_orders_with_http_info(self, settle, status, **kwargs): # noqa: E501
- """List all auto orders # noqa: E501
+ """Query auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3172,9 +3172,9 @@ def list_price_triggered_delivery_orders_with_http_info(self, settle, status, **
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -3277,7 +3277,7 @@ def list_price_triggered_delivery_orders_with_http_info(self, settle, status, **
collection_formats=collection_formats)
def create_price_triggered_delivery_order(self, settle, futures_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3302,7 +3302,7 @@ def create_price_triggered_delivery_order(self, settle, futures_price_triggered_
return self.create_price_triggered_delivery_order_with_http_info(settle, futures_price_triggered_order, **kwargs) # noqa: E501
def create_price_triggered_delivery_order_with_http_info(self, settle, futures_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3402,7 +3402,7 @@ def create_price_triggered_delivery_order_with_http_info(self, settle, futures_p
collection_formats=collection_formats)
def cancel_price_triggered_delivery_order_list(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3427,7 +3427,7 @@ def cancel_price_triggered_delivery_order_list(self, settle, contract, **kwargs)
return self.cancel_price_triggered_delivery_order_list_with_http_info(settle, contract, **kwargs) # noqa: E501
def cancel_price_triggered_delivery_order_list_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3523,7 +3523,7 @@ def cancel_price_triggered_delivery_order_list_with_http_info(self, settle, cont
collection_formats=collection_formats)
def get_price_triggered_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3532,7 +3532,7 @@ def get_price_triggered_delivery_order(self, settle, order_id, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3548,7 +3548,7 @@ def get_price_triggered_delivery_order(self, settle, order_id, **kwargs): # noq
return self.get_price_triggered_delivery_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def get_price_triggered_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3557,7 +3557,7 @@ def get_price_triggered_delivery_order_with_http_info(self, settle, order_id, **
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3644,7 +3644,7 @@ def get_price_triggered_delivery_order_with_http_info(self, settle, order_id, **
collection_formats=collection_formats)
def cancel_price_triggered_delivery_order(self, settle, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3653,7 +3653,7 @@ def cancel_price_triggered_delivery_order(self, settle, order_id, **kwargs): #
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3669,7 +3669,7 @@ def cancel_price_triggered_delivery_order(self, settle, order_id, **kwargs): #
return self.cancel_price_triggered_delivery_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def cancel_price_triggered_delivery_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3678,7 +3678,7 @@ def cancel_price_triggered_delivery_order_with_http_info(self, settle, order_id,
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/gate_api/api/earn_api.py b/gate_api/api/earn_api.py
index e3d2d52..2076555 100644
--- a/gate_api/api/earn_api.py
+++ b/gate_api/api/earn_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -148,6 +148,111 @@ def swap_eth2_with_http_info(self, eth2_swap, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def rate_list_eth2(self, **kwargs): # noqa: E501
+ """ETH2 historical return rate query # noqa: E501
+
+ Query ETH earnings rate records for the last 31 days # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.rate_list_eth2(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: list[gate_api.Eth2RateList]
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.rate_list_eth2_with_http_info(**kwargs) # noqa: E501
+
+ def rate_list_eth2_with_http_info(self, **kwargs): # noqa: E501
+ """ETH2 historical return rate query # noqa: E501
+
+ Query ETH earnings rate records for the last 31 days # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.rate_list_eth2_with_http_info(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(list[gate_api.Eth2RateList], status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method rate_list_eth2" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/earn/staking/eth2/rate_records', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[Eth2RateList]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
def list_dual_investment_plans(self, **kwargs): # noqa: E501
"""Dual Investment product list # noqa: E501
@@ -157,6 +262,7 @@ def list_dual_investment_plans(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param int plan_id: Financial project ID
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -180,6 +286,7 @@ def list_dual_investment_plans_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param int plan_id: Financial project ID
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -197,6 +304,7 @@ def list_dual_investment_plans_with_http_info(self, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ 'plan_id'
]
all_params.extend(
[
@@ -221,6 +329,8 @@ def list_dual_investment_plans_with_http_info(self, **kwargs): # noqa: E501
path_params = {}
query_params = []
+ if 'plan_id' in local_var_params and local_var_params['plan_id'] is not None: # noqa: E501
+ query_params.append(('plan_id', local_var_params['plan_id'])) # noqa: E501
header_params = {}
@@ -260,6 +370,10 @@ def list_dual_orders(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param int _from: Start settlement time
+ :param int to: End settlement time
+ :param int page: Page number
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -283,6 +397,10 @@ def list_dual_orders_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param int _from: Start settlement time
+ :param int to: End settlement time
+ :param int page: Page number
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -300,6 +418,10 @@ def list_dual_orders_with_http_info(self, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ '_from',
+ 'to',
+ 'page',
+ 'limit'
]
all_params.extend(
[
@@ -319,11 +441,25 @@ def list_dual_orders_with_http_info(self, **kwargs): # noqa: E501
local_var_params[k] = v
del local_var_params['kwargs']
+ if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 1: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `page` when calling `list_dual_orders`, must be a value greater than or equal to `1`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_dual_orders`, must be a value less than or equal to `1000`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_dual_orders`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
+ if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
+ query_params.append(('from', local_var_params['_from'])) # noqa: E501
+ if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
+ query_params.append(('to', local_var_params['to'])) # noqa: E501
+ if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
+ query_params.append(('page', local_var_params['page'])) # noqa: E501
+ if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
+ query_params.append(('limit', local_var_params['limit'])) # noqa: E501
header_params = {}
@@ -475,10 +611,10 @@ def list_structured_products(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish (required)
- :param str type: Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall
+ :param str status: Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed (required)
+ :param str type: Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -502,10 +638,10 @@ def list_structured_products_with_http_info(self, status, **kwargs): # noqa: E5
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish (required)
- :param str type: Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall
+ :param str status: Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed (required)
+ :param str type: Product Type (Default empty to query all) `SharkFin2.0`-Shark Fin `BullishSharkFin`-Bullish Treasure `BearishSharkFin`-Bearish Treasure `DoubleNoTouch`-Volatility Treasure `RangeAccrual`-Range Smart Yield `SnowBall`-Snowball
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -608,10 +744,10 @@ def list_structured_orders(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -635,10 +771,10 @@ def list_structured_orders_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -839,3 +975,235 @@ def place_structured_order_with_http_info(self, structured_buy, **kwargs): # no
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+
+ def find_coin(self, find_coin, **kwargs): # noqa: E501
+ """Staking coins # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.find_coin(find_coin, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param FindCoin find_coin: (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: object
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.find_coin_with_http_info(find_coin, **kwargs) # noqa: E501
+
+ def find_coin_with_http_info(self, find_coin, **kwargs): # noqa: E501
+ """Staking coins # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.find_coin_with_http_info(find_coin, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param FindCoin find_coin: (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(object, status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'find_coin'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method find_coin" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'find_coin' is set
+ if self.api_client.client_side_validation and ('find_coin' not in local_var_params or # noqa: E501
+ local_var_params['find_coin'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `find_coin` when calling `find_coin`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'find_coin' in local_var_params:
+ body_params = local_var_params['find_coin']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/earn/staking/coins', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='object', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def swap_staking_coin(self, swap_coin, **kwargs): # noqa: E501
+ """On-chain token swap for earned coins # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.swap_staking_coin(swap_coin, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param SwapCoin swap_coin: (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: gate_api.SwapCoinStruct
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.swap_staking_coin_with_http_info(swap_coin, **kwargs) # noqa: E501
+
+ def swap_staking_coin_with_http_info(self, swap_coin, **kwargs): # noqa: E501
+ """On-chain token swap for earned coins # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.swap_staking_coin_with_http_info(swap_coin, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param SwapCoin swap_coin: (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(gate_api.SwapCoinStruct, status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'swap_coin'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method swap_staking_coin" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'swap_coin' is set
+ if self.api_client.client_side_validation and ('swap_coin' not in local_var_params or # noqa: E501
+ local_var_params['swap_coin'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `swap_coin` when calling `swap_staking_coin`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'swap_coin' in local_var_params:
+ body_params = local_var_params['swap_coin']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/earn/staking/swap', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='SwapCoinStruct', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
diff --git a/gate_api/api/earn_uni_api.py b/gate_api/api/earn_uni_api.py
index 9a18d82..4d37fd4 100644
--- a/gate_api/api/earn_uni_api.py
+++ b/gate_api/api/earn_uni_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_uni_currencies(self, **kwargs): # noqa: E501
- """List currencies for lending # noqa: E501
+ """Query lending currency list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -60,7 +60,7 @@ def list_uni_currencies(self, **kwargs): # noqa: E501
return self.list_uni_currencies_with_http_info(**kwargs) # noqa: E501
def list_uni_currencies_with_http_info(self, **kwargs): # noqa: E501
- """List currencies for lending # noqa: E501
+ """Query lending currency list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -140,7 +140,7 @@ def list_uni_currencies_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_uni_currency(self, currency, **kwargs): # noqa: E501
- """Get currency detail for lending # noqa: E501
+ """Query single lending currency details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -164,7 +164,7 @@ def get_uni_currency(self, currency, **kwargs): # noqa: E501
return self.get_uni_currency_with_http_info(currency, **kwargs) # noqa: E501
def get_uni_currency_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get currency detail for lending # noqa: E501
+ """Query single lending currency details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -252,7 +252,7 @@ def get_uni_currency_with_http_info(self, currency, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_user_uni_lends(self, **kwargs): # noqa: E501
- """List user's lending orders # noqa: E501
+ """Query user's lending order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -260,9 +260,9 @@ def list_user_uni_lends(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -278,7 +278,7 @@ def list_user_uni_lends(self, **kwargs): # noqa: E501
return self.list_user_uni_lends_with_http_info(**kwargs) # noqa: E501
def list_user_uni_lends_with_http_info(self, **kwargs): # noqa: E501
- """List user's lending orders # noqa: E501
+ """Query user's lending order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -286,9 +286,9 @@ def list_user_uni_lends_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -376,9 +376,9 @@ def list_user_uni_lends_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_uni_lend(self, create_uni_lend, **kwargs): # noqa: E501
- """Lend or redeem # noqa: E501
+ """Create lending or redemption # noqa: E501
- `Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. # noqa: E501
+ Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_uni_lend(create_uni_lend, async_req=True)
@@ -401,9 +401,9 @@ def create_uni_lend(self, create_uni_lend, **kwargs): # noqa: E501
return self.create_uni_lend_with_http_info(create_uni_lend, **kwargs) # noqa: E501
def create_uni_lend_with_http_info(self, create_uni_lend, **kwargs): # noqa: E501
- """Lend or redeem # noqa: E501
+ """Create lending or redemption # noqa: E501
- `Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. # noqa: E501
+ Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_uni_lend_with_http_info(create_uni_lend, async_req=True)
@@ -490,9 +490,9 @@ def create_uni_lend_with_http_info(self, create_uni_lend, **kwargs): # noqa: E5
collection_formats=collection_formats)
def change_uni_lend(self, patch_uni_lend, **kwargs): # noqa: E501
- """Amend lending order # noqa: E501
+ """Amend user lending information # noqa: E501
- Currently only supports amending the minimum interest rate (hour) # noqa: E501
+ Currently only supports amending minimum interest rate (hourly) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.change_uni_lend(patch_uni_lend, async_req=True)
@@ -515,9 +515,9 @@ def change_uni_lend(self, patch_uni_lend, **kwargs): # noqa: E501
return self.change_uni_lend_with_http_info(patch_uni_lend, **kwargs) # noqa: E501
def change_uni_lend_with_http_info(self, patch_uni_lend, **kwargs): # noqa: E501
- """Amend lending order # noqa: E501
+ """Amend user lending information # noqa: E501
- Currently only supports amending the minimum interest rate (hour) # noqa: E501
+ Currently only supports amending minimum interest rate (hourly) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.change_uni_lend_with_http_info(patch_uni_lend, async_req=True)
@@ -604,7 +604,7 @@ def change_uni_lend_with_http_info(self, patch_uni_lend, **kwargs): # noqa: E50
collection_formats=collection_formats)
def list_uni_lend_records(self, **kwargs): # noqa: E501
- """List records of lending # noqa: E501
+ """Query lending transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -612,12 +612,12 @@ def list_uni_lend_records(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: type: lend - lend, redeem - redeem
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Operation type: lend - Lend, redeem - Redeem
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -633,7 +633,7 @@ def list_uni_lend_records(self, **kwargs): # noqa: E501
return self.list_uni_lend_records_with_http_info(**kwargs) # noqa: E501
def list_uni_lend_records_with_http_info(self, **kwargs): # noqa: E501
- """List records of lending # noqa: E501
+ """Query lending transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -641,12 +641,12 @@ def list_uni_lend_records_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: type: lend - lend, redeem - redeem
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Operation type: lend - Lend, redeem - Redeem
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -743,7 +743,7 @@ def list_uni_lend_records_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_uni_interest(self, currency, **kwargs): # noqa: E501
- """Get the user's total interest income of specified currency # noqa: E501
+ """Query user's total interest income for specified currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -767,7 +767,7 @@ def get_uni_interest(self, currency, **kwargs): # noqa: E501
return self.get_uni_interest_with_http_info(currency, **kwargs) # noqa: E501
def get_uni_interest_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get the user's total interest income of specified currency # noqa: E501
+ """Query user's total interest income for specified currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -855,7 +855,7 @@ def get_uni_interest_with_http_info(self, currency, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_uni_interest_records(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query user dividend records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -863,11 +863,11 @@ def list_uni_interest_records(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -883,7 +883,7 @@ def list_uni_interest_records(self, **kwargs): # noqa: E501
return self.list_uni_interest_records_with_http_info(**kwargs) # noqa: E501
def list_uni_interest_records_with_http_info(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query user dividend records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -891,11 +891,11 @@ def list_uni_interest_records_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -988,16 +988,16 @@ def list_uni_interest_records_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def switch_interest_reinvest(self, uni_interest_mode, **kwargs): # noqa: E501
- """Set interest reinvestment toggle # noqa: E501
+ def get_uni_interest_status(self, currency, **kwargs): # noqa: E501
+ """Query currency interest compounding status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.switch_interest_reinvest(uni_interest_mode, async_req=True)
+ >>> thread = api.get_uni_interest_status(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UniInterestMode uni_interest_mode: (required)
+ :param str currency: Currency (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1005,23 +1005,23 @@ def switch_interest_reinvest(self, uni_interest_mode, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: None
+ :rtype: gate_api.UniCurrencyInterest
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.switch_interest_reinvest_with_http_info(uni_interest_mode, **kwargs) # noqa: E501
+ return self.get_uni_interest_status_with_http_info(currency, **kwargs) # noqa: E501
- def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs): # noqa: E501
- """Set interest reinvestment toggle # noqa: E501
+ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E501
+ """Query currency interest compounding status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.switch_interest_reinvest_with_http_info(uni_interest_mode, async_req=True)
+ >>> thread = api.get_uni_interest_status_with_http_info(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UniInterestMode uni_interest_mode: (required)
+ :param str currency: Currency (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1031,7 +1031,7 @@ def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs):
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: None
+ :rtype: tuple(gate_api.UniCurrencyInterest, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1039,7 +1039,7 @@ def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs):
local_var_params = locals()
all_params = [
- 'uni_interest_mode'
+ 'currency'
]
all_params.extend(
[
@@ -1054,18 +1054,20 @@ def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs):
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method switch_interest_reinvest" % k
+ " to method get_uni_interest_status" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'uni_interest_mode' is set
- if self.api_client.client_side_validation and ('uni_interest_mode' not in local_var_params or # noqa: E501
- local_var_params['uni_interest_mode'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `uni_interest_mode` when calling `switch_interest_reinvest`") # noqa: E501
+ # verify the required parameter 'currency' is set
+ if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
+ local_var_params['currency'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currency` when calling `get_uni_interest_status`") # noqa: E501
collection_formats = {}
path_params = {}
+ if 'currency' in local_var_params:
+ path_params['currency'] = local_var_params['currency'] # noqa: E501
query_params = []
@@ -1075,24 +1077,22 @@ def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs):
local_var_files = {}
body_params = None
- if 'uni_interest_mode' in local_var_params:
- body_params = local_var_params['uni_interest_mode']
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/earn/uni/interest_reinvest', 'PUT',
+ '/earn/uni/interest_status/{currency}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type=None, # noqa: E501
+ response_type='UniCurrencyInterest', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -1100,16 +1100,19 @@ def switch_interest_reinvest_with_http_info(self, uni_interest_mode, **kwargs):
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_uni_interest_status(self, currency, **kwargs): # noqa: E501
- """query currency interest compounding status # noqa: E501
+ def list_uni_chart(self, _from, to, asset, **kwargs): # noqa: E501
+ """UniLoan currency annualized trend chart # noqa: E501
+ Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_uni_interest_status(currency, async_req=True)
+ >>> thread = api.list_uni_chart(_from, to, asset, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency (required)
+ :param int _from: Start timestamp in seconds, maximum span 30 days (required)
+ :param int to: End timestamp in seconds, maximum span 30 days (required)
+ :param str asset: Currency name (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1117,23 +1120,26 @@ def get_uni_interest_status(self, currency, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.UniCurrencyInterest
+ :rtype: list[gate_api.InlineResponse200]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.get_uni_interest_status_with_http_info(currency, **kwargs) # noqa: E501
+ return self.list_uni_chart_with_http_info(_from, to, asset, **kwargs) # noqa: E501
- def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E501
- """query currency interest compounding status # noqa: E501
+ def list_uni_chart_with_http_info(self, _from, to, asset, **kwargs): # noqa: E501
+ """UniLoan currency annualized trend chart # noqa: E501
+ Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_uni_interest_status_with_http_info(currency, async_req=True)
+ >>> thread = api.list_uni_chart_with_http_info(_from, to, asset, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency (required)
+ :param int _from: Start timestamp in seconds, maximum span 30 days (required)
+ :param int to: End timestamp in seconds, maximum span 30 days (required)
+ :param str asset: Currency name (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1143,7 +1149,7 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.UniCurrencyInterest, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.InlineResponse200], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1151,7 +1157,9 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E
local_var_params = locals()
all_params = [
- 'currency'
+ '_from',
+ 'to',
+ 'asset'
]
all_params.extend(
[
@@ -1166,22 +1174,34 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_uni_interest_status" % k
+ " to method list_uni_chart" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_uni_interest_status`") # noqa: E501
+ # verify the required parameter '_from' is set
+ if self.api_client.client_side_validation and ('_from' not in local_var_params or # noqa: E501
+ local_var_params['_from'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `_from` when calling `list_uni_chart`") # noqa: E501
+ # verify the required parameter 'to' is set
+ if self.api_client.client_side_validation and ('to' not in local_var_params or # noqa: E501
+ local_var_params['to'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `to` when calling `list_uni_chart`") # noqa: E501
+ # verify the required parameter 'asset' is set
+ if self.api_client.client_side_validation and ('asset' not in local_var_params or # noqa: E501
+ local_var_params['asset'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `asset` when calling `list_uni_chart`") # noqa: E501
collection_formats = {}
path_params = {}
- if 'currency' in local_var_params:
- path_params['currency'] = local_var_params['currency'] # noqa: E501
query_params = []
+ if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
+ query_params.append(('from', local_var_params['_from'])) # noqa: E501
+ if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
+ query_params.append(('to', local_var_params['to'])) # noqa: E501
+ if 'asset' in local_var_params and local_var_params['asset'] is not None: # noqa: E501
+ query_params.append(('asset', local_var_params['asset'])) # noqa: E501
header_params = {}
@@ -1197,14 +1217,119 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/earn/uni/interest_status/{currency}', 'GET',
+ '/earn/uni/chart', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='UniCurrencyInterest', # noqa: E501
+ response_type='list[InlineResponse200]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def list_uni_rate(self, **kwargs): # noqa: E501
+ """Currency estimated annualized interest rate # noqa: E501
+
+ Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.list_uni_rate(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: list[gate_api.InlineResponse2001]
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.list_uni_rate_with_http_info(**kwargs) # noqa: E501
+
+ def list_uni_rate_with_http_info(self, **kwargs): # noqa: E501
+ """Currency estimated annualized interest rate # noqa: E501
+
+ Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME Language: en Language-Team: en Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.list_uni_rate_with_http_info(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(list[gate_api.InlineResponse2001], status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method list_uni_rate" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/earn/uni/rate', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[InlineResponse2001]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
diff --git a/gate_api/api/flash_swap_api.py b/gate_api/api/flash_swap_api.py
index 079dee6..ffbba85 100644
--- a/gate_api/api/flash_swap_api.py
+++ b/gate_api/api/flash_swap_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -36,109 +36,6 @@ def __init__(self, api_client=None):
api_client = ApiClient()
self.api_client = api_client
- def list_flash_swap_currencies(self, **kwargs): # noqa: E501
- """List All Supported Currencies In Flash Swap (deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_flash_swap_currencies(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.FlashSwapCurrency]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_flash_swap_currencies_with_http_info(**kwargs) # noqa: E501
-
- def list_flash_swap_currencies_with_http_info(self, **kwargs): # noqa: E501
- """List All Supported Currencies In Flash Swap (deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_flash_swap_currencies_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.FlashSwapCurrency], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_flash_swap_currencies" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = [] # noqa: E501
-
- return self.api_client.call_api(
- '/flash_swap/currencies', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[FlashSwapCurrency]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
def list_flash_swap_currency_pair(self, **kwargs): # noqa: E501
"""List All Supported Currency Pairs In Flash Swap # noqa: E501
@@ -149,9 +46,9 @@ def list_flash_swap_currency_pair(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 1000
+ :param int limit: Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -176,9 +73,9 @@ def list_flash_swap_currency_pair_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 1000
+ :param int limit: Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -266,7 +163,7 @@ def list_flash_swap_currency_pair_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_flash_swap_orders(self, **kwargs): # noqa: E501
- """List all flash swap orders # noqa: E501
+ """Query flash swap order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -274,11 +171,11 @@ def list_flash_swap_orders(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int status: Flash swap order status `1` - success `2` - failure
- :param str sell_currency: Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies`
- :param str buy_currency: Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies`
- :param bool reverse: If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int status: Flash swap order status `1` - success `2` - failed
+ :param str sell_currency: Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies
+ :param str buy_currency: Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies
+ :param bool reverse: Sort by ID in ascending or descending order, default `true` - `true`: ID descending order (most recent data first) - `false`: ID ascending order (oldest data first)
+ :param int limit: Maximum number of records returned in a single list
:param int page: Page number
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -295,7 +192,7 @@ def list_flash_swap_orders(self, **kwargs): # noqa: E501
return self.list_flash_swap_orders_with_http_info(**kwargs) # noqa: E501
def list_flash_swap_orders_with_http_info(self, **kwargs): # noqa: E501
- """List all flash swap orders # noqa: E501
+ """Query flash swap order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -303,11 +200,11 @@ def list_flash_swap_orders_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int status: Flash swap order status `1` - success `2` - failure
- :param str sell_currency: Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies`
- :param str buy_currency: Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies`
- :param bool reverse: If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int status: Flash swap order status `1` - success `2` - failed
+ :param str sell_currency: Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies
+ :param str buy_currency: Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies
+ :param bool reverse: Sort by ID in ascending or descending order, default `true` - `true`: ID descending order (most recent data first) - `false`: ID ascending order (oldest data first)
+ :param int limit: Maximum number of records returned in a single list
:param int page: Page number
:param _return_http_data_only: response data without head status code
and headers
@@ -523,7 +420,7 @@ def create_flash_swap_order_with_http_info(self, flash_swap_order_request, **kwa
collection_formats=collection_formats)
def get_flash_swap_order(self, order_id, **kwargs): # noqa: E501
- """Get a single flash swap order's detail # noqa: E501
+ """Query single flash swap order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -547,7 +444,7 @@ def get_flash_swap_order(self, order_id, **kwargs): # noqa: E501
return self.get_flash_swap_order_with_http_info(order_id, **kwargs) # noqa: E501
def get_flash_swap_order_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Get a single flash swap order's detail # noqa: E501
+ """Query single flash swap order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -635,7 +532,7 @@ def get_flash_swap_order_with_http_info(self, order_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def preview_flash_swap_order(self, flash_swap_preview_request, **kwargs): # noqa: E501
- """Initiate a flash swap order preview # noqa: E501
+ """Flash swap order preview # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -659,7 +556,7 @@ def preview_flash_swap_order(self, flash_swap_preview_request, **kwargs): # noq
return self.preview_flash_swap_order_with_http_info(flash_swap_preview_request, **kwargs) # noqa: E501
def preview_flash_swap_order_with_http_info(self, flash_swap_preview_request, **kwargs): # noqa: E501
- """Initiate a flash swap order preview # noqa: E501
+ """Flash swap order preview # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
diff --git a/gate_api/api/futures_api.py b/gate_api/api/futures_api.py
index 885a5bc..5d20be4 100644
--- a/gate_api/api/futures_api.py
+++ b/gate_api/api/futures_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_futures_contracts(self, settle, **kwargs): # noqa: E501
- """List all futures contracts # noqa: E501
+ """Query all futures contracts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -46,7 +46,7 @@ def list_futures_contracts(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -63,7 +63,7 @@ def list_futures_contracts(self, settle, **kwargs): # noqa: E501
return self.list_futures_contracts_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_contracts_with_http_info(self, settle, **kwargs): # noqa: E501
- """List all futures contracts # noqa: E501
+ """Query all futures contracts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -72,7 +72,7 @@ def list_futures_contracts_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -165,7 +165,7 @@ def list_futures_contracts_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_futures_contract(self, settle, contract, **kwargs): # noqa: E501
- """Get a single contract # noqa: E501
+ """Query single contract information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -190,7 +190,7 @@ def get_futures_contract(self, settle, contract, **kwargs): # noqa: E501
return self.get_futures_contract_with_http_info(settle, contract, **kwargs) # noqa: E501
def get_futures_contract_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get a single contract # noqa: E501
+ """Query single contract information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -286,7 +286,7 @@ def get_futures_contract_with_http_info(self, settle, contract, **kwargs): # no
collection_formats=collection_formats)
def list_futures_order_book(self, settle, contract, **kwargs): # noqa: E501
- """Futures order book # noqa: E501
+ """Query futures market depth information # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -297,9 +297,9 @@ def list_futures_order_book(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -315,7 +315,7 @@ def list_futures_order_book(self, settle, contract, **kwargs): # noqa: E501
return self.list_futures_order_book_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_futures_order_book_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Futures order book # noqa: E501
+ """Query futures market depth information # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -326,9 +326,9 @@ def list_futures_order_book_with_http_info(self, settle, contract, **kwargs): #
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -428,7 +428,7 @@ def list_futures_order_book_with_http_info(self, settle, contract, **kwargs): #
collection_formats=collection_formats)
def list_futures_trades(self, settle, contract, **kwargs): # noqa: E501
- """Futures trading history # noqa: E501
+ """Futures market transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -438,11 +438,11 @@ def list_futures_trades(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range
:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.
- :param int to: Specify end time in Unix seconds, default to current time
+ :param int to: Specify end time in Unix seconds, default to current time.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -458,7 +458,7 @@ def list_futures_trades(self, settle, contract, **kwargs): # noqa: E501
return self.list_futures_trades_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_futures_trades_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Futures trading history # noqa: E501
+ """Futures market transaction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -468,11 +468,11 @@ def list_futures_trades_with_http_info(self, settle, contract, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range
:param int _from: Specify starting time in Unix seconds. If not specified, `to` and `limit` will be used to limit response items. If items between `from` and `to` are more than `limit`, only `limit` number will be returned.
- :param int to: Specify end time in Unix seconds, default to current time
+ :param int to: Specify end time in Unix seconds, default to current time.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -580,7 +580,7 @@ def list_futures_trades_with_http_info(self, settle, contract, **kwargs): # noq
collection_formats=collection_formats)
def list_futures_candlesticks(self, settle, contract, **kwargs): # noqa: E501
- """Get futures candlesticks # noqa: E501
+ """Futures market K-line chart # noqa: E501
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -592,9 +592,10 @@ def list_futures_candlesticks(self, settle, contract, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Interval time between data points. Note that `1w` means natural week(Mon-Sun), while `7d` means every 7d since unix 0. 30d represents a natural month, not 30 days
+ :param str timezone: Time zone: all/utc0/utc8, default utc0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -610,7 +611,7 @@ def list_futures_candlesticks(self, settle, contract, **kwargs): # noqa: E501
return self.list_futures_candlesticks_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get futures candlesticks # noqa: E501
+ """Futures market K-line chart # noqa: E501
Return specified contract candlesticks. If prefix `contract` with `mark_`, the contract's mark price candlesticks are returned; if prefix with `index_`, index price candlesticks will be returned. Maximum of 2000 points are returned in one query. Be sure not to exceed the limit when specifying `from`, `to` and `interval` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -622,9 +623,10 @@ def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs):
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Interval time between data points. Note that `1w` means natural week(Mon-Sun), while `7d` means every 7d since unix 0. 30d represents a natural month, not 30 days
+ :param str timezone: Time zone: all/utc0/utc8, default utc0
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -647,7 +649,8 @@ def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs):
'_from',
'to',
'limit',
- 'interval'
+ 'interval',
+ 'timezone'
]
all_params.extend(
[
@@ -694,6 +697,8 @@ def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs):
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
if 'interval' in local_var_params and local_var_params['interval'] is not None: # noqa: E501
query_params.append(('interval', local_var_params['interval'])) # noqa: E501
+ if 'timezone' in local_var_params and local_var_params['timezone'] is not None: # noqa: E501
+ query_params.append(('timezone', local_var_params['timezone'])) # noqa: E501
header_params = {}
@@ -725,7 +730,7 @@ def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs):
collection_formats=collection_formats)
def list_futures_premium_index(self, settle, contract, **kwargs): # noqa: E501
- """Premium Index K-Line # noqa: E501
+ """Premium Index K-line chart # noqa: E501
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -737,9 +742,9 @@ def list_futures_premium_index(self, settle, contract, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Time interval between data points
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -755,7 +760,7 @@ def list_futures_premium_index(self, settle, contract, **kwargs): # noqa: E501
return self.list_futures_premium_index_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_futures_premium_index_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Premium Index K-Line # noqa: E501
+ """Premium Index K-line chart # noqa: E501
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -767,9 +772,9 @@ def list_futures_premium_index_with_http_info(self, settle, contract, **kwargs):
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
- :param str interval: Interval time between data points
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param str interval: Time interval between data points
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -870,7 +875,7 @@ def list_futures_premium_index_with_http_info(self, settle, contract, **kwargs):
collection_formats=collection_formats)
def list_futures_tickers(self, settle, **kwargs): # noqa: E501
- """List futures tickers # noqa: E501
+ """Get all futures trading statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -895,7 +900,7 @@ def list_futures_tickers(self, settle, **kwargs): # noqa: E501
return self.list_futures_tickers_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
- """List futures tickers # noqa: E501
+ """Get all futures trading statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -987,7 +992,7 @@ def list_futures_tickers_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_futures_funding_rate_history(self, settle, contract, **kwargs): # noqa: E501
- """Funding rate history # noqa: E501
+ """Futures market historical funding rate # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -997,9 +1002,9 @@ def list_futures_funding_rate_history(self, settle, contract, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1015,7 +1020,7 @@ def list_futures_funding_rate_history(self, settle, contract, **kwargs): # noqa
return self.list_futures_funding_rate_history_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_futures_funding_rate_history_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Funding rate history # noqa: E501
+ """Futures market historical funding rate # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1025,9 +1030,9 @@ def list_futures_funding_rate_history_with_http_info(self, settle, contract, **k
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1127,7 +1132,7 @@ def list_futures_funding_rate_history_with_http_info(self, settle, contract, **k
collection_formats=collection_formats)
def list_futures_insurance_ledger(self, settle, **kwargs): # noqa: E501
- """Futures insurance balance history # noqa: E501
+ """Futures market insurance fund history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1136,7 +1141,7 @@ def list_futures_insurance_ledger(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1152,7 +1157,7 @@ def list_futures_insurance_ledger(self, settle, **kwargs): # noqa: E501
return self.list_futures_insurance_ledger_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_insurance_ledger_with_http_info(self, settle, **kwargs): # noqa: E501
- """Futures insurance balance history # noqa: E501
+ """Futures market insurance fund history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1161,7 +1166,7 @@ def list_futures_insurance_ledger_with_http_info(self, settle, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1248,7 +1253,7 @@ def list_futures_insurance_ledger_with_http_info(self, settle, **kwargs): # noq
collection_formats=collection_formats)
def list_contract_stats(self, settle, contract, **kwargs): # noqa: E501
- """Futures stats # noqa: E501
+ """Futures statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1276,7 +1281,7 @@ def list_contract_stats(self, settle, contract, **kwargs): # noqa: E501
return self.list_contract_stats_with_http_info(settle, contract, **kwargs) # noqa: E501
def list_contract_stats_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Futures stats # noqa: E501
+ """Futures statistics # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1388,7 +1393,7 @@ def list_contract_stats_with_http_info(self, settle, contract, **kwargs): # noq
collection_formats=collection_formats)
def get_index_constituents(self, settle, index, **kwargs): # noqa: E501
- """Get index constituents # noqa: E501
+ """Query index constituents # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1413,7 +1418,7 @@ def get_index_constituents(self, settle, index, **kwargs): # noqa: E501
return self.get_index_constituents_with_http_info(settle, index, **kwargs) # noqa: E501
def get_index_constituents_with_http_info(self, settle, index, **kwargs): # noqa: E501
- """Get index constituents # noqa: E501
+ """Query index constituents # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1509,9 +1514,9 @@ def get_index_constituents_with_http_info(self, settle, index, **kwargs): # noq
collection_formats=collection_formats)
def list_liquidated_orders(self, settle, **kwargs): # noqa: E501
- """Retrieve liquidation history # noqa: E501
+ """Query liquidation order history # noqa: E501
- Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail. # noqa: E501
+ The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_liquidated_orders(settle, async_req=True)
@@ -1520,9 +1525,9 @@ def list_liquidated_orders(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1538,9 +1543,9 @@ def list_liquidated_orders(self, settle, **kwargs): # noqa: E501
return self.list_liquidated_orders_with_http_info(settle, **kwargs) # noqa: E501
def list_liquidated_orders_with_http_info(self, settle, **kwargs): # noqa: E501
- """Retrieve liquidation history # noqa: E501
+ """Query liquidation order history # noqa: E501
- Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail. # noqa: E501
+ The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_liquidated_orders_with_http_info(settle, async_req=True)
@@ -1549,9 +1554,9 @@ def list_liquidated_orders_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1647,9 +1652,9 @@ def list_liquidated_orders_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_futures_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
- """List risk limit tiers # noqa: E501
+ """Query risk limit tiers # noqa: E501
- When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. # noqa: E501
+ When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_futures_risk_limit_tiers(settle, async_req=True)
@@ -1658,7 +1663,7 @@ def list_futures_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1675,9 +1680,9 @@ def list_futures_risk_limit_tiers(self, settle, **kwargs): # noqa: E501
return self.list_futures_risk_limit_tiers_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_risk_limit_tiers_with_http_info(self, settle, **kwargs): # noqa: E501
- """List risk limit tiers # noqa: E501
+ """Query risk limit tiers # noqa: E501
- When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. # noqa: E501
+ When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_futures_risk_limit_tiers_with_http_info(settle, async_req=True)
@@ -1686,7 +1691,7 @@ def list_futures_risk_limit_tiers_with_http_info(self, settle, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -1782,7 +1787,7 @@ def list_futures_risk_limit_tiers_with_http_info(self, settle, **kwargs): # noq
collection_formats=collection_formats)
def list_futures_accounts(self, settle, **kwargs): # noqa: E501
- """Query futures account # noqa: E501
+ """Get futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1806,7 +1811,7 @@ def list_futures_accounts(self, settle, **kwargs): # noqa: E501
return self.list_futures_accounts_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_accounts_with_http_info(self, settle, **kwargs): # noqa: E501
- """Query futures account # noqa: E501
+ """Get futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1894,9 +1899,9 @@ def list_futures_accounts_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_futures_account_book(self, settle, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query futures account change history # noqa: E501
- If the `contract` field is provided, it can only filter records that include this field after 2023-10-30. # noqa: E501
+ If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_futures_account_book(settle, async_req=True)
@@ -1905,11 +1910,11 @@ def list_futures_account_book(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1925,9 +1930,9 @@ def list_futures_account_book(self, settle, **kwargs): # noqa: E501
return self.list_futures_account_book_with_http_info(settle, **kwargs) # noqa: E501
def list_futures_account_book_with_http_info(self, settle, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query futures account change history # noqa: E501
- If the `contract` field is provided, it can only filter records that include this field after 2023-10-30. # noqa: E501
+ If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_futures_account_book_with_http_info(settle, async_req=True)
@@ -1936,11 +1941,11 @@ def list_futures_account_book_with_http_info(self, settle, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2044,7 +2049,7 @@ def list_futures_account_book_with_http_info(self, settle, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_positions(self, settle, **kwargs): # noqa: E501
- """List all positions of a user # noqa: E501
+ """Get user position list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2053,8 +2058,8 @@ def list_positions(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param bool holding: Return only real positions - true, return all - false.
- :param int limit: Maximum number of records to be returned in a single list
+ :param bool holding: Return only real positions - true, return all - false
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -2071,7 +2076,7 @@ def list_positions(self, settle, **kwargs): # noqa: E501
return self.list_positions_with_http_info(settle, **kwargs) # noqa: E501
def list_positions_with_http_info(self, settle, **kwargs): # noqa: E501
- """List all positions of a user # noqa: E501
+ """Get user position list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2080,8 +2085,8 @@ def list_positions_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param bool holding: Return only real positions - true, return all - false.
- :param int limit: Maximum number of records to be returned in a single list
+ :param bool holding: Return only real positions - true, return all - false
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -2177,7 +2182,7 @@ def list_positions_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_position(self, settle, contract, **kwargs): # noqa: E501
- """Get single position # noqa: E501
+ """Get single position information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2202,7 +2207,7 @@ def get_position(self, settle, contract, **kwargs): # noqa: E501
return self.get_position_with_http_info(settle, contract, **kwargs) # noqa: E501
def get_position_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Get single position # noqa: E501
+ """Get single position information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2308,7 +2313,7 @@ def update_position_margin(self, settle, contract, change, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2334,7 +2339,7 @@ def update_position_margin_with_http_info(self, settle, contract, change, **kwar
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2439,7 +2444,8 @@ def update_position_leverage(self, settle, contract, leverage, **kwargs): # noq
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param str leverage: New position leverage (required)
- :param str cross_leverage_limit: Cross margin leverage(valid only when `leverage` is 0)
+ :param str cross_leverage_limit: Cross margin leverage (valid only when `leverage` is 0)
+ :param int pid: Product ID
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2466,7 +2472,8 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, **
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param str leverage: New position leverage (required)
- :param str cross_leverage_limit: Cross margin leverage(valid only when `leverage` is 0)
+ :param str cross_leverage_limit: Cross margin leverage (valid only when `leverage` is 0)
+ :param int pid: Product ID
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2487,7 +2494,8 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, **
'settle',
'contract',
'leverage',
- 'cross_leverage_limit'
+ 'cross_leverage_limit',
+ 'pid'
]
all_params.extend(
[
@@ -2532,6 +2540,8 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, **
query_params.append(('leverage', local_var_params['leverage'])) # noqa: E501
if 'cross_leverage_limit' in local_var_params and local_var_params['cross_leverage_limit'] is not None: # noqa: E501
query_params.append(('cross_leverage_limit', local_var_params['cross_leverage_limit'])) # noqa: E501
+ if 'pid' in local_var_params and local_var_params['pid'] is not None: # noqa: E501
+ query_params.append(('pid', local_var_params['pid'])) # noqa: E501
header_params = {}
@@ -2562,6 +2572,256 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, **
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def update_position_cross_mode(self, settle, futures_position_cross_mode, **kwargs): # noqa: E501
+ """Switch Position Margin Mode # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.update_position_cross_mode(settle, futures_position_cross_mode, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param FuturesPositionCrossMode futures_position_cross_mode: (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: gate_api.Position
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.update_position_cross_mode_with_http_info(settle, futures_position_cross_mode, **kwargs) # noqa: E501
+
+ def update_position_cross_mode_with_http_info(self, settle, futures_position_cross_mode, **kwargs): # noqa: E501
+ """Switch Position Margin Mode # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.update_position_cross_mode_with_http_info(settle, futures_position_cross_mode, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param FuturesPositionCrossMode futures_position_cross_mode: (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(gate_api.Position, status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'settle',
+ 'futures_position_cross_mode'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method update_position_cross_mode" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'settle' is set
+ if self.api_client.client_side_validation and ('settle' not in local_var_params or # noqa: E501
+ local_var_params['settle'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `settle` when calling `update_position_cross_mode`") # noqa: E501
+ # verify the required parameter 'futures_position_cross_mode' is set
+ if self.api_client.client_side_validation and ('futures_position_cross_mode' not in local_var_params or # noqa: E501
+ local_var_params['futures_position_cross_mode'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `futures_position_cross_mode` when calling `update_position_cross_mode`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'settle' in local_var_params:
+ path_params['settle'] = local_var_params['settle'] # noqa: E501
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'futures_position_cross_mode' in local_var_params:
+ body_params = local_var_params['futures_position_cross_mode']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/futures/{settle}/positions/cross_mode', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Position', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
+ def update_dual_comp_position_cross_mode(self, settle, inline_object, **kwargs): # noqa: E501
+ """Switch Between Cross and Isolated Margin Modes Under Hedge Mode # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.update_dual_comp_position_cross_mode(settle, inline_object, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param InlineObject inline_object: (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: list[gate_api.Position]
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.update_dual_comp_position_cross_mode_with_http_info(settle, inline_object, **kwargs) # noqa: E501
+
+ def update_dual_comp_position_cross_mode_with_http_info(self, settle, inline_object, **kwargs): # noqa: E501
+ """Switch Between Cross and Isolated Margin Modes Under Hedge Mode # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.update_dual_comp_position_cross_mode_with_http_info(settle, inline_object, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param InlineObject inline_object: (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(list[gate_api.Position], status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'settle',
+ 'inline_object'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method update_dual_comp_position_cross_mode" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'settle' is set
+ if self.api_client.client_side_validation and ('settle' not in local_var_params or # noqa: E501
+ local_var_params['settle'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `settle` when calling `update_dual_comp_position_cross_mode`") # noqa: E501
+ # verify the required parameter 'inline_object' is set
+ if self.api_client.client_side_validation and ('inline_object' not in local_var_params or # noqa: E501
+ local_var_params['inline_object'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `inline_object` when calling `update_dual_comp_position_cross_mode`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'settle' in local_var_params:
+ path_params['settle'] = local_var_params['settle'] # noqa: E501
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'inline_object' in local_var_params:
+ body_params = local_var_params['inline_object']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/futures/{settle}/dual_comp/positions/cross_mode', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[Position]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
def update_position_risk_limit(self, settle, contract, risk_limit, **kwargs): # noqa: E501
"""Update position risk limit # noqa: E501
@@ -2573,7 +2833,7 @@ def update_position_risk_limit(self, settle, contract, risk_limit, **kwargs): #
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str risk_limit: New Risk Limit Value (required)
+ :param str risk_limit: New risk limit value (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2599,7 +2859,7 @@ def update_position_risk_limit_with_http_info(self, settle, contract, risk_limit
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str risk_limit: New Risk Limit Value (required)
+ :param str risk_limit: New risk limit value (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2693,9 +2953,9 @@ def update_position_risk_limit_with_http_info(self, settle, contract, risk_limit
collection_formats=collection_formats)
def set_dual_mode(self, settle, dual_mode, **kwargs): # noqa: E501
- """Enable or disable dual mode # noqa: E501
+ """Set position mode # noqa: E501
- Before setting dual mode, make sure all positions are closed and no orders are open # noqa: E501
+ The prerequisite for changing mode is that all positions have no holdings and no pending orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_dual_mode(settle, dual_mode, async_req=True)
@@ -2719,9 +2979,9 @@ def set_dual_mode(self, settle, dual_mode, **kwargs): # noqa: E501
return self.set_dual_mode_with_http_info(settle, dual_mode, **kwargs) # noqa: E501
def set_dual_mode_with_http_info(self, settle, dual_mode, **kwargs): # noqa: E501
- """Enable or disable dual mode # noqa: E501
+ """Set position mode # noqa: E501
- Before setting dual mode, make sure all positions are closed and no orders are open # noqa: E501
+ The prerequisite for changing mode is that all positions have no holdings and no pending orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_dual_mode_with_http_info(settle, dual_mode, async_req=True)
@@ -2816,7 +3076,7 @@ def set_dual_mode_with_http_info(self, settle, dual_mode, **kwargs): # noqa: E5
collection_formats=collection_formats)
def get_dual_mode_position(self, settle, contract, **kwargs): # noqa: E501
- """Retrieve position detail in dual mode # noqa: E501
+ """Get position information in dual mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2841,7 +3101,7 @@ def get_dual_mode_position(self, settle, contract, **kwargs): # noqa: E501
return self.get_dual_mode_position_with_http_info(settle, contract, **kwargs) # noqa: E501
def get_dual_mode_position_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Retrieve position detail in dual mode # noqa: E501
+ """Get position information in dual mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2947,7 +3207,7 @@ def update_dual_mode_position_margin(self, settle, contract, change, dual_side,
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param str dual_side: Long or short position (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -2974,7 +3234,7 @@ def update_dual_mode_position_margin_with_http_info(self, settle, contract, chan
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str change: Margin change. Use positive number to increase margin, negative number otherwise. (required)
+ :param str change: Margin change amount, positive number increases, negative number decreases (required)
:param str dual_side: Long or short position (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -3087,7 +3347,7 @@ def update_dual_mode_position_leverage(self, settle, contract, leverage, **kwarg
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param str leverage: New position leverage (required)
- :param str cross_leverage_limit: Cross margin leverage(valid only when `leverage` is 0)
+ :param str cross_leverage_limit: Cross margin leverage (valid only when `leverage` is 0)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3114,7 +3374,7 @@ def update_dual_mode_position_leverage_with_http_info(self, settle, contract, le
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
:param str leverage: New position leverage (required)
- :param str cross_leverage_limit: Cross margin leverage(valid only when `leverage` is 0)
+ :param str cross_leverage_limit: Cross margin leverage (valid only when `leverage` is 0)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3221,7 +3481,7 @@ def update_dual_mode_position_risk_limit(self, settle, contract, risk_limit, **k
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str risk_limit: New Risk Limit Value (required)
+ :param str risk_limit: New risk limit value (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3247,7 +3507,7 @@ def update_dual_mode_position_risk_limit_with_http_info(self, settle, contract,
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param str risk_limit: New Risk Limit Value (required)
+ :param str risk_limit: New risk limit value (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3341,7 +3601,7 @@ def update_dual_mode_position_risk_limit_with_http_info(self, settle, contract,
collection_formats=collection_formats)
def list_futures_orders(self, settle, status, **kwargs): # noqa: E501
- """List futures orders # noqa: E501
+ """Query futures order list # noqa: E501
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/orders_timerange`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -3351,11 +3611,11 @@ def list_futures_orders(self, settle, status, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3371,7 +3631,7 @@ def list_futures_orders(self, settle, status, **kwargs): # noqa: E501
return self.list_futures_orders_with_http_info(settle, status, **kwargs) # noqa: E501
def list_futures_orders_with_http_info(self, settle, status, **kwargs): # noqa: E501
- """List futures orders # noqa: E501
+ """Query futures order list # noqa: E501
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/orders_timerange`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -3381,11 +3641,11 @@ def list_futures_orders_with_http_info(self, settle, status, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3490,9 +3750,9 @@ def list_futures_orders_with_http_info(self, settle, status, **kwargs): # noqa:
collection_formats=collection_formats)
def create_futures_order(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a futures order # noqa: E501
+ """Place futures order # noqa: E501
- - Creating futures orders requires `size`, which is number of contracts instead of currency amount. You can use `quanto_multiplier` in contract detail response to know how much currency 1 size contract represents - Zero-filled order cannot be retrieved 10 minutes after order cancellation. You will get a 404 not found for such orders - Set `reduce_only` to `true` can keep the position from changing side when reducing position size - In single position mode, to close a position, you need to set `size` to 0 and `close` to `true` - In dual position mode, to close one side position, you need to set `auto_size` side, `reduce_only` to true and `size` to 0 - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body # noqa: E501
+ - When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_futures_order(settle, futures_order, async_req=True)
@@ -3501,7 +3761,7 @@ def create_futures_order(self, settle, futures_order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param FuturesOrder futures_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3517,9 +3777,9 @@ def create_futures_order(self, settle, futures_order, **kwargs): # noqa: E501
return self.create_futures_order_with_http_info(settle, futures_order, **kwargs) # noqa: E501
def create_futures_order_with_http_info(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a futures order # noqa: E501
+ """Place futures order # noqa: E501
- - Creating futures orders requires `size`, which is number of contracts instead of currency amount. You can use `quanto_multiplier` in contract detail response to know how much currency 1 size contract represents - Zero-filled order cannot be retrieved 10 minutes after order cancellation. You will get a 404 not found for such orders - Set `reduce_only` to `true` can keep the position from changing side when reducing position size - In single position mode, to close a position, you need to set `size` to 0 and `close` to `true` - In dual position mode, to close one side position, you need to set `auto_size` side, `reduce_only` to true and `size` to 0 - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body # noqa: E501
+ - When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_futures_order_with_http_info(settle, futures_order, async_req=True)
@@ -3528,7 +3788,7 @@ def create_futures_order_with_http_info(self, settle, futures_order, **kwargs):
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param FuturesOrder futures_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3622,9 +3882,9 @@ def create_futures_order_with_http_info(self, settle, futures_order, **kwargs):
collection_formats=collection_formats)
def cancel_futures_orders(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_futures_orders(settle, contract, async_req=True)
@@ -3633,8 +3893,10 @@ def cancel_futures_orders(self, settle, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
- :param str side: All bids or asks. Both included if not specified
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str side: Specify all buy orders or all sell orders, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell orders
+ :param bool exclude_reduce_only: Whether to exclude reduce-only orders
+ :param str text: Remark for order cancellation
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3650,9 +3912,9 @@ def cancel_futures_orders(self, settle, contract, **kwargs): # noqa: E501
return self.cancel_futures_orders_with_http_info(settle, contract, **kwargs) # noqa: E501
def cancel_futures_orders_with_http_info(self, settle, contract, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
- Zero-filled order cannot be retrieved 10 minutes after order cancellation # noqa: E501
+ Zero-fill orders cannot be retrieved 10 minutes after order cancellation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_futures_orders_with_http_info(settle, contract, async_req=True)
@@ -3661,8 +3923,10 @@ def cancel_futures_orders_with_http_info(self, settle, contract, **kwargs): # n
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
- :param str side: All bids or asks. Both included if not specified
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str side: Specify all buy orders or all sell orders, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell orders
+ :param bool exclude_reduce_only: Whether to exclude reduce-only orders
+ :param str text: Remark for order cancellation
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3683,7 +3947,9 @@ def cancel_futures_orders_with_http_info(self, settle, contract, **kwargs): # n
'settle',
'contract',
'x_gate_exptime',
- 'side'
+ 'side',
+ 'exclude_reduce_only',
+ 'text'
]
all_params.extend(
[
@@ -3722,6 +3988,10 @@ def cancel_futures_orders_with_http_info(self, settle, contract, **kwargs): # n
query_params.append(('contract', local_var_params['contract'])) # noqa: E501
if 'side' in local_var_params and local_var_params['side'] is not None: # noqa: E501
query_params.append(('side', local_var_params['side'])) # noqa: E501
+ if 'exclude_reduce_only' in local_var_params and local_var_params['exclude_reduce_only'] is not None: # noqa: E501
+ query_params.append(('exclude_reduce_only', local_var_params['exclude_reduce_only'])) # noqa: E501
+ if 'text' in local_var_params and local_var_params['text'] is not None: # noqa: E501
+ query_params.append(('text', local_var_params['text'])) # noqa: E501
header_params = {}
if 'x_gate_exptime' in local_var_params:
@@ -3755,7 +4025,7 @@ def cancel_futures_orders_with_http_info(self, settle, contract, **kwargs): # n
collection_formats=collection_formats)
def get_orders_with_time_range(self, settle, **kwargs): # noqa: E501
- """List Futures Orders By Time Range # noqa: E501
+ """Query futures order list by time range # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3765,9 +4035,9 @@ def get_orders_with_time_range(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -3784,7 +4054,7 @@ def get_orders_with_time_range(self, settle, **kwargs): # noqa: E501
return self.get_orders_with_time_range_with_http_info(settle, **kwargs) # noqa: E501
def get_orders_with_time_range_with_http_info(self, settle, **kwargs): # noqa: E501
- """List Futures Orders By Time Range # noqa: E501
+ """Query futures order list by time range # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3794,9 +4064,9 @@ def get_orders_with_time_range_with_http_info(self, settle, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -3898,7 +4168,7 @@ def get_orders_with_time_range_with_http_info(self, settle, **kwargs): # noqa:
collection_formats=collection_formats)
def create_batch_futures_order(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a batch of futures orders # noqa: E501
+ """Place batch futures orders # noqa: E501
- Up to 10 orders per request - If any of the order's parameters are missing or in the wrong format, all of them will not be executed, and a http status 400 error will be returned directly - If the parameters are checked and passed, all are executed. Even if there is a business logic error in the middle (such as insufficient funds), it will not affect other execution orders - The returned result is in array format, and the order corresponds to the orders in the request body - In the returned result, the `succeeded` field of type bool indicates whether the execution was successful or not - If the execution is successful, the normal order content is included; if the execution fails, the `label` field is included to indicate the cause of the error - In the rate limiting, each order is counted individually # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -3909,7 +4179,7 @@ def create_batch_futures_order(self, settle, futures_order, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[FuturesOrder] futures_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3925,7 +4195,7 @@ def create_batch_futures_order(self, settle, futures_order, **kwargs): # noqa:
return self.create_batch_futures_order_with_http_info(settle, futures_order, **kwargs) # noqa: E501
def create_batch_futures_order_with_http_info(self, settle, futures_order, **kwargs): # noqa: E501
- """Create a batch of futures orders # noqa: E501
+ """Place batch futures orders # noqa: E501
- Up to 10 orders per request - If any of the order's parameters are missing or in the wrong format, all of them will not be executed, and a http status 400 error will be returned directly - If the parameters are checked and passed, all are executed. Even if there is a business logic error in the middle (such as insufficient funds), it will not affect other execution orders - The returned result is in array format, and the order corresponds to the orders in the request body - In the returned result, the `succeeded` field of type bool indicates whether the execution was successful or not - If the execution is successful, the normal order content is included; if the execution fails, the `label` field is included to indicate the cause of the error - In the rate limiting, each order is counted individually # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -3936,7 +4206,7 @@ def create_batch_futures_order_with_http_info(self, settle, futures_order, **kwa
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[FuturesOrder] futures_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4030,7 +4300,7 @@ def create_batch_futures_order_with_http_info(self, settle, futures_order, **kwa
collection_formats=collection_formats)
def get_futures_order(self, settle, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -4040,7 +4310,7 @@ def get_futures_order(self, settle, order_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -4056,7 +4326,7 @@ def get_futures_order(self, settle, order_id, **kwargs): # noqa: E501
return self.get_futures_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def get_futures_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -4066,7 +4336,7 @@ def get_futures_order_with_http_info(self, settle, order_id, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4153,7 +4423,7 @@ def get_futures_order_with_http_info(self, settle, order_id, **kwargs): # noqa:
collection_formats=collection_formats)
def amend_futures_order(self, settle, order_id, futures_order_amendment, **kwargs): # noqa: E501
- """Amend an order # noqa: E501
+ """Amend single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4162,9 +4432,9 @@ def amend_futures_order(self, settle, order_id, futures_order_amendment, **kwarg
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
:param FuturesOrderAmendment futures_order_amendment: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -4180,7 +4450,7 @@ def amend_futures_order(self, settle, order_id, futures_order_amendment, **kwarg
return self.amend_futures_order_with_http_info(settle, order_id, futures_order_amendment, **kwargs) # noqa: E501
def amend_futures_order_with_http_info(self, settle, order_id, futures_order_amendment, **kwargs): # noqa: E501
- """Amend an order # noqa: E501
+ """Amend single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4189,9 +4459,9 @@ def amend_futures_order_with_http_info(self, settle, order_id, futures_order_ame
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
:param FuturesOrderAmendment futures_order_amendment: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4292,7 +4562,7 @@ def amend_futures_order_with_http_info(self, settle, order_id, futures_order_ame
collection_formats=collection_formats)
def cancel_futures_order(self, settle, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4301,8 +4571,8 @@ def cancel_futures_order(self, settle, order_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -4318,7 +4588,7 @@ def cancel_futures_order(self, settle, order_id, **kwargs): # noqa: E501
return self.cancel_futures_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def cancel_futures_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4327,8 +4597,8 @@ def cancel_futures_order_with_http_info(self, settle, order_id, **kwargs): # no
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4418,7 +4688,7 @@ def cancel_futures_order_with_http_info(self, settle, order_id, **kwargs): # no
collection_formats=collection_formats)
def get_my_trades(self, settle, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
By default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/my_trades_timerange`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -4430,7 +4700,7 @@ def get_my_trades(self, settle, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
:param int order: Futures order ID, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. If you need to iterate through and retrieve more records, we recommend using 'GET /futures/{settle}/my_trades_timerange'.
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4448,7 +4718,7 @@ def get_my_trades(self, settle, **kwargs): # noqa: E501
return self.get_my_trades_with_http_info(settle, **kwargs) # noqa: E501
def get_my_trades_with_http_info(self, settle, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
By default, only data within the past 6 months is supported. If you need to query data for a longer period, please use `GET /futures/{settle}/my_trades_timerange`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -4460,7 +4730,7 @@ def get_my_trades_with_http_info(self, settle, **kwargs): # noqa: E501
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
:param int order: Futures order ID, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param str last_id: Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. If you need to iterate through and retrieve more records, we recommend using 'GET /futures/{settle}/my_trades_timerange'.
:param _return_http_data_only: response data without head status code
@@ -4563,7 +4833,7 @@ def get_my_trades_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_my_trades_with_time_range(self, settle, **kwargs): # noqa: E501
- """List personal trading history by time range # noqa: E501
+ """Query personal trading records by time range # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4573,11 +4843,11 @@ def get_my_trades_with_time_range(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str role: Query role, maker or taker.
+ :param str role: Query role, maker or taker
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -4593,7 +4863,7 @@ def get_my_trades_with_time_range(self, settle, **kwargs): # noqa: E501
return self.get_my_trades_with_time_range_with_http_info(settle, **kwargs) # noqa: E501
def get_my_trades_with_time_range_with_http_info(self, settle, **kwargs): # noqa: E501
- """List personal trading history by time range # noqa: E501
+ """Query personal trading records by time range # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4603,11 +4873,11 @@ def get_my_trades_with_time_range_with_http_info(self, settle, **kwargs): # noq
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param str role: Query role, maker or taker.
+ :param str role: Query role, maker or taker
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4711,7 +4981,7 @@ def get_my_trades_with_time_range_with_http_info(self, settle, **kwargs): # noq
collection_formats=collection_formats)
def list_position_close(self, settle, **kwargs): # noqa: E501
- """List position close history # noqa: E501
+ """Query position close history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4721,11 +4991,11 @@ def list_position_close(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str side: Query side. long or shot
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str side: Query side. long or shot
:param str pnl: Query profit or loss
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -4742,7 +5012,7 @@ def list_position_close(self, settle, **kwargs): # noqa: E501
return self.list_position_close_with_http_info(settle, **kwargs) # noqa: E501
def list_position_close_with_http_info(self, settle, **kwargs): # noqa: E501
- """List position close history # noqa: E501
+ """Query position close history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4752,11 +5022,11 @@ def list_position_close_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str side: Query side. long or shot
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str side: Query side. long or shot
:param str pnl: Query profit or loss
:param _return_http_data_only: response data without head status code
and headers
@@ -4864,7 +5134,7 @@ def list_position_close_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_liquidates(self, settle, **kwargs): # noqa: E501
- """List liquidation history # noqa: E501
+ """Query liquidation history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4874,8 +5144,11 @@ def list_liquidates(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a liquidation timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int at: Specify liquidation timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -4891,7 +5164,7 @@ def list_liquidates(self, settle, **kwargs): # noqa: E501
return self.list_liquidates_with_http_info(settle, **kwargs) # noqa: E501
def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
- """List liquidation history # noqa: E501
+ """Query liquidation history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -4901,8 +5174,11 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify a liquidation timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int at: Specify liquidation timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4923,6 +5199,9 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
'settle',
'contract',
'limit',
+ 'offset',
+ '_from',
+ 'to',
'at'
]
all_params.extend(
@@ -4951,6 +5230,8 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
raise ApiValueError("Invalid value for parameter `limit` when calling `list_liquidates`, must be a value less than or equal to `1000`") # noqa: E501
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
raise ApiValueError("Invalid value for parameter `limit` when calling `list_liquidates`, must be a value greater than or equal to `1`") # noqa: E501
+ if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `offset` when calling `list_liquidates`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
@@ -4962,6 +5243,12 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
query_params.append(('contract', local_var_params['contract'])) # noqa: E501
if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
+ if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
+ query_params.append(('offset', local_var_params['offset'])) # noqa: E501
+ if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
+ query_params.append(('from', local_var_params['_from'])) # noqa: E501
+ if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
+ query_params.append(('to', local_var_params['to'])) # noqa: E501
if 'at' in local_var_params and local_var_params['at'] is not None: # noqa: E501
query_params.append(('at', local_var_params['at'])) # noqa: E501
@@ -4995,7 +5282,7 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_auto_deleverages(self, settle, **kwargs): # noqa: E501
- """List Auto-Deleveraging History # noqa: E501
+ """Query ADL auto-deleveraging order information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5005,8 +5292,11 @@ def list_auto_deleverages(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify an auto-deleveraging timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int at: Specify auto-deleveraging timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -5022,7 +5312,7 @@ def list_auto_deleverages(self, settle, **kwargs): # noqa: E501
return self.list_auto_deleverages_with_http_info(settle, **kwargs) # noqa: E501
def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
- """List Auto-Deleveraging History # noqa: E501
+ """Query ADL auto-deleveraging order information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5032,8 +5322,11 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
- :param int at: Specify an auto-deleveraging timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param int at: Specify auto-deleveraging timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -5054,6 +5347,9 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
'settle',
'contract',
'limit',
+ 'offset',
+ '_from',
+ 'to',
'at'
]
all_params.extend(
@@ -5082,6 +5378,8 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
raise ApiValueError("Invalid value for parameter `limit` when calling `list_auto_deleverages`, must be a value less than or equal to `1000`") # noqa: E501
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
raise ApiValueError("Invalid value for parameter `limit` when calling `list_auto_deleverages`, must be a value greater than or equal to `1`") # noqa: E501
+ if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `offset` when calling `list_auto_deleverages`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
@@ -5093,6 +5391,12 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
query_params.append(('contract', local_var_params['contract'])) # noqa: E501
if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
+ if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
+ query_params.append(('offset', local_var_params['offset'])) # noqa: E501
+ if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
+ query_params.append(('from', local_var_params['_from'])) # noqa: E501
+ if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
+ query_params.append(('to', local_var_params['to'])) # noqa: E501
if 'at' in local_var_params and local_var_params['at'] is not None: # noqa: E501
query_params.append(('at', local_var_params['at'])) # noqa: E501
@@ -5128,7 +5432,7 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501
def countdown_cancel_all_futures(self, settle, countdown_cancel_all_futures_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. # noqa: E501
+ Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_futures(settle, countdown_cancel_all_futures_task, async_req=True)
@@ -5154,7 +5458,7 @@ def countdown_cancel_all_futures(self, settle, countdown_cancel_all_futures_task
def countdown_cancel_all_futures_with_http_info(self, settle, countdown_cancel_all_futures_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. # noqa: E501
+ Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_futures_with_http_info(settle, countdown_cancel_all_futures_task, async_req=True)
@@ -5253,7 +5557,7 @@ def countdown_cancel_all_futures_with_http_info(self, settle, countdown_cancel_a
collection_formats=collection_formats)
def get_futures_fee(self, settle, **kwargs): # noqa: E501
- """Query user trading fee rates # noqa: E501
+ """Query futures market trading fee rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5278,7 +5582,7 @@ def get_futures_fee(self, settle, **kwargs): # noqa: E501
return self.get_futures_fee_with_http_info(settle, **kwargs) # noqa: E501
def get_futures_fee_with_http_info(self, settle, **kwargs): # noqa: E501
- """Query user trading fee rates # noqa: E501
+ """Query futures market trading fee rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5370,9 +5674,9 @@ def get_futures_fee_with_http_info(self, settle, **kwargs): # noqa: E501
collection_formats=collection_formats)
def cancel_batch_future_orders(self, settle, request_body, **kwargs): # noqa: E501
- """Cancel a batch of orders with an ID list # noqa: E501
+ """Cancel batch orders by specified ID list # noqa: E501
- Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. # noqa: E501
+ Multiple different order IDs can be specified, maximum 20 records per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_batch_future_orders(settle, request_body, async_req=True)
@@ -5381,7 +5685,7 @@ def cancel_batch_future_orders(self, settle, request_body, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[str] request_body: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -5397,9 +5701,9 @@ def cancel_batch_future_orders(self, settle, request_body, **kwargs): # noqa: E
return self.cancel_batch_future_orders_with_http_info(settle, request_body, **kwargs) # noqa: E501
def cancel_batch_future_orders_with_http_info(self, settle, request_body, **kwargs): # noqa: E501
- """Cancel a batch of orders with an ID list # noqa: E501
+ """Cancel batch orders by specified ID list # noqa: E501
- Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. # noqa: E501
+ Multiple different order IDs can be specified, maximum 20 records per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_batch_future_orders_with_http_info(settle, request_body, async_req=True)
@@ -5408,7 +5712,7 @@ def cancel_batch_future_orders_with_http_info(self, settle, request_body, **kwar
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[str] request_body: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -5502,9 +5806,9 @@ def cancel_batch_future_orders_with_http_info(self, settle, request_body, **kwar
collection_formats=collection_formats)
def amend_batch_future_orders(self, settle, batch_amend_order_req, **kwargs): # noqa: E501
- """Batch modify orders with specified IDs # noqa: E501
+ """Batch modify orders by specified IDs # noqa: E501
- You can specify multiple different order IDs. You can only modify up to 10 orders in one request. # noqa: E501
+ Multiple different order IDs can be specified, maximum 10 orders per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_batch_future_orders(settle, batch_amend_order_req, async_req=True)
@@ -5513,7 +5817,7 @@ def amend_batch_future_orders(self, settle, batch_amend_order_req, **kwargs): #
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[BatchAmendOrderReq] batch_amend_order_req: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -5529,9 +5833,9 @@ def amend_batch_future_orders(self, settle, batch_amend_order_req, **kwargs): #
return self.amend_batch_future_orders_with_http_info(settle, batch_amend_order_req, **kwargs) # noqa: E501
def amend_batch_future_orders_with_http_info(self, settle, batch_amend_order_req, **kwargs): # noqa: E501
- """Batch modify orders with specified IDs # noqa: E501
+ """Batch modify orders by specified IDs # noqa: E501
- You can specify multiple different order IDs. You can only modify up to 10 orders in one request. # noqa: E501
+ Multiple different order IDs can be specified, maximum 10 orders per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_batch_future_orders_with_http_info(settle, batch_amend_order_req, async_req=True)
@@ -5540,7 +5844,7 @@ def amend_batch_future_orders_with_http_info(self, settle, batch_amend_order_req
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
:param list[BatchAmendOrderReq] batch_amend_order_req: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -5633,8 +5937,131 @@ def amend_batch_future_orders_with_http_info(self, settle, batch_amend_order_req
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def get_futures_risk_limit_table(self, settle, table_id, **kwargs): # noqa: E501
+ """Query risk limit table by table_id # noqa: E501
+
+ Just pass table_id # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.get_futures_risk_limit_table(settle, table_id, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param str table_id: Risk limit table ID (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: list[gate_api.FuturesRiskLimitTier]
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.get_futures_risk_limit_table_with_http_info(settle, table_id, **kwargs) # noqa: E501
+
+ def get_futures_risk_limit_table_with_http_info(self, settle, table_id, **kwargs): # noqa: E501
+ """Query risk limit table by table_id # noqa: E501
+
+ Just pass table_id # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.get_futures_risk_limit_table_with_http_info(settle, table_id, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str settle: Settle currency (required)
+ :param str table_id: Risk limit table ID (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(list[gate_api.FuturesRiskLimitTier], status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'settle',
+ 'table_id'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method get_futures_risk_limit_table" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'settle' is set
+ if self.api_client.client_side_validation and ('settle' not in local_var_params or # noqa: E501
+ local_var_params['settle'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `settle` when calling `get_futures_risk_limit_table`") # noqa: E501
+ # verify the required parameter 'table_id' is set
+ if self.api_client.client_side_validation and ('table_id' not in local_var_params or # noqa: E501
+ local_var_params['table_id'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `table_id` when calling `get_futures_risk_limit_table`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+ if 'settle' in local_var_params:
+ path_params['settle'] = local_var_params['settle'] # noqa: E501
+
+ query_params = []
+ if 'table_id' in local_var_params and local_var_params['table_id'] is not None: # noqa: E501
+ query_params.append(('table_id', local_var_params['table_id'])) # noqa: E501
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = [] # noqa: E501
+
+ return self.api_client.call_api(
+ '/futures/{settle}/risk_limit_table', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[FuturesRiskLimitTier]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
def list_price_triggered_orders(self, settle, status, **kwargs): # noqa: E501
- """List all auto orders # noqa: E501
+ """Query auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5643,9 +6070,9 @@ def list_price_triggered_orders(self, settle, status, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -5662,7 +6089,7 @@ def list_price_triggered_orders(self, settle, status, **kwargs): # noqa: E501
return self.list_price_triggered_orders_with_http_info(settle, status, **kwargs) # noqa: E501
def list_price_triggered_orders_with_http_info(self, settle, status, **kwargs): # noqa: E501
- """List all auto orders # noqa: E501
+ """Query auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5671,9 +6098,9 @@ def list_price_triggered_orders_with_http_info(self, settle, status, **kwargs):
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Futures contract, return related data only if specified
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -5776,7 +6203,7 @@ def list_price_triggered_orders_with_http_info(self, settle, status, **kwargs):
collection_formats=collection_formats)
def create_price_triggered_order(self, settle, futures_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5801,7 +6228,7 @@ def create_price_triggered_order(self, settle, futures_price_triggered_order, **
return self.create_price_triggered_order_with_http_info(settle, futures_price_triggered_order, **kwargs) # noqa: E501
def create_price_triggered_order_with_http_info(self, settle, futures_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5901,7 +6328,7 @@ def create_price_triggered_order_with_http_info(self, settle, futures_price_trig
collection_formats=collection_formats)
def cancel_price_triggered_order_list(self, settle, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -5926,7 +6353,7 @@ def cancel_price_triggered_order_list(self, settle, **kwargs): # noqa: E501
return self.cancel_price_triggered_order_list_with_http_info(settle, **kwargs) # noqa: E501
def cancel_price_triggered_order_list_with_http_info(self, settle, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -6018,7 +6445,7 @@ def cancel_price_triggered_order_list_with_http_info(self, settle, **kwargs): #
collection_formats=collection_formats)
def get_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -6027,7 +6454,7 @@ def get_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -6043,7 +6470,7 @@ def get_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E501
return self.get_price_triggered_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def get_price_triggered_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -6052,7 +6479,7 @@ def get_price_triggered_order_with_http_info(self, settle, order_id, **kwargs):
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -6139,7 +6566,7 @@ def get_price_triggered_order_with_http_info(self, settle, order_id, **kwargs):
collection_formats=collection_formats)
def cancel_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -6148,7 +6575,7 @@ def cancel_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E50
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -6164,7 +6591,7 @@ def cancel_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E50
return self.cancel_price_triggered_order_with_http_info(settle, order_id, **kwargs) # noqa: E501
def cancel_price_triggered_order_with_http_info(self, settle, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -6173,7 +6600,7 @@ def cancel_price_triggered_order_with_http_info(self, settle, order_id, **kwargs
:param bool async_req: execute request asynchronously
:param str settle: Settle currency (required)
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/gate_api/api/margin_api.py b/gate_api/api/margin_api.py
index ca083e6..9464f10 100644
--- a/gate_api/api/margin_api.py
+++ b/gate_api/api/margin_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -145,22 +145,22 @@ def list_margin_accounts_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_margin_account_book(self, **kwargs): # noqa: E501
- """List margin account balance change history # noqa: E501
+ """Query margin account balance change history # noqa: E501
- Only transferals from and to margin account are provided for now. Time range allows 30 days at most # noqa: E501
+ Currently only provides transfer history to and from margin accounts. Query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_margin_account_book(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: List records related to specified currency only. If specified, `currency_pair` is also required.
- :param str currency_pair: List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str currency: Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified.
+ :param str currency_pair: Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified
+ :param str type: Query by specified account change type. If not specified, all change types will be included.
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -176,22 +176,22 @@ def list_margin_account_book(self, **kwargs): # noqa: E501
return self.list_margin_account_book_with_http_info(**kwargs) # noqa: E501
def list_margin_account_book_with_http_info(self, **kwargs): # noqa: E501
- """List margin account balance change history # noqa: E501
+ """Query margin account balance change history # noqa: E501
- Only transferals from and to margin account are provided for now. Time range allows 30 days at most # noqa: E501
+ Currently only provides transfer history to and from margin accounts. Query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_margin_account_book_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: List records related to specified currency only. If specified, `currency_pair` is also required.
- :param str currency_pair: List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str currency: Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified.
+ :param str currency_pair: Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified
+ :param str type: Query by specified account change type. If not specified, all change types will be included.
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -299,7 +299,7 @@ def list_funding_accounts(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -323,7 +323,7 @@ def list_funding_accounts_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -399,7 +399,7 @@ def list_funding_accounts_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_auto_repay_status(self, **kwargs): # noqa: E501
- """Retrieve user auto repayment setting # noqa: E501
+ """Query user auto repayment settings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -422,7 +422,7 @@ def get_auto_repay_status(self, **kwargs): # noqa: E501
return self.get_auto_repay_status_with_http_info(**kwargs) # noqa: E501
def get_auto_repay_status_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve user auto repayment setting # noqa: E501
+ """Query user auto repayment settings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -502,7 +502,7 @@ def get_auto_repay_status_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def set_auto_repay(self, status, **kwargs): # noqa: E501
- """Update user's auto repayment setting # noqa: E501
+ """Update user auto repayment settings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -510,7 +510,7 @@ def set_auto_repay(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: New auto repayment status. `on` - enabled, `off` - disabled (required)
+ :param str status: Whether to enable auto repayment: `on` - enabled, `off` - disabled (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -526,7 +526,7 @@ def set_auto_repay(self, status, **kwargs): # noqa: E501
return self.set_auto_repay_with_http_info(status, **kwargs) # noqa: E501
def set_auto_repay_with_http_info(self, status, **kwargs): # noqa: E501
- """Update user's auto repayment setting # noqa: E501
+ """Update user auto repayment settings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -534,7 +534,7 @@ def set_auto_repay_with_http_info(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: New auto repayment status. `on` - enabled, `off` - disabled (required)
+ :param str status: Whether to enable auto repayment: `on` - enabled, `off` - disabled (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -614,7 +614,7 @@ def set_auto_repay_with_http_info(self, status, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_margin_transferable(self, currency, **kwargs): # noqa: E501
- """Get the max transferable amount for a specific margin currency # noqa: E501
+ """Get maximum transferable amount for isolated margin # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -622,7 +622,7 @@ def get_margin_transferable(self, currency, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currency: Query by specified currency name (required)
:param str currency_pair: Currency pair
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -639,7 +639,7 @@ def get_margin_transferable(self, currency, **kwargs): # noqa: E501
return self.get_margin_transferable_with_http_info(currency, **kwargs) # noqa: E501
def get_margin_transferable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get the max transferable amount for a specific margin currency # noqa: E501
+ """Get maximum transferable amount for isolated margin # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -647,7 +647,7 @@ def get_margin_transferable_with_http_info(self, currency, **kwargs): # noqa: E
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currency: Query by specified currency name (required)
:param str currency_pair: Currency pair
:param _return_http_data_only: response data without head status code
and headers
@@ -730,15 +730,16 @@ def get_margin_transferable_with_http_info(self, currency, **kwargs): # noqa: E
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def list_margin_currency_pairs(self, **kwargs): # noqa: E501
- """List all supported currency pairs supported in margin trading(Deprecated) # noqa: E501
+ def get_user_margin_tier(self, currency_pair, **kwargs): # noqa: E501
+ """Query user's own leverage lending tiers in current market # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_margin_currency_pairs(async_req=True)
+ >>> thread = api.get_user_margin_tier(currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param str currency_pair: Currency pair (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -746,22 +747,23 @@ def list_margin_currency_pairs(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.MarginCurrencyPair]
+ :rtype: list[gate_api.MarginLeverageTier]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.list_margin_currency_pairs_with_http_info(**kwargs) # noqa: E501
+ return self.get_user_margin_tier_with_http_info(currency_pair, **kwargs) # noqa: E501
- def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
- """List all supported currency pairs supported in margin trading(Deprecated) # noqa: E501
+ def get_user_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: E501
+ """Query user's own leverage lending tiers in current market # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_margin_currency_pairs_with_http_info(async_req=True)
+ >>> thread = api.get_user_margin_tier_with_http_info(currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param str currency_pair: Currency pair (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -771,7 +773,7 @@ def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.MarginCurrencyPair], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.MarginLeverageTier], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -779,6 +781,7 @@ def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ 'currency_pair'
]
all_params.extend(
[
@@ -793,16 +796,22 @@ def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method list_margin_currency_pairs" % k
+ " to method get_user_margin_tier" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
+ # verify the required parameter 'currency_pair' is set
+ if self.api_client.client_side_validation and ('currency_pair' not in local_var_params or # noqa: E501
+ local_var_params['currency_pair'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currency_pair` when calling `get_user_margin_tier`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
+ if 'currency_pair' in local_var_params and local_var_params['currency_pair'] is not None: # noqa: E501
+ query_params.append(('currency_pair', local_var_params['currency_pair'])) # noqa: E501
header_params = {}
@@ -815,17 +824,17 @@ def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
- auth_settings = [] # noqa: E501
+ auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/margin/currency_pairs', 'GET',
+ '/margin/user/loan_margin_tiers', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[MarginCurrencyPair]', # noqa: E501
+ response_type='list[MarginLeverageTier]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -833,16 +842,16 @@ def list_margin_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_margin_currency_pair(self, currency_pair, **kwargs): # noqa: E501
- """Query one single margin currency pair(Deprecated) # noqa: E501
+ def get_market_margin_tier(self, currency_pair, **kwargs): # noqa: E501
+ """Query current market leverage lending tiers # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_margin_currency_pair(currency_pair, async_req=True)
+ >>> thread = api.get_market_margin_tier(currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Margin currency pair (required)
+ :param str currency_pair: Currency pair (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -850,23 +859,23 @@ def get_margin_currency_pair(self, currency_pair, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.MarginCurrencyPair
+ :rtype: list[gate_api.MarginLeverageTier]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.get_margin_currency_pair_with_http_info(currency_pair, **kwargs) # noqa: E501
+ return self.get_market_margin_tier_with_http_info(currency_pair, **kwargs) # noqa: E501
- def get_margin_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Query one single margin currency pair(Deprecated) # noqa: E501
+ def get_market_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: E501
+ """Query current market leverage lending tiers # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_margin_currency_pair_with_http_info(currency_pair, async_req=True)
+ >>> thread = api.get_market_margin_tier_with_http_info(currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Margin currency pair (required)
+ :param str currency_pair: Currency pair (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -876,7 +885,7 @@ def get_margin_currency_pair_with_http_info(self, currency_pair, **kwargs): # n
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.MarginCurrencyPair, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.MarginLeverageTier], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -899,22 +908,22 @@ def get_margin_currency_pair_with_http_info(self, currency_pair, **kwargs): # n
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_margin_currency_pair" % k
+ " to method get_market_margin_tier" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
# verify the required parameter 'currency_pair' is set
if self.api_client.client_side_validation and ('currency_pair' not in local_var_params or # noqa: E501
local_var_params['currency_pair'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency_pair` when calling `get_margin_currency_pair`") # noqa: E501
+ raise ApiValueError("Missing the required parameter `currency_pair` when calling `get_market_margin_tier`") # noqa: E501
collection_formats = {}
path_params = {}
- if 'currency_pair' in local_var_params:
- path_params['currency_pair'] = local_var_params['currency_pair'] # noqa: E501
query_params = []
+ if 'currency_pair' in local_var_params and local_var_params['currency_pair'] is not None: # noqa: E501
+ query_params.append(('currency_pair', local_var_params['currency_pair'])) # noqa: E501
header_params = {}
@@ -930,14 +939,14 @@ def get_margin_currency_pair_with_http_info(self, currency_pair, **kwargs): # n
auth_settings = [] # noqa: E501
return self.api_client.call_api(
- '/margin/currency_pairs/{currency_pair}', 'GET',
+ '/margin/loan_margin_tiers', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='MarginCurrencyPair', # noqa: E501
+ response_type='list[MarginLeverageTier]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -945,16 +954,16 @@ def get_margin_currency_pair_with_http_info(self, currency_pair, **kwargs): # n
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def list_funding_book(self, currency, **kwargs): # noqa: E501
- """Order book of lending loans(Deprecated) # noqa: E501
+ def set_user_market_leverage(self, margin_market_leverage, **kwargs): # noqa: E501
+ """Set user market leverage multiplier # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_funding_book(currency, async_req=True)
+ >>> thread = api.set_user_market_leverage(margin_market_leverage, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param MarginMarketLeverage margin_market_leverage: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -962,23 +971,23 @@ def list_funding_book(self, currency, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.FundingBookItem]
+ :rtype: None
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.list_funding_book_with_http_info(currency, **kwargs) # noqa: E501
+ return self.set_user_market_leverage_with_http_info(margin_market_leverage, **kwargs) # noqa: E501
- def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
- """Order book of lending loans(Deprecated) # noqa: E501
+ def set_user_market_leverage_with_http_info(self, margin_market_leverage, **kwargs): # noqa: E501
+ """Set user market leverage multiplier # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_funding_book_with_http_info(currency, async_req=True)
+ >>> thread = api.set_user_market_leverage_with_http_info(margin_market_leverage, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param MarginMarketLeverage margin_market_leverage: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -988,7 +997,7 @@ def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.FundingBookItem], status_code(int), headers(HTTPHeaderDict))
+ :rtype: None
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -996,7 +1005,7 @@ def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
- 'currency'
+ 'margin_market_leverage'
]
all_params.extend(
[
@@ -1011,22 +1020,20 @@ def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method list_funding_book" % k
+ " to method set_user_market_leverage" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `list_funding_book`") # noqa: E501
+ # verify the required parameter 'margin_market_leverage' is set
+ if self.api_client.client_side_validation and ('margin_market_leverage' not in local_var_params or # noqa: E501
+ local_var_params['margin_market_leverage'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `margin_market_leverage` when calling `set_user_market_leverage`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
header_params = {}
@@ -1034,22 +1041,24 @@ def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
local_var_files = {}
body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
+ if 'margin_market_leverage' in local_var_params:
+ body_params = local_var_params['margin_market_leverage']
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
- auth_settings = [] # noqa: E501
+ auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/margin/funding_book', 'GET',
+ '/margin/leverage/user_market_setting', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[FundingBookItem]', # noqa: E501
+ response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -1057,23 +1066,17 @@ def list_funding_book_with_http_info(self, currency, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def list_loans(self, status, side, **kwargs): # noqa: E501
- """List all loans(Deprecated) # noqa: E501
+ def list_margin_user_account(self, **kwargs): # noqa: E501
+ """Query user's isolated margin account list # noqa: E501
+ Supports querying risk ratio isolated accounts and margin ratio isolated accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loans(status, side, async_req=True)
+ >>> thread = api.list_margin_user_account(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Loan status (required)
- :param str side: Lend or borrow (required)
- :param str currency: Retrieve data of the specified currency
:param str currency_pair: Currency pair
- :param str sort_by: Specify which field is used to sort. `create_time` or `rate` is supported. Default to `create_time`
- :param bool reverse_sort: Whether to sort in descending order. Default to `true`
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1081,30 +1084,24 @@ def list_loans(self, status, side, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.Loan]
+ :rtype: list[gate_api.MarginAccount]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.list_loans_with_http_info(status, side, **kwargs) # noqa: E501
+ return self.list_margin_user_account_with_http_info(**kwargs) # noqa: E501
- def list_loans_with_http_info(self, status, side, **kwargs): # noqa: E501
- """List all loans(Deprecated) # noqa: E501
+ def list_margin_user_account_with_http_info(self, **kwargs): # noqa: E501
+ """Query user's isolated margin account list # noqa: E501
+ Supports querying risk ratio isolated accounts and margin ratio isolated accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loans_with_http_info(status, side, async_req=True)
+ >>> thread = api.list_margin_user_account_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Loan status (required)
- :param str side: Lend or borrow (required)
- :param str currency: Retrieve data of the specified currency
:param str currency_pair: Currency pair
- :param str sort_by: Specify which field is used to sort. `create_time` or `rate` is supported. Default to `create_time`
- :param bool reverse_sort: Whether to sort in descending order. Default to `true`
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1114,7 +1111,7 @@ def list_loans_with_http_info(self, status, side, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.Loan], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.MarginAccount], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1122,14 +1119,7 @@ def list_loans_with_http_info(self, status, side, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
- 'status',
- 'side',
- 'currency',
- 'currency_pair',
- 'sort_by',
- 'reverse_sort',
- 'page',
- 'limit'
+ 'currency_pair'
]
all_params.extend(
[
@@ -1144,156 +1134,18 @@ def list_loans_with_http_info(self, status, side, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method list_loans" % k
+ " to method list_margin_user_account" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'status' is set
- if self.api_client.client_side_validation and ('status' not in local_var_params or # noqa: E501
- local_var_params['status'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `status` when calling `list_loans`") # noqa: E501
- # verify the required parameter 'side' is set
- if self.api_client.client_side_validation and ('side' not in local_var_params or # noqa: E501
- local_var_params['side'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `side` when calling `list_loans`") # noqa: E501
- if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `page` when calling `list_loans`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_loans`, must be a value less than or equal to `1000`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_loans`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
- if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501
- query_params.append(('status', local_var_params['status'])) # noqa: E501
- if 'side' in local_var_params and local_var_params['side'] is not None: # noqa: E501
- query_params.append(('side', local_var_params['side'])) # noqa: E501
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
if 'currency_pair' in local_var_params and local_var_params['currency_pair'] is not None: # noqa: E501
query_params.append(('currency_pair', local_var_params['currency_pair'])) # noqa: E501
- if 'sort_by' in local_var_params and local_var_params['sort_by'] is not None: # noqa: E501
- query_params.append(('sort_by', local_var_params['sort_by'])) # noqa: E501
- if 'reverse_sort' in local_var_params and local_var_params['reverse_sort'] is not None: # noqa: E501
- query_params.append(('reverse_sort', local_var_params['reverse_sort'])) # noqa: E501
- if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
- query_params.append(('page', local_var_params['page'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loans', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[Loan]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def create_loan(self, loan, **kwargs): # noqa: E501
- """Lend or borrow(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_loan(loan, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param Loan loan: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.Loan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.create_loan_with_http_info(loan, **kwargs) # noqa: E501
-
- def create_loan_with_http_info(self, loan, **kwargs): # noqa: E501
- """Lend or borrow(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_loan_with_http_info(loan, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param Loan loan: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method create_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan' is set
- if self.api_client.client_side_validation and ('loan' not in local_var_params or # noqa: E501
- local_var_params['loan'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan` when calling `create_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
header_params = {}
@@ -1301,28 +1153,22 @@ def create_loan_with_http_info(self, loan, **kwargs): # noqa: E501
local_var_files = {}
body_params = None
- if 'loan' in local_var_params:
- body_params = local_var_params['loan']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
# Authentication setting
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/margin/loans', 'POST',
+ '/margin/user/account', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='Loan', # noqa: E501
+ response_type='list[MarginAccount]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -1330,17 +1176,21 @@ def create_loan_with_http_info(self, loan, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def merge_loans(self, currency, ids, **kwargs): # noqa: E501
- """Merge multiple lending loans(Deprecated) # noqa: E501
+ def list_cross_margin_loans(self, status, **kwargs): # noqa: E501
+ """Query cross margin borrow history (deprecated) # noqa: E501
+ Sorted by creation time in descending order by default. Set `reverse=false` for ascending order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.merge_loans(currency, ids, async_req=True)
+ >>> thread = api.list_cross_margin_loans(status, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param str ids: A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (required)
+ :param int status: Filter by status. Supported values are 2 and 3. (deprecated.) (required)
+ :param str currency: Query by specified currency, includes all currencies if not specified
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1348,24 +1198,28 @@ def merge_loans(self, currency, ids, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.Loan
+ :rtype: list[gate_api.CrossMarginLoan]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.merge_loans_with_http_info(currency, ids, **kwargs) # noqa: E501
+ return self.list_cross_margin_loans_with_http_info(status, **kwargs) # noqa: E501
- def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
- """Merge multiple lending loans(Deprecated) # noqa: E501
+ def list_cross_margin_loans_with_http_info(self, status, **kwargs): # noqa: E501
+ """Query cross margin borrow history (deprecated) # noqa: E501
+ Sorted by creation time in descending order by default. Set `reverse=false` for ascending order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.merge_loans_with_http_info(currency, ids, async_req=True)
+ >>> thread = api.list_cross_margin_loans_with_http_info(status, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param str ids: A comma-separated (,) list of IDs of the loans lent. Maximum of 20 IDs are allowed in a request (required)
+ :param int status: Filter by status. Supported values are 2 and 3. (deprecated.) (required)
+ :param str currency: Query by specified currency, includes all currencies if not specified
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1375,7 +1229,7 @@ def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.CrossMarginLoan], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1383,8 +1237,11 @@ def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ 'status',
'currency',
- 'ids'
+ 'limit',
+ 'offset',
+ 'reverse'
]
all_params.extend(
[
@@ -1399,28 +1256,36 @@ def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method merge_loans" % k
+ " to method list_cross_margin_loans" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `merge_loans`") # noqa: E501
- # verify the required parameter 'ids' is set
- if self.api_client.client_side_validation and ('ids' not in local_var_params or # noqa: E501
- local_var_params['ids'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `ids` when calling `merge_loans`") # noqa: E501
+ # verify the required parameter 'status' is set
+ if self.api_client.client_side_validation and ('status' not in local_var_params or # noqa: E501
+ local_var_params['status'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `status` when calling `list_cross_margin_loans`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_loans`, must be a value less than or equal to `1000`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_loans`, must be a value greater than or equal to `1`") # noqa: E501
+ if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `offset` when calling `list_cross_margin_loans`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
+ if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501
+ query_params.append(('status', local_var_params['status'])) # noqa: E501
if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if 'ids' in local_var_params and local_var_params['ids'] is not None: # noqa: E501
- query_params.append(('ids', local_var_params['ids'])) # noqa: E501
+ if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
+ query_params.append(('limit', local_var_params['limit'])) # noqa: E501
+ if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
+ query_params.append(('offset', local_var_params['offset'])) # noqa: E501
+ if 'reverse' in local_var_params and local_var_params['reverse'] is not None: # noqa: E501
+ query_params.append(('reverse', local_var_params['reverse'])) # noqa: E501
header_params = {}
@@ -1436,14 +1301,14 @@ def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/margin/merged_loans', 'POST',
+ '/margin/cross/loans', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='Loan', # noqa: E501
+ response_type='list[CrossMarginLoan]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -1451,17 +1316,21 @@ def merge_loans_with_http_info(self, currency, ids, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_loan(self, loan_id, side, **kwargs): # noqa: E501
- """Retrieve one single loan detail(Deprecated) # noqa: E501
+ def list_cross_margin_repayments(self, **kwargs): # noqa: E501
+ """Retrieve cross margin repayments. (deprecated) # noqa: E501
+ Sorted by creation time in descending order by default. Set `reverse=false` for ascending order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_loan(loan_id, side, async_req=True)
+ >>> thread = api.list_cross_margin_repayments(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str side: Lend or borrow (required)
+ :param str currency:
+ :param str loan_id:
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1469,24 +1338,28 @@ def get_loan(self, loan_id, side, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.Loan
+ :rtype: list[gate_api.CrossMarginRepayment]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.get_loan_with_http_info(loan_id, side, **kwargs) # noqa: E501
+ return self.list_cross_margin_repayments_with_http_info(**kwargs) # noqa: E501
- def get_loan_with_http_info(self, loan_id, side, **kwargs): # noqa: E501
- """Retrieve one single loan detail(Deprecated) # noqa: E501
+ def list_cross_margin_repayments_with_http_info(self, **kwargs): # noqa: E501
+ """Retrieve cross margin repayments. (deprecated) # noqa: E501
+ Sorted by creation time in descending order by default. Set `reverse=false` for ascending order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_loan_with_http_info(loan_id, side, async_req=True)
+ >>> thread = api.list_cross_margin_repayments_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str side: Lend or borrow (required)
+ :param str currency:
+ :param str loan_id:
+ :param int limit: Maximum number of records returned in a single list
+ :param int offset: List offset, starting from 0
+ :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1496,7 +1369,7 @@ def get_loan_with_http_info(self, loan_id, side, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.CrossMarginRepayment], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1504,8 +1377,11 @@ def get_loan_with_http_info(self, loan_id, side, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ 'currency',
'loan_id',
- 'side'
+ 'limit',
+ 'offset',
+ 'reverse'
]
all_params.extend(
[
@@ -1520,28 +1396,32 @@ def get_loan_with_http_info(self, loan_id, side, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_loan" % k
+ " to method list_cross_margin_repayments" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `get_loan`") # noqa: E501
- # verify the required parameter 'side' is set
- if self.api_client.client_side_validation and ('side' not in local_var_params or # noqa: E501
- local_var_params['side'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `side` when calling `get_loan`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_repayments`, must be a value less than or equal to `1000`") # noqa: E501
+ if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_repayments`, must be a value greater than or equal to `1`") # noqa: E501
+ if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
+ raise ApiValueError("Invalid value for parameter `offset` when calling `list_cross_margin_repayments`, must be a value greater than or equal to `0`") # noqa: E501
collection_formats = {}
path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
query_params = []
- if 'side' in local_var_params and local_var_params['side'] is not None: # noqa: E501
- query_params.append(('side', local_var_params['side'])) # noqa: E501
+ if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
+ query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'loan_id' in local_var_params and local_var_params['loan_id'] is not None: # noqa: E501
+ query_params.append(('loan_id', local_var_params['loan_id'])) # noqa: E501
+ if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
+ query_params.append(('limit', local_var_params['limit'])) # noqa: E501
+ if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
+ query_params.append(('offset', local_var_params['offset'])) # noqa: E501
+ if 'reverse' in local_var_params and local_var_params['reverse'] is not None: # noqa: E501
+ query_params.append(('reverse', local_var_params['reverse'])) # noqa: E501
header_params = {}
@@ -1557,2561 +1437,14 @@ def get_loan_with_http_info(self, loan_id, side, **kwargs): # noqa: E501
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/margin/loans/{loan_id}', 'GET',
+ '/margin/cross/repayments', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='Loan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def cancel_loan(self, loan_id, currency, **kwargs): # noqa: E501
- """Cancel lending loan(Deprecated) # noqa: E501
-
- Only lent loans can be cancelled # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.cancel_loan(loan_id, currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str currency: Retrieve data of the specified currency (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.Loan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.cancel_loan_with_http_info(loan_id, currency, **kwargs) # noqa: E501
-
- def cancel_loan_with_http_info(self, loan_id, currency, **kwargs): # noqa: E501
- """Cancel lending loan(Deprecated) # noqa: E501
-
- Only lent loans can be cancelled # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.cancel_loan_with_http_info(loan_id, currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str currency: Retrieve data of the specified currency (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id',
- 'currency'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method cancel_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `cancel_loan`") # noqa: E501
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `cancel_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loans/{loan_id}', 'DELETE',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='Loan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def update_loan(self, loan_id, loan_patch, **kwargs): # noqa: E501
- """Modify a loan(Deprecated) # noqa: E501
-
- Only `auto_renew` modification is supported currently # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.update_loan(loan_id, loan_patch, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param LoanPatch loan_patch: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.Loan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.update_loan_with_http_info(loan_id, loan_patch, **kwargs) # noqa: E501
-
- def update_loan_with_http_info(self, loan_id, loan_patch, **kwargs): # noqa: E501
- """Modify a loan(Deprecated) # noqa: E501
-
- Only `auto_renew` modification is supported currently # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.update_loan_with_http_info(loan_id, loan_patch, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param LoanPatch loan_patch: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id',
- 'loan_patch'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method update_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `update_loan`") # noqa: E501
- # verify the required parameter 'loan_patch' is set
- if self.api_client.client_side_validation and ('loan_patch' not in local_var_params or # noqa: E501
- local_var_params['loan_patch'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_patch` when calling `update_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- if 'loan_patch' in local_var_params:
- body_params = local_var_params['loan_patch']
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loans/{loan_id}', 'PATCH',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='Loan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_loan_repayments(self, loan_id, **kwargs): # noqa: E501
- """List loan repayment records(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loan_repayments(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.Repayment]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_loan_repayments_with_http_info(loan_id, **kwargs) # noqa: E501
-
- def list_loan_repayments_with_http_info(self, loan_id, **kwargs): # noqa: E501
- """List loan repayment records(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loan_repayments_with_http_info(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.Repayment], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_loan_repayments" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `list_loan_repayments`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loans/{loan_id}/repayment', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[Repayment]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def repay_loan(self, loan_id, repay_request, **kwargs): # noqa: E501
- """Repay a loan(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.repay_loan(loan_id, repay_request, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param RepayRequest repay_request: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.Loan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.repay_loan_with_http_info(loan_id, repay_request, **kwargs) # noqa: E501
-
- def repay_loan_with_http_info(self, loan_id, repay_request, **kwargs): # noqa: E501
- """Repay a loan(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.repay_loan_with_http_info(loan_id, repay_request, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param RepayRequest repay_request: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.Loan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id',
- 'repay_request'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method repay_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `repay_loan`") # noqa: E501
- # verify the required parameter 'repay_request' is set
- if self.api_client.client_side_validation and ('repay_request' not in local_var_params or # noqa: E501
- local_var_params['repay_request'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `repay_request` when calling `repay_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- if 'repay_request' in local_var_params:
- body_params = local_var_params['repay_request']
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loans/{loan_id}/repayment', 'POST',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='Loan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_loan_records(self, loan_id, **kwargs): # noqa: E501
- """List repayment records of a specific loan(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loan_records(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str status: Loan record status
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.LoanRecord]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_loan_records_with_http_info(loan_id, **kwargs) # noqa: E501
-
- def list_loan_records_with_http_info(self, loan_id, **kwargs): # noqa: E501
- """List repayment records of a specific loan(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_loan_records_with_http_info(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Loan ID (required)
- :param str status: Loan record status
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.LoanRecord], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id',
- 'status',
- 'page',
- 'limit'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_loan_records" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `list_loan_records`") # noqa: E501
-
- if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `page` when calling `list_loan_records`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_loan_records`, must be a value less than or equal to `1000`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_loan_records`, must be a value greater than or equal to `1`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'loan_id' in local_var_params and local_var_params['loan_id'] is not None: # noqa: E501
- query_params.append(('loan_id', local_var_params['loan_id'])) # noqa: E501
- if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501
- query_params.append(('status', local_var_params['status'])) # noqa: E501
- if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
- query_params.append(('page', local_var_params['page'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loan_records', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[LoanRecord]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_loan_record(self, loan_record_id, loan_id, **kwargs): # noqa: E501
- """Get one single loan record(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_loan_record(loan_record_id, loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_record_id: Loan record ID (required)
- :param str loan_id: Loan ID (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.LoanRecord
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_loan_record_with_http_info(loan_record_id, loan_id, **kwargs) # noqa: E501
-
- def get_loan_record_with_http_info(self, loan_record_id, loan_id, **kwargs): # noqa: E501
- """Get one single loan record(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_loan_record_with_http_info(loan_record_id, loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_record_id: Loan record ID (required)
- :param str loan_id: Loan ID (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.LoanRecord, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_record_id',
- 'loan_id'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_loan_record" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_record_id' is set
- if self.api_client.client_side_validation and ('loan_record_id' not in local_var_params or # noqa: E501
- local_var_params['loan_record_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_record_id` when calling `get_loan_record`") # noqa: E501
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `get_loan_record`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_record_id' in local_var_params:
- path_params['loan_record_id'] = local_var_params['loan_record_id'] # noqa: E501
-
- query_params = []
- if 'loan_id' in local_var_params and local_var_params['loan_id'] is not None: # noqa: E501
- query_params.append(('loan_id', local_var_params['loan_id'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loan_records/{loan_record_id}', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='LoanRecord', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def update_loan_record(self, loan_record_id, loan_patch, **kwargs): # noqa: E501
- """Modify a loan record(Deprecated) # noqa: E501
-
- Only `auto_renew` modification is supported currently # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.update_loan_record(loan_record_id, loan_patch, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_record_id: Loan record ID (required)
- :param LoanPatch loan_patch: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.LoanRecord
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.update_loan_record_with_http_info(loan_record_id, loan_patch, **kwargs) # noqa: E501
-
- def update_loan_record_with_http_info(self, loan_record_id, loan_patch, **kwargs): # noqa: E501
- """Modify a loan record(Deprecated) # noqa: E501
-
- Only `auto_renew` modification is supported currently # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.update_loan_record_with_http_info(loan_record_id, loan_patch, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_record_id: Loan record ID (required)
- :param LoanPatch loan_patch: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.LoanRecord, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_record_id',
- 'loan_patch'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method update_loan_record" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_record_id' is set
- if self.api_client.client_side_validation and ('loan_record_id' not in local_var_params or # noqa: E501
- local_var_params['loan_record_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_record_id` when calling `update_loan_record`") # noqa: E501
- # verify the required parameter 'loan_patch' is set
- if self.api_client.client_side_validation and ('loan_patch' not in local_var_params or # noqa: E501
- local_var_params['loan_patch'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_patch` when calling `update_loan_record`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_record_id' in local_var_params:
- path_params['loan_record_id'] = local_var_params['loan_record_id'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- if 'loan_patch' in local_var_params:
- body_params = local_var_params['loan_patch']
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/loan_records/{loan_record_id}', 'PATCH',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='LoanRecord', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_margin_borrowable(self, currency, **kwargs): # noqa: E501
- """Get the max borrowable amount for a specific margin currency(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_margin_borrowable(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param str currency_pair: Currency pair
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.MarginBorrowable
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_margin_borrowable_with_http_info(currency, **kwargs) # noqa: E501
-
- def get_margin_borrowable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get the max borrowable amount for a specific margin currency(Deprecated) # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_margin_borrowable_with_http_info(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param str currency_pair: Currency pair
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.MarginBorrowable, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency',
- 'currency_pair'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_margin_borrowable" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_margin_borrowable`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if 'currency_pair' in local_var_params and local_var_params['currency_pair'] is not None: # noqa: E501
- query_params.append(('currency_pair', local_var_params['currency_pair'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/borrowable', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='MarginBorrowable', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_cross_margin_currencies(self, **kwargs): # noqa: E501
- """Currencies supported by cross margin. # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_currencies(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.CrossMarginCurrency]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_cross_margin_currencies_with_http_info(**kwargs) # noqa: E501
-
- def list_cross_margin_currencies_with_http_info(self, **kwargs): # noqa: E501
- """Currencies supported by cross margin. # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_currencies_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.CrossMarginCurrency], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_cross_margin_currencies" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = [] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/currencies', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[CrossMarginCurrency]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_currency(self, currency, **kwargs): # noqa: E501
- """Retrieve detail of one single currency supported by cross margin # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_currency(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Currency name (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.CrossMarginCurrency
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_currency_with_http_info(currency, **kwargs) # noqa: E501
-
- def get_cross_margin_currency_with_http_info(self, currency, **kwargs): # noqa: E501
- """Retrieve detail of one single currency supported by cross margin # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_currency_with_http_info(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Currency name (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.CrossMarginCurrency, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_currency" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_cross_margin_currency`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'currency' in local_var_params:
- path_params['currency'] = local_var_params['currency'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = [] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/currencies/{currency}', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='CrossMarginCurrency', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_account(self, **kwargs): # noqa: E501
- """Retrieve cross margin account # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_account(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.CrossMarginAccount
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_account_with_http_info(**kwargs) # noqa: E501
-
- def get_cross_margin_account_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve cross margin account # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_account_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.CrossMarginAccount, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_account" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/accounts', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='CrossMarginAccount', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_cross_margin_account_book(self, **kwargs): # noqa: E501
- """Retrieve cross margin account change history # noqa: E501
-
- 记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_account_book(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Filter by currency
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.CrossMarginAccountBook]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_cross_margin_account_book_with_http_info(**kwargs) # noqa: E501
-
- def list_cross_margin_account_book_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve cross margin account change history # noqa: E501
-
- 记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_account_book_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Filter by currency
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.CrossMarginAccountBook], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency',
- '_from',
- 'to',
- 'page',
- 'limit',
- 'type'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_cross_margin_account_book" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `page` when calling `list_cross_margin_account_book`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_account_book`, must be a value less than or equal to `1000`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_account_book`, must be a value greater than or equal to `1`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
- query_params.append(('from', local_var_params['_from'])) # noqa: E501
- if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
- query_params.append(('to', local_var_params['to'])) # noqa: E501
- if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
- query_params.append(('page', local_var_params['page'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
- if 'type' in local_var_params and local_var_params['type'] is not None: # noqa: E501
- query_params.append(('type', local_var_params['type'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/account_book', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[CrossMarginAccountBook]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_cross_margin_loans(self, status, **kwargs): # noqa: E501
- """List cross margin borrow history # noqa: E501
-
- Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_loans(status, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param int status: Filter by status. Supported values are 2 and 3. (deprecated.) (required)
- :param str currency: Filter by currency
- :param int limit: Maximum number of records to be returned in a single list
- :param int offset: List offset, starting from 0
- :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.CrossMarginLoan]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_cross_margin_loans_with_http_info(status, **kwargs) # noqa: E501
-
- def list_cross_margin_loans_with_http_info(self, status, **kwargs): # noqa: E501
- """List cross margin borrow history # noqa: E501
-
- Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_loans_with_http_info(status, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param int status: Filter by status. Supported values are 2 and 3. (deprecated.) (required)
- :param str currency: Filter by currency
- :param int limit: Maximum number of records to be returned in a single list
- :param int offset: List offset, starting from 0
- :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.CrossMarginLoan], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'status',
- 'currency',
- 'limit',
- 'offset',
- 'reverse'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_cross_margin_loans" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'status' is set
- if self.api_client.client_side_validation and ('status' not in local_var_params or # noqa: E501
- local_var_params['status'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `status` when calling `list_cross_margin_loans`") # noqa: E501
-
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_loans`, must be a value less than or equal to `1000`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_loans`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
- raise ApiValueError("Invalid value for parameter `offset` when calling `list_cross_margin_loans`, must be a value greater than or equal to `0`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501
- query_params.append(('status', local_var_params['status'])) # noqa: E501
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
- if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
- query_params.append(('offset', local_var_params['offset'])) # noqa: E501
- if 'reverse' in local_var_params and local_var_params['reverse'] is not None: # noqa: E501
- query_params.append(('reverse', local_var_params['reverse'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/loans', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[CrossMarginLoan]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def create_cross_margin_loan(self, cross_margin_loan, **kwargs): # noqa: E501
- """Create a cross margin borrow loan # noqa: E501
-
- Borrow amount cannot be less than currency minimum borrow amount # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_cross_margin_loan(cross_margin_loan, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param CrossMarginLoan cross_margin_loan: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.CrossMarginLoan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.create_cross_margin_loan_with_http_info(cross_margin_loan, **kwargs) # noqa: E501
-
- def create_cross_margin_loan_with_http_info(self, cross_margin_loan, **kwargs): # noqa: E501
- """Create a cross margin borrow loan # noqa: E501
-
- Borrow amount cannot be less than currency minimum borrow amount # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.create_cross_margin_loan_with_http_info(cross_margin_loan, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param CrossMarginLoan cross_margin_loan: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.CrossMarginLoan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'cross_margin_loan'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method create_cross_margin_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'cross_margin_loan' is set
- if self.api_client.client_side_validation and ('cross_margin_loan' not in local_var_params or # noqa: E501
- local_var_params['cross_margin_loan'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `cross_margin_loan` when calling `create_cross_margin_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- if 'cross_margin_loan' in local_var_params:
- body_params = local_var_params['cross_margin_loan']
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/loans', 'POST',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='CrossMarginLoan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_loan(self, loan_id, **kwargs): # noqa: E501
- """Retrieve single borrow loan detail # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_loan(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Borrow loan ID (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.CrossMarginLoan
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_loan_with_http_info(loan_id, **kwargs) # noqa: E501
-
- def get_cross_margin_loan_with_http_info(self, loan_id, **kwargs): # noqa: E501
- """Retrieve single borrow loan detail # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_loan_with_http_info(loan_id, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str loan_id: Borrow loan ID (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.CrossMarginLoan, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'loan_id'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'loan_id' is set
- if self.api_client.client_side_validation and ('loan_id' not in local_var_params or # noqa: E501
- local_var_params['loan_id'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `loan_id` when calling `get_cross_margin_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
- if 'loan_id' in local_var_params:
- path_params['loan_id'] = local_var_params['loan_id'] # noqa: E501
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/loans/{loan_id}', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='CrossMarginLoan', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def list_cross_margin_repayments(self, **kwargs): # noqa: E501
- """Retrieve cross margin repayments # noqa: E501
-
- Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_repayments(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency:
- :param str loan_id:
- :param int limit: Maximum number of records to be returned in a single list
- :param int offset: List offset, starting from 0
- :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.CrossMarginRepayment]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.list_cross_margin_repayments_with_http_info(**kwargs) # noqa: E501
-
- def list_cross_margin_repayments_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve cross margin repayments # noqa: E501
-
- Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_cross_margin_repayments_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency:
- :param str loan_id:
- :param int limit: Maximum number of records to be returned in a single list
- :param int offset: List offset, starting from 0
- :param bool reverse: Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.CrossMarginRepayment], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency',
- 'loan_id',
- 'limit',
- 'offset',
- 'reverse'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method list_cross_margin_repayments" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 1000: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_repayments`, must be a value less than or equal to `1000`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `list_cross_margin_repayments`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params['offset'] < 0: # noqa: E501
- raise ApiValueError("Invalid value for parameter `offset` when calling `list_cross_margin_repayments`, must be a value greater than or equal to `0`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if 'loan_id' in local_var_params and local_var_params['loan_id'] is not None: # noqa: E501
- query_params.append(('loan_id', local_var_params['loan_id'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
- if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
- query_params.append(('offset', local_var_params['offset'])) # noqa: E501
- if 'reverse' in local_var_params and local_var_params['reverse'] is not None: # noqa: E501
- query_params.append(('reverse', local_var_params['reverse'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/repayments', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[CrossMarginRepayment]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def repay_cross_margin_loan(self, cross_margin_repay_request, **kwargs): # noqa: E501
- """Cross margin repayments # noqa: E501
-
- When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.repay_cross_margin_loan(cross_margin_repay_request, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param CrossMarginRepayRequest cross_margin_repay_request: (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.CrossMarginLoan]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.repay_cross_margin_loan_with_http_info(cross_margin_repay_request, **kwargs) # noqa: E501
-
- def repay_cross_margin_loan_with_http_info(self, cross_margin_repay_request, **kwargs): # noqa: E501
- """Cross margin repayments # noqa: E501
-
- When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.repay_cross_margin_loan_with_http_info(cross_margin_repay_request, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param CrossMarginRepayRequest cross_margin_repay_request: (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.CrossMarginLoan], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'cross_margin_repay_request'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method repay_cross_margin_loan" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'cross_margin_repay_request' is set
- if self.api_client.client_side_validation and ('cross_margin_repay_request' not in local_var_params or # noqa: E501
- local_var_params['cross_margin_repay_request'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `cross_margin_repay_request` when calling `repay_cross_margin_loan`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- if 'cross_margin_repay_request' in local_var_params:
- body_params = local_var_params['cross_margin_repay_request']
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/repayments', 'POST',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[CrossMarginLoan]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_interest_records(self, **kwargs): # noqa: E501
- """Interest records for the cross margin account # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_interest_records(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
- :param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: list[gate_api.UniLoanInterestRecord]
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_interest_records_with_http_info(**kwargs) # noqa: E501
-
- def get_cross_margin_interest_records_with_http_info(self, **kwargs): # noqa: E501
- """Interest records for the cross margin account # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_interest_records_with_http_info(async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
- :param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(list[gate_api.UniLoanInterestRecord], status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency',
- 'page',
- 'limit',
- '_from',
- 'to'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_interest_records" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
-
- if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params['page'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `page` when calling `get_cross_margin_interest_records`, must be a value greater than or equal to `1`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 100: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `get_cross_margin_interest_records`, must be a value less than or equal to `100`") # noqa: E501
- if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] < 1: # noqa: E501
- raise ApiValueError("Invalid value for parameter `limit` when calling `get_cross_margin_interest_records`, must be a value greater than or equal to `1`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
- if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
- query_params.append(('page', local_var_params['page'])) # noqa: E501
- if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
- query_params.append(('limit', local_var_params['limit'])) # noqa: E501
- if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
- query_params.append(('from', local_var_params['_from'])) # noqa: E501
- if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
- query_params.append(('to', local_var_params['to'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/interest_records', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='list[UniLoanInterestRecord]', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_transferable(self, currency, **kwargs): # noqa: E501
- """Get the max transferable amount for a specific cross margin currency # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_transferable(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.CrossMarginTransferable
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_transferable_with_http_info(currency, **kwargs) # noqa: E501
-
- def get_cross_margin_transferable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get the max transferable amount for a specific cross margin currency # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_transferable_with_http_info(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.CrossMarginTransferable, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_transferable" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_cross_margin_transferable`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/transferable', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='CrossMarginTransferable', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_estimate_rate(self, currencies, **kwargs): # noqa: E501
- """Estimated interest rates # noqa: E501
-
- Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_estimate_rate(currencies, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param list[str] currencies: An array of up to 10 specifying the currency name (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: dict
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_estimate_rate_with_http_info(currencies, **kwargs) # noqa: E501
-
- def get_cross_margin_estimate_rate_with_http_info(self, currencies, **kwargs): # noqa: E501
- """Estimated interest rates # noqa: E501
-
- Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. # noqa: E501
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_estimate_rate_with_http_info(currencies, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param list[str] currencies: An array of up to 10 specifying the currency name (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(dict, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currencies'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_estimate_rate" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'currencies' is set
- if self.api_client.client_side_validation and ('currencies' not in local_var_params or # noqa: E501
- local_var_params['currencies'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currencies` when calling `get_cross_margin_estimate_rate`") # noqa: E501
-
- if self.api_client.client_side_validation and ('currencies' in local_var_params and # noqa: E501
- len(local_var_params['currencies']) > 10): # noqa: E501
- raise ApiValueError("Invalid value for parameter `currencies` when calling `get_cross_margin_estimate_rate`, number of items must be less than or equal to `10`") # noqa: E501
- if self.api_client.client_side_validation and ('currencies' in local_var_params and # noqa: E501
- len(local_var_params['currencies']) < 1): # noqa: E501
- raise ApiValueError("Invalid value for parameter `currencies` when calling `get_cross_margin_estimate_rate`, number of items must be greater than or equal to `1`") # noqa: E501
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currencies' in local_var_params and local_var_params['currencies'] is not None: # noqa: E501
- query_params.append(('currencies', local_var_params['currencies'])) # noqa: E501
- collection_formats['currencies'] = 'multi' # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/estimate_rate', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='dict(str, str)', # noqa: E501
- auth_settings=auth_settings,
- async_req=local_var_params.get('async_req'),
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
- _preload_content=local_var_params.get('_preload_content', True),
- _request_timeout=local_var_params.get('_request_timeout'),
- collection_formats=collection_formats)
-
- def get_cross_margin_borrowable(self, currency, **kwargs): # noqa: E501
- """Get the max borrowable amount for a specific cross margin currency # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_borrowable(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: gate_api.UnifiedBorrowable
- :return: If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- return self.get_cross_margin_borrowable_with_http_info(currency, **kwargs) # noqa: E501
-
- def get_cross_margin_borrowable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get the max borrowable amount for a specific cross margin currency # noqa: E501
-
- This method makes a synchronous HTTP request by default. To make an
- asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_cross_margin_borrowable_with_http_info(currency, async_req=True)
- >>> result = thread.get()
-
- :param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
- :param _return_http_data_only: response data without head status code
- and headers
- :param _preload_content: if False, the urllib3.HTTPResponse object will
- be returned without reading/decoding response
- data. Default is True.
- :param _request_timeout: timeout setting for this request. If one
- number provided, it will be total request
- timeout. It can also be a pair (tuple) of
- (connection, read) timeouts.
- :rtype: tuple(gate_api.UnifiedBorrowable, status_code(int), headers(HTTPHeaderDict))
- :return: If the method is called asynchronously,
- returns the request thread.
- """
-
- local_var_params = locals()
-
- all_params = [
- 'currency'
- ]
- all_params.extend(
- [
- 'async_req',
- '_return_http_data_only',
- '_preload_content',
- '_request_timeout'
- ]
- )
-
- for k, v in six.iteritems(local_var_params['kwargs']):
- if k not in all_params:
- raise ApiTypeError(
- "Got an unexpected keyword argument '%s'"
- " to method get_cross_margin_borrowable" % k
- )
- local_var_params[k] = v
- del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_cross_margin_borrowable`") # noqa: E501
-
- collection_formats = {}
-
- path_params = {}
-
- query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # HTTP header `Accept`
- header_params['Accept'] = self.api_client.select_header_accept(
- ['application/json']) # noqa: E501
-
- # Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
-
- return self.api_client.call_api(
- '/margin/cross/borrowable', 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='UnifiedBorrowable', # noqa: E501
+ response_type='list[CrossMarginRepayment]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
diff --git a/gate_api/api/margin_uni_api.py b/gate_api/api/margin_uni_api.py
index 1ceca59..6ba4bde 100644
--- a/gate_api/api/margin_uni_api.py
+++ b/gate_api/api/margin_uni_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -140,7 +140,7 @@ def list_uni_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_uni_currency_pair(self, currency_pair, **kwargs): # noqa: E501
- """Get detail of lending market # noqa: E501
+ """Get lending market details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -164,7 +164,7 @@ def get_uni_currency_pair(self, currency_pair, **kwargs): # noqa: E501
return self.get_uni_currency_pair_with_http_info(currency_pair, **kwargs) # noqa: E501
def get_uni_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Get detail of lending market # noqa: E501
+ """Get lending market details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -252,16 +252,16 @@ def get_uni_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa
collection_formats=collection_formats)
def get_margin_uni_estimate_rate(self, currencies, **kwargs): # noqa: E501
- """Estimate interest Rate # noqa: E501
+ """Estimate interest rate for isolated margin currencies # noqa: E501
- Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. # noqa: E501
+ Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_margin_uni_estimate_rate(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: An array of up to 10 specifying the currency name (required)
+ :param list[str] currencies: Array of currency names to query, maximum 10 (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -277,16 +277,16 @@ def get_margin_uni_estimate_rate(self, currencies, **kwargs): # noqa: E501
return self.get_margin_uni_estimate_rate_with_http_info(currencies, **kwargs) # noqa: E501
def get_margin_uni_estimate_rate_with_http_info(self, currencies, **kwargs): # noqa: E501
- """Estimate interest Rate # noqa: E501
+ """Estimate interest rate for isolated margin currencies # noqa: E501
- Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. # noqa: E501
+ Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_margin_uni_estimate_rate_with_http_info(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: An array of up to 10 specifying the currency name (required)
+ :param list[str] currencies: Array of currency names to query, maximum 10 (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -373,7 +373,7 @@ def get_margin_uni_estimate_rate_with_http_info(self, currencies, **kwargs): #
collection_formats=collection_formats)
def list_uni_loans(self, **kwargs): # noqa: E501
- """List loans # noqa: E501
+ """Query loans # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -382,9 +382,9 @@ def list_uni_loans(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -400,7 +400,7 @@ def list_uni_loans(self, **kwargs): # noqa: E501
return self.list_uni_loans_with_http_info(**kwargs) # noqa: E501
def list_uni_loans_with_http_info(self, **kwargs): # noqa: E501
- """List loans # noqa: E501
+ """Query loans # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -409,9 +409,9 @@ def list_uni_loans_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -614,7 +614,7 @@ def create_uni_loan_with_http_info(self, create_uni_loan, **kwargs): # noqa: E5
collection_formats=collection_formats)
def list_uni_loan_records(self, **kwargs): # noqa: E501
- """Get load records # noqa: E501
+ """Query loan records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -622,11 +622,11 @@ def list_uni_loan_records(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: type: borrow - borrow, repay - repay
- :param str currency: Retrieve data of the specified currency
+ :param str type: Type: `borrow` - borrow, `repay` - repay
+ :param str currency: Query by specified currency name
:param str currency_pair: Currency pair
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -642,7 +642,7 @@ def list_uni_loan_records(self, **kwargs): # noqa: E501
return self.list_uni_loan_records_with_http_info(**kwargs) # noqa: E501
def list_uni_loan_records_with_http_info(self, **kwargs): # noqa: E501
- """Get load records # noqa: E501
+ """Query loan records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -650,11 +650,11 @@ def list_uni_loan_records_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: type: borrow - borrow, repay - repay
- :param str currency: Retrieve data of the specified currency
+ :param str type: Type: `borrow` - borrow, `repay` - repay
+ :param str currency: Query by specified currency name
:param str currency_pair: Currency pair
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -748,7 +748,7 @@ def list_uni_loan_records_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_uni_loan_interest_records(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query interest deduction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -757,11 +757,11 @@ def list_uni_loan_interest_records(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -777,7 +777,7 @@ def list_uni_loan_interest_records(self, **kwargs): # noqa: E501
return self.list_uni_loan_interest_records_with_http_info(**kwargs) # noqa: E501
def list_uni_loan_interest_records_with_http_info(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query interest deduction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -786,11 +786,11 @@ def list_uni_loan_interest_records_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -887,7 +887,7 @@ def list_uni_loan_interest_records_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_uni_borrowable(self, currency, currency_pair, **kwargs): # noqa: E501
- """Get maximum borrowable # noqa: E501
+ """Query maximum borrowable amount by currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -895,7 +895,7 @@ def get_uni_borrowable(self, currency, currency_pair, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currency: Query by specified currency name (required)
:param str currency_pair: Currency pair (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -912,7 +912,7 @@ def get_uni_borrowable(self, currency, currency_pair, **kwargs): # noqa: E501
return self.get_uni_borrowable_with_http_info(currency, currency_pair, **kwargs) # noqa: E501
def get_uni_borrowable_with_http_info(self, currency, currency_pair, **kwargs): # noqa: E501
- """Get maximum borrowable # noqa: E501
+ """Query maximum borrowable amount by currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -920,7 +920,7 @@ def get_uni_borrowable_with_http_info(self, currency, currency_pair, **kwargs):
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currency: Query by specified currency name (required)
:param str currency_pair: Currency pair (required)
:param _return_http_data_only: response data without head status code
and headers
diff --git a/gate_api/api/multi_collateral_loan_api.py b/gate_api/api/multi_collateral_loan_api.py
index 8cea842..4578f3f 100644
--- a/gate_api/api/multi_collateral_loan_api.py
+++ b/gate_api/api/multi_collateral_loan_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_multi_collateral_orders(self, **kwargs): # noqa: E501
- """List Multi-Collateral Orders # noqa: E501
+ """Query multi-currency collateral order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -46,9 +46,9 @@ def list_multi_collateral_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str sort: Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv.
- :param str order_type: Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders
+ :param int limit: Maximum number of records returned in a single list
+ :param str sort: Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending.
+ :param str order_type: Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,7 +64,7 @@ def list_multi_collateral_orders(self, **kwargs): # noqa: E501
return self.list_multi_collateral_orders_with_http_info(**kwargs) # noqa: E501
def list_multi_collateral_orders_with_http_info(self, **kwargs): # noqa: E501
- """List Multi-Collateral Orders # noqa: E501
+ """Query multi-currency collateral order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -73,9 +73,9 @@ def list_multi_collateral_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str sort: Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv.
- :param str order_type: Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders
+ :param int limit: Maximum number of records returned in a single list
+ :param str sort: Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending.
+ :param str order_type: Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -166,7 +166,7 @@ def list_multi_collateral_orders_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_multi_collateral(self, create_multi_collateral_order, **kwargs): # noqa: E501
- """Create Multi-Collateral Order # noqa: E501
+ """Place multi-currency collateral order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -190,7 +190,7 @@ def create_multi_collateral(self, create_multi_collateral_order, **kwargs): # n
return self.create_multi_collateral_with_http_info(create_multi_collateral_order, **kwargs) # noqa: E501
def create_multi_collateral_with_http_info(self, create_multi_collateral_order, **kwargs): # noqa: E501
- """Create Multi-Collateral Order # noqa: E501
+ """Place multi-currency collateral order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -282,7 +282,7 @@ def create_multi_collateral_with_http_info(self, create_multi_collateral_order,
collection_formats=collection_formats)
def get_multi_collateral_order_detail(self, order_id, **kwargs): # noqa: E501
- """Get Multi-Collateral Order Detail # noqa: E501
+ """Query order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -290,7 +290,7 @@ def get_multi_collateral_order_detail(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned on successful order creation (required)
+ :param str order_id: Order ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -306,7 +306,7 @@ def get_multi_collateral_order_detail(self, order_id, **kwargs): # noqa: E501
return self.get_multi_collateral_order_detail_with_http_info(order_id, **kwargs) # noqa: E501
def get_multi_collateral_order_detail_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Get Multi-Collateral Order Detail # noqa: E501
+ """Query order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -314,7 +314,7 @@ def get_multi_collateral_order_detail_with_http_info(self, order_id, **kwargs):
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned on successful order creation (required)
+ :param str order_id: Order ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -394,7 +394,7 @@ def get_multi_collateral_order_detail_with_http_info(self, order_id, **kwargs):
collection_formats=collection_formats)
def list_multi_repay_records(self, type, **kwargs): # noqa: E501
- """List Multi-Collateral Repay Records # noqa: E501
+ """Query multi-currency collateral repayment records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -405,9 +405,9 @@ def list_multi_repay_records(self, type, **kwargs): # noqa: E501
:param str type: Operation type: repay - Regular repayment, liquidate - Liquidation (required)
:param str borrow_currency: Borrowed currency
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -423,7 +423,7 @@ def list_multi_repay_records(self, type, **kwargs): # noqa: E501
return self.list_multi_repay_records_with_http_info(type, **kwargs) # noqa: E501
def list_multi_repay_records_with_http_info(self, type, **kwargs): # noqa: E501
- """List Multi-Collateral Repay Records # noqa: E501
+ """Query multi-currency collateral repayment records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -434,9 +434,9 @@ def list_multi_repay_records_with_http_info(self, type, **kwargs): # noqa: E501
:param str type: Operation type: repay - Regular repayment, liquidate - Liquidation (required)
:param str borrow_currency: Borrowed currency
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -537,7 +537,7 @@ def list_multi_repay_records_with_http_info(self, type, **kwargs): # noqa: E501
collection_formats=collection_formats)
def repay_multi_collateral_loan(self, repay_multi_loan, **kwargs): # noqa: E501
- """Repay Multi-Collateral Loan # noqa: E501
+ """Multi-currency collateral repayment # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -561,7 +561,7 @@ def repay_multi_collateral_loan(self, repay_multi_loan, **kwargs): # noqa: E501
return self.repay_multi_collateral_loan_with_http_info(repay_multi_loan, **kwargs) # noqa: E501
def repay_multi_collateral_loan_with_http_info(self, repay_multi_loan, **kwargs): # noqa: E501
- """Repay Multi-Collateral Loan # noqa: E501
+ """Multi-currency collateral repayment # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -662,10 +662,10 @@ def list_multi_collateral_records(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str collateral_currency: Collateral
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str collateral_currency: Collateral currency
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -690,10 +690,10 @@ def list_multi_collateral_records_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str collateral_currency: Collateral
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str collateral_currency: Collateral currency
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -787,7 +787,7 @@ def list_multi_collateral_records_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def operate_multi_collateral(self, collateral_adjust, **kwargs): # noqa: E501
- """Operate Multi-Collateral # noqa: E501
+ """Add or withdraw collateral # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -811,7 +811,7 @@ def operate_multi_collateral(self, collateral_adjust, **kwargs): # noqa: E501
return self.operate_multi_collateral_with_http_info(collateral_adjust, **kwargs) # noqa: E501
def operate_multi_collateral_with_http_info(self, collateral_adjust, **kwargs): # noqa: E501
- """Operate Multi-Collateral # noqa: E501
+ """Add or withdraw collateral # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -903,7 +903,7 @@ def operate_multi_collateral_with_http_info(self, collateral_adjust, **kwargs):
collection_formats=collection_formats)
def list_user_currency_quota(self, type, currency, **kwargs): # noqa: E501
- """List User Currency Quota # noqa: E501
+ """Query user's collateral and borrowing currency quota information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -911,8 +911,8 @@ def list_user_currency_quota(self, type, currency, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: Currency types: collateral - collateral currency, borrow - borrowing currency. (required)
- :param str currency: When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required)
+ :param str type: Currency type: collateral - Collateral currency, borrow - Borrowing currency (required)
+ :param str currency: When it is a collateral currency, multiple currencies can be provided separated by commas; when it is a borrowing currency, only one currency can be provided. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -928,7 +928,7 @@ def list_user_currency_quota(self, type, currency, **kwargs): # noqa: E501
return self.list_user_currency_quota_with_http_info(type, currency, **kwargs) # noqa: E501
def list_user_currency_quota_with_http_info(self, type, currency, **kwargs): # noqa: E501
- """List User Currency Quota # noqa: E501
+ """Query user's collateral and borrowing currency quota information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -936,8 +936,8 @@ def list_user_currency_quota_with_http_info(self, type, currency, **kwargs): #
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: Currency types: collateral - collateral currency, borrow - borrowing currency. (required)
- :param str currency: When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required)
+ :param str type: Currency type: collateral - Collateral currency, borrow - Borrowing currency (required)
+ :param str currency: When it is a collateral currency, multiple currencies can be provided separated by commas; when it is a borrowing currency, only one currency can be provided. (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1024,7 +1024,7 @@ def list_user_currency_quota_with_http_info(self, type, currency, **kwargs): #
collection_formats=collection_formats)
def list_multi_collateral_currencies(self, **kwargs): # noqa: E501
- """Query supported borrowing and collateral currencies in Multi-Collateral # noqa: E501
+ """Query supported borrowing and collateral currencies for multi-currency collateral # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1047,7 +1047,7 @@ def list_multi_collateral_currencies(self, **kwargs): # noqa: E501
return self.list_multi_collateral_currencies_with_http_info(**kwargs) # noqa: E501
def list_multi_collateral_currencies_with_http_info(self, **kwargs): # noqa: E501
- """Query supported borrowing and collateral currencies in Multi-Collateral # noqa: E501
+ """Query supported borrowing and collateral currencies for multi-currency collateral # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1127,9 +1127,9 @@ def list_multi_collateral_currencies_with_http_info(self, **kwargs): # noqa: E5
collection_formats=collection_formats)
def get_multi_collateral_ltv(self, **kwargs): # noqa: E501
- """Get Multi-Collateral ratio # noqa: E501
+ """Query collateralization ratio information # noqa: E501
- The Multi-Collateral ratio is fixed, irrespective of the currency. # noqa: E501
+ Multi-currency collateral ratio is fixed, independent of currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_multi_collateral_ltv(async_req=True)
@@ -1151,9 +1151,9 @@ def get_multi_collateral_ltv(self, **kwargs): # noqa: E501
return self.get_multi_collateral_ltv_with_http_info(**kwargs) # noqa: E501
def get_multi_collateral_ltv_with_http_info(self, **kwargs): # noqa: E501
- """Get Multi-Collateral ratio # noqa: E501
+ """Query collateralization ratio information # noqa: E501
- The Multi-Collateral ratio is fixed, irrespective of the currency. # noqa: E501
+ Multi-currency collateral ratio is fixed, independent of currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_multi_collateral_ltv_with_http_info(async_req=True)
@@ -1232,7 +1232,7 @@ def get_multi_collateral_ltv_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_multi_collateral_fix_rate(self, **kwargs): # noqa: E501
- """Query fixed interest rates for the currency for 7 days and 30 days # noqa: E501
+ """Query currency's 7-day and 30-day fixed interest rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1255,7 +1255,7 @@ def get_multi_collateral_fix_rate(self, **kwargs): # noqa: E501
return self.get_multi_collateral_fix_rate_with_http_info(**kwargs) # noqa: E501
def get_multi_collateral_fix_rate_with_http_info(self, **kwargs): # noqa: E501
- """Query fixed interest rates for the currency for 7 days and 30 days # noqa: E501
+ """Query currency's 7-day and 30-day fixed interest rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1335,17 +1335,17 @@ def get_multi_collateral_fix_rate_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_multi_collateral_current_rate(self, currencies, **kwargs): # noqa: E501
- """Query the current interest rate of the currency # noqa: E501
+ """Query currency's current interest rate # noqa: E501
- Query the current interest rate of the currency in the last hour. The current interest rate is updated every hour. # noqa: E501
+ Query currency's current interest rate for the previous hour, current interest rate updates hourly # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_multi_collateral_current_rate(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. (required)
- :param str vip_level: VIP level, defaults to 0 if not transferred
+ :param list[str] currencies: Specify currency name query array, separated by commas, maximum 100 items (required)
+ :param str vip_level: VIP level, defaults to 0 if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1361,17 +1361,17 @@ def get_multi_collateral_current_rate(self, currencies, **kwargs): # noqa: E501
return self.get_multi_collateral_current_rate_with_http_info(currencies, **kwargs) # noqa: E501
def get_multi_collateral_current_rate_with_http_info(self, currencies, **kwargs): # noqa: E501
- """Query the current interest rate of the currency # noqa: E501
+ """Query currency's current interest rate # noqa: E501
- Query the current interest rate of the currency in the last hour. The current interest rate is updated every hour. # noqa: E501
+ Query currency's current interest rate for the previous hour, current interest rate updates hourly # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_multi_collateral_current_rate_with_http_info(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. (required)
- :param str vip_level: VIP level, defaults to 0 if not transferred
+ :param list[str] currencies: Specify currency name query array, separated by commas, maximum 100 items (required)
+ :param str vip_level: VIP level, defaults to 0 if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/gate_api/api/options_api.py b/gate_api/api/options_api.py
index b5f74f7..3c6fd4a 100644
--- a/gate_api/api/options_api.py
+++ b/gate_api/api/options_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_options_underlyings(self, **kwargs): # noqa: E501
- """List all underlyings # noqa: E501
+ """List all underlying assets # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -60,7 +60,7 @@ def list_options_underlyings(self, **kwargs): # noqa: E501
return self.list_options_underlyings_with_http_info(**kwargs) # noqa: E501
def list_options_underlyings_with_http_info(self, **kwargs): # noqa: E501
- """List all underlyings # noqa: E501
+ """List all underlying assets # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -140,7 +140,7 @@ def list_options_underlyings_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_options_expirations(self, underlying, **kwargs): # noqa: E501
- """List all expiration times # noqa: E501
+ """List all expiration dates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -164,7 +164,7 @@ def list_options_expirations(self, underlying, **kwargs): # noqa: E501
return self.list_options_expirations_with_http_info(underlying, **kwargs) # noqa: E501
def list_options_expirations_with_http_info(self, underlying, **kwargs): # noqa: E501
- """List all expiration times # noqa: E501
+ """List all expiration dates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -252,7 +252,7 @@ def list_options_expirations_with_http_info(self, underlying, **kwargs): # noqa
collection_formats=collection_formats)
def list_options_contracts(self, underlying, **kwargs): # noqa: E501
- """List all the contracts with specified underlying and expiration time # noqa: E501
+ """List all contracts for specified underlying and expiration date # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -261,7 +261,7 @@ def list_options_contracts(self, underlying, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int expiration: Unix timestamp of the expiration time
+ :param int expiration: Unix timestamp of expiration date
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -277,7 +277,7 @@ def list_options_contracts(self, underlying, **kwargs): # noqa: E501
return self.list_options_contracts_with_http_info(underlying, **kwargs) # noqa: E501
def list_options_contracts_with_http_info(self, underlying, **kwargs): # noqa: E501
- """List all the contracts with specified underlying and expiration time # noqa: E501
+ """List all contracts for specified underlying and expiration date # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -286,7 +286,7 @@ def list_options_contracts_with_http_info(self, underlying, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int expiration: Unix timestamp of the expiration time
+ :param int expiration: Unix timestamp of expiration date
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -369,7 +369,7 @@ def list_options_contracts_with_http_info(self, underlying, **kwargs): # noqa:
collection_formats=collection_formats)
def get_options_contract(self, contract, **kwargs): # noqa: E501
- """Query specified contract detail # noqa: E501
+ """Query specified contract details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -393,7 +393,7 @@ def get_options_contract(self, contract, **kwargs): # noqa: E501
return self.get_options_contract_with_http_info(contract, **kwargs) # noqa: E501
def get_options_contract_with_http_info(self, contract, **kwargs): # noqa: E501
- """Query specified contract detail # noqa: E501
+ """Query specified contract details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -490,10 +490,10 @@ def list_options_settlements(self, underlying, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -518,10 +518,10 @@ def list_options_settlements_with_http_info(self, underlying, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -619,7 +619,7 @@ def list_options_settlements_with_http_info(self, underlying, **kwargs): # noqa
collection_formats=collection_formats)
def get_options_settlement(self, contract, underlying, at, **kwargs): # noqa: E501
- """Get specified contract's settlement # noqa: E501
+ """Get specified contract settlement information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -645,7 +645,7 @@ def get_options_settlement(self, contract, underlying, at, **kwargs): # noqa: E
return self.get_options_settlement_with_http_info(contract, underlying, at, **kwargs) # noqa: E501
def get_options_settlement_with_http_info(self, contract, underlying, at, **kwargs): # noqa: E501
- """Get specified contract's settlement # noqa: E501
+ """Get specified contract settlement information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -749,7 +749,7 @@ def get_options_settlement_with_http_info(self, contract, underlying, at, **kwar
collection_formats=collection_formats)
def list_my_options_settlements(self, underlying, **kwargs): # noqa: E501
- """List my options settlements # noqa: E501
+ """Query personal settlement records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -759,10 +759,10 @@ def list_my_options_settlements(self, underlying, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
:param str contract: Options contract name
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -778,7 +778,7 @@ def list_my_options_settlements(self, underlying, **kwargs): # noqa: E501
return self.list_my_options_settlements_with_http_info(underlying, **kwargs) # noqa: E501
def list_my_options_settlements_with_http_info(self, underlying, **kwargs): # noqa: E501
- """List my options settlements # noqa: E501
+ """Query personal settlement records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -788,10 +788,10 @@ def list_my_options_settlements_with_http_info(self, underlying, **kwargs): # n
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
:param str contract: Options contract name
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -892,7 +892,7 @@ def list_my_options_settlements_with_http_info(self, underlying, **kwargs): # n
collection_formats=collection_formats)
def list_options_order_book(self, contract, **kwargs): # noqa: E501
- """Options order book # noqa: E501
+ """Query options contract order book # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -902,9 +902,9 @@ def list_options_order_book(self, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -920,7 +920,7 @@ def list_options_order_book(self, contract, **kwargs): # noqa: E501
return self.list_options_order_book_with_http_info(contract, **kwargs) # noqa: E501
def list_options_order_book_with_http_info(self, contract, **kwargs): # noqa: E501
- """Options order book # noqa: E501
+ """Query options contract order book # noqa: E501
Bids will be sorted by price from high to low, while asks sorted reversely # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -930,9 +930,9 @@ def list_options_order_book_with_http_info(self, contract, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str contract: Options contract name (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Whether the order book update ID will be returned. This ID increases by 1 on every order book update
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Whether to return depth update ID. This ID increments by 1 each time depth changes
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1025,7 +1025,7 @@ def list_options_order_book_with_http_info(self, contract, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_options_tickers(self, underlying, **kwargs): # noqa: E501
- """List tickers of options contracts # noqa: E501
+ """Query options market ticker information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1049,7 +1049,7 @@ def list_options_tickers(self, underlying, **kwargs): # noqa: E501
return self.list_options_tickers_with_http_info(underlying, **kwargs) # noqa: E501
def list_options_tickers_with_http_info(self, underlying, **kwargs): # noqa: E501
- """List tickers of options contracts # noqa: E501
+ """Query options market ticker information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1137,7 +1137,7 @@ def list_options_tickers_with_http_info(self, underlying, **kwargs): # noqa: E5
collection_formats=collection_formats)
def list_options_underlying_tickers(self, underlying, **kwargs): # noqa: E501
- """Get underlying ticker # noqa: E501
+ """Query underlying ticker information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1161,7 +1161,7 @@ def list_options_underlying_tickers(self, underlying, **kwargs): # noqa: E501
return self.list_options_underlying_tickers_with_http_info(underlying, **kwargs) # noqa: E501
def list_options_underlying_tickers_with_http_info(self, underlying, **kwargs): # noqa: E501
- """Get underlying ticker # noqa: E501
+ """Query underlying ticker information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1249,7 +1249,7 @@ def list_options_underlying_tickers_with_http_info(self, underlying, **kwargs):
collection_formats=collection_formats)
def list_options_candlesticks(self, contract, **kwargs): # noqa: E501
- """Get options candlesticks # noqa: E501
+ """Options contract market candlestick chart # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1258,10 +1258,10 @@ def list_options_candlesticks(self, contract, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str interval: Interval time between data points
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str interval: Time interval between data points
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1277,7 +1277,7 @@ def list_options_candlesticks(self, contract, **kwargs): # noqa: E501
return self.list_options_candlesticks_with_http_info(contract, **kwargs) # noqa: E501
def list_options_candlesticks_with_http_info(self, contract, **kwargs): # noqa: E501
- """Get options candlesticks # noqa: E501
+ """Options contract market candlestick chart # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1286,10 +1286,10 @@ def list_options_candlesticks_with_http_info(self, contract, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str contract: Options contract name (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str interval: Interval time between data points
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str interval: Time interval between data points
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1385,7 +1385,7 @@ def list_options_candlesticks_with_http_info(self, contract, **kwargs): # noqa:
collection_formats=collection_formats)
def list_options_underlying_candlesticks(self, underlying, **kwargs): # noqa: E501
- """Mark price candlesticks of an underlying # noqa: E501
+ """Underlying index price candlestick chart # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1394,10 +1394,10 @@ def list_options_underlying_candlesticks(self, underlying, **kwargs): # noqa: E
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str interval: Interval time between data points
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str interval: Time interval between data points
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1413,7 +1413,7 @@ def list_options_underlying_candlesticks(self, underlying, **kwargs): # noqa: E
return self.list_options_underlying_candlesticks_with_http_info(underlying, **kwargs) # noqa: E501
def list_options_underlying_candlesticks_with_http_info(self, underlying, **kwargs): # noqa: E501
- """Mark price candlesticks of an underlying # noqa: E501
+ """Underlying index price candlestick chart # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1422,10 +1422,10 @@ def list_options_underlying_candlesticks_with_http_info(self, underlying, **kwar
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
- :param int limit: Maximum number of records to be returned in a single list
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str interval: Interval time between data points
+ :param int limit: Maximum number of records returned in a single list
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str interval: Time interval between data points
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1521,7 +1521,7 @@ def list_options_underlying_candlesticks_with_http_info(self, underlying, **kwar
collection_formats=collection_formats)
def list_options_trades(self, **kwargs): # noqa: E501
- """Options trade history # noqa: E501
+ """Market trade records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1530,11 +1530,11 @@ def list_options_trades(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name
- :param str type: `C` is call, while `P` is put
- :param int limit: Maximum number of records to be returned in a single list
+ :param str type: `C` for call, `P` for put
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1550,7 +1550,7 @@ def list_options_trades(self, **kwargs): # noqa: E501
return self.list_options_trades_with_http_info(**kwargs) # noqa: E501
def list_options_trades_with_http_info(self, **kwargs): # noqa: E501
- """Options trade history # noqa: E501
+ """Market trade records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1559,11 +1559,11 @@ def list_options_trades_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name
- :param str type: `C` is call, while `P` is put
- :param int limit: Maximum number of records to be returned in a single list
+ :param str type: `C` for call, `P` for put
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1660,7 +1660,7 @@ def list_options_trades_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_options_account(self, **kwargs): # noqa: E501
- """List options account # noqa: E501
+ """Query account information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1683,7 +1683,7 @@ def list_options_account(self, **kwargs): # noqa: E501
return self.list_options_account_with_http_info(**kwargs) # noqa: E501
def list_options_account_with_http_info(self, **kwargs): # noqa: E501
- """List options account # noqa: E501
+ """Query account information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1763,7 +1763,7 @@ def list_options_account_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_options_account_book(self, **kwargs): # noqa: E501
- """List account changing history # noqa: E501
+ """Query account change history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1771,11 +1771,11 @@ def list_options_account_book(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1791,7 +1791,7 @@ def list_options_account_book(self, **kwargs): # noqa: E501
return self.list_options_account_book_with_http_info(**kwargs) # noqa: E501
def list_options_account_book_with_http_info(self, **kwargs): # noqa: E501
- """List account changing history # noqa: E501
+ """Query account change history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1799,11 +1799,11 @@ def list_options_account_book_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
- :param str type: Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
+ :param str type: Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2242,13 +2242,13 @@ def list_options_orders(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Options contract name
:param str underlying: Underlying
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2272,13 +2272,13 @@ def list_options_orders_with_http_info(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Only list the orders with this status (required)
+ :param str status: Query order list based on status (required)
:param str contract: Options contract name
:param str underlying: Underlying
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2498,7 +2498,7 @@ def create_options_order_with_http_info(self, options_order, **kwargs): # noqa:
collection_formats=collection_formats)
def cancel_options_orders(self, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2508,7 +2508,7 @@ def cancel_options_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name
:param str underlying: Underlying
- :param str side: All bids or asks. Both included if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2524,7 +2524,7 @@ def cancel_options_orders(self, **kwargs): # noqa: E501
return self.cancel_options_orders_with_http_info(**kwargs) # noqa: E501
def cancel_options_orders_with_http_info(self, **kwargs): # noqa: E501
- """Cancel all `open` orders matched # noqa: E501
+ """Cancel all orders with 'open' status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2534,7 +2534,7 @@ def cancel_options_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str contract: Options contract name
:param str underlying: Underlying
- :param str side: All bids or asks. Both included if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2616,7 +2616,7 @@ def cancel_options_orders_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_options_order(self, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2624,7 +2624,7 @@ def get_options_order(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2640,7 +2640,7 @@ def get_options_order(self, order_id, **kwargs): # noqa: E501
return self.get_options_order_with_http_info(order_id, **kwargs) # noqa: E501
def get_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2648,7 +2648,7 @@ def get_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2728,7 +2728,7 @@ def get_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def cancel_options_order(self, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2736,7 +2736,7 @@ def cancel_options_order(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2752,7 +2752,7 @@ def cancel_options_order(self, order_id, **kwargs): # noqa: E501
return self.cancel_options_order_with_http_info(order_id, **kwargs) # noqa: E501
def cancel_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2760,7 +2760,7 @@ def cancel_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int order_id: Order ID returned on successful order creation (required)
+ :param int order_id: Order ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2842,7 +2842,7 @@ def cancel_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501
def countdown_cancel_all_options(self, countdown_cancel_all_options_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. # noqa: E501
+ Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_options(countdown_cancel_all_options_task, async_req=True)
@@ -2867,7 +2867,7 @@ def countdown_cancel_all_options(self, countdown_cancel_all_options_task, **kwar
def countdown_cancel_all_options_with_http_info(self, countdown_cancel_all_options_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. # noqa: E501
+ Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_options_with_http_info(countdown_cancel_all_options_task, async_req=True)
@@ -2958,7 +2958,7 @@ def countdown_cancel_all_options_with_http_info(self, countdown_cancel_all_optio
collection_formats=collection_formats)
def list_my_options_trades(self, underlying, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2968,10 +2968,10 @@ def list_my_options_trades(self, underlying, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
:param str contract: Options contract name
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2987,7 +2987,7 @@ def list_my_options_trades(self, underlying, **kwargs): # noqa: E501
return self.list_my_options_trades_with_http_info(underlying, **kwargs) # noqa: E501
def list_my_options_trades_with_http_info(self, underlying, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2997,10 +2997,10 @@ def list_my_options_trades_with_http_info(self, underlying, **kwargs): # noqa:
:param bool async_req: execute request asynchronously
:param str underlying: Underlying (Obtained by listing underlying endpoint) (required)
:param str contract: Options contract name
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
- :param int _from: Start timestamp
- :param int to: End timestamp
+ :param int _from: Start timestamp Specify start time, time format is Unix timestamp. If not specified, it defaults to (the data start time of the time range actually returned by to and limit)
+ :param int to: Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3101,7 +3101,7 @@ def list_my_options_trades_with_http_info(self, underlying, **kwargs): # noqa:
collection_formats=collection_formats)
def get_options_mmp(self, **kwargs): # noqa: E501
- """MMP Query # noqa: E501
+ """MMP Query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3125,7 +3125,7 @@ def get_options_mmp(self, **kwargs): # noqa: E501
return self.get_options_mmp_with_http_info(**kwargs) # noqa: E501
def get_options_mmp_with_http_info(self, **kwargs): # noqa: E501
- """MMP Query # noqa: E501
+ """MMP Query. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
diff --git a/gate_api/api/rebate_api.py b/gate_api/api/rebate_api.py
index 518a74f..f04f15e 100644
--- a/gate_api/api/rebate_api.py
+++ b/gate_api/api/rebate_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,20 +37,20 @@ def __init__(self, api_client=None):
self.api_client = api_client
def agency_transaction_history(self, **kwargs): # noqa: E501
- """The agency obtains the transaction history of the recommended user # noqa: E501
+ """Broker obtains transaction history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.agency_transaction_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify the currency pair, if not specified, return all currency pairs
+ :param str currency_pair: Specify the trading pair. If not specified, returns all trading pairs
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -67,20 +67,20 @@ def agency_transaction_history(self, **kwargs): # noqa: E501
return self.agency_transaction_history_with_http_info(**kwargs) # noqa: E501
def agency_transaction_history_with_http_info(self, **kwargs): # noqa: E501
- """The agency obtains the transaction history of the recommended user # noqa: E501
+ """Broker obtains transaction history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.agency_transaction_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify the currency pair, if not specified, return all currency pairs
+ :param str currency_pair: Specify the trading pair. If not specified, returns all trading pairs
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -178,20 +178,21 @@ def agency_transaction_history_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def agency_commissions_history(self, **kwargs): # noqa: E501
- """The agency obtains the commission history of the recommended user # noqa: E501
+ """Broker obtains rebate history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.agency_commissions_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param int commission_type: Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -208,20 +209,21 @@ def agency_commissions_history(self, **kwargs): # noqa: E501
return self.agency_commissions_history_with_http_info(**kwargs) # noqa: E501
def agency_commissions_history_with_http_info(self, **kwargs): # noqa: E501
- """The agency obtains the commission history of the recommended user # noqa: E501
+ """Broker obtains rebate history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.agency_commissions_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param int commission_type: Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -241,6 +243,7 @@ def agency_commissions_history_with_http_info(self, **kwargs): # noqa: E501
all_params = [
'currency',
+ 'commission_type',
'user_id',
'_from',
'to',
@@ -278,6 +281,8 @@ def agency_commissions_history_with_http_info(self, **kwargs): # noqa: E501
query_params = []
if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'commission_type' in local_var_params and local_var_params['commission_type'] is not None: # noqa: E501
+ query_params.append(('commission_type', local_var_params['commission_type'])) # noqa: E501
if 'user_id' in local_var_params and local_var_params['user_id'] is not None: # noqa: E501
query_params.append(('user_id', local_var_params['user_id'])) # noqa: E501
if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
@@ -319,20 +324,20 @@ def agency_commissions_history_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def partner_transaction_history(self, **kwargs): # noqa: E501
- """Partner obtains transaction records of recommended users # noqa: E501
+ """Partner obtains transaction history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_transaction_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify the currency pair, if not specified, return all currency pairs
+ :param str currency_pair: Specify the trading pair. If not specified, returns all trading pairs
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -349,20 +354,20 @@ def partner_transaction_history(self, **kwargs): # noqa: E501
return self.partner_transaction_history_with_http_info(**kwargs) # noqa: E501
def partner_transaction_history_with_http_info(self, **kwargs): # noqa: E501
- """Partner obtains transaction records of recommended users # noqa: E501
+ """Partner obtains transaction history of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_transaction_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify the currency pair, if not specified, return all currency pairs
+ :param str currency_pair: Specify the trading pair. If not specified, returns all trading pairs
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -460,20 +465,20 @@ def partner_transaction_history_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def partner_commissions_history(self, **kwargs): # noqa: E501
- """Partner obtains commission records of recommended users # noqa: E501
+ """Partner obtains rebate records of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_commissions_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
+ :param str currency: Specify the currency. If not specified, returns all currencies
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -490,20 +495,20 @@ def partner_commissions_history(self, **kwargs): # noqa: E501
return self.partner_commissions_history_with_http_info(**kwargs) # noqa: E501
def partner_commissions_history_with_http_info(self, **kwargs): # noqa: E501
- """Partner obtains commission records of recommended users # noqa: E501
+ """Partner obtains rebate records of recommended users # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_commissions_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
+ :param str currency: Specify the currency. If not specified, returns all currencies
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -603,7 +608,7 @@ def partner_commissions_history_with_http_info(self, **kwargs): # noqa: E501
def partner_sub_list(self, **kwargs): # noqa: E501
"""Partner subordinate list # noqa: E501
- Including sub-agents, direct customers, indirect customers # noqa: E501
+ Including sub-agents, direct customers, and indirect customers # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_sub_list(async_req=True)
@@ -611,7 +616,7 @@ def partner_sub_list(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int user_id: User ID. If not specified, all user records will be returned
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -630,7 +635,7 @@ def partner_sub_list(self, **kwargs): # noqa: E501
def partner_sub_list_with_http_info(self, **kwargs): # noqa: E501
"""Partner subordinate list # noqa: E501
- Including sub-agents, direct customers, indirect customers # noqa: E501
+ Including sub-agents, direct customers, and indirect customers # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.partner_sub_list_with_http_info(async_req=True)
@@ -638,7 +643,7 @@ def partner_sub_list_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int user_id: User ID. If not specified, all user records will be returned
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -727,20 +732,20 @@ def partner_sub_list_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def rebate_broker_commission_history(self, **kwargs): # noqa: E501
- """The broker obtains the user's commission rebate records # noqa: E501
+ """Broker obtains user's rebate records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.rebate_broker_commission_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: The start time of the query record. If not specified, the default is to push forward 30 days from the current time.
- :param int to: Time range ending, default to current time
+ :param int _from: Start time of the query record. If not specified, defaults to 30 days before the current time
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -756,20 +761,20 @@ def rebate_broker_commission_history(self, **kwargs): # noqa: E501
return self.rebate_broker_commission_history_with_http_info(**kwargs) # noqa: E501
def rebate_broker_commission_history_with_http_info(self, **kwargs): # noqa: E501
- """The broker obtains the user's commission rebate records # noqa: E501
+ """Broker obtains user's rebate records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.rebate_broker_commission_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: The start time of the query record. If not specified, the default is to push forward 30 days from the current time.
- :param int to: Time range ending, default to current time
+ :param int _from: Start time of the query record. If not specified, defaults to 30 days before the current time
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -863,20 +868,20 @@ def rebate_broker_commission_history_with_http_info(self, **kwargs): # noqa: E5
collection_formats=collection_formats)
def rebate_broker_transaction_history(self, **kwargs): # noqa: E501
- """The broker obtains the user's trading history # noqa: E501
+ """Broker obtains user's trading history # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.rebate_broker_transaction_history(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: The start time of the query record. If not specified, the default is to push forward 30 days from the current time.
- :param int to: Time range ending, default to current time
+ :param int _from: Start time of the query record. If not specified, defaults to 30 days before the current time
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -892,20 +897,20 @@ def rebate_broker_transaction_history(self, **kwargs): # noqa: E501
return self.rebate_broker_transaction_history_with_http_info(**kwargs) # noqa: E501
def rebate_broker_transaction_history_with_http_info(self, **kwargs): # noqa: E501
- """The broker obtains the user's trading history # noqa: E501
+ """Broker obtains user's trading history # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.rebate_broker_transaction_history_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int limit: Maximum number of records to be returned in a single list
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param int user_id: User ID. If not specified, all user records will be returned
- :param int _from: The start time of the query record. If not specified, the default is to push forward 30 days from the current time.
- :param int to: Time range ending, default to current time
+ :param int _from: Start time of the query record. If not specified, defaults to 30 days before the current time
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -999,7 +1004,7 @@ def rebate_broker_transaction_history_with_http_info(self, **kwargs): # noqa: E
collection_formats=collection_formats)
def rebate_user_info(self, **kwargs): # noqa: E501
- """User retrieves rebate information # noqa: E501
+ """User obtains rebate information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1022,7 +1027,7 @@ def rebate_user_info(self, **kwargs): # noqa: E501
return self.rebate_user_info_with_http_info(**kwargs) # noqa: E501
def rebate_user_info_with_http_info(self, **kwargs): # noqa: E501
- """User retrieves rebate information # noqa: E501
+ """User obtains rebate information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1100,3 +1105,117 @@ def rebate_user_info_with_http_info(self, **kwargs): # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+
+ def user_sub_relation(self, user_id_list, **kwargs): # noqa: E501
+ """User subordinate relationship # noqa: E501
+
+ Query whether the specified user is within the system # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.user_sub_relation(user_id_list, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str user_id_list: Query user ID list, separated by commas. If more than 100, only 100 will be returned (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: gate_api.UserSubRelation
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.user_sub_relation_with_http_info(user_id_list, **kwargs) # noqa: E501
+
+ def user_sub_relation_with_http_info(self, user_id_list, **kwargs): # noqa: E501
+ """User subordinate relationship # noqa: E501
+
+ Query whether the specified user is within the system # noqa: E501
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.user_sub_relation_with_http_info(user_id_list, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str user_id_list: Query user ID list, separated by commas. If more than 100, only 100 will be returned (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(gate_api.UserSubRelation, status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'user_id_list'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method user_sub_relation" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'user_id_list' is set
+ if self.api_client.client_side_validation and ('user_id_list' not in local_var_params or # noqa: E501
+ local_var_params['user_id_list'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `user_id_list` when calling `user_sub_relation`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+ if 'user_id_list' in local_var_params and local_var_params['user_id_list'] is not None: # noqa: E501
+ query_params.append(('user_id_list', local_var_params['user_id_list'])) # noqa: E501
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/rebate/user/sub_relation', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='UserSubRelation', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
diff --git a/gate_api/api/spot_api.py b/gate_api/api/spot_api.py
index 2e3ece6..1894742 100644
--- a/gate_api/api/spot_api.py
+++ b/gate_api/api/spot_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,9 +37,9 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_currencies(self, **kwargs): # noqa: E501
- """List all currencies' details # noqa: E501
+ """Query all currency information # noqa: E501
- Currency has two forms: 1. Only currency name, e.g., BTC, USDT 2. `_`, 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 `_`. # noqa: E501
+ 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 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_currencies(async_req=True)
@@ -61,9 +61,9 @@ def list_currencies(self, **kwargs): # noqa: E501
return self.list_currencies_with_http_info(**kwargs) # noqa: E501
def list_currencies_with_http_info(self, **kwargs): # noqa: E501
- """List all currencies' details # noqa: E501
+ """Query all currency information # noqa: E501
- Currency has two forms: 1. Only currency name, e.g., BTC, USDT 2. `_`, 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 `_`. # noqa: E501
+ 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 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_currencies_with_http_info(async_req=True)
@@ -142,7 +142,7 @@ def list_currencies_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_currency(self, currency, **kwargs): # noqa: E501
- """Get details of a specific currency # noqa: E501
+ """Query single currency information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -166,7 +166,7 @@ def get_currency(self, currency, **kwargs): # noqa: E501
return self.get_currency_with_http_info(currency, **kwargs) # noqa: E501
def get_currency_with_http_info(self, currency, **kwargs): # noqa: E501
- """Get details of a specific currency # noqa: E501
+ """Query single currency information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -254,7 +254,7 @@ def get_currency_with_http_info(self, currency, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_currency_pairs(self, **kwargs): # noqa: E501
- """List all currency pairs supported # noqa: E501
+ """Query all supported currency pairs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -277,7 +277,7 @@ def list_currency_pairs(self, **kwargs): # noqa: E501
return self.list_currency_pairs_with_http_info(**kwargs) # noqa: E501
def list_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
- """List all currency pairs supported # noqa: E501
+ """Query all supported currency pairs # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -357,7 +357,7 @@ def list_currency_pairs_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_currency_pair(self, currency_pair, **kwargs): # noqa: E501
- """Get details of a specifc currency pair # noqa: E501
+ """Query single currency pair details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -381,7 +381,7 @@ def get_currency_pair(self, currency_pair, **kwargs): # noqa: E501
return self.get_currency_pair_with_http_info(currency_pair, **kwargs) # noqa: E501
def get_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Get details of a specifc currency pair # noqa: E501
+ """Query single currency pair details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -469,9 +469,9 @@ def get_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa: E5
collection_formats=collection_formats)
def list_tickers(self, **kwargs): # noqa: E501
- """Retrieve ticker information # noqa: E501
+ """Get currency pair ticker information # noqa: E501
- Return only related data if `currency_pair` is specified; otherwise return all of them # noqa: E501
+ If `currency_pair` is specified, only query that currency pair; otherwise return all information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_tickers(async_req=True)
@@ -495,9 +495,9 @@ def list_tickers(self, **kwargs): # noqa: E501
return self.list_tickers_with_http_info(**kwargs) # noqa: E501
def list_tickers_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve ticker information # noqa: E501
+ """Get currency pair ticker information # noqa: E501
- Return only related data if `currency_pair` is specified; otherwise return all of them # noqa: E501
+ If `currency_pair` is specified, only query that currency pair; otherwise return all information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_tickers_with_http_info(async_req=True)
@@ -584,9 +584,9 @@ def list_tickers_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_order_book(self, currency_pair, **kwargs): # noqa: E501
- """Retrieve order book # noqa: E501
+ """Get market depth information # noqa: E501
- Order book will be sorted by price from high to low on bids; low to high on asks # noqa: E501
+ Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_order_book(currency_pair, async_req=True)
@@ -594,9 +594,9 @@ def list_order_book(self, currency_pair, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Return order book ID
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Return order book update ID
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -612,9 +612,9 @@ def list_order_book(self, currency_pair, **kwargs): # noqa: E501
return self.list_order_book_with_http_info(currency_pair, **kwargs) # noqa: E501
def list_order_book_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Retrieve order book # noqa: E501
+ """Get market depth information # noqa: E501
- Order book will be sorted by price from high to low on bids; low to high on asks # noqa: E501
+ Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_order_book_with_http_info(currency_pair, async_req=True)
@@ -622,9 +622,9 @@ def list_order_book_with_http_info(self, currency_pair, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param str interval: Order depth. 0 means no aggregation is applied. default to 0
- :param int limit: Maximum number of order depth data in asks or bids
- :param bool with_id: Return order book ID
+ :param str interval: Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified
+ :param int limit: Number of depth levels
+ :param bool with_id: Return order book update ID
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -715,9 +715,9 @@ def list_order_book_with_http_info(self, currency_pair, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_trades(self, currency_pair, **kwargs): # noqa: E501
- """Retrieve market trades # noqa: E501
+ """Query market transaction records # noqa: E501
- 支持指定 `from` 和 `to` 按时间范围查询或基于 `last_id` 的翻页查询。默认按时间范围查询,查询范围为最近30天。 基于 `last_id` 翻页的查询方式不再推荐继续使用。如果指定 `last_id` ，时间范围查询参数会被忽略。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
+ Supports querying by time range using `from` and `to` parameters or pagination based on `last_id`. By default, queries the last 30 days. Pagination based on `last_id` is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_trades(currency_pair, async_req=True)
@@ -725,11 +725,11 @@ def list_trades(self, currency_pair, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param int limit: Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param bool reverse: Whether the id of records to be retrieved should be less than the last_id specified. Default to false. When `last_id` is specified. Set `reverse` to `true` to trace back trading history; `false` to retrieve latest tradings. No effect if `last_id` is not specified.
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param bool reverse: Whether to retrieve data less than `last_id`. Default returns records greater than `last_id`. Set to `true` to trace back market trade records, `false` to get latest trades. No effect when `last_id` is not set.
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -746,9 +746,9 @@ def list_trades(self, currency_pair, **kwargs): # noqa: E501
return self.list_trades_with_http_info(currency_pair, **kwargs) # noqa: E501
def list_trades_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Retrieve market trades # noqa: E501
+ """Query market transaction records # noqa: E501
- 支持指定 `from` 和 `to` 按时间范围查询或基于 `last_id` 的翻页查询。默认按时间范围查询,查询范围为最近30天。 基于 `last_id` 翻页的查询方式不再推荐继续使用。如果指定 `last_id` ，时间范围查询参数会被忽略。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
+ Supports querying by time range using `from` and `to` parameters or pagination based on `last_id`. By default, queries the last 30 days. Pagination based on `last_id` is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_trades_with_http_info(currency_pair, async_req=True)
@@ -756,11 +756,11 @@ def list_trades_with_http_info(self, currency_pair, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param int limit: Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000
- :param str last_id: Specify list staring point using the `id` of last record in previous list-query results
- :param bool reverse: Whether the id of records to be retrieved should be less than the last_id specified. Default to false. When `last_id` is specified. Set `reverse` to `true` to trace back trading history; `false` to retrieve latest tradings. No effect if `last_id` is not specified.
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param int limit: Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000
+ :param str last_id: Use the ID of the last record in the previous list as the starting point for the next list Operations based on custom IDs can only be checked when orders are pending. After orders are completed (filled/cancelled), they can be checked within 1 hour after completion. After expiration, only order IDs can be used
+ :param bool reverse: Whether to retrieve data less than `last_id`. Default returns records greater than `last_id`. Set to `true` to trace back market trade records, `false` to get latest trades. No effect when `last_id` is not set.
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
:param _return_http_data_only: response data without head status code
and headers
@@ -865,7 +865,7 @@ def list_trades_with_http_info(self, currency_pair, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_candlesticks(self, currency_pair, **kwargs): # noqa: E501
- """Market candlesticks # noqa: E501
+ """Market K-line chart # noqa: E501
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -875,10 +875,10 @@ def list_candlesticks(self, currency_pair, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param str interval: Interval time between data points. Note that `30d` means 1 natual month, not 30 days
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param str interval: Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -894,7 +894,7 @@ def list_candlesticks(self, currency_pair, **kwargs): # noqa: E501
return self.list_candlesticks_with_http_info(currency_pair, **kwargs) # noqa: E501
def list_candlesticks_with_http_info(self, currency_pair, **kwargs): # noqa: E501
- """Market candlesticks # noqa: E501
+ """Market K-line chart # noqa: E501
Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -904,10 +904,10 @@ def list_candlesticks_with_http_info(self, currency_pair, **kwargs): # noqa: E5
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair (required)
- :param int limit: Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
+ :param int limit: Maximum number of recent data points to return. `limit` conflicts with `from` and `to`. If either `from` or `to` is specified, request will be rejected.
:param int _from: Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified
- :param int to: End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time
- :param str interval: Interval time between data points. Note that `30d` means 1 natual month, not 30 days
+ :param int to: Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision
+ :param str interval: Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1001,16 +1001,16 @@ def list_candlesticks_with_http_info(self, currency_pair, **kwargs): # noqa: E5
collection_formats=collection_formats)
def get_fee(self, **kwargs): # noqa: E501
- """Query user trading fee rates # noqa: E501
+ """Query account fee rates # noqa: E501
- This API is deprecated in favour of new fee retrieving API `/wallet/fee`. # noqa: E501
+ This API is deprecated. The new fee query API is `/wallet/fee` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_fee(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs
+ :param str currency_pair: Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1026,16 +1026,16 @@ def get_fee(self, **kwargs): # noqa: E501
return self.get_fee_with_http_info(**kwargs) # noqa: E501
def get_fee_with_http_info(self, **kwargs): # noqa: E501
- """Query user trading fee rates # noqa: E501
+ """Query account fee rates # noqa: E501
- This API is deprecated in favour of new fee retrieving API `/wallet/fee`. # noqa: E501
+ This API is deprecated. The new fee query API is `/wallet/fee` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_fee_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs
+ :param str currency_pair: Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1111,7 +1111,7 @@ def get_fee_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_batch_spot_fee(self, currency_pairs, **kwargs): # noqa: E501
- """Query a batch of user trading fee rates # noqa: E501
+ """Batch query account fee rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1119,7 +1119,7 @@ def get_batch_spot_fee(self, currency_pairs, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pairs: A request can only query up to 50 currency pairs (required)
+ :param str currency_pairs: Maximum 50 currency pairs per request (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1135,7 +1135,7 @@ def get_batch_spot_fee(self, currency_pairs, **kwargs): # noqa: E501
return self.get_batch_spot_fee_with_http_info(currency_pairs, **kwargs) # noqa: E501
def get_batch_spot_fee_with_http_info(self, currency_pairs, **kwargs): # noqa: E501
- """Query a batch of user trading fee rates # noqa: E501
+ """Batch query account fee rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1143,7 +1143,7 @@ def get_batch_spot_fee_with_http_info(self, currency_pairs, **kwargs): # noqa:
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pairs: A request can only query up to 50 currency pairs (required)
+ :param str currency_pairs: Maximum 50 currency pairs per request (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1223,7 +1223,7 @@ def get_batch_spot_fee_with_http_info(self, currency_pairs, **kwargs): # noqa:
collection_formats=collection_formats)
def list_spot_accounts(self, **kwargs): # noqa: E501
- """List spot accounts # noqa: E501
+ """List spot trading accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1231,7 +1231,7 @@ def list_spot_accounts(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1247,7 +1247,7 @@ def list_spot_accounts(self, **kwargs): # noqa: E501
return self.list_spot_accounts_with_http_info(**kwargs) # noqa: E501
def list_spot_accounts_with_http_info(self, **kwargs): # noqa: E501
- """List spot accounts # noqa: E501
+ """List spot trading accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1255,7 +1255,7 @@ def list_spot_accounts_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1331,21 +1331,22 @@ def list_spot_accounts_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_spot_account_book(self, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query spot account transaction history # noqa: E501
- 记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
+ Record query time range cannot exceed 30 days. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_spot_account_book(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str currency: Query by specified currency name
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
+ :param int limit: Maximum number of records returned in a single list
+ :param str type: Query by specified account change type. If not specified, all change types will be included.
+ :param str code: Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type`
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1361,21 +1362,22 @@ def list_spot_account_book(self, **kwargs): # noqa: E501
return self.list_spot_account_book_with_http_info(**kwargs) # noqa: E501
def list_spot_account_book_with_http_info(self, **kwargs): # noqa: E501
- """Query account book # noqa: E501
+ """Query spot account transaction history # noqa: E501
- 记录查询时间范围不允许超过 30 天。 使用 limit&page分页功能检索数据时最大分页数量为100,000条，即 (limit * page - 1) <= 100000。 # noqa: E501
+ Record query time range cannot exceed 30 days. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_spot_account_book_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str currency: Query by specified currency name
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param int page: Page number
- :param int limit: Maximum number of records to be returned in a single list
- :param str type: Only retrieve changes of the specified type. All types will be returned if not specified.
+ :param int limit: Maximum number of records returned in a single list
+ :param str type: Query by specified account change type. If not specified, all change types will be included.
+ :param str code: Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type`
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1398,7 +1400,8 @@ def list_spot_account_book_with_http_info(self, **kwargs): # noqa: E501
'to',
'page',
'limit',
- 'type'
+ 'type',
+ 'code'
]
all_params.extend(
[
@@ -1441,6 +1444,8 @@ def list_spot_account_book_with_http_info(self, **kwargs): # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
if 'type' in local_var_params and local_var_params['type'] is not None: # noqa: E501
query_params.append(('type', local_var_params['type'])) # noqa: E501
+ if 'code' in local_var_params and local_var_params['code'] is not None: # noqa: E501
+ query_params.append(('code', local_var_params['code'])) # noqa: E501
header_params = {}
@@ -1472,9 +1477,9 @@ def list_spot_account_book_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_batch_orders(self, order, **kwargs): # noqa: E501
- """Create a batch of orders # noqa: E501
+ """Batch place orders # noqa: E501
- Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders # noqa: E501
+ Batch order requirements: 1. Custom order field `text` must be specified 2. Up to 4 currency pairs per request, with up to 10 orders per currency pair 3. Spot orders and margin orders cannot be mixed; all `account` fields in the same request must be identical # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_batch_orders(order, async_req=True)
@@ -1482,7 +1487,7 @@ def create_batch_orders(self, order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param list[Order] order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1498,9 +1503,9 @@ def create_batch_orders(self, order, **kwargs): # noqa: E501
return self.create_batch_orders_with_http_info(order, **kwargs) # noqa: E501
def create_batch_orders_with_http_info(self, order, **kwargs): # noqa: E501
- """Create a batch of orders # noqa: E501
+ """Batch place orders # noqa: E501
- Batch orders requirements: 1. custom order field `text` is required 2. At most 4 currency pairs, maximum 10 orders each, are allowed in one request 3. No mixture of spot orders and margin orders, i.e. `account` must be identical for all orders # noqa: E501
+ Batch order requirements: 1. Custom order field `text` must be specified 2. Up to 4 currency pairs per request, with up to 10 orders per currency pair 3. Spot orders and margin orders cannot be mixed; all `account` fields in the same request must be identical # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_batch_orders_with_http_info(order, async_req=True)
@@ -1508,7 +1513,7 @@ def create_batch_orders_with_http_info(self, order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param list[Order] order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1597,7 +1602,7 @@ def create_batch_orders_with_http_info(self, order, **kwargs): # noqa: E501
def list_all_open_orders(self, **kwargs): # noqa: E501
"""List all open orders # noqa: E501
- List open orders in all currency pairs. Note that pagination parameters affect record number in each currency pair's open order list. No pagination is applied to the number of currency pairs returned. All currency pairs with open orders will be returned. Spot,portfolio and margin orders are returned by default. To list cross margin orders, `account` must be set to `cross_margin` # noqa: E501
+ Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_all_open_orders(async_req=True)
@@ -1606,7 +1611,7 @@ def list_all_open_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
:param int limit: Maximum number of records returned in one page in each currency pair
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
+ :param str account: Specify query account
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1624,7 +1629,7 @@ def list_all_open_orders(self, **kwargs): # noqa: E501
def list_all_open_orders_with_http_info(self, **kwargs): # noqa: E501
"""List all open orders # noqa: E501
- List open orders in all currency pairs. Note that pagination parameters affect record number in each currency pair's open order list. No pagination is applied to the number of currency pairs returned. All currency pairs with open orders will be returned. Spot,portfolio and margin orders are returned by default. To list cross margin orders, `account` must be set to `cross_margin` # noqa: E501
+ Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_all_open_orders_with_http_info(async_req=True)
@@ -1633,7 +1638,7 @@ def list_all_open_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int page: Page number
:param int limit: Maximum number of records returned in one page in each currency pair
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
+ :param str account: Specify query account
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1721,9 +1726,9 @@ def list_all_open_orders_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_cross_liquidate_order(self, liquidate_order, **kwargs): # noqa: E501
- """close position when cross-currency is disabled # noqa: E501
+ """Close position when cross-currency is disabled # noqa: E501
- Currently, only cross-margin accounts are supported to close position when cross currencies are disabled. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in the order book) / 0.998 # noqa: E501
+ Currently, only cross-margin accounts are supported to place buy orders for disabled currencies. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in pending orders) / 0.998 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_cross_liquidate_order(liquidate_order, async_req=True)
@@ -1746,9 +1751,9 @@ def create_cross_liquidate_order(self, liquidate_order, **kwargs): # noqa: E501
return self.create_cross_liquidate_order_with_http_info(liquidate_order, **kwargs) # noqa: E501
def create_cross_liquidate_order_with_http_info(self, liquidate_order, **kwargs): # noqa: E501
- """close position when cross-currency is disabled # noqa: E501
+ """Close position when cross-currency is disabled # noqa: E501
- Currently, only cross-margin accounts are supported to close position when cross currencies are disabled. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in the order book) / 0.998 # noqa: E501
+ Currently, only cross-margin accounts are supported to place buy orders for disabled currencies. Maximum buy quantity = (unpaid principal and interest - currency balance - the amount of the currency in pending orders) / 0.998 # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_cross_liquidate_order_with_http_info(liquidate_order, async_req=True)
@@ -1841,21 +1846,21 @@ def create_cross_liquidate_order_with_http_info(self, liquidate_order, **kwargs)
def list_orders(self, currency_pair, status, **kwargs): # noqa: E501
"""List orders # noqa: E501
- Spot, portfolio and margin orders are returned by default. If cross margin orders are needed, `account` must be set to `cross_margin` When `status` is `open`, i.e., listing open orders, only pagination parameters `page` and `limit` are supported and `limit` cannot be larger than 100. Query by `side` and time range parameters `from` and `to` are not supported. When `status` is `finished`, i.e., listing finished orders, pagination parameters, time range parameters `from` and `to`, and `side` parameters are all supported. Time range parameters are handled as order finish time. # noqa: E501
+ Note that query results default to spot order lists for spot, unified account, and isolated margin accounts. When `status` is set to `open` (i.e., when querying pending order lists), only `page` and `limit` pagination controls are supported. `limit` can only be set to a maximum of 100. The `side` parameter and time range query parameters `from` and `to` are not supported. When `status` is set to `finished` (i.e., when querying historical orders), in addition to pagination queries, `from` and `to` time range queries are also supported. Additionally, the `side` parameter can be set to filter one-sided history. Time range filter parameters are processed according to the order end time. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_orders(currency_pair, status, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (required)
+ :param str currency_pair: Query by specified currency pair. Required for open orders, optional for filled orders (required)
:param str status: List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled (required)
:param int page: Page number
:param int limit: Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str side: All bids or asks. Both included if not specified
+ :param str account: Specify query account
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1873,21 +1878,21 @@ def list_orders(self, currency_pair, status, **kwargs): # noqa: E501
def list_orders_with_http_info(self, currency_pair, status, **kwargs): # noqa: E501
"""List orders # noqa: E501
- Spot, portfolio and margin orders are returned by default. If cross margin orders are needed, `account` must be set to `cross_margin` When `status` is `open`, i.e., listing open orders, only pagination parameters `page` and `limit` are supported and `limit` cannot be larger than 100. Query by `side` and time range parameters `from` and `to` are not supported. When `status` is `finished`, i.e., listing finished orders, pagination parameters, time range parameters `from` and `to`, and `side` parameters are all supported. Time range parameters are handled as order finish time. # noqa: E501
+ Note that query results default to spot order lists for spot, unified account, and isolated margin accounts. When `status` is set to `open` (i.e., when querying pending order lists), only `page` and `limit` pagination controls are supported. `limit` can only be set to a maximum of 100. The `side` parameter and time range query parameters `from` and `to` are not supported. When `status` is set to `finished` (i.e., when querying historical orders), in addition to pagination queries, `from` and `to` time range queries are also supported. Additionally, the `side` parameter can be set to filter one-sided history. Time range filter parameters are processed according to the order end time. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_orders_with_http_info(currency_pair, status, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (required)
+ :param str currency_pair: Query by specified currency pair. Required for open orders, optional for filled orders (required)
:param str status: List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled (required)
:param int page: Page number
:param int limit: Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str side: All bids or asks. Both included if not specified
+ :param str account: Specify query account
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str side: Specify all bids or all asks, both included if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2000,7 +2005,7 @@ def list_orders_with_http_info(self, currency_pair, status, **kwargs): # noqa:
def create_order(self, order, **kwargs): # noqa: E501
"""Create an order # noqa: E501
- You can place orders with spot, portfolio, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide the order completely. Note that the hidden part's fee will be charged using taker's fee rate. **Self Trade Prevention** - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body # noqa: E501
+ Supports spot, margin, leverage, and cross-margin leverage orders. Use different accounts through the `account` field. Default is `spot`, which means using the spot account to place orders. If the user has a `unified` account, the default is to place orders with the unified account. When using leveraged account trading (i.e., when `account` is set to `margin`), you can set `auto_borrow` to `true`. In case of insufficient account balance, the system will automatically execute `POST /margin/uni/loans` to borrow the insufficient amount. Whether assets obtained after leveraged order execution are automatically used to repay borrowing orders of the isolated margin account depends on the automatic repayment settings of the user's isolated margin account. Account automatic repayment settings can be queried and set through `/margin/auto_repay`. When using unified account trading (i.e., when `account` is set to `unified`), `auto_borrow` can also be enabled to realize automatic borrowing of insufficient amounts. However, unlike the isolated margin account, whether unified account orders are automatically repaid depends on the `auto_repay` setting when placing the order. This setting only applies to the current order, meaning only assets obtained after order execution will be used to repay borrowing orders of the cross-margin account. Unified account ordering currently supports enabling both `auto_borrow` and `auto_repay` simultaneously. Auto repayment will be triggered when the order ends, i.e., when `status` is `cancelled` or `closed`. **Order Status** The order status in pending orders is `open`, which remains `open` until all quantity is filled. If fully filled, the order ends and status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of partial fills, the status will become `cancelled`. **Iceberg Orders** `iceberg` is used to set the displayed quantity of iceberg orders and does not support complete hiding. Note that hidden portions are charged according to the taker's fee rate. **Self-Trade Prevention** Set `stp_act` to determine the self-trade prevention strategy to use # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_order(order, async_req=True)
@@ -2008,7 +2013,7 @@ def create_order(self, order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param Order order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2026,7 +2031,7 @@ def create_order(self, order, **kwargs): # noqa: E501
def create_order_with_http_info(self, order, **kwargs): # noqa: E501
"""Create an order # noqa: E501
- You can place orders with spot, portfolio, margin or cross margin account through setting the `account `field. It defaults to `spot`, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account. When margin account is used, i.e., `account` is `margin`, `auto_borrow` field can be set to `true` to enable the server to borrow the amount lacked using `POST /margin/loans` when your account's balance is not enough. Whether margin orders' fill will be used to repay margin loans automatically is determined by the auto repayment setting in your **margin account**, which can be updated or queried using `/margin/auto_repay` API. When cross margin account is used, i.e., `account` is `cross_margin`, `auto_borrow` can also be enabled to achieve borrowing the insufficient amount automatically if cross account's balance is not enough. But it differs from margin account that automatic repayment is determined by order's `auto_repay` field and only current order's fill will be used to repay cross margin loans. Automatic repayment will be triggered when the order is finished, i.e., its status is either `cancelled` or `closed`. **Order status** An order waiting to be filled is `open`, and it stays `open` until it is filled totally. If fully filled, order is finished and its status turns to `closed`.If the order is cancelled before it is totally filled, whether or not partially filled, its status is `cancelled`. **Iceberg order** `iceberg` field can be used to set the amount shown. Set to `-1` to hide the order completely. Note that the hidden part's fee will be charged using taker's fee rate. **Self Trade Prevention** - Set `stp_act` to decide the strategy of self-trade prevention. For detailed usage, refer to the `stp_act` parameter in request body # noqa: E501
+ Supports spot, margin, leverage, and cross-margin leverage orders. Use different accounts through the `account` field. Default is `spot`, which means using the spot account to place orders. If the user has a `unified` account, the default is to place orders with the unified account. When using leveraged account trading (i.e., when `account` is set to `margin`), you can set `auto_borrow` to `true`. In case of insufficient account balance, the system will automatically execute `POST /margin/uni/loans` to borrow the insufficient amount. Whether assets obtained after leveraged order execution are automatically used to repay borrowing orders of the isolated margin account depends on the automatic repayment settings of the user's isolated margin account. Account automatic repayment settings can be queried and set through `/margin/auto_repay`. When using unified account trading (i.e., when `account` is set to `unified`), `auto_borrow` can also be enabled to realize automatic borrowing of insufficient amounts. However, unlike the isolated margin account, whether unified account orders are automatically repaid depends on the `auto_repay` setting when placing the order. This setting only applies to the current order, meaning only assets obtained after order execution will be used to repay borrowing orders of the cross-margin account. Unified account ordering currently supports enabling both `auto_borrow` and `auto_repay` simultaneously. Auto repayment will be triggered when the order ends, i.e., when `status` is `cancelled` or `closed`. **Order Status** The order status in pending orders is `open`, which remains `open` until all quantity is filled. If fully filled, the order ends and status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of partial fills, the status will become `cancelled`. **Iceberg Orders** `iceberg` is used to set the displayed quantity of iceberg orders and does not support complete hiding. Note that hidden portions are charged according to the taker's fee rate. **Self-Trade Prevention** Set `stp_act` to determine the self-trade prevention strategy to use # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_order_with_http_info(order, async_req=True)
@@ -2034,7 +2039,7 @@ def create_order_with_http_info(self, order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param Order order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2123,7 +2128,7 @@ def create_order_with_http_info(self, order, **kwargs): # noqa: E501
def cancel_orders(self, **kwargs): # noqa: E501
"""Cancel all `open` orders in specified currency pair # noqa: E501
- If `account` is not set, all open orders, including spot, portfolio, margin and cross margin ones, will be cancelled. If `currency_pair` is not specified, all pending orders for trading pairs will be cancelled. You can set `account` to cancel only orders within the specified account # noqa: E501
+ When the `account` parameter is not specified, all pending orders including spot, unified account, and isolated margin will be cancelled. When `currency_pair` is not specified, all trading pair pending orders will be cancelled. You can specify a particular account to cancel all pending orders under that account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_orders(async_req=True)
@@ -2131,10 +2136,10 @@ def cancel_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str side: All bids or asks. Both included if not specified
- :param str account: Specify account type: - Classic account: Includes all if not specified - Unified account: Specify `unified` - Unified account (legacy): Can only specify `cross_margin`
- :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str side: Specify all bids or all asks, both included if not specified
+ :param str account: Specify account type Classic account: All are included if not specified Unified account: Specify `unified`
+ :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2152,7 +2157,7 @@ def cancel_orders(self, **kwargs): # noqa: E501
def cancel_orders_with_http_info(self, **kwargs): # noqa: E501
"""Cancel all `open` orders in specified currency pair # noqa: E501
- If `account` is not set, all open orders, including spot, portfolio, margin and cross margin ones, will be cancelled. If `currency_pair` is not specified, all pending orders for trading pairs will be cancelled. You can set `account` to cancel only orders within the specified account # noqa: E501
+ When the `account` parameter is not specified, all pending orders including spot, unified account, and isolated margin will be cancelled. When `currency_pair` is not specified, all trading pair pending orders will be cancelled. You can specify a particular account to cancel all pending orders under that account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_orders_with_http_info(async_req=True)
@@ -2160,10 +2165,10 @@ def cancel_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Currency pair
- :param str side: All bids or asks. Both included if not specified
- :param str account: Specify account type: - Classic account: Includes all if not specified - Unified account: Specify `unified` - Unified account (legacy): Can only specify `cross_margin`
- :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str side: Specify all bids or all asks, both included if not specified
+ :param str account: Specify account type Classic account: All are included if not specified Unified account: Specify `unified`
+ :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2251,7 +2256,7 @@ def cancel_orders_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def cancel_batch_orders(self, cancel_batch_order, **kwargs): # noqa: E501
- """Cancel a batch of orders with an ID list # noqa: E501
+ """Cancel batch orders by specified ID list # noqa: E501
Multiple currency pairs can be specified, but maximum 20 orders are allowed per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -2261,7 +2266,7 @@ def cancel_batch_orders(self, cancel_batch_order, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param list[CancelBatchOrder] cancel_batch_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2277,7 +2282,7 @@ def cancel_batch_orders(self, cancel_batch_order, **kwargs): # noqa: E501
return self.cancel_batch_orders_with_http_info(cancel_batch_order, **kwargs) # noqa: E501
def cancel_batch_orders_with_http_info(self, cancel_batch_order, **kwargs): # noqa: E501
- """Cancel a batch of orders with an ID list # noqa: E501
+ """Cancel batch orders by specified ID list # noqa: E501
Multiple currency pairs can be specified, but maximum 20 orders are allowed per request # noqa: E501
This method makes a synchronous HTTP request by default. To make an
@@ -2287,7 +2292,7 @@ def cancel_batch_orders_with_http_info(self, cancel_batch_order, **kwargs): # n
:param bool async_req: execute request asynchronously
:param list[CancelBatchOrder] cancel_batch_order: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2374,18 +2379,18 @@ def cancel_batch_orders_with_http_info(self, cancel_batch_order, **kwargs): # n
collection_formats=collection_formats)
def get_order(self, order_id, currency_pair, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Spot, portfolio and margin orders are queried by default. If cross margin orders are needed or portfolio margin account are used, account must be set to cross_margin. # noqa: E501
+ By default, queries orders for spot, unified account, and isolated margin accounts. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_order(order_id, currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
- :param str currency_pair: Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required)
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
+ :param str currency_pair: Specify the trading pair to query. This field is required when querying pending order records. This field can be omitted when querying filled order records. (required)
+ :param str account: Specify query account
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2401,18 +2406,18 @@ def get_order(self, order_id, currency_pair, **kwargs): # noqa: E501
return self.get_order_with_http_info(order_id, currency_pair, **kwargs) # noqa: E501
def get_order_with_http_info(self, order_id, currency_pair, **kwargs): # noqa: E501
- """Get a single order # noqa: E501
+ """Query single order details # noqa: E501
- Spot, portfolio and margin orders are queried by default. If cross margin orders are needed or portfolio margin account are used, account must be set to cross_margin. # noqa: E501
+ By default, queries orders for spot, unified account, and isolated margin accounts. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_order_with_http_info(order_id, currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
- :param str currency_pair: Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required)
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
+ :param str currency_pair: Specify the trading pair to query. This field is required when querying pending order records. This field can be omitted when querying filled order records. (required)
+ :param str account: Specify query account
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2502,20 +2507,20 @@ def get_order_with_http_info(self, order_id, currency_pair, **kwargs): # noqa:
collection_formats=collection_formats)
def cancel_order(self, order_id, currency_pair, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
- Spot,portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin # noqa: E501
+ By default, orders for spot, unified accounts and leveraged accounts are revoked. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_order(order_id, currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
:param str currency_pair: Currency pair (required)
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str account: Specify query account
+ :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2531,20 +2536,20 @@ def cancel_order(self, order_id, currency_pair, **kwargs): # noqa: E501
return self.cancel_order_with_http_info(order_id, currency_pair, **kwargs) # noqa: E501
def cancel_order_with_http_info(self, order_id, currency_pair, **kwargs): # noqa: E501
- """Cancel a single order # noqa: E501
+ """Cancel single order # noqa: E501
- Spot,portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin # noqa: E501
+ By default, orders for spot, unified accounts and leveraged accounts are revoked. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_order_with_http_info(order_id, currency_pair, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
:param str currency_pair: Currency pair (required)
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - ACK: Asynchronous mode, returns only key order fields - RESULT: No clearing information - FULL: Full mode (default)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str account: Specify query account
+ :param str action_mode: Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default)
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2640,20 +2645,20 @@ def cancel_order_with_http_info(self, order_id, currency_pair, **kwargs): # noq
collection_formats=collection_formats)
def amend_order(self, order_id, order_patch, **kwargs): # noqa: E501
- """Amend an order # noqa: E501
+ """Amend single order # noqa: E501
- By default, the orders of spot, portfolio and margin account are updated. If you need to modify orders of the `cross-margin` account, you must specify account as `cross_margin`. For portfolio margin account, only `cross_margin` account is supported. Currently, both request body and query support currency_pair and account parameter passing, but request body has higher priority Currently, only supports modification of `price` or `amount` fields. Regarding rate limiting: modify order and create order sharing rate limiting rules. Regarding matching priority: Only reducing the quantity without modifying the priority of matching, altering the price or increasing the quantity will adjust the priority to the new price at the end Note: If the modified amount is less than the fill amount, the order will be cancelled. # noqa: E501
+ Modify orders in spot, unified account and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation operation. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_order(order_id, order_patch, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
:param OrderPatch order_patch: (required)
:param str currency_pair: Currency pair
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str account: Specify query account
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2669,20 +2674,20 @@ def amend_order(self, order_id, order_patch, **kwargs): # noqa: E501
return self.amend_order_with_http_info(order_id, order_patch, **kwargs) # noqa: E501
def amend_order_with_http_info(self, order_id, order_patch, **kwargs): # noqa: E501
- """Amend an order # noqa: E501
+ """Amend single order # noqa: E501
- By default, the orders of spot, portfolio and margin account are updated. If you need to modify orders of the `cross-margin` account, you must specify account as `cross_margin`. For portfolio margin account, only `cross_margin` account is supported. Currently, both request body and query support currency_pair and account parameter passing, but request body has higher priority Currently, only supports modification of `price` or `amount` fields. Regarding rate limiting: modify order and create order sharing rate limiting rules. Regarding matching priority: Only reducing the quantity without modifying the priority of matching, altering the price or increasing the quantity will adjust the priority to the new price at the end Note: If the modified amount is less than the fill amount, the order will be cancelled. # noqa: E501
+ Modify orders in spot, unified account and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation operation. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_order_with_http_info(order_id, order_patch, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 1 hour after the end of the order. After that, only order ID is accepted. (required)
+ :param str order_id: The order ID returned when the order was successfully created or the custom ID specified by the user's creation (i.e. the `text` field). Operations based on custom IDs can only be checked in pending orders. Only order ID can be used after the order is finished (transaction/cancel) (required)
:param OrderPatch order_patch: (required)
:param str currency_pair: Currency pair
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str account: Specify query account
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2782,9 +2787,9 @@ def amend_order_with_http_info(self, order_id, order_patch, **kwargs): # noqa:
collection_formats=collection_formats)
def list_my_trades(self, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
- Spot,portfolio and margin trades are queried by default. If cross margin trades are needed, `account` must be set to `cross_margin` You can also set `from` and(or) `to` to query by time range. If you don't specify `from` and/or `to` parameters, only the last 7 days of data will be retured. The range of `from` and `to` is not alloed to exceed 30 days. Time range parameters are handled as order finish time. When using the limit&page paging function to retrieve data, the maximum number of pages is 100,000, that is, (limit * page - 1) <= 100000. # noqa: E501
+ By default query of transaction records for spot, unified account and warehouse-by-site leverage accounts. The history within a specified time range can be queried by specifying `from` or (and) `to`. - If no time parameters are specified, only data for the last 7 days can be obtained. - If only any parameter of `from` or `to` is specified, only 7-day data from the start (or end) of the specified time is returned. - The range not allowed to exceed 30 days. The parameters of the time range filter are processed according to the order end time. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_my_trades(async_req=True)
@@ -2792,12 +2797,12 @@ def list_my_trades(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Retrieve results with specified currency pair
- :param int limit: Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000
+ :param int limit: Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000
:param int page: Page number
:param str order_id: Filter trades with specified order ID. `currency_pair` is also required if this field is present
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str account: Specify query account
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2813,9 +2818,9 @@ def list_my_trades(self, **kwargs): # noqa: E501
return self.list_my_trades_with_http_info(**kwargs) # noqa: E501
def list_my_trades_with_http_info(self, **kwargs): # noqa: E501
- """List personal trading history # noqa: E501
+ """Query personal trading records # noqa: E501
- Spot,portfolio and margin trades are queried by default. If cross margin trades are needed, `account` must be set to `cross_margin` You can also set `from` and(or) `to` to query by time range. If you don't specify `from` and/or `to` parameters, only the last 7 days of data will be retured. The range of `from` and `to` is not alloed to exceed 30 days. Time range parameters are handled as order finish time. When using the limit&page paging function to retrieve data, the maximum number of pages is 100,000, that is, (limit * page - 1) <= 100000. # noqa: E501
+ By default query of transaction records for spot, unified account and warehouse-by-site leverage accounts. The history within a specified time range can be queried by specifying `from` or (and) `to`. - If no time parameters are specified, only data for the last 7 days can be obtained. - If only any parameter of `from` or `to` is specified, only 7-day data from the start (or end) of the specified time is returned. - The range not allowed to exceed 30 days. The parameters of the time range filter are processed according to the order end time. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_my_trades_with_http_info(async_req=True)
@@ -2823,12 +2828,12 @@ def list_my_trades_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency_pair: Retrieve results with specified currency pair
- :param int limit: Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000
+ :param int limit: Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000
:param int page: Page number
:param str order_id: Filter trades with specified order ID. `currency_pair` is also required if this field is present
- :param str account: Specify operation account. Default to spot ,portfolio and margin account if not specified. Set to `cross_margin` to operate against margin account. Portfolio margin account must set to `cross_margin` only
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
+ :param str account: Specify query account
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3033,7 +3038,7 @@ def get_system_time_with_http_info(self, **kwargs): # noqa: E501
def countdown_cancel_all_spot(self, countdown_cancel_all_spot_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. # noqa: E501
+ Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_spot(countdown_cancel_all_spot_task, async_req=True)
@@ -3058,7 +3063,7 @@ def countdown_cancel_all_spot(self, countdown_cancel_all_spot_task, **kwargs):
def countdown_cancel_all_spot_with_http_info(self, countdown_cancel_all_spot_task, **kwargs): # noqa: E501
"""Countdown cancel orders # noqa: E501
- When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. # noqa: E501
+ Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.countdown_cancel_all_spot_with_http_info(countdown_cancel_all_spot_task, async_req=True)
@@ -3151,7 +3156,7 @@ def countdown_cancel_all_spot_with_http_info(self, countdown_cancel_all_spot_tas
def amend_batch_orders(self, batch_amend_item, **kwargs): # noqa: E501
"""Batch modification of orders # noqa: E501
- Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the `account` parameter must be specified as `cross_margin`. For portfolio margin accounts, the `account` parameter can only be specified as `cross_margin`. Currently, only modifications to price or quantity (choose one) are supported. When modifying unfinished orders, a maximum of 5 orders can be batch-modified in one request. The request parameters should be passed in an array format. During batch modification, if one order modification fails, the modification process will continue with the next order. After execution, the response will include corresponding failure information for the failed orders. The sequence of calling for batch order modification should be consistent with the order in the order list. The response content order for batch order modification will also be consistent with the order in the order list. # noqa: E501
+ Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_batch_orders(batch_amend_item, async_req=True)
@@ -3159,7 +3164,7 @@ def amend_batch_orders(self, batch_amend_item, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param list[BatchAmendItem] batch_amend_item: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3177,7 +3182,7 @@ def amend_batch_orders(self, batch_amend_item, **kwargs): # noqa: E501
def amend_batch_orders_with_http_info(self, batch_amend_item, **kwargs): # noqa: E501
"""Batch modification of orders # noqa: E501
- Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the `account` parameter must be specified as `cross_margin`. For portfolio margin accounts, the `account` parameter can only be specified as `cross_margin`. Currently, only modifications to price or quantity (choose one) are supported. When modifying unfinished orders, a maximum of 5 orders can be batch-modified in one request. The request parameters should be passed in an array format. During batch modification, if one order modification fails, the modification process will continue with the next order. After execution, the response will include corresponding failure information for the failed orders. The sequence of calling for batch order modification should be consistent with the order in the order list. The response content order for batch order modification will also be consistent with the order in the order list. # noqa: E501
+ Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.amend_batch_orders_with_http_info(batch_amend_item, async_req=True)
@@ -3185,7 +3190,7 @@ def amend_batch_orders_with_http_info(self, batch_amend_item, **kwargs): # noqa
:param bool async_req: execute request asynchronously
:param list[BatchAmendItem] batch_amend_item: (required)
- :param int x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
+ :param str x_gate_exptime: Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3282,8 +3287,8 @@ def get_spot_insurance_history(self, business, currency, _from, to, **kwargs):
:param bool async_req: execute request asynchronously
:param str business: Leverage business, margin - position by position; unified - unified account (required)
:param str currency: Currency (required)
- :param int _from: Start timestamp, seconds (required)
- :param int to: End timestamp, in seconds (required)
+ :param int _from: Start timestamp in seconds (required)
+ :param int to: End timestamp in seconds (required)
:param int page: Page number
:param int limit: The maximum number of items returned in the list, the default value is 30
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3311,8 +3316,8 @@ def get_spot_insurance_history_with_http_info(self, business, currency, _from, t
:param bool async_req: execute request asynchronously
:param str business: Leverage business, margin - position by position; unified - unified account (required)
:param str currency: Currency (required)
- :param int _from: Start timestamp, seconds (required)
- :param int to: End timestamp, in seconds (required)
+ :param int _from: Start timestamp in seconds (required)
+ :param int to: End timestamp in seconds (required)
:param int page: Page number
:param int limit: The maximum number of items returned in the list, the default value is 30
:param _return_http_data_only: response data without head status code
@@ -3408,7 +3413,7 @@ def get_spot_insurance_history_with_http_info(self, business, currency, _from, t
['application/json']) # noqa: E501
# Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
+ auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/spot/insurance_history', 'GET',
@@ -3427,7 +3432,7 @@ def get_spot_insurance_history_with_http_info(self, business, currency, _from, t
collection_formats=collection_formats)
def list_spot_price_triggered_orders(self, status, **kwargs): # noqa: E501
- """Retrieve running auto order list # noqa: E501
+ """Query running auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3435,10 +3440,10 @@ def list_spot_price_triggered_orders(self, status, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Only list the orders with this status (required)
- :param str market: Currency pair
- :param str account: Trading account type. Portfolio margin account must set to `cross_margin`
- :param int limit: Maximum number of records to be returned in a single list
+ :param str status: Query order list based on status (required)
+ :param str market: Trading market
+ :param str account: Trading account type. Unified account must be set to `unified`
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -3455,7 +3460,7 @@ def list_spot_price_triggered_orders(self, status, **kwargs): # noqa: E501
return self.list_spot_price_triggered_orders_with_http_info(status, **kwargs) # noqa: E501
def list_spot_price_triggered_orders_with_http_info(self, status, **kwargs): # noqa: E501
- """Retrieve running auto order list # noqa: E501
+ """Query running auto order list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3463,10 +3468,10 @@ def list_spot_price_triggered_orders_with_http_info(self, status, **kwargs): #
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str status: Only list the orders with this status (required)
- :param str market: Currency pair
- :param str account: Trading account type. Portfolio margin account must set to `cross_margin`
- :param int limit: Maximum number of records to be returned in a single list
+ :param str status: Query order list based on status (required)
+ :param str market: Trading market
+ :param str account: Trading account type. Unified account must be set to `unified`
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -3565,7 +3570,7 @@ def list_spot_price_triggered_orders_with_http_info(self, status, **kwargs): #
collection_formats=collection_formats)
def create_spot_price_triggered_order(self, spot_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3589,7 +3594,7 @@ def create_spot_price_triggered_order(self, spot_price_triggered_order, **kwargs
return self.create_spot_price_triggered_order_with_http_info(spot_price_triggered_order, **kwargs) # noqa: E501
def create_spot_price_triggered_order_with_http_info(self, spot_price_triggered_order, **kwargs): # noqa: E501
- """Create a price-triggered order # noqa: E501
+ """Create price-triggered order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3681,7 +3686,7 @@ def create_spot_price_triggered_order_with_http_info(self, spot_price_triggered_
collection_formats=collection_formats)
def cancel_spot_price_triggered_order_list(self, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3689,8 +3694,8 @@ def cancel_spot_price_triggered_order_list(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str market: Currency pair
- :param str account: Trading account type. Portfolio margin account must set to `cross_margin`
+ :param str market: Trading market
+ :param str account: Trading account type. Unified account must be set to `unified`
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3706,7 +3711,7 @@ def cancel_spot_price_triggered_order_list(self, **kwargs): # noqa: E501
return self.cancel_spot_price_triggered_order_list_with_http_info(**kwargs) # noqa: E501
def cancel_spot_price_triggered_order_list_with_http_info(self, **kwargs): # noqa: E501
- """Cancel all open orders # noqa: E501
+ """Cancel all auto orders # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3714,8 +3719,8 @@ def cancel_spot_price_triggered_order_list_with_http_info(self, **kwargs): # no
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str market: Currency pair
- :param str account: Trading account type. Portfolio margin account must set to `cross_margin`
+ :param str market: Trading market
+ :param str account: Trading account type. Unified account must be set to `unified`
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3794,7 +3799,7 @@ def cancel_spot_price_triggered_order_list_with_http_info(self, **kwargs): # no
collection_formats=collection_formats)
def get_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3802,7 +3807,7 @@ def get_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3818,7 +3823,7 @@ def get_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
return self.get_spot_price_triggered_order_with_http_info(order_id, **kwargs) # noqa: E501
def get_spot_price_triggered_order_with_http_info(self, order_id, **kwargs): # noqa: E501
- """Get a price-triggered order # noqa: E501
+ """Query single auto order details # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3826,7 +3831,7 @@ def get_spot_price_triggered_order_with_http_info(self, order_id, **kwargs): #
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3906,7 +3911,7 @@ def get_spot_price_triggered_order_with_http_info(self, order_id, **kwargs): #
collection_formats=collection_formats)
def cancel_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3914,7 +3919,7 @@ def cancel_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -3930,7 +3935,7 @@ def cancel_spot_price_triggered_order(self, order_id, **kwargs): # noqa: E501
return self.cancel_spot_price_triggered_order_with_http_info(order_id, **kwargs) # noqa: E501
def cancel_spot_price_triggered_order_with_http_info(self, order_id, **kwargs): # noqa: E501
- """cancel a price-triggered order # noqa: E501
+ """Cancel single auto order # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -3938,7 +3943,7 @@ def cancel_spot_price_triggered_order_with_http_info(self, order_id, **kwargs):
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str order_id: Retrieve the data of the order with the specified ID (required)
+ :param str order_id: ID returned when order is successfully created (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
diff --git a/gate_api/api/sub_account_api.py b/gate_api/api/sub_account_api.py
index 3ab7b07..2c864c3 100644
--- a/gate_api/api/sub_account_api.py
+++ b/gate_api/api/sub_account_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -45,7 +45,7 @@ def list_sub_accounts(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: `0` to list all types of sub-accounts (currently supporting cross margin accounts and sub-accounts). `1` to list sub-accounts only. If no parameter is passed, only sub-accounts will be listed by default.
+ :param str type: Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -69,7 +69,7 @@ def list_sub_accounts_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: `0` to list all types of sub-accounts (currently supporting cross margin accounts and sub-accounts). `1` to list sub-accounts only. If no parameter is passed, only sub-accounts will be listed by default.
+ :param str type: Enter `0` to list all types of sub-accounts (currently supporting cross-margin sub-accounts and regular sub-accounts). Enter `1` to query regular sub-accounts only. If no parameter is passed, only regular sub-accounts will be queried by default.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -261,7 +261,7 @@ def create_sub_accounts_with_http_info(self, sub_account, **kwargs): # noqa: E5
collection_formats=collection_formats)
def get_sub_account(self, user_id, **kwargs): # noqa: E501
- """Get the sub-account # noqa: E501
+ """Get sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -269,7 +269,7 @@ def get_sub_account(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -285,7 +285,7 @@ def get_sub_account(self, user_id, **kwargs): # noqa: E501
return self.get_sub_account_with_http_info(user_id, **kwargs) # noqa: E501
def get_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
- """Get the sub-account # noqa: E501
+ """Get sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -293,7 +293,7 @@ def get_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -373,7 +373,7 @@ def get_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_sub_account_keys(self, user_id, **kwargs): # noqa: E501
- """List all API Key of the sub-account # noqa: E501
+ """List all API key pairs of the sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -381,7 +381,7 @@ def list_sub_account_keys(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -397,7 +397,7 @@ def list_sub_account_keys(self, user_id, **kwargs): # noqa: E501
return self.list_sub_account_keys_with_http_info(user_id, **kwargs) # noqa: E501
def list_sub_account_keys_with_http_info(self, user_id, **kwargs): # noqa: E501
- """List all API Key of the sub-account # noqa: E501
+ """List all API key pairs of the sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -405,7 +405,7 @@ def list_sub_account_keys_with_http_info(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -485,7 +485,7 @@ def list_sub_account_keys_with_http_info(self, user_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def create_sub_account_keys(self, user_id, sub_account_key, **kwargs): # noqa: E501
- """Create API Key of the sub-account # noqa: E501
+ """Create new sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -493,7 +493,7 @@ def create_sub_account_keys(self, user_id, sub_account_key, **kwargs): # noqa:
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param SubAccountKey sub_account_key: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -502,7 +502,7 @@ def create_sub_account_keys(self, user_id, sub_account_key, **kwargs): # noqa:
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.SubAccountKey]
+ :rtype: gate_api.SubAccountKey
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -510,7 +510,7 @@ def create_sub_account_keys(self, user_id, sub_account_key, **kwargs): # noqa:
return self.create_sub_account_keys_with_http_info(user_id, sub_account_key, **kwargs) # noqa: E501
def create_sub_account_keys_with_http_info(self, user_id, sub_account_key, **kwargs): # noqa: E501
- """Create API Key of the sub-account # noqa: E501
+ """Create new sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -518,7 +518,7 @@ def create_sub_account_keys_with_http_info(self, user_id, sub_account_key, **kwa
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
+ :param int user_id: Sub-account user ID (required)
:param SubAccountKey sub_account_key: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -529,7 +529,7 @@ def create_sub_account_keys_with_http_info(self, user_id, sub_account_key, **kwa
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.SubAccountKey], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(gate_api.SubAccountKey, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -601,7 +601,7 @@ def create_sub_account_keys_with_http_info(self, user_id, sub_account_key, **kwa
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[SubAccountKey]', # noqa: E501
+ response_type='SubAccountKey', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -610,7 +610,7 @@ def create_sub_account_keys_with_http_info(self, user_id, sub_account_key, **kwa
collection_formats=collection_formats)
def get_sub_account_key(self, user_id, key, **kwargs): # noqa: E501
- """Get the API Key of the sub-account # noqa: E501
+ """Get specific API key pair of the sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -618,8 +618,8 @@ def get_sub_account_key(self, user_id, key, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -635,7 +635,7 @@ def get_sub_account_key(self, user_id, key, **kwargs): # noqa: E501
return self.get_sub_account_key_with_http_info(user_id, key, **kwargs) # noqa: E501
def get_sub_account_key_with_http_info(self, user_id, key, **kwargs): # noqa: E501
- """Get the API Key of the sub-account # noqa: E501
+ """Get specific API key pair of the sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -643,8 +643,8 @@ def get_sub_account_key_with_http_info(self, user_id, key, **kwargs): # noqa: E
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -731,7 +731,7 @@ def get_sub_account_key_with_http_info(self, user_id, key, **kwargs): # noqa: E
collection_formats=collection_formats)
def update_sub_account_keys(self, user_id, key, sub_account_key, **kwargs): # noqa: E501
- """Update API key of the sub-account # noqa: E501
+ """Update sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -739,8 +739,8 @@ def update_sub_account_keys(self, user_id, key, sub_account_key, **kwargs): # n
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param SubAccountKey sub_account_key: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -757,7 +757,7 @@ def update_sub_account_keys(self, user_id, key, sub_account_key, **kwargs): # n
return self.update_sub_account_keys_with_http_info(user_id, key, sub_account_key, **kwargs) # noqa: E501
def update_sub_account_keys_with_http_info(self, user_id, key, sub_account_key, **kwargs): # noqa: E501
- """Update API key of the sub-account # noqa: E501
+ """Update sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -765,8 +765,8 @@ def update_sub_account_keys_with_http_info(self, user_id, key, sub_account_key,
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param SubAccountKey sub_account_key: (required)
:param _return_http_data_only: response data without head status code
and headers
@@ -861,7 +861,7 @@ def update_sub_account_keys_with_http_info(self, user_id, key, sub_account_key,
collection_formats=collection_formats)
def delete_sub_account_keys(self, user_id, key, **kwargs): # noqa: E501
- """Delete API key of the sub-account # noqa: E501
+ """Delete sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -869,8 +869,8 @@ def delete_sub_account_keys(self, user_id, key, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -886,7 +886,7 @@ def delete_sub_account_keys(self, user_id, key, **kwargs): # noqa: E501
return self.delete_sub_account_keys_with_http_info(user_id, key, **kwargs) # noqa: E501
def delete_sub_account_keys_with_http_info(self, user_id, key, **kwargs): # noqa: E501
- """Delete API key of the sub-account # noqa: E501
+ """Delete sub-account API key pair # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -894,8 +894,8 @@ def delete_sub_account_keys_with_http_info(self, user_id, key, **kwargs): # noq
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: Sub-account user id (required)
- :param str key: The API Key of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
+ :param str key: Sub-account API key (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -978,7 +978,7 @@ def delete_sub_account_keys_with_http_info(self, user_id, key, **kwargs): # noq
collection_formats=collection_formats)
def lock_sub_account(self, user_id, **kwargs): # noqa: E501
- """Lock the sub-account # noqa: E501
+ """Lock sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -986,7 +986,7 @@ def lock_sub_account(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: The user id of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1002,7 +1002,7 @@ def lock_sub_account(self, user_id, **kwargs): # noqa: E501
return self.lock_sub_account_with_http_info(user_id, **kwargs) # noqa: E501
def lock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
- """Lock the sub-account # noqa: E501
+ """Lock sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1010,7 +1010,7 @@ def lock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: The user id of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1086,7 +1086,7 @@ def lock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
collection_formats=collection_formats)
def unlock_sub_account(self, user_id, **kwargs): # noqa: E501
- """Unlock the sub-account # noqa: E501
+ """Unlock sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1094,7 +1094,7 @@ def unlock_sub_account(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: The user id of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1110,7 +1110,7 @@ def unlock_sub_account(self, user_id, **kwargs): # noqa: E501
return self.unlock_sub_account_with_http_info(user_id, **kwargs) # noqa: E501
def unlock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
- """Unlock the sub-account # noqa: E501
+ """Unlock sub-account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1118,7 +1118,7 @@ def unlock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param int user_id: The user id of the sub-account (required)
+ :param int user_id: Sub-account user ID (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1196,7 +1196,7 @@ def unlock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501
def list_unified_mode(self, **kwargs): # noqa: E501
"""Get sub-account mode # noqa: E501
- Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_unified_mode(async_req=True)
@@ -1220,7 +1220,7 @@ def list_unified_mode(self, **kwargs): # noqa: E501
def list_unified_mode_with_http_info(self, **kwargs): # noqa: E501
"""Get sub-account mode # noqa: E501
- Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_unified_mode_with_http_info(async_req=True)
diff --git a/gate_api/api/unified_api.py b/gate_api/api/unified_api.py
index 583c284..a6deb68 100644
--- a/gate_api/api/unified_api.py
+++ b/gate_api/api/unified_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -39,14 +39,15 @@ def __init__(self, api_client=None):
def list_unified_accounts(self, **kwargs): # noqa: E501
"""Get unified account information # noqa: E501
- The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation # noqa: E501
+ The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. For specific formulas, please refer to [Margin Formula](#margin-formula) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_unified_accounts(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
+ :param str sub_uid: Sub account user ID
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -64,14 +65,15 @@ def list_unified_accounts(self, **kwargs): # noqa: E501
def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501
"""Get unified account information # noqa: E501
- The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation # noqa: E501
+ The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. For specific formulas, please refer to [Margin Formula](#margin-formula) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_unified_accounts_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
+ :param str sub_uid: Sub account user ID
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -89,7 +91,8 @@ def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
- 'currency'
+ 'currency',
+ 'sub_uid'
]
all_params.extend(
[
@@ -116,6 +119,8 @@ def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501
query_params = []
if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'sub_uid' in local_var_params and local_var_params['sub_uid'] is not None: # noqa: E501
+ query_params.append(('sub_uid', local_var_params['sub_uid'])) # noqa: E501
header_params = {}
@@ -146,16 +151,16 @@ def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def list_unified_account_mode(self, **kwargs): # noqa: E501
- """Inquire about unified account mode (deprecated) # noqa: E501
+ def get_unified_borrowable(self, currency, **kwargs): # noqa: E501
+ """Query maximum borrowable amount for unified account # noqa: E501
- cross_margin - Spot full-margin trading, usdt_futures - USDT perpetual futures # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_unified_account_mode(async_req=True)
+ >>> thread = api.get_unified_borrowable(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param str currency: Query by specified currency name (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -163,23 +168,23 @@ def list_unified_account_mode(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: dict(str, bool)
+ :rtype: gate_api.UnifiedBorrowable
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.list_unified_account_mode_with_http_info(**kwargs) # noqa: E501
+ return self.get_unified_borrowable_with_http_info(currency, **kwargs) # noqa: E501
- def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
- """Inquire about unified account mode (deprecated) # noqa: E501
+ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E501
+ """Query maximum borrowable amount for unified account # noqa: E501
- cross_margin - Spot full-margin trading, usdt_futures - USDT perpetual futures # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.list_unified_account_mode_with_http_info(async_req=True)
+ >>> thread = api.get_unified_borrowable_with_http_info(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
+ :param str currency: Query by specified currency name (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -189,7 +194,7 @@ def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(dict(str, bool), status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(gate_api.UnifiedBorrowable, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -197,6 +202,7 @@ def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
local_var_params = locals()
all_params = [
+ 'currency'
]
all_params.extend(
[
@@ -211,16 +217,22 @@ def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method list_unified_account_mode" % k
+ " to method get_unified_borrowable" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
+ # verify the required parameter 'currency' is set
+ if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
+ local_var_params['currency'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currency` when calling `get_unified_borrowable`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
+ if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
+ query_params.append(('currency', local_var_params['currency'])) # noqa: E501
header_params = {}
@@ -236,14 +248,14 @@ def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/unified/account_mode', 'GET',
+ '/unified/borrowable', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='dict(str, bool)', # noqa: E501
+ response_type='UnifiedBorrowable', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -251,16 +263,16 @@ def list_unified_account_mode_with_http_info(self, **kwargs): # noqa: E501
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def set_unified_account_mode(self, unified_mode, **kwargs): # noqa: E501
- """Set unified account mode (deprecated) # noqa: E501
+ def get_unified_transferable(self, currency, **kwargs): # noqa: E501
+ """Query maximum transferable amount for unified account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_unified_account_mode(unified_mode, async_req=True)
+ >>> thread = api.get_unified_transferable(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UnifiedMode unified_mode: (required)
+ :param str currency: Query by specified currency name (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -268,23 +280,23 @@ def set_unified_account_mode(self, unified_mode, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: dict(str, bool)
+ :rtype: gate_api.UnifiedTransferable
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.set_unified_account_mode_with_http_info(unified_mode, **kwargs) # noqa: E501
+ return self.get_unified_transferable_with_http_info(currency, **kwargs) # noqa: E501
- def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # noqa: E501
- """Set unified account mode (deprecated) # noqa: E501
+ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa: E501
+ """Query maximum transferable amount for unified account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_unified_account_mode_with_http_info(unified_mode, async_req=True)
+ >>> thread = api.get_unified_transferable_with_http_info(currency, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UnifiedMode unified_mode: (required)
+ :param str currency: Query by specified currency name (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -294,7 +306,7 @@ def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # no
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(dict(str, bool), status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(gate_api.UnifiedTransferable, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -302,7 +314,7 @@ def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # no
local_var_params = locals()
all_params = [
- 'unified_mode'
+ 'currency'
]
all_params.extend(
[
@@ -317,20 +329,22 @@ def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # no
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method set_unified_account_mode" % k
+ " to method get_unified_transferable" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'unified_mode' is set
- if self.api_client.client_side_validation and ('unified_mode' not in local_var_params or # noqa: E501
- local_var_params['unified_mode'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `unified_mode` when calling `set_unified_account_mode`") # noqa: E501
+ # verify the required parameter 'currency' is set
+ if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
+ local_var_params['currency'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currency` when calling `get_unified_transferable`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
+ if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
+ query_params.append(('currency', local_var_params['currency'])) # noqa: E501
header_params = {}
@@ -338,28 +352,22 @@ def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # no
local_var_files = {}
body_params = None
- if 'unified_mode' in local_var_params:
- body_params = local_var_params['unified_mode']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
- ['application/json']) # noqa: E501
-
# Authentication setting
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/unified/account_mode', 'POST',
+ '/unified/transferable', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='dict(str, bool)', # noqa: E501
+ response_type='UnifiedTransferable', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -367,16 +375,16 @@ def set_unified_account_mode_with_http_info(self, unified_mode, **kwargs): # no
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_unified_borrowable(self, currency, **kwargs): # noqa: E501
- """Query about the maximum borrowing for the unified account # noqa: E501
+ def get_unified_transferables(self, currencies, **kwargs): # noqa: E501
+ """Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_unified_borrowable(currency, async_req=True)
+ >>> thread = api.get_unified_transferables(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currencies: Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -384,23 +392,23 @@ def get_unified_borrowable(self, currency, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.UnifiedBorrowable
+ :rtype: list[gate_api.TransferablesResult]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.get_unified_borrowable_with_http_info(currency, **kwargs) # noqa: E501
+ return self.get_unified_transferables_with_http_info(currencies, **kwargs) # noqa: E501
- def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Query about the maximum borrowing for the unified account # noqa: E501
+ def get_unified_transferables_with_http_info(self, currencies, **kwargs): # noqa: E501
+ """Batch query maximum transferable amount for unified accounts. Each currency shows the maximum value. After user withdrawal, the transferable amount for all currencies will change # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_unified_borrowable_with_http_info(currency, async_req=True)
+ >>> thread = api.get_unified_transferables_with_http_info(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param str currencies: Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -410,7 +418,7 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.UnifiedBorrowable, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.TransferablesResult], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -418,7 +426,7 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5
local_var_params = locals()
all_params = [
- 'currency'
+ 'currencies'
]
all_params.extend(
[
@@ -433,22 +441,22 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_unified_borrowable" % k
+ " to method get_unified_transferables" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_unified_borrowable`") # noqa: E501
+ # verify the required parameter 'currencies' is set
+ if self.api_client.client_side_validation and ('currencies' not in local_var_params or # noqa: E501
+ local_var_params['currencies'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currencies` when calling `get_unified_transferables`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'currencies' in local_var_params and local_var_params['currencies'] is not None: # noqa: E501
+ query_params.append(('currencies', local_var_params['currencies'])) # noqa: E501
header_params = {}
@@ -464,14 +472,14 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/unified/borrowable', 'GET',
+ '/unified/transferables', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='UnifiedBorrowable', # noqa: E501
+ response_type='list[TransferablesResult]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -479,16 +487,16 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_unified_transferable(self, currency, **kwargs): # noqa: E501
- """Query about the maximum transferable for the unified account # noqa: E501
+ def get_unified_borrowable_list(self, currencies, **kwargs): # noqa: E501
+ """Batch query unified account maximum borrowable amount # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_unified_transferable(currency, async_req=True)
+ >>> thread = api.get_unified_borrowable_list(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param list[str] currencies: Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -496,23 +504,23 @@ def get_unified_transferable(self, currency, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.UnifiedTransferable
+ :rtype: list[gate_api.UnifiedBorrowable1]
:return: If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.get_unified_transferable_with_http_info(currency, **kwargs) # noqa: E501
+ return self.get_unified_borrowable_list_with_http_info(currencies, **kwargs) # noqa: E501
- def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa: E501
- """Query about the maximum transferable for the unified account # noqa: E501
+ def get_unified_borrowable_list_with_http_info(self, currencies, **kwargs): # noqa: E501
+ """Batch query unified account maximum borrowable amount # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.get_unified_transferable_with_http_info(currency, async_req=True)
+ >>> thread = api.get_unified_borrowable_list_with_http_info(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency (required)
+ :param list[str] currencies: Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -522,7 +530,7 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa:
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.UnifiedTransferable, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.UnifiedBorrowable1], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -530,7 +538,7 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa:
local_var_params = locals()
all_params = [
- 'currency'
+ 'currencies'
]
all_params.extend(
[
@@ -545,22 +553,29 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa:
if k not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_unified_transferable" % k
+ " to method get_unified_borrowable_list" % k
)
local_var_params[k] = v
del local_var_params['kwargs']
- # verify the required parameter 'currency' is set
- if self.api_client.client_side_validation and ('currency' not in local_var_params or # noqa: E501
- local_var_params['currency'] is None): # noqa: E501
- raise ApiValueError("Missing the required parameter `currency` when calling `get_unified_transferable`") # noqa: E501
+ # verify the required parameter 'currencies' is set
+ if self.api_client.client_side_validation and ('currencies' not in local_var_params or # noqa: E501
+ local_var_params['currencies'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `currencies` when calling `get_unified_borrowable_list`") # noqa: E501
+ if self.api_client.client_side_validation and ('currencies' in local_var_params and # noqa: E501
+ len(local_var_params['currencies']) > 10): # noqa: E501
+ raise ApiValueError("Invalid value for parameter `currencies` when calling `get_unified_borrowable_list`, number of items must be less than or equal to `10`") # noqa: E501
+ if self.api_client.client_side_validation and ('currencies' in local_var_params and # noqa: E501
+ len(local_var_params['currencies']) < 1): # noqa: E501
+ raise ApiValueError("Invalid value for parameter `currencies` when calling `get_unified_borrowable_list`, number of items must be greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
- if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
- query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'currencies' in local_var_params and local_var_params['currencies'] is not None: # noqa: E501
+ query_params.append(('currencies', local_var_params['currencies'])) # noqa: E501
+ collection_formats['currencies'] = 'multi' # noqa: E501
header_params = {}
@@ -576,14 +591,14 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa:
auth_settings = ['apiv4'] # noqa: E501
return self.api_client.call_api(
- '/unified/transferable', 'GET',
+ '/unified/batch_borrowable', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='UnifiedTransferable', # noqa: E501
+ response_type='list[UnifiedBorrowable1]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -592,7 +607,7 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa:
collection_formats=collection_formats)
def list_unified_loans(self, **kwargs): # noqa: E501
- """List loans # noqa: E501
+ """Query loans # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -600,10 +615,10 @@ def list_unified_loans(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param str type: Loan type, platform - platform, margin - margin
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param str type: Loan type: platform borrowing - platform, margin borrowing - margin
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -619,7 +634,7 @@ def list_unified_loans(self, **kwargs): # noqa: E501
return self.list_unified_loans_with_http_info(**kwargs) # noqa: E501
def list_unified_loans_with_http_info(self, **kwargs): # noqa: E501
- """List loans # noqa: E501
+ """Query loans # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -627,10 +642,10 @@ def list_unified_loans_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param str type: Loan type, platform - platform, margin - margin
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param str type: Loan type: platform borrowing - platform, margin borrowing - margin
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -723,7 +738,7 @@ def list_unified_loans_with_http_info(self, **kwargs): # noqa: E501
def create_unified_loan(self, unified_loan, **kwargs): # noqa: E501
"""Borrow or repay # noqa: E501
- When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` # noqa: E501
+ When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_unified_loan(unified_loan, async_req=True)
@@ -738,7 +753,7 @@ def create_unified_loan(self, unified_loan, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: None
+ :rtype: gate_api.UnifiedLoanResult
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -748,7 +763,7 @@ def create_unified_loan(self, unified_loan, **kwargs): # noqa: E501
def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E501
"""Borrow or repay # noqa: E501
- When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` # noqa: E501
+ When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_unified_loan_with_http_info(unified_loan, async_req=True)
@@ -765,7 +780,7 @@ def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: None
+ :rtype: tuple(gate_api.UnifiedLoanResult, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -811,6 +826,10 @@ def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E
body_params = None
if 'unified_loan' in local_var_params:
body_params = local_var_params['unified_loan']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
@@ -826,7 +845,7 @@ def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type=None, # noqa: E501
+ response_type='UnifiedLoanResult', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -835,7 +854,7 @@ def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_unified_loan_records(self, **kwargs): # noqa: E501
- """Get load records # noqa: E501
+ """Query loan records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -843,10 +862,10 @@ def list_unified_loan_records(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds
- :param str currency: Retrieve data of the specified currency
+ :param str type: Loan record type: borrow - borrowing, repay - repayment
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -862,7 +881,7 @@ def list_unified_loan_records(self, **kwargs): # noqa: E501
return self.list_unified_loan_records_with_http_info(**kwargs) # noqa: E501
def list_unified_loan_records_with_http_info(self, **kwargs): # noqa: E501
- """Get load records # noqa: E501
+ """Query loan records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -870,10 +889,10 @@ def list_unified_loan_records_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str type: The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds
- :param str currency: Retrieve data of the specified currency
+ :param str type: Loan record type: borrow - borrowing, repay - repayment
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -964,7 +983,7 @@ def list_unified_loan_records_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_unified_loan_interest_records(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query interest deduction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -972,12 +991,12 @@ def list_unified_loan_interest_records(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str type: Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str type: Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -993,7 +1012,7 @@ def list_unified_loan_interest_records(self, **kwargs): # noqa: E501
return self.list_unified_loan_interest_records_with_http_info(**kwargs) # noqa: E501
def list_unified_loan_interest_records_with_http_info(self, **kwargs): # noqa: E501
- """List interest records # noqa: E501
+ """Query interest deduction records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1001,12 +1020,12 @@ def list_unified_loan_interest_records_with_http_info(self, **kwargs): # noqa:
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
- :param int _from: Start timestamp of the query
- :param int to: Time range ending, default to current time
- :param str type: Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
+ :param int _from: Start timestamp for the query
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param str type: Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1103,8 +1122,9 @@ def list_unified_loan_interest_records_with_http_info(self, **kwargs): # noqa:
collection_formats=collection_formats)
def get_unified_risk_units(self, **kwargs): # noqa: E501
- """Retrieve user risk unit details, only valid in portfolio margin mode # noqa: E501
+ """Get user risk unit details # noqa: E501
+ Get user risk unit details, only valid in portfolio margin mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unified_risk_units(async_req=True)
@@ -1126,8 +1146,9 @@ def get_unified_risk_units(self, **kwargs): # noqa: E501
return self.get_unified_risk_units_with_http_info(**kwargs) # noqa: E501
def get_unified_risk_units_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve user risk unit details, only valid in portfolio margin mode # noqa: E501
+ """Get user risk unit details # noqa: E501
+ Get user risk unit details, only valid in portfolio margin mode # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unified_risk_units_with_http_info(async_req=True)
@@ -1311,9 +1332,9 @@ def get_unified_mode_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def set_unified_mode(self, unified_mode_set, **kwargs): # noqa: E501
- """Set mode of the unified account # noqa: E501
+ """Set unified account mode # noqa: E501
- 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通组合保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` # noqa: E501
+ Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_unified_mode(unified_mode_set, async_req=True)
@@ -1336,9 +1357,9 @@ def set_unified_mode(self, unified_mode_set, **kwargs): # noqa: E501
return self.set_unified_mode_with_http_info(unified_mode_set, **kwargs) # noqa: E501
def set_unified_mode_with_http_info(self, unified_mode_set, **kwargs): # noqa: E501
- """Set mode of the unified account # noqa: E501
+ """Set unified account mode # noqa: E501
- 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通组合保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` # noqa: E501
+ Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_unified_mode_with_http_info(unified_mode_set, async_req=True)
@@ -1425,16 +1446,16 @@ def set_unified_mode_with_http_info(self, unified_mode_set, **kwargs): # noqa:
collection_formats=collection_formats)
def get_unified_estimate_rate(self, currencies, **kwargs): # noqa: E501
- """Get unified estimate rate # noqa: E501
+ """Query unified account estimated interest rate # noqa: E501
- Due to fluctuations in lending depth, hourly interest rates may vary, and thus, I cannot provide exact rates. When a currency is not supported, the interest rate returned will be an empty string. # noqa: E501
+ Interest rates fluctuate hourly based on lending depth, so exact rates cannot be provided. When a currency is not supported, the interest rate returned will be an empty string # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unified_estimate_rate(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required)
+ :param list[str] currencies: Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1450,16 +1471,16 @@ def get_unified_estimate_rate(self, currencies, **kwargs): # noqa: E501
return self.get_unified_estimate_rate_with_http_info(currencies, **kwargs) # noqa: E501
def get_unified_estimate_rate_with_http_info(self, currencies, **kwargs): # noqa: E501
- """Get unified estimate rate # noqa: E501
+ """Query unified account estimated interest rate # noqa: E501
- Due to fluctuations in lending depth, hourly interest rates may vary, and thus, I cannot provide exact rates. When a currency is not supported, the interest rate returned will be an empty string. # noqa: E501
+ Interest rates fluctuate hourly based on lending depth, so exact rates cannot be provided. When a currency is not supported, the interest rate returned will be an empty string # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_unified_estimate_rate_with_http_info(currencies, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param list[str] currencies: Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required)
+ :param list[str] currencies: Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1546,7 +1567,7 @@ def get_unified_estimate_rate_with_http_info(self, currencies, **kwargs): # noq
collection_formats=collection_formats)
def list_currency_discount_tiers(self, **kwargs): # noqa: E501
- """List currency discount tiers # noqa: E501
+ """Query unified account tiered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1569,7 +1590,7 @@ def list_currency_discount_tiers(self, **kwargs): # noqa: E501
return self.list_currency_discount_tiers_with_http_info(**kwargs) # noqa: E501
def list_currency_discount_tiers_with_http_info(self, **kwargs): # noqa: E501
- """List currency discount tiers # noqa: E501
+ """Query unified account tiered # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1649,7 +1670,7 @@ def list_currency_discount_tiers_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_loan_margin_tiers(self, **kwargs): # noqa: E501
- """List loan margin tiers # noqa: E501
+ """Query unified account tiered loan margin # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1672,7 +1693,7 @@ def list_loan_margin_tiers(self, **kwargs): # noqa: E501
return self.list_loan_margin_tiers_with_http_info(**kwargs) # noqa: E501
def list_loan_margin_tiers_with_http_info(self, **kwargs): # noqa: E501
- """List loan margin tiers # noqa: E501
+ """Query unified account tiered loan margin # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1754,7 +1775,7 @@ def list_loan_margin_tiers_with_http_info(self, **kwargs): # noqa: E501
def calculate_portfolio_margin(self, unified_portfolio_input, **kwargs): # noqa: E501
"""Portfolio margin calculator # noqa: E501
- Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. # noqa: E501
+ Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.calculate_portfolio_margin(unified_portfolio_input, async_req=True)
@@ -1779,7 +1800,7 @@ def calculate_portfolio_margin(self, unified_portfolio_input, **kwargs): # noqa
def calculate_portfolio_margin_with_http_info(self, unified_portfolio_input, **kwargs): # noqa: E501
"""Portfolio margin calculator # noqa: E501
- Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. # noqa: E501
+ Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.calculate_portfolio_margin_with_http_info(unified_portfolio_input, async_req=True)
@@ -1870,7 +1891,7 @@ def calculate_portfolio_margin_with_http_info(self, unified_portfolio_input, **k
collection_formats=collection_formats)
def get_user_leverage_currency_config(self, currency, **kwargs): # noqa: E501
- """The maximum and minimum leverage multiples that users can set for a currency type are: # noqa: E501
+ """Maximum and minimum currency leverage that can be set # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1894,7 +1915,7 @@ def get_user_leverage_currency_config(self, currency, **kwargs): # noqa: E501
return self.get_user_leverage_currency_config_with_http_info(currency, **kwargs) # noqa: E501
def get_user_leverage_currency_config_with_http_info(self, currency, **kwargs): # noqa: E501
- """The maximum and minimum leverage multiples that users can set for a currency type are: # noqa: E501
+ """Maximum and minimum currency leverage that can be set # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1982,8 +2003,9 @@ def get_user_leverage_currency_config_with_http_info(self, currency, **kwargs):
collection_formats=collection_formats)
def get_user_leverage_currency_setting(self, **kwargs): # noqa: E501
- """Get the user's currency leverage. If currency is not passed, query all currencies. # noqa: E501
+ """Get user currency leverage # noqa: E501
+ Get user currency leverage. If currency is not specified, query all currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_leverage_currency_setting(async_req=True)
@@ -1998,7 +2020,7 @@ def get_user_leverage_currency_setting(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.UnifiedLeverageSetting
+ :rtype: list[gate_api.UnifiedLeverageSetting]
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -2006,8 +2028,9 @@ def get_user_leverage_currency_setting(self, **kwargs): # noqa: E501
return self.get_user_leverage_currency_setting_with_http_info(**kwargs) # noqa: E501
def get_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa: E501
- """Get the user's currency leverage. If currency is not passed, query all currencies. # noqa: E501
+ """Get user currency leverage # noqa: E501
+ Get user currency leverage. If currency is not specified, query all currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_leverage_currency_setting_with_http_info(async_req=True)
@@ -2024,7 +2047,7 @@ def get_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa:
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.UnifiedLeverageSetting, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.UnifiedLeverageSetting], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -2081,7 +2104,7 @@ def get_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa:
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='UnifiedLeverageSetting', # noqa: E501
+ response_type='list[UnifiedLeverageSetting]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -2089,16 +2112,16 @@ def get_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa:
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
- def set_user_leverage_currency_setting(self, **kwargs): # noqa: E501
- """Set the loan currency leverage # noqa: E501
+ def set_user_leverage_currency_setting(self, unified_leverage_setting, **kwargs): # noqa: E501
+ """Set loan currency leverage # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_user_leverage_currency_setting(async_req=True)
+ >>> thread = api.set_user_leverage_currency_setting(unified_leverage_setting, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UnifiedLeverageSetting unified_leverage_setting:
+ :param UnifiedLeverageSetting unified_leverage_setting: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2111,18 +2134,18 @@ def set_user_leverage_currency_setting(self, **kwargs): # noqa: E501
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
- return self.set_user_leverage_currency_setting_with_http_info(**kwargs) # noqa: E501
+ return self.set_user_leverage_currency_setting_with_http_info(unified_leverage_setting, **kwargs) # noqa: E501
- def set_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa: E501
- """Set the loan currency leverage # noqa: E501
+ def set_user_leverage_currency_setting_with_http_info(self, unified_leverage_setting, **kwargs): # noqa: E501
+ """Set loan currency leverage # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
- >>> thread = api.set_user_leverage_currency_setting_with_http_info(async_req=True)
+ >>> thread = api.set_user_leverage_currency_setting_with_http_info(unified_leverage_setting, async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param UnifiedLeverageSetting unified_leverage_setting:
+ :param UnifiedLeverageSetting unified_leverage_setting: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2159,6 +2182,10 @@ def set_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa:
)
local_var_params[k] = v
del local_var_params['kwargs']
+ # verify the required parameter 'unified_leverage_setting' is set
+ if self.api_client.client_side_validation and ('unified_leverage_setting' not in local_var_params or # noqa: E501
+ local_var_params['unified_leverage_setting'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `unified_leverage_setting` when calling `set_user_leverage_currency_setting`") # noqa: E501
collection_formats = {}
@@ -2197,8 +2224,116 @@ def set_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa:
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+ def list_unified_currencies(self, **kwargs): # noqa: E501
+ """List of loan currencies supported by unified account # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.list_unified_currencies(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str currency: Currency
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: list[gate_api.UnifiedCurrency]
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.list_unified_currencies_with_http_info(**kwargs) # noqa: E501
+
+ def list_unified_currencies_with_http_info(self, **kwargs): # noqa: E501
+ """List of loan currencies supported by unified account # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.list_unified_currencies_with_http_info(async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param str currency: Currency
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(list[gate_api.UnifiedCurrency], status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'currency'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method list_unified_currencies" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+ if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
+ query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = [] # noqa: E501
+
+ return self.api_client.call_api(
+ '/unified/currencies', 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='list[UnifiedCurrency]', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
+
def get_history_loan_rate(self, currency, **kwargs): # noqa: E501
- """get historical lending rates # noqa: E501
+ """Get historical lending rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2207,9 +2342,9 @@ def get_history_loan_rate(self, currency, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency: Currency (required)
- :param str tier: The VIP level of the floating rate that needs to be queried
+ :param str tier: VIP level for the floating rate to be queried
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2225,7 +2360,7 @@ def get_history_loan_rate(self, currency, **kwargs): # noqa: E501
return self.get_history_loan_rate_with_http_info(currency, **kwargs) # noqa: E501
def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E501
- """get historical lending rates # noqa: E501
+ """Get historical lending rates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2234,9 +2369,9 @@ def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E50
:param bool async_req: execute request asynchronously
:param str currency: Currency (required)
- :param str tier: The VIP level of the floating rate that needs to be queried
+ :param str tier: VIP level for the floating rate to be queried
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2312,7 +2447,7 @@ def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E50
['application/json']) # noqa: E501
# Authentication setting
- auth_settings = ['apiv4'] # noqa: E501
+ auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/unified/history_loan_rate', 'GET',
@@ -2329,3 +2464,119 @@ def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E50
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
+
+ def set_unified_collateral(self, unified_collateral_req, **kwargs): # noqa: E501
+ """Set collateral currency # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.set_unified_collateral(unified_collateral_req, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param UnifiedCollateralReq unified_collateral_req: (required)
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: gate_api.UnifiedCollateralRes
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ return self.set_unified_collateral_with_http_info(unified_collateral_req, **kwargs) # noqa: E501
+
+ def set_unified_collateral_with_http_info(self, unified_collateral_req, **kwargs): # noqa: E501
+ """Set collateral currency # noqa: E501
+
+ This method makes a synchronous HTTP request by default. To make an
+ asynchronous HTTP request, please pass async_req=True
+ >>> thread = api.set_unified_collateral_with_http_info(unified_collateral_req, async_req=True)
+ >>> result = thread.get()
+
+ :param bool async_req: execute request asynchronously
+ :param UnifiedCollateralReq unified_collateral_req: (required)
+ :param _return_http_data_only: response data without head status code
+ and headers
+ :param _preload_content: if False, the urllib3.HTTPResponse object will
+ be returned without reading/decoding response
+ data. Default is True.
+ :param _request_timeout: timeout setting for this request. If one
+ number provided, it will be total request
+ timeout. It can also be a pair (tuple) of
+ (connection, read) timeouts.
+ :rtype: tuple(gate_api.UnifiedCollateralRes, status_code(int), headers(HTTPHeaderDict))
+ :return: If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ local_var_params = locals()
+
+ all_params = [
+ 'unified_collateral_req'
+ ]
+ all_params.extend(
+ [
+ 'async_req',
+ '_return_http_data_only',
+ '_preload_content',
+ '_request_timeout'
+ ]
+ )
+
+ for k, v in six.iteritems(local_var_params['kwargs']):
+ if k not in all_params:
+ raise ApiTypeError(
+ "Got an unexpected keyword argument '%s'"
+ " to method set_unified_collateral" % k
+ )
+ local_var_params[k] = v
+ del local_var_params['kwargs']
+ # verify the required parameter 'unified_collateral_req' is set
+ if self.api_client.client_side_validation and ('unified_collateral_req' not in local_var_params or # noqa: E501
+ local_var_params['unified_collateral_req'] is None): # noqa: E501
+ raise ApiValueError("Missing the required parameter `unified_collateral_req` when calling `set_unified_collateral`") # noqa: E501
+
+ collection_formats = {}
+
+ path_params = {}
+
+ query_params = []
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'unified_collateral_req' in local_var_params:
+ body_params = local_var_params['unified_collateral_req']
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.select_header_accept(
+ ['application/json']) # noqa: E501
+
+ # HTTP header `Content-Type`
+ header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
+ ['application/json']) # noqa: E501
+
+ # Authentication setting
+ auth_settings = ['apiv4'] # noqa: E501
+
+ return self.api_client.call_api(
+ '/unified/collateral_currencies', 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='UnifiedCollateralRes', # noqa: E501
+ auth_settings=auth_settings,
+ async_req=local_var_params.get('async_req'),
+ _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
+ _preload_content=local_var_params.get('_preload_content', True),
+ _request_timeout=local_var_params.get('_request_timeout'),
+ collection_formats=collection_formats)
diff --git a/gate_api/api/wallet_api.py b/gate_api/api/wallet_api.py
index da481ed..0284850 100644
--- a/gate_api/api/wallet_api.py
+++ b/gate_api/api/wallet_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -37,7 +37,7 @@ def __init__(self, api_client=None):
self.api_client = api_client
def list_currency_chains(self, currency, **kwargs): # noqa: E501
- """List chains supported for specified currency # noqa: E501
+ """Query chains supported for specified currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -61,7 +61,7 @@ def list_currency_chains(self, currency, **kwargs): # noqa: E501
return self.list_currency_chains_with_http_info(currency, **kwargs) # noqa: E501
def list_currency_chains_with_http_info(self, currency, **kwargs): # noqa: E501
- """List chains supported for specified currency # noqa: E501
+ """Query chains supported for specified currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -261,19 +261,22 @@ def get_deposit_address_with_http_info(self, currency, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_withdrawals(self, **kwargs): # noqa: E501
- """Retrieve withdrawal records # noqa: E501
+ """Get withdrawal records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_withdrawals(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param str withdraw_id: Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled
+ :param str asset_class: Currency type of withdrawal record, empty by default. Supports querying withdrawal records in main zone and innovation zone on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone
+ :param str withdraw_order_id: User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -290,19 +293,22 @@ def list_withdrawals(self, **kwargs): # noqa: E501
return self.list_withdrawals_with_http_info(**kwargs) # noqa: E501
def list_withdrawals_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve withdrawal records # noqa: E501
+ """Get withdrawal records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_withdrawals_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param str withdraw_id: Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled
+ :param str asset_class: Currency type of withdrawal record, empty by default. Supports querying withdrawal records in main zone and innovation zone on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone
+ :param str withdraw_order_id: User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -322,6 +328,9 @@ def list_withdrawals_with_http_info(self, **kwargs): # noqa: E501
all_params = [
'currency',
+ 'withdraw_id',
+ 'asset_class',
+ 'withdraw_order_id',
'_from',
'to',
'limit',
@@ -358,6 +367,12 @@ def list_withdrawals_with_http_info(self, **kwargs): # noqa: E501
query_params = []
if 'currency' in local_var_params and local_var_params['currency'] is not None: # noqa: E501
query_params.append(('currency', local_var_params['currency'])) # noqa: E501
+ if 'withdraw_id' in local_var_params and local_var_params['withdraw_id'] is not None: # noqa: E501
+ query_params.append(('withdraw_id', local_var_params['withdraw_id'])) # noqa: E501
+ if 'asset_class' in local_var_params and local_var_params['asset_class'] is not None: # noqa: E501
+ query_params.append(('asset_class', local_var_params['asset_class'])) # noqa: E501
+ if 'withdraw_order_id' in local_var_params and local_var_params['withdraw_order_id'] is not None: # noqa: E501
+ query_params.append(('withdraw_order_id', local_var_params['withdraw_order_id'])) # noqa: E501
if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
query_params.append(('from', local_var_params['_from'])) # noqa: E501
if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
@@ -397,19 +412,19 @@ def list_withdrawals_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_deposits(self, **kwargs): # noqa: E501
- """Retrieve deposit records # noqa: E501
+ """Get deposit records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_deposits(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: The maximum number of entries returned in the list is limited to 500 transactions.
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of entries returned in the list, limited to 500 transactions
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -418,7 +433,7 @@ def list_deposits(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.LedgerRecord]
+ :rtype: list[gate_api.DepositRecord]
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -426,19 +441,19 @@ def list_deposits(self, **kwargs): # noqa: E501
return self.list_deposits_with_http_info(**kwargs) # noqa: E501
def list_deposits_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve deposit records # noqa: E501
+ """Get deposit records # noqa: E501
- Record time range cannot exceed 30 days # noqa: E501
+ Record query time range cannot exceed 30 days # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_deposits_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Filter by currency. Return all currency records if not specified
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: The maximum number of entries returned in the list is limited to 500 transactions.
+ :param str currency: Specify the currency. If not specified, returns all currencies
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of entries returned in the list, limited to 500 transactions
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -449,7 +464,7 @@ def list_deposits_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.LedgerRecord], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.DepositRecord], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -524,7 +539,7 @@ def list_deposits_with_http_info(self, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[LedgerRecord]', # noqa: E501
+ response_type='list[DepositRecord]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -535,7 +550,7 @@ def list_deposits_with_http_info(self, **kwargs): # noqa: E501
def transfer(self, transfer, **kwargs): # noqa: E501
"""Transfer between trading accounts # noqa: E501
- Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options # noqa: E501
+ Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.transfer(transfer, async_req=True)
@@ -560,7 +575,7 @@ def transfer(self, transfer, **kwargs): # noqa: E501
def transfer_with_http_info(self, transfer, **kwargs): # noqa: E501
"""Transfer between trading accounts # noqa: E501
- Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options # noqa: E501
+ Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.transfer_with_http_info(transfer, async_req=True)
@@ -651,19 +666,19 @@ def transfer_with_http_info(self, transfer, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_sub_account_transfers(self, **kwargs): # noqa: E501
- """Retrieve transfer records between main and sub accounts # noqa: E501
+ """Get transfer records between main and sub accounts # noqa: E501
- Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved # noqa: E501
+ Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_sub_account_transfers(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -672,7 +687,7 @@ def list_sub_account_transfers(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: list[gate_api.SubAccountTransfer]
+ :rtype: list[gate_api.SubAccountTransferRecordItem]
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -680,19 +695,19 @@ def list_sub_account_transfers(self, **kwargs): # noqa: E501
return self.list_sub_account_transfers_with_http_info(**kwargs) # noqa: E501
def list_sub_account_transfers_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve transfer records between main and sub accounts # noqa: E501
+ """Get transfer records between main and sub accounts # noqa: E501
- Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved # noqa: E501
+ Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_sub_account_transfers_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
- :param int _from: Time range beginning, default to 7 days before current time
- :param int to: Time range ending, default to current time
- :param int limit: Maximum number of records to be returned in a single list
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
+ :param int _from: Start time for querying records, defaults to 7 days before current time if not specified
+ :param int to: End timestamp for the query, defaults to current time if not specified
+ :param int limit: Maximum number of records returned in a single list
:param int offset: List offset, starting from 0
:param _return_http_data_only: response data without head status code
and headers
@@ -703,7 +718,7 @@ def list_sub_account_transfers_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(list[gate_api.SubAccountTransfer], status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(list[gate_api.SubAccountTransferRecordItem], status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -778,7 +793,7 @@ def list_sub_account_transfers_with_http_info(self, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='list[SubAccountTransfer]', # noqa: E501
+ response_type='list[SubAccountTransferRecordItem]', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -789,7 +804,7 @@ def list_sub_account_transfers_with_http_info(self, **kwargs): # noqa: E501
def transfer_with_sub_account(self, sub_account_transfer, **kwargs): # noqa: E501
"""Transfer between main and sub accounts # noqa: E501
- Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. # noqa: E501
+ Supports transfers to/from sub-account's spot or futures accounts. Note that regardless of which sub-account is operated, only the main account's spot account is used # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.transfer_with_sub_account(sub_account_transfer, async_req=True)
@@ -814,7 +829,7 @@ def transfer_with_sub_account(self, sub_account_transfer, **kwargs): # noqa: E5
def transfer_with_sub_account_with_http_info(self, sub_account_transfer, **kwargs): # noqa: E501
"""Transfer between main and sub accounts # noqa: E501
- Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. # noqa: E501
+ Supports transfers to/from sub-account's spot or futures accounts. Note that regardless of which sub-account is operated, only the main account's spot account is used # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.transfer_with_sub_account_with_http_info(sub_account_transfer, async_req=True)
@@ -905,9 +920,9 @@ def transfer_with_sub_account_with_http_info(self, sub_account_transfer, **kwarg
collection_formats=collection_formats)
def sub_account_to_sub_account(self, sub_account_to_sub_account, **kwargs): # noqa: E501
- """Sub-account transfers to sub-account # noqa: E501
+ """Transfer between sub-accounts # noqa: E501
- It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. # noqa: E501
+ Supports balance transfers between two sub-accounts under the same main account. You can use either the main account's API Key or the source sub-account's API Key to perform the operation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sub_account_to_sub_account(sub_account_to_sub_account, async_req=True)
@@ -930,9 +945,9 @@ def sub_account_to_sub_account(self, sub_account_to_sub_account, **kwargs): # n
return self.sub_account_to_sub_account_with_http_info(sub_account_to_sub_account, **kwargs) # noqa: E501
def sub_account_to_sub_account_with_http_info(self, sub_account_to_sub_account, **kwargs): # noqa: E501
- """Sub-account transfers to sub-account # noqa: E501
+ """Transfer between sub-accounts # noqa: E501
- It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. # noqa: E501
+ Supports balance transfers between two sub-accounts under the same main account. You can use either the main account's API Key or the source sub-account's API Key to perform the operation # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.sub_account_to_sub_account_with_http_info(sub_account_to_sub_account, async_req=True)
@@ -1025,15 +1040,15 @@ def sub_account_to_sub_account_with_http_info(self, sub_account_to_sub_account,
def get_transfer_order_status(self, **kwargs): # noqa: E501
"""Transfer status query # noqa: E501
- Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface # noqa: E501
+ Supports querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transfer_order_status(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str client_order_id: The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters.
- :param str tx_id: The transfer operation number and client_order_id cannot be empty at the same time
+ :param str client_order_id: Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters
+ :param str tx_id: Transfer operation number, cannot be empty at the same time as client_order_id
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1041,7 +1056,7 @@ def get_transfer_order_status(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: gate_api.InlineResponse200
+ :rtype: gate_api.TransferOrderStatus
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1051,15 +1066,15 @@ def get_transfer_order_status(self, **kwargs): # noqa: E501
def get_transfer_order_status_with_http_info(self, **kwargs): # noqa: E501
"""Transfer status query # noqa: E501
- Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface # noqa: E501
+ Supports querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_transfer_order_status_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str client_order_id: The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters.
- :param str tx_id: The transfer operation number and client_order_id cannot be empty at the same time
+ :param str client_order_id: Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters
+ :param str tx_id: Transfer operation number, cannot be empty at the same time as client_order_id
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1069,7 +1084,7 @@ def get_transfer_order_status_with_http_info(self, **kwargs): # noqa: E501
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
- :rtype: tuple(gate_api.InlineResponse200, status_code(int), headers(HTTPHeaderDict))
+ :rtype: tuple(gate_api.TransferOrderStatus, status_code(int), headers(HTTPHeaderDict))
:return: If the method is called asynchronously,
returns the request thread.
"""
@@ -1129,7 +1144,7 @@ def get_transfer_order_status_with_http_info(self, **kwargs): # noqa: E501
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='InlineResponse200', # noqa: E501
+ response_type='TransferOrderStatus', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
@@ -1138,7 +1153,7 @@ def get_transfer_order_status_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_withdraw_status(self, **kwargs): # noqa: E501
- """Retrieve withdrawal status # noqa: E501
+ """Query withdrawal status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1146,7 +1161,7 @@ def list_withdraw_status(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1162,7 +1177,7 @@ def list_withdraw_status(self, **kwargs): # noqa: E501
return self.list_withdraw_status_with_http_info(**kwargs) # noqa: E501
def list_withdraw_status_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve withdrawal status # noqa: E501
+ """Query withdrawal status # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1170,7 +1185,7 @@ def list_withdraw_status_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Retrieve data of the specified currency
+ :param str currency: Query by specified currency name
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1246,7 +1261,7 @@ def list_withdraw_status_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_sub_account_balances(self, **kwargs): # noqa: E501
- """Retrieve sub account balances # noqa: E501
+ """Query sub-account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1254,7 +1269,7 @@ def list_sub_account_balances(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1270,7 +1285,7 @@ def list_sub_account_balances(self, **kwargs): # noqa: E501
return self.list_sub_account_balances_with_http_info(**kwargs) # noqa: E501
def list_sub_account_balances_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve sub account balances # noqa: E501
+ """Query sub-account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1278,7 +1293,7 @@ def list_sub_account_balances_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1354,7 +1369,7 @@ def list_sub_account_balances_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_sub_account_margin_balances(self, **kwargs): # noqa: E501
- """Query sub accounts' margin balances # noqa: E501
+ """Query sub-account isolated margin account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1362,7 +1377,7 @@ def list_sub_account_margin_balances(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1378,7 +1393,7 @@ def list_sub_account_margin_balances(self, **kwargs): # noqa: E501
return self.list_sub_account_margin_balances_with_http_info(**kwargs) # noqa: E501
def list_sub_account_margin_balances_with_http_info(self, **kwargs): # noqa: E501
- """Query sub accounts' margin balances # noqa: E501
+ """Query sub-account isolated margin account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1386,7 +1401,7 @@ def list_sub_account_margin_balances_with_http_info(self, **kwargs): # noqa: E5
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1462,7 +1477,7 @@ def list_sub_account_margin_balances_with_http_info(self, **kwargs): # noqa: E5
collection_formats=collection_formats)
def list_sub_account_futures_balances(self, **kwargs): # noqa: E501
- """Query sub accounts' futures account balances # noqa: E501
+ """Query sub-account perpetual futures account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1470,8 +1485,8 @@ def list_sub_account_futures_balances(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
- :param str settle: Query only balances of specified settle currency
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
+ :param str settle: Query balance of specified settlement currency
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1487,7 +1502,7 @@ def list_sub_account_futures_balances(self, **kwargs): # noqa: E501
return self.list_sub_account_futures_balances_with_http_info(**kwargs) # noqa: E501
def list_sub_account_futures_balances_with_http_info(self, **kwargs): # noqa: E501
- """Query sub accounts' futures account balances # noqa: E501
+ """Query sub-account perpetual futures account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1495,8 +1510,8 @@ def list_sub_account_futures_balances_with_http_info(self, **kwargs): # noqa: E
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
- :param str settle: Query only balances of specified settle currency
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
+ :param str settle: Query balance of specified settlement currency
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1575,7 +1590,7 @@ def list_sub_account_futures_balances_with_http_info(self, **kwargs): # noqa: E
collection_formats=collection_formats)
def list_sub_account_cross_margin_balances(self, **kwargs): # noqa: E501
- """Query subaccount's cross_margin account info # noqa: E501
+ """Query sub-account cross margin account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1583,7 +1598,7 @@ def list_sub_account_cross_margin_balances(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1599,7 +1614,7 @@ def list_sub_account_cross_margin_balances(self, **kwargs): # noqa: E501
return self.list_sub_account_cross_margin_balances_with_http_info(**kwargs) # noqa: E501
def list_sub_account_cross_margin_balances_with_http_info(self, **kwargs): # noqa: E501
- """Query subaccount's cross_margin account info # noqa: E501
+ """Query sub-account cross margin account balance information # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1607,7 +1622,7 @@ def list_sub_account_cross_margin_balances_with_http_info(self, **kwargs): # no
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str sub_uid: User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts
+ :param str sub_uid: Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1683,7 +1698,7 @@ def list_sub_account_cross_margin_balances_with_http_info(self, **kwargs): # no
collection_formats=collection_formats)
def list_saved_address(self, currency, **kwargs): # noqa: E501
- """Query saved address # noqa: E501
+ """Query withdrawal address whitelist # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1693,7 +1708,7 @@ def list_saved_address(self, currency, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency: Currency (required)
:param str chain: Chain name
- :param str limit: Maximum number returned, 100 at most
+ :param str limit: Maximum number returned, up to 100
:param int page: Page number
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
@@ -1710,7 +1725,7 @@ def list_saved_address(self, currency, **kwargs): # noqa: E501
return self.list_saved_address_with_http_info(currency, **kwargs) # noqa: E501
def list_saved_address_with_http_info(self, currency, **kwargs): # noqa: E501
- """Query saved address # noqa: E501
+ """Query withdrawal address whitelist # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1720,7 +1735,7 @@ def list_saved_address_with_http_info(self, currency, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param str currency: Currency (required)
:param str chain: Chain name
- :param str limit: Maximum number returned, 100 at most
+ :param str limit: Maximum number returned, up to 100
:param int page: Page number
:param _return_http_data_only: response data without head status code
and headers
@@ -1812,7 +1827,7 @@ def list_saved_address_with_http_info(self, currency, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_trade_fee(self, **kwargs): # noqa: E501
- """Retrieve personal trading fee # noqa: E501
+ """Query personal trading fees # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1820,8 +1835,8 @@ def get_trade_fee(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs
- :param str settle: Specify the settlement currency of the contract to get more accurate rate settings This field is optional. Generally, the rate settings for all settlement currencies are the same.
+ :param str currency_pair: Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs.
+ :param str settle: Specify the settlement currency of the contract to get more accurate fee settings. This field is optional. Generally, the fee settings for all settlement currencies are the same.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1837,7 +1852,7 @@ def get_trade_fee(self, **kwargs): # noqa: E501
return self.get_trade_fee_with_http_info(**kwargs) # noqa: E501
def get_trade_fee_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve personal trading fee # noqa: E501
+ """Query personal trading fees # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1845,8 +1860,8 @@ def get_trade_fee_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency_pair: Specify a currency pair to retrieve precise fee rate This field is optional. In most cases, the fee rate is identical among all currency pairs
- :param str settle: Specify the settlement currency of the contract to get more accurate rate settings This field is optional. Generally, the rate settings for all settlement currencies are the same.
+ :param str currency_pair: Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs.
+ :param str settle: Specify the settlement currency of the contract to get more accurate fee settings. This field is optional. Generally, the fee settings for all settlement currencies are the same.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1925,16 +1940,16 @@ def get_trade_fee_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def get_total_balance(self, **kwargs): # noqa: E501
- """Retrieve user's total balances # noqa: E501
+ """Query personal account totals # noqa: E501
- This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance # noqa: E501
+ This query endpoint returns the total *estimated value* of all currencies in each account converted to the input currency. Exchange rates and related account balance information may be cached for up to 1 minute. It is not recommended to use this interface data for real-time calculations. For real-time calculations, query the corresponding balance interface based on account type, such as: - `GET /spot/accounts` to query spot account - `GET /margin/accounts` to query margin account - `GET /futures/{settle}/accounts` to query futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_total_balance(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default.
+ :param str currency: Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -1950,16 +1965,16 @@ def get_total_balance(self, **kwargs): # noqa: E501
return self.get_total_balance_with_http_info(**kwargs) # noqa: E501
def get_total_balance_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve user's total balances # noqa: E501
+ """Query personal account totals # noqa: E501
- This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance # noqa: E501
+ This query endpoint returns the total *estimated value* of all currencies in each account converted to the input currency. Exchange rates and related account balance information may be cached for up to 1 minute. It is not recommended to use this interface data for real-time calculations. For real-time calculations, query the corresponding balance interface based on account type, such as: - `GET /spot/accounts` to query spot account - `GET /margin/accounts` to query margin account - `GET /futures/{settle}/accounts` to query futures account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_total_balance_with_http_info(async_req=True)
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default.
+ :param str currency: Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2035,7 +2050,7 @@ def get_total_balance_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_small_balance(self, **kwargs): # noqa: E501
- """List small balance # noqa: E501
+ """Get list of convertible small balance currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2058,7 +2073,7 @@ def list_small_balance(self, **kwargs): # noqa: E501
return self.list_small_balance_with_http_info(**kwargs) # noqa: E501
def list_small_balance_with_http_info(self, **kwargs): # noqa: E501
- """List small balance # noqa: E501
+ """Get list of convertible small balance currencies # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2138,7 +2153,7 @@ def list_small_balance_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def convert_small_balance(self, convert_small_balance, **kwargs): # noqa: E501
- """Convert small balance # noqa: E501
+ """Convert small balance currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2162,7 +2177,7 @@ def convert_small_balance(self, convert_small_balance, **kwargs): # noqa: E501
return self.convert_small_balance_with_http_info(convert_small_balance, **kwargs) # noqa: E501
def convert_small_balance_with_http_info(self, convert_small_balance, **kwargs): # noqa: E501
- """Convert small balance # noqa: E501
+ """Convert small balance currency # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2250,7 +2265,7 @@ def convert_small_balance_with_http_info(self, convert_small_balance, **kwargs):
collection_formats=collection_formats)
def list_small_balance_history(self, **kwargs): # noqa: E501
- """List small balance history # noqa: E501
+ """Get convertible small balance currency history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2258,9 +2273,9 @@ def list_small_balance_history(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency
+ :param str currency: Currency to convert
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2276,7 +2291,7 @@ def list_small_balance_history(self, **kwargs): # noqa: E501
return self.list_small_balance_history_with_http_info(**kwargs) # noqa: E501
def list_small_balance_history_with_http_info(self, **kwargs): # noqa: E501
- """List small balance history # noqa: E501
+ """Get convertible small balance currency history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2284,9 +2299,9 @@ def list_small_balance_history_with_http_info(self, **kwargs): # noqa: E501
>>> result = thread.get()
:param bool async_req: execute request asynchronously
- :param str currency: Currency
+ :param str currency: Currency to convert
:param int page: Page number
- :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100
+ :param int limit: Maximum number of items returned. Default: 100, minimum: 1, maximum: 100
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2374,7 +2389,7 @@ def list_small_balance_history_with_http_info(self, **kwargs): # noqa: E501
collection_formats=collection_formats)
def list_push_orders(self, **kwargs): # noqa: E501
- """Retrieve the UID transfer history # noqa: E501
+ """Get UID transfer history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2383,10 +2398,11 @@ def list_push_orders(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int id: Order ID
- :param int _from: The start time of the query record. If not specified, it defaults to 7 days forward from the current time, in seconds Unix timestamp
- :param int to: The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds.
- :param int limit: The maximum number of items returned in the list, the default value is 100
+ :param int _from: Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds
+ :param int to: End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds
+ :param int limit: Maximum number of items returned in the list, default value is 100
:param int offset: List offset, starting from 0
+ :param str transaction_type: Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`.
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
@@ -2402,7 +2418,7 @@ def list_push_orders(self, **kwargs): # noqa: E501
return self.list_push_orders_with_http_info(**kwargs) # noqa: E501
def list_push_orders_with_http_info(self, **kwargs): # noqa: E501
- """Retrieve the UID transfer history # noqa: E501
+ """Get UID transfer history # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -2411,10 +2427,11 @@ def list_push_orders_with_http_info(self, **kwargs): # noqa: E501
:param bool async_req: execute request asynchronously
:param int id: Order ID
- :param int _from: The start time of the query record. If not specified, it defaults to 7 days forward from the current time, in seconds Unix timestamp
- :param int to: The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds.
- :param int limit: The maximum number of items returned in the list, the default value is 100
+ :param int _from: Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds
+ :param int to: End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds
+ :param int limit: Maximum number of items returned in the list, default value is 100
:param int offset: List offset, starting from 0
+ :param str transaction_type: Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2436,7 +2453,8 @@ def list_push_orders_with_http_info(self, **kwargs): # noqa: E501
'_from',
'to',
'limit',
- 'offset'
+ 'offset',
+ 'transaction_type'
]
all_params.extend(
[
@@ -2475,6 +2493,8 @@ def list_push_orders_with_http_info(self, **kwargs): # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
query_params.append(('offset', local_var_params['offset'])) # noqa: E501
+ if 'transaction_type' in local_var_params and local_var_params['transaction_type'] is not None: # noqa: E501
+ query_params.append(('transaction_type', local_var_params['transaction_type'])) # noqa: E501
header_params = {}
diff --git a/gate_api/api/withdrawal_api.py b/gate_api/api/withdrawal_api.py
index 318623a..7fb64dd 100644
--- a/gate_api/api/withdrawal_api.py
+++ b/gate_api/api/withdrawal_api.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -39,7 +39,7 @@ def __init__(self, api_client=None):
def withdraw(self, ledger_record, **kwargs): # noqa: E501
"""Withdraw # noqa: E501
- Withdrawals to Gate addresses do not incur transaction fees. # noqa: E501
+ If the recipient's on-chain address is also Gate, no transaction fee will be charged # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.withdraw(ledger_record, async_req=True)
@@ -64,7 +64,7 @@ def withdraw(self, ledger_record, **kwargs): # noqa: E501
def withdraw_with_http_info(self, ledger_record, **kwargs): # noqa: E501
"""Withdraw # noqa: E501
- Withdrawals to Gate addresses do not incur transaction fees. # noqa: E501
+ If the recipient's on-chain address is also Gate, no transaction fee will be charged # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.withdraw_with_http_info(ledger_record, async_req=True)
@@ -157,7 +157,7 @@ def withdraw_with_http_info(self, ledger_record, **kwargs): # noqa: E501
def withdraw_push_order(self, uid_push_withdrawal, **kwargs): # noqa: E501
"""UID transfer # noqa: E501
- Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts # noqa: E501
+ Transfers between main spot accounts. Both parties cannot be sub-accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.withdraw_push_order(uid_push_withdrawal, async_req=True)
@@ -182,7 +182,7 @@ def withdraw_push_order(self, uid_push_withdrawal, **kwargs): # noqa: E501
def withdraw_push_order_with_http_info(self, uid_push_withdrawal, **kwargs): # noqa: E501
"""UID transfer # noqa: E501
- Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts # noqa: E501
+ Transfers between main spot accounts. Both parties cannot be sub-accounts # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.withdraw_push_order_with_http_info(uid_push_withdrawal, async_req=True)
diff --git a/gate_api/api_client.py b/gate_api/api_client.py
index 6498a0e..5d90c48 100644
--- a/gate_api/api_client.py
+++ b/gate_api/api_client.py
@@ -1,10 +1,10 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -83,7 +83,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
- self.user_agent = 'OpenAPI-Generator/4.88.0/python'
+ self.user_agent = 'OpenAPI-Generator/7.1.8/python'
self.client_side_validation = configuration.client_side_validation
def __enter__(self):
diff --git a/gate_api/configuration.py b/gate_api/configuration.py
index 5ccfe35..e1a45a1 100644
--- a/gate_api/configuration.py
+++ b/gate_api/configuration.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -313,8 +313,8 @@ def to_debug_report(self):
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
- "Version of the API: 4.88.0\n"\
- "SDK Package Version: 4.88.0".\
+ "Version of the API: v4.105.8\n"\
+ "SDK Package Version: 7.1.8".\
format(env=sys.platform, pyversion=sys.version)
def get_host_settings(self):
@@ -325,11 +325,11 @@ def get_host_settings(self):
return [
{
'url': "https://api.gateio.ws/api/v4",
- 'description': "Real Trading",
+ 'description': "Real trading",
},
{
'url': "https://fx-api-testnet.gateio.ws/api/v4",
- 'description': "TestNet Trading",
+ 'description': "TestNet trading",
}
]
diff --git a/gate_api/exceptions.py b/gate_api/exceptions.py
index e890184..31ff2ea 100644
--- a/gate_api/exceptions.py
+++ b/gate_api/exceptions.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/__init__.py b/gate_api/models/__init__.py
index 96d8f36..4976416 100644
--- a/gate_api/models/__init__.py
+++ b/gate_api/models/__init__.py
@@ -2,11 +2,11 @@
# flake8: noqa
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -30,6 +30,7 @@
from gate_api.models.borrow_currency_info import BorrowCurrencyInfo
from gate_api.models.broker_commission import BrokerCommission
from gate_api.models.broker_commission1 import BrokerCommission1
+from gate_api.models.broker_commission_sub_broker_info import BrokerCommissionSubBrokerInfo
from gate_api.models.broker_transaction import BrokerTransaction
from gate_api.models.broker_transaction1 import BrokerTransaction1
from gate_api.models.cancel_batch_order import CancelBatchOrder
@@ -56,34 +57,31 @@
from gate_api.models.create_multi_collateral_order import CreateMultiCollateralOrder
from gate_api.models.create_uni_lend import CreateUniLend
from gate_api.models.create_uni_loan import CreateUniLoan
-from gate_api.models.cross_margin_account import CrossMarginAccount
-from gate_api.models.cross_margin_account_book import CrossMarginAccountBook
from gate_api.models.cross_margin_balance import CrossMarginBalance
-from gate_api.models.cross_margin_balance1 import CrossMarginBalance1
-from gate_api.models.cross_margin_currency import CrossMarginCurrency
from gate_api.models.cross_margin_loan import CrossMarginLoan
-from gate_api.models.cross_margin_repay_request import CrossMarginRepayRequest
from gate_api.models.cross_margin_repayment import CrossMarginRepayment
-from gate_api.models.cross_margin_transferable import CrossMarginTransferable
from gate_api.models.currency import Currency
from gate_api.models.currency_chain import CurrencyChain
from gate_api.models.currency_pair import CurrencyPair
from gate_api.models.currency_quota import CurrencyQuota
+from gate_api.models.debit_fee import DebitFee
from gate_api.models.delivery_candlestick import DeliveryCandlestick
from gate_api.models.delivery_contract import DeliveryContract
from gate_api.models.delivery_settlement import DeliverySettlement
+from gate_api.models.delivery_ticker import DeliveryTicker
from gate_api.models.deposit_address import DepositAddress
+from gate_api.models.deposit_record import DepositRecord
from gate_api.models.dual_get_orders import DualGetOrders
from gate_api.models.dual_get_plans import DualGetPlans
+from gate_api.models.eth2_rate_list import Eth2RateList
from gate_api.models.eth2_swap import Eth2Swap
-from gate_api.models.flash_swap_currency import FlashSwapCurrency
+from gate_api.models.find_coin import FindCoin
from gate_api.models.flash_swap_currency_pair import FlashSwapCurrencyPair
from gate_api.models.flash_swap_order import FlashSwapOrder
from gate_api.models.flash_swap_order_preview import FlashSwapOrderPreview
from gate_api.models.flash_swap_order_request import FlashSwapOrderRequest
from gate_api.models.flash_swap_preview_request import FlashSwapPreviewRequest
from gate_api.models.funding_account import FundingAccount
-from gate_api.models.funding_book_item import FundingBookItem
from gate_api.models.funding_rate_record import FundingRateRecord
from gate_api.models.future_cancel_order_result import FutureCancelOrderResult
from gate_api.models.futures_account import FuturesAccount
@@ -102,9 +100,11 @@
from gate_api.models.futures_order_amendment import FuturesOrderAmendment
from gate_api.models.futures_order_book import FuturesOrderBook
from gate_api.models.futures_order_book_item import FuturesOrderBookItem
+from gate_api.models.futures_position_cross_mode import FuturesPositionCrossMode
from gate_api.models.futures_premium_index import FuturesPremiumIndex
from gate_api.models.futures_price_trigger import FuturesPriceTrigger
from gate_api.models.futures_price_triggered_order import FuturesPriceTriggeredOrder
+from gate_api.models.futures_risk_limit_tier import FuturesRiskLimitTier
from gate_api.models.futures_ticker import FuturesTicker
from gate_api.models.futures_trade import FuturesTrade
from gate_api.models.index_constituent import IndexConstituent
@@ -114,14 +114,11 @@
from gate_api.models.insurance_record import InsuranceRecord
from gate_api.models.ledger_record import LedgerRecord
from gate_api.models.liquidate_order import LiquidateOrder
-from gate_api.models.loan import Loan
-from gate_api.models.loan_patch import LoanPatch
-from gate_api.models.loan_record import LoanRecord
from gate_api.models.margin_account import MarginAccount
from gate_api.models.margin_account_book import MarginAccountBook
from gate_api.models.margin_account_currency import MarginAccountCurrency
-from gate_api.models.margin_borrowable import MarginBorrowable
-from gate_api.models.margin_currency_pair import MarginCurrencyPair
+from gate_api.models.margin_leverage_tier import MarginLeverageTier
+from gate_api.models.margin_market_leverage import MarginMarketLeverage
from gate_api.models.margin_tiers import MarginTiers
from gate_api.models.margin_transferable import MarginTransferable
from gate_api.models.max_uni_borrowable import MaxUniBorrowable
@@ -186,15 +183,14 @@
from gate_api.models.repay_record_left_interest import RepayRecordLeftInterest
from gate_api.models.repay_record_repaid_currency import RepayRecordRepaidCurrency
from gate_api.models.repay_record_total_interest import RepayRecordTotalInterest
-from gate_api.models.repay_request import RepayRequest
from gate_api.models.repay_resp import RepayResp
-from gate_api.models.repayment import Repayment
from gate_api.models.risk_units import RiskUnits
from gate_api.models.saved_address import SavedAddress
from gate_api.models.small_balance import SmallBalance
from gate_api.models.small_balance_history import SmallBalanceHistory
from gate_api.models.spot_account import SpotAccount
from gate_api.models.spot_account_book import SpotAccountBook
+from gate_api.models.spot_currency_chain import SpotCurrencyChain
from gate_api.models.spot_fee import SpotFee
from gate_api.models.spot_insurance_history import SpotInsuranceHistory
from gate_api.models.spot_price_put_order import SpotPricePutOrder
@@ -214,8 +210,11 @@
from gate_api.models.sub_account_margin_balance import SubAccountMarginBalance
from gate_api.models.sub_account_to_sub_account import SubAccountToSubAccount
from gate_api.models.sub_account_transfer import SubAccountTransfer
+from gate_api.models.sub_account_transfer_record_item import SubAccountTransferRecordItem
from gate_api.models.sub_cross_margin_account import SubCrossMarginAccount
from gate_api.models.sub_user_mode import SubUserMode
+from gate_api.models.swap_coin import SwapCoin
+from gate_api.models.swap_coin_struct import SwapCoinStruct
from gate_api.models.system_time import SystemTime
from gate_api.models.ticker import Ticker
from gate_api.models.total_balance import TotalBalance
@@ -223,6 +222,8 @@
from gate_api.models.trade_fee import TradeFee
from gate_api.models.transaction_id import TransactionID
from gate_api.models.transfer import Transfer
+from gate_api.models.transfer_order_status import TransferOrderStatus
+from gate_api.models.transferables_result import TransferablesResult
from gate_api.models.trigger_order_response import TriggerOrderResponse
from gate_api.models.trigger_time import TriggerTime
from gate_api.models.uid_push_order import UidPushOrder
@@ -231,7 +232,6 @@
from gate_api.models.uni_currency import UniCurrency
from gate_api.models.uni_currency_interest import UniCurrencyInterest
from gate_api.models.uni_currency_pair import UniCurrencyPair
-from gate_api.models.uni_interest_mode import UniInterestMode
from gate_api.models.uni_interest_record import UniInterestRecord
from gate_api.models.uni_lend import UniLend
from gate_api.models.uni_lend_interest import UniLendInterest
@@ -242,6 +242,10 @@
from gate_api.models.unified_account import UnifiedAccount
from gate_api.models.unified_balance import UnifiedBalance
from gate_api.models.unified_borrowable import UnifiedBorrowable
+from gate_api.models.unified_borrowable1 import UnifiedBorrowable1
+from gate_api.models.unified_collateral_req import UnifiedCollateralReq
+from gate_api.models.unified_collateral_res import UnifiedCollateralRes
+from gate_api.models.unified_currency import UnifiedCurrency
from gate_api.models.unified_discount import UnifiedDiscount
from gate_api.models.unified_discount_tiers import UnifiedDiscountTiers
from gate_api.models.unified_history_loan_rate import UnifiedHistoryLoanRate
@@ -250,8 +254,8 @@
from gate_api.models.unified_leverage_setting import UnifiedLeverageSetting
from gate_api.models.unified_loan import UnifiedLoan
from gate_api.models.unified_loan_record import UnifiedLoanRecord
+from gate_api.models.unified_loan_result import UnifiedLoanResult
from gate_api.models.unified_margin_tiers import UnifiedMarginTiers
-from gate_api.models.unified_mode import UnifiedMode
from gate_api.models.unified_mode_set import UnifiedModeSet
from gate_api.models.unified_portfolio_input import UnifiedPortfolioInput
from gate_api.models.unified_portfolio_output import UnifiedPortfolioOutput
@@ -259,6 +263,8 @@
from gate_api.models.unified_settings import UnifiedSettings
from gate_api.models.unified_transferable import UnifiedTransferable
from gate_api.models.user_ltv_info import UserLtvInfo
+from gate_api.models.user_sub import UserSub
+from gate_api.models.user_sub_relation import UserSubRelation
from gate_api.models.user_total_amount import UserTotalAmount
from gate_api.models.withdraw_status import WithdrawStatus
from gate_api.models.withdrawal_record import WithdrawalRecord
diff --git a/gate_api/models/account_balance.py b/gate_api/models/account_balance.py
index 03dfc20..f213fb7 100644
--- a/gate_api/models/account_balance.py
+++ b/gate_api/models/account_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -147,7 +147,7 @@ def unrealised_pnl(self, unrealised_pnl):
def borrowed(self):
"""Gets the borrowed of this AccountBalance. # noqa: E501
- Borrowed，this field will only appear in margin and cross_margin accounts # noqa: E501
+ Total borrowed amount, this field will only appear in margin and cross_margin accounts # noqa: E501
:return: The borrowed of this AccountBalance. # noqa: E501
:rtype: str
@@ -158,7 +158,7 @@ def borrowed(self):
def borrowed(self, borrowed):
"""Sets the borrowed of this AccountBalance.
- Borrowed，this field will only appear in margin and cross_margin accounts # noqa: E501
+ Total borrowed amount, this field will only appear in margin and cross_margin accounts # noqa: E501
:param borrowed: The borrowed of this AccountBalance. # noqa: E501
:type: str
diff --git a/gate_api/models/account_detail.py b/gate_api/models/account_detail.py
index 914531f..7854045 100644
--- a/gate_api/models/account_detail.py
+++ b/gate_api/models/account_detail.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -82,7 +82,7 @@ def __init__(self, ip_whitelist=None, currency_pairs=None, user_id=None, tier=No
def ip_whitelist(self):
"""Gets the ip_whitelist of this AccountDetail. # noqa: E501
- IP whitelist # noqa: E501
+ IP Whitelist # noqa: E501
:return: The ip_whitelist of this AccountDetail. # noqa: E501
:rtype: list[str]
@@ -93,7 +93,7 @@ def ip_whitelist(self):
def ip_whitelist(self, ip_whitelist):
"""Sets the ip_whitelist of this AccountDetail.
- IP whitelist # noqa: E501
+ IP Whitelist # noqa: E501
:param ip_whitelist: The ip_whitelist of this AccountDetail. # noqa: E501
:type: list[str]
@@ -105,7 +105,7 @@ def ip_whitelist(self, ip_whitelist):
def currency_pairs(self):
"""Gets the currency_pairs of this AccountDetail. # noqa: E501
- CurrencyPair whitelisting # noqa: E501
+ Trading pair whitelist # noqa: E501
:return: The currency_pairs of this AccountDetail. # noqa: E501
:rtype: list[str]
@@ -116,7 +116,7 @@ def currency_pairs(self):
def currency_pairs(self, currency_pairs):
"""Sets the currency_pairs of this AccountDetail.
- CurrencyPair whitelisting # noqa: E501
+ Trading pair whitelist # noqa: E501
:param currency_pairs: The currency_pairs of this AccountDetail. # noqa: E501
:type: list[str]
@@ -195,7 +195,7 @@ def key(self, key):
def copy_trading_role(self):
"""Gets the copy_trading_role of this AccountDetail. # noqa: E501
- User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower # noqa: E501
+ User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower # noqa: E501
:return: The copy_trading_role of this AccountDetail. # noqa: E501
:rtype: int
@@ -206,7 +206,7 @@ def copy_trading_role(self):
def copy_trading_role(self, copy_trading_role):
"""Sets the copy_trading_role of this AccountDetail.
- User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower # noqa: E501
+ User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower # noqa: E501
:param copy_trading_role: The copy_trading_role of this AccountDetail. # noqa: E501
:type: int
diff --git a/gate_api/models/account_detail_key.py b/gate_api/models/account_detail_key.py
index 75cde18..d9e3728 100644
--- a/gate_api/models/account_detail_key.py
+++ b/gate_api/models/account_detail_key.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -57,7 +57,7 @@ def __init__(self, mode=None, local_vars_configuration=None): # noqa: E501
def mode(self):
"""Gets the mode of this AccountDetailKey. # noqa: E501
- mode: 1 - classic account 2 - portfolio margin account # noqa: E501
+ Mode: 1 - Classic mode, 2 - Legacy unified mode # noqa: E501
:return: The mode of this AccountDetailKey. # noqa: E501
:rtype: int
@@ -68,7 +68,7 @@ def mode(self):
def mode(self, mode):
"""Sets the mode of this AccountDetailKey.
- mode: 1 - classic account 2 - portfolio margin account # noqa: E501
+ Mode: 1 - Classic mode, 2 - Legacy unified mode # noqa: E501
:param mode: The mode of this AccountDetailKey. # noqa: E501
:type: int
diff --git a/gate_api/models/account_rate_limit.py b/gate_api/models/account_rate_limit.py
index 18aac47..2fd7e27 100644
--- a/gate_api/models/account_rate_limit.py
+++ b/gate_api/models/account_rate_limit.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -72,7 +72,7 @@ def __init__(self, tier=None, ratio=None, main_ratio=None, updated_at=None, loca
def tier(self):
"""Gets the tier of this AccountRateLimit. # noqa: E501
- Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#成交比率限频)) # noqa: E501
+ Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) # noqa: E501
:return: The tier of this AccountRateLimit. # noqa: E501
:rtype: str
@@ -83,7 +83,7 @@ def tier(self):
def tier(self, tier):
"""Sets the tier of this AccountRateLimit.
- Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#成交比率限频)) # noqa: E501
+ Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) # noqa: E501
:param tier: The tier of this AccountRateLimit. # noqa: E501
:type: str
@@ -95,7 +95,7 @@ def tier(self, tier):
def ratio(self):
"""Gets the ratio of this AccountRateLimit. # noqa: E501
- Transaction rate # noqa: E501
+ Fill rate # noqa: E501
:return: The ratio of this AccountRateLimit. # noqa: E501
:rtype: str
@@ -106,7 +106,7 @@ def ratio(self):
def ratio(self, ratio):
"""Sets the ratio of this AccountRateLimit.
- Transaction rate # noqa: E501
+ Fill rate # noqa: E501
:param ratio: The ratio of this AccountRateLimit. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def ratio(self, ratio):
def main_ratio(self):
"""Gets the main_ratio of this AccountRateLimit. # noqa: E501
- Total transaction ratio of main account # noqa: E501
+ Total fill ratio of main account # noqa: E501
:return: The main_ratio of this AccountRateLimit. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def main_ratio(self):
def main_ratio(self, main_ratio):
"""Sets the main_ratio of this AccountRateLimit.
- Total transaction ratio of main account # noqa: E501
+ Total fill ratio of main account # noqa: E501
:param main_ratio: The main_ratio of this AccountRateLimit. # noqa: E501
:type: str
diff --git a/gate_api/models/agency_commission.py b/gate_api/models/agency_commission.py
index c55dad8..d843953 100644
--- a/gate_api/models/agency_commission.py
+++ b/gate_api/models/agency_commission.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -82,7 +82,7 @@ def __init__(self, commission_time=None, user_id=None, group_name=None, commissi
def commission_time(self):
"""Gets the commission_time of this AgencyCommission. # noqa: E501
- Commission Time. (unix timestamp) # noqa: E501
+ Commission time (Unix timestamp in seconds) # noqa: E501
:return: The commission_time of this AgencyCommission. # noqa: E501
:rtype: int
@@ -93,7 +93,7 @@ def commission_time(self):
def commission_time(self, commission_time):
"""Sets the commission_time of this AgencyCommission.
- Commission Time. (unix timestamp) # noqa: E501
+ Commission time (Unix timestamp in seconds) # noqa: E501
:param commission_time: The commission_time of this AgencyCommission. # noqa: E501
:type: int
@@ -151,7 +151,7 @@ def group_name(self, group_name):
def commission_amount(self):
"""Gets the commission_amount of this AgencyCommission. # noqa: E501
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:return: The commission_amount of this AgencyCommission. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def commission_amount(self):
def commission_amount(self, commission_amount):
"""Sets the commission_amount of this AgencyCommission.
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:param commission_amount: The commission_amount of this AgencyCommission. # noqa: E501
:type: str
@@ -197,7 +197,7 @@ def commission_asset(self, commission_asset):
def source(self):
"""Gets the source of this AgencyCommission. # noqa: E501
- Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate # noqa: E501
+ Commission source: SPOT - Spot commission, FUTURES - Futures commission # noqa: E501
:return: The source of this AgencyCommission. # noqa: E501
:rtype: str
@@ -208,7 +208,7 @@ def source(self):
def source(self, source):
"""Sets the source of this AgencyCommission.
- Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate # noqa: E501
+ Commission source: SPOT - Spot commission, FUTURES - Futures commission # noqa: E501
:param source: The source of this AgencyCommission. # noqa: E501
:type: str
diff --git a/gate_api/models/agency_commission_history.py b/gate_api/models/agency_commission_history.py
index 59c4540..50fd672 100644
--- a/gate_api/models/agency_commission_history.py
+++ b/gate_api/models/agency_commission_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -113,7 +113,7 @@ def total(self, total):
def list(self):
"""Gets the list of this AgencyCommissionHistory. # noqa: E501
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:return: The list of this AgencyCommissionHistory. # noqa: E501
:rtype: list[AgencyCommission]
@@ -124,7 +124,7 @@ def list(self):
def list(self, list):
"""Sets the list of this AgencyCommissionHistory.
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:param list: The list of this AgencyCommissionHistory. # noqa: E501
:type: list[AgencyCommission]
diff --git a/gate_api/models/agency_transaction.py b/gate_api/models/agency_transaction.py
index ffba857..abdf119 100644
--- a/gate_api/models/agency_transaction.py
+++ b/gate_api/models/agency_transaction.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -235,7 +235,7 @@ def currency_pair(self, currency_pair):
def amount(self):
"""Gets the amount of this AgencyTransaction. # noqa: E501
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:return: The amount of this AgencyTransaction. # noqa: E501
:rtype: str
@@ -246,7 +246,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this AgencyTransaction.
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:param amount: The amount of this AgencyTransaction. # noqa: E501
:type: str
@@ -281,7 +281,7 @@ def amount_asset(self, amount_asset):
def source(self):
"""Gets the source of this AgencyTransaction. # noqa: E501
- Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate # noqa: E501
+ Commission source: SPOT - Spot commission, FUTURES - Futures commission # noqa: E501
:return: The source of this AgencyTransaction. # noqa: E501
:rtype: str
@@ -292,7 +292,7 @@ def source(self):
def source(self, source):
"""Sets the source of this AgencyTransaction.
- Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate # noqa: E501
+ Commission source: SPOT - Spot commission, FUTURES - Futures commission # noqa: E501
:param source: The source of this AgencyTransaction. # noqa: E501
:type: str
diff --git a/gate_api/models/agency_transaction_history.py b/gate_api/models/agency_transaction_history.py
index 63f4d6b..99dfdeb 100644
--- a/gate_api/models/agency_transaction_history.py
+++ b/gate_api/models/agency_transaction_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/auto_repay_setting.py b/gate_api/models/auto_repay_setting.py
index 8b3fe3c..a3d0994 100644
--- a/gate_api/models/auto_repay_setting.py
+++ b/gate_api/models/auto_repay_setting.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -57,7 +57,7 @@ def __init__(self, status=None, local_vars_configuration=None): # noqa: E501
def status(self):
"""Gets the status of this AutoRepaySetting. # noqa: E501
- Auto repayment status. `on` - enabled, `off` - disabled # noqa: E501
+ Auto repayment status: `on` - enabled, `off` - disabled # noqa: E501
:return: The status of this AutoRepaySetting. # noqa: E501
:rtype: str
@@ -68,7 +68,7 @@ def status(self):
def status(self, status):
"""Sets the status of this AutoRepaySetting.
- Auto repayment status. `on` - enabled, `off` - disabled # noqa: E501
+ Auto repayment status: `on` - enabled, `off` - disabled # noqa: E501
:param status: The status of this AutoRepaySetting. # noqa: E501
:type: str
diff --git a/gate_api/models/batch_amend_item.py b/gate_api/models/batch_amend_item.py
index 236c791..7125ac0 100644
--- a/gate_api/models/batch_amend_item.py
+++ b/gate_api/models/batch_amend_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def __init__(self, order_id=None, currency_pair=None, account=None, amount=None,
def order_id(self):
"""Gets the order_id of this BatchAmendItem. # noqa: E501
- The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). # noqa: E501
+ The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field) # noqa: E501
:return: The order_id of this BatchAmendItem. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this BatchAmendItem.
- The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). # noqa: E501
+ The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field) # noqa: E501
:param order_id: The order_id of this BatchAmendItem. # noqa: E501
:type: str
@@ -135,7 +135,7 @@ def currency_pair(self, currency_pair):
def account(self):
"""Gets the account of this BatchAmendItem. # noqa: E501
- 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. # noqa: E501
+ Default spot, unified account and warehouse-by-store leverage account # noqa: E501
:return: The account of this BatchAmendItem. # noqa: E501
:rtype: str
@@ -146,7 +146,7 @@ def account(self):
def account(self, account):
"""Sets the account of this BatchAmendItem.
- 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. # noqa: E501
+ Default spot, unified account and warehouse-by-store leverage account # noqa: E501
:param account: The account of this BatchAmendItem. # noqa: E501
:type: str
@@ -158,7 +158,7 @@ def account(self, account):
def amount(self):
"""Gets the amount of this BatchAmendItem. # noqa: E501
- trade amount, only one of amount and price can be specified # noqa: E501
+ Trading Quantity. Only one of `amount` or `price` can be specified # noqa: E501
:return: The amount of this BatchAmendItem. # noqa: E501
:rtype: str
@@ -169,7 +169,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this BatchAmendItem.
- trade amount, only one of amount and price can be specified # noqa: E501
+ Trading Quantity. Only one of `amount` or `price` can be specified # noqa: E501
:param amount: The amount of this BatchAmendItem. # noqa: E501
:type: str
@@ -181,7 +181,7 @@ def amount(self, amount):
def price(self):
"""Gets the price of this BatchAmendItem. # noqa: E501
- trade price, only one of amount and price can be specified # noqa: E501
+ Trading Price. Only one of `amount` or `price` can be specified # noqa: E501
:return: The price of this BatchAmendItem. # noqa: E501
:rtype: str
@@ -192,7 +192,7 @@ def price(self):
def price(self, price):
"""Sets the price of this BatchAmendItem.
- trade price, only one of amount and price can be specified # noqa: E501
+ Trading Price. Only one of `amount` or `price` can be specified # noqa: E501
:param price: The price of this BatchAmendItem. # noqa: E501
:type: str
@@ -204,7 +204,7 @@ def price(self, price):
def amend_text(self):
"""Gets the amend_text of this BatchAmendItem. # noqa: E501
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:return: The amend_text of this BatchAmendItem. # noqa: E501
:rtype: str
@@ -215,7 +215,7 @@ def amend_text(self):
def amend_text(self, amend_text):
"""Sets the amend_text of this BatchAmendItem.
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:param amend_text: The amend_text of this BatchAmendItem. # noqa: E501
:type: str
diff --git a/gate_api/models/batch_amend_order_req.py b/gate_api/models/batch_amend_order_req.py
index e6ab0e6..c357589 100644
--- a/gate_api/models/batch_amend_order_req.py
+++ b/gate_api/models/batch_amend_order_req.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -123,7 +123,7 @@ def text(self, text):
def size(self):
"""Gets the size of this BatchAmendOrderReq. # noqa: E501
- The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. # noqa: E501
+ New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. # noqa: E501
:return: The size of this BatchAmendOrderReq. # noqa: E501
:rtype: int
@@ -134,7 +134,7 @@ def size(self):
def size(self, size):
"""Sets the size of this BatchAmendOrderReq.
- The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. # noqa: E501
+ New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. # noqa: E501
:param size: The size of this BatchAmendOrderReq. # noqa: E501
:type: int
@@ -146,7 +146,7 @@ def size(self, size):
def price(self):
"""Gets the price of this BatchAmendOrderReq. # noqa: E501
- New order price. # noqa: E501
+ New order price # noqa: E501
:return: The price of this BatchAmendOrderReq. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def price(self):
def price(self, price):
"""Sets the price of this BatchAmendOrderReq.
- New order price. # noqa: E501
+ New order price # noqa: E501
:param price: The price of this BatchAmendOrderReq. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def price(self, price):
def amend_text(self):
"""Gets the amend_text of this BatchAmendOrderReq. # noqa: E501
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:return: The amend_text of this BatchAmendOrderReq. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def amend_text(self):
def amend_text(self, amend_text):
"""Sets the amend_text of this BatchAmendOrderReq.
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:param amend_text: The amend_text of this BatchAmendOrderReq. # noqa: E501
:type: str
diff --git a/gate_api/models/batch_futures_order.py b/gate_api/models/batch_futures_order.py
index 0d8529a..0448f1a 100644
--- a/gate_api/models/batch_futures_order.py
+++ b/gate_api/models/batch_futures_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -192,7 +192,7 @@ def __init__(self, succeeded=None, label=None, detail=None, id=None, user=None,
def succeeded(self):
"""Gets the succeeded of this BatchFuturesOrder. # noqa: E501
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:return: The succeeded of this BatchFuturesOrder. # noqa: E501
:rtype: bool
@@ -203,7 +203,7 @@ def succeeded(self):
def succeeded(self, succeeded):
"""Sets the succeeded of this BatchFuturesOrder.
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:param succeeded: The succeeded of this BatchFuturesOrder. # noqa: E501
:type: bool
@@ -353,7 +353,7 @@ def finish_time(self, finish_time):
def finish_as(self):
"""Gets the finish_as of this BatchFuturesOrder. # noqa: E501
- How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
+ How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
:return: The finish_as of this BatchFuturesOrder. # noqa: E501
:rtype: str
@@ -364,7 +364,7 @@ def finish_as(self):
def finish_as(self, finish_as):
"""Sets the finish_as of this BatchFuturesOrder.
- How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
+ How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
:param finish_as: The finish_as of this BatchFuturesOrder. # noqa: E501
:type: str
@@ -382,7 +382,7 @@ def finish_as(self, finish_as):
def status(self):
"""Gets the status of this BatchFuturesOrder. # noqa: E501
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:return: The status of this BatchFuturesOrder. # noqa: E501
:rtype: str
@@ -393,7 +393,7 @@ def status(self):
def status(self, status):
"""Sets the status of this BatchFuturesOrder.
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:param status: The status of this BatchFuturesOrder. # noqa: E501
:type: str
@@ -434,7 +434,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this BatchFuturesOrder. # noqa: E501
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:return: The size of this BatchFuturesOrder. # noqa: E501
:rtype: int
@@ -445,7 +445,7 @@ def size(self):
def size(self, size):
"""Sets the size of this BatchFuturesOrder.
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:param size: The size of this BatchFuturesOrder. # noqa: E501
:type: int
@@ -457,7 +457,7 @@ def size(self, size):
def iceberg(self):
"""Gets the iceberg of this BatchFuturesOrder. # noqa: E501
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:return: The iceberg of this BatchFuturesOrder. # noqa: E501
:rtype: int
@@ -468,7 +468,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this BatchFuturesOrder.
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:param iceberg: The iceberg of this BatchFuturesOrder. # noqa: E501
:type: int
@@ -480,7 +480,7 @@ def iceberg(self, iceberg):
def price(self):
"""Gets the price of this BatchFuturesOrder. # noqa: E501
- Order price. 0 for market order with `tif` set as `ioc` # noqa: E501
+ Order price. Price of 0 with `tif` set to `ioc` represents a market order. # noqa: E501
:return: The price of this BatchFuturesOrder. # noqa: E501
:rtype: str
@@ -491,7 +491,7 @@ def price(self):
def price(self, price):
"""Sets the price of this BatchFuturesOrder.
- Order price. 0 for market order with `tif` set as `ioc` # noqa: E501
+ Order price. Price of 0 with `tif` set to `ioc` represents a market order. # noqa: E501
:param price: The price of this BatchFuturesOrder. # noqa: E501
:type: str
@@ -647,7 +647,7 @@ def tif(self, tif):
def left(self):
"""Gets the left of this BatchFuturesOrder. # noqa: E501
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:return: The left of this BatchFuturesOrder. # noqa: E501
:rtype: int
@@ -658,7 +658,7 @@ def left(self):
def left(self, left):
"""Sets the left of this BatchFuturesOrder.
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:param left: The left of this BatchFuturesOrder. # noqa: E501
:type: int
@@ -670,7 +670,7 @@ def left(self, left):
def fill_price(self):
"""Gets the fill_price of this BatchFuturesOrder. # noqa: E501
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:return: The fill_price of this BatchFuturesOrder. # noqa: E501
:rtype: str
@@ -681,7 +681,7 @@ def fill_price(self):
def fill_price(self, fill_price):
"""Sets the fill_price of this BatchFuturesOrder.
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:param fill_price: The fill_price of this BatchFuturesOrder. # noqa: E501
:type: str
@@ -762,7 +762,7 @@ def mkfr(self, mkfr):
def refu(self):
"""Gets the refu of this BatchFuturesOrder. # noqa: E501
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:return: The refu of this BatchFuturesOrder. # noqa: E501
:rtype: int
@@ -773,7 +773,7 @@ def refu(self):
def refu(self, refu):
"""Sets the refu of this BatchFuturesOrder.
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:param refu: The refu of this BatchFuturesOrder. # noqa: E501
:type: int
@@ -814,7 +814,7 @@ def auto_size(self, auto_size):
def stp_act(self):
"""Gets the stp_act of this BatchFuturesOrder. # noqa: E501
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:return: The stp_act of this BatchFuturesOrder. # noqa: E501
:rtype: str
@@ -825,7 +825,7 @@ def stp_act(self):
def stp_act(self, stp_act):
"""Sets the stp_act of this BatchFuturesOrder.
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:param stp_act: The stp_act of this BatchFuturesOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/batch_order.py b/gate_api/models/batch_order.py
index 384befe..12d30e9 100644
--- a/gate_api/models/batch_order.py
+++ b/gate_api/models/batch_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -283,7 +283,7 @@ def amend_text(self, amend_text):
def text(self):
"""Gets the text of this BatchOrder. # noqa: E501
- 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(.) # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
:return: The text of this BatchOrder. # noqa: E501
:rtype: str
@@ -294,7 +294,7 @@ def text(self):
def text(self, text):
"""Sets the text of this BatchOrder.
- 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(.) # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
:param text: The text of this BatchOrder. # noqa: E501
:type: str
@@ -306,7 +306,7 @@ def text(self, text):
def succeeded(self):
"""Gets the succeeded of this BatchOrder. # noqa: E501
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:return: The succeeded of this BatchOrder. # noqa: E501
:rtype: bool
@@ -317,7 +317,7 @@ def succeeded(self):
def succeeded(self, succeeded):
"""Sets the succeeded of this BatchOrder.
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:param succeeded: The succeeded of this BatchOrder. # noqa: E501
:type: bool
@@ -542,7 +542,7 @@ def currency_pair(self, currency_pair):
def type(self):
"""Gets the type of this BatchOrder. # noqa: E501
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:return: The type of this BatchOrder. # noqa: E501
:rtype: str
@@ -553,7 +553,7 @@ def type(self):
def type(self, type):
"""Sets the type of this BatchOrder.
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:param type: The type of this BatchOrder. # noqa: E501
:type: str
@@ -571,7 +571,7 @@ def type(self, type):
def account(self):
"""Gets the account of this BatchOrder. # noqa: E501
- Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account, unified - unified account # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:return: The account of this BatchOrder. # noqa: E501
:rtype: str
@@ -582,7 +582,7 @@ def account(self):
def account(self, account):
"""Sets the account of this BatchOrder.
- Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account, unified - unified account # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:param account: The account of this BatchOrder. # noqa: E501
:type: str
@@ -600,7 +600,7 @@ def account(self, account):
def side(self):
"""Gets the side of this BatchOrder. # noqa: E501
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:return: The side of this BatchOrder. # noqa: E501
:rtype: str
@@ -611,7 +611,7 @@ def side(self):
def side(self, side):
"""Sets the side of this BatchOrder.
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:param side: The side of this BatchOrder. # noqa: E501
:type: str
@@ -704,7 +704,7 @@ def time_in_force(self, time_in_force):
def iceberg(self):
"""Gets the iceberg of this BatchOrder. # noqa: E501
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:return: The iceberg of this BatchOrder. # noqa: E501
:rtype: str
@@ -715,7 +715,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this BatchOrder.
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:param iceberg: The iceberg of this BatchOrder. # noqa: E501
:type: str
@@ -727,7 +727,7 @@ def iceberg(self, iceberg):
def auto_borrow(self):
"""Gets the auto_borrow of this BatchOrder. # noqa: E501
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:return: The auto_borrow of this BatchOrder. # noqa: E501
:rtype: bool
@@ -738,7 +738,7 @@ def auto_borrow(self):
def auto_borrow(self, auto_borrow):
"""Sets the auto_borrow of this BatchOrder.
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:param auto_borrow: The auto_borrow of this BatchOrder. # noqa: E501
:type: bool
@@ -750,7 +750,7 @@ def auto_borrow(self, auto_borrow):
def auto_repay(self):
"""Gets the auto_repay of this BatchOrder. # noqa: E501
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:return: The auto_repay of this BatchOrder. # noqa: E501
:rtype: bool
@@ -761,7 +761,7 @@ def auto_repay(self):
def auto_repay(self, auto_repay):
"""Sets the auto_repay of this BatchOrder.
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:param auto_repay: The auto_repay of this BatchOrder. # noqa: E501
:type: bool
@@ -796,7 +796,7 @@ def left(self, left):
def filled_amount(self):
"""Gets the filled_amount of this BatchOrder. # noqa: E501
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:return: The filled_amount of this BatchOrder. # noqa: E501
:rtype: str
@@ -807,7 +807,7 @@ def filled_amount(self):
def filled_amount(self, filled_amount):
"""Sets the filled_amount of this BatchOrder.
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:param filled_amount: The filled_amount of this BatchOrder. # noqa: E501
:type: str
@@ -980,7 +980,7 @@ def gt_fee(self, gt_fee):
def gt_discount(self):
"""Gets the gt_discount of this BatchOrder. # noqa: E501
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:return: The gt_discount of this BatchOrder. # noqa: E501
:rtype: bool
@@ -991,7 +991,7 @@ def gt_discount(self):
def gt_discount(self, gt_discount):
"""Sets the gt_discount of this BatchOrder.
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:param gt_discount: The gt_discount of this BatchOrder. # noqa: E501
:type: bool
@@ -1072,7 +1072,7 @@ def stp_id(self, stp_id):
def stp_act(self):
"""Gets the stp_act of this BatchOrder. # noqa: E501
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
:return: The stp_act of this BatchOrder. # noqa: E501
:rtype: str
@@ -1083,7 +1083,7 @@ def stp_act(self):
def stp_act(self, stp_act):
"""Sets the stp_act of this BatchOrder.
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
:param stp_act: The stp_act of this BatchOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/borrow_currency_info.py b/gate_api/models/borrow_currency_info.py
index 58762be..4c6b514 100644
--- a/gate_api/models/borrow_currency_info.py
+++ b/gate_api/models/borrow_currency_info.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -123,7 +123,7 @@ def index_price(self, index_price):
def left_repay_principal(self):
"""Gets the left_repay_principal of this BorrowCurrencyInfo. # noqa: E501
- outstanding principal # noqa: E501
+ Outstanding principal # noqa: E501
:return: The left_repay_principal of this BorrowCurrencyInfo. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def left_repay_principal(self):
def left_repay_principal(self, left_repay_principal):
"""Sets the left_repay_principal of this BorrowCurrencyInfo.
- outstanding principal # noqa: E501
+ Outstanding principal # noqa: E501
:param left_repay_principal: The left_repay_principal of this BorrowCurrencyInfo. # noqa: E501
:type: str
@@ -146,7 +146,7 @@ def left_repay_principal(self, left_repay_principal):
def left_repay_interest(self):
"""Gets the left_repay_interest of this BorrowCurrencyInfo. # noqa: E501
- outstanding interest # noqa: E501
+ Outstanding interest # noqa: E501
:return: The left_repay_interest of this BorrowCurrencyInfo. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def left_repay_interest(self):
def left_repay_interest(self, left_repay_interest):
"""Sets the left_repay_interest of this BorrowCurrencyInfo.
- outstanding interest # noqa: E501
+ Outstanding interest # noqa: E501
:param left_repay_interest: The left_repay_interest of this BorrowCurrencyInfo. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def left_repay_interest(self, left_repay_interest):
def left_repay_usdt(self):
"""Gets the left_repay_usdt of this BorrowCurrencyInfo. # noqa: E501
- Value of left total repayments amount in USDT # noqa: E501
+ Remaining total outstanding value converted to USDT # noqa: E501
:return: The left_repay_usdt of this BorrowCurrencyInfo. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def left_repay_usdt(self):
def left_repay_usdt(self, left_repay_usdt):
"""Sets the left_repay_usdt of this BorrowCurrencyInfo.
- Value of left total repayments amount in USDT # noqa: E501
+ Remaining total outstanding value converted to USDT # noqa: E501
:param left_repay_usdt: The left_repay_usdt of this BorrowCurrencyInfo. # noqa: E501
:type: str
diff --git a/gate_api/models/broker_commission.py b/gate_api/models/broker_commission.py
index e6f2d36..cc6e70a 100644
--- a/gate_api/models/broker_commission.py
+++ b/gate_api/models/broker_commission.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def total(self, total):
def list(self):
"""Gets the list of this BrokerCommission. # noqa: E501
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:return: The list of this BrokerCommission. # noqa: E501
:rtype: list[BrokerCommission1]
@@ -96,7 +96,7 @@ def list(self):
def list(self, list):
"""Sets the list of this BrokerCommission.
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:param list: The list of this BrokerCommission. # noqa: E501
:type: list[BrokerCommission1]
diff --git a/gate_api/models/broker_commission1.py b/gate_api/models/broker_commission1.py
index 3c60c83..71474fc 100644
--- a/gate_api/models/broker_commission1.py
+++ b/gate_api/models/broker_commission1.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -41,7 +41,9 @@ class BrokerCommission1(object):
'fee_asset': 'str',
'rebate_fee': 'str',
'source': 'str',
- 'currency_pair': 'str'
+ 'currency_pair': 'str',
+ 'sub_broker_info': 'BrokerCommissionSubBrokerInfo',
+ 'alpha_contract_addr': 'str'
}
attribute_map = {
@@ -53,11 +55,13 @@ class BrokerCommission1(object):
'fee_asset': 'fee_asset',
'rebate_fee': 'rebate_fee',
'source': 'source',
- 'currency_pair': 'currency_pair'
+ 'currency_pair': 'currency_pair',
+ 'sub_broker_info': 'sub_broker_info',
+ 'alpha_contract_addr': 'alpha_contract_addr'
}
- def __init__(self, commission_time=None, user_id=None, group_name=None, amount=None, fee=None, fee_asset=None, rebate_fee=None, source=None, currency_pair=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, commission_time=None, user_id=None, group_name=None, amount=None, fee=None, fee_asset=None, rebate_fee=None, source=None, currency_pair=None, sub_broker_info=None, alpha_contract_addr=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, str, str, str, str, str, str, str, BrokerCommissionSubBrokerInfo, str, Configuration) -> None
"""BrokerCommission1 - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -72,6 +76,8 @@ def __init__(self, commission_time=None, user_id=None, group_name=None, amount=N
self._rebate_fee = None
self._source = None
self._currency_pair = None
+ self._sub_broker_info = None
+ self._alpha_contract_addr = None
self.discriminator = None
if commission_time is not None:
@@ -92,12 +98,16 @@ def __init__(self, commission_time=None, user_id=None, group_name=None, amount=N
self.source = source
if currency_pair is not None:
self.currency_pair = currency_pair
+ if sub_broker_info is not None:
+ self.sub_broker_info = sub_broker_info
+ if alpha_contract_addr is not None:
+ self.alpha_contract_addr = alpha_contract_addr
@property
def commission_time(self):
"""Gets the commission_time of this BrokerCommission1. # noqa: E501
- Commission Time. (unix timestamp) # noqa: E501
+ Commission time (Unix timestamp in seconds) # noqa: E501
:return: The commission_time of this BrokerCommission1. # noqa: E501
:rtype: int
@@ -108,7 +118,7 @@ def commission_time(self):
def commission_time(self, commission_time):
"""Sets the commission_time of this BrokerCommission1.
- Commission Time. (unix timestamp) # noqa: E501
+ Commission time (Unix timestamp in seconds) # noqa: E501
:param commission_time: The commission_time of this BrokerCommission1. # noqa: E501
:type: int
@@ -258,7 +268,7 @@ def rebate_fee(self, rebate_fee):
def source(self):
"""Gets the source of this BrokerCommission1. # noqa: E501
- Rebate Type: Spot、Futures、Options # noqa: E501
+ Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501
:return: The source of this BrokerCommission1. # noqa: E501
:rtype: str
@@ -269,7 +279,7 @@ def source(self):
def source(self, source):
"""Sets the source of this BrokerCommission1.
- Rebate Type: Spot、Futures、Options # noqa: E501
+ Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501
:param source: The source of this BrokerCommission1. # noqa: E501
:type: str
@@ -300,6 +310,50 @@ def currency_pair(self, currency_pair):
self._currency_pair = currency_pair
+ @property
+ def sub_broker_info(self):
+ """Gets the sub_broker_info of this BrokerCommission1. # noqa: E501
+
+
+ :return: The sub_broker_info of this BrokerCommission1. # noqa: E501
+ :rtype: BrokerCommissionSubBrokerInfo
+ """
+ return self._sub_broker_info
+
+ @sub_broker_info.setter
+ def sub_broker_info(self, sub_broker_info):
+ """Sets the sub_broker_info of this BrokerCommission1.
+
+
+ :param sub_broker_info: The sub_broker_info of this BrokerCommission1. # noqa: E501
+ :type: BrokerCommissionSubBrokerInfo
+ """
+
+ self._sub_broker_info = sub_broker_info
+
+ @property
+ def alpha_contract_addr(self):
+ """Gets the alpha_contract_addr of this BrokerCommission1. # noqa: E501
+
+ Alpha contract address # noqa: E501
+
+ :return: The alpha_contract_addr of this BrokerCommission1. # noqa: E501
+ :rtype: str
+ """
+ return self._alpha_contract_addr
+
+ @alpha_contract_addr.setter
+ def alpha_contract_addr(self, alpha_contract_addr):
+ """Sets the alpha_contract_addr of this BrokerCommission1.
+
+ Alpha contract address # noqa: E501
+
+ :param alpha_contract_addr: The alpha_contract_addr of this BrokerCommission1. # noqa: E501
+ :type: str
+ """
+
+ self._alpha_contract_addr = alpha_contract_addr
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/broker_commission_sub_broker_info.py b/gate_api/models/broker_commission_sub_broker_info.py
new file mode 100644
index 0000000..220166c
--- /dev/null
+++ b/gate_api/models/broker_commission_sub_broker_info.py
@@ -0,0 +1,207 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class BrokerCommissionSubBrokerInfo(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'user_id': 'int',
+ 'original_commission_rate': 'str',
+ 'relative_commission_rate': 'str',
+ 'commission_rate': 'str'
+ }
+
+ attribute_map = {
+ 'user_id': 'user_id',
+ 'original_commission_rate': 'original_commission_rate',
+ 'relative_commission_rate': 'relative_commission_rate',
+ 'commission_rate': 'commission_rate'
+ }
+
+ def __init__(self, user_id=None, original_commission_rate=None, relative_commission_rate=None, commission_rate=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, str, str, Configuration) -> None
+ """BrokerCommissionSubBrokerInfo - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._user_id = None
+ self._original_commission_rate = None
+ self._relative_commission_rate = None
+ self._commission_rate = None
+ self.discriminator = None
+
+ if user_id is not None:
+ self.user_id = user_id
+ if original_commission_rate is not None:
+ self.original_commission_rate = original_commission_rate
+ if relative_commission_rate is not None:
+ self.relative_commission_rate = relative_commission_rate
+ if commission_rate is not None:
+ self.commission_rate = commission_rate
+
+ @property
+ def user_id(self):
+ """Gets the user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501
+
+ Sub-broker user ID # noqa: E501
+
+ :return: The user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :rtype: int
+ """
+ return self._user_id
+
+ @user_id.setter
+ def user_id(self, user_id):
+ """Sets the user_id of this BrokerCommissionSubBrokerInfo.
+
+ Sub-broker user ID # noqa: E501
+
+ :param user_id: The user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :type: int
+ """
+
+ self._user_id = user_id
+
+ @property
+ def original_commission_rate(self):
+ """Gets the original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+
+ Sub-broker original commission rate # noqa: E501
+
+ :return: The original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._original_commission_rate
+
+ @original_commission_rate.setter
+ def original_commission_rate(self, original_commission_rate):
+ """Sets the original_commission_rate of this BrokerCommissionSubBrokerInfo.
+
+ Sub-broker original commission rate # noqa: E501
+
+ :param original_commission_rate: The original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :type: str
+ """
+
+ self._original_commission_rate = original_commission_rate
+
+ @property
+ def relative_commission_rate(self):
+ """Gets the relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+
+ Sub-broker relative commission rate # noqa: E501
+
+ :return: The relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._relative_commission_rate
+
+ @relative_commission_rate.setter
+ def relative_commission_rate(self, relative_commission_rate):
+ """Sets the relative_commission_rate of this BrokerCommissionSubBrokerInfo.
+
+ Sub-broker relative commission rate # noqa: E501
+
+ :param relative_commission_rate: The relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :type: str
+ """
+
+ self._relative_commission_rate = relative_commission_rate
+
+ @property
+ def commission_rate(self):
+ """Gets the commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+
+ Sub-broker actual commission rate # noqa: E501
+
+ :return: The commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._commission_rate
+
+ @commission_rate.setter
+ def commission_rate(self, commission_rate):
+ """Sets the commission_rate of this BrokerCommissionSubBrokerInfo.
+
+ Sub-broker actual commission rate # noqa: E501
+
+ :param commission_rate: The commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501
+ :type: str
+ """
+
+ self._commission_rate = commission_rate
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, BrokerCommissionSubBrokerInfo):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, BrokerCommissionSubBrokerInfo):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/broker_transaction.py b/gate_api/models/broker_transaction.py
index 96ce328..0a85977 100644
--- a/gate_api/models/broker_transaction.py
+++ b/gate_api/models/broker_transaction.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/broker_transaction1.py b/gate_api/models/broker_transaction1.py
index 3e507d1..87a12d0 100644
--- a/gate_api/models/broker_transaction1.py
+++ b/gate_api/models/broker_transaction1.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -40,7 +40,9 @@ class BrokerTransaction1(object):
'currency_pair': 'str',
'amount': 'str',
'fee_asset': 'str',
- 'source': 'str'
+ 'source': 'str',
+ 'sub_broker_info': 'BrokerCommissionSubBrokerInfo',
+ 'alpha_contract_addr': 'str'
}
attribute_map = {
@@ -51,11 +53,13 @@ class BrokerTransaction1(object):
'currency_pair': 'currency_pair',
'amount': 'amount',
'fee_asset': 'fee_asset',
- 'source': 'source'
+ 'source': 'source',
+ 'sub_broker_info': 'sub_broker_info',
+ 'alpha_contract_addr': 'alpha_contract_addr'
}
- def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=None, currency_pair=None, amount=None, fee_asset=None, source=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=None, currency_pair=None, amount=None, fee_asset=None, source=None, sub_broker_info=None, alpha_contract_addr=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, str, str, str, str, str, str, BrokerCommissionSubBrokerInfo, str, Configuration) -> None
"""BrokerTransaction1 - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -69,6 +73,8 @@ def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=Non
self._amount = None
self._fee_asset = None
self._source = None
+ self._sub_broker_info = None
+ self._alpha_contract_addr = None
self.discriminator = None
if transaction_time is not None:
@@ -87,6 +93,10 @@ def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=Non
self.fee_asset = fee_asset
if source is not None:
self.source = source
+ if sub_broker_info is not None:
+ self.sub_broker_info = sub_broker_info
+ if alpha_contract_addr is not None:
+ self.alpha_contract_addr = alpha_contract_addr
@property
def transaction_time(self):
@@ -161,7 +171,7 @@ def group_name(self, group_name):
def fee(self):
"""Gets the fee of this BrokerTransaction1. # noqa: E501
- fee (usdt) # noqa: E501
+ Fee amount (USDT) # noqa: E501
:return: The fee of this BrokerTransaction1. # noqa: E501
:rtype: str
@@ -172,7 +182,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this BrokerTransaction1.
- fee (usdt) # noqa: E501
+ Fee amount (USDT) # noqa: E501
:param fee: The fee of this BrokerTransaction1. # noqa: E501
:type: str
@@ -207,7 +217,7 @@ def currency_pair(self, currency_pair):
def amount(self):
"""Gets the amount of this BrokerTransaction1. # noqa: E501
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:return: The amount of this BrokerTransaction1. # noqa: E501
:rtype: str
@@ -218,7 +228,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this BrokerTransaction1.
- Commission Amount # noqa: E501
+ Transaction amount # noqa: E501
:param amount: The amount of this BrokerTransaction1. # noqa: E501
:type: str
@@ -253,7 +263,7 @@ def fee_asset(self, fee_asset):
def source(self):
"""Gets the source of this BrokerTransaction1. # noqa: E501
- Rebate Type: Spot、Futures、Options # noqa: E501
+ Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501
:return: The source of this BrokerTransaction1. # noqa: E501
:rtype: str
@@ -264,7 +274,7 @@ def source(self):
def source(self, source):
"""Sets the source of this BrokerTransaction1.
- Rebate Type: Spot、Futures、Options # noqa: E501
+ Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501
:param source: The source of this BrokerTransaction1. # noqa: E501
:type: str
@@ -272,6 +282,50 @@ def source(self, source):
self._source = source
+ @property
+ def sub_broker_info(self):
+ """Gets the sub_broker_info of this BrokerTransaction1. # noqa: E501
+
+
+ :return: The sub_broker_info of this BrokerTransaction1. # noqa: E501
+ :rtype: BrokerCommissionSubBrokerInfo
+ """
+ return self._sub_broker_info
+
+ @sub_broker_info.setter
+ def sub_broker_info(self, sub_broker_info):
+ """Sets the sub_broker_info of this BrokerTransaction1.
+
+
+ :param sub_broker_info: The sub_broker_info of this BrokerTransaction1. # noqa: E501
+ :type: BrokerCommissionSubBrokerInfo
+ """
+
+ self._sub_broker_info = sub_broker_info
+
+ @property
+ def alpha_contract_addr(self):
+ """Gets the alpha_contract_addr of this BrokerTransaction1. # noqa: E501
+
+ Alpha contract address # noqa: E501
+
+ :return: The alpha_contract_addr of this BrokerTransaction1. # noqa: E501
+ :rtype: str
+ """
+ return self._alpha_contract_addr
+
+ @alpha_contract_addr.setter
+ def alpha_contract_addr(self, alpha_contract_addr):
+ """Sets the alpha_contract_addr of this BrokerTransaction1.
+
+ Alpha contract address # noqa: E501
+
+ :param alpha_contract_addr: The alpha_contract_addr of this BrokerTransaction1. # noqa: E501
+ :type: str
+ """
+
+ self._alpha_contract_addr = alpha_contract_addr
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/cancel_batch_order.py b/gate_api/models/cancel_batch_order.py
index bdfa77d..bfc7bd9 100644
--- a/gate_api/models/cancel_batch_order.py
+++ b/gate_api/models/cancel_batch_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -35,17 +35,19 @@ class CancelBatchOrder(object):
openapi_types = {
'currency_pair': 'str',
'id': 'str',
+ 'account': 'str',
'action_mode': 'str'
}
attribute_map = {
'currency_pair': 'currency_pair',
'id': 'id',
+ 'account': 'account',
'action_mode': 'action_mode'
}
- def __init__(self, currency_pair=None, id=None, action_mode=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, Configuration) -> None
+ def __init__(self, currency_pair=None, id=None, account=None, action_mode=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, Configuration) -> None
"""CancelBatchOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -53,11 +55,14 @@ def __init__(self, currency_pair=None, id=None, action_mode=None, local_vars_con
self._currency_pair = None
self._id = None
+ self._account = None
self._action_mode = None
self.discriminator = None
self.currency_pair = currency_pair
self.id = id
+ if account is not None:
+ self.account = account
if action_mode is not None:
self.action_mode = action_mode
@@ -111,6 +116,29 @@ def id(self, id):
self._id = id
+ @property
+ def account(self):
+ """Gets the account of this CancelBatchOrder. # noqa: E501
+
+ If the canceled order is a unified account apikey, this field must be specified and set to `unified` # noqa: E501
+
+ :return: The account of this CancelBatchOrder. # noqa: E501
+ :rtype: str
+ """
+ return self._account
+
+ @account.setter
+ def account(self, account):
+ """Sets the account of this CancelBatchOrder.
+
+ If the canceled order is a unified account apikey, this field must be specified and set to `unified` # noqa: E501
+
+ :param account: The account of this CancelBatchOrder. # noqa: E501
+ :type: str
+ """
+
+ self._account = account
+
@property
def action_mode(self):
"""Gets the action_mode of this CancelBatchOrder. # noqa: E501
diff --git a/gate_api/models/cancel_order_result.py b/gate_api/models/cancel_order_result.py
index b3f38be..487486a 100644
--- a/gate_api/models/cancel_order_result.py
+++ b/gate_api/models/cancel_order_result.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -202,7 +202,7 @@ def label(self, label):
def message(self):
"""Gets the message of this CancelOrderResult. # noqa: E501
- Error message when failed to cancel the order; empty if succeeded # noqa: E501
+ Error description when cancellation fails, empty if successful # noqa: E501
:return: The message of this CancelOrderResult. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def message(self):
def message(self, message):
"""Sets the message of this CancelOrderResult.
- Error message when failed to cancel the order; empty if succeeded # noqa: E501
+ Error description when cancellation fails, empty if successful # noqa: E501
:param message: The message of this CancelOrderResult. # noqa: E501
:type: str
@@ -225,7 +225,7 @@ def message(self, message):
def account(self):
"""Gets the account of this CancelOrderResult. # noqa: E501
- Empty by default. If cancelled order is cross margin order, this field is set to `cross_margin` # noqa: E501
+ Default is empty (deprecated) # noqa: E501
:return: The account of this CancelOrderResult. # noqa: E501
:rtype: str
@@ -236,7 +236,7 @@ def account(self):
def account(self, account):
"""Sets the account of this CancelOrderResult.
- Empty by default. If cancelled order is cross margin order, this field is set to `cross_margin` # noqa: E501
+ Default is empty (deprecated) # noqa: E501
:param account: The account of this CancelOrderResult. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_adjust.py b/gate_api/models/collateral_adjust.py
index 3ed0b11..919556a 100644
--- a/gate_api/models/collateral_adjust.py
+++ b/gate_api/models/collateral_adjust.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def order_id(self, order_id):
def type(self):
"""Gets the type of this CollateralAdjust. # noqa: E501
- Operation types: append - for adding collateral, redeem - for withdrawing collateral # noqa: E501
+ Operation type: append - add collateral, redeem - withdraw collateral # noqa: E501
:return: The type of this CollateralAdjust. # noqa: E501
:rtype: str
@@ -101,7 +101,7 @@ def type(self):
def type(self, type):
"""Sets the type of this CollateralAdjust.
- Operation types: append - for adding collateral, redeem - for withdrawing collateral # noqa: E501
+ Operation type: append - add collateral, redeem - withdraw collateral # noqa: E501
:param type: The type of this CollateralAdjust. # noqa: E501
:type: str
@@ -115,7 +115,7 @@ def type(self, type):
def collaterals(self):
"""Gets the collaterals of this CollateralAdjust. # noqa: E501
- Collateral Currency List # noqa: E501
+ Collateral currency list # noqa: E501
:return: The collaterals of this CollateralAdjust. # noqa: E501
:rtype: list[CollateralCurrency]
@@ -126,7 +126,7 @@ def collaterals(self):
def collaterals(self, collaterals):
"""Sets the collaterals of this CollateralAdjust.
- Collateral Currency List # noqa: E501
+ Collateral currency list # noqa: E501
:param collaterals: The collaterals of this CollateralAdjust. # noqa: E501
:type: list[CollateralCurrency]
diff --git a/gate_api/models/collateral_adjust_res.py b/gate_api/models/collateral_adjust_res.py
index 4f0e933..7cc0044 100644
--- a/gate_api/models/collateral_adjust_res.py
+++ b/gate_api/models/collateral_adjust_res.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def order_id(self, order_id):
def collateral_currencies(self):
"""Gets the collateral_currencies of this CollateralAdjustRes. # noqa: E501
- Collateral Currency Information # noqa: E501
+ Collateral currency information # noqa: E501
:return: The collateral_currencies of this CollateralAdjustRes. # noqa: E501
:rtype: list[CollateralCurrencyRes]
@@ -96,7 +96,7 @@ def collateral_currencies(self):
def collateral_currencies(self, collateral_currencies):
"""Sets the collateral_currencies of this CollateralAdjustRes.
- Collateral Currency Information # noqa: E501
+ Collateral currency information # noqa: E501
:param collateral_currencies: The collateral_currencies of this CollateralAdjustRes. # noqa: E501
:type: list[CollateralCurrencyRes]
diff --git a/gate_api/models/collateral_align.py b/gate_api/models/collateral_align.py
index 3b77762..3bc3192 100644
--- a/gate_api/models/collateral_align.py
+++ b/gate_api/models/collateral_align.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -93,7 +93,7 @@ def order_id(self, order_id):
def collateral_currency(self):
"""Gets the collateral_currency of this CollateralAlign. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this CollateralAlign. # noqa: E501
:rtype: str
@@ -104,7 +104,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this CollateralAlign.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this CollateralAlign. # noqa: E501
:type: str
@@ -143,7 +143,7 @@ def collateral_amount(self, collateral_amount):
def type(self):
"""Gets the type of this CollateralAlign. # noqa: E501
- Operation types: append - for adding collateral, redeem - for withdrawing collateral # noqa: E501
+ Operation type: append - add collateral, redeem - withdraw collateral # noqa: E501
:return: The type of this CollateralAlign. # noqa: E501
:rtype: str
@@ -154,7 +154,7 @@ def type(self):
def type(self, type):
"""Sets the type of this CollateralAlign.
- Operation types: append - for adding collateral, redeem - for withdrawing collateral # noqa: E501
+ Operation type: append - add collateral, redeem - withdraw collateral # noqa: E501
:param type: The type of this CollateralAlign. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_currency.py b/gate_api/models/collateral_currency.py
index 47f69b4..08c6811 100644
--- a/gate_api/models/collateral_currency.py
+++ b/gate_api/models/collateral_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/collateral_currency_info.py b/gate_api/models/collateral_currency_info.py
index 2671b11..f555f62 100644
--- a/gate_api/models/collateral_currency_info.py
+++ b/gate_api/models/collateral_currency_info.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -118,7 +118,7 @@ def index_price(self, index_price):
def left_collateral(self):
"""Gets the left_collateral of this CollateralCurrencyInfo. # noqa: E501
- Left Collateral Amount # noqa: E501
+ Remaining collateral amount # noqa: E501
:return: The left_collateral of this CollateralCurrencyInfo. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def left_collateral(self):
def left_collateral(self, left_collateral):
"""Sets the left_collateral of this CollateralCurrencyInfo.
- Left Collateral Amount # noqa: E501
+ Remaining collateral amount # noqa: E501
:param left_collateral: The left_collateral of this CollateralCurrencyInfo. # noqa: E501
:type: str
@@ -141,7 +141,7 @@ def left_collateral(self, left_collateral):
def left_collateral_usdt(self):
"""Gets the left_collateral_usdt of this CollateralCurrencyInfo. # noqa: E501
- Value of left collateral amount in USDT # noqa: E501
+ Remaining collateral value converted to USDT # noqa: E501
:return: The left_collateral_usdt of this CollateralCurrencyInfo. # noqa: E501
:rtype: str
@@ -152,7 +152,7 @@ def left_collateral_usdt(self):
def left_collateral_usdt(self, left_collateral_usdt):
"""Sets the left_collateral_usdt of this CollateralCurrencyInfo.
- Value of left collateral amount in USDT # noqa: E501
+ Remaining collateral value converted to USDT # noqa: E501
:param left_collateral_usdt: The left_collateral_usdt of this CollateralCurrencyInfo. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_currency_res.py b/gate_api/models/collateral_currency_res.py
index 585b8a6..610a406 100644
--- a/gate_api/models/collateral_currency_res.py
+++ b/gate_api/models/collateral_currency_res.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -100,7 +100,7 @@ def succeeded(self, succeeded):
def label(self):
"""Gets the label of this CollateralCurrencyRes. # noqa: E501
- Error identifier for unsuccessful operations; empty for successful. # noqa: E501
+ Error identifier for failed operations; empty when successful # noqa: E501
:return: The label of this CollateralCurrencyRes. # noqa: E501
:rtype: str
@@ -111,7 +111,7 @@ def label(self):
def label(self, label):
"""Sets the label of this CollateralCurrencyRes.
- Error identifier for unsuccessful operations; empty for successful. # noqa: E501
+ Error identifier for failed operations; empty when successful # noqa: E501
:param label: The label of this CollateralCurrencyRes. # noqa: E501
:type: str
@@ -123,7 +123,7 @@ def label(self, label):
def message(self):
"""Gets the message of this CollateralCurrencyRes. # noqa: E501
- Error description in case of operation failure; empty when successful. # noqa: E501
+ Error description for failed operations; empty when successful # noqa: E501
:return: The message of this CollateralCurrencyRes. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def message(self):
def message(self, message):
"""Sets the message of this CollateralCurrencyRes.
- Error description in case of operation failure; empty when successful. # noqa: E501
+ Error description for failed operations; empty when successful # noqa: E501
:param message: The message of this CollateralCurrencyRes. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this CollateralCurrencyRes. # noqa: E501
- Quantity of successful collateral operation; 0 if the operation fails. # noqa: E501
+ Successfully operated collateral quantity; 0 if operation fails # noqa: E501
:return: The amount of this CollateralCurrencyRes. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this CollateralCurrencyRes.
- Quantity of successful collateral operation; 0 if the operation fails. # noqa: E501
+ Successfully operated collateral quantity; 0 if operation fails # noqa: E501
:param amount: The amount of this CollateralCurrencyRes. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_current_rate.py b/gate_api/models/collateral_current_rate.py
index 0031fc0..5d00be0 100644
--- a/gate_api/models/collateral_current_rate.py
+++ b/gate_api/models/collateral_current_rate.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/collateral_fix_rate.py b/gate_api/models/collateral_fix_rate.py
index f11afc2..0bdfb45 100644
--- a/gate_api/models/collateral_fix_rate.py
+++ b/gate_api/models/collateral_fix_rate.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -95,7 +95,7 @@ def currency(self, currency):
def rate_7d(self):
"""Gets the rate_7d of this CollateralFixRate. # noqa: E501
- Fixed interest rate for a lending period of 7 days # noqa: E501
+ Fixed interest rate for 7-day lending period # noqa: E501
:return: The rate_7d of this CollateralFixRate. # noqa: E501
:rtype: str
@@ -106,7 +106,7 @@ def rate_7d(self):
def rate_7d(self, rate_7d):
"""Sets the rate_7d of this CollateralFixRate.
- Fixed interest rate for a lending period of 7 days # noqa: E501
+ Fixed interest rate for 7-day lending period # noqa: E501
:param rate_7d: The rate_7d of this CollateralFixRate. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def rate_7d(self, rate_7d):
def rate_30d(self):
"""Gets the rate_30d of this CollateralFixRate. # noqa: E501
- Fixed interest rate for a lending period of 30 days # noqa: E501
+ Fixed interest rate for 30-day lending period # noqa: E501
:return: The rate_30d of this CollateralFixRate. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def rate_30d(self):
def rate_30d(self, rate_30d):
"""Sets the rate_30d of this CollateralFixRate.
- Fixed interest rate for a lending period of 30 days # noqa: E501
+ Fixed interest rate for 30-day lending period # noqa: E501
:param rate_30d: The rate_30d of this CollateralFixRate. # noqa: E501
:type: str
@@ -141,7 +141,7 @@ def rate_30d(self, rate_30d):
def update_time(self):
"""Gets the update_time of this CollateralFixRate. # noqa: E501
- Update time, timestamp, unit in seconds # noqa: E501
+ Update time, timestamp in seconds # noqa: E501
:return: The update_time of this CollateralFixRate. # noqa: E501
:rtype: int
@@ -152,7 +152,7 @@ def update_time(self):
def update_time(self, update_time):
"""Sets the update_time of this CollateralFixRate.
- Update time, timestamp, unit in seconds # noqa: E501
+ Update time, timestamp in seconds # noqa: E501
:param update_time: The update_time of this CollateralFixRate. # noqa: E501
:type: int
diff --git a/gate_api/models/collateral_loan_currency.py b/gate_api/models/collateral_loan_currency.py
index 90120f4..67b6713 100644
--- a/gate_api/models/collateral_loan_currency.py
+++ b/gate_api/models/collateral_loan_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/collateral_ltv.py b/gate_api/models/collateral_ltv.py
index daee385..34c8653 100644
--- a/gate_api/models/collateral_ltv.py
+++ b/gate_api/models/collateral_ltv.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -67,7 +67,7 @@ def __init__(self, init_ltv=None, alert_ltv=None, liquidate_ltv=None, local_vars
def init_ltv(self):
"""Gets the init_ltv of this CollateralLtv. # noqa: E501
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:return: The init_ltv of this CollateralLtv. # noqa: E501
:rtype: str
@@ -78,7 +78,7 @@ def init_ltv(self):
def init_ltv(self, init_ltv):
"""Sets the init_ltv of this CollateralLtv.
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:param init_ltv: The init_ltv of this CollateralLtv. # noqa: E501
:type: str
@@ -90,7 +90,7 @@ def init_ltv(self, init_ltv):
def alert_ltv(self):
"""Gets the alert_ltv of this CollateralLtv. # noqa: E501
- Warning collateralization ratio # noqa: E501
+ Warning collateralization rate # noqa: E501
:return: The alert_ltv of this CollateralLtv. # noqa: E501
:rtype: str
@@ -101,7 +101,7 @@ def alert_ltv(self):
def alert_ltv(self, alert_ltv):
"""Sets the alert_ltv of this CollateralLtv.
- Warning collateralization ratio # noqa: E501
+ Warning collateralization rate # noqa: E501
:param alert_ltv: The alert_ltv of this CollateralLtv. # noqa: E501
:type: str
@@ -113,7 +113,7 @@ def alert_ltv(self, alert_ltv):
def liquidate_ltv(self):
"""Gets the liquidate_ltv of this CollateralLtv. # noqa: E501
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:return: The liquidate_ltv of this CollateralLtv. # noqa: E501
:rtype: str
@@ -124,7 +124,7 @@ def liquidate_ltv(self):
def liquidate_ltv(self, liquidate_ltv):
"""Sets the liquidate_ltv of this CollateralLtv.
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:param liquidate_ltv: The liquidate_ltv of this CollateralLtv. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_order.py b/gate_api/models/collateral_order.py
index da2b478..f6cac73 100644
--- a/gate_api/models/collateral_order.py
+++ b/gate_api/models/collateral_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -155,7 +155,7 @@ def order_id(self, order_id):
def collateral_currency(self):
"""Gets the collateral_currency of this CollateralOrder. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this CollateralOrder. # noqa: E501
:rtype: str
@@ -166,7 +166,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this CollateralOrder.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this CollateralOrder. # noqa: E501
:type: str
@@ -224,7 +224,7 @@ def borrow_currency(self, borrow_currency):
def borrow_amount(self):
"""Gets the borrow_amount of this CollateralOrder. # noqa: E501
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:return: The borrow_amount of this CollateralOrder. # noqa: E501
:rtype: str
@@ -235,7 +235,7 @@ def borrow_amount(self):
def borrow_amount(self, borrow_amount):
"""Sets the borrow_amount of this CollateralOrder.
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:param borrow_amount: The borrow_amount of this CollateralOrder. # noqa: E501
:type: str
@@ -316,7 +316,7 @@ def repaid_interest(self, repaid_interest):
def init_ltv(self):
"""Gets the init_ltv of this CollateralOrder. # noqa: E501
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:return: The init_ltv of this CollateralOrder. # noqa: E501
:rtype: str
@@ -327,7 +327,7 @@ def init_ltv(self):
def init_ltv(self, init_ltv):
"""Sets the init_ltv of this CollateralOrder.
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:param init_ltv: The init_ltv of this CollateralOrder. # noqa: E501
:type: str
@@ -339,7 +339,7 @@ def init_ltv(self, init_ltv):
def current_ltv(self):
"""Gets the current_ltv of this CollateralOrder. # noqa: E501
- The current collateralization rate # noqa: E501
+ Current collateralization rate # noqa: E501
:return: The current_ltv of this CollateralOrder. # noqa: E501
:rtype: str
@@ -350,7 +350,7 @@ def current_ltv(self):
def current_ltv(self, current_ltv):
"""Sets the current_ltv of this CollateralOrder.
- The current collateralization rate # noqa: E501
+ Current collateralization rate # noqa: E501
:param current_ltv: The current_ltv of this CollateralOrder. # noqa: E501
:type: str
@@ -362,7 +362,7 @@ def current_ltv(self, current_ltv):
def liquidate_ltv(self):
"""Gets the liquidate_ltv of this CollateralOrder. # noqa: E501
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:return: The liquidate_ltv of this CollateralOrder. # noqa: E501
:rtype: str
@@ -373,7 +373,7 @@ def liquidate_ltv(self):
def liquidate_ltv(self, liquidate_ltv):
"""Sets the liquidate_ltv of this CollateralOrder.
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:param liquidate_ltv: The liquidate_ltv of this CollateralOrder. # noqa: E501
:type: str
@@ -454,7 +454,7 @@ def left_repay_total(self, left_repay_total):
def left_repay_principal(self):
"""Gets the left_repay_principal of this CollateralOrder. # noqa: E501
- outstanding principal # noqa: E501
+ Outstanding principal # noqa: E501
:return: The left_repay_principal of this CollateralOrder. # noqa: E501
:rtype: str
@@ -465,7 +465,7 @@ def left_repay_principal(self):
def left_repay_principal(self, left_repay_principal):
"""Sets the left_repay_principal of this CollateralOrder.
- outstanding principal # noqa: E501
+ Outstanding principal # noqa: E501
:param left_repay_principal: The left_repay_principal of this CollateralOrder. # noqa: E501
:type: str
@@ -477,7 +477,7 @@ def left_repay_principal(self, left_repay_principal):
def left_repay_interest(self):
"""Gets the left_repay_interest of this CollateralOrder. # noqa: E501
- outstanding interest # noqa: E501
+ Outstanding interest # noqa: E501
:return: The left_repay_interest of this CollateralOrder. # noqa: E501
:rtype: str
@@ -488,7 +488,7 @@ def left_repay_interest(self):
def left_repay_interest(self, left_repay_interest):
"""Sets the left_repay_interest of this CollateralOrder.
- outstanding interest # noqa: E501
+ Outstanding interest # noqa: E501
:param left_repay_interest: The left_repay_interest of this CollateralOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/collateral_record.py b/gate_api/models/collateral_record.py
index 36d8f8f..b5eeb09 100644
--- a/gate_api/models/collateral_record.py
+++ b/gate_api/models/collateral_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -171,7 +171,7 @@ def borrow_currency(self, borrow_currency):
def borrow_amount(self):
"""Gets the borrow_amount of this CollateralRecord. # noqa: E501
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:return: The borrow_amount of this CollateralRecord. # noqa: E501
:rtype: str
@@ -182,7 +182,7 @@ def borrow_amount(self):
def borrow_amount(self, borrow_amount):
"""Sets the borrow_amount of this CollateralRecord.
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:param borrow_amount: The borrow_amount of this CollateralRecord. # noqa: E501
:type: str
@@ -194,7 +194,7 @@ def borrow_amount(self, borrow_amount):
def collateral_currency(self):
"""Gets the collateral_currency of this CollateralRecord. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this CollateralRecord. # noqa: E501
:rtype: str
@@ -205,7 +205,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this CollateralRecord.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this CollateralRecord. # noqa: E501
:type: str
@@ -217,7 +217,7 @@ def collateral_currency(self, collateral_currency):
def before_collateral(self):
"""Gets the before_collateral of this CollateralRecord. # noqa: E501
- The collateral amount before adjustment # noqa: E501
+ Collateral amount before adjustment # noqa: E501
:return: The before_collateral of this CollateralRecord. # noqa: E501
:rtype: str
@@ -228,7 +228,7 @@ def before_collateral(self):
def before_collateral(self, before_collateral):
"""Sets the before_collateral of this CollateralRecord.
- The collateral amount before adjustment # noqa: E501
+ Collateral amount before adjustment # noqa: E501
:param before_collateral: The before_collateral of this CollateralRecord. # noqa: E501
:type: str
@@ -240,7 +240,7 @@ def before_collateral(self, before_collateral):
def after_collateral(self):
"""Gets the after_collateral of this CollateralRecord. # noqa: E501
- The collateral amount after adjustment # noqa: E501
+ Collateral amount after adjustment # noqa: E501
:return: The after_collateral of this CollateralRecord. # noqa: E501
:rtype: str
@@ -251,7 +251,7 @@ def after_collateral(self):
def after_collateral(self, after_collateral):
"""Sets the after_collateral of this CollateralRecord.
- The collateral amount after adjustment # noqa: E501
+ Collateral amount after adjustment # noqa: E501
:param after_collateral: The after_collateral of this CollateralRecord. # noqa: E501
:type: str
@@ -263,7 +263,7 @@ def after_collateral(self, after_collateral):
def before_ltv(self):
"""Gets the before_ltv of this CollateralRecord. # noqa: E501
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:return: The before_ltv of this CollateralRecord. # noqa: E501
:rtype: str
@@ -274,7 +274,7 @@ def before_ltv(self):
def before_ltv(self, before_ltv):
"""Sets the before_ltv of this CollateralRecord.
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:param before_ltv: The before_ltv of this CollateralRecord. # noqa: E501
:type: str
@@ -286,7 +286,7 @@ def before_ltv(self, before_ltv):
def after_ltv(self):
"""Gets the after_ltv of this CollateralRecord. # noqa: E501
- The collateral ratio after adjustment # noqa: E501
+ Collateral ratio after adjustment # noqa: E501
:return: The after_ltv of this CollateralRecord. # noqa: E501
:rtype: str
@@ -297,7 +297,7 @@ def after_ltv(self):
def after_ltv(self, after_ltv):
"""Sets the after_ltv of this CollateralRecord.
- The collateral ratio after adjustment # noqa: E501
+ Collateral ratio after adjustment # noqa: E501
:param after_ltv: The after_ltv of this CollateralRecord. # noqa: E501
:type: str
@@ -309,7 +309,7 @@ def after_ltv(self, after_ltv):
def operate_time(self):
"""Gets the operate_time of this CollateralRecord. # noqa: E501
- Timestamp of the operation, in seconds # noqa: E501
+ Operation time, timestamp in seconds # noqa: E501
:return: The operate_time of this CollateralRecord. # noqa: E501
:rtype: int
@@ -320,7 +320,7 @@ def operate_time(self):
def operate_time(self, operate_time):
"""Sets the operate_time of this CollateralRecord.
- Timestamp of the operation, in seconds # noqa: E501
+ Operation time, timestamp in seconds # noqa: E501
:param operate_time: The operate_time of this CollateralRecord. # noqa: E501
:type: int
diff --git a/gate_api/models/contract.py b/gate_api/models/contract.py
index 0af2632..557f6ce 100644
--- a/gate_api/models/contract.py
+++ b/gate_api/models/contract.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -68,7 +68,11 @@ class Contract(object):
'enable_bonus': 'bool',
'enable_credit': 'bool',
'create_time': 'float',
- 'funding_cap_ratio': 'str'
+ 'funding_cap_ratio': 'str',
+ 'status': 'str',
+ 'launch_time': 'int',
+ 'delisting_time': 'int',
+ 'delisted_time': 'int'
}
attribute_map = {
@@ -107,11 +111,15 @@ class Contract(object):
'enable_bonus': 'enable_bonus',
'enable_credit': 'enable_credit',
'create_time': 'create_time',
- 'funding_cap_ratio': 'funding_cap_ratio'
+ 'funding_cap_ratio': 'funding_cap_ratio',
+ 'status': 'status',
+ 'launch_time': 'launch_time',
+ 'delisting_time': 'delisting_time',
+ 'delisted_time': 'delisted_time'
}
- def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=None, leverage_max=None, maintenance_rate=None, mark_type=None, mark_price=None, index_price=None, last_price=None, maker_fee_rate=None, taker_fee_rate=None, order_price_round=None, mark_price_round=None, funding_rate=None, funding_interval=None, funding_next_apply=None, risk_limit_base=None, risk_limit_step=None, risk_limit_max=None, order_size_min=None, order_size_max=None, order_price_deviate=None, ref_discount_rate=None, ref_rebate_rate=None, orderbook_id=None, trade_id=None, trade_size=None, position_size=None, config_change_time=None, in_delisting=None, orders_limit=None, enable_bonus=None, enable_credit=None, create_time=None, funding_cap_ratio=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, int, float, str, str, str, int, int, str, str, str, int, int, int, int, float, bool, int, bool, bool, float, str, Configuration) -> None
+ def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=None, leverage_max=None, maintenance_rate=None, mark_type=None, mark_price=None, index_price=None, last_price=None, maker_fee_rate=None, taker_fee_rate=None, order_price_round=None, mark_price_round=None, funding_rate=None, funding_interval=None, funding_next_apply=None, risk_limit_base=None, risk_limit_step=None, risk_limit_max=None, order_size_min=None, order_size_max=None, order_price_deviate=None, ref_discount_rate=None, ref_rebate_rate=None, orderbook_id=None, trade_id=None, trade_size=None, position_size=None, config_change_time=None, in_delisting=None, orders_limit=None, enable_bonus=None, enable_credit=None, create_time=None, funding_cap_ratio=None, status=None, launch_time=None, delisting_time=None, delisted_time=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, int, float, str, str, str, int, int, str, str, str, int, int, int, int, float, bool, int, bool, bool, float, str, str, int, int, int, Configuration) -> None
"""Contract - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -153,6 +161,10 @@ def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=No
self._enable_credit = None
self._create_time = None
self._funding_cap_ratio = None
+ self._status = None
+ self._launch_time = None
+ self._delisting_time = None
+ self._delisted_time = None
self.discriminator = None
if name is not None:
@@ -227,6 +239,14 @@ def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=No
self.create_time = create_time
if funding_cap_ratio is not None:
self.funding_cap_ratio = funding_cap_ratio
+ if status is not None:
+ self.status = status
+ if launch_time is not None:
+ self.launch_time = launch_time
+ if delisting_time is not None:
+ self.delisting_time = delisting_time
+ if delisted_time is not None:
+ self.delisted_time = delisted_time
@property
def name(self):
@@ -255,7 +275,7 @@ def name(self, name):
def type(self):
"""Gets the type of this Contract. # noqa: E501
- Futures contract type # noqa: E501
+ Contract type: inverse - inverse contract, direct - direct contract # noqa: E501
:return: The type of this Contract. # noqa: E501
:rtype: str
@@ -266,7 +286,7 @@ def type(self):
def type(self, type):
"""Sets the type of this Contract.
- Futures contract type # noqa: E501
+ Contract type: inverse - inverse contract, direct - direct contract # noqa: E501
:param type: The type of this Contract. # noqa: E501
:type: str
@@ -376,7 +396,7 @@ def maintenance_rate(self, maintenance_rate):
def mark_type(self):
"""Gets the mark_type of this Contract. # noqa: E501
- Mark price type, internal - based on internal trading, index - based on external index price # noqa: E501
+ Mark price type: internal - internal trading price, index - external index price # noqa: E501
:return: The mark_type of this Contract. # noqa: E501
:rtype: str
@@ -387,7 +407,7 @@ def mark_type(self):
def mark_type(self, mark_type):
"""Sets the mark_type of this Contract.
- Mark price type, internal - based on internal trading, index - based on external index price # noqa: E501
+ Mark price type: internal - internal trading price, index - external index price # noqa: E501
:param mark_type: The mark_type of this Contract. # noqa: E501
:type: str
@@ -474,7 +494,7 @@ def last_price(self, last_price):
def maker_fee_rate(self):
"""Gets the maker_fee_rate of this Contract. # noqa: E501
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:return: The maker_fee_rate of this Contract. # noqa: E501
:rtype: str
@@ -485,7 +505,7 @@ def maker_fee_rate(self):
def maker_fee_rate(self, maker_fee_rate):
"""Sets the maker_fee_rate of this Contract.
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:param maker_fee_rate: The maker_fee_rate of this Contract. # noqa: E501
:type: str
@@ -635,7 +655,7 @@ def funding_next_apply(self, funding_next_apply):
def risk_limit_base(self):
"""Gets the risk_limit_base of this Contract. # noqa: E501
- Risk limit base,deprecated # noqa: E501
+ Base risk limit (deprecated) # noqa: E501
:return: The risk_limit_base of this Contract. # noqa: E501
:rtype: str
@@ -646,7 +666,7 @@ def risk_limit_base(self):
def risk_limit_base(self, risk_limit_base):
"""Sets the risk_limit_base of this Contract.
- Risk limit base,deprecated # noqa: E501
+ Base risk limit (deprecated) # noqa: E501
:param risk_limit_base: The risk_limit_base of this Contract. # noqa: E501
:type: str
@@ -658,7 +678,7 @@ def risk_limit_base(self, risk_limit_base):
def risk_limit_step(self):
"""Gets the risk_limit_step of this Contract. # noqa: E501
- Step of adjusting risk limit,deprecated # noqa: E501
+ Risk limit adjustment step (deprecated) # noqa: E501
:return: The risk_limit_step of this Contract. # noqa: E501
:rtype: str
@@ -669,7 +689,7 @@ def risk_limit_step(self):
def risk_limit_step(self, risk_limit_step):
"""Sets the risk_limit_step of this Contract.
- Step of adjusting risk limit,deprecated # noqa: E501
+ Risk limit adjustment step (deprecated) # noqa: E501
:param risk_limit_step: The risk_limit_step of this Contract. # noqa: E501
:type: str
@@ -681,7 +701,7 @@ def risk_limit_step(self, risk_limit_step):
def risk_limit_max(self):
"""Gets the risk_limit_max of this Contract. # noqa: E501
- Maximum risk limit the contract allowed,deprecated,It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits. # noqa: E501
+ Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits # noqa: E501
:return: The risk_limit_max of this Contract. # noqa: E501
:rtype: str
@@ -692,7 +712,7 @@ def risk_limit_max(self):
def risk_limit_max(self, risk_limit_max):
"""Sets the risk_limit_max of this Contract.
- Maximum risk limit the contract allowed,deprecated,It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits. # noqa: E501
+ Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits # noqa: E501
:param risk_limit_max: The risk_limit_max of this Contract. # noqa: E501
:type: str
@@ -704,7 +724,7 @@ def risk_limit_max(self, risk_limit_max):
def order_size_min(self):
"""Gets the order_size_min of this Contract. # noqa: E501
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:return: The order_size_min of this Contract. # noqa: E501
:rtype: int
@@ -715,7 +735,7 @@ def order_size_min(self):
def order_size_min(self, order_size_min):
"""Sets the order_size_min of this Contract.
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:param order_size_min: The order_size_min of this Contract. # noqa: E501
:type: int
@@ -727,7 +747,7 @@ def order_size_min(self, order_size_min):
def order_size_max(self):
"""Gets the order_size_max of this Contract. # noqa: E501
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:return: The order_size_max of this Contract. # noqa: E501
:rtype: int
@@ -738,7 +758,7 @@ def order_size_max(self):
def order_size_max(self, order_size_max):
"""Sets the order_size_max of this Contract.
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:param order_size_max: The order_size_max of this Contract. # noqa: E501
:type: int
@@ -750,7 +770,7 @@ def order_size_max(self, order_size_max):
def order_price_deviate(self):
"""Gets the order_price_deviate of this Contract. # noqa: E501
- 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 # noqa: E501
+ Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate # noqa: E501
:return: The order_price_deviate of this Contract. # noqa: E501
:rtype: str
@@ -761,7 +781,7 @@ def order_price_deviate(self):
def order_price_deviate(self, order_price_deviate):
"""Sets the order_price_deviate of this Contract.
- 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 # noqa: E501
+ Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate # noqa: E501
:param order_price_deviate: The order_price_deviate of this Contract. # noqa: E501
:type: str
@@ -773,7 +793,7 @@ def order_price_deviate(self, order_price_deviate):
def ref_discount_rate(self):
"""Gets the ref_discount_rate of this Contract. # noqa: E501
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:return: The ref_discount_rate of this Contract. # noqa: E501
:rtype: str
@@ -784,7 +804,7 @@ def ref_discount_rate(self):
def ref_discount_rate(self, ref_discount_rate):
"""Sets the ref_discount_rate of this Contract.
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:param ref_discount_rate: The ref_discount_rate of this Contract. # noqa: E501
:type: str
@@ -796,7 +816,7 @@ def ref_discount_rate(self, ref_discount_rate):
def ref_rebate_rate(self):
"""Gets the ref_rebate_rate of this Contract. # noqa: E501
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:return: The ref_rebate_rate of this Contract. # noqa: E501
:rtype: str
@@ -807,7 +827,7 @@ def ref_rebate_rate(self):
def ref_rebate_rate(self, ref_rebate_rate):
"""Sets the ref_rebate_rate of this Contract.
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:param ref_rebate_rate: The ref_rebate_rate of this Contract. # noqa: E501
:type: str
@@ -819,7 +839,7 @@ def ref_rebate_rate(self, ref_rebate_rate):
def orderbook_id(self):
"""Gets the orderbook_id of this Contract. # noqa: E501
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:return: The orderbook_id of this Contract. # noqa: E501
:rtype: int
@@ -830,7 +850,7 @@ def orderbook_id(self):
def orderbook_id(self, orderbook_id):
"""Sets the orderbook_id of this Contract.
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:param orderbook_id: The orderbook_id of this Contract. # noqa: E501
:type: int
@@ -865,7 +885,7 @@ def trade_id(self, trade_id):
def trade_size(self):
"""Gets the trade_size of this Contract. # noqa: E501
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:return: The trade_size of this Contract. # noqa: E501
:rtype: int
@@ -876,7 +896,7 @@ def trade_size(self):
def trade_size(self, trade_size):
"""Sets the trade_size of this Contract.
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:param trade_size: The trade_size of this Contract. # noqa: E501
:type: int
@@ -911,7 +931,7 @@ def position_size(self, position_size):
def config_change_time(self):
"""Gets the config_change_time of this Contract. # noqa: E501
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:return: The config_change_time of this Contract. # noqa: E501
:rtype: float
@@ -922,7 +942,7 @@ def config_change_time(self):
def config_change_time(self, config_change_time):
"""Sets the config_change_time of this Contract.
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:param config_change_time: The config_change_time of this Contract. # noqa: E501
:type: float
@@ -934,7 +954,7 @@ def config_change_time(self, config_change_time):
def in_delisting(self):
"""Gets the in_delisting of this Contract. # noqa: E501
- `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline # noqa: E501
+ `in_delisting=true` and position_size>0 indicates the contract is in delisting transition period `in_delisting=true` and position_size=0 indicates the contract is delisted # noqa: E501
:return: The in_delisting of this Contract. # noqa: E501
:rtype: bool
@@ -945,7 +965,7 @@ def in_delisting(self):
def in_delisting(self, in_delisting):
"""Sets the in_delisting of this Contract.
- `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline # noqa: E501
+ `in_delisting=true` and position_size>0 indicates the contract is in delisting transition period `in_delisting=true` and position_size=0 indicates the contract is delisted # noqa: E501
:param in_delisting: The in_delisting of this Contract. # noqa: E501
:type: bool
@@ -957,7 +977,7 @@ def in_delisting(self, in_delisting):
def orders_limit(self):
"""Gets the orders_limit of this Contract. # noqa: E501
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:return: The orders_limit of this Contract. # noqa: E501
:rtype: int
@@ -968,7 +988,7 @@ def orders_limit(self):
def orders_limit(self, orders_limit):
"""Sets the orders_limit of this Contract.
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:param orders_limit: The orders_limit of this Contract. # noqa: E501
:type: int
@@ -980,7 +1000,7 @@ def orders_limit(self, orders_limit):
def enable_bonus(self):
"""Gets the enable_bonus of this Contract. # noqa: E501
- Whether bouns is enabled # noqa: E501
+ Whether bonus is enabled # noqa: E501
:return: The enable_bonus of this Contract. # noqa: E501
:rtype: bool
@@ -991,7 +1011,7 @@ def enable_bonus(self):
def enable_bonus(self, enable_bonus):
"""Sets the enable_bonus of this Contract.
- Whether bouns is enabled # noqa: E501
+ Whether bonus is enabled # noqa: E501
:param enable_bonus: The enable_bonus of this Contract. # noqa: E501
:type: bool
@@ -1068,6 +1088,98 @@ def funding_cap_ratio(self, funding_cap_ratio):
self._funding_cap_ratio = funding_cap_ratio
+ @property
+ def status(self):
+ """Gets the status of this Contract. # noqa: E501
+
+ Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) # noqa: E501
+
+ :return: The status of this Contract. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this Contract.
+
+ Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) # noqa: E501
+
+ :param status: The status of this Contract. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def launch_time(self):
+ """Gets the launch_time of this Contract. # noqa: E501
+
+ Contract expiry timestamp # noqa: E501
+
+ :return: The launch_time of this Contract. # noqa: E501
+ :rtype: int
+ """
+ return self._launch_time
+
+ @launch_time.setter
+ def launch_time(self, launch_time):
+ """Sets the launch_time of this Contract.
+
+ Contract expiry timestamp # noqa: E501
+
+ :param launch_time: The launch_time of this Contract. # noqa: E501
+ :type: int
+ """
+
+ self._launch_time = launch_time
+
+ @property
+ def delisting_time(self):
+ """Gets the delisting_time of this Contract. # noqa: E501
+
+ Timestamp when contract enters reduce-only state # noqa: E501
+
+ :return: The delisting_time of this Contract. # noqa: E501
+ :rtype: int
+ """
+ return self._delisting_time
+
+ @delisting_time.setter
+ def delisting_time(self, delisting_time):
+ """Sets the delisting_time of this Contract.
+
+ Timestamp when contract enters reduce-only state # noqa: E501
+
+ :param delisting_time: The delisting_time of this Contract. # noqa: E501
+ :type: int
+ """
+
+ self._delisting_time = delisting_time
+
+ @property
+ def delisted_time(self):
+ """Gets the delisted_time of this Contract. # noqa: E501
+
+ Contract delisting time # noqa: E501
+
+ :return: The delisted_time of this Contract. # noqa: E501
+ :rtype: int
+ """
+ return self._delisted_time
+
+ @delisted_time.setter
+ def delisted_time(self, delisted_time):
+ """Sets the delisted_time of this Contract.
+
+ Contract delisting time # noqa: E501
+
+ :param delisted_time: The delisted_time of this Contract. # noqa: E501
+ :type: int
+ """
+
+ self._delisted_time = delisted_time
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/contract_stat.py b/gate_api/models/contract_stat.py
index 450c573..cac370c 100644
--- a/gate_api/models/contract_stat.py
+++ b/gate_api/models/contract_stat.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -45,7 +45,8 @@ class ContractStat(object):
'open_interest': 'int',
'open_interest_usd': 'float',
'top_lsr_account': 'float',
- 'top_lsr_size': 'float'
+ 'top_lsr_size': 'float',
+ 'mark_price': 'float'
}
attribute_map = {
@@ -61,11 +62,12 @@ class ContractStat(object):
'open_interest': 'open_interest',
'open_interest_usd': 'open_interest_usd',
'top_lsr_account': 'top_lsr_account',
- 'top_lsr_size': 'top_lsr_size'
+ 'top_lsr_size': 'top_lsr_size',
+ 'mark_price': 'mark_price'
}
- def __init__(self, time=None, lsr_taker=None, lsr_account=None, long_liq_size=None, long_liq_amount=None, long_liq_usd=None, short_liq_size=None, short_liq_amount=None, short_liq_usd=None, open_interest=None, open_interest_usd=None, top_lsr_account=None, top_lsr_size=None, local_vars_configuration=None): # noqa: E501
- # type: (int, float, float, int, float, float, int, float, float, int, float, float, float, Configuration) -> None
+ def __init__(self, time=None, lsr_taker=None, lsr_account=None, long_liq_size=None, long_liq_amount=None, long_liq_usd=None, short_liq_size=None, short_liq_amount=None, short_liq_usd=None, open_interest=None, open_interest_usd=None, top_lsr_account=None, top_lsr_size=None, mark_price=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, float, float, int, float, float, int, float, float, int, float, float, float, float, Configuration) -> None
"""ContractStat - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -84,6 +86,7 @@ def __init__(self, time=None, lsr_taker=None, lsr_account=None, long_liq_size=No
self._open_interest_usd = None
self._top_lsr_account = None
self._top_lsr_size = None
+ self._mark_price = None
self.discriminator = None
if time is not None:
@@ -112,6 +115,8 @@ def __init__(self, time=None, lsr_taker=None, lsr_account=None, long_liq_size=No
self.top_lsr_account = top_lsr_account
if top_lsr_size is not None:
self.top_lsr_size = top_lsr_size
+ if mark_price is not None:
+ self.mark_price = mark_price
@property
def time(self):
@@ -140,7 +145,7 @@ def time(self, time):
def lsr_taker(self):
"""Gets the lsr_taker of this ContractStat. # noqa: E501
- Long/short account number ratio # noqa: E501
+ Long/short taker ratio # noqa: E501
:return: The lsr_taker of this ContractStat. # noqa: E501
:rtype: float
@@ -151,7 +156,7 @@ def lsr_taker(self):
def lsr_taker(self, lsr_taker):
"""Sets the lsr_taker of this ContractStat.
- Long/short account number ratio # noqa: E501
+ Long/short taker ratio # noqa: E501
:param lsr_taker: The lsr_taker of this ContractStat. # noqa: E501
:type: float
@@ -163,7 +168,7 @@ def lsr_taker(self, lsr_taker):
def lsr_account(self):
"""Gets the lsr_account of this ContractStat. # noqa: E501
- Long/short taker size ratio # noqa: E501
+ Long/short position user ratio # noqa: E501
:return: The lsr_account of this ContractStat. # noqa: E501
:rtype: float
@@ -174,7 +179,7 @@ def lsr_account(self):
def lsr_account(self, lsr_account):
"""Sets the lsr_account of this ContractStat.
- Long/short taker size ratio # noqa: E501
+ Long/short position user ratio # noqa: E501
:param lsr_account: The lsr_account of this ContractStat. # noqa: E501
:type: float
@@ -186,7 +191,7 @@ def lsr_account(self, lsr_account):
def long_liq_size(self):
"""Gets the long_liq_size of this ContractStat. # noqa: E501
- Long liquidation size # noqa: E501
+ Long liquidation size (contracts) # noqa: E501
:return: The long_liq_size of this ContractStat. # noqa: E501
:rtype: int
@@ -197,7 +202,7 @@ def long_liq_size(self):
def long_liq_size(self, long_liq_size):
"""Sets the long_liq_size of this ContractStat.
- Long liquidation size # noqa: E501
+ Long liquidation size (contracts) # noqa: E501
:param long_liq_size: The long_liq_size of this ContractStat. # noqa: E501
:type: int
@@ -209,7 +214,7 @@ def long_liq_size(self, long_liq_size):
def long_liq_amount(self):
"""Gets the long_liq_amount of this ContractStat. # noqa: E501
- Long liquidation amount(base currency) # noqa: E501
+ Long liquidation amount (base currency) # noqa: E501
:return: The long_liq_amount of this ContractStat. # noqa: E501
:rtype: float
@@ -220,7 +225,7 @@ def long_liq_amount(self):
def long_liq_amount(self, long_liq_amount):
"""Sets the long_liq_amount of this ContractStat.
- Long liquidation amount(base currency) # noqa: E501
+ Long liquidation amount (base currency) # noqa: E501
:param long_liq_amount: The long_liq_amount of this ContractStat. # noqa: E501
:type: float
@@ -232,7 +237,7 @@ def long_liq_amount(self, long_liq_amount):
def long_liq_usd(self):
"""Gets the long_liq_usd of this ContractStat. # noqa: E501
- Long liquidation volume(quote currency) # noqa: E501
+ Long liquidation volume (quote currency) # noqa: E501
:return: The long_liq_usd of this ContractStat. # noqa: E501
:rtype: float
@@ -243,7 +248,7 @@ def long_liq_usd(self):
def long_liq_usd(self, long_liq_usd):
"""Sets the long_liq_usd of this ContractStat.
- Long liquidation volume(quote currency) # noqa: E501
+ Long liquidation volume (quote currency) # noqa: E501
:param long_liq_usd: The long_liq_usd of this ContractStat. # noqa: E501
:type: float
@@ -255,7 +260,7 @@ def long_liq_usd(self, long_liq_usd):
def short_liq_size(self):
"""Gets the short_liq_size of this ContractStat. # noqa: E501
- Short liquidation size # noqa: E501
+ Short liquidation size (contracts) # noqa: E501
:return: The short_liq_size of this ContractStat. # noqa: E501
:rtype: int
@@ -266,7 +271,7 @@ def short_liq_size(self):
def short_liq_size(self, short_liq_size):
"""Sets the short_liq_size of this ContractStat.
- Short liquidation size # noqa: E501
+ Short liquidation size (contracts) # noqa: E501
:param short_liq_size: The short_liq_size of this ContractStat. # noqa: E501
:type: int
@@ -278,7 +283,7 @@ def short_liq_size(self, short_liq_size):
def short_liq_amount(self):
"""Gets the short_liq_amount of this ContractStat. # noqa: E501
- Short liquidation amount(base currency) # noqa: E501
+ Short liquidation amount (base currency) # noqa: E501
:return: The short_liq_amount of this ContractStat. # noqa: E501
:rtype: float
@@ -289,7 +294,7 @@ def short_liq_amount(self):
def short_liq_amount(self, short_liq_amount):
"""Sets the short_liq_amount of this ContractStat.
- Short liquidation amount(base currency) # noqa: E501
+ Short liquidation amount (base currency) # noqa: E501
:param short_liq_amount: The short_liq_amount of this ContractStat. # noqa: E501
:type: float
@@ -301,7 +306,7 @@ def short_liq_amount(self, short_liq_amount):
def short_liq_usd(self):
"""Gets the short_liq_usd of this ContractStat. # noqa: E501
- Short liquidation volume(quote currency) # noqa: E501
+ Short liquidation volume (quote currency) # noqa: E501
:return: The short_liq_usd of this ContractStat. # noqa: E501
:rtype: float
@@ -312,7 +317,7 @@ def short_liq_usd(self):
def short_liq_usd(self, short_liq_usd):
"""Sets the short_liq_usd of this ContractStat.
- Short liquidation volume(quote currency) # noqa: E501
+ Short liquidation volume (quote currency) # noqa: E501
:param short_liq_usd: The short_liq_usd of this ContractStat. # noqa: E501
:type: float
@@ -324,7 +329,7 @@ def short_liq_usd(self, short_liq_usd):
def open_interest(self):
"""Gets the open_interest of this ContractStat. # noqa: E501
- Open interest size # noqa: E501
+ Total open interest size (contracts) # noqa: E501
:return: The open_interest of this ContractStat. # noqa: E501
:rtype: int
@@ -335,7 +340,7 @@ def open_interest(self):
def open_interest(self, open_interest):
"""Sets the open_interest of this ContractStat.
- Open interest size # noqa: E501
+ Total open interest size (contracts) # noqa: E501
:param open_interest: The open_interest of this ContractStat. # noqa: E501
:type: int
@@ -347,7 +352,7 @@ def open_interest(self, open_interest):
def open_interest_usd(self):
"""Gets the open_interest_usd of this ContractStat. # noqa: E501
- Open interest volume(quote currency) # noqa: E501
+ Total open interest volume (quote currency) # noqa: E501
:return: The open_interest_usd of this ContractStat. # noqa: E501
:rtype: float
@@ -358,7 +363,7 @@ def open_interest_usd(self):
def open_interest_usd(self, open_interest_usd):
"""Sets the open_interest_usd of this ContractStat.
- Open interest volume(quote currency) # noqa: E501
+ Total open interest volume (quote currency) # noqa: E501
:param open_interest_usd: The open_interest_usd of this ContractStat. # noqa: E501
:type: float
@@ -412,6 +417,29 @@ def top_lsr_size(self, top_lsr_size):
self._top_lsr_size = top_lsr_size
+ @property
+ def mark_price(self):
+ """Gets the mark_price of this ContractStat. # noqa: E501
+
+ Mark price # noqa: E501
+
+ :return: The mark_price of this ContractStat. # noqa: E501
+ :rtype: float
+ """
+ return self._mark_price
+
+ @mark_price.setter
+ def mark_price(self, mark_price):
+ """Sets the mark_price of this ContractStat.
+
+ Mark price # noqa: E501
+
+ :param mark_price: The mark_price of this ContractStat. # noqa: E501
+ :type: float
+ """
+
+ self._mark_price = mark_price
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/convert_small_balance.py b/gate_api/models/convert_small_balance.py
index e254254..dc47f37 100644
--- a/gate_api/models/convert_small_balance.py
+++ b/gate_api/models/convert_small_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -62,7 +62,7 @@ def __init__(self, currency=None, is_all=None, local_vars_configuration=None):
def currency(self):
"""Gets the currency of this ConvertSmallBalance. # noqa: E501
- Currency # noqa: E501
+ Currency to be converted # noqa: E501
:return: The currency of this ConvertSmallBalance. # noqa: E501
:rtype: list[str]
@@ -73,7 +73,7 @@ def currency(self):
def currency(self, currency):
"""Sets the currency of this ConvertSmallBalance.
- Currency # noqa: E501
+ Currency to be converted # noqa: E501
:param currency: The currency of this ConvertSmallBalance. # noqa: E501
:type: list[str]
@@ -85,7 +85,7 @@ def currency(self, currency):
def is_all(self):
"""Gets the is_all of this ConvertSmallBalance. # noqa: E501
- Whether to exchange all # noqa: E501
+ Whether to convert all # noqa: E501
:return: The is_all of this ConvertSmallBalance. # noqa: E501
:rtype: bool
@@ -96,7 +96,7 @@ def is_all(self):
def is_all(self, is_all):
"""Sets the is_all of this ConvertSmallBalance.
- Whether to exchange all # noqa: E501
+ Whether to convert all # noqa: E501
:param is_all: The is_all of this ConvertSmallBalance. # noqa: E501
:type: bool
diff --git a/gate_api/models/countdown_cancel_all_futures_task.py b/gate_api/models/countdown_cancel_all_futures_task.py
index 4501ba2..c927a3a 100644
--- a/gate_api/models/countdown_cancel_all_futures_task.py
+++ b/gate_api/models/countdown_cancel_all_futures_task.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -61,7 +61,7 @@ def __init__(self, timeout=None, contract=None, local_vars_configuration=None):
def timeout(self):
"""Gets the timeout of this CountdownCancelAllFuturesTask. # noqa: E501
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:return: The timeout of this CountdownCancelAllFuturesTask. # noqa: E501
:rtype: int
@@ -72,7 +72,7 @@ def timeout(self):
def timeout(self, timeout):
"""Sets the timeout of this CountdownCancelAllFuturesTask.
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:param timeout: The timeout of this CountdownCancelAllFuturesTask. # noqa: E501
:type: int
diff --git a/gate_api/models/countdown_cancel_all_options_task.py b/gate_api/models/countdown_cancel_all_options_task.py
index 62cc503..b221659 100644
--- a/gate_api/models/countdown_cancel_all_options_task.py
+++ b/gate_api/models/countdown_cancel_all_options_task.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -66,7 +66,7 @@ def __init__(self, timeout=None, contract=None, underlying=None, local_vars_conf
def timeout(self):
"""Gets the timeout of this CountdownCancelAllOptionsTask. # noqa: E501
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:return: The timeout of this CountdownCancelAllOptionsTask. # noqa: E501
:rtype: int
@@ -77,7 +77,7 @@ def timeout(self):
def timeout(self, timeout):
"""Sets the timeout of this CountdownCancelAllOptionsTask.
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:param timeout: The timeout of this CountdownCancelAllOptionsTask. # noqa: E501
:type: int
diff --git a/gate_api/models/countdown_cancel_all_spot_task.py b/gate_api/models/countdown_cancel_all_spot_task.py
index f2764ab..2761477 100644
--- a/gate_api/models/countdown_cancel_all_spot_task.py
+++ b/gate_api/models/countdown_cancel_all_spot_task.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -61,7 +61,7 @@ def __init__(self, timeout=None, currency_pair=None, local_vars_configuration=No
def timeout(self):
"""Gets the timeout of this CountdownCancelAllSpotTask. # noqa: E501
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:return: The timeout of this CountdownCancelAllSpotTask. # noqa: E501
:rtype: int
@@ -72,7 +72,7 @@ def timeout(self):
def timeout(self, timeout):
"""Sets the timeout of this CountdownCancelAllSpotTask.
- Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown # noqa: E501
+ Countdown time in seconds At least 5 seconds, 0 means cancel countdown # noqa: E501
:param timeout: The timeout of this CountdownCancelAllSpotTask. # noqa: E501
:type: int
diff --git a/gate_api/models/create_collateral_order.py b/gate_api/models/create_collateral_order.py
index b82beab..f570586 100644
--- a/gate_api/models/create_collateral_order.py
+++ b/gate_api/models/create_collateral_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -93,7 +93,7 @@ def collateral_amount(self, collateral_amount):
def collateral_currency(self):
"""Gets the collateral_currency of this CreateCollateralOrder. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this CreateCollateralOrder. # noqa: E501
:rtype: str
@@ -104,7 +104,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this CreateCollateralOrder.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this CreateCollateralOrder. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def collateral_currency(self, collateral_currency):
def borrow_amount(self):
"""Gets the borrow_amount of this CreateCollateralOrder. # noqa: E501
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:return: The borrow_amount of this CreateCollateralOrder. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def borrow_amount(self):
def borrow_amount(self, borrow_amount):
"""Sets the borrow_amount of this CreateCollateralOrder.
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:param borrow_amount: The borrow_amount of this CreateCollateralOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/create_multi_collateral_order.py b/gate_api/models/create_multi_collateral_order.py
index 84e5e21..b3cc035 100644
--- a/gate_api/models/create_multi_collateral_order.py
+++ b/gate_api/models/create_multi_collateral_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -118,7 +118,7 @@ def order_id(self, order_id):
def order_type(self):
"""Gets the order_type of this CreateMultiCollateralOrder. # noqa: E501
- current - current, fixed - fixed, if not specified, default to current # noqa: E501
+ current - current rate, fixed - fixed rate, defaults to current if not specified # noqa: E501
:return: The order_type of this CreateMultiCollateralOrder. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def order_type(self):
def order_type(self, order_type):
"""Sets the order_type of this CreateMultiCollateralOrder.
- current - current, fixed - fixed, if not specified, default to current # noqa: E501
+ current - current rate, fixed - fixed rate, defaults to current if not specified # noqa: E501
:param order_type: The order_type of this CreateMultiCollateralOrder. # noqa: E501
:type: str
@@ -141,7 +141,7 @@ def order_type(self, order_type):
def fixed_type(self):
"""Gets the fixed_type of this CreateMultiCollateralOrder. # noqa: E501
- Fixed interest rate loan period: 7d - 7 days, 30d - 30 days. Must be provided for fixed # noqa: E501
+ Fixed interest rate lending period: 7d - 7 days, 30d - 30 days. Required for fixed rate # noqa: E501
:return: The fixed_type of this CreateMultiCollateralOrder. # noqa: E501
:rtype: str
@@ -152,7 +152,7 @@ def fixed_type(self):
def fixed_type(self, fixed_type):
"""Sets the fixed_type of this CreateMultiCollateralOrder.
- Fixed interest rate loan period: 7d - 7 days, 30d - 30 days. Must be provided for fixed # noqa: E501
+ Fixed interest rate lending period: 7d - 7 days, 30d - 30 days. Required for fixed rate # noqa: E501
:param fixed_type: The fixed_type of this CreateMultiCollateralOrder. # noqa: E501
:type: str
@@ -164,7 +164,7 @@ def fixed_type(self, fixed_type):
def fixed_rate(self):
"""Gets the fixed_rate of this CreateMultiCollateralOrder. # noqa: E501
- Fixed interest rate, must be specified for fixed # noqa: E501
+ Fixed interest rate, required for fixed rate # noqa: E501
:return: The fixed_rate of this CreateMultiCollateralOrder. # noqa: E501
:rtype: str
@@ -175,7 +175,7 @@ def fixed_rate(self):
def fixed_rate(self, fixed_rate):
"""Sets the fixed_rate of this CreateMultiCollateralOrder.
- Fixed interest rate, must be specified for fixed # noqa: E501
+ Fixed interest rate, required for fixed rate # noqa: E501
:param fixed_rate: The fixed_rate of this CreateMultiCollateralOrder. # noqa: E501
:type: str
@@ -187,7 +187,7 @@ def fixed_rate(self, fixed_rate):
def auto_renew(self):
"""Gets the auto_renew of this CreateMultiCollateralOrder. # noqa: E501
- Fixed interest rate, automatic renewal # noqa: E501
+ Fixed interest rate, auto-renewal # noqa: E501
:return: The auto_renew of this CreateMultiCollateralOrder. # noqa: E501
:rtype: bool
@@ -198,7 +198,7 @@ def auto_renew(self):
def auto_renew(self, auto_renew):
"""Sets the auto_renew of this CreateMultiCollateralOrder.
- Fixed interest rate, automatic renewal # noqa: E501
+ Fixed interest rate, auto-renewal # noqa: E501
:param auto_renew: The auto_renew of this CreateMultiCollateralOrder. # noqa: E501
:type: bool
@@ -210,7 +210,7 @@ def auto_renew(self, auto_renew):
def auto_repay(self):
"""Gets the auto_repay of this CreateMultiCollateralOrder. # noqa: E501
- Fixed interest rate, automatic repayment # noqa: E501
+ Fixed interest rate, auto-repayment # noqa: E501
:return: The auto_repay of this CreateMultiCollateralOrder. # noqa: E501
:rtype: bool
@@ -221,7 +221,7 @@ def auto_repay(self):
def auto_repay(self, auto_repay):
"""Sets the auto_repay of this CreateMultiCollateralOrder.
- Fixed interest rate, automatic repayment # noqa: E501
+ Fixed interest rate, auto-repayment # noqa: E501
:param auto_repay: The auto_repay of this CreateMultiCollateralOrder. # noqa: E501
:type: bool
@@ -258,7 +258,7 @@ def borrow_currency(self, borrow_currency):
def borrow_amount(self):
"""Gets the borrow_amount of this CreateMultiCollateralOrder. # noqa: E501
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:return: The borrow_amount of this CreateMultiCollateralOrder. # noqa: E501
:rtype: str
@@ -269,7 +269,7 @@ def borrow_amount(self):
def borrow_amount(self, borrow_amount):
"""Sets the borrow_amount of this CreateMultiCollateralOrder.
- Borrowing amount # noqa: E501
+ Borrowed amount # noqa: E501
:param borrow_amount: The borrow_amount of this CreateMultiCollateralOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/create_uni_lend.py b/gate_api/models/create_uni_lend.py
index b45bd6b..ea40615 100644
--- a/gate_api/models/create_uni_lend.py
+++ b/gate_api/models/create_uni_lend.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -94,7 +94,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this CreateUniLend. # noqa: E501
- The amount of currency could be lent # noqa: E501
+ Amount to deposit into lending pool # noqa: E501
:return: The amount of this CreateUniLend. # noqa: E501
:rtype: str
@@ -105,7 +105,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this CreateUniLend.
- The amount of currency could be lent # noqa: E501
+ Amount to deposit into lending pool # noqa: E501
:param amount: The amount of this CreateUniLend. # noqa: E501
:type: str
@@ -119,7 +119,7 @@ def amount(self, amount):
def type(self):
"""Gets the type of this CreateUniLend. # noqa: E501
- type: lend - lend, redeem - redeem # noqa: E501
+ Operation type: lend - Lend, redeem - Redeem # noqa: E501
:return: The type of this CreateUniLend. # noqa: E501
:rtype: str
@@ -130,7 +130,7 @@ def type(self):
def type(self, type):
"""Sets the type of this CreateUniLend.
- type: lend - lend, redeem - redeem # noqa: E501
+ Operation type: lend - Lend, redeem - Redeem # noqa: E501
:param type: The type of this CreateUniLend. # noqa: E501
:type: str
@@ -150,7 +150,7 @@ def type(self, type):
def min_rate(self):
"""Gets the min_rate of this CreateUniLend. # noqa: E501
- The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. # noqa: E501
+ Minimum interest rate. If set too high, lending may fail and no interest will be earned. Required for lending operations. # noqa: E501
:return: The min_rate of this CreateUniLend. # noqa: E501
:rtype: str
@@ -161,7 +161,7 @@ def min_rate(self):
def min_rate(self, min_rate):
"""Sets the min_rate of this CreateUniLend.
- The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. # noqa: E501
+ Minimum interest rate. If set too high, lending may fail and no interest will be earned. Required for lending operations. # noqa: E501
:param min_rate: The min_rate of this CreateUniLend. # noqa: E501
:type: str
diff --git a/gate_api/models/create_uni_loan.py b/gate_api/models/create_uni_loan.py
index 419b667..708db4a 100644
--- a/gate_api/models/create_uni_loan.py
+++ b/gate_api/models/create_uni_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -98,7 +98,7 @@ def currency(self, currency):
def type(self):
"""Gets the type of this CreateUniLoan. # noqa: E501
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:return: The type of this CreateUniLoan. # noqa: E501
:rtype: str
@@ -109,7 +109,7 @@ def type(self):
def type(self, type):
"""Sets the type of this CreateUniLoan.
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:param type: The type of this CreateUniLoan. # noqa: E501
:type: str
@@ -129,7 +129,7 @@ def type(self, type):
def amount(self):
"""Gets the amount of this CreateUniLoan. # noqa: E501
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:return: The amount of this CreateUniLoan. # noqa: E501
:rtype: str
@@ -140,7 +140,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this CreateUniLoan.
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:param amount: The amount of this CreateUniLoan. # noqa: E501
:type: str
@@ -154,7 +154,7 @@ def amount(self, amount):
def repaid_all(self):
"""Gets the repaid_all of this CreateUniLoan. # noqa: E501
- Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. # noqa: E501
+ Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount # noqa: E501
:return: The repaid_all of this CreateUniLoan. # noqa: E501
:rtype: bool
@@ -165,7 +165,7 @@ def repaid_all(self):
def repaid_all(self, repaid_all):
"""Sets the repaid_all of this CreateUniLoan.
- Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. # noqa: E501
+ Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount # noqa: E501
:param repaid_all: The repaid_all of this CreateUniLoan. # noqa: E501
:type: bool
diff --git a/gate_api/models/cross_margin_account.py b/gate_api/models/cross_margin_account.py
deleted file mode 100644
index e76d6ed..0000000
--- a/gate_api/models/cross_margin_account.py
+++ /dev/null
@@ -1,569 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class CrossMarginAccount(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'user_id': 'int',
- 'refresh_time': 'int',
- 'locked': 'bool',
- 'balances': 'dict(str, CrossMarginBalance)',
- 'total': 'str',
- 'borrowed': 'str',
- 'interest': 'str',
- 'risk': 'str',
- 'total_initial_margin': 'str',
- 'total_margin_balance': 'str',
- 'total_maintenance_margin': 'str',
- 'total_initial_margin_rate': 'str',
- 'total_maintenance_margin_rate': 'str',
- 'total_available_margin': 'str',
- 'portfolio_margin_total': 'str',
- 'portfolio_margin_total_liab': 'str',
- 'portfolio_margin_total_equity': 'str'
- }
-
- attribute_map = {
- 'user_id': 'user_id',
- 'refresh_time': 'refresh_time',
- 'locked': 'locked',
- 'balances': 'balances',
- 'total': 'total',
- 'borrowed': 'borrowed',
- 'interest': 'interest',
- 'risk': 'risk',
- 'total_initial_margin': 'total_initial_margin',
- 'total_margin_balance': 'total_margin_balance',
- 'total_maintenance_margin': 'total_maintenance_margin',
- 'total_initial_margin_rate': 'total_initial_margin_rate',
- 'total_maintenance_margin_rate': 'total_maintenance_margin_rate',
- 'total_available_margin': 'total_available_margin',
- 'portfolio_margin_total': 'portfolio_margin_total',
- 'portfolio_margin_total_liab': 'portfolio_margin_total_liab',
- 'portfolio_margin_total_equity': 'portfolio_margin_total_equity'
- }
-
- def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None, total=None, borrowed=None, interest=None, risk=None, total_initial_margin=None, total_margin_balance=None, total_maintenance_margin=None, total_initial_margin_rate=None, total_maintenance_margin_rate=None, total_available_margin=None, portfolio_margin_total=None, portfolio_margin_total_liab=None, portfolio_margin_total_equity=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, bool, dict(str, CrossMarginBalance), str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
- """CrossMarginAccount - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._user_id = None
- self._refresh_time = None
- self._locked = None
- self._balances = None
- self._total = None
- self._borrowed = None
- self._interest = None
- self._risk = None
- self._total_initial_margin = None
- self._total_margin_balance = None
- self._total_maintenance_margin = None
- self._total_initial_margin_rate = None
- self._total_maintenance_margin_rate = None
- self._total_available_margin = None
- self._portfolio_margin_total = None
- self._portfolio_margin_total_liab = None
- self._portfolio_margin_total_equity = None
- self.discriminator = None
-
- if user_id is not None:
- self.user_id = user_id
- if refresh_time is not None:
- self.refresh_time = refresh_time
- if locked is not None:
- self.locked = locked
- if balances is not None:
- self.balances = balances
- if total is not None:
- self.total = total
- if borrowed is not None:
- self.borrowed = borrowed
- if interest is not None:
- self.interest = interest
- if risk is not None:
- self.risk = risk
- if total_initial_margin is not None:
- self.total_initial_margin = total_initial_margin
- if total_margin_balance is not None:
- self.total_margin_balance = total_margin_balance
- if total_maintenance_margin is not None:
- self.total_maintenance_margin = total_maintenance_margin
- if total_initial_margin_rate is not None:
- self.total_initial_margin_rate = total_initial_margin_rate
- if total_maintenance_margin_rate is not None:
- self.total_maintenance_margin_rate = total_maintenance_margin_rate
- if total_available_margin is not None:
- self.total_available_margin = total_available_margin
- if portfolio_margin_total is not None:
- self.portfolio_margin_total = portfolio_margin_total
- if portfolio_margin_total_liab is not None:
- self.portfolio_margin_total_liab = portfolio_margin_total_liab
- if portfolio_margin_total_equity is not None:
- self.portfolio_margin_total_equity = portfolio_margin_total_equity
-
- @property
- def user_id(self):
- """Gets the user_id of this CrossMarginAccount. # noqa: E501
-
- User ID # noqa: E501
-
- :return: The user_id of this CrossMarginAccount. # noqa: E501
- :rtype: int
- """
- return self._user_id
-
- @user_id.setter
- def user_id(self, user_id):
- """Sets the user_id of this CrossMarginAccount.
-
- User ID # noqa: E501
-
- :param user_id: The user_id of this CrossMarginAccount. # noqa: E501
- :type: int
- """
-
- self._user_id = user_id
-
- @property
- def refresh_time(self):
- """Gets the refresh_time of this CrossMarginAccount. # noqa: E501
-
- Time of the most recent refresh # noqa: E501
-
- :return: The refresh_time of this CrossMarginAccount. # noqa: E501
- :rtype: int
- """
- return self._refresh_time
-
- @refresh_time.setter
- def refresh_time(self, refresh_time):
- """Sets the refresh_time of this CrossMarginAccount.
-
- Time of the most recent refresh # noqa: E501
-
- :param refresh_time: The refresh_time of this CrossMarginAccount. # noqa: E501
- :type: int
- """
-
- self._refresh_time = refresh_time
-
- @property
- def locked(self):
- """Gets the locked of this CrossMarginAccount. # noqa: E501
-
- Whether account is locked # noqa: E501
-
- :return: The locked of this CrossMarginAccount. # noqa: E501
- :rtype: bool
- """
- return self._locked
-
- @locked.setter
- def locked(self, locked):
- """Sets the locked of this CrossMarginAccount.
-
- Whether account is locked # noqa: E501
-
- :param locked: The locked of this CrossMarginAccount. # noqa: E501
- :type: bool
- """
-
- self._locked = locked
-
- @property
- def balances(self):
- """Gets the balances of this CrossMarginAccount. # noqa: E501
-
-
- :return: The balances of this CrossMarginAccount. # noqa: E501
- :rtype: dict(str, CrossMarginBalance)
- """
- return self._balances
-
- @balances.setter
- def balances(self, balances):
- """Sets the balances of this CrossMarginAccount.
-
-
- :param balances: The balances of this CrossMarginAccount. # noqa: E501
- :type: dict(str, CrossMarginBalance)
- """
-
- self._balances = balances
-
- @property
- def total(self):
- """Gets the total of this CrossMarginAccount. # noqa: E501
-
- Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` # noqa: E501
-
- :return: The total of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total
-
- @total.setter
- def total(self, total):
- """Sets the total of this CrossMarginAccount.
-
- Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` # noqa: E501
-
- :param total: The total of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total = total
-
- @property
- def borrowed(self):
- """Gets the borrowed of this CrossMarginAccount. # noqa: E501
-
- Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` # noqa: E501
-
- :return: The borrowed of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._borrowed
-
- @borrowed.setter
- def borrowed(self, borrowed):
- """Sets the borrowed of this CrossMarginAccount.
-
- Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` # noqa: E501
-
- :param borrowed: The borrowed of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._borrowed = borrowed
-
- @property
- def interest(self):
- """Gets the interest of this CrossMarginAccount. # noqa: E501
-
- Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
-
- :return: The interest of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._interest
-
- @interest.setter
- def interest(self, interest):
- """Sets the interest of this CrossMarginAccount.
-
- Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
-
- :param interest: The interest of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._interest = interest
-
- @property
- def risk(self):
- """Gets the risk of this CrossMarginAccount. # noqa: E501
-
- Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
-
- :return: The risk of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._risk
-
- @risk.setter
- def risk(self, risk):
- """Sets the risk of this CrossMarginAccount.
-
- Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
-
- :param risk: The risk of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._risk = risk
-
- @property
- def total_initial_margin(self):
- """Gets the total_initial_margin of this CrossMarginAccount. # noqa: E501
-
- Total initial margin # noqa: E501
-
- :return: The total_initial_margin of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_initial_margin
-
- @total_initial_margin.setter
- def total_initial_margin(self, total_initial_margin):
- """Sets the total_initial_margin of this CrossMarginAccount.
-
- Total initial margin # noqa: E501
-
- :param total_initial_margin: The total_initial_margin of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_initial_margin = total_initial_margin
-
- @property
- def total_margin_balance(self):
- """Gets the total_margin_balance of this CrossMarginAccount. # noqa: E501
-
- Total Margin Balance (∑(positive equity ＊ index price * discount) + ∑(negative equity * index price)) # noqa: E501
-
- :return: The total_margin_balance of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_margin_balance
-
- @total_margin_balance.setter
- def total_margin_balance(self, total_margin_balance):
- """Sets the total_margin_balance of this CrossMarginAccount.
-
- Total Margin Balance (∑(positive equity ＊ index price * discount) + ∑(negative equity * index price)) # noqa: E501
-
- :param total_margin_balance: The total_margin_balance of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_margin_balance = total_margin_balance
-
- @property
- def total_maintenance_margin(self):
- """Gets the total_maintenance_margin of this CrossMarginAccount. # noqa: E501
-
- Total maintenance margin # noqa: E501
-
- :return: The total_maintenance_margin of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_maintenance_margin
-
- @total_maintenance_margin.setter
- def total_maintenance_margin(self, total_maintenance_margin):
- """Sets the total_maintenance_margin of this CrossMarginAccount.
-
- Total maintenance margin # noqa: E501
-
- :param total_maintenance_margin: The total_maintenance_margin of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_maintenance_margin = total_maintenance_margin
-
- @property
- def total_initial_margin_rate(self):
- """Gets the total_initial_margin_rate of this CrossMarginAccount. # noqa: E501
-
- Total initial margin rate # noqa: E501
-
- :return: The total_initial_margin_rate of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_initial_margin_rate
-
- @total_initial_margin_rate.setter
- def total_initial_margin_rate(self, total_initial_margin_rate):
- """Sets the total_initial_margin_rate of this CrossMarginAccount.
-
- Total initial margin rate # noqa: E501
-
- :param total_initial_margin_rate: The total_initial_margin_rate of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_initial_margin_rate = total_initial_margin_rate
-
- @property
- def total_maintenance_margin_rate(self):
- """Gets the total_maintenance_margin_rate of this CrossMarginAccount. # noqa: E501
-
- Total maintenance margin rate # noqa: E501
-
- :return: The total_maintenance_margin_rate of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_maintenance_margin_rate
-
- @total_maintenance_margin_rate.setter
- def total_maintenance_margin_rate(self, total_maintenance_margin_rate):
- """Sets the total_maintenance_margin_rate of this CrossMarginAccount.
-
- Total maintenance margin rate # noqa: E501
-
- :param total_maintenance_margin_rate: The total_maintenance_margin_rate of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_maintenance_margin_rate = total_maintenance_margin_rate
-
- @property
- def total_available_margin(self):
- """Gets the total_available_margin of this CrossMarginAccount. # noqa: E501
-
- Total available margin # noqa: E501
-
- :return: The total_available_margin of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._total_available_margin
-
- @total_available_margin.setter
- def total_available_margin(self, total_available_margin):
- """Sets the total_available_margin of this CrossMarginAccount.
-
- Total available margin # noqa: E501
-
- :param total_available_margin: The total_available_margin of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._total_available_margin = total_available_margin
-
- @property
- def portfolio_margin_total(self):
- """Gets the portfolio_margin_total of this CrossMarginAccount. # noqa: E501
-
- Total amount of the portfolio margin account # noqa: E501
-
- :return: The portfolio_margin_total of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._portfolio_margin_total
-
- @portfolio_margin_total.setter
- def portfolio_margin_total(self, portfolio_margin_total):
- """Sets the portfolio_margin_total of this CrossMarginAccount.
-
- Total amount of the portfolio margin account # noqa: E501
-
- :param portfolio_margin_total: The portfolio_margin_total of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._portfolio_margin_total = portfolio_margin_total
-
- @property
- def portfolio_margin_total_liab(self):
- """Gets the portfolio_margin_total_liab of this CrossMarginAccount. # noqa: E501
-
- Total liabilities of the portfolio margin account # noqa: E501
-
- :return: The portfolio_margin_total_liab of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._portfolio_margin_total_liab
-
- @portfolio_margin_total_liab.setter
- def portfolio_margin_total_liab(self, portfolio_margin_total_liab):
- """Sets the portfolio_margin_total_liab of this CrossMarginAccount.
-
- Total liabilities of the portfolio margin account # noqa: E501
-
- :param portfolio_margin_total_liab: The portfolio_margin_total_liab of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._portfolio_margin_total_liab = portfolio_margin_total_liab
-
- @property
- def portfolio_margin_total_equity(self):
- """Gets the portfolio_margin_total_equity of this CrossMarginAccount. # noqa: E501
-
- Total equity of the portfolio margin account # noqa: E501
-
- :return: The portfolio_margin_total_equity of this CrossMarginAccount. # noqa: E501
- :rtype: str
- """
- return self._portfolio_margin_total_equity
-
- @portfolio_margin_total_equity.setter
- def portfolio_margin_total_equity(self, portfolio_margin_total_equity):
- """Sets the portfolio_margin_total_equity of this CrossMarginAccount.
-
- Total equity of the portfolio margin account # noqa: E501
-
- :param portfolio_margin_total_equity: The portfolio_margin_total_equity of this CrossMarginAccount. # noqa: E501
- :type: str
- """
-
- self._portfolio_margin_total_equity = portfolio_margin_total_equity
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginAccount):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginAccount):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/cross_margin_account_book.py b/gate_api/models/cross_margin_account_book.py
deleted file mode 100644
index faf0dd2..0000000
--- a/gate_api/models/cross_margin_account_book.py
+++ /dev/null
@@ -1,263 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class CrossMarginAccountBook(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'id': 'str',
- 'time': 'int',
- 'currency': 'str',
- 'change': 'str',
- 'balance': 'str',
- 'type': 'str'
- }
-
- attribute_map = {
- 'id': 'id',
- 'time': 'time',
- 'currency': 'currency',
- 'change': 'change',
- 'balance': 'balance',
- 'type': 'type'
- }
-
- def __init__(self, id=None, time=None, currency=None, change=None, balance=None, type=None, local_vars_configuration=None): # noqa: E501
- # type: (str, int, str, str, str, str, Configuration) -> None
- """CrossMarginAccountBook - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._id = None
- self._time = None
- self._currency = None
- self._change = None
- self._balance = None
- self._type = None
- self.discriminator = None
-
- if id is not None:
- self.id = id
- if time is not None:
- self.time = time
- if currency is not None:
- self.currency = currency
- if change is not None:
- self.change = change
- if balance is not None:
- self.balance = balance
- if type is not None:
- self.type = type
-
- @property
- def id(self):
- """Gets the id of this CrossMarginAccountBook. # noqa: E501
-
- Balance change record ID # noqa: E501
-
- :return: The id of this CrossMarginAccountBook. # noqa: E501
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id):
- """Sets the id of this CrossMarginAccountBook.
-
- Balance change record ID # noqa: E501
-
- :param id: The id of this CrossMarginAccountBook. # noqa: E501
- :type: str
- """
-
- self._id = id
-
- @property
- def time(self):
- """Gets the time of this CrossMarginAccountBook. # noqa: E501
-
- The timestamp of the change (in milliseconds) # noqa: E501
-
- :return: The time of this CrossMarginAccountBook. # noqa: E501
- :rtype: int
- """
- return self._time
-
- @time.setter
- def time(self, time):
- """Sets the time of this CrossMarginAccountBook.
-
- The timestamp of the change (in milliseconds) # noqa: E501
-
- :param time: The time of this CrossMarginAccountBook. # noqa: E501
- :type: int
- """
-
- self._time = time
-
- @property
- def currency(self):
- """Gets the currency of this CrossMarginAccountBook. # noqa: E501
-
- Currency changed # noqa: E501
-
- :return: The currency of this CrossMarginAccountBook. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this CrossMarginAccountBook.
-
- Currency changed # noqa: E501
-
- :param currency: The currency of this CrossMarginAccountBook. # noqa: E501
- :type: str
- """
-
- self._currency = currency
-
- @property
- def change(self):
- """Gets the change of this CrossMarginAccountBook. # noqa: E501
-
- Amount changed. Positive value means transferring in, while negative out # noqa: E501
-
- :return: The change of this CrossMarginAccountBook. # noqa: E501
- :rtype: str
- """
- return self._change
-
- @change.setter
- def change(self, change):
- """Sets the change of this CrossMarginAccountBook.
-
- Amount changed. Positive value means transferring in, while negative out # noqa: E501
-
- :param change: The change of this CrossMarginAccountBook. # noqa: E501
- :type: str
- """
-
- self._change = change
-
- @property
- def balance(self):
- """Gets the balance of this CrossMarginAccountBook. # noqa: E501
-
- Balance after change # noqa: E501
-
- :return: The balance of this CrossMarginAccountBook. # noqa: E501
- :rtype: str
- """
- return self._balance
-
- @balance.setter
- def balance(self, balance):
- """Sets the balance of this CrossMarginAccountBook.
-
- Balance after change # noqa: E501
-
- :param balance: The balance of this CrossMarginAccountBook. # noqa: E501
- :type: str
- """
-
- self._balance = balance
-
- @property
- def type(self):
- """Gets the type of this CrossMarginAccountBook. # noqa: E501
-
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
-
- :return: The type of this CrossMarginAccountBook. # noqa: E501
- :rtype: str
- """
- return self._type
-
- @type.setter
- def type(self, type):
- """Sets the type of this CrossMarginAccountBook.
-
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
-
- :param type: The type of this CrossMarginAccountBook. # noqa: E501
- :type: str
- """
-
- self._type = type
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginAccountBook):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginAccountBook):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/cross_margin_balance.py b/gate_api/models/cross_margin_balance.py
index b3c766a..6b9d284 100644
--- a/gate_api/models/cross_margin_balance.py
+++ b/gate_api/models/cross_margin_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -36,28 +36,18 @@ class CrossMarginBalance(object):
'available': 'str',
'freeze': 'str',
'borrowed': 'str',
- 'interest': 'str',
- 'negative_liab': 'str',
- 'futures_pos_liab': 'str',
- 'equity': 'str',
- 'total_freeze': 'str',
- 'total_liab': 'str'
+ 'interest': 'str'
}
attribute_map = {
'available': 'available',
'freeze': 'freeze',
'borrowed': 'borrowed',
- 'interest': 'interest',
- 'negative_liab': 'negative_liab',
- 'futures_pos_liab': 'futures_pos_liab',
- 'equity': 'equity',
- 'total_freeze': 'total_freeze',
- 'total_liab': 'total_liab'
+ 'interest': 'interest'
}
- def __init__(self, available=None, freeze=None, borrowed=None, interest=None, negative_liab=None, futures_pos_liab=None, equity=None, total_freeze=None, total_liab=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, available=None, freeze=None, borrowed=None, interest=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, Configuration) -> None
"""CrossMarginBalance - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -67,11 +57,6 @@ def __init__(self, available=None, freeze=None, borrowed=None, interest=None, ne
self._freeze = None
self._borrowed = None
self._interest = None
- self._negative_liab = None
- self._futures_pos_liab = None
- self._equity = None
- self._total_freeze = None
- self._total_liab = None
self.discriminator = None
if available is not None:
@@ -82,22 +67,12 @@ def __init__(self, available=None, freeze=None, borrowed=None, interest=None, ne
self.borrowed = borrowed
if interest is not None:
self.interest = interest
- if negative_liab is not None:
- self.negative_liab = negative_liab
- if futures_pos_liab is not None:
- self.futures_pos_liab = futures_pos_liab
- if equity is not None:
- self.equity = equity
- if total_freeze is not None:
- self.total_freeze = total_freeze
- if total_liab is not None:
- self.total_liab = total_liab
@property
def available(self):
"""Gets the available of this CrossMarginBalance. # noqa: E501
- Available amount # noqa: E501
+ Available balance # noqa: E501
:return: The available of this CrossMarginBalance. # noqa: E501
:rtype: str
@@ -108,7 +83,7 @@ def available(self):
def available(self, available):
"""Sets the available of this CrossMarginBalance.
- Available amount # noqa: E501
+ Available balance # noqa: E501
:param available: The available of this CrossMarginBalance. # noqa: E501
:type: str
@@ -120,7 +95,7 @@ def available(self, available):
def freeze(self):
"""Gets the freeze of this CrossMarginBalance. # noqa: E501
- Locked amount # noqa: E501
+ Locked balance # noqa: E501
:return: The freeze of this CrossMarginBalance. # noqa: E501
:rtype: str
@@ -131,7 +106,7 @@ def freeze(self):
def freeze(self, freeze):
"""Sets the freeze of this CrossMarginBalance.
- Locked amount # noqa: E501
+ Locked balance # noqa: E501
:param freeze: The freeze of this CrossMarginBalance. # noqa: E501
:type: str
@@ -143,7 +118,7 @@ def freeze(self, freeze):
def borrowed(self):
"""Gets the borrowed of this CrossMarginBalance. # noqa: E501
- Borrowed amount # noqa: E501
+ Borrowed balance # noqa: E501
:return: The borrowed of this CrossMarginBalance. # noqa: E501
:rtype: str
@@ -154,7 +129,7 @@ def borrowed(self):
def borrowed(self, borrowed):
"""Sets the borrowed of this CrossMarginBalance.
- Borrowed amount # noqa: E501
+ Borrowed balance # noqa: E501
:param borrowed: The borrowed of this CrossMarginBalance. # noqa: E501
:type: str
@@ -166,7 +141,7 @@ def borrowed(self, borrowed):
def interest(self):
"""Gets the interest of this CrossMarginBalance. # noqa: E501
- Unpaid interests # noqa: E501
+ Unpaid interest # noqa: E501
:return: The interest of this CrossMarginBalance. # noqa: E501
:rtype: str
@@ -177,7 +152,7 @@ def interest(self):
def interest(self, interest):
"""Sets the interest of this CrossMarginBalance.
- Unpaid interests # noqa: E501
+ Unpaid interest # noqa: E501
:param interest: The interest of this CrossMarginBalance. # noqa: E501
:type: str
@@ -185,121 +160,6 @@ def interest(self, interest):
self._interest = interest
- @property
- def negative_liab(self):
- """Gets the negative_liab of this CrossMarginBalance. # noqa: E501
-
- Negative Liabilities. Formula:Min[available+total+unrealized_pnl,0] # noqa: E501
-
- :return: The negative_liab of this CrossMarginBalance. # noqa: E501
- :rtype: str
- """
- return self._negative_liab
-
- @negative_liab.setter
- def negative_liab(self, negative_liab):
- """Sets the negative_liab of this CrossMarginBalance.
-
- Negative Liabilities. Formula:Min[available+total+unrealized_pnl,0] # noqa: E501
-
- :param negative_liab: The negative_liab of this CrossMarginBalance. # noqa: E501
- :type: str
- """
-
- self._negative_liab = negative_liab
-
- @property
- def futures_pos_liab(self):
- """Gets the futures_pos_liab of this CrossMarginBalance. # noqa: E501
-
- Borrowing to Open Positions in Futures # noqa: E501
-
- :return: The futures_pos_liab of this CrossMarginBalance. # noqa: E501
- :rtype: str
- """
- return self._futures_pos_liab
-
- @futures_pos_liab.setter
- def futures_pos_liab(self, futures_pos_liab):
- """Sets the futures_pos_liab of this CrossMarginBalance.
-
- Borrowing to Open Positions in Futures # noqa: E501
-
- :param futures_pos_liab: The futures_pos_liab of this CrossMarginBalance. # noqa: E501
- :type: str
- """
-
- self._futures_pos_liab = futures_pos_liab
-
- @property
- def equity(self):
- """Gets the equity of this CrossMarginBalance. # noqa: E501
-
- Equity. Formula: available + freeze - borrowed + futures account's total + unrealized_pnl # noqa: E501
-
- :return: The equity of this CrossMarginBalance. # noqa: E501
- :rtype: str
- """
- return self._equity
-
- @equity.setter
- def equity(self, equity):
- """Sets the equity of this CrossMarginBalance.
-
- Equity. Formula: available + freeze - borrowed + futures account's total + unrealized_pnl # noqa: E501
-
- :param equity: The equity of this CrossMarginBalance. # noqa: E501
- :type: str
- """
-
- self._equity = equity
-
- @property
- def total_freeze(self):
- """Gets the total_freeze of this CrossMarginBalance. # noqa: E501
-
- Total freeze. Formula: freeze + position_initial_margin + order_margin # noqa: E501
-
- :return: The total_freeze of this CrossMarginBalance. # noqa: E501
- :rtype: str
- """
- return self._total_freeze
-
- @total_freeze.setter
- def total_freeze(self, total_freeze):
- """Sets the total_freeze of this CrossMarginBalance.
-
- Total freeze. Formula: freeze + position_initial_margin + order_margin # noqa: E501
-
- :param total_freeze: The total_freeze of this CrossMarginBalance. # noqa: E501
- :type: str
- """
-
- self._total_freeze = total_freeze
-
- @property
- def total_liab(self):
- """Gets the total_liab of this CrossMarginBalance. # noqa: E501
-
- Total liabilities. Formula: Max[Abs[Min[quity - total_freeze,0], borrowed]] - futures_pos_liab # noqa: E501
-
- :return: The total_liab of this CrossMarginBalance. # noqa: E501
- :rtype: str
- """
- return self._total_liab
-
- @total_liab.setter
- def total_liab(self, total_liab):
- """Sets the total_liab of this CrossMarginBalance.
-
- Total liabilities. Formula: Max[Abs[Min[quity - total_freeze,0], borrowed]] - futures_pos_liab # noqa: E501
-
- :param total_liab: The total_liab of this CrossMarginBalance. # noqa: E501
- :type: str
- """
-
- self._total_liab = total_liab
-
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/cross_margin_balance1.py b/gate_api/models/cross_margin_balance1.py
deleted file mode 100644
index 354247d..0000000
--- a/gate_api/models/cross_margin_balance1.py
+++ /dev/null
@@ -1,207 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class CrossMarginBalance1(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'available': 'str',
- 'freeze': 'str',
- 'borrowed': 'str',
- 'interest': 'str'
- }
-
- attribute_map = {
- 'available': 'available',
- 'freeze': 'freeze',
- 'borrowed': 'borrowed',
- 'interest': 'interest'
- }
-
- def __init__(self, available=None, freeze=None, borrowed=None, interest=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, Configuration) -> None
- """CrossMarginBalance1 - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._available = None
- self._freeze = None
- self._borrowed = None
- self._interest = None
- self.discriminator = None
-
- if available is not None:
- self.available = available
- if freeze is not None:
- self.freeze = freeze
- if borrowed is not None:
- self.borrowed = borrowed
- if interest is not None:
- self.interest = interest
-
- @property
- def available(self):
- """Gets the available of this CrossMarginBalance1. # noqa: E501
-
- Available amount # noqa: E501
-
- :return: The available of this CrossMarginBalance1. # noqa: E501
- :rtype: str
- """
- return self._available
-
- @available.setter
- def available(self, available):
- """Sets the available of this CrossMarginBalance1.
-
- Available amount # noqa: E501
-
- :param available: The available of this CrossMarginBalance1. # noqa: E501
- :type: str
- """
-
- self._available = available
-
- @property
- def freeze(self):
- """Gets the freeze of this CrossMarginBalance1. # noqa: E501
-
- Locked amount # noqa: E501
-
- :return: The freeze of this CrossMarginBalance1. # noqa: E501
- :rtype: str
- """
- return self._freeze
-
- @freeze.setter
- def freeze(self, freeze):
- """Sets the freeze of this CrossMarginBalance1.
-
- Locked amount # noqa: E501
-
- :param freeze: The freeze of this CrossMarginBalance1. # noqa: E501
- :type: str
- """
-
- self._freeze = freeze
-
- @property
- def borrowed(self):
- """Gets the borrowed of this CrossMarginBalance1. # noqa: E501
-
- Borrowed amount # noqa: E501
-
- :return: The borrowed of this CrossMarginBalance1. # noqa: E501
- :rtype: str
- """
- return self._borrowed
-
- @borrowed.setter
- def borrowed(self, borrowed):
- """Sets the borrowed of this CrossMarginBalance1.
-
- Borrowed amount # noqa: E501
-
- :param borrowed: The borrowed of this CrossMarginBalance1. # noqa: E501
- :type: str
- """
-
- self._borrowed = borrowed
-
- @property
- def interest(self):
- """Gets the interest of this CrossMarginBalance1. # noqa: E501
-
- Unpaid interests # noqa: E501
-
- :return: The interest of this CrossMarginBalance1. # noqa: E501
- :rtype: str
- """
- return self._interest
-
- @interest.setter
- def interest(self, interest):
- """Sets the interest of this CrossMarginBalance1.
-
- Unpaid interests # noqa: E501
-
- :param interest: The interest of this CrossMarginBalance1. # noqa: E501
- :type: str
- """
-
- self._interest = interest
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginBalance1):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginBalance1):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/cross_margin_currency.py b/gate_api/models/cross_margin_currency.py
deleted file mode 100644
index 3b9f37a..0000000
--- a/gate_api/models/cross_margin_currency.py
+++ /dev/null
@@ -1,375 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class CrossMarginCurrency(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'name': 'str',
- 'rate': 'str',
- 'prec': 'str',
- 'discount': 'str',
- 'min_borrow_amount': 'str',
- 'user_max_borrow_amount': 'str',
- 'total_max_borrow_amount': 'str',
- 'price': 'str',
- 'loanable': 'bool',
- 'status': 'int'
- }
-
- attribute_map = {
- 'name': 'name',
- 'rate': 'rate',
- 'prec': 'prec',
- 'discount': 'discount',
- 'min_borrow_amount': 'min_borrow_amount',
- 'user_max_borrow_amount': 'user_max_borrow_amount',
- 'total_max_borrow_amount': 'total_max_borrow_amount',
- 'price': 'price',
- 'loanable': 'loanable',
- 'status': 'status'
- }
-
- def __init__(self, name=None, rate=None, prec=None, discount=None, min_borrow_amount=None, user_max_borrow_amount=None, total_max_borrow_amount=None, price=None, loanable=None, status=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, bool, int, Configuration) -> None
- """CrossMarginCurrency - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._name = None
- self._rate = None
- self._prec = None
- self._discount = None
- self._min_borrow_amount = None
- self._user_max_borrow_amount = None
- self._total_max_borrow_amount = None
- self._price = None
- self._loanable = None
- self._status = None
- self.discriminator = None
-
- if name is not None:
- self.name = name
- if rate is not None:
- self.rate = rate
- if prec is not None:
- self.prec = prec
- if discount is not None:
- self.discount = discount
- if min_borrow_amount is not None:
- self.min_borrow_amount = min_borrow_amount
- if user_max_borrow_amount is not None:
- self.user_max_borrow_amount = user_max_borrow_amount
- if total_max_borrow_amount is not None:
- self.total_max_borrow_amount = total_max_borrow_amount
- if price is not None:
- self.price = price
- if loanable is not None:
- self.loanable = loanable
- if status is not None:
- self.status = status
-
- @property
- def name(self):
- """Gets the name of this CrossMarginCurrency. # noqa: E501
-
- Currency name # noqa: E501
-
- :return: The name of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._name
-
- @name.setter
- def name(self, name):
- """Sets the name of this CrossMarginCurrency.
-
- Currency name # noqa: E501
-
- :param name: The name of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._name = name
-
- @property
- def rate(self):
- """Gets the rate of this CrossMarginCurrency. # noqa: E501
-
- Minimum lending rate (hourly rate) # noqa: E501
-
- :return: The rate of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._rate
-
- @rate.setter
- def rate(self, rate):
- """Sets the rate of this CrossMarginCurrency.
-
- Minimum lending rate (hourly rate) # noqa: E501
-
- :param rate: The rate of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._rate = rate
-
- @property
- def prec(self):
- """Gets the prec of this CrossMarginCurrency. # noqa: E501
-
- Currency precision # noqa: E501
-
- :return: The prec of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._prec
-
- @prec.setter
- def prec(self, prec):
- """Sets the prec of this CrossMarginCurrency.
-
- Currency precision # noqa: E501
-
- :param prec: The prec of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._prec = prec
-
- @property
- def discount(self):
- """Gets the discount of this CrossMarginCurrency. # noqa: E501
-
- Currency value discount, which is used in total value calculation # noqa: E501
-
- :return: The discount of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._discount
-
- @discount.setter
- def discount(self, discount):
- """Sets the discount of this CrossMarginCurrency.
-
- Currency value discount, which is used in total value calculation # noqa: E501
-
- :param discount: The discount of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._discount = discount
-
- @property
- def min_borrow_amount(self):
- """Gets the min_borrow_amount of this CrossMarginCurrency. # noqa: E501
-
- Minimum currency borrow amount. Unit is currency itself # noqa: E501
-
- :return: The min_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._min_borrow_amount
-
- @min_borrow_amount.setter
- def min_borrow_amount(self, min_borrow_amount):
- """Sets the min_borrow_amount of this CrossMarginCurrency.
-
- Minimum currency borrow amount. Unit is currency itself # noqa: E501
-
- :param min_borrow_amount: The min_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._min_borrow_amount = min_borrow_amount
-
- @property
- def user_max_borrow_amount(self):
- """Gets the user_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
-
- Maximum borrow value allowed per user, in USDT # noqa: E501
-
- :return: The user_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._user_max_borrow_amount
-
- @user_max_borrow_amount.setter
- def user_max_borrow_amount(self, user_max_borrow_amount):
- """Sets the user_max_borrow_amount of this CrossMarginCurrency.
-
- Maximum borrow value allowed per user, in USDT # noqa: E501
-
- :param user_max_borrow_amount: The user_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._user_max_borrow_amount = user_max_borrow_amount
-
- @property
- def total_max_borrow_amount(self):
- """Gets the total_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
-
- Maximum borrow value allowed for this currency, in USDT # noqa: E501
-
- :return: The total_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._total_max_borrow_amount
-
- @total_max_borrow_amount.setter
- def total_max_borrow_amount(self, total_max_borrow_amount):
- """Sets the total_max_borrow_amount of this CrossMarginCurrency.
-
- Maximum borrow value allowed for this currency, in USDT # noqa: E501
-
- :param total_max_borrow_amount: The total_max_borrow_amount of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._total_max_borrow_amount = total_max_borrow_amount
-
- @property
- def price(self):
- """Gets the price of this CrossMarginCurrency. # noqa: E501
-
- Price change between this currency and USDT # noqa: E501
-
- :return: The price of this CrossMarginCurrency. # noqa: E501
- :rtype: str
- """
- return self._price
-
- @price.setter
- def price(self, price):
- """Sets the price of this CrossMarginCurrency.
-
- Price change between this currency and USDT # noqa: E501
-
- :param price: The price of this CrossMarginCurrency. # noqa: E501
- :type: str
- """
-
- self._price = price
-
- @property
- def loanable(self):
- """Gets the loanable of this CrossMarginCurrency. # noqa: E501
-
- Whether currency is borrowed # noqa: E501
-
- :return: The loanable of this CrossMarginCurrency. # noqa: E501
- :rtype: bool
- """
- return self._loanable
-
- @loanable.setter
- def loanable(self, loanable):
- """Sets the loanable of this CrossMarginCurrency.
-
- Whether currency is borrowed # noqa: E501
-
- :param loanable: The loanable of this CrossMarginCurrency. # noqa: E501
- :type: bool
- """
-
- self._loanable = loanable
-
- @property
- def status(self):
- """Gets the status of this CrossMarginCurrency. # noqa: E501
-
- status - `0` : disable - `1` : enable # noqa: E501
-
- :return: The status of this CrossMarginCurrency. # noqa: E501
- :rtype: int
- """
- return self._status
-
- @status.setter
- def status(self, status):
- """Sets the status of this CrossMarginCurrency.
-
- status - `0` : disable - `1` : enable # noqa: E501
-
- :param status: The status of this CrossMarginCurrency. # noqa: E501
- :type: int
- """
-
- self._status = status
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginCurrency):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginCurrency):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/cross_margin_loan.py b/gate_api/models/cross_margin_loan.py
index 9a09c9e..b085e67 100644
--- a/gate_api/models/cross_margin_loan.py
+++ b/gate_api/models/cross_margin_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -317,7 +317,7 @@ def repaid_interest(self, repaid_interest):
def unpaid_interest(self):
"""Gets the unpaid_interest of this CrossMarginLoan. # noqa: E501
- Outstanding interest yet to be paid # noqa: E501
+ Unpaid interest # noqa: E501
:return: The unpaid_interest of this CrossMarginLoan. # noqa: E501
:rtype: str
@@ -328,7 +328,7 @@ def unpaid_interest(self):
def unpaid_interest(self, unpaid_interest):
"""Sets the unpaid_interest of this CrossMarginLoan.
- Outstanding interest yet to be paid # noqa: E501
+ Unpaid interest # noqa: E501
:param unpaid_interest: The unpaid_interest of this CrossMarginLoan. # noqa: E501
:type: str
diff --git a/gate_api/models/cross_margin_repayment.py b/gate_api/models/cross_margin_repayment.py
index dcbb97b..6e71d54 100644
--- a/gate_api/models/cross_margin_repayment.py
+++ b/gate_api/models/cross_margin_repayment.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -225,7 +225,7 @@ def interest(self, interest):
def repayment_type(self):
"""Gets the repayment_type of this CrossMarginRepayment. # noqa: E501
- Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation # noqa: E501
+ Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment after cancellation # noqa: E501
:return: The repayment_type of this CrossMarginRepayment. # noqa: E501
:rtype: str
@@ -236,7 +236,7 @@ def repayment_type(self):
def repayment_type(self, repayment_type):
"""Sets the repayment_type of this CrossMarginRepayment.
- Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation # noqa: E501
+ Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment after cancellation # noqa: E501
:param repayment_type: The repayment_type of this CrossMarginRepayment. # noqa: E501
:type: str
diff --git a/gate_api/models/currency.py b/gate_api/models/currency.py
index 1aff455..14789cf 100644
--- a/gate_api/models/currency.py
+++ b/gate_api/models/currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -34,34 +34,39 @@ class Currency(object):
"""
openapi_types = {
'currency': 'str',
+ 'name': 'str',
'delisted': 'bool',
'withdraw_disabled': 'bool',
'withdraw_delayed': 'bool',
'deposit_disabled': 'bool',
'trade_disabled': 'bool',
'fixed_rate': 'str',
- 'chain': 'str'
+ 'chain': 'str',
+ 'chains': 'list[SpotCurrencyChain]'
}
attribute_map = {
'currency': 'currency',
+ 'name': 'name',
'delisted': 'delisted',
'withdraw_disabled': 'withdraw_disabled',
'withdraw_delayed': 'withdraw_delayed',
'deposit_disabled': 'deposit_disabled',
'trade_disabled': 'trade_disabled',
'fixed_rate': 'fixed_rate',
- 'chain': 'chain'
+ 'chain': 'chain',
+ 'chains': 'chains'
}
- def __init__(self, currency=None, delisted=None, withdraw_disabled=None, withdraw_delayed=None, deposit_disabled=None, trade_disabled=None, fixed_rate=None, chain=None, local_vars_configuration=None): # noqa: E501
- # type: (str, bool, bool, bool, bool, bool, str, str, Configuration) -> None
+ def __init__(self, currency=None, name=None, delisted=None, withdraw_disabled=None, withdraw_delayed=None, deposit_disabled=None, trade_disabled=None, fixed_rate=None, chain=None, chains=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, bool, bool, bool, bool, bool, str, str, list[SpotCurrencyChain], Configuration) -> None
"""Currency - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
self._currency = None
+ self._name = None
self._delisted = None
self._withdraw_disabled = None
self._withdraw_delayed = None
@@ -69,10 +74,13 @@ def __init__(self, currency=None, delisted=None, withdraw_disabled=None, withdra
self._trade_disabled = None
self._fixed_rate = None
self._chain = None
+ self._chains = None
self.discriminator = None
if currency is not None:
self.currency = currency
+ if name is not None:
+ self.name = name
if delisted is not None:
self.delisted = delisted
if withdraw_disabled is not None:
@@ -87,12 +95,14 @@ def __init__(self, currency=None, delisted=None, withdraw_disabled=None, withdra
self.fixed_rate = fixed_rate
if chain is not None:
self.chain = chain
+ if chains is not None:
+ self.chains = chains
@property
def currency(self):
"""Gets the currency of this Currency. # noqa: E501
- Currency name # noqa: E501
+ Currency symbol # noqa: E501
:return: The currency of this Currency. # noqa: E501
:rtype: str
@@ -103,7 +113,7 @@ def currency(self):
def currency(self, currency):
"""Sets the currency of this Currency.
- Currency name # noqa: E501
+ Currency symbol # noqa: E501
:param currency: The currency of this Currency. # noqa: E501
:type: str
@@ -111,6 +121,29 @@ def currency(self, currency):
self._currency = currency
+ @property
+ def name(self):
+ """Gets the name of this Currency. # noqa: E501
+
+ Currency name # noqa: E501
+
+ :return: The name of this Currency. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this Currency.
+
+ Currency name # noqa: E501
+
+ :param name: The name of this Currency. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
@property
def delisted(self):
"""Gets the delisted of this Currency. # noqa: E501
@@ -138,7 +171,7 @@ def delisted(self, delisted):
def withdraw_disabled(self):
"""Gets the withdraw_disabled of this Currency. # noqa: E501
- Whether currency's withdrawal is disabled # noqa: E501
+ Whether currency's withdrawal is disabled (deprecated) # noqa: E501
:return: The withdraw_disabled of this Currency. # noqa: E501
:rtype: bool
@@ -149,7 +182,7 @@ def withdraw_disabled(self):
def withdraw_disabled(self, withdraw_disabled):
"""Sets the withdraw_disabled of this Currency.
- Whether currency's withdrawal is disabled # noqa: E501
+ Whether currency's withdrawal is disabled (deprecated) # noqa: E501
:param withdraw_disabled: The withdraw_disabled of this Currency. # noqa: E501
:type: bool
@@ -161,7 +194,7 @@ def withdraw_disabled(self, withdraw_disabled):
def withdraw_delayed(self):
"""Gets the withdraw_delayed of this Currency. # noqa: E501
- Whether currency's withdrawal is delayed # noqa: E501
+ Whether currency's withdrawal is delayed (deprecated) # noqa: E501
:return: The withdraw_delayed of this Currency. # noqa: E501
:rtype: bool
@@ -172,7 +205,7 @@ def withdraw_delayed(self):
def withdraw_delayed(self, withdraw_delayed):
"""Sets the withdraw_delayed of this Currency.
- Whether currency's withdrawal is delayed # noqa: E501
+ Whether currency's withdrawal is delayed (deprecated) # noqa: E501
:param withdraw_delayed: The withdraw_delayed of this Currency. # noqa: E501
:type: bool
@@ -184,7 +217,7 @@ def withdraw_delayed(self, withdraw_delayed):
def deposit_disabled(self):
"""Gets the deposit_disabled of this Currency. # noqa: E501
- Whether currency's deposit is disabled # noqa: E501
+ Whether currency's deposit is disabled (deprecated) # noqa: E501
:return: The deposit_disabled of this Currency. # noqa: E501
:rtype: bool
@@ -195,7 +228,7 @@ def deposit_disabled(self):
def deposit_disabled(self, deposit_disabled):
"""Sets the deposit_disabled of this Currency.
- Whether currency's deposit is disabled # noqa: E501
+ Whether currency's deposit is disabled (deprecated) # noqa: E501
:param deposit_disabled: The deposit_disabled of this Currency. # noqa: E501
:type: bool
@@ -253,7 +286,7 @@ def fixed_rate(self, fixed_rate):
def chain(self):
"""Gets the chain of this Currency. # noqa: E501
- Chain of currency # noqa: E501
+ The main chain corresponding to the coin # noqa: E501
:return: The chain of this Currency. # noqa: E501
:rtype: str
@@ -264,7 +297,7 @@ def chain(self):
def chain(self, chain):
"""Sets the chain of this Currency.
- Chain of currency # noqa: E501
+ The main chain corresponding to the coin # noqa: E501
:param chain: The chain of this Currency. # noqa: E501
:type: str
@@ -272,6 +305,29 @@ def chain(self, chain):
self._chain = chain
+ @property
+ def chains(self):
+ """Gets the chains of this Currency. # noqa: E501
+
+ All links corresponding to coins # noqa: E501
+
+ :return: The chains of this Currency. # noqa: E501
+ :rtype: list[SpotCurrencyChain]
+ """
+ return self._chains
+
+ @chains.setter
+ def chains(self, chains):
+ """Sets the chains of this Currency.
+
+ All links corresponding to coins # noqa: E501
+
+ :param chains: The chains of this Currency. # noqa: E501
+ :type: list[SpotCurrencyChain]
+ """
+
+ self._chains = chains
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/currency_chain.py b/gate_api/models/currency_chain.py
index 1f4eb6d..5feb14f 100644
--- a/gate_api/models/currency_chain.py
+++ b/gate_api/models/currency_chain.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -207,7 +207,7 @@ def is_disabled(self, is_disabled):
def is_deposit_disabled(self):
"""Gets the is_deposit_disabled of this CurrencyChain. # noqa: E501
- Is deposit disabled. 0 means not # noqa: E501
+ Is deposit disabled. 0 means not disabled # noqa: E501
:return: The is_deposit_disabled of this CurrencyChain. # noqa: E501
:rtype: int
@@ -218,7 +218,7 @@ def is_deposit_disabled(self):
def is_deposit_disabled(self, is_deposit_disabled):
"""Sets the is_deposit_disabled of this CurrencyChain.
- Is deposit disabled. 0 means not # noqa: E501
+ Is deposit disabled. 0 means not disabled # noqa: E501
:param is_deposit_disabled: The is_deposit_disabled of this CurrencyChain. # noqa: E501
:type: int
@@ -230,7 +230,7 @@ def is_deposit_disabled(self, is_deposit_disabled):
def is_withdraw_disabled(self):
"""Gets the is_withdraw_disabled of this CurrencyChain. # noqa: E501
- Is withdrawal disabled. 0 means not # noqa: E501
+ Is withdrawal disabled. 0 means not disabled # noqa: E501
:return: The is_withdraw_disabled of this CurrencyChain. # noqa: E501
:rtype: int
@@ -241,7 +241,7 @@ def is_withdraw_disabled(self):
def is_withdraw_disabled(self, is_withdraw_disabled):
"""Sets the is_withdraw_disabled of this CurrencyChain.
- Is withdrawal disabled. 0 means not # noqa: E501
+ Is withdrawal disabled. 0 means not disabled # noqa: E501
:param is_withdraw_disabled: The is_withdraw_disabled of this CurrencyChain. # noqa: E501
:type: int
diff --git a/gate_api/models/currency_pair.py b/gate_api/models/currency_pair.py
index 9c24a3b..26e7959 100644
--- a/gate_api/models/currency_pair.py
+++ b/gate_api/models/currency_pair.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -35,7 +35,9 @@ class CurrencyPair(object):
openapi_types = {
'id': 'str',
'base': 'str',
+ 'base_name': 'str',
'quote': 'str',
+ 'quote_name': 'str',
'fee': 'str',
'min_base_amount': 'str',
'min_quote_amount': 'str',
@@ -45,13 +47,19 @@ class CurrencyPair(object):
'precision': 'int',
'trade_status': 'str',
'sell_start': 'int',
- 'buy_start': 'int'
+ 'buy_start': 'int',
+ 'delisting_time': 'int',
+ 'type': 'str',
+ 'trade_url': 'str',
+ 'st_tag': 'bool'
}
attribute_map = {
'id': 'id',
'base': 'base',
+ 'base_name': 'base_name',
'quote': 'quote',
+ 'quote_name': 'quote_name',
'fee': 'fee',
'min_base_amount': 'min_base_amount',
'min_quote_amount': 'min_quote_amount',
@@ -61,11 +69,15 @@ class CurrencyPair(object):
'precision': 'precision',
'trade_status': 'trade_status',
'sell_start': 'sell_start',
- 'buy_start': 'buy_start'
+ 'buy_start': 'buy_start',
+ 'delisting_time': 'delisting_time',
+ 'type': 'type',
+ 'trade_url': 'trade_url',
+ 'st_tag': 'st_tag'
}
- def __init__(self, id=None, base=None, quote=None, fee=None, min_base_amount=None, min_quote_amount=None, max_base_amount=None, max_quote_amount=None, amount_precision=None, precision=None, trade_status=None, sell_start=None, buy_start=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, int, int, str, int, int, Configuration) -> None
+ def __init__(self, id=None, base=None, base_name=None, quote=None, quote_name=None, fee=None, min_base_amount=None, min_quote_amount=None, max_base_amount=None, max_quote_amount=None, amount_precision=None, precision=None, trade_status=None, sell_start=None, buy_start=None, delisting_time=None, type=None, trade_url=None, st_tag=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, int, int, str, int, int, int, str, str, bool, Configuration) -> None
"""CurrencyPair - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -73,7 +85,9 @@ def __init__(self, id=None, base=None, quote=None, fee=None, min_base_amount=Non
self._id = None
self._base = None
+ self._base_name = None
self._quote = None
+ self._quote_name = None
self._fee = None
self._min_base_amount = None
self._min_quote_amount = None
@@ -84,14 +98,22 @@ def __init__(self, id=None, base=None, quote=None, fee=None, min_base_amount=Non
self._trade_status = None
self._sell_start = None
self._buy_start = None
+ self._delisting_time = None
+ self._type = None
+ self._trade_url = None
+ self._st_tag = None
self.discriminator = None
if id is not None:
self.id = id
if base is not None:
self.base = base
+ if base_name is not None:
+ self.base_name = base_name
if quote is not None:
self.quote = quote
+ if quote_name is not None:
+ self.quote_name = quote_name
if fee is not None:
self.fee = fee
if min_base_amount is not None:
@@ -112,6 +134,14 @@ def __init__(self, id=None, base=None, quote=None, fee=None, min_base_amount=Non
self.sell_start = sell_start
if buy_start is not None:
self.buy_start = buy_start
+ if delisting_time is not None:
+ self.delisting_time = delisting_time
+ if type is not None:
+ self.type = type
+ if trade_url is not None:
+ self.trade_url = trade_url
+ if st_tag is not None:
+ self.st_tag = st_tag
@property
def id(self):
@@ -159,6 +189,29 @@ def base(self, base):
self._base = base
+ @property
+ def base_name(self):
+ """Gets the base_name of this CurrencyPair. # noqa: E501
+
+ Base currency name # noqa: E501
+
+ :return: The base_name of this CurrencyPair. # noqa: E501
+ :rtype: str
+ """
+ return self._base_name
+
+ @base_name.setter
+ def base_name(self, base_name):
+ """Sets the base_name of this CurrencyPair.
+
+ Base currency name # noqa: E501
+
+ :param base_name: The base_name of this CurrencyPair. # noqa: E501
+ :type: str
+ """
+
+ self._base_name = base_name
+
@property
def quote(self):
"""Gets the quote of this CurrencyPair. # noqa: E501
@@ -182,11 +235,34 @@ def quote(self, quote):
self._quote = quote
+ @property
+ def quote_name(self):
+ """Gets the quote_name of this CurrencyPair. # noqa: E501
+
+ Quote currency name # noqa: E501
+
+ :return: The quote_name of this CurrencyPair. # noqa: E501
+ :rtype: str
+ """
+ return self._quote_name
+
+ @quote_name.setter
+ def quote_name(self, quote_name):
+ """Sets the quote_name of this CurrencyPair.
+
+ Quote currency name # noqa: E501
+
+ :param quote_name: The quote_name of this CurrencyPair. # noqa: E501
+ :type: str
+ """
+
+ self._quote_name = quote_name
+
@property
def fee(self):
"""Gets the fee of this CurrencyPair. # noqa: E501
- Trading fee # noqa: E501
+ Trading fee rate # noqa: E501
:return: The fee of this CurrencyPair. # noqa: E501
:rtype: str
@@ -197,7 +273,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this CurrencyPair.
- Trading fee # noqa: E501
+ Trading fee rate # noqa: E501
:param fee: The fee of this CurrencyPair. # noqa: E501
:type: str
@@ -347,7 +423,7 @@ def precision(self, precision):
def trade_status(self):
"""Gets the trade_status of this CurrencyPair. # noqa: E501
- 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 # noqa: E501
+ Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold # noqa: E501
:return: The trade_status of this CurrencyPair. # noqa: E501
:rtype: str
@@ -358,7 +434,7 @@ def trade_status(self):
def trade_status(self, trade_status):
"""Sets the trade_status of this CurrencyPair.
- 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 # noqa: E501
+ Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold # noqa: E501
:param trade_status: The trade_status of this CurrencyPair. # noqa: E501
:type: str
@@ -418,6 +494,98 @@ def buy_start(self, buy_start):
self._buy_start = buy_start
+ @property
+ def delisting_time(self):
+ """Gets the delisting_time of this CurrencyPair. # noqa: E501
+
+ Expected time to remove the shelves, Unix timestamp in seconds # noqa: E501
+
+ :return: The delisting_time of this CurrencyPair. # noqa: E501
+ :rtype: int
+ """
+ return self._delisting_time
+
+ @delisting_time.setter
+ def delisting_time(self, delisting_time):
+ """Sets the delisting_time of this CurrencyPair.
+
+ Expected time to remove the shelves, Unix timestamp in seconds # noqa: E501
+
+ :param delisting_time: The delisting_time of this CurrencyPair. # noqa: E501
+ :type: int
+ """
+
+ self._delisting_time = delisting_time
+
+ @property
+ def type(self):
+ """Gets the type of this CurrencyPair. # noqa: E501
+
+ Trading pair type, normal: normal, premarket: pre-market # noqa: E501
+
+ :return: The type of this CurrencyPair. # noqa: E501
+ :rtype: str
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this CurrencyPair.
+
+ Trading pair type, normal: normal, premarket: pre-market # noqa: E501
+
+ :param type: The type of this CurrencyPair. # noqa: E501
+ :type: str
+ """
+
+ self._type = type
+
+ @property
+ def trade_url(self):
+ """Gets the trade_url of this CurrencyPair. # noqa: E501
+
+ Transaction link # noqa: E501
+
+ :return: The trade_url of this CurrencyPair. # noqa: E501
+ :rtype: str
+ """
+ return self._trade_url
+
+ @trade_url.setter
+ def trade_url(self, trade_url):
+ """Sets the trade_url of this CurrencyPair.
+
+ Transaction link # noqa: E501
+
+ :param trade_url: The trade_url of this CurrencyPair. # noqa: E501
+ :type: str
+ """
+
+ self._trade_url = trade_url
+
+ @property
+ def st_tag(self):
+ """Gets the st_tag of this CurrencyPair. # noqa: E501
+
+ Whether the trading pair is in ST risk assessment, false - No, true - Yes # noqa: E501
+
+ :return: The st_tag of this CurrencyPair. # noqa: E501
+ :rtype: bool
+ """
+ return self._st_tag
+
+ @st_tag.setter
+ def st_tag(self, st_tag):
+ """Sets the st_tag of this CurrencyPair.
+
+ Whether the trading pair is in ST risk assessment, false - No, true - Yes # noqa: E501
+
+ :param st_tag: The st_tag of this CurrencyPair. # noqa: E501
+ :type: bool
+ """
+
+ self._st_tag = st_tag
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/currency_quota.py b/gate_api/models/currency_quota.py
index 58a945d..3ebee02 100644
--- a/gate_api/models/currency_quota.py
+++ b/gate_api/models/currency_quota.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -123,7 +123,7 @@ def index_price(self, index_price):
def min_quota(self):
"""Gets the min_quota of this CurrencyQuota. # noqa: E501
- Minimum borrowing/collateral quota for the currency # noqa: E501
+ Minimum borrowing/collateral limit for the currency # noqa: E501
:return: The min_quota of this CurrencyQuota. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def min_quota(self):
def min_quota(self, min_quota):
"""Sets the min_quota of this CurrencyQuota.
- Minimum borrowing/collateral quota for the currency # noqa: E501
+ Minimum borrowing/collateral limit for the currency # noqa: E501
:param min_quota: The min_quota of this CurrencyQuota. # noqa: E501
:type: str
@@ -146,7 +146,7 @@ def min_quota(self, min_quota):
def left_quota(self):
"""Gets the left_quota of this CurrencyQuota. # noqa: E501
- Remaining borrowing/collateral limit for the currency # noqa: E501
+ Remaining borrowing/collateral quota for the currency # noqa: E501
:return: The left_quota of this CurrencyQuota. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def left_quota(self):
def left_quota(self, left_quota):
"""Sets the left_quota of this CurrencyQuota.
- Remaining borrowing/collateral limit for the currency # noqa: E501
+ Remaining borrowing/collateral quota for the currency # noqa: E501
:param left_quota: The left_quota of this CurrencyQuota. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_mode.py b/gate_api/models/debit_fee.py
similarity index 59%
rename from gate_api/models/unified_mode.py
rename to gate_api/models/debit_fee.py
index 4d4d123..d563fe2 100644
--- a/gate_api/models/unified_mode.py
+++ b/gate_api/models/debit_fee.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class UnifiedMode(object):
+class DebitFee(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -33,72 +33,43 @@ class UnifiedMode(object):
and the value is json key in definition.
"""
openapi_types = {
- 'mode': 'str',
'enabled': 'bool'
}
attribute_map = {
- 'mode': 'mode',
'enabled': 'enabled'
}
- def __init__(self, mode=None, enabled=None, local_vars_configuration=None): # noqa: E501
- # type: (str, bool, Configuration) -> None
- """UnifiedMode - a model defined in OpenAPI""" # noqa: E501
+ def __init__(self, enabled=None, local_vars_configuration=None): # noqa: E501
+ # type: (bool, Configuration) -> None
+ """DebitFee - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._mode = None
self._enabled = None
self.discriminator = None
- self.mode = mode
self.enabled = enabled
- @property
- def mode(self):
- """Gets the mode of this UnifiedMode. # noqa: E501
-
- Portfolio mode - cross_margin : cross margin - usdt_futures : usdt futures # noqa: E501
-
- :return: The mode of this UnifiedMode. # noqa: E501
- :rtype: str
- """
- return self._mode
-
- @mode.setter
- def mode(self, mode):
- """Sets the mode of this UnifiedMode.
-
- Portfolio mode - cross_margin : cross margin - usdt_futures : usdt futures # noqa: E501
-
- :param mode: The mode of this UnifiedMode. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and mode is None: # noqa: E501
- raise ValueError("Invalid value for `mode`, must not be `None`") # noqa: E501
-
- self._mode = mode
-
@property
def enabled(self):
- """Gets the enabled of this UnifiedMode. # noqa: E501
+ """Gets the enabled of this DebitFee. # noqa: E501
- Is it enabled? # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
- :return: The enabled of this UnifiedMode. # noqa: E501
+ :return: The enabled of this DebitFee. # noqa: E501
:rtype: bool
"""
return self._enabled
@enabled.setter
def enabled(self, enabled):
- """Sets the enabled of this UnifiedMode.
+ """Sets the enabled of this DebitFee.
- Is it enabled? # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
- :param enabled: The enabled of this UnifiedMode. # noqa: E501
+ :param enabled: The enabled of this DebitFee. # noqa: E501
:type: bool
"""
if self.local_vars_configuration.client_side_validation and enabled is None: # noqa: E501
@@ -140,14 +111,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, UnifiedMode):
+ if not isinstance(other, DebitFee):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, UnifiedMode):
+ if not isinstance(other, DebitFee):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/delivery_candlestick.py b/gate_api/models/delivery_candlestick.py
index 8bbd1ba..83355ce 100644
--- a/gate_api/models/delivery_candlestick.py
+++ b/gate_api/models/delivery_candlestick.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/delivery_contract.py b/gate_api/models/delivery_contract.py
index ee2632c..57b228c 100644
--- a/gate_api/models/delivery_contract.py
+++ b/gate_api/models/delivery_contract.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -317,7 +317,7 @@ def cycle(self, cycle):
def type(self):
"""Gets the type of this DeliveryContract. # noqa: E501
- Futures contract type # noqa: E501
+ Contract type: inverse - inverse contract, direct - direct contract # noqa: E501
:return: The type of this DeliveryContract. # noqa: E501
:rtype: str
@@ -328,7 +328,7 @@ def type(self):
def type(self, type):
"""Sets the type of this DeliveryContract.
- Futures contract type # noqa: E501
+ Contract type: inverse - inverse contract, direct - direct contract # noqa: E501
:param type: The type of this DeliveryContract. # noqa: E501
:type: str
@@ -438,7 +438,7 @@ def maintenance_rate(self, maintenance_rate):
def mark_type(self):
"""Gets the mark_type of this DeliveryContract. # noqa: E501
- Mark price type, internal - based on internal trading, index - based on external index price # noqa: E501
+ Mark price type: internal - internal trading price, index - external index price # noqa: E501
:return: The mark_type of this DeliveryContract. # noqa: E501
:rtype: str
@@ -449,7 +449,7 @@ def mark_type(self):
def mark_type(self, mark_type):
"""Sets the mark_type of this DeliveryContract.
- Mark price type, internal - based on internal trading, index - based on external index price # noqa: E501
+ Mark price type: internal - internal trading price, index - external index price # noqa: E501
:param mark_type: The mark_type of this DeliveryContract. # noqa: E501
:type: str
@@ -536,7 +536,7 @@ def last_price(self, last_price):
def maker_fee_rate(self):
"""Gets the maker_fee_rate of this DeliveryContract. # noqa: E501
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:return: The maker_fee_rate of this DeliveryContract. # noqa: E501
:rtype: str
@@ -547,7 +547,7 @@ def maker_fee_rate(self):
def maker_fee_rate(self, maker_fee_rate):
"""Sets the maker_fee_rate of this DeliveryContract.
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:param maker_fee_rate: The maker_fee_rate of this DeliveryContract. # noqa: E501
:type: str
@@ -858,7 +858,7 @@ def risk_limit_max(self, risk_limit_max):
def order_size_min(self):
"""Gets the order_size_min of this DeliveryContract. # noqa: E501
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:return: The order_size_min of this DeliveryContract. # noqa: E501
:rtype: int
@@ -869,7 +869,7 @@ def order_size_min(self):
def order_size_min(self, order_size_min):
"""Sets the order_size_min of this DeliveryContract.
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:param order_size_min: The order_size_min of this DeliveryContract. # noqa: E501
:type: int
@@ -881,7 +881,7 @@ def order_size_min(self, order_size_min):
def order_size_max(self):
"""Gets the order_size_max of this DeliveryContract. # noqa: E501
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:return: The order_size_max of this DeliveryContract. # noqa: E501
:rtype: int
@@ -892,7 +892,7 @@ def order_size_max(self):
def order_size_max(self, order_size_max):
"""Sets the order_size_max of this DeliveryContract.
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:param order_size_max: The order_size_max of this DeliveryContract. # noqa: E501
:type: int
@@ -904,7 +904,7 @@ def order_size_max(self, order_size_max):
def order_price_deviate(self):
"""Gets the order_price_deviate of this DeliveryContract. # noqa: E501
- 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 # noqa: E501
+ Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate # noqa: E501
:return: The order_price_deviate of this DeliveryContract. # noqa: E501
:rtype: str
@@ -915,7 +915,7 @@ def order_price_deviate(self):
def order_price_deviate(self, order_price_deviate):
"""Sets the order_price_deviate of this DeliveryContract.
- 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 # noqa: E501
+ Maximum allowed deviation between order price and current mark price. The order price `order_price` must satisfy the following condition: abs(order_price - mark_price) <= mark_price * order_price_deviate # noqa: E501
:param order_price_deviate: The order_price_deviate of this DeliveryContract. # noqa: E501
:type: str
@@ -927,7 +927,7 @@ def order_price_deviate(self, order_price_deviate):
def ref_discount_rate(self):
"""Gets the ref_discount_rate of this DeliveryContract. # noqa: E501
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:return: The ref_discount_rate of this DeliveryContract. # noqa: E501
:rtype: str
@@ -938,7 +938,7 @@ def ref_discount_rate(self):
def ref_discount_rate(self, ref_discount_rate):
"""Sets the ref_discount_rate of this DeliveryContract.
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:param ref_discount_rate: The ref_discount_rate of this DeliveryContract. # noqa: E501
:type: str
@@ -950,7 +950,7 @@ def ref_discount_rate(self, ref_discount_rate):
def ref_rebate_rate(self):
"""Gets the ref_rebate_rate of this DeliveryContract. # noqa: E501
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:return: The ref_rebate_rate of this DeliveryContract. # noqa: E501
:rtype: str
@@ -961,7 +961,7 @@ def ref_rebate_rate(self):
def ref_rebate_rate(self, ref_rebate_rate):
"""Sets the ref_rebate_rate of this DeliveryContract.
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:param ref_rebate_rate: The ref_rebate_rate of this DeliveryContract. # noqa: E501
:type: str
@@ -973,7 +973,7 @@ def ref_rebate_rate(self, ref_rebate_rate):
def orderbook_id(self):
"""Gets the orderbook_id of this DeliveryContract. # noqa: E501
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:return: The orderbook_id of this DeliveryContract. # noqa: E501
:rtype: int
@@ -984,7 +984,7 @@ def orderbook_id(self):
def orderbook_id(self, orderbook_id):
"""Sets the orderbook_id of this DeliveryContract.
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:param orderbook_id: The orderbook_id of this DeliveryContract. # noqa: E501
:type: int
@@ -1019,7 +1019,7 @@ def trade_id(self, trade_id):
def trade_size(self):
"""Gets the trade_size of this DeliveryContract. # noqa: E501
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:return: The trade_size of this DeliveryContract. # noqa: E501
:rtype: int
@@ -1030,7 +1030,7 @@ def trade_size(self):
def trade_size(self, trade_size):
"""Sets the trade_size of this DeliveryContract.
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:param trade_size: The trade_size of this DeliveryContract. # noqa: E501
:type: int
@@ -1065,7 +1065,7 @@ def position_size(self, position_size):
def config_change_time(self):
"""Gets the config_change_time of this DeliveryContract. # noqa: E501
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:return: The config_change_time of this DeliveryContract. # noqa: E501
:rtype: float
@@ -1076,7 +1076,7 @@ def config_change_time(self):
def config_change_time(self, config_change_time):
"""Sets the config_change_time of this DeliveryContract.
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:param config_change_time: The config_change_time of this DeliveryContract. # noqa: E501
:type: float
@@ -1111,7 +1111,7 @@ def in_delisting(self, in_delisting):
def orders_limit(self):
"""Gets the orders_limit of this DeliveryContract. # noqa: E501
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:return: The orders_limit of this DeliveryContract. # noqa: E501
:rtype: int
@@ -1122,7 +1122,7 @@ def orders_limit(self):
def orders_limit(self, orders_limit):
"""Sets the orders_limit of this DeliveryContract.
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:param orders_limit: The orders_limit of this DeliveryContract. # noqa: E501
:type: int
diff --git a/gate_api/models/delivery_settlement.py b/gate_api/models/delivery_settlement.py
index bc01b64..1985a9b 100644
--- a/gate_api/models/delivery_settlement.py
+++ b/gate_api/models/delivery_settlement.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/delivery_ticker.py b/gate_api/models/delivery_ticker.py
new file mode 100644
index 0000000..9cf1203
--- /dev/null
+++ b/gate_api/models/delivery_ticker.py
@@ -0,0 +1,739 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class DeliveryTicker(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'contract': 'str',
+ 'last': 'str',
+ 'change_percentage': 'str',
+ 'total_size': 'str',
+ 'low_24h': 'str',
+ 'high_24h': 'str',
+ 'volume_24h': 'str',
+ 'volume_24h_btc': 'str',
+ 'volume_24h_usd': 'str',
+ 'volume_24h_base': 'str',
+ 'volume_24h_quote': 'str',
+ 'volume_24h_settle': 'str',
+ 'mark_price': 'str',
+ 'funding_rate': 'str',
+ 'funding_rate_indicative': 'str',
+ 'index_price': 'str',
+ 'quanto_base_rate': 'str',
+ 'basis_rate': 'str',
+ 'basis_value': 'str',
+ 'lowest_ask': 'str',
+ 'lowest_size': 'str',
+ 'highest_bid': 'str',
+ 'highest_size': 'str'
+ }
+
+ attribute_map = {
+ 'contract': 'contract',
+ 'last': 'last',
+ 'change_percentage': 'change_percentage',
+ 'total_size': 'total_size',
+ 'low_24h': 'low_24h',
+ 'high_24h': 'high_24h',
+ 'volume_24h': 'volume_24h',
+ 'volume_24h_btc': 'volume_24h_btc',
+ 'volume_24h_usd': 'volume_24h_usd',
+ 'volume_24h_base': 'volume_24h_base',
+ 'volume_24h_quote': 'volume_24h_quote',
+ 'volume_24h_settle': 'volume_24h_settle',
+ 'mark_price': 'mark_price',
+ 'funding_rate': 'funding_rate',
+ 'funding_rate_indicative': 'funding_rate_indicative',
+ 'index_price': 'index_price',
+ 'quanto_base_rate': 'quanto_base_rate',
+ 'basis_rate': 'basis_rate',
+ 'basis_value': 'basis_value',
+ 'lowest_ask': 'lowest_ask',
+ 'lowest_size': 'lowest_size',
+ 'highest_bid': 'highest_bid',
+ 'highest_size': 'highest_size'
+ }
+
+ def __init__(self, contract=None, last=None, change_percentage=None, total_size=None, low_24h=None, high_24h=None, volume_24h=None, volume_24h_btc=None, volume_24h_usd=None, volume_24h_base=None, volume_24h_quote=None, volume_24h_settle=None, mark_price=None, funding_rate=None, funding_rate_indicative=None, index_price=None, quanto_base_rate=None, basis_rate=None, basis_value=None, lowest_ask=None, lowest_size=None, highest_bid=None, highest_size=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ """DeliveryTicker - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._contract = None
+ self._last = None
+ self._change_percentage = None
+ self._total_size = None
+ self._low_24h = None
+ self._high_24h = None
+ self._volume_24h = None
+ self._volume_24h_btc = None
+ self._volume_24h_usd = None
+ self._volume_24h_base = None
+ self._volume_24h_quote = None
+ self._volume_24h_settle = None
+ self._mark_price = None
+ self._funding_rate = None
+ self._funding_rate_indicative = None
+ self._index_price = None
+ self._quanto_base_rate = None
+ self._basis_rate = None
+ self._basis_value = None
+ self._lowest_ask = None
+ self._lowest_size = None
+ self._highest_bid = None
+ self._highest_size = None
+ self.discriminator = None
+
+ if contract is not None:
+ self.contract = contract
+ if last is not None:
+ self.last = last
+ if change_percentage is not None:
+ self.change_percentage = change_percentage
+ if total_size is not None:
+ self.total_size = total_size
+ if low_24h is not None:
+ self.low_24h = low_24h
+ if high_24h is not None:
+ self.high_24h = high_24h
+ if volume_24h is not None:
+ self.volume_24h = volume_24h
+ if volume_24h_btc is not None:
+ self.volume_24h_btc = volume_24h_btc
+ if volume_24h_usd is not None:
+ self.volume_24h_usd = volume_24h_usd
+ if volume_24h_base is not None:
+ self.volume_24h_base = volume_24h_base
+ if volume_24h_quote is not None:
+ self.volume_24h_quote = volume_24h_quote
+ if volume_24h_settle is not None:
+ self.volume_24h_settle = volume_24h_settle
+ if mark_price is not None:
+ self.mark_price = mark_price
+ if funding_rate is not None:
+ self.funding_rate = funding_rate
+ if funding_rate_indicative is not None:
+ self.funding_rate_indicative = funding_rate_indicative
+ if index_price is not None:
+ self.index_price = index_price
+ if quanto_base_rate is not None:
+ self.quanto_base_rate = quanto_base_rate
+ if basis_rate is not None:
+ self.basis_rate = basis_rate
+ if basis_value is not None:
+ self.basis_value = basis_value
+ if lowest_ask is not None:
+ self.lowest_ask = lowest_ask
+ if lowest_size is not None:
+ self.lowest_size = lowest_size
+ if highest_bid is not None:
+ self.highest_bid = highest_bid
+ if highest_size is not None:
+ self.highest_size = highest_size
+
+ @property
+ def contract(self):
+ """Gets the contract of this DeliveryTicker. # noqa: E501
+
+ Futures contract # noqa: E501
+
+ :return: The contract of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._contract
+
+ @contract.setter
+ def contract(self, contract):
+ """Sets the contract of this DeliveryTicker.
+
+ Futures contract # noqa: E501
+
+ :param contract: The contract of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._contract = contract
+
+ @property
+ def last(self):
+ """Gets the last of this DeliveryTicker. # noqa: E501
+
+ Last trading price # noqa: E501
+
+ :return: The last of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._last
+
+ @last.setter
+ def last(self, last):
+ """Sets the last of this DeliveryTicker.
+
+ Last trading price # noqa: E501
+
+ :param last: The last of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._last = last
+
+ @property
+ def change_percentage(self):
+ """Gets the change_percentage of this DeliveryTicker. # noqa: E501
+
+ Price change percentage. Negative values indicate price decrease, e.g. -7.45 # noqa: E501
+
+ :return: The change_percentage of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_percentage
+
+ @change_percentage.setter
+ def change_percentage(self, change_percentage):
+ """Sets the change_percentage of this DeliveryTicker.
+
+ Price change percentage. Negative values indicate price decrease, e.g. -7.45 # noqa: E501
+
+ :param change_percentage: The change_percentage of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_percentage = change_percentage
+
+ @property
+ def total_size(self):
+ """Gets the total_size of this DeliveryTicker. # noqa: E501
+
+ Contract total size # noqa: E501
+
+ :return: The total_size of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._total_size
+
+ @total_size.setter
+ def total_size(self, total_size):
+ """Sets the total_size of this DeliveryTicker.
+
+ Contract total size # noqa: E501
+
+ :param total_size: The total_size of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._total_size = total_size
+
+ @property
+ def low_24h(self):
+ """Gets the low_24h of this DeliveryTicker. # noqa: E501
+
+ 24-hour lowest price # noqa: E501
+
+ :return: The low_24h of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._low_24h
+
+ @low_24h.setter
+ def low_24h(self, low_24h):
+ """Sets the low_24h of this DeliveryTicker.
+
+ 24-hour lowest price # noqa: E501
+
+ :param low_24h: The low_24h of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._low_24h = low_24h
+
+ @property
+ def high_24h(self):
+ """Gets the high_24h of this DeliveryTicker. # noqa: E501
+
+ 24-hour highest price # noqa: E501
+
+ :return: The high_24h of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._high_24h
+
+ @high_24h.setter
+ def high_24h(self, high_24h):
+ """Sets the high_24h of this DeliveryTicker.
+
+ 24-hour highest price # noqa: E501
+
+ :param high_24h: The high_24h of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._high_24h = high_24h
+
+ @property
+ def volume_24h(self):
+ """Gets the volume_24h of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume # noqa: E501
+
+ :return: The volume_24h of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h
+
+ @volume_24h.setter
+ def volume_24h(self, volume_24h):
+ """Sets the volume_24h of this DeliveryTicker.
+
+ 24-hour trading volume # noqa: E501
+
+ :param volume_24h: The volume_24h of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h = volume_24h
+
+ @property
+ def volume_24h_btc(self):
+ """Gets the volume_24h_btc of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+
+ :return: The volume_24h_btc of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h_btc
+
+ @volume_24h_btc.setter
+ def volume_24h_btc(self, volume_24h_btc):
+ """Sets the volume_24h_btc of this DeliveryTicker.
+
+ 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+
+ :param volume_24h_btc: The volume_24h_btc of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h_btc = volume_24h_btc
+
+ @property
+ def volume_24h_usd(self):
+ """Gets the volume_24h_usd of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+
+ :return: The volume_24h_usd of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h_usd
+
+ @volume_24h_usd.setter
+ def volume_24h_usd(self, volume_24h_usd):
+ """Sets the volume_24h_usd of this DeliveryTicker.
+
+ 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+
+ :param volume_24h_usd: The volume_24h_usd of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h_usd = volume_24h_usd
+
+ @property
+ def volume_24h_base(self):
+ """Gets the volume_24h_base of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume in base currency # noqa: E501
+
+ :return: The volume_24h_base of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h_base
+
+ @volume_24h_base.setter
+ def volume_24h_base(self, volume_24h_base):
+ """Sets the volume_24h_base of this DeliveryTicker.
+
+ 24-hour trading volume in base currency # noqa: E501
+
+ :param volume_24h_base: The volume_24h_base of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h_base = volume_24h_base
+
+ @property
+ def volume_24h_quote(self):
+ """Gets the volume_24h_quote of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume in quote currency # noqa: E501
+
+ :return: The volume_24h_quote of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h_quote
+
+ @volume_24h_quote.setter
+ def volume_24h_quote(self, volume_24h_quote):
+ """Sets the volume_24h_quote of this DeliveryTicker.
+
+ 24-hour trading volume in quote currency # noqa: E501
+
+ :param volume_24h_quote: The volume_24h_quote of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h_quote = volume_24h_quote
+
+ @property
+ def volume_24h_settle(self):
+ """Gets the volume_24h_settle of this DeliveryTicker. # noqa: E501
+
+ 24-hour trading volume in settle currency # noqa: E501
+
+ :return: The volume_24h_settle of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._volume_24h_settle
+
+ @volume_24h_settle.setter
+ def volume_24h_settle(self, volume_24h_settle):
+ """Sets the volume_24h_settle of this DeliveryTicker.
+
+ 24-hour trading volume in settle currency # noqa: E501
+
+ :param volume_24h_settle: The volume_24h_settle of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._volume_24h_settle = volume_24h_settle
+
+ @property
+ def mark_price(self):
+ """Gets the mark_price of this DeliveryTicker. # noqa: E501
+
+ Recent mark price # noqa: E501
+
+ :return: The mark_price of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._mark_price
+
+ @mark_price.setter
+ def mark_price(self, mark_price):
+ """Sets the mark_price of this DeliveryTicker.
+
+ Recent mark price # noqa: E501
+
+ :param mark_price: The mark_price of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._mark_price = mark_price
+
+ @property
+ def funding_rate(self):
+ """Gets the funding_rate of this DeliveryTicker. # noqa: E501
+
+ Funding rate # noqa: E501
+
+ :return: The funding_rate of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._funding_rate
+
+ @funding_rate.setter
+ def funding_rate(self, funding_rate):
+ """Sets the funding_rate of this DeliveryTicker.
+
+ Funding rate # noqa: E501
+
+ :param funding_rate: The funding_rate of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._funding_rate = funding_rate
+
+ @property
+ def funding_rate_indicative(self):
+ """Gets the funding_rate_indicative of this DeliveryTicker. # noqa: E501
+
+ Indicative Funding rate in next period. (deprecated. use `funding_rate`) # noqa: E501
+
+ :return: The funding_rate_indicative of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._funding_rate_indicative
+
+ @funding_rate_indicative.setter
+ def funding_rate_indicative(self, funding_rate_indicative):
+ """Sets the funding_rate_indicative of this DeliveryTicker.
+
+ Indicative Funding rate in next period. (deprecated. use `funding_rate`) # noqa: E501
+
+ :param funding_rate_indicative: The funding_rate_indicative of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._funding_rate_indicative = funding_rate_indicative
+
+ @property
+ def index_price(self):
+ """Gets the index_price of this DeliveryTicker. # noqa: E501
+
+ Index price # noqa: E501
+
+ :return: The index_price of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._index_price
+
+ @index_price.setter
+ def index_price(self, index_price):
+ """Sets the index_price of this DeliveryTicker.
+
+ Index price # noqa: E501
+
+ :param index_price: The index_price of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._index_price = index_price
+
+ @property
+ def quanto_base_rate(self):
+ """Gets the quanto_base_rate of this DeliveryTicker. # noqa: E501
+
+ Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types # noqa: E501
+
+ :return: The quanto_base_rate of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._quanto_base_rate
+
+ @quanto_base_rate.setter
+ def quanto_base_rate(self, quanto_base_rate):
+ """Sets the quanto_base_rate of this DeliveryTicker.
+
+ Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types # noqa: E501
+
+ :param quanto_base_rate: The quanto_base_rate of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._quanto_base_rate = quanto_base_rate
+
+ @property
+ def basis_rate(self):
+ """Gets the basis_rate of this DeliveryTicker. # noqa: E501
+
+ Basis rate # noqa: E501
+
+ :return: The basis_rate of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._basis_rate
+
+ @basis_rate.setter
+ def basis_rate(self, basis_rate):
+ """Sets the basis_rate of this DeliveryTicker.
+
+ Basis rate # noqa: E501
+
+ :param basis_rate: The basis_rate of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._basis_rate = basis_rate
+
+ @property
+ def basis_value(self):
+ """Gets the basis_value of this DeliveryTicker. # noqa: E501
+
+ Basis value # noqa: E501
+
+ :return: The basis_value of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._basis_value
+
+ @basis_value.setter
+ def basis_value(self, basis_value):
+ """Sets the basis_value of this DeliveryTicker.
+
+ Basis value # noqa: E501
+
+ :param basis_value: The basis_value of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._basis_value = basis_value
+
+ @property
+ def lowest_ask(self):
+ """Gets the lowest_ask of this DeliveryTicker. # noqa: E501
+
+ Recent lowest ask # noqa: E501
+
+ :return: The lowest_ask of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._lowest_ask
+
+ @lowest_ask.setter
+ def lowest_ask(self, lowest_ask):
+ """Sets the lowest_ask of this DeliveryTicker.
+
+ Recent lowest ask # noqa: E501
+
+ :param lowest_ask: The lowest_ask of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._lowest_ask = lowest_ask
+
+ @property
+ def lowest_size(self):
+ """Gets the lowest_size of this DeliveryTicker. # noqa: E501
+
+ The latest seller's lowest price order quantity # noqa: E501
+
+ :return: The lowest_size of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._lowest_size
+
+ @lowest_size.setter
+ def lowest_size(self, lowest_size):
+ """Sets the lowest_size of this DeliveryTicker.
+
+ The latest seller's lowest price order quantity # noqa: E501
+
+ :param lowest_size: The lowest_size of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._lowest_size = lowest_size
+
+ @property
+ def highest_bid(self):
+ """Gets the highest_bid of this DeliveryTicker. # noqa: E501
+
+ Recent highest bid # noqa: E501
+
+ :return: The highest_bid of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._highest_bid
+
+ @highest_bid.setter
+ def highest_bid(self, highest_bid):
+ """Sets the highest_bid of this DeliveryTicker.
+
+ Recent highest bid # noqa: E501
+
+ :param highest_bid: The highest_bid of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._highest_bid = highest_bid
+
+ @property
+ def highest_size(self):
+ """Gets the highest_size of this DeliveryTicker. # noqa: E501
+
+ The latest buyer's highest price order volume # noqa: E501
+
+ :return: The highest_size of this DeliveryTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._highest_size
+
+ @highest_size.setter
+ def highest_size(self, highest_size):
+ """Sets the highest_size of this DeliveryTicker.
+
+ The latest buyer's highest price order volume # noqa: E501
+
+ :param highest_size: The highest_size of this DeliveryTicker. # noqa: E501
+ :type: str
+ """
+
+ self._highest_size = highest_size
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, DeliveryTicker):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, DeliveryTicker):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/deposit_address.py b/gate_api/models/deposit_address.py
index 9601ce8..01a55df 100644
--- a/gate_api/models/deposit_address.py
+++ b/gate_api/models/deposit_address.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/deposit_record.py b/gate_api/models/deposit_record.py
new file mode 100644
index 0000000..509aa32
--- /dev/null
+++ b/gate_api/models/deposit_record.py
@@ -0,0 +1,378 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class DepositRecord(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'id': 'str',
+ 'txid': 'str',
+ 'withdraw_order_id': 'str',
+ 'timestamp': 'str',
+ 'amount': 'str',
+ 'currency': 'str',
+ 'address': 'str',
+ 'memo': 'str',
+ 'status': 'str',
+ 'chain': 'str'
+ }
+
+ attribute_map = {
+ 'id': 'id',
+ 'txid': 'txid',
+ 'withdraw_order_id': 'withdraw_order_id',
+ 'timestamp': 'timestamp',
+ 'amount': 'amount',
+ 'currency': 'currency',
+ 'address': 'address',
+ 'memo': 'memo',
+ 'status': 'status',
+ 'chain': 'chain'
+ }
+
+ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, amount=None, currency=None, address=None, memo=None, status=None, chain=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ """DepositRecord - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._id = None
+ self._txid = None
+ self._withdraw_order_id = None
+ self._timestamp = None
+ self._amount = None
+ self._currency = None
+ self._address = None
+ self._memo = None
+ self._status = None
+ self._chain = None
+ self.discriminator = None
+
+ if id is not None:
+ self.id = id
+ if txid is not None:
+ self.txid = txid
+ if withdraw_order_id is not None:
+ self.withdraw_order_id = withdraw_order_id
+ if timestamp is not None:
+ self.timestamp = timestamp
+ self.amount = amount
+ self.currency = currency
+ if address is not None:
+ self.address = address
+ if memo is not None:
+ self.memo = memo
+ if status is not None:
+ self.status = status
+ self.chain = chain
+
+ @property
+ def id(self):
+ """Gets the id of this DepositRecord. # noqa: E501
+
+ Record ID # noqa: E501
+
+ :return: The id of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id):
+ """Sets the id of this DepositRecord.
+
+ Record ID # noqa: E501
+
+ :param id: The id of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._id = id
+
+ @property
+ def txid(self):
+ """Gets the txid of this DepositRecord. # noqa: E501
+
+ Hash record of the withdrawal # noqa: E501
+
+ :return: The txid of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._txid
+
+ @txid.setter
+ def txid(self, txid):
+ """Sets the txid of this DepositRecord.
+
+ Hash record of the withdrawal # noqa: E501
+
+ :param txid: The txid of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._txid = txid
+
+ @property
+ def withdraw_order_id(self):
+ """Gets the withdraw_order_id of this DepositRecord. # noqa: E501
+
+ Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) # noqa: E501
+
+ :return: The withdraw_order_id of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._withdraw_order_id
+
+ @withdraw_order_id.setter
+ def withdraw_order_id(self, withdraw_order_id):
+ """Sets the withdraw_order_id of this DepositRecord.
+
+ Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) # noqa: E501
+
+ :param withdraw_order_id: The withdraw_order_id of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._withdraw_order_id = withdraw_order_id
+
+ @property
+ def timestamp(self):
+ """Gets the timestamp of this DepositRecord. # noqa: E501
+
+ Operation time # noqa: E501
+
+ :return: The timestamp of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._timestamp
+
+ @timestamp.setter
+ def timestamp(self, timestamp):
+ """Sets the timestamp of this DepositRecord.
+
+ Operation time # noqa: E501
+
+ :param timestamp: The timestamp of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._timestamp = timestamp
+
+ @property
+ def amount(self):
+ """Gets the amount of this DepositRecord. # noqa: E501
+
+ Token amount # noqa: E501
+
+ :return: The amount of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._amount
+
+ @amount.setter
+ def amount(self, amount):
+ """Sets the amount of this DepositRecord.
+
+ Token amount # noqa: E501
+
+ :param amount: The amount of this DepositRecord. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
+ raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
+
+ self._amount = amount
+
+ @property
+ def currency(self):
+ """Gets the currency of this DepositRecord. # noqa: E501
+
+ Currency name # noqa: E501
+
+ :return: The currency of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._currency
+
+ @currency.setter
+ def currency(self, currency):
+ """Sets the currency of this DepositRecord.
+
+ Currency name # noqa: E501
+
+ :param currency: The currency of this DepositRecord. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
+ raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
+
+ self._currency = currency
+
+ @property
+ def address(self):
+ """Gets the address of this DepositRecord. # noqa: E501
+
+ Withdrawal address. Required for withdrawals # noqa: E501
+
+ :return: The address of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._address
+
+ @address.setter
+ def address(self, address):
+ """Sets the address of this DepositRecord.
+
+ Withdrawal address. Required for withdrawals # noqa: E501
+
+ :param address: The address of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._address = address
+
+ @property
+ def memo(self):
+ """Gets the memo of this DepositRecord. # noqa: E501
+
+ Additional remarks with regards to the withdrawal # noqa: E501
+
+ :return: The memo of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._memo
+
+ @memo.setter
+ def memo(self, memo):
+ """Sets the memo of this DepositRecord.
+
+ Additional remarks with regards to the withdrawal # noqa: E501
+
+ :param memo: The memo of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._memo = memo
+
+ @property
+ def status(self):
+ """Gets the status of this DepositRecord. # noqa: E501
+
+ Trading Status - REVIEW: Recharge review (compliance review) - PEND: Processing - DONE: Waiting for funds to be unlocked - INVALID: Invalid data - TRACK: Track the number of confirmations, waiting to add funds to the user (spot) - BLOCKED: Rejected Recharge - DEP_CREDITED: Recharge to account, withdrawal is not unlocked # noqa: E501
+
+ :return: The status of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this DepositRecord.
+
+ Trading Status - REVIEW: Recharge review (compliance review) - PEND: Processing - DONE: Waiting for funds to be unlocked - INVALID: Invalid data - TRACK: Track the number of confirmations, waiting to add funds to the user (spot) - BLOCKED: Rejected Recharge - DEP_CREDITED: Recharge to account, withdrawal is not unlocked # noqa: E501
+
+ :param status: The status of this DepositRecord. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def chain(self):
+ """Gets the chain of this DepositRecord. # noqa: E501
+
+ Name of the chain used in withdrawals # noqa: E501
+
+ :return: The chain of this DepositRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._chain
+
+ @chain.setter
+ def chain(self, chain):
+ """Sets the chain of this DepositRecord.
+
+ Name of the chain used in withdrawals # noqa: E501
+
+ :param chain: The chain of this DepositRecord. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and chain is None: # noqa: E501
+ raise ValueError("Invalid value for `chain`, must not be `None`") # noqa: E501
+
+ self._chain = chain
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, DepositRecord):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, DepositRecord):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/dual_get_orders.py b/gate_api/models/dual_get_orders.py
index 12e8d2a..3734353 100644
--- a/gate_api/models/dual_get_orders.py
+++ b/gate_api/models/dual_get_orders.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -48,7 +48,8 @@ class DualGetOrders(object):
'settlement_currency': 'str',
'apy_display': 'str',
'apy_settlement': 'str',
- 'delivery_time': 'int'
+ 'delivery_time': 'int',
+ 'text': 'str'
}
attribute_map = {
@@ -67,11 +68,12 @@ class DualGetOrders(object):
'settlement_currency': 'settlement_currency',
'apy_display': 'apy_display',
'apy_settlement': 'apy_settlement',
- 'delivery_time': 'delivery_time'
+ 'delivery_time': 'delivery_time',
+ 'text': 'text'
}
- def __init__(self, id=None, plan_id=None, copies=None, invest_amount=None, settlement_amount=None, create_time=None, complete_time=None, status=None, invest_currency=None, exercise_currency=None, exercise_price=None, settlement_price=None, settlement_currency=None, apy_display=None, apy_settlement=None, delivery_time=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, str, str, str, int, int, str, str, str, str, str, str, str, str, int, Configuration) -> None
+ def __init__(self, id=None, plan_id=None, copies=None, invest_amount=None, settlement_amount=None, create_time=None, complete_time=None, status=None, invest_currency=None, exercise_currency=None, exercise_price=None, settlement_price=None, settlement_currency=None, apy_display=None, apy_settlement=None, delivery_time=None, text=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, str, str, str, int, int, str, str, str, str, str, str, str, str, int, str, Configuration) -> None
"""DualGetOrders - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -93,6 +95,7 @@ def __init__(self, id=None, plan_id=None, copies=None, invest_amount=None, settl
self._apy_display = None
self._apy_settlement = None
self._delivery_time = None
+ self._text = None
self.discriminator = None
if id is not None:
@@ -127,6 +130,8 @@ def __init__(self, id=None, plan_id=None, copies=None, invest_amount=None, settl
self.apy_settlement = apy_settlement
if delivery_time is not None:
self.delivery_time = delivery_time
+ if text is not None:
+ self.text = text
@property
def id(self):
@@ -155,7 +160,7 @@ def id(self, id):
def plan_id(self):
"""Gets the plan_id of this DualGetOrders. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The plan_id of this DualGetOrders. # noqa: E501
:rtype: int
@@ -166,7 +171,7 @@ def plan_id(self):
def plan_id(self, plan_id):
"""Sets the plan_id of this DualGetOrders.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param plan_id: The plan_id of this DualGetOrders. # noqa: E501
:type: int
@@ -178,7 +183,7 @@ def plan_id(self, plan_id):
def copies(self):
"""Gets the copies of this DualGetOrders. # noqa: E501
- Copies # noqa: E501
+ Units # noqa: E501
:return: The copies of this DualGetOrders. # noqa: E501
:rtype: str
@@ -189,7 +194,7 @@ def copies(self):
def copies(self, copies):
"""Sets the copies of this DualGetOrders.
- Copies # noqa: E501
+ Units # noqa: E501
:param copies: The copies of this DualGetOrders. # noqa: E501
:type: str
@@ -201,7 +206,7 @@ def copies(self, copies):
def invest_amount(self):
"""Gets the invest_amount of this DualGetOrders. # noqa: E501
- Investment Amount # noqa: E501
+ Investment Quantity # noqa: E501
:return: The invest_amount of this DualGetOrders. # noqa: E501
:rtype: str
@@ -212,7 +217,7 @@ def invest_amount(self):
def invest_amount(self, invest_amount):
"""Sets the invest_amount of this DualGetOrders.
- Investment Amount # noqa: E501
+ Investment Quantity # noqa: E501
:param invest_amount: The invest_amount of this DualGetOrders. # noqa: E501
:type: str
@@ -224,7 +229,7 @@ def invest_amount(self, invest_amount):
def settlement_amount(self):
"""Gets the settlement_amount of this DualGetOrders. # noqa: E501
- Settlement Amount # noqa: E501
+ Settlement Quantity # noqa: E501
:return: The settlement_amount of this DualGetOrders. # noqa: E501
:rtype: str
@@ -235,7 +240,7 @@ def settlement_amount(self):
def settlement_amount(self, settlement_amount):
"""Sets the settlement_amount of this DualGetOrders.
- Settlement Amount # noqa: E501
+ Settlement Quantity # noqa: E501
:param settlement_amount: The settlement_amount of this DualGetOrders. # noqa: E501
:type: str
@@ -247,7 +252,7 @@ def settlement_amount(self, settlement_amount):
def create_time(self):
"""Gets the create_time of this DualGetOrders. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this DualGetOrders. # noqa: E501
:rtype: int
@@ -258,7 +263,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this DualGetOrders.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this DualGetOrders. # noqa: E501
:type: int
@@ -270,7 +275,7 @@ def create_time(self, create_time):
def complete_time(self):
"""Gets the complete_time of this DualGetOrders. # noqa: E501
- Completion Time # noqa: E501
+ Completed Time # noqa: E501
:return: The complete_time of this DualGetOrders. # noqa: E501
:rtype: int
@@ -281,7 +286,7 @@ def complete_time(self):
def complete_time(self, complete_time):
"""Sets the complete_time of this DualGetOrders.
- Completion Time # noqa: E501
+ Completed Time # noqa: E501
:param complete_time: The complete_time of this DualGetOrders. # noqa: E501
:type: int
@@ -293,7 +298,7 @@ def complete_time(self, complete_time):
def status(self):
"""Gets the status of this DualGetOrders. # noqa: E501
- Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed # noqa: E501
+ Status: `INIT`-Created `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-Settlement Processing `CANCELED`-Canceled `FAILED`-Failed # noqa: E501
:return: The status of this DualGetOrders. # noqa: E501
:rtype: str
@@ -304,7 +309,7 @@ def status(self):
def status(self, status):
"""Sets the status of this DualGetOrders.
- Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed # noqa: E501
+ Status: `INIT`-Created `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-Settlement Processing `CANCELED`-Canceled `FAILED`-Failed # noqa: E501
:param status: The status of this DualGetOrders. # noqa: E501
:type: str
@@ -316,7 +321,7 @@ def status(self, status):
def invest_currency(self):
"""Gets the invest_currency of this DualGetOrders. # noqa: E501
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:return: The invest_currency of this DualGetOrders. # noqa: E501
:rtype: str
@@ -327,7 +332,7 @@ def invest_currency(self):
def invest_currency(self, invest_currency):
"""Sets the invest_currency of this DualGetOrders.
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:param invest_currency: The invest_currency of this DualGetOrders. # noqa: E501
:type: str
@@ -339,7 +344,7 @@ def invest_currency(self, invest_currency):
def exercise_currency(self):
"""Gets the exercise_currency of this DualGetOrders. # noqa: E501
- Strike Currency # noqa: E501
+ Strike Token # noqa: E501
:return: The exercise_currency of this DualGetOrders. # noqa: E501
:rtype: str
@@ -350,7 +355,7 @@ def exercise_currency(self):
def exercise_currency(self, exercise_currency):
"""Sets the exercise_currency of this DualGetOrders.
- Strike Currency # noqa: E501
+ Strike Token # noqa: E501
:param exercise_currency: The exercise_currency of this DualGetOrders. # noqa: E501
:type: str
@@ -385,7 +390,7 @@ def exercise_price(self, exercise_price):
def settlement_price(self):
"""Gets the settlement_price of this DualGetOrders. # noqa: E501
- settlement price # noqa: E501
+ Settlement price # noqa: E501
:return: The settlement_price of this DualGetOrders. # noqa: E501
:rtype: str
@@ -396,7 +401,7 @@ def settlement_price(self):
def settlement_price(self, settlement_price):
"""Sets the settlement_price of this DualGetOrders.
- settlement price # noqa: E501
+ Settlement price # noqa: E501
:param settlement_price: The settlement_price of this DualGetOrders. # noqa: E501
:type: str
@@ -408,7 +413,7 @@ def settlement_price(self, settlement_price):
def settlement_currency(self):
"""Gets the settlement_currency of this DualGetOrders. # noqa: E501
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:return: The settlement_currency of this DualGetOrders. # noqa: E501
:rtype: str
@@ -419,7 +424,7 @@ def settlement_currency(self):
def settlement_currency(self, settlement_currency):
"""Sets the settlement_currency of this DualGetOrders.
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:param settlement_currency: The settlement_currency of this DualGetOrders. # noqa: E501
:type: str
@@ -431,7 +436,7 @@ def settlement_currency(self, settlement_currency):
def apy_display(self):
"""Gets the apy_display of this DualGetOrders. # noqa: E501
- APY # noqa: E501
+ Annual Yield # noqa: E501
:return: The apy_display of this DualGetOrders. # noqa: E501
:rtype: str
@@ -442,7 +447,7 @@ def apy_display(self):
def apy_display(self, apy_display):
"""Sets the apy_display of this DualGetOrders.
- APY # noqa: E501
+ Annual Yield # noqa: E501
:param apy_display: The apy_display of this DualGetOrders. # noqa: E501
:type: str
@@ -454,7 +459,7 @@ def apy_display(self, apy_display):
def apy_settlement(self):
"""Gets the apy_settlement of this DualGetOrders. # noqa: E501
- Settlement APY # noqa: E501
+ Settlement Annual Yield # noqa: E501
:return: The apy_settlement of this DualGetOrders. # noqa: E501
:rtype: str
@@ -465,7 +470,7 @@ def apy_settlement(self):
def apy_settlement(self, apy_settlement):
"""Sets the apy_settlement of this DualGetOrders.
- Settlement APY # noqa: E501
+ Settlement Annual Yield # noqa: E501
:param apy_settlement: The apy_settlement of this DualGetOrders. # noqa: E501
:type: str
@@ -496,6 +501,29 @@ def delivery_time(self, delivery_time):
self._delivery_time = delivery_time
+ @property
+ def text(self):
+ """Gets the text of this DualGetOrders. # noqa: E501
+
+ Custom order information # noqa: E501
+
+ :return: The text of this DualGetOrders. # noqa: E501
+ :rtype: str
+ """
+ return self._text
+
+ @text.setter
+ def text(self, text):
+ """Sets the text of this DualGetOrders.
+
+ Custom order information # noqa: E501
+
+ :param text: The text of this DualGetOrders. # noqa: E501
+ :type: str
+ """
+
+ self._text = text
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/dual_get_plans.py b/gate_api/models/dual_get_plans.py
index e1319ed..90808a3 100644
--- a/gate_api/models/dual_get_plans.py
+++ b/gate_api/models/dual_get_plans.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -117,7 +117,7 @@ def __init__(self, id=None, instrument_name=None, invest_currency=None, exercise
def id(self):
"""Gets the id of this DualGetPlans. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The id of this DualGetPlans. # noqa: E501
:rtype: int
@@ -128,7 +128,7 @@ def id(self):
def id(self, id):
"""Sets the id of this DualGetPlans.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param id: The id of this DualGetPlans. # noqa: E501
:type: int
@@ -140,7 +140,7 @@ def id(self, id):
def instrument_name(self):
"""Gets the instrument_name of this DualGetPlans. # noqa: E501
- Instrument Name # noqa: E501
+ Product Name # noqa: E501
:return: The instrument_name of this DualGetPlans. # noqa: E501
:rtype: str
@@ -151,7 +151,7 @@ def instrument_name(self):
def instrument_name(self, instrument_name):
"""Sets the instrument_name of this DualGetPlans.
- Instrument Name # noqa: E501
+ Product Name # noqa: E501
:param instrument_name: The instrument_name of this DualGetPlans. # noqa: E501
:type: str
@@ -163,7 +163,7 @@ def instrument_name(self, instrument_name):
def invest_currency(self):
"""Gets the invest_currency of this DualGetPlans. # noqa: E501
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:return: The invest_currency of this DualGetPlans. # noqa: E501
:rtype: str
@@ -174,7 +174,7 @@ def invest_currency(self):
def invest_currency(self, invest_currency):
"""Sets the invest_currency of this DualGetPlans.
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:param invest_currency: The invest_currency of this DualGetPlans. # noqa: E501
:type: str
@@ -186,7 +186,7 @@ def invest_currency(self, invest_currency):
def exercise_currency(self):
"""Gets the exercise_currency of this DualGetPlans. # noqa: E501
- Strike Currency # noqa: E501
+ Strike Token # noqa: E501
:return: The exercise_currency of this DualGetPlans. # noqa: E501
:rtype: str
@@ -197,7 +197,7 @@ def exercise_currency(self):
def exercise_currency(self, exercise_currency):
"""Sets the exercise_currency of this DualGetPlans.
- Strike Currency # noqa: E501
+ Strike Token # noqa: E501
:param exercise_currency: The exercise_currency of this DualGetPlans. # noqa: E501
:type: str
@@ -255,7 +255,7 @@ def delivery_time(self, delivery_time):
def min_copies(self):
"""Gets the min_copies of this DualGetPlans. # noqa: E501
- Minimum Copies # noqa: E501
+ Minimum Units # noqa: E501
:return: The min_copies of this DualGetPlans. # noqa: E501
:rtype: int
@@ -266,7 +266,7 @@ def min_copies(self):
def min_copies(self, min_copies):
"""Sets the min_copies of this DualGetPlans.
- Minimum Copies # noqa: E501
+ Minimum Units # noqa: E501
:param min_copies: The min_copies of this DualGetPlans. # noqa: E501
:type: int
@@ -278,7 +278,7 @@ def min_copies(self, min_copies):
def max_copies(self):
"""Gets the max_copies of this DualGetPlans. # noqa: E501
- Maximum Copies # noqa: E501
+ Maximum Units # noqa: E501
:return: The max_copies of this DualGetPlans. # noqa: E501
:rtype: int
@@ -289,7 +289,7 @@ def max_copies(self):
def max_copies(self, max_copies):
"""Sets the max_copies of this DualGetPlans.
- Maximum Copies # noqa: E501
+ Maximum Units # noqa: E501
:param max_copies: The max_copies of this DualGetPlans. # noqa: E501
:type: int
@@ -301,7 +301,7 @@ def max_copies(self, max_copies):
def per_value(self):
"""Gets the per_value of this DualGetPlans. # noqa: E501
- Per Unit Value # noqa: E501
+ Value Per Unit # noqa: E501
:return: The per_value of this DualGetPlans. # noqa: E501
:rtype: str
@@ -312,7 +312,7 @@ def per_value(self):
def per_value(self, per_value):
"""Sets the per_value of this DualGetPlans.
- Per Unit Value # noqa: E501
+ Value Per Unit # noqa: E501
:param per_value: The per_value of this DualGetPlans. # noqa: E501
:type: str
@@ -324,7 +324,7 @@ def per_value(self, per_value):
def apy_display(self):
"""Gets the apy_display of this DualGetPlans. # noqa: E501
- APY # noqa: E501
+ Annual Yield # noqa: E501
:return: The apy_display of this DualGetPlans. # noqa: E501
:rtype: str
@@ -335,7 +335,7 @@ def apy_display(self):
def apy_display(self, apy_display):
"""Sets the apy_display of this DualGetPlans.
- APY # noqa: E501
+ Annual Yield # noqa: E501
:param apy_display: The apy_display of this DualGetPlans. # noqa: E501
:type: str
@@ -347,7 +347,7 @@ def apy_display(self, apy_display):
def start_time(self):
"""Gets the start_time of this DualGetPlans. # noqa: E501
- start time # noqa: E501
+ Start Time # noqa: E501
:return: The start_time of this DualGetPlans. # noqa: E501
:rtype: int
@@ -358,7 +358,7 @@ def start_time(self):
def start_time(self, start_time):
"""Sets the start_time of this DualGetPlans.
- start time # noqa: E501
+ Start Time # noqa: E501
:param start_time: The start_time of this DualGetPlans. # noqa: E501
:type: int
@@ -370,7 +370,7 @@ def start_time(self, start_time):
def end_time(self):
"""Gets the end_time of this DualGetPlans. # noqa: E501
- Finished time # noqa: E501
+ End time # noqa: E501
:return: The end_time of this DualGetPlans. # noqa: E501
:rtype: int
@@ -381,7 +381,7 @@ def end_time(self):
def end_time(self, end_time):
"""Sets the end_time of this DualGetPlans.
- Finished time # noqa: E501
+ End time # noqa: E501
:param end_time: The end_time of this DualGetPlans. # noqa: E501
:type: int
@@ -393,7 +393,7 @@ def end_time(self, end_time):
def status(self):
"""Gets the status of this DualGetPlans. # noqa: E501
- Status: `NOTSTARTED`-not started `ONGOING`-ongoing `ENDED`-ended # noqa: E501
+ Status: `NOTSTARTED`-Not Started `ONGOING`-In Progress `ENDED`-Ended # noqa: E501
:return: The status of this DualGetPlans. # noqa: E501
:rtype: str
@@ -404,7 +404,7 @@ def status(self):
def status(self, status):
"""Sets the status of this DualGetPlans.
- Status: `NOTSTARTED`-not started `ONGOING`-ongoing `ENDED`-ended # noqa: E501
+ Status: `NOTSTARTED`-Not Started `ONGOING`-In Progress `ENDED`-Ended # noqa: E501
:param status: The status of this DualGetPlans. # noqa: E501
:type: str
diff --git a/gate_api/models/funding_book_item.py b/gate_api/models/eth2_rate_list.py
similarity index 54%
rename from gate_api/models/funding_book_item.py
rename to gate_api/models/eth2_rate_list.py
index b08d07f..c714e00 100644
--- a/gate_api/models/funding_book_item.py
+++ b/gate_api/models/eth2_rate_list.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class FundingBookItem(object):
+class Eth2RateList(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -33,104 +33,104 @@ class FundingBookItem(object):
and the value is json key in definition.
"""
openapi_types = {
- 'rate': 'str',
- 'amount': 'str',
- 'days': 'int'
+ 'date_time': 'int',
+ 'date': 'str',
+ 'rate': 'str'
}
attribute_map = {
- 'rate': 'rate',
- 'amount': 'amount',
- 'days': 'days'
+ 'date_time': 'date_time',
+ 'date': 'date',
+ 'rate': 'rate'
}
- def __init__(self, rate=None, amount=None, days=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, int, Configuration) -> None
- """FundingBookItem - a model defined in OpenAPI""" # noqa: E501
+ def __init__(self, date_time=None, date=None, rate=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, str, Configuration) -> None
+ """Eth2RateList - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
+ self._date_time = None
+ self._date = None
self._rate = None
- self._amount = None
- self._days = None
self.discriminator = None
+ if date_time is not None:
+ self.date_time = date_time
+ if date is not None:
+ self.date = date
if rate is not None:
self.rate = rate
- if amount is not None:
- self.amount = amount
- if days is not None:
- self.days = days
@property
- def rate(self):
- """Gets the rate of this FundingBookItem. # noqa: E501
+ def date_time(self):
+ """Gets the date_time of this Eth2RateList. # noqa: E501
- Loan rate (daily rate) # noqa: E501
+ Date Timestamp # noqa: E501
- :return: The rate of this FundingBookItem. # noqa: E501
- :rtype: str
+ :return: The date_time of this Eth2RateList. # noqa: E501
+ :rtype: int
"""
- return self._rate
+ return self._date_time
- @rate.setter
- def rate(self, rate):
- """Sets the rate of this FundingBookItem.
+ @date_time.setter
+ def date_time(self, date_time):
+ """Sets the date_time of this Eth2RateList.
- Loan rate (daily rate) # noqa: E501
+ Date Timestamp # noqa: E501
- :param rate: The rate of this FundingBookItem. # noqa: E501
- :type: str
+ :param date_time: The date_time of this Eth2RateList. # noqa: E501
+ :type: int
"""
- self._rate = rate
+ self._date_time = date_time
@property
- def amount(self):
- """Gets the amount of this FundingBookItem. # noqa: E501
+ def date(self):
+ """Gets the date of this Eth2RateList. # noqa: E501
- Borrowable amount # noqa: E501
+ Date # noqa: E501
- :return: The amount of this FundingBookItem. # noqa: E501
+ :return: The date of this Eth2RateList. # noqa: E501
:rtype: str
"""
- return self._amount
+ return self._date
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this FundingBookItem.
+ @date.setter
+ def date(self, date):
+ """Sets the date of this Eth2RateList.
- Borrowable amount # noqa: E501
+ Date # noqa: E501
- :param amount: The amount of this FundingBookItem. # noqa: E501
+ :param date: The date of this Eth2RateList. # noqa: E501
:type: str
"""
- self._amount = amount
+ self._date = date
@property
- def days(self):
- """Gets the days of this FundingBookItem. # noqa: E501
+ def rate(self):
+ """Gets the rate of this Eth2RateList. # noqa: E501
- The number of days till the loan repayment's dateline # noqa: E501
+ Percentage Rate # noqa: E501
- :return: The days of this FundingBookItem. # noqa: E501
- :rtype: int
+ :return: The rate of this Eth2RateList. # noqa: E501
+ :rtype: str
"""
- return self._days
+ return self._rate
- @days.setter
- def days(self, days):
- """Sets the days of this FundingBookItem.
+ @rate.setter
+ def rate(self, rate):
+ """Sets the rate of this Eth2RateList.
- The number of days till the loan repayment's dateline # noqa: E501
+ Percentage Rate # noqa: E501
- :param days: The days of this FundingBookItem. # noqa: E501
- :type: int
+ :param rate: The rate of this Eth2RateList. # noqa: E501
+ :type: str
"""
- self._days = days
+ self._rate = rate
def to_dict(self):
"""Returns the model properties as a dict"""
@@ -166,14 +166,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, FundingBookItem):
+ if not isinstance(other, Eth2RateList):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, FundingBookItem):
+ if not isinstance(other, Eth2RateList):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/eth2_swap.py b/gate_api/models/eth2_swap.py
index 23a2a8e..ac51063 100644
--- a/gate_api/models/eth2_swap.py
+++ b/gate_api/models/eth2_swap.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -60,7 +60,7 @@ def __init__(self, side=None, amount=None, local_vars_configuration=None): # no
def side(self):
"""Gets the side of this Eth2Swap. # noqa: E501
- 1-Forward Swap（ETH -> ETH2）, 2-Reverse Swap（ETH2 -> ETH） # noqa: E501
+ 1-Forward Swap (ETH -> ETH2), 2-Reverse Swap (ETH2 -> ETH) # noqa: E501
:return: The side of this Eth2Swap. # noqa: E501
:rtype: str
@@ -71,7 +71,7 @@ def side(self):
def side(self, side):
"""Sets the side of this Eth2Swap.
- 1-Forward Swap（ETH -> ETH2）, 2-Reverse Swap（ETH2 -> ETH） # noqa: E501
+ 1-Forward Swap (ETH -> ETH2), 2-Reverse Swap (ETH2 -> ETH) # noqa: E501
:param side: The side of this Eth2Swap. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def side(self, side):
def amount(self):
"""Gets the amount of this Eth2Swap. # noqa: E501
- amount # noqa: E501
+ Swap Amount # noqa: E501
:return: The amount of this Eth2Swap. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this Eth2Swap.
- amount # noqa: E501
+ Swap Amount # noqa: E501
:param amount: The amount of this Eth2Swap. # noqa: E501
:type: str
diff --git a/gate_api/models/find_coin.py b/gate_api/models/find_coin.py
new file mode 100644
index 0000000..a73037a
--- /dev/null
+++ b/gate_api/models/find_coin.py
@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class FindCoin(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'cointype': 'str'
+ }
+
+ attribute_map = {
+ 'cointype': 'cointype'
+ }
+
+ def __init__(self, cointype=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, Configuration) -> None
+ """FindCoin - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._cointype = None
+ self.discriminator = None
+
+ if cointype is not None:
+ self.cointype = cointype
+
+ @property
+ def cointype(self):
+ """Gets the cointype of this FindCoin. # noqa: E501
+
+ Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. # noqa: E501
+
+ :return: The cointype of this FindCoin. # noqa: E501
+ :rtype: str
+ """
+ return self._cointype
+
+ @cointype.setter
+ def cointype(self, cointype):
+ """Sets the cointype of this FindCoin.
+
+ Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. # noqa: E501
+
+ :param cointype: The cointype of this FindCoin. # noqa: E501
+ :type: str
+ """
+
+ self._cointype = cointype
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, FindCoin):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, FindCoin):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/flash_swap_currency.py b/gate_api/models/flash_swap_currency.py
deleted file mode 100644
index 00006b2..0000000
--- a/gate_api/models/flash_swap_currency.py
+++ /dev/null
@@ -1,207 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class FlashSwapCurrency(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'currency': 'str',
- 'min_amount': 'str',
- 'max_amount': 'str',
- 'swappable': 'list[str]'
- }
-
- attribute_map = {
- 'currency': 'currency',
- 'min_amount': 'min_amount',
- 'max_amount': 'max_amount',
- 'swappable': 'swappable'
- }
-
- def __init__(self, currency=None, min_amount=None, max_amount=None, swappable=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, list[str], Configuration) -> None
- """FlashSwapCurrency - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._currency = None
- self._min_amount = None
- self._max_amount = None
- self._swappable = None
- self.discriminator = None
-
- if currency is not None:
- self.currency = currency
- if min_amount is not None:
- self.min_amount = min_amount
- if max_amount is not None:
- self.max_amount = max_amount
- if swappable is not None:
- self.swappable = swappable
-
- @property
- def currency(self):
- """Gets the currency of this FlashSwapCurrency. # noqa: E501
-
- Currency name # noqa: E501
-
- :return: The currency of this FlashSwapCurrency. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this FlashSwapCurrency.
-
- Currency name # noqa: E501
-
- :param currency: The currency of this FlashSwapCurrency. # noqa: E501
- :type: str
- """
-
- self._currency = currency
-
- @property
- def min_amount(self):
- """Gets the min_amount of this FlashSwapCurrency. # noqa: E501
-
- Minimum amount required in flash swap # noqa: E501
-
- :return: The min_amount of this FlashSwapCurrency. # noqa: E501
- :rtype: str
- """
- return self._min_amount
-
- @min_amount.setter
- def min_amount(self, min_amount):
- """Sets the min_amount of this FlashSwapCurrency.
-
- Minimum amount required in flash swap # noqa: E501
-
- :param min_amount: The min_amount of this FlashSwapCurrency. # noqa: E501
- :type: str
- """
-
- self._min_amount = min_amount
-
- @property
- def max_amount(self):
- """Gets the max_amount of this FlashSwapCurrency. # noqa: E501
-
- Maximum amount allowed in flash swap # noqa: E501
-
- :return: The max_amount of this FlashSwapCurrency. # noqa: E501
- :rtype: str
- """
- return self._max_amount
-
- @max_amount.setter
- def max_amount(self, max_amount):
- """Sets the max_amount of this FlashSwapCurrency.
-
- Maximum amount allowed in flash swap # noqa: E501
-
- :param max_amount: The max_amount of this FlashSwapCurrency. # noqa: E501
- :type: str
- """
-
- self._max_amount = max_amount
-
- @property
- def swappable(self):
- """Gets the swappable of this FlashSwapCurrency. # noqa: E501
-
- Currencies which can be swapped to from this currency # noqa: E501
-
- :return: The swappable of this FlashSwapCurrency. # noqa: E501
- :rtype: list[str]
- """
- return self._swappable
-
- @swappable.setter
- def swappable(self, swappable):
- """Sets the swappable of this FlashSwapCurrency.
-
- Currencies which can be swapped to from this currency # noqa: E501
-
- :param swappable: The swappable of this FlashSwapCurrency. # noqa: E501
- :type: list[str]
- """
-
- self._swappable = swappable
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, FlashSwapCurrency):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, FlashSwapCurrency):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/flash_swap_currency_pair.py b/gate_api/models/flash_swap_currency_pair.py
index fe52683..5a9ed86 100644
--- a/gate_api/models/flash_swap_currency_pair.py
+++ b/gate_api/models/flash_swap_currency_pair.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -87,7 +87,7 @@ def __init__(self, currency_pair=None, sell_currency=None, buy_currency=None, se
def currency_pair(self):
"""Gets the currency_pair of this FlashSwapCurrencyPair. # noqa: E501
- The currency pair, BTC_USDT represents selling Bitcoin (BTC) and buying Tether (USDT). # noqa: E501
+ Currency pair, `BTC_USDT` represents selling `BTC` and buying `USDT` # noqa: E501
:return: The currency_pair of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -98,7 +98,7 @@ def currency_pair(self):
def currency_pair(self, currency_pair):
"""Sets the currency_pair of this FlashSwapCurrencyPair.
- The currency pair, BTC_USDT represents selling Bitcoin (BTC) and buying Tether (USDT). # noqa: E501
+ Currency pair, `BTC_USDT` represents selling `BTC` and buying `USDT` # noqa: E501
:param currency_pair: The currency_pair of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -110,7 +110,7 @@ def currency_pair(self, currency_pair):
def sell_currency(self):
"""Gets the sell_currency of this FlashSwapCurrencyPair. # noqa: E501
- The currency to be sold # noqa: E501
+ Currency to sell # noqa: E501
:return: The sell_currency of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -121,7 +121,7 @@ def sell_currency(self):
def sell_currency(self, sell_currency):
"""Sets the sell_currency of this FlashSwapCurrencyPair.
- The currency to be sold # noqa: E501
+ Currency to sell # noqa: E501
:param sell_currency: The sell_currency of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -133,7 +133,7 @@ def sell_currency(self, sell_currency):
def buy_currency(self):
"""Gets the buy_currency of this FlashSwapCurrencyPair. # noqa: E501
- The currency to be bought # noqa: E501
+ Currency to buy # noqa: E501
:return: The buy_currency of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -144,7 +144,7 @@ def buy_currency(self):
def buy_currency(self, buy_currency):
"""Sets the buy_currency of this FlashSwapCurrencyPair.
- The currency to be bought # noqa: E501
+ Currency to buy # noqa: E501
:param buy_currency: The buy_currency of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -156,7 +156,7 @@ def buy_currency(self, buy_currency):
def sell_min_amount(self):
"""Gets the sell_min_amount of this FlashSwapCurrencyPair. # noqa: E501
- The minimum quantity required for selling # noqa: E501
+ Minimum sell quantity # noqa: E501
:return: The sell_min_amount of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -167,7 +167,7 @@ def sell_min_amount(self):
def sell_min_amount(self, sell_min_amount):
"""Sets the sell_min_amount of this FlashSwapCurrencyPair.
- The minimum quantity required for selling # noqa: E501
+ Minimum sell quantity # noqa: E501
:param sell_min_amount: The sell_min_amount of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -179,7 +179,7 @@ def sell_min_amount(self, sell_min_amount):
def sell_max_amount(self):
"""Gets the sell_max_amount of this FlashSwapCurrencyPair. # noqa: E501
- The maximum quantity allowed for selling # noqa: E501
+ Maximum sell quantity # noqa: E501
:return: The sell_max_amount of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -190,7 +190,7 @@ def sell_max_amount(self):
def sell_max_amount(self, sell_max_amount):
"""Sets the sell_max_amount of this FlashSwapCurrencyPair.
- The maximum quantity allowed for selling # noqa: E501
+ Maximum sell quantity # noqa: E501
:param sell_max_amount: The sell_max_amount of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -202,7 +202,7 @@ def sell_max_amount(self, sell_max_amount):
def buy_min_amount(self):
"""Gets the buy_min_amount of this FlashSwapCurrencyPair. # noqa: E501
- The minimum quantity required for buying # noqa: E501
+ Minimum buy quantity # noqa: E501
:return: The buy_min_amount of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def buy_min_amount(self):
def buy_min_amount(self, buy_min_amount):
"""Sets the buy_min_amount of this FlashSwapCurrencyPair.
- The minimum quantity required for buying # noqa: E501
+ Minimum buy quantity # noqa: E501
:param buy_min_amount: The buy_min_amount of this FlashSwapCurrencyPair. # noqa: E501
:type: str
@@ -225,7 +225,7 @@ def buy_min_amount(self, buy_min_amount):
def buy_max_amount(self):
"""Gets the buy_max_amount of this FlashSwapCurrencyPair. # noqa: E501
- The maximum quantity allowed for buying # noqa: E501
+ Maximum buy quantity # noqa: E501
:return: The buy_max_amount of this FlashSwapCurrencyPair. # noqa: E501
:rtype: str
@@ -236,7 +236,7 @@ def buy_max_amount(self):
def buy_max_amount(self, buy_max_amount):
"""Sets the buy_max_amount of this FlashSwapCurrencyPair.
- The maximum quantity allowed for buying # noqa: E501
+ Maximum buy quantity # noqa: E501
:param buy_max_amount: The buy_max_amount of this FlashSwapCurrencyPair. # noqa: E501
:type: str
diff --git a/gate_api/models/flash_swap_order.py b/gate_api/models/flash_swap_order.py
index e50d55f..2be7592 100644
--- a/gate_api/models/flash_swap_order.py
+++ b/gate_api/models/flash_swap_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/flash_swap_order_preview.py b/gate_api/models/flash_swap_order_preview.py
index b0e582c..d137d5a 100644
--- a/gate_api/models/flash_swap_order_preview.py
+++ b/gate_api/models/flash_swap_order_preview.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -105,7 +105,7 @@ def preview_id(self, preview_id):
def sell_currency(self):
"""Gets the sell_currency of this FlashSwapOrderPreview. # noqa: E501
- Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` # noqa: E501
+ Name of the sold asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain # noqa: E501
:return: The sell_currency of this FlashSwapOrderPreview. # noqa: E501
:rtype: str
@@ -116,7 +116,7 @@ def sell_currency(self):
def sell_currency(self, sell_currency):
"""Sets the sell_currency of this FlashSwapOrderPreview.
- Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` # noqa: E501
+ Name of the sold asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain # noqa: E501
:param sell_currency: The sell_currency of this FlashSwapOrderPreview. # noqa: E501
:type: str
@@ -151,7 +151,7 @@ def sell_amount(self, sell_amount):
def buy_currency(self):
"""Gets the buy_currency of this FlashSwapOrderPreview. # noqa: E501
- Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` # noqa: E501
+ Name of the purchased asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain # noqa: E501
:return: The buy_currency of this FlashSwapOrderPreview. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def buy_currency(self):
def buy_currency(self, buy_currency):
"""Sets the buy_currency of this FlashSwapOrderPreview.
- Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` # noqa: E501
+ Name of the purchased asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain # noqa: E501
:param buy_currency: The buy_currency of this FlashSwapOrderPreview. # noqa: E501
:type: str
diff --git a/gate_api/models/flash_swap_order_request.py b/gate_api/models/flash_swap_order_request.py
index 7ce00f8..d89b46b 100644
--- a/gate_api/models/flash_swap_order_request.py
+++ b/gate_api/models/flash_swap_order_request.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -97,7 +97,7 @@ def preview_id(self, preview_id):
def sell_currency(self):
"""Gets the sell_currency of this FlashSwapOrderRequest. # noqa: E501
- The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. # noqa: E501
+ Name of the asset to be sold, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap # noqa: E501
:return: The sell_currency of this FlashSwapOrderRequest. # noqa: E501
:rtype: str
@@ -108,7 +108,7 @@ def sell_currency(self):
def sell_currency(self, sell_currency):
"""Sets the sell_currency of this FlashSwapOrderRequest.
- The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. # noqa: E501
+ Name of the asset to be sold, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap # noqa: E501
:param sell_currency: The sell_currency of this FlashSwapOrderRequest. # noqa: E501
:type: str
@@ -147,7 +147,7 @@ def sell_amount(self, sell_amount):
def buy_currency(self):
"""Gets the buy_currency of this FlashSwapOrderRequest. # noqa: E501
- The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. # noqa: E501
+ Name of the asset to be bought, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap # noqa: E501
:return: The buy_currency of this FlashSwapOrderRequest. # noqa: E501
:rtype: str
@@ -158,7 +158,7 @@ def buy_currency(self):
def buy_currency(self, buy_currency):
"""Sets the buy_currency of this FlashSwapOrderRequest.
- The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. # noqa: E501
+ Name of the asset to be bought, obtained from the interface GET /flash_swap/currency_pairs: Query the list of all trading pairs supporting flash swap # noqa: E501
:param buy_currency: The buy_currency of this FlashSwapOrderRequest. # noqa: E501
:type: str
diff --git a/gate_api/models/flash_swap_preview_request.py b/gate_api/models/flash_swap_preview_request.py
index 1905832..3cfe1d1 100644
--- a/gate_api/models/flash_swap_preview_request.py
+++ b/gate_api/models/flash_swap_preview_request.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -70,7 +70,7 @@ def __init__(self, sell_currency=None, sell_amount=None, buy_currency=None, buy_
def sell_currency(self):
"""Gets the sell_currency of this FlashSwapPreviewRequest. # noqa: E501
- The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. # noqa: E501
+ The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs # noqa: E501
:return: The sell_currency of this FlashSwapPreviewRequest. # noqa: E501
:rtype: str
@@ -81,7 +81,7 @@ def sell_currency(self):
def sell_currency(self, sell_currency):
"""Sets the sell_currency of this FlashSwapPreviewRequest.
- The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs. # noqa: E501
+ The name of the asset being sold, as obtained from the \"GET /flash_swap/currency_pairs\" API, which retrieves a list of supported flash swap currency pairs # noqa: E501
:param sell_currency: The sell_currency of this FlashSwapPreviewRequest. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def sell_amount(self, sell_amount):
def buy_currency(self):
"""Gets the buy_currency of this FlashSwapPreviewRequest. # noqa: E501
- The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. # noqa: E501
+ The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs # noqa: E501
:return: The buy_currency of this FlashSwapPreviewRequest. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def buy_currency(self):
def buy_currency(self, buy_currency):
"""Sets the buy_currency of this FlashSwapPreviewRequest.
- The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs. # noqa: E501
+ The name of the asset being purchased, as obtained from the \"GET /flash_swap/currency_pairs\" API, which provides a list of supported flash swap currency pairs # noqa: E501
:param buy_currency: The buy_currency of this FlashSwapPreviewRequest. # noqa: E501
:type: str
diff --git a/gate_api/models/funding_account.py b/gate_api/models/funding_account.py
index 19cbfb6..9ba5a0f 100644
--- a/gate_api/models/funding_account.py
+++ b/gate_api/models/funding_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/funding_rate_record.py b/gate_api/models/funding_rate_record.py
index 840509d..cf06b1c 100644
--- a/gate_api/models/funding_rate_record.py
+++ b/gate_api/models/funding_rate_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/future_cancel_order_result.py b/gate_api/models/future_cancel_order_result.py
index 836de56..7f7ccd4 100644
--- a/gate_api/models/future_cancel_order_result.py
+++ b/gate_api/models/future_cancel_order_result.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -141,7 +141,7 @@ def succeeded(self, succeeded):
def message(self):
"""Gets the message of this FutureCancelOrderResult. # noqa: E501
- Error message when failed to cancel the order; empty if succeeded # noqa: E501
+ Error description when cancellation fails, empty if successful # noqa: E501
:return: The message of this FutureCancelOrderResult. # noqa: E501
:rtype: str
@@ -152,7 +152,7 @@ def message(self):
def message(self, message):
"""Sets the message of this FutureCancelOrderResult.
- Error message when failed to cancel the order; empty if succeeded # noqa: E501
+ Error description when cancellation fails, empty if successful # noqa: E501
:param message: The message of this FutureCancelOrderResult. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_account.py b/gate_api/models/futures_account.py
index a6730f0..6855e9f 100644
--- a/gate_api/models/futures_account.py
+++ b/gate_api/models/futures_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -41,6 +41,7 @@ class FuturesAccount(object):
'point': 'str',
'currency': 'str',
'in_dual_mode': 'bool',
+ 'position_mode': 'str',
'enable_credit': 'bool',
'position_initial_margin': 'str',
'maintenance_margin': 'str',
@@ -51,9 +52,13 @@ class FuturesAccount(object):
'cross_maintenance_margin': 'str',
'cross_unrealised_pnl': 'str',
'cross_available': 'str',
+ 'cross_margin_balance': 'str',
+ 'cross_mmr': 'str',
+ 'cross_imr': 'str',
'isolated_position_margin': 'str',
'enable_new_dual_mode': 'bool',
'margin_mode': 'int',
+ 'enable_tiered_mm': 'bool',
'history': 'FuturesAccountHistory'
}
@@ -66,6 +71,7 @@ class FuturesAccount(object):
'point': 'point',
'currency': 'currency',
'in_dual_mode': 'in_dual_mode',
+ 'position_mode': 'position_mode',
'enable_credit': 'enable_credit',
'position_initial_margin': 'position_initial_margin',
'maintenance_margin': 'maintenance_margin',
@@ -76,14 +82,18 @@ class FuturesAccount(object):
'cross_maintenance_margin': 'cross_maintenance_margin',
'cross_unrealised_pnl': 'cross_unrealised_pnl',
'cross_available': 'cross_available',
+ 'cross_margin_balance': 'cross_margin_balance',
+ 'cross_mmr': 'cross_mmr',
+ 'cross_imr': 'cross_imr',
'isolated_position_margin': 'isolated_position_margin',
'enable_new_dual_mode': 'enable_new_dual_mode',
'margin_mode': 'margin_mode',
+ 'enable_tiered_mm': 'enable_tiered_mm',
'history': 'history'
}
- def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_margin=None, available=None, point=None, currency=None, in_dual_mode=None, enable_credit=None, position_initial_margin=None, maintenance_margin=None, bonus=None, enable_evolved_classic=None, cross_order_margin=None, cross_initial_margin=None, cross_maintenance_margin=None, cross_unrealised_pnl=None, cross_available=None, isolated_position_margin=None, enable_new_dual_mode=None, margin_mode=None, history=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, bool, bool, str, str, str, bool, str, str, str, str, str, str, bool, int, FuturesAccountHistory, Configuration) -> None
+ def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_margin=None, available=None, point=None, currency=None, in_dual_mode=None, position_mode=None, enable_credit=None, position_initial_margin=None, maintenance_margin=None, bonus=None, enable_evolved_classic=None, cross_order_margin=None, cross_initial_margin=None, cross_maintenance_margin=None, cross_unrealised_pnl=None, cross_available=None, cross_margin_balance=None, cross_mmr=None, cross_imr=None, isolated_position_margin=None, enable_new_dual_mode=None, margin_mode=None, enable_tiered_mm=None, history=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, bool, str, bool, str, str, str, bool, str, str, str, str, str, str, str, str, str, bool, int, bool, FuturesAccountHistory, Configuration) -> None
"""FuturesAccount - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -97,6 +107,7 @@ def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_
self._point = None
self._currency = None
self._in_dual_mode = None
+ self._position_mode = None
self._enable_credit = None
self._position_initial_margin = None
self._maintenance_margin = None
@@ -107,9 +118,13 @@ def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_
self._cross_maintenance_margin = None
self._cross_unrealised_pnl = None
self._cross_available = None
+ self._cross_margin_balance = None
+ self._cross_mmr = None
+ self._cross_imr = None
self._isolated_position_margin = None
self._enable_new_dual_mode = None
self._margin_mode = None
+ self._enable_tiered_mm = None
self._history = None
self.discriminator = None
@@ -129,6 +144,8 @@ def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_
self.currency = currency
if in_dual_mode is not None:
self.in_dual_mode = in_dual_mode
+ if position_mode is not None:
+ self.position_mode = position_mode
if enable_credit is not None:
self.enable_credit = enable_credit
if position_initial_margin is not None:
@@ -149,12 +166,20 @@ def __init__(self, total=None, unrealised_pnl=None, position_margin=None, order_
self.cross_unrealised_pnl = cross_unrealised_pnl
if cross_available is not None:
self.cross_available = cross_available
+ if cross_margin_balance is not None:
+ self.cross_margin_balance = cross_margin_balance
+ if cross_mmr is not None:
+ self.cross_mmr = cross_mmr
+ if cross_imr is not None:
+ self.cross_imr = cross_imr
if isolated_position_margin is not None:
self.isolated_position_margin = isolated_position_margin
if enable_new_dual_mode is not None:
self.enable_new_dual_mode = enable_new_dual_mode
if margin_mode is not None:
self.margin_mode = margin_mode
+ if enable_tiered_mm is not None:
+ self.enable_tiered_mm = enable_tiered_mm
if history is not None:
self.history = history
@@ -254,7 +279,7 @@ def order_margin(self, order_margin):
def available(self):
"""Gets the available of this FuturesAccount. # noqa: E501
- The available balance for transferring or trading(including bonus. Bonus can't be be withdrawn. The transfer amount needs to deduct the bonus) # noqa: E501
+ Available balance for transferring or trading (including bonus. Bonus cannot be withdrawn, so transfer amount needs to deduct bonus) # noqa: E501
:return: The available of this FuturesAccount. # noqa: E501
:rtype: str
@@ -265,7 +290,7 @@ def available(self):
def available(self, available):
"""Sets the available of this FuturesAccount.
- The available balance for transferring or trading(including bonus. Bonus can't be be withdrawn. The transfer amount needs to deduct the bonus) # noqa: E501
+ Available balance for transferring or trading (including bonus. Bonus cannot be withdrawn, so transfer amount needs to deduct bonus) # noqa: E501
:param available: The available of this FuturesAccount. # noqa: E501
:type: str
@@ -277,7 +302,7 @@ def available(self, available):
def point(self):
"""Gets the point of this FuturesAccount. # noqa: E501
- POINT amount # noqa: E501
+ Point card amount # noqa: E501
:return: The point of this FuturesAccount. # noqa: E501
:rtype: str
@@ -288,7 +313,7 @@ def point(self):
def point(self, point):
"""Sets the point of this FuturesAccount.
- POINT amount # noqa: E501
+ Point card amount # noqa: E501
:param point: The point of this FuturesAccount. # noqa: E501
:type: str
@@ -300,7 +325,7 @@ def point(self, point):
def currency(self):
"""Gets the currency of this FuturesAccount. # noqa: E501
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:return: The currency of this FuturesAccount. # noqa: E501
:rtype: str
@@ -311,7 +336,7 @@ def currency(self):
def currency(self, currency):
"""Sets the currency of this FuturesAccount.
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:param currency: The currency of this FuturesAccount. # noqa: E501
:type: str
@@ -342,6 +367,29 @@ def in_dual_mode(self, in_dual_mode):
self._in_dual_mode = in_dual_mode
+ @property
+ def position_mode(self):
+ """Gets the position_mode of this FuturesAccount. # noqa: E501
+
+ Position mode: single - one-way, dual - dual-side, split - sub-positions (in_dual_mode is deprecated) # noqa: E501
+
+ :return: The position_mode of this FuturesAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._position_mode
+
+ @position_mode.setter
+ def position_mode(self, position_mode):
+ """Sets the position_mode of this FuturesAccount.
+
+ Position mode: single - one-way, dual - dual-side, split - sub-positions (in_dual_mode is deprecated) # noqa: E501
+
+ :param position_mode: The position_mode of this FuturesAccount. # noqa: E501
+ :type: str
+ """
+
+ self._position_mode = position_mode
+
@property
def enable_credit(self):
"""Gets the enable_credit of this FuturesAccount. # noqa: E501
@@ -369,7 +417,7 @@ def enable_credit(self, enable_credit):
def position_initial_margin(self):
"""Gets the position_initial_margin of this FuturesAccount. # noqa: E501
- Initial margin position, applicable to the portfolio margin account model # noqa: E501
+ Initial margin occupied by positions, applicable to unified account mode # noqa: E501
:return: The position_initial_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -380,7 +428,7 @@ def position_initial_margin(self):
def position_initial_margin(self, position_initial_margin):
"""Sets the position_initial_margin of this FuturesAccount.
- Initial margin position, applicable to the portfolio margin account model # noqa: E501
+ Initial margin occupied by positions, applicable to unified account mode # noqa: E501
:param position_initial_margin: The position_initial_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -392,7 +440,7 @@ def position_initial_margin(self, position_initial_margin):
def maintenance_margin(self):
"""Gets the maintenance_margin of this FuturesAccount. # noqa: E501
- The maintenance deposit occupied by the position is suitable for the new classic account margin model and unified account model # noqa: E501
+ Maintenance margin occupied by positions, applicable to new classic account margin mode and unified account mode # noqa: E501
:return: The maintenance_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -403,7 +451,7 @@ def maintenance_margin(self):
def maintenance_margin(self, maintenance_margin):
"""Sets the maintenance_margin of this FuturesAccount.
- The maintenance deposit occupied by the position is suitable for the new classic account margin model and unified account model # noqa: E501
+ Maintenance margin occupied by positions, applicable to new classic account margin mode and unified account mode # noqa: E501
:param maintenance_margin: The maintenance_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -415,7 +463,7 @@ def maintenance_margin(self, maintenance_margin):
def bonus(self):
"""Gets the bonus of this FuturesAccount. # noqa: E501
- Perpetual Contract Bonus # noqa: E501
+ Bonus # noqa: E501
:return: The bonus of this FuturesAccount. # noqa: E501
:rtype: str
@@ -426,7 +474,7 @@ def bonus(self):
def bonus(self, bonus):
"""Sets the bonus of this FuturesAccount.
- Perpetual Contract Bonus # noqa: E501
+ Bonus # noqa: E501
:param bonus: The bonus of this FuturesAccount. # noqa: E501
:type: str
@@ -461,7 +509,7 @@ def enable_evolved_classic(self, enable_evolved_classic):
def cross_order_margin(self):
"""Gets the cross_order_margin of this FuturesAccount. # noqa: E501
- Full -warehouse hanging order deposit, suitable for the new classic account margin model # noqa: E501
+ Cross margin order margin, applicable to new classic account margin mode # noqa: E501
:return: The cross_order_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -472,7 +520,7 @@ def cross_order_margin(self):
def cross_order_margin(self, cross_order_margin):
"""Sets the cross_order_margin of this FuturesAccount.
- Full -warehouse hanging order deposit, suitable for the new classic account margin model # noqa: E501
+ Cross margin order margin, applicable to new classic account margin mode # noqa: E501
:param cross_order_margin: The cross_order_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -484,7 +532,7 @@ def cross_order_margin(self, cross_order_margin):
def cross_initial_margin(self):
"""Gets the cross_initial_margin of this FuturesAccount. # noqa: E501
- The initial security deposit of the full warehouse is suitable for the new classic account margin model # noqa: E501
+ Cross margin initial margin, applicable to new classic account margin mode # noqa: E501
:return: The cross_initial_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -495,7 +543,7 @@ def cross_initial_margin(self):
def cross_initial_margin(self, cross_initial_margin):
"""Sets the cross_initial_margin of this FuturesAccount.
- The initial security deposit of the full warehouse is suitable for the new classic account margin model # noqa: E501
+ Cross margin initial margin, applicable to new classic account margin mode # noqa: E501
:param cross_initial_margin: The cross_initial_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -507,7 +555,7 @@ def cross_initial_margin(self, cross_initial_margin):
def cross_maintenance_margin(self):
"""Gets the cross_maintenance_margin of this FuturesAccount. # noqa: E501
- Maintain deposit in full warehouse, suitable for new classic account margin models # noqa: E501
+ Cross margin maintenance margin, applicable to new classic account margin mode # noqa: E501
:return: The cross_maintenance_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -518,7 +566,7 @@ def cross_maintenance_margin(self):
def cross_maintenance_margin(self, cross_maintenance_margin):
"""Sets the cross_maintenance_margin of this FuturesAccount.
- Maintain deposit in full warehouse, suitable for new classic account margin models # noqa: E501
+ Cross margin maintenance margin, applicable to new classic account margin mode # noqa: E501
:param cross_maintenance_margin: The cross_maintenance_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -530,7 +578,7 @@ def cross_maintenance_margin(self, cross_maintenance_margin):
def cross_unrealised_pnl(self):
"""Gets the cross_unrealised_pnl of this FuturesAccount. # noqa: E501
- The full warehouse does not achieve profit and loss, suitable for the new classic account margin model # noqa: E501
+ Cross margin unrealized P&L, applicable to new classic account margin mode # noqa: E501
:return: The cross_unrealised_pnl of this FuturesAccount. # noqa: E501
:rtype: str
@@ -541,7 +589,7 @@ def cross_unrealised_pnl(self):
def cross_unrealised_pnl(self, cross_unrealised_pnl):
"""Sets the cross_unrealised_pnl of this FuturesAccount.
- The full warehouse does not achieve profit and loss, suitable for the new classic account margin model # noqa: E501
+ Cross margin unrealized P&L, applicable to new classic account margin mode # noqa: E501
:param cross_unrealised_pnl: The cross_unrealised_pnl of this FuturesAccount. # noqa: E501
:type: str
@@ -553,7 +601,7 @@ def cross_unrealised_pnl(self, cross_unrealised_pnl):
def cross_available(self):
"""Gets the cross_available of this FuturesAccount. # noqa: E501
- Full warehouse available amount, suitable for the new classic account margin model # noqa: E501
+ Cross margin available balance, applicable to new classic account margin mode # noqa: E501
:return: The cross_available of this FuturesAccount. # noqa: E501
:rtype: str
@@ -564,7 +612,7 @@ def cross_available(self):
def cross_available(self, cross_available):
"""Sets the cross_available of this FuturesAccount.
- Full warehouse available amount, suitable for the new classic account margin model # noqa: E501
+ Cross margin available balance, applicable to new classic account margin mode # noqa: E501
:param cross_available: The cross_available of this FuturesAccount. # noqa: E501
:type: str
@@ -572,11 +620,80 @@ def cross_available(self, cross_available):
self._cross_available = cross_available
+ @property
+ def cross_margin_balance(self):
+ """Gets the cross_margin_balance of this FuturesAccount. # noqa: E501
+
+ Cross margin balance, applicable to new classic account margin mode # noqa: E501
+
+ :return: The cross_margin_balance of this FuturesAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._cross_margin_balance
+
+ @cross_margin_balance.setter
+ def cross_margin_balance(self, cross_margin_balance):
+ """Sets the cross_margin_balance of this FuturesAccount.
+
+ Cross margin balance, applicable to new classic account margin mode # noqa: E501
+
+ :param cross_margin_balance: The cross_margin_balance of this FuturesAccount. # noqa: E501
+ :type: str
+ """
+
+ self._cross_margin_balance = cross_margin_balance
+
+ @property
+ def cross_mmr(self):
+ """Gets the cross_mmr of this FuturesAccount. # noqa: E501
+
+ Cross margin maintenance margin rate, applicable to new classic account margin mode # noqa: E501
+
+ :return: The cross_mmr of this FuturesAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._cross_mmr
+
+ @cross_mmr.setter
+ def cross_mmr(self, cross_mmr):
+ """Sets the cross_mmr of this FuturesAccount.
+
+ Cross margin maintenance margin rate, applicable to new classic account margin mode # noqa: E501
+
+ :param cross_mmr: The cross_mmr of this FuturesAccount. # noqa: E501
+ :type: str
+ """
+
+ self._cross_mmr = cross_mmr
+
+ @property
+ def cross_imr(self):
+ """Gets the cross_imr of this FuturesAccount. # noqa: E501
+
+ Cross margin initial margin rate, applicable to new classic account margin mode # noqa: E501
+
+ :return: The cross_imr of this FuturesAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._cross_imr
+
+ @cross_imr.setter
+ def cross_imr(self, cross_imr):
+ """Sets the cross_imr of this FuturesAccount.
+
+ Cross margin initial margin rate, applicable to new classic account margin mode # noqa: E501
+
+ :param cross_imr: The cross_imr of this FuturesAccount. # noqa: E501
+ :type: str
+ """
+
+ self._cross_imr = cross_imr
+
@property
def isolated_position_margin(self):
"""Gets the isolated_position_margin of this FuturesAccount. # noqa: E501
- Ware -position margin, suitable for the new classic account margin model # noqa: E501
+ Isolated position margin, applicable to new classic account margin mode # noqa: E501
:return: The isolated_position_margin of this FuturesAccount. # noqa: E501
:rtype: str
@@ -587,7 +704,7 @@ def isolated_position_margin(self):
def isolated_position_margin(self, isolated_position_margin):
"""Sets the isolated_position_margin of this FuturesAccount.
- Ware -position margin, suitable for the new classic account margin model # noqa: E501
+ Isolated position margin, applicable to new classic account margin mode # noqa: E501
:param isolated_position_margin: The isolated_position_margin of this FuturesAccount. # noqa: E501
:type: str
@@ -641,6 +758,29 @@ def margin_mode(self, margin_mode):
self._margin_mode = margin_mode
+ @property
+ def enable_tiered_mm(self):
+ """Gets the enable_tiered_mm of this FuturesAccount. # noqa: E501
+
+ Whether to enable tiered maintenance margin calculation # noqa: E501
+
+ :return: The enable_tiered_mm of this FuturesAccount. # noqa: E501
+ :rtype: bool
+ """
+ return self._enable_tiered_mm
+
+ @enable_tiered_mm.setter
+ def enable_tiered_mm(self, enable_tiered_mm):
+ """Sets the enable_tiered_mm of this FuturesAccount.
+
+ Whether to enable tiered maintenance margin calculation # noqa: E501
+
+ :param enable_tiered_mm: The enable_tiered_mm of this FuturesAccount. # noqa: E501
+ :type: bool
+ """
+
+ self._enable_tiered_mm = enable_tiered_mm
+
@property
def history(self):
"""Gets the history of this FuturesAccount. # noqa: E501
diff --git a/gate_api/models/futures_account_book.py b/gate_api/models/futures_account_book.py
index 558f5e9..ff4e125 100644
--- a/gate_api/models/futures_account_book.py
+++ b/gate_api/models/futures_account_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -161,7 +161,7 @@ def balance(self, balance):
def type(self):
"""Gets the type of this FuturesAccountBook. # noqa: E501
- Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction # noqa: E501
+ Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction # noqa: E501
:return: The type of this FuturesAccountBook. # noqa: E501
:rtype: str
@@ -172,7 +172,7 @@ def type(self):
def type(self, type):
"""Sets the type of this FuturesAccountBook.
- Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction # noqa: E501
+ Change types: - dnw: Deposit and withdrawal - pnl: Profit and loss from position reduction - fee: Trading fees - refr: Referrer rebates - fund: Funding fees - point_dnw: Point card deposit and withdrawal - point_fee: Point card trading fees - point_refr: Point card referrer rebates - bonus_offset: Trial fund deduction # noqa: E501
:param type: The type of this FuturesAccountBook. # noqa: E501
:type: str
@@ -213,7 +213,7 @@ def text(self, text):
def contract(self):
"""Gets the contract of this FuturesAccountBook. # noqa: E501
- Futures contract, the field is only available for data after 2023-10-30. # noqa: E501
+ Futures contract, the field is only available for data after 2023-10-30 # noqa: E501
:return: The contract of this FuturesAccountBook. # noqa: E501
:rtype: str
@@ -224,7 +224,7 @@ def contract(self):
def contract(self, contract):
"""Sets the contract of this FuturesAccountBook.
- Futures contract, the field is only available for data after 2023-10-30. # noqa: E501
+ Futures contract, the field is only available for data after 2023-10-30 # noqa: E501
:param contract: The contract of this FuturesAccountBook. # noqa: E501
:type: str
@@ -259,7 +259,7 @@ def trade_id(self, trade_id):
def id(self):
"""Gets the id of this FuturesAccountBook. # noqa: E501
- 账户变更记录 id # noqa: E501
+ Account change record ID # noqa: E501
:return: The id of this FuturesAccountBook. # noqa: E501
:rtype: str
@@ -270,7 +270,7 @@ def id(self):
def id(self, id):
"""Sets the id of this FuturesAccountBook.
- 账户变更记录 id # noqa: E501
+ Account change record ID # noqa: E501
:param id: The id of this FuturesAccountBook. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_account_history.py b/gate_api/models/futures_account_history.py
index 86fa0c3..6960744 100644
--- a/gate_api/models/futures_account_history.py
+++ b/gate_api/models/futures_account_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/futures_auto_deleverage.py b/gate_api/models/futures_auto_deleverage.py
index 2a70fbf..f6064c7 100644
--- a/gate_api/models/futures_auto_deleverage.py
+++ b/gate_api/models/futures_auto_deleverage.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -217,7 +217,7 @@ def leverage(self, leverage):
def cross_leverage_limit(self):
"""Gets the cross_leverage_limit of this FuturesAutoDeleverage. # noqa: E501
- Cross margin leverage(valid only when `leverage` is 0) # noqa: E501
+ Cross margin leverage (valid only when `leverage` is 0) # noqa: E501
:return: The cross_leverage_limit of this FuturesAutoDeleverage. # noqa: E501
:rtype: str
@@ -228,7 +228,7 @@ def cross_leverage_limit(self):
def cross_leverage_limit(self, cross_leverage_limit):
"""Sets the cross_leverage_limit of this FuturesAutoDeleverage.
- Cross margin leverage(valid only when `leverage` is 0) # noqa: E501
+ Cross margin leverage (valid only when `leverage` is 0) # noqa: E501
:param cross_leverage_limit: The cross_leverage_limit of this FuturesAutoDeleverage. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_batch_amend_order_request.py b/gate_api/models/futures_batch_amend_order_request.py
index a421bca..c12d869 100644
--- a/gate_api/models/futures_batch_amend_order_request.py
+++ b/gate_api/models/futures_batch_amend_order_request.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -123,7 +123,7 @@ def text(self, text):
def size(self):
"""Gets the size of this FuturesBatchAmendOrderRequest. # noqa: E501
- The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. # noqa: E501
+ New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. # noqa: E501
:return: The size of this FuturesBatchAmendOrderRequest. # noqa: E501
:rtype: int
@@ -134,7 +134,7 @@ def size(self):
def size(self, size):
"""Sets the size of this FuturesBatchAmendOrderRequest.
- The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. # noqa: E501
+ New order size, including filled size. - If less than or equal to the filled quantity, the order will be cancelled. - The new order side must be identical to the original one. - Close order size cannot be modified. - For reduce-only orders, increasing the size may cancel other reduce-only orders. - If the price is not modified, decreasing the size will not affect the depth queue, while increasing the size will place it at the end of the current price level. # noqa: E501
:param size: The size of this FuturesBatchAmendOrderRequest. # noqa: E501
:type: int
@@ -146,7 +146,7 @@ def size(self, size):
def price(self):
"""Gets the price of this FuturesBatchAmendOrderRequest. # noqa: E501
- New order price. # noqa: E501
+ New order price # noqa: E501
:return: The price of this FuturesBatchAmendOrderRequest. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def price(self):
def price(self, price):
"""Sets the price of this FuturesBatchAmendOrderRequest.
- New order price. # noqa: E501
+ New order price # noqa: E501
:param price: The price of this FuturesBatchAmendOrderRequest. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def price(self, price):
def amend_text(self):
"""Gets the amend_text of this FuturesBatchAmendOrderRequest. # noqa: E501
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:return: The amend_text of this FuturesBatchAmendOrderRequest. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def amend_text(self):
def amend_text(self, amend_text):
"""Sets the amend_text of this FuturesBatchAmendOrderRequest.
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:param amend_text: The amend_text of this FuturesBatchAmendOrderRequest. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_candlestick.py b/gate_api/models/futures_candlestick.py
index 70af555..246d19d 100644
--- a/gate_api/models/futures_candlestick.py
+++ b/gate_api/models/futures_candlestick.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/futures_fee.py b/gate_api/models/futures_fee.py
index a05f42e..07aa347 100644
--- a/gate_api/models/futures_fee.py
+++ b/gate_api/models/futures_fee.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/futures_index_constituents.py b/gate_api/models/futures_index_constituents.py
index d0a158d..12232a7 100644
--- a/gate_api/models/futures_index_constituents.py
+++ b/gate_api/models/futures_index_constituents.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/futures_initial_order.py b/gate_api/models/futures_initial_order.py
index 23da744..7f3999c 100644
--- a/gate_api/models/futures_initial_order.py
+++ b/gate_api/models/futures_initial_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -125,7 +125,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this FuturesInitialOrder. # noqa: E501
- Order size. Positive size means to buy, while negative one means to sell. Set to 0 to close the position # noqa: E501
+ Represents the number of contracts that need to be closed, full closing: size=0 Partial closing: plan-close-short-position size>0 Partial closing: plan-close-long-position size<0 # noqa: E501
:return: The size of this FuturesInitialOrder. # noqa: E501
:rtype: int
@@ -136,7 +136,7 @@ def size(self):
def size(self, size):
"""Sets the size of this FuturesInitialOrder.
- Order size. Positive size means to buy, while negative one means to sell. Set to 0 to close the position # noqa: E501
+ Represents the number of contracts that need to be closed, full closing: size=0 Partial closing: plan-close-short-position size>0 Partial closing: plan-close-long-position size<0 # noqa: E501
:param size: The size of this FuturesInitialOrder. # noqa: E501
:type: int
@@ -173,7 +173,7 @@ def price(self, price):
def close(self):
"""Gets the close of this FuturesInitialOrder. # noqa: E501
- Set to true if trying to close the position # noqa: E501
+ When all positions are closed in a single position mode, it must be set to true to perform the closing operation When partially closed positions in single-store mode/double-store mode, you can not set close, or close=false # noqa: E501
:return: The close of this FuturesInitialOrder. # noqa: E501
:rtype: bool
@@ -184,7 +184,7 @@ def close(self):
def close(self, close):
"""Sets the close of this FuturesInitialOrder.
- Set to true if trying to close the position # noqa: E501
+ When all positions are closed in a single position mode, it must be set to true to perform the closing operation When partially closed positions in single-store mode/double-store mode, you can not set close, or close=false # noqa: E501
:param close: The close of this FuturesInitialOrder. # noqa: E501
:type: bool
@@ -196,7 +196,7 @@ def close(self, close):
def tif(self):
"""Gets the tif of this FuturesInitialOrder. # noqa: E501
- Time in force. If using market price, only `ioc` is supported. - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled # noqa: E501
+ Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled # noqa: E501
:return: The tif of this FuturesInitialOrder. # noqa: E501
:rtype: str
@@ -207,7 +207,7 @@ def tif(self):
def tif(self, tif):
"""Sets the tif of this FuturesInitialOrder.
- Time in force. If using market price, only `ioc` is supported. - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled # noqa: E501
+ Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled # noqa: E501
:param tif: The tif of this FuturesInitialOrder. # noqa: E501
:type: str
@@ -225,7 +225,7 @@ def tif(self, tif):
def text(self):
"""Gets the text of this FuturesInitialOrder. # noqa: E501
- The source of the order, including: - web: web - api: api - app: app # noqa: E501
+ The source of the order, including: - web: Web - api: API call - app: Mobile app # noqa: E501
:return: The text of this FuturesInitialOrder. # noqa: E501
:rtype: str
@@ -236,7 +236,7 @@ def text(self):
def text(self, text):
"""Sets the text of this FuturesInitialOrder.
- The source of the order, including: - web: web - api: api - app: app # noqa: E501
+ The source of the order, including: - web: Web - api: API call - app: Mobile app # noqa: E501
:param text: The text of this FuturesInitialOrder. # noqa: E501
:type: str
@@ -248,7 +248,7 @@ def text(self, text):
def reduce_only(self):
"""Gets the reduce_only of this FuturesInitialOrder. # noqa: E501
- Set to true to create a reduce-only order # noqa: E501
+ When set to true, perform automatic position reduction operation. Set to true to ensure that the order will not open a new position, and is only used to close or reduce positions # noqa: E501
:return: The reduce_only of this FuturesInitialOrder. # noqa: E501
:rtype: bool
@@ -259,7 +259,7 @@ def reduce_only(self):
def reduce_only(self, reduce_only):
"""Sets the reduce_only of this FuturesInitialOrder.
- Set to true to create a reduce-only order # noqa: E501
+ When set to true, perform automatic position reduction operation. Set to true to ensure that the order will not open a new position, and is only used to close or reduce positions # noqa: E501
:param reduce_only: The reduce_only of this FuturesInitialOrder. # noqa: E501
:type: bool
@@ -271,7 +271,7 @@ def reduce_only(self, reduce_only):
def auto_size(self):
"""Gets the auto_size of this FuturesInitialOrder. # noqa: E501
- Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 # noqa: E501
+ Single position mode: auto_size is not required Dual position mode full closing (size=0): auto_size must be set, close_long for closing long positions, close_short for closing short positions Dual position mode partial closing (size≠0): auto_size is not required # noqa: E501
:return: The auto_size of this FuturesInitialOrder. # noqa: E501
:rtype: str
@@ -282,7 +282,7 @@ def auto_size(self):
def auto_size(self, auto_size):
"""Sets the auto_size of this FuturesInitialOrder.
- Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0 # noqa: E501
+ Single position mode: auto_size is not required Dual position mode full closing (size=0): auto_size must be set, close_long for closing long positions, close_short for closing short positions Dual position mode partial closing (size≠0): auto_size is not required # noqa: E501
:param auto_size: The auto_size of this FuturesInitialOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_limit_risk_tiers.py b/gate_api/models/futures_limit_risk_tiers.py
index 6afde67..a636a2e 100644
--- a/gate_api/models/futures_limit_risk_tiers.py
+++ b/gate_api/models/futures_limit_risk_tiers.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -38,7 +38,8 @@ class FuturesLimitRiskTiers(object):
'initial_rate': 'str',
'maintenance_rate': 'str',
'leverage_max': 'str',
- 'contract': 'str'
+ 'contract': 'str',
+ 'deduction': 'str'
}
attribute_map = {
@@ -47,11 +48,12 @@ class FuturesLimitRiskTiers(object):
'initial_rate': 'initial_rate',
'maintenance_rate': 'maintenance_rate',
'leverage_max': 'leverage_max',
- 'contract': 'contract'
+ 'contract': 'contract',
+ 'deduction': 'deduction'
}
- def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_rate=None, leverage_max=None, contract=None, local_vars_configuration=None): # noqa: E501
- # type: (int, str, str, str, str, str, Configuration) -> None
+ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_rate=None, leverage_max=None, contract=None, deduction=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, str, str, str, str, str, Configuration) -> None
"""FuturesLimitRiskTiers - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -63,6 +65,7 @@ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_ra
self._maintenance_rate = None
self._leverage_max = None
self._contract = None
+ self._deduction = None
self.discriminator = None
if tier is not None:
@@ -77,6 +80,8 @@ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_ra
self.leverage_max = leverage_max
if contract is not None:
self.contract = contract
+ if deduction is not None:
+ self.deduction = deduction
@property
def tier(self):
@@ -197,7 +202,7 @@ def leverage_max(self, leverage_max):
def contract(self):
"""Gets the contract of this FuturesLimitRiskTiers. # noqa: E501
- Markets, visible only during market pagination requests # noqa: E501
+ Market, only visible when market pagination is requested # noqa: E501
:return: The contract of this FuturesLimitRiskTiers. # noqa: E501
:rtype: str
@@ -208,7 +213,7 @@ def contract(self):
def contract(self, contract):
"""Sets the contract of this FuturesLimitRiskTiers.
- Markets, visible only during market pagination requests # noqa: E501
+ Market, only visible when market pagination is requested # noqa: E501
:param contract: The contract of this FuturesLimitRiskTiers. # noqa: E501
:type: str
@@ -216,6 +221,29 @@ def contract(self, contract):
self._contract = contract
+ @property
+ def deduction(self):
+ """Gets the deduction of this FuturesLimitRiskTiers. # noqa: E501
+
+ Maintenance margin quick calculation deduction amount # noqa: E501
+
+ :return: The deduction of this FuturesLimitRiskTiers. # noqa: E501
+ :rtype: str
+ """
+ return self._deduction
+
+ @deduction.setter
+ def deduction(self, deduction):
+ """Sets the deduction of this FuturesLimitRiskTiers.
+
+ Maintenance margin quick calculation deduction amount # noqa: E501
+
+ :param deduction: The deduction of this FuturesLimitRiskTiers. # noqa: E501
+ :type: str
+ """
+
+ self._deduction = deduction
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/futures_liq_order.py b/gate_api/models/futures_liq_order.py
index 2fe5112..fabcb0a 100644
--- a/gate_api/models/futures_liq_order.py
+++ b/gate_api/models/futures_liq_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -36,6 +36,7 @@ class FuturesLiqOrder(object):
'time': 'int',
'contract': 'str',
'size': 'int',
+ 'order_size': 'int',
'order_price': 'str',
'fill_price': 'str',
'left': 'int'
@@ -45,13 +46,14 @@ class FuturesLiqOrder(object):
'time': 'time',
'contract': 'contract',
'size': 'size',
+ 'order_size': 'order_size',
'order_price': 'order_price',
'fill_price': 'fill_price',
'left': 'left'
}
- def __init__(self, time=None, contract=None, size=None, order_price=None, fill_price=None, left=None, local_vars_configuration=None): # noqa: E501
- # type: (int, str, int, str, str, int, Configuration) -> None
+ def __init__(self, time=None, contract=None, size=None, order_size=None, order_price=None, fill_price=None, left=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, int, int, str, str, int, Configuration) -> None
"""FuturesLiqOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -60,6 +62,7 @@ def __init__(self, time=None, contract=None, size=None, order_price=None, fill_p
self._time = None
self._contract = None
self._size = None
+ self._order_size = None
self._order_price = None
self._fill_price = None
self._left = None
@@ -71,6 +74,8 @@ def __init__(self, time=None, contract=None, size=None, order_price=None, fill_p
self.contract = contract
if size is not None:
self.size = size
+ if order_size is not None:
+ self.order_size = order_size
if order_price is not None:
self.order_price = order_price
if fill_price is not None:
@@ -147,6 +152,29 @@ def size(self, size):
self._size = size
+ @property
+ def order_size(self):
+ """Gets the order_size of this FuturesLiqOrder. # noqa: E501
+
+ Number of forced liquidation orders # noqa: E501
+
+ :return: The order_size of this FuturesLiqOrder. # noqa: E501
+ :rtype: int
+ """
+ return self._order_size
+
+ @order_size.setter
+ def order_size(self, order_size):
+ """Sets the order_size of this FuturesLiqOrder.
+
+ Number of forced liquidation orders # noqa: E501
+
+ :param order_size: The order_size of this FuturesLiqOrder. # noqa: E501
+ :type: int
+ """
+
+ self._order_size = order_size
+
@property
def order_price(self):
"""Gets the order_price of this FuturesLiqOrder. # noqa: E501
diff --git a/gate_api/models/futures_liquidate.py b/gate_api/models/futures_liquidate.py
index 99727e4..549e71f 100644
--- a/gate_api/models/futures_liquidate.py
+++ b/gate_api/models/futures_liquidate.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -158,7 +158,7 @@ def contract(self, contract):
def leverage(self):
"""Gets the leverage of this FuturesLiquidate. # noqa: E501
- Position leverage. Not returned in public endpoints. # noqa: E501
+ Position leverage. Not returned in public endpoints # noqa: E501
:return: The leverage of this FuturesLiquidate. # noqa: E501
:rtype: str
@@ -169,7 +169,7 @@ def leverage(self):
def leverage(self, leverage):
"""Sets the leverage of this FuturesLiquidate.
- Position leverage. Not returned in public endpoints. # noqa: E501
+ Position leverage. Not returned in public endpoints # noqa: E501
:param leverage: The leverage of this FuturesLiquidate. # noqa: E501
:type: str
@@ -204,7 +204,7 @@ def size(self, size):
def margin(self):
"""Gets the margin of this FuturesLiquidate. # noqa: E501
- Position margin. Not returned in public endpoints. # noqa: E501
+ Position margin. Not returned in public endpoints # noqa: E501
:return: The margin of this FuturesLiquidate. # noqa: E501
:rtype: str
@@ -215,7 +215,7 @@ def margin(self):
def margin(self, margin):
"""Sets the margin of this FuturesLiquidate.
- Position margin. Not returned in public endpoints. # noqa: E501
+ Position margin. Not returned in public endpoints # noqa: E501
:param margin: The margin of this FuturesLiquidate. # noqa: E501
:type: str
@@ -227,7 +227,7 @@ def margin(self, margin):
def entry_price(self):
"""Gets the entry_price of this FuturesLiquidate. # noqa: E501
- Average entry price. Not returned in public endpoints. # noqa: E501
+ Average entry price. Not returned in public endpoints # noqa: E501
:return: The entry_price of this FuturesLiquidate. # noqa: E501
:rtype: str
@@ -238,7 +238,7 @@ def entry_price(self):
def entry_price(self, entry_price):
"""Sets the entry_price of this FuturesLiquidate.
- Average entry price. Not returned in public endpoints. # noqa: E501
+ Average entry price. Not returned in public endpoints # noqa: E501
:param entry_price: The entry_price of this FuturesLiquidate. # noqa: E501
:type: str
@@ -250,7 +250,7 @@ def entry_price(self, entry_price):
def liq_price(self):
"""Gets the liq_price of this FuturesLiquidate. # noqa: E501
- Liquidation price. Not returned in public endpoints. # noqa: E501
+ Liquidation price. Not returned in public endpoints # noqa: E501
:return: The liq_price of this FuturesLiquidate. # noqa: E501
:rtype: str
@@ -261,7 +261,7 @@ def liq_price(self):
def liq_price(self, liq_price):
"""Sets the liq_price of this FuturesLiquidate.
- Liquidation price. Not returned in public endpoints. # noqa: E501
+ Liquidation price. Not returned in public endpoints # noqa: E501
:param liq_price: The liq_price of this FuturesLiquidate. # noqa: E501
:type: str
@@ -273,7 +273,7 @@ def liq_price(self, liq_price):
def mark_price(self):
"""Gets the mark_price of this FuturesLiquidate. # noqa: E501
- Mark price. Not returned in public endpoints. # noqa: E501
+ Mark price. Not returned in public endpoints # noqa: E501
:return: The mark_price of this FuturesLiquidate. # noqa: E501
:rtype: str
@@ -284,7 +284,7 @@ def mark_price(self):
def mark_price(self, mark_price):
"""Sets the mark_price of this FuturesLiquidate.
- Mark price. Not returned in public endpoints. # noqa: E501
+ Mark price. Not returned in public endpoints # noqa: E501
:param mark_price: The mark_price of this FuturesLiquidate. # noqa: E501
:type: str
@@ -296,7 +296,7 @@ def mark_price(self, mark_price):
def order_id(self):
"""Gets the order_id of this FuturesLiquidate. # noqa: E501
- Liquidation order ID. Not returned in public endpoints. # noqa: E501
+ Liquidation order ID. Not returned in public endpoints # noqa: E501
:return: The order_id of this FuturesLiquidate. # noqa: E501
:rtype: int
@@ -307,7 +307,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this FuturesLiquidate.
- Liquidation order ID. Not returned in public endpoints. # noqa: E501
+ Liquidation order ID. Not returned in public endpoints # noqa: E501
:param order_id: The order_id of this FuturesLiquidate. # noqa: E501
:type: int
diff --git a/gate_api/models/futures_order.py b/gate_api/models/futures_order.py
index 25ba1f2..0f60281 100644
--- a/gate_api/models/futures_order.py
+++ b/gate_api/models/futures_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -36,6 +36,7 @@ class FuturesOrder(object):
'id': 'int',
'user': 'int',
'create_time': 'float',
+ 'update_time': 'float',
'finish_time': 'float',
'finish_as': 'str',
'status': 'str',
@@ -59,13 +60,15 @@ class FuturesOrder(object):
'stp_id': 'int',
'stp_act': 'str',
'amend_text': 'str',
- 'biz_info': 'str'
+ 'limit_vip': 'int',
+ 'pid': 'int'
}
attribute_map = {
'id': 'id',
'user': 'user',
'create_time': 'create_time',
+ 'update_time': 'update_time',
'finish_time': 'finish_time',
'finish_as': 'finish_as',
'status': 'status',
@@ -89,11 +92,12 @@ class FuturesOrder(object):
'stp_id': 'stp_id',
'stp_act': 'stp_act',
'amend_text': 'amend_text',
- 'biz_info': 'biz_info'
+ 'limit_vip': 'limit_vip',
+ 'pid': 'pid'
}
- def __init__(self, id=None, user=None, create_time=None, finish_time=None, finish_as=None, status=None, contract=None, size=None, iceberg=None, price=None, close=False, is_close=None, reduce_only=False, is_reduce_only=None, is_liq=None, tif='gtc', left=None, fill_price=None, text=None, tkfr=None, mkfr=None, refu=None, auto_size=None, stp_id=None, stp_act=None, amend_text=None, biz_info=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, float, float, str, str, str, int, int, str, bool, bool, bool, bool, bool, str, int, str, str, str, str, int, str, int, str, str, str, Configuration) -> None
+ def __init__(self, id=None, user=None, create_time=None, update_time=None, finish_time=None, finish_as=None, status=None, contract=None, size=None, iceberg=None, price=None, close=False, is_close=None, reduce_only=False, is_reduce_only=None, is_liq=None, tif='gtc', left=None, fill_price=None, text=None, tkfr=None, mkfr=None, refu=None, auto_size=None, stp_id=None, stp_act=None, amend_text=None, limit_vip=None, pid=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, float, float, float, str, str, str, int, int, str, bool, bool, bool, bool, bool, str, int, str, str, str, str, int, str, int, str, str, int, int, Configuration) -> None
"""FuturesOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -102,6 +106,7 @@ def __init__(self, id=None, user=None, create_time=None, finish_time=None, finis
self._id = None
self._user = None
self._create_time = None
+ self._update_time = None
self._finish_time = None
self._finish_as = None
self._status = None
@@ -125,7 +130,8 @@ def __init__(self, id=None, user=None, create_time=None, finish_time=None, finis
self._stp_id = None
self._stp_act = None
self._amend_text = None
- self._biz_info = None
+ self._limit_vip = None
+ self._pid = None
self.discriminator = None
if id is not None:
@@ -134,6 +140,8 @@ def __init__(self, id=None, user=None, create_time=None, finish_time=None, finis
self.user = user
if create_time is not None:
self.create_time = create_time
+ if update_time is not None:
+ self.update_time = update_time
if finish_time is not None:
self.finish_time = finish_time
if finish_as is not None:
@@ -178,8 +186,10 @@ def __init__(self, id=None, user=None, create_time=None, finish_time=None, finis
self.stp_act = stp_act
if amend_text is not None:
self.amend_text = amend_text
- if biz_info is not None:
- self.biz_info = biz_info
+ if limit_vip is not None:
+ self.limit_vip = limit_vip
+ if pid is not None:
+ self.pid = pid
@property
def id(self):
@@ -250,6 +260,29 @@ def create_time(self, create_time):
self._create_time = create_time
+ @property
+ def update_time(self):
+ """Gets the update_time of this FuturesOrder. # noqa: E501
+
+ OrderUpdateTime # noqa: E501
+
+ :return: The update_time of this FuturesOrder. # noqa: E501
+ :rtype: float
+ """
+ return self._update_time
+
+ @update_time.setter
+ def update_time(self, update_time):
+ """Sets the update_time of this FuturesOrder.
+
+ OrderUpdateTime # noqa: E501
+
+ :param update_time: The update_time of this FuturesOrder. # noqa: E501
+ :type: float
+ """
+
+ self._update_time = update_time
+
@property
def finish_time(self):
"""Gets the finish_time of this FuturesOrder. # noqa: E501
@@ -277,7 +310,7 @@ def finish_time(self, finish_time):
def finish_as(self):
"""Gets the finish_as of this FuturesOrder. # noqa: E501
- How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
+ How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
:return: The finish_as of this FuturesOrder. # noqa: E501
:rtype: str
@@ -288,7 +321,7 @@ def finish_as(self):
def finish_as(self, finish_as):
"""Sets the finish_as of this FuturesOrder.
- How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
+ How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention # noqa: E501
:param finish_as: The finish_as of this FuturesOrder. # noqa: E501
:type: str
@@ -306,7 +339,7 @@ def finish_as(self, finish_as):
def status(self):
"""Gets the status of this FuturesOrder. # noqa: E501
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:return: The status of this FuturesOrder. # noqa: E501
:rtype: str
@@ -317,7 +350,7 @@ def status(self):
def status(self, status):
"""Sets the status of this FuturesOrder.
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:param status: The status of this FuturesOrder. # noqa: E501
:type: str
@@ -360,7 +393,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this FuturesOrder. # noqa: E501
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:return: The size of this FuturesOrder. # noqa: E501
:rtype: int
@@ -371,7 +404,7 @@ def size(self):
def size(self, size):
"""Sets the size of this FuturesOrder.
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:param size: The size of this FuturesOrder. # noqa: E501
:type: int
@@ -385,7 +418,7 @@ def size(self, size):
def iceberg(self):
"""Gets the iceberg of this FuturesOrder. # noqa: E501
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:return: The iceberg of this FuturesOrder. # noqa: E501
:rtype: int
@@ -396,7 +429,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this FuturesOrder.
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:param iceberg: The iceberg of this FuturesOrder. # noqa: E501
:type: int
@@ -408,7 +441,7 @@ def iceberg(self, iceberg):
def price(self):
"""Gets the price of this FuturesOrder. # noqa: E501
- Order price. 0 for market order with `tif` set as `ioc` # noqa: E501
+ Order price. Price of 0 with `tif` set to `ioc` represents a market order. # noqa: E501
:return: The price of this FuturesOrder. # noqa: E501
:rtype: str
@@ -419,7 +452,7 @@ def price(self):
def price(self, price):
"""Sets the price of this FuturesOrder.
- Order price. 0 for market order with `tif` set as `ioc` # noqa: E501
+ Order price. Price of 0 with `tif` set to `ioc` represents a market order. # noqa: E501
:param price: The price of this FuturesOrder. # noqa: E501
:type: str
@@ -575,7 +608,7 @@ def tif(self, tif):
def left(self):
"""Gets the left of this FuturesOrder. # noqa: E501
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:return: The left of this FuturesOrder. # noqa: E501
:rtype: int
@@ -586,7 +619,7 @@ def left(self):
def left(self, left):
"""Sets the left of this FuturesOrder.
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:param left: The left of this FuturesOrder. # noqa: E501
:type: int
@@ -598,7 +631,7 @@ def left(self, left):
def fill_price(self):
"""Gets the fill_price of this FuturesOrder. # noqa: E501
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:return: The fill_price of this FuturesOrder. # noqa: E501
:rtype: str
@@ -609,7 +642,7 @@ def fill_price(self):
def fill_price(self, fill_price):
"""Sets the fill_price of this FuturesOrder.
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:param fill_price: The fill_price of this FuturesOrder. # noqa: E501
:type: str
@@ -621,7 +654,7 @@ def fill_price(self, fill_price):
def text(self):
"""Gets the text of this FuturesOrder. # noqa: E501
- 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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance # noqa: E501
+ Custom order 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(.) In addition to user-defined information, the following are internal reserved fields that identify the order source: - web: Web - api: API call - app: Mobile app - auto_deleveraging: Automatic deleveraging - liquidation: Forced liquidation of positions under the old classic mode - liq-xxx: a. Forced liquidation of positions under the new classic mode, including isolated margin, one-way cross margin, and non-hedged positions under two-way cross margin. b. Forced liquidation of isolated positions under the unified account single-currency margin mode - hedge-liq-xxx: Forced liquidation of hedged positions under the new classic mode two-way cross margin, i.e., simultaneously closing long and short positions - pm_liquidate: Forced liquidation under unified account multi-currency margin mode - comb_margin_liquidate: Forced liquidation under unified account portfolio margin mode - scm_liquidate: Forced liquidation of positions under unified account single-currency margin mode - insurance: Insurance # noqa: E501
:return: The text of this FuturesOrder. # noqa: E501
:rtype: str
@@ -632,7 +665,7 @@ def text(self):
def text(self, text):
"""Sets the text of this FuturesOrder.
- 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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance # noqa: E501
+ Custom order 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(.) In addition to user-defined information, the following are internal reserved fields that identify the order source: - web: Web - api: API call - app: Mobile app - auto_deleveraging: Automatic deleveraging - liquidation: Forced liquidation of positions under the old classic mode - liq-xxx: a. Forced liquidation of positions under the new classic mode, including isolated margin, one-way cross margin, and non-hedged positions under two-way cross margin. b. Forced liquidation of isolated positions under the unified account single-currency margin mode - hedge-liq-xxx: Forced liquidation of hedged positions under the new classic mode two-way cross margin, i.e., simultaneously closing long and short positions - pm_liquidate: Forced liquidation under unified account multi-currency margin mode - comb_margin_liquidate: Forced liquidation under unified account portfolio margin mode - scm_liquidate: Forced liquidation of positions under unified account single-currency margin mode - insurance: Insurance # noqa: E501
:param text: The text of this FuturesOrder. # noqa: E501
:type: str
@@ -690,7 +723,7 @@ def mkfr(self, mkfr):
def refu(self):
"""Gets the refu of this FuturesOrder. # noqa: E501
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:return: The refu of this FuturesOrder. # noqa: E501
:rtype: int
@@ -701,7 +734,7 @@ def refu(self):
def refu(self, refu):
"""Sets the refu of this FuturesOrder.
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:param refu: The refu of this FuturesOrder. # noqa: E501
:type: int
@@ -765,7 +798,7 @@ def stp_id(self, stp_id):
def stp_act(self):
"""Gets the stp_act of this FuturesOrder. # noqa: E501
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:return: The stp_act of this FuturesOrder. # noqa: E501
:rtype: str
@@ -776,7 +809,7 @@ def stp_act(self):
def stp_act(self, stp_act):
"""Sets the stp_act of this FuturesOrder.
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:param stp_act: The stp_act of this FuturesOrder. # noqa: E501
:type: str
@@ -814,27 +847,50 @@ def amend_text(self, amend_text):
self._amend_text = amend_text
@property
- def biz_info(self):
- """Gets the biz_info of this FuturesOrder. # noqa: E501
+ def limit_vip(self):
+ """Gets the limit_vip of this FuturesOrder. # noqa: E501
- Additional information # noqa: E501
+ Counterparty user's VIP level for limit order fills. Current order will only match with orders whose VIP level is less than or equal to the specified level. Only 11~16 are supported; default is 0 # noqa: E501
- :return: The biz_info of this FuturesOrder. # noqa: E501
- :rtype: str
+ :return: The limit_vip of this FuturesOrder. # noqa: E501
+ :rtype: int
"""
- return self._biz_info
+ return self._limit_vip
- @biz_info.setter
- def biz_info(self, biz_info):
- """Sets the biz_info of this FuturesOrder.
+ @limit_vip.setter
+ def limit_vip(self, limit_vip):
+ """Sets the limit_vip of this FuturesOrder.
- Additional information # noqa: E501
+ Counterparty user's VIP level for limit order fills. Current order will only match with orders whose VIP level is less than or equal to the specified level. Only 11~16 are supported; default is 0 # noqa: E501
- :param biz_info: The biz_info of this FuturesOrder. # noqa: E501
- :type: str
+ :param limit_vip: The limit_vip of this FuturesOrder. # noqa: E501
+ :type: int
+ """
+
+ self._limit_vip = limit_vip
+
+ @property
+ def pid(self):
+ """Gets the pid of this FuturesOrder. # noqa: E501
+
+ Position ID # noqa: E501
+
+ :return: The pid of this FuturesOrder. # noqa: E501
+ :rtype: int
+ """
+ return self._pid
+
+ @pid.setter
+ def pid(self, pid):
+ """Sets the pid of this FuturesOrder.
+
+ Position ID # noqa: E501
+
+ :param pid: The pid of this FuturesOrder. # noqa: E501
+ :type: int
"""
- self._biz_info = biz_info
+ self._pid = pid
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/futures_order_amendment.py b/gate_api/models/futures_order_amendment.py
index d50351e..1232631 100644
--- a/gate_api/models/futures_order_amendment.py
+++ b/gate_api/models/futures_order_amendment.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -36,20 +36,18 @@ class FuturesOrderAmendment(object):
'size': 'int',
'price': 'str',
'amend_text': 'str',
- 'biz_info': 'str',
- 'bbo': 'str'
+ 'text': 'str'
}
attribute_map = {
'size': 'size',
'price': 'price',
'amend_text': 'amend_text',
- 'biz_info': 'biz_info',
- 'bbo': 'bbo'
+ 'text': 'text'
}
- def __init__(self, size=None, price=None, amend_text=None, biz_info=None, bbo=None, local_vars_configuration=None): # noqa: E501
- # type: (int, str, str, str, str, Configuration) -> None
+ def __init__(self, size=None, price=None, amend_text=None, text=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, str, str, Configuration) -> None
"""FuturesOrderAmendment - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -58,8 +56,7 @@ def __init__(self, size=None, price=None, amend_text=None, biz_info=None, bbo=No
self._size = None
self._price = None
self._amend_text = None
- self._biz_info = None
- self._bbo = None
+ self._text = None
self.discriminator = None
if size is not None:
@@ -68,10 +65,8 @@ def __init__(self, size=None, price=None, amend_text=None, biz_info=None, bbo=No
self.price = price
if amend_text is not None:
self.amend_text = amend_text
- if biz_info is not None:
- self.biz_info = biz_info
- if bbo is not None:
- self.bbo = bbo
+ if text is not None:
+ self.text = text
@property
def size(self):
@@ -100,7 +95,7 @@ def size(self, size):
def price(self):
"""Gets the price of this FuturesOrderAmendment. # noqa: E501
- New order price. # noqa: E501
+ New order price # noqa: E501
:return: The price of this FuturesOrderAmendment. # noqa: E501
:rtype: str
@@ -111,7 +106,7 @@ def price(self):
def price(self, price):
"""Sets the price of this FuturesOrderAmendment.
- New order price. # noqa: E501
+ New order price # noqa: E501
:param price: The price of this FuturesOrderAmendment. # noqa: E501
:type: str
@@ -123,7 +118,7 @@ def price(self, price):
def amend_text(self):
"""Gets the amend_text of this FuturesOrderAmendment. # noqa: E501
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:return: The amend_text of this FuturesOrderAmendment. # noqa: E501
:rtype: str
@@ -134,7 +129,7 @@ def amend_text(self):
def amend_text(self, amend_text):
"""Sets the amend_text of this FuturesOrderAmendment.
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:param amend_text: The amend_text of this FuturesOrderAmendment. # noqa: E501
:type: str
@@ -143,50 +138,27 @@ def amend_text(self, amend_text):
self._amend_text = amend_text
@property
- def biz_info(self):
- """Gets the biz_info of this FuturesOrderAmendment. # noqa: E501
+ def text(self):
+ """Gets the text of this FuturesOrderAmendment. # noqa: E501
- Users can annotate this modification with information. # noqa: E501
+ Internal users can modify information in the text field. # noqa: E501
- :return: The biz_info of this FuturesOrderAmendment. # noqa: E501
+ :return: The text of this FuturesOrderAmendment. # noqa: E501
:rtype: str
"""
- return self._biz_info
+ return self._text
- @biz_info.setter
- def biz_info(self, biz_info):
- """Sets the biz_info of this FuturesOrderAmendment.
+ @text.setter
+ def text(self, text):
+ """Sets the text of this FuturesOrderAmendment.
- Users can annotate this modification with information. # noqa: E501
+ Internal users can modify information in the text field. # noqa: E501
- :param biz_info: The biz_info of this FuturesOrderAmendment. # noqa: E501
+ :param text: The text of this FuturesOrderAmendment. # noqa: E501
:type: str
"""
- self._biz_info = biz_info
-
- @property
- def bbo(self):
- """Gets the bbo of this FuturesOrderAmendment. # noqa: E501
-
- Users are able to modify the offer price manually. # noqa: E501
-
- :return: The bbo of this FuturesOrderAmendment. # noqa: E501
- :rtype: str
- """
- return self._bbo
-
- @bbo.setter
- def bbo(self, bbo):
- """Sets the bbo of this FuturesOrderAmendment.
-
- Users are able to modify the offer price manually. # noqa: E501
-
- :param bbo: The bbo of this FuturesOrderAmendment. # noqa: E501
- :type: str
- """
-
- self._bbo = bbo
+ self._text = text
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/futures_order_book.py b/gate_api/models/futures_order_book.py
index 31fb88a..cc240a6 100644
--- a/gate_api/models/futures_order_book.py
+++ b/gate_api/models/futures_order_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -144,7 +144,7 @@ def update(self, update):
def asks(self):
"""Gets the asks of this FuturesOrderBook. # noqa: E501
- Asks order depth # noqa: E501
+ Ask Depth # noqa: E501
:return: The asks of this FuturesOrderBook. # noqa: E501
:rtype: list[FuturesOrderBookItem]
@@ -155,7 +155,7 @@ def asks(self):
def asks(self, asks):
"""Sets the asks of this FuturesOrderBook.
- Asks order depth # noqa: E501
+ Ask Depth # noqa: E501
:param asks: The asks of this FuturesOrderBook. # noqa: E501
:type: list[FuturesOrderBookItem]
@@ -169,7 +169,7 @@ def asks(self, asks):
def bids(self):
"""Gets the bids of this FuturesOrderBook. # noqa: E501
- Bids order depth # noqa: E501
+ Bid Depth # noqa: E501
:return: The bids of this FuturesOrderBook. # noqa: E501
:rtype: list[FuturesOrderBookItem]
@@ -180,7 +180,7 @@ def bids(self):
def bids(self, bids):
"""Sets the bids of this FuturesOrderBook.
- Bids order depth # noqa: E501
+ Bid Depth # noqa: E501
:param bids: The bids of this FuturesOrderBook. # noqa: E501
:type: list[FuturesOrderBookItem]
diff --git a/gate_api/models/futures_order_book_item.py b/gate_api/models/futures_order_book_item.py
index 365905c..4ca4732 100644
--- a/gate_api/models/futures_order_book_item.py
+++ b/gate_api/models/futures_order_book_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/futures_position_cross_mode.py b/gate_api/models/futures_position_cross_mode.py
new file mode 100644
index 0000000..4f4a83c
--- /dev/null
+++ b/gate_api/models/futures_position_cross_mode.py
@@ -0,0 +1,153 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class FuturesPositionCrossMode(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'mode': 'str',
+ 'contract': 'str'
+ }
+
+ attribute_map = {
+ 'mode': 'mode',
+ 'contract': 'contract'
+ }
+
+ def __init__(self, mode=None, contract=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, Configuration) -> None
+ """FuturesPositionCrossMode - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._mode = None
+ self._contract = None
+ self.discriminator = None
+
+ self.mode = mode
+ self.contract = contract
+
+ @property
+ def mode(self):
+ """Gets the mode of this FuturesPositionCrossMode. # noqa: E501
+
+ Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501
+
+ :return: The mode of this FuturesPositionCrossMode. # noqa: E501
+ :rtype: str
+ """
+ return self._mode
+
+ @mode.setter
+ def mode(self, mode):
+ """Sets the mode of this FuturesPositionCrossMode.
+
+ Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501
+
+ :param mode: The mode of this FuturesPositionCrossMode. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and mode is None: # noqa: E501
+ raise ValueError("Invalid value for `mode`, must not be `None`") # noqa: E501
+
+ self._mode = mode
+
+ @property
+ def contract(self):
+ """Gets the contract of this FuturesPositionCrossMode. # noqa: E501
+
+ Futures market # noqa: E501
+
+ :return: The contract of this FuturesPositionCrossMode. # noqa: E501
+ :rtype: str
+ """
+ return self._contract
+
+ @contract.setter
+ def contract(self, contract):
+ """Sets the contract of this FuturesPositionCrossMode.
+
+ Futures market # noqa: E501
+
+ :param contract: The contract of this FuturesPositionCrossMode. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and contract is None: # noqa: E501
+ raise ValueError("Invalid value for `contract`, must not be `None`") # noqa: E501
+
+ self._contract = contract
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, FuturesPositionCrossMode):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, FuturesPositionCrossMode):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/futures_premium_index.py b/gate_api/models/futures_premium_index.py
index 9552be5..f02adc1 100644
--- a/gate_api/models/futures_premium_index.py
+++ b/gate_api/models/futures_premium_index.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -146,7 +146,7 @@ def h(self, h):
def l(self):
"""Gets the l of this FuturesPremiumIndex. # noqa: E501
- Lowest price` # noqa: E501
+ Lowest price # noqa: E501
:return: The l of this FuturesPremiumIndex. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def l(self):
def l(self, l):
"""Sets the l of this FuturesPremiumIndex.
- Lowest price` # noqa: E501
+ Lowest price # noqa: E501
:param l: The l of this FuturesPremiumIndex. # noqa: E501
:type: str
diff --git a/gate_api/models/futures_price_trigger.py b/gate_api/models/futures_price_trigger.py
index 9f1850e..7dd48a6 100644
--- a/gate_api/models/futures_price_trigger.py
+++ b/gate_api/models/futures_price_trigger.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -77,7 +77,7 @@ def __init__(self, strategy_type=None, price_type=None, price=None, rule=None, e
def strategy_type(self):
"""Gets the strategy_type of this FuturesPriceTrigger. # noqa: E501
- How the order will be triggered - `0`: by price, which means the order will be triggered if price condition is satisfied - `1`: by price gap, which means the order will be triggered if gap of recent two prices of specified `price_type` are satisfied. Only `0` is supported currently # noqa: E501
+ Trigger Strategy - 0: Price trigger, triggered when price meets conditions - 1: Price spread trigger, i.e. the difference between the latest price specified in `price_type` and the second-last price Currently only supports 0 (latest transaction price) # noqa: E501
:return: The strategy_type of this FuturesPriceTrigger. # noqa: E501
:rtype: int
@@ -88,7 +88,7 @@ def strategy_type(self):
def strategy_type(self, strategy_type):
"""Sets the strategy_type of this FuturesPriceTrigger.
- How the order will be triggered - `0`: by price, which means the order will be triggered if price condition is satisfied - `1`: by price gap, which means the order will be triggered if gap of recent two prices of specified `price_type` are satisfied. Only `0` is supported currently # noqa: E501
+ Trigger Strategy - 0: Price trigger, triggered when price meets conditions - 1: Price spread trigger, i.e. the difference between the latest price specified in `price_type` and the second-last price Currently only supports 0 (latest transaction price) # noqa: E501
:param strategy_type: The strategy_type of this FuturesPriceTrigger. # noqa: E501
:type: int
@@ -106,7 +106,7 @@ def strategy_type(self, strategy_type):
def price_type(self):
"""Gets the price_type of this FuturesPriceTrigger. # noqa: E501
- Price type. 0 - latest deal price, 1 - mark price, 2 - index price # noqa: E501
+ Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price # noqa: E501
:return: The price_type of this FuturesPriceTrigger. # noqa: E501
:rtype: int
@@ -117,7 +117,7 @@ def price_type(self):
def price_type(self, price_type):
"""Sets the price_type of this FuturesPriceTrigger.
- Price type. 0 - latest deal price, 1 - mark price, 2 - index price # noqa: E501
+ Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price # noqa: E501
:param price_type: The price_type of this FuturesPriceTrigger. # noqa: E501
:type: int
@@ -135,7 +135,7 @@ def price_type(self, price_type):
def price(self):
"""Gets the price of this FuturesPriceTrigger. # noqa: E501
- Value of price on price triggered, or price gap on price gap triggered # noqa: E501
+ Price value for price trigger, or spread value for spread trigger # noqa: E501
:return: The price of this FuturesPriceTrigger. # noqa: E501
:rtype: str
@@ -146,7 +146,7 @@ def price(self):
def price(self, price):
"""Sets the price of this FuturesPriceTrigger.
- Value of price on price triggered, or price gap on price gap triggered # noqa: E501
+ Price value for price trigger, or spread value for spread trigger # noqa: E501
:param price: The price of this FuturesPriceTrigger. # noqa: E501
:type: str
@@ -158,7 +158,7 @@ def price(self, price):
def rule(self):
"""Gets the rule of this FuturesPriceTrigger. # noqa: E501
- Trigger condition type - `1`: calculated price based on `strategy_type` and `price_type` >= `price` - `2`: calculated price based on `strategy_type` and `price_type` <= `price` # noqa: E501
+ Price Condition Type - 1: Trigger when the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price`, while Trigger.Price must > last_price - 2: Trigger when the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price`, and Trigger.Price must < last_price # noqa: E501
:return: The rule of this FuturesPriceTrigger. # noqa: E501
:rtype: int
@@ -169,7 +169,7 @@ def rule(self):
def rule(self, rule):
"""Sets the rule of this FuturesPriceTrigger.
- Trigger condition type - `1`: calculated price based on `strategy_type` and `price_type` >= `price` - `2`: calculated price based on `strategy_type` and `price_type` <= `price` # noqa: E501
+ Price Condition Type - 1: Trigger when the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price`, while Trigger.Price must > last_price - 2: Trigger when the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price`, and Trigger.Price must < last_price # noqa: E501
:param rule: The rule of this FuturesPriceTrigger. # noqa: E501
:type: int
@@ -187,7 +187,7 @@ def rule(self, rule):
def expiration(self):
"""Gets the expiration of this FuturesPriceTrigger. # noqa: E501
- How long (in seconds) to wait for the condition to be triggered before cancelling the order. # noqa: E501
+ Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout # noqa: E501
:return: The expiration of this FuturesPriceTrigger. # noqa: E501
:rtype: int
@@ -198,7 +198,7 @@ def expiration(self):
def expiration(self, expiration):
"""Sets the expiration of this FuturesPriceTrigger.
- How long (in seconds) to wait for the condition to be triggered before cancelling the order. # noqa: E501
+ Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout # noqa: E501
:param expiration: The expiration of this FuturesPriceTrigger. # noqa: E501
:type: int
diff --git a/gate_api/models/futures_price_triggered_order.py b/gate_api/models/futures_price_triggered_order.py
index d996387..14e16ae 100644
--- a/gate_api/models/futures_price_triggered_order.py
+++ b/gate_api/models/futures_price_triggered_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -202,7 +202,7 @@ def user(self, user):
def create_time(self):
"""Gets the create_time of this FuturesPriceTriggeredOrder. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: float
@@ -213,7 +213,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this FuturesPriceTriggeredOrder.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this FuturesPriceTriggeredOrder. # noqa: E501
:type: float
@@ -225,7 +225,7 @@ def create_time(self, create_time):
def finish_time(self):
"""Gets the finish_time of this FuturesPriceTriggeredOrder. # noqa: E501
- Finished time # noqa: E501
+ End time # noqa: E501
:return: The finish_time of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: float
@@ -236,7 +236,7 @@ def finish_time(self):
def finish_time(self, finish_time):
"""Sets the finish_time of this FuturesPriceTriggeredOrder.
- Finished time # noqa: E501
+ End time # noqa: E501
:param finish_time: The finish_time of this FuturesPriceTriggeredOrder. # noqa: E501
:type: float
@@ -248,7 +248,7 @@ def finish_time(self, finish_time):
def trade_id(self):
"""Gets the trade_id of this FuturesPriceTriggeredOrder. # noqa: E501
- ID of the newly created order on condition triggered # noqa: E501
+ ID of the order created after trigger # noqa: E501
:return: The trade_id of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: int
@@ -259,7 +259,7 @@ def trade_id(self):
def trade_id(self, trade_id):
"""Sets the trade_id of this FuturesPriceTriggeredOrder.
- ID of the newly created order on condition triggered # noqa: E501
+ ID of the order created after trigger # noqa: E501
:param trade_id: The trade_id of this FuturesPriceTriggeredOrder. # noqa: E501
:type: int
@@ -271,7 +271,7 @@ def trade_id(self, trade_id):
def status(self):
"""Gets the status of this FuturesPriceTriggeredOrder. # noqa: E501
- Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order # noqa: E501
+ Order status - `open`: Active - `finished`: Finished - `inactive`: Inactive, only applies to order take-profit/stop-loss - `invalid`: Invalid, only applies to order take-profit/stop-loss # noqa: E501
:return: The status of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -282,7 +282,7 @@ def status(self):
def status(self, status):
"""Sets the status of this FuturesPriceTriggeredOrder.
- Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order # noqa: E501
+ Order status - `open`: Active - `finished`: Finished - `inactive`: Inactive, only applies to order take-profit/stop-loss - `invalid`: Invalid, only applies to order take-profit/stop-loss # noqa: E501
:param status: The status of this FuturesPriceTriggeredOrder. # noqa: E501
:type: str
@@ -300,7 +300,7 @@ def status(self, status):
def finish_as(self):
"""Gets the finish_as of this FuturesPriceTriggeredOrder. # noqa: E501
- How order is finished # noqa: E501
+ Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired # noqa: E501
:return: The finish_as of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -311,7 +311,7 @@ def finish_as(self):
def finish_as(self, finish_as):
"""Sets the finish_as of this FuturesPriceTriggeredOrder.
- How order is finished # noqa: E501
+ Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired # noqa: E501
:param finish_as: The finish_as of this FuturesPriceTriggeredOrder. # noqa: E501
:type: str
@@ -329,7 +329,7 @@ def finish_as(self, finish_as):
def reason(self):
"""Gets the reason of this FuturesPriceTriggeredOrder. # noqa: E501
- Additional remarks on how the order was finished # noqa: E501
+ Additional description of how the order was completed # noqa: E501
:return: The reason of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -340,7 +340,7 @@ def reason(self):
def reason(self, reason):
"""Sets the reason of this FuturesPriceTriggeredOrder.
- Additional remarks on how the order was finished # noqa: E501
+ Additional description of how the order was completed # noqa: E501
:param reason: The reason of this FuturesPriceTriggeredOrder. # noqa: E501
:type: str
@@ -352,7 +352,7 @@ def reason(self, reason):
def order_type(self):
"""Gets the order_type of this FuturesPriceTriggeredOrder. # noqa: E501
- Take-profit/stop-loss types, which include: - `close-long-order`: order take-profit/stop-loss, close long position - `close-short-order`: order take-profit/stop-loss, close short position - `close-long-position`: position take-profit/stop-loss, close long position - `close-short-position`: position take-profit/stop-loss, close short position - `plan-close-long-position`: position planned take-profit/stop-loss, close long position - `plan-close-short-position`: position planned take-profit/stop-loss, close short position The order take-profit/stop-loss can not be passed by request. These two types are read only. # noqa: E501
+ Types of take-profit and stop-loss orders, including: - `close-long-order`: Order take-profit/stop-loss, close long position - `close-short-order`: Order take-profit/stop-loss, close short position - `close-long-position`: Position take-profit/stop-loss, used to close all long positions - `close-short-position`: Position take-profit/stop-loss, used to close all short positions - `plan-close-long-position`: Position plan take-profit/stop-loss, used to close all or partial long positions - `plan-close-short-position`: Position plan take-profit/stop-loss, used to close all or partial short positions The two types of order take-profit/stop-loss are read-only and cannot be passed in requests # noqa: E501
:return: The order_type of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -363,7 +363,7 @@ def order_type(self):
def order_type(self, order_type):
"""Sets the order_type of this FuturesPriceTriggeredOrder.
- Take-profit/stop-loss types, which include: - `close-long-order`: order take-profit/stop-loss, close long position - `close-short-order`: order take-profit/stop-loss, close short position - `close-long-position`: position take-profit/stop-loss, close long position - `close-short-position`: position take-profit/stop-loss, close short position - `plan-close-long-position`: position planned take-profit/stop-loss, close long position - `plan-close-short-position`: position planned take-profit/stop-loss, close short position The order take-profit/stop-loss can not be passed by request. These two types are read only. # noqa: E501
+ Types of take-profit and stop-loss orders, including: - `close-long-order`: Order take-profit/stop-loss, close long position - `close-short-order`: Order take-profit/stop-loss, close short position - `close-long-position`: Position take-profit/stop-loss, used to close all long positions - `close-short-position`: Position take-profit/stop-loss, used to close all short positions - `plan-close-long-position`: Position plan take-profit/stop-loss, used to close all or partial long positions - `plan-close-short-position`: Position plan take-profit/stop-loss, used to close all or partial short positions The two types of order take-profit/stop-loss are read-only and cannot be passed in requests # noqa: E501
:param order_type: The order_type of this FuturesPriceTriggeredOrder. # noqa: E501
:type: str
@@ -375,7 +375,7 @@ def order_type(self, order_type):
def me_order_id(self):
"""Gets the me_order_id of this FuturesPriceTriggeredOrder. # noqa: E501
- Corresponding order ID of order take-profit/stop-loss. # noqa: E501
+ Corresponding order ID for order take-profit/stop-loss orders # noqa: E501
:return: The me_order_id of this FuturesPriceTriggeredOrder. # noqa: E501
:rtype: int
@@ -386,7 +386,7 @@ def me_order_id(self):
def me_order_id(self, me_order_id):
"""Sets the me_order_id of this FuturesPriceTriggeredOrder.
- Corresponding order ID of order take-profit/stop-loss. # noqa: E501
+ Corresponding order ID for order take-profit/stop-loss orders # noqa: E501
:param me_order_id: The me_order_id of this FuturesPriceTriggeredOrder. # noqa: E501
:type: int
diff --git a/gate_api/models/futures_risk_limit_tier.py b/gate_api/models/futures_risk_limit_tier.py
new file mode 100644
index 0000000..fcbc314
--- /dev/null
+++ b/gate_api/models/futures_risk_limit_tier.py
@@ -0,0 +1,263 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class FuturesRiskLimitTier(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'tier': 'int',
+ 'risk_limit': 'str',
+ 'initial_rate': 'str',
+ 'maintenance_rate': 'str',
+ 'leverage_max': 'str',
+ 'deduction': 'str'
+ }
+
+ attribute_map = {
+ 'tier': 'tier',
+ 'risk_limit': 'risk_limit',
+ 'initial_rate': 'initial_rate',
+ 'maintenance_rate': 'maintenance_rate',
+ 'leverage_max': 'leverage_max',
+ 'deduction': 'deduction'
+ }
+
+ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_rate=None, leverage_max=None, deduction=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, str, str, str, str, Configuration) -> None
+ """FuturesRiskLimitTier - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._tier = None
+ self._risk_limit = None
+ self._initial_rate = None
+ self._maintenance_rate = None
+ self._leverage_max = None
+ self._deduction = None
+ self.discriminator = None
+
+ if tier is not None:
+ self.tier = tier
+ if risk_limit is not None:
+ self.risk_limit = risk_limit
+ if initial_rate is not None:
+ self.initial_rate = initial_rate
+ if maintenance_rate is not None:
+ self.maintenance_rate = maintenance_rate
+ if leverage_max is not None:
+ self.leverage_max = leverage_max
+ if deduction is not None:
+ self.deduction = deduction
+
+ @property
+ def tier(self):
+ """Gets the tier of this FuturesRiskLimitTier. # noqa: E501
+
+ Tier # noqa: E501
+
+ :return: The tier of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: int
+ """
+ return self._tier
+
+ @tier.setter
+ def tier(self, tier):
+ """Sets the tier of this FuturesRiskLimitTier.
+
+ Tier # noqa: E501
+
+ :param tier: The tier of this FuturesRiskLimitTier. # noqa: E501
+ :type: int
+ """
+
+ self._tier = tier
+
+ @property
+ def risk_limit(self):
+ """Gets the risk_limit of this FuturesRiskLimitTier. # noqa: E501
+
+ Position risk limit # noqa: E501
+
+ :return: The risk_limit of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: str
+ """
+ return self._risk_limit
+
+ @risk_limit.setter
+ def risk_limit(self, risk_limit):
+ """Sets the risk_limit of this FuturesRiskLimitTier.
+
+ Position risk limit # noqa: E501
+
+ :param risk_limit: The risk_limit of this FuturesRiskLimitTier. # noqa: E501
+ :type: str
+ """
+
+ self._risk_limit = risk_limit
+
+ @property
+ def initial_rate(self):
+ """Gets the initial_rate of this FuturesRiskLimitTier. # noqa: E501
+
+ Initial margin rate # noqa: E501
+
+ :return: The initial_rate of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: str
+ """
+ return self._initial_rate
+
+ @initial_rate.setter
+ def initial_rate(self, initial_rate):
+ """Sets the initial_rate of this FuturesRiskLimitTier.
+
+ Initial margin rate # noqa: E501
+
+ :param initial_rate: The initial_rate of this FuturesRiskLimitTier. # noqa: E501
+ :type: str
+ """
+
+ self._initial_rate = initial_rate
+
+ @property
+ def maintenance_rate(self):
+ """Gets the maintenance_rate of this FuturesRiskLimitTier. # noqa: E501
+
+ Maintenance margin rate # noqa: E501
+
+ :return: The maintenance_rate of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: str
+ """
+ return self._maintenance_rate
+
+ @maintenance_rate.setter
+ def maintenance_rate(self, maintenance_rate):
+ """Sets the maintenance_rate of this FuturesRiskLimitTier.
+
+ Maintenance margin rate # noqa: E501
+
+ :param maintenance_rate: The maintenance_rate of this FuturesRiskLimitTier. # noqa: E501
+ :type: str
+ """
+
+ self._maintenance_rate = maintenance_rate
+
+ @property
+ def leverage_max(self):
+ """Gets the leverage_max of this FuturesRiskLimitTier. # noqa: E501
+
+ Maximum leverage # noqa: E501
+
+ :return: The leverage_max of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: str
+ """
+ return self._leverage_max
+
+ @leverage_max.setter
+ def leverage_max(self, leverage_max):
+ """Sets the leverage_max of this FuturesRiskLimitTier.
+
+ Maximum leverage # noqa: E501
+
+ :param leverage_max: The leverage_max of this FuturesRiskLimitTier. # noqa: E501
+ :type: str
+ """
+
+ self._leverage_max = leverage_max
+
+ @property
+ def deduction(self):
+ """Gets the deduction of this FuturesRiskLimitTier. # noqa: E501
+
+ Maintenance margin quick calculation deduction amount # noqa: E501
+
+ :return: The deduction of this FuturesRiskLimitTier. # noqa: E501
+ :rtype: str
+ """
+ return self._deduction
+
+ @deduction.setter
+ def deduction(self, deduction):
+ """Sets the deduction of this FuturesRiskLimitTier.
+
+ Maintenance margin quick calculation deduction amount # noqa: E501
+
+ :param deduction: The deduction of this FuturesRiskLimitTier. # noqa: E501
+ :type: str
+ """
+
+ self._deduction = deduction
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, FuturesRiskLimitTier):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, FuturesRiskLimitTier):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/futures_ticker.py b/gate_api/models/futures_ticker.py
index 1839616..37acc8e 100644
--- a/gate_api/models/futures_ticker.py
+++ b/gate_api/models/futures_ticker.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -50,12 +50,15 @@ class FuturesTicker(object):
'funding_rate_indicative': 'str',
'index_price': 'str',
'quanto_base_rate': 'str',
- 'basis_rate': 'str',
- 'basis_value': 'str',
'lowest_ask': 'str',
'lowest_size': 'str',
'highest_bid': 'str',
- 'highest_size': 'str'
+ 'highest_size': 'str',
+ 'change_utc0': 'str',
+ 'change_utc8': 'str',
+ 'change_price': 'str',
+ 'change_utc0_price': 'str',
+ 'change_utc8_price': 'str'
}
attribute_map = {
@@ -76,16 +79,19 @@ class FuturesTicker(object):
'funding_rate_indicative': 'funding_rate_indicative',
'index_price': 'index_price',
'quanto_base_rate': 'quanto_base_rate',
- 'basis_rate': 'basis_rate',
- 'basis_value': 'basis_value',
'lowest_ask': 'lowest_ask',
'lowest_size': 'lowest_size',
'highest_bid': 'highest_bid',
- 'highest_size': 'highest_size'
+ 'highest_size': 'highest_size',
+ 'change_utc0': 'change_utc0',
+ 'change_utc8': 'change_utc8',
+ 'change_price': 'change_price',
+ 'change_utc0_price': 'change_utc0_price',
+ 'change_utc8_price': 'change_utc8_price'
}
- def __init__(self, contract=None, last=None, change_percentage=None, total_size=None, low_24h=None, high_24h=None, volume_24h=None, volume_24h_btc=None, volume_24h_usd=None, volume_24h_base=None, volume_24h_quote=None, volume_24h_settle=None, mark_price=None, funding_rate=None, funding_rate_indicative=None, index_price=None, quanto_base_rate=None, basis_rate=None, basis_value=None, lowest_ask=None, lowest_size=None, highest_bid=None, highest_size=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, contract=None, last=None, change_percentage=None, total_size=None, low_24h=None, high_24h=None, volume_24h=None, volume_24h_btc=None, volume_24h_usd=None, volume_24h_base=None, volume_24h_quote=None, volume_24h_settle=None, mark_price=None, funding_rate=None, funding_rate_indicative=None, index_price=None, quanto_base_rate=None, lowest_ask=None, lowest_size=None, highest_bid=None, highest_size=None, change_utc0=None, change_utc8=None, change_price=None, change_utc0_price=None, change_utc8_price=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
"""FuturesTicker - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -108,12 +114,15 @@ def __init__(self, contract=None, last=None, change_percentage=None, total_size=
self._funding_rate_indicative = None
self._index_price = None
self._quanto_base_rate = None
- self._basis_rate = None
- self._basis_value = None
self._lowest_ask = None
self._lowest_size = None
self._highest_bid = None
self._highest_size = None
+ self._change_utc0 = None
+ self._change_utc8 = None
+ self._change_price = None
+ self._change_utc0_price = None
+ self._change_utc8_price = None
self.discriminator = None
if contract is not None:
@@ -150,10 +159,6 @@ def __init__(self, contract=None, last=None, change_percentage=None, total_size=
self.index_price = index_price
if quanto_base_rate is not None:
self.quanto_base_rate = quanto_base_rate
- if basis_rate is not None:
- self.basis_rate = basis_rate
- if basis_value is not None:
- self.basis_value = basis_value
if lowest_ask is not None:
self.lowest_ask = lowest_ask
if lowest_size is not None:
@@ -162,6 +167,16 @@ def __init__(self, contract=None, last=None, change_percentage=None, total_size=
self.highest_bid = highest_bid
if highest_size is not None:
self.highest_size = highest_size
+ if change_utc0 is not None:
+ self.change_utc0 = change_utc0
+ if change_utc8 is not None:
+ self.change_utc8 = change_utc8
+ if change_price is not None:
+ self.change_price = change_price
+ if change_utc0_price is not None:
+ self.change_utc0_price = change_utc0_price
+ if change_utc8_price is not None:
+ self.change_utc8_price = change_utc8_price
@property
def contract(self):
@@ -213,7 +228,7 @@ def last(self, last):
def change_percentage(self):
"""Gets the change_percentage of this FuturesTicker. # noqa: E501
- Change percentage. # noqa: E501
+ Price change percentage. Negative values indicate price decrease, e.g. -7.45 # noqa: E501
:return: The change_percentage of this FuturesTicker. # noqa: E501
:rtype: str
@@ -224,7 +239,7 @@ def change_percentage(self):
def change_percentage(self, change_percentage):
"""Sets the change_percentage of this FuturesTicker.
- Change percentage. # noqa: E501
+ Price change percentage. Negative values indicate price decrease, e.g. -7.45 # noqa: E501
:param change_percentage: The change_percentage of this FuturesTicker. # noqa: E501
:type: str
@@ -259,7 +274,7 @@ def total_size(self, total_size):
def low_24h(self):
"""Gets the low_24h of this FuturesTicker. # noqa: E501
- Lowest trading price in recent 24h # noqa: E501
+ 24-hour lowest price # noqa: E501
:return: The low_24h of this FuturesTicker. # noqa: E501
:rtype: str
@@ -270,7 +285,7 @@ def low_24h(self):
def low_24h(self, low_24h):
"""Sets the low_24h of this FuturesTicker.
- Lowest trading price in recent 24h # noqa: E501
+ 24-hour lowest price # noqa: E501
:param low_24h: The low_24h of this FuturesTicker. # noqa: E501
:type: str
@@ -282,7 +297,7 @@ def low_24h(self, low_24h):
def high_24h(self):
"""Gets the high_24h of this FuturesTicker. # noqa: E501
- Highest trading price in recent 24h # noqa: E501
+ 24-hour highest price # noqa: E501
:return: The high_24h of this FuturesTicker. # noqa: E501
:rtype: str
@@ -293,7 +308,7 @@ def high_24h(self):
def high_24h(self, high_24h):
"""Sets the high_24h of this FuturesTicker.
- Highest trading price in recent 24h # noqa: E501
+ 24-hour highest price # noqa: E501
:param high_24h: The high_24h of this FuturesTicker. # noqa: E501
:type: str
@@ -305,7 +320,7 @@ def high_24h(self, high_24h):
def volume_24h(self):
"""Gets the volume_24h of this FuturesTicker. # noqa: E501
- Trade size in recent 24h # noqa: E501
+ 24-hour trading volume # noqa: E501
:return: The volume_24h of this FuturesTicker. # noqa: E501
:rtype: str
@@ -316,7 +331,7 @@ def volume_24h(self):
def volume_24h(self, volume_24h):
"""Sets the volume_24h of this FuturesTicker.
- Trade size in recent 24h # noqa: E501
+ 24-hour trading volume # noqa: E501
:param volume_24h: The volume_24h of this FuturesTicker. # noqa: E501
:type: str
@@ -328,7 +343,7 @@ def volume_24h(self, volume_24h):
def volume_24h_btc(self):
"""Gets the volume_24h_btc of this FuturesTicker. # noqa: E501
- Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+ 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
:return: The volume_24h_btc of this FuturesTicker. # noqa: E501
:rtype: str
@@ -339,7 +354,7 @@ def volume_24h_btc(self):
def volume_24h_btc(self, volume_24h_btc):
"""Sets the volume_24h_btc of this FuturesTicker.
- Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+ 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
:param volume_24h_btc: The volume_24h_btc of this FuturesTicker. # noqa: E501
:type: str
@@ -351,7 +366,7 @@ def volume_24h_btc(self, volume_24h_btc):
def volume_24h_usd(self):
"""Gets the volume_24h_usd of this FuturesTicker. # noqa: E501
- Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+ 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
:return: The volume_24h_usd of this FuturesTicker. # noqa: E501
:rtype: str
@@ -362,7 +377,7 @@ def volume_24h_usd(self):
def volume_24h_usd(self, volume_24h_usd):
"""Sets the volume_24h_usd of this FuturesTicker.
- Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
+ 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) # noqa: E501
:param volume_24h_usd: The volume_24h_usd of this FuturesTicker. # noqa: E501
:type: str
@@ -374,7 +389,7 @@ def volume_24h_usd(self, volume_24h_usd):
def volume_24h_base(self):
"""Gets the volume_24h_base of this FuturesTicker. # noqa: E501
- Trade volume in recent 24h, in base currency # noqa: E501
+ 24-hour trading volume in base currency # noqa: E501
:return: The volume_24h_base of this FuturesTicker. # noqa: E501
:rtype: str
@@ -385,7 +400,7 @@ def volume_24h_base(self):
def volume_24h_base(self, volume_24h_base):
"""Sets the volume_24h_base of this FuturesTicker.
- Trade volume in recent 24h, in base currency # noqa: E501
+ 24-hour trading volume in base currency # noqa: E501
:param volume_24h_base: The volume_24h_base of this FuturesTicker. # noqa: E501
:type: str
@@ -397,7 +412,7 @@ def volume_24h_base(self, volume_24h_base):
def volume_24h_quote(self):
"""Gets the volume_24h_quote of this FuturesTicker. # noqa: E501
- Trade volume in recent 24h, in quote currency # noqa: E501
+ 24-hour trading volume in quote currency # noqa: E501
:return: The volume_24h_quote of this FuturesTicker. # noqa: E501
:rtype: str
@@ -408,7 +423,7 @@ def volume_24h_quote(self):
def volume_24h_quote(self, volume_24h_quote):
"""Sets the volume_24h_quote of this FuturesTicker.
- Trade volume in recent 24h, in quote currency # noqa: E501
+ 24-hour trading volume in quote currency # noqa: E501
:param volume_24h_quote: The volume_24h_quote of this FuturesTicker. # noqa: E501
:type: str
@@ -420,7 +435,7 @@ def volume_24h_quote(self, volume_24h_quote):
def volume_24h_settle(self):
"""Gets the volume_24h_settle of this FuturesTicker. # noqa: E501
- Trade volume in recent 24h, in settle currency # noqa: E501
+ 24-hour trading volume in settle currency # noqa: E501
:return: The volume_24h_settle of this FuturesTicker. # noqa: E501
:rtype: str
@@ -431,7 +446,7 @@ def volume_24h_settle(self):
def volume_24h_settle(self, volume_24h_settle):
"""Sets the volume_24h_settle of this FuturesTicker.
- Trade volume in recent 24h, in settle currency # noqa: E501
+ 24-hour trading volume in settle currency # noqa: E501
:param volume_24h_settle: The volume_24h_settle of this FuturesTicker. # noqa: E501
:type: str
@@ -489,7 +504,7 @@ def funding_rate(self, funding_rate):
def funding_rate_indicative(self):
"""Gets the funding_rate_indicative of this FuturesTicker. # noqa: E501
- Indicative Funding rate in next period # noqa: E501
+ Indicative Funding rate in next period. (deprecated. use `funding_rate`) # noqa: E501
:return: The funding_rate_indicative of this FuturesTicker. # noqa: E501
:rtype: str
@@ -500,7 +515,7 @@ def funding_rate_indicative(self):
def funding_rate_indicative(self, funding_rate_indicative):
"""Sets the funding_rate_indicative of this FuturesTicker.
- Indicative Funding rate in next period # noqa: E501
+ Indicative Funding rate in next period. (deprecated. use `funding_rate`) # noqa: E501
:param funding_rate_indicative: The funding_rate_indicative of this FuturesTicker. # noqa: E501
:type: str
@@ -554,52 +569,6 @@ def quanto_base_rate(self, quanto_base_rate):
self._quanto_base_rate = quanto_base_rate
- @property
- def basis_rate(self):
- """Gets the basis_rate of this FuturesTicker. # noqa: E501
-
- Basis rate # noqa: E501
-
- :return: The basis_rate of this FuturesTicker. # noqa: E501
- :rtype: str
- """
- return self._basis_rate
-
- @basis_rate.setter
- def basis_rate(self, basis_rate):
- """Sets the basis_rate of this FuturesTicker.
-
- Basis rate # noqa: E501
-
- :param basis_rate: The basis_rate of this FuturesTicker. # noqa: E501
- :type: str
- """
-
- self._basis_rate = basis_rate
-
- @property
- def basis_value(self):
- """Gets the basis_value of this FuturesTicker. # noqa: E501
-
- Basis value # noqa: E501
-
- :return: The basis_value of this FuturesTicker. # noqa: E501
- :rtype: str
- """
- return self._basis_value
-
- @basis_value.setter
- def basis_value(self, basis_value):
- """Sets the basis_value of this FuturesTicker.
-
- Basis value # noqa: E501
-
- :param basis_value: The basis_value of this FuturesTicker. # noqa: E501
- :type: str
- """
-
- self._basis_value = basis_value
-
@property
def lowest_ask(self):
"""Gets the lowest_ask of this FuturesTicker. # noqa: E501
@@ -692,6 +661,121 @@ def highest_size(self, highest_size):
self._highest_size = highest_size
+ @property
+ def change_utc0(self):
+ """Gets the change_utc0 of this FuturesTicker. # noqa: E501
+
+ Percentage change at utc0. Negative values indicate a drop, e.g., -7.45% # noqa: E501
+
+ :return: The change_utc0 of this FuturesTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_utc0
+
+ @change_utc0.setter
+ def change_utc0(self, change_utc0):
+ """Sets the change_utc0 of this FuturesTicker.
+
+ Percentage change at utc0. Negative values indicate a drop, e.g., -7.45% # noqa: E501
+
+ :param change_utc0: The change_utc0 of this FuturesTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_utc0 = change_utc0
+
+ @property
+ def change_utc8(self):
+ """Gets the change_utc8 of this FuturesTicker. # noqa: E501
+
+ Percentage change at utc8. Negative values indicate a drop, e.g., -7.45% # noqa: E501
+
+ :return: The change_utc8 of this FuturesTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_utc8
+
+ @change_utc8.setter
+ def change_utc8(self, change_utc8):
+ """Sets the change_utc8 of this FuturesTicker.
+
+ Percentage change at utc8. Negative values indicate a drop, e.g., -7.45% # noqa: E501
+
+ :param change_utc8: The change_utc8 of this FuturesTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_utc8 = change_utc8
+
+ @property
+ def change_price(self):
+ """Gets the change_price of this FuturesTicker. # noqa: E501
+
+ 24h change amount. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :return: The change_price of this FuturesTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_price
+
+ @change_price.setter
+ def change_price(self, change_price):
+ """Sets the change_price of this FuturesTicker.
+
+ 24h change amount. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :param change_price: The change_price of this FuturesTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_price = change_price
+
+ @property
+ def change_utc0_price(self):
+ """Gets the change_utc0_price of this FuturesTicker. # noqa: E501
+
+ Change amount at utc0. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :return: The change_utc0_price of this FuturesTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_utc0_price
+
+ @change_utc0_price.setter
+ def change_utc0_price(self, change_utc0_price):
+ """Sets the change_utc0_price of this FuturesTicker.
+
+ Change amount at utc0. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :param change_utc0_price: The change_utc0_price of this FuturesTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_utc0_price = change_utc0_price
+
+ @property
+ def change_utc8_price(self):
+ """Gets the change_utc8_price of this FuturesTicker. # noqa: E501
+
+ Change amount at utc8. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :return: The change_utc8_price of this FuturesTicker. # noqa: E501
+ :rtype: str
+ """
+ return self._change_utc8_price
+
+ @change_utc8_price.setter
+ def change_utc8_price(self, change_utc8_price):
+ """Sets the change_utc8_price of this FuturesTicker.
+
+ Change amount at utc8. Negative values indicate a drop, e.g., -7.45 # noqa: E501
+
+ :param change_utc8_price: The change_utc8_price of this FuturesTicker. # noqa: E501
+ :type: str
+ """
+
+ self._change_utc8_price = change_utc8_price
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/futures_trade.py b/gate_api/models/futures_trade.py
index c28ab4e..66b45c0 100644
--- a/gate_api/models/futures_trade.py
+++ b/gate_api/models/futures_trade.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -87,7 +87,7 @@ def __init__(self, id=None, create_time=None, create_time_ms=None, contract=None
def id(self):
"""Gets the id of this FuturesTrade. # noqa: E501
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:return: The id of this FuturesTrade. # noqa: E501
:rtype: int
@@ -98,7 +98,7 @@ def id(self):
def id(self, id):
"""Sets the id of this FuturesTrade.
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:param id: The id of this FuturesTrade. # noqa: E501
:type: int
@@ -110,7 +110,7 @@ def id(self, id):
def create_time(self):
"""Gets the create_time of this FuturesTrade. # noqa: E501
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:return: The create_time of this FuturesTrade. # noqa: E501
:rtype: float
@@ -121,7 +121,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this FuturesTrade.
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:param create_time: The create_time of this FuturesTrade. # noqa: E501
:type: float
@@ -133,7 +133,7 @@ def create_time(self, create_time):
def create_time_ms(self):
"""Gets the create_time_ms of this FuturesTrade. # noqa: E501
- Trading time, with milliseconds set to 3 decimal places. # noqa: E501
+ Trade time, with millisecond precision to 3 decimal places # noqa: E501
:return: The create_time_ms of this FuturesTrade. # noqa: E501
:rtype: float
@@ -144,7 +144,7 @@ def create_time_ms(self):
def create_time_ms(self, create_time_ms):
"""Sets the create_time_ms of this FuturesTrade.
- Trading time, with milliseconds set to 3 decimal places. # noqa: E501
+ Trade time, with millisecond precision to 3 decimal places # noqa: E501
:param create_time_ms: The create_time_ms of this FuturesTrade. # noqa: E501
:type: float
@@ -202,7 +202,7 @@ def size(self, size):
def price(self):
"""Gets the price of this FuturesTrade. # noqa: E501
- Trading price (quote currency) # noqa: E501
+ Trade price (quote currency) # noqa: E501
:return: The price of this FuturesTrade. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def price(self):
def price(self, price):
"""Sets the price of this FuturesTrade.
- Trading price (quote currency) # noqa: E501
+ Trade price (quote currency) # noqa: E501
:param price: The price of this FuturesTrade. # noqa: E501
:type: str
@@ -225,7 +225,7 @@ def price(self, price):
def is_internal(self):
"""Gets the is_internal of this FuturesTrade. # noqa: E501
- Whether internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned. # noqa: E501
+ Whether it is an internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the trade price may deviate from the market, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned # noqa: E501
:return: The is_internal of this FuturesTrade. # noqa: E501
:rtype: bool
@@ -236,7 +236,7 @@ def is_internal(self):
def is_internal(self, is_internal):
"""Sets the is_internal of this FuturesTrade.
- Whether internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned. # noqa: E501
+ Whether it is an internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the trade price may deviate from the market, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned # noqa: E501
:param is_internal: The is_internal of this FuturesTrade. # noqa: E501
:type: bool
diff --git a/gate_api/models/index_constituent.py b/gate_api/models/index_constituent.py
index fff7594..7357ff1 100644
--- a/gate_api/models/index_constituent.py
+++ b/gate_api/models/index_constituent.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/inline_object.py b/gate_api/models/inline_object.py
index 8bfa717..a034500 100644
--- a/gate_api/models/inline_object.py
+++ b/gate_api/models/inline_object.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -33,49 +33,78 @@ class InlineObject(object):
and the value is json key in definition.
"""
openapi_types = {
- 'enabled': 'bool'
+ 'mode': 'str',
+ 'contract': 'str'
}
attribute_map = {
- 'enabled': 'enabled'
+ 'mode': 'mode',
+ 'contract': 'contract'
}
- def __init__(self, enabled=None, local_vars_configuration=None): # noqa: E501
- # type: (bool, Configuration) -> None
+ def __init__(self, mode=None, contract=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, Configuration) -> None
"""InlineObject - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._enabled = None
+ self._mode = None
+ self._contract = None
self.discriminator = None
- self.enabled = enabled
+ self.mode = mode
+ self.contract = contract
@property
- def enabled(self):
- """Gets the enabled of this InlineObject. # noqa: E501
+ def mode(self):
+ """Gets the mode of this InlineObject. # noqa: E501
- Whether GT fee discount is used # noqa: E501
+ Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501
- :return: The enabled of this InlineObject. # noqa: E501
- :rtype: bool
+ :return: The mode of this InlineObject. # noqa: E501
+ :rtype: str
"""
- return self._enabled
+ return self._mode
- @enabled.setter
- def enabled(self, enabled):
- """Sets the enabled of this InlineObject.
+ @mode.setter
+ def mode(self, mode):
+ """Sets the mode of this InlineObject.
- Whether GT fee discount is used # noqa: E501
+ Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501
- :param enabled: The enabled of this InlineObject. # noqa: E501
- :type: bool
+ :param mode: The mode of this InlineObject. # noqa: E501
+ :type: str
"""
- if self.local_vars_configuration.client_side_validation and enabled is None: # noqa: E501
- raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501
+ if self.local_vars_configuration.client_side_validation and mode is None: # noqa: E501
+ raise ValueError("Invalid value for `mode`, must not be `None`") # noqa: E501
- self._enabled = enabled
+ self._mode = mode
+
+ @property
+ def contract(self):
+ """Gets the contract of this InlineObject. # noqa: E501
+
+ Futures market # noqa: E501
+
+ :return: The contract of this InlineObject. # noqa: E501
+ :rtype: str
+ """
+ return self._contract
+
+ @contract.setter
+ def contract(self, contract):
+ """Sets the contract of this InlineObject.
+
+ Futures market # noqa: E501
+
+ :param contract: The contract of this InlineObject. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and contract is None: # noqa: E501
+ raise ValueError("Invalid value for `contract`, must not be `None`") # noqa: E501
+
+ self._contract = contract
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/inline_response200.py b/gate_api/models/inline_response200.py
index 81b70a0..171fd14 100644
--- a/gate_api/models/inline_response200.py
+++ b/gate_api/models/inline_response200.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -33,76 +33,72 @@ class InlineResponse200(object):
and the value is json key in definition.
"""
openapi_types = {
- 'tx_id': 'str',
- 'status': 'str'
+ 'time': 'int',
+ 'value': 'str'
}
attribute_map = {
- 'tx_id': 'tx_id',
- 'status': 'status'
+ 'time': 'time',
+ 'value': 'value'
}
- def __init__(self, tx_id=None, status=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, Configuration) -> None
+ def __init__(self, time=None, value=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, Configuration) -> None
"""InlineResponse200 - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._tx_id = None
- self._status = None
+ self._time = None
+ self._value = None
self.discriminator = None
- if tx_id is not None:
- self.tx_id = tx_id
- if status is not None:
- self.status = status
+ if time is not None:
+ self.time = time
+ if value is not None:
+ self.value = value
@property
- def tx_id(self):
- """Gets the tx_id of this InlineResponse200. # noqa: E501
+ def time(self):
+ """Gets the time of this InlineResponse200. # noqa: E501
- Order id # noqa: E501
- :return: The tx_id of this InlineResponse200. # noqa: E501
- :rtype: str
+ :return: The time of this InlineResponse200. # noqa: E501
+ :rtype: int
"""
- return self._tx_id
+ return self._time
- @tx_id.setter
- def tx_id(self, tx_id):
- """Sets the tx_id of this InlineResponse200.
+ @time.setter
+ def time(self, time):
+ """Sets the time of this InlineResponse200.
- Order id # noqa: E501
- :param tx_id: The tx_id of this InlineResponse200. # noqa: E501
- :type: str
+ :param time: The time of this InlineResponse200. # noqa: E501
+ :type: int
"""
- self._tx_id = tx_id
+ self._time = time
@property
- def status(self):
- """Gets the status of this InlineResponse200. # noqa: E501
+ def value(self):
+ """Gets the value of this InlineResponse200. # noqa: E501
- Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) # noqa: E501
- :return: The status of this InlineResponse200. # noqa: E501
+ :return: The value of this InlineResponse200. # noqa: E501
:rtype: str
"""
- return self._status
+ return self._value
- @status.setter
- def status(self, status):
- """Sets the status of this InlineResponse200.
+ @value.setter
+ def value(self, value):
+ """Sets the value of this InlineResponse200.
- Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) # noqa: E501
- :param status: The status of this InlineResponse200. # noqa: E501
+ :param value: The value of this InlineResponse200. # noqa: E501
:type: str
"""
- self._status = status
+ self._value = value
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/inline_response2001.py b/gate_api/models/inline_response2001.py
index c41b9f8..e637913 100644
--- a/gate_api/models/inline_response2001.py
+++ b/gate_api/models/inline_response2001.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -33,48 +33,74 @@ class InlineResponse2001(object):
and the value is json key in definition.
"""
openapi_types = {
- 'enabled': 'bool'
+ 'currency': 'str',
+ 'est_rate': 'str'
}
attribute_map = {
- 'enabled': 'enabled'
+ 'currency': 'currency',
+ 'est_rate': 'est_rate'
}
- def __init__(self, enabled=None, local_vars_configuration=None): # noqa: E501
- # type: (bool, Configuration) -> None
+ def __init__(self, currency=None, est_rate=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, Configuration) -> None
"""InlineResponse2001 - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._enabled = None
+ self._currency = None
+ self._est_rate = None
self.discriminator = None
- if enabled is not None:
- self.enabled = enabled
+ if currency is not None:
+ self.currency = currency
+ if est_rate is not None:
+ self.est_rate = est_rate
@property
- def enabled(self):
- """Gets the enabled of this InlineResponse2001. # noqa: E501
+ def currency(self):
+ """Gets the currency of this InlineResponse2001. # noqa: E501
- Whether GT fee discount is used # noqa: E501
- :return: The enabled of this InlineResponse2001. # noqa: E501
- :rtype: bool
+ :return: The currency of this InlineResponse2001. # noqa: E501
+ :rtype: str
"""
- return self._enabled
+ return self._currency
- @enabled.setter
- def enabled(self, enabled):
- """Sets the enabled of this InlineResponse2001.
+ @currency.setter
+ def currency(self, currency):
+ """Sets the currency of this InlineResponse2001.
- Whether GT fee discount is used # noqa: E501
- :param enabled: The enabled of this InlineResponse2001. # noqa: E501
- :type: bool
+ :param currency: The currency of this InlineResponse2001. # noqa: E501
+ :type: str
"""
- self._enabled = enabled
+ self._currency = currency
+
+ @property
+ def est_rate(self):
+ """Gets the est_rate of this InlineResponse2001. # noqa: E501
+
+ Unconverted percentage # noqa: E501
+
+ :return: The est_rate of this InlineResponse2001. # noqa: E501
+ :rtype: str
+ """
+ return self._est_rate
+
+ @est_rate.setter
+ def est_rate(self, est_rate):
+ """Sets the est_rate of this InlineResponse2001.
+
+ Unconverted percentage # noqa: E501
+
+ :param est_rate: The est_rate of this InlineResponse2001. # noqa: E501
+ :type: str
+ """
+
+ self._est_rate = est_rate
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/insurance_record.py b/gate_api/models/insurance_record.py
index ac2ace6..9ee7e93 100644
--- a/gate_api/models/insurance_record.py
+++ b/gate_api/models/insurance_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/ledger_record.py b/gate_api/models/ledger_record.py
index 2f3f66e..c1cd314 100644
--- a/gate_api/models/ledger_record.py
+++ b/gate_api/models/ledger_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -41,6 +41,8 @@ class LedgerRecord(object):
'currency': 'str',
'address': 'str',
'memo': 'str',
+ 'withdraw_id': 'str',
+ 'asset_class': 'str',
'status': 'str',
'chain': 'str'
}
@@ -54,12 +56,14 @@ class LedgerRecord(object):
'currency': 'currency',
'address': 'address',
'memo': 'memo',
+ 'withdraw_id': 'withdraw_id',
+ 'asset_class': 'asset_class',
'status': 'status',
'chain': 'chain'
}
- def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, amount=None, currency=None, address=None, memo=None, status=None, chain=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, amount=None, currency=None, address=None, memo=None, withdraw_id=None, asset_class=None, status=None, chain=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
"""LedgerRecord - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -73,6 +77,8 @@ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, a
self._currency = None
self._address = None
self._memo = None
+ self._withdraw_id = None
+ self._asset_class = None
self._status = None
self._chain = None
self.discriminator = None
@@ -91,6 +97,10 @@ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, a
self.address = address
if memo is not None:
self.memo = memo
+ if withdraw_id is not None:
+ self.withdraw_id = withdraw_id
+ if asset_class is not None:
+ self.asset_class = asset_class
if status is not None:
self.status = status
self.chain = chain
@@ -145,7 +155,7 @@ def txid(self, txid):
def withdraw_order_id(self):
"""Gets the withdraw_order_id of this LedgerRecord. # noqa: E501
- Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) # noqa: E501
+ User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried # noqa: E501
:return: The withdraw_order_id of this LedgerRecord. # noqa: E501
:rtype: str
@@ -156,7 +166,7 @@ def withdraw_order_id(self):
def withdraw_order_id(self, withdraw_order_id):
"""Sets the withdraw_order_id of this LedgerRecord.
- Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) # noqa: E501
+ User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried # noqa: E501
:param withdraw_order_id: The withdraw_order_id of this LedgerRecord. # noqa: E501
:type: str
@@ -191,7 +201,7 @@ def timestamp(self, timestamp):
def amount(self):
"""Gets the amount of this LedgerRecord. # noqa: E501
- Currency amount # noqa: E501
+ Token amount # noqa: E501
:return: The amount of this LedgerRecord. # noqa: E501
:rtype: str
@@ -202,7 +212,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this LedgerRecord.
- Currency amount # noqa: E501
+ Token amount # noqa: E501
:param amount: The amount of this LedgerRecord. # noqa: E501
:type: str
@@ -283,11 +293,57 @@ def memo(self, memo):
self._memo = memo
+ @property
+ def withdraw_id(self):
+ """Gets the withdraw_id of this LedgerRecord. # noqa: E501
+
+ Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled # noqa: E501
+
+ :return: The withdraw_id of this LedgerRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._withdraw_id
+
+ @withdraw_id.setter
+ def withdraw_id(self, withdraw_id):
+ """Sets the withdraw_id of this LedgerRecord.
+
+ Withdrawal record ID starts with 'w', such as: w1879219868. When withdraw_id is not empty, only this specific withdrawal record will be queried, and time-based querying will be disabled # noqa: E501
+
+ :param withdraw_id: The withdraw_id of this LedgerRecord. # noqa: E501
+ :type: str
+ """
+
+ self._withdraw_id = withdraw_id
+
+ @property
+ def asset_class(self):
+ """Gets the asset_class of this LedgerRecord. # noqa: E501
+
+ Withdrawal record currency type, empty by default. Supports users to query withdrawal records in main area and innovation area on demand. Valid values: SPOT, PILOT SPOT: Main area PILOT: Innovation area # noqa: E501
+
+ :return: The asset_class of this LedgerRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._asset_class
+
+ @asset_class.setter
+ def asset_class(self, asset_class):
+ """Sets the asset_class of this LedgerRecord.
+
+ Withdrawal record currency type, empty by default. Supports users to query withdrawal records in main area and innovation area on demand. Valid values: SPOT, PILOT SPOT: Main area PILOT: Innovation area # noqa: E501
+
+ :param asset_class: The asset_class of this LedgerRecord. # noqa: E501
+ :type: str
+ """
+
+ self._asset_class = asset_class
+
@property
def status(self):
"""Gets the status of this LedgerRecord. # noqa: E501
- 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 # noqa: E501
+ Transaction status - DONE: Completed - CANCEL: Cancelled - REQUEST: Requesting - MANUAL: Pending manual review - BCODE: GateCode operation - EXTPEND: Sent, waiting for confirmation - FAIL: Failed on chain, waiting for confirmation - INVALID: Invalid order - VERIFY: Verifying - PROCES: Processing - PEND: Processing - DMOVE: Pending manual review - REVIEW: Under review # noqa: E501
:return: The status of this LedgerRecord. # noqa: E501
:rtype: str
@@ -298,17 +354,11 @@ def status(self):
def status(self, status):
"""Sets the status of this LedgerRecord.
- 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 # noqa: E501
+ Transaction status - DONE: Completed - CANCEL: Cancelled - REQUEST: Requesting - MANUAL: Pending manual review - BCODE: GateCode operation - EXTPEND: Sent, waiting for confirmation - FAIL: Failed on chain, waiting for confirmation - INVALID: Invalid order - VERIFY: Verifying - PROCES: Processing - PEND: Processing - DMOVE: Pending manual review - REVIEW: Under review # noqa: E501
:param status: The status of this LedgerRecord. # noqa: E501
:type: str
"""
- allowed_values = ["DONE", "CANCEL", "REQUEST", "MANUAL", "BCODE", "EXTPEND", "FAIL", "INVALID", "VERIFY", "PROCES", "PEND", "DMOVE", "SPLITPEND"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
- .format(status, allowed_values)
- )
self._status = status
diff --git a/gate_api/models/liquidate_order.py b/gate_api/models/liquidate_order.py
index 08b3ae6..97214b5 100644
--- a/gate_api/models/liquidate_order.py
+++ b/gate_api/models/liquidate_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -74,7 +74,7 @@ def __init__(self, text=None, currency_pair=None, amount=None, price=None, actio
def text(self):
"""Gets the text of this LiquidateOrder. # noqa: E501
- 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(.) # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
:return: The text of this LiquidateOrder. # noqa: E501
:rtype: str
@@ -85,7 +85,7 @@ def text(self):
def text(self, text):
"""Sets the text of this LiquidateOrder.
- 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(.) # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
:param text: The text of this LiquidateOrder. # noqa: E501
:type: str
@@ -172,7 +172,7 @@ def price(self, price):
def action_mode(self):
"""Gets the action_mode of this LiquidateOrder. # noqa: E501
- Processing Mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request, and it is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) # noqa: E501
+ Processing mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request and is not included in the response `ACK`: Asynchronous mode, only returns key order fields `RESULT`: No liquidation information `FULL`: Full mode (default) # noqa: E501
:return: The action_mode of this LiquidateOrder. # noqa: E501
:rtype: str
@@ -183,7 +183,7 @@ def action_mode(self):
def action_mode(self, action_mode):
"""Sets the action_mode of this LiquidateOrder.
- Processing Mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request, and it is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default) # noqa: E501
+ Processing mode: Different fields are returned when placing an order based on action_mode. This field is only valid during the request and is not included in the response `ACK`: Asynchronous mode, only returns key order fields `RESULT`: No liquidation information `FULL`: Full mode (default) # noqa: E501
:param action_mode: The action_mode of this LiquidateOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/loan.py b/gate_api/models/loan.py
deleted file mode 100644
index ae42a6d..0000000
--- a/gate_api/models/loan.py
+++ /dev/null
@@ -1,614 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class Loan(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'id': 'str',
- 'create_time': 'str',
- 'expire_time': 'str',
- 'status': 'str',
- 'side': 'str',
- 'currency': 'str',
- 'rate': 'str',
- 'amount': 'str',
- 'days': 'int',
- 'auto_renew': 'bool',
- 'currency_pair': 'str',
- 'left': 'str',
- 'repaid': 'str',
- 'paid_interest': 'str',
- 'unpaid_interest': 'str',
- 'fee_rate': 'str',
- 'orig_id': 'str',
- 'text': 'str'
- }
-
- attribute_map = {
- 'id': 'id',
- 'create_time': 'create_time',
- 'expire_time': 'expire_time',
- 'status': 'status',
- 'side': 'side',
- 'currency': 'currency',
- 'rate': 'rate',
- 'amount': 'amount',
- 'days': 'days',
- 'auto_renew': 'auto_renew',
- 'currency_pair': 'currency_pair',
- 'left': 'left',
- 'repaid': 'repaid',
- 'paid_interest': 'paid_interest',
- 'unpaid_interest': 'unpaid_interest',
- 'fee_rate': 'fee_rate',
- 'orig_id': 'orig_id',
- 'text': 'text'
- }
-
- def __init__(self, id=None, create_time=None, expire_time=None, status=None, side=None, currency=None, rate=None, amount=None, days=None, auto_renew=False, currency_pair=None, left=None, repaid=None, paid_interest=None, unpaid_interest=None, fee_rate=None, orig_id=None, text=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, int, bool, str, str, str, str, str, str, str, str, Configuration) -> None
- """Loan - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._id = None
- self._create_time = None
- self._expire_time = None
- self._status = None
- self._side = None
- self._currency = None
- self._rate = None
- self._amount = None
- self._days = None
- self._auto_renew = None
- self._currency_pair = None
- self._left = None
- self._repaid = None
- self._paid_interest = None
- self._unpaid_interest = None
- self._fee_rate = None
- self._orig_id = None
- self._text = None
- self.discriminator = None
-
- if id is not None:
- self.id = id
- if create_time is not None:
- self.create_time = create_time
- if expire_time is not None:
- self.expire_time = expire_time
- if status is not None:
- self.status = status
- self.side = side
- self.currency = currency
- if rate is not None:
- self.rate = rate
- self.amount = amount
- if days is not None:
- self.days = days
- if auto_renew is not None:
- self.auto_renew = auto_renew
- if currency_pair is not None:
- self.currency_pair = currency_pair
- if left is not None:
- self.left = left
- if repaid is not None:
- self.repaid = repaid
- if paid_interest is not None:
- self.paid_interest = paid_interest
- if unpaid_interest is not None:
- self.unpaid_interest = unpaid_interest
- if fee_rate is not None:
- self.fee_rate = fee_rate
- if orig_id is not None:
- self.orig_id = orig_id
- if text is not None:
- self.text = text
-
- @property
- def id(self):
- """Gets the id of this Loan. # noqa: E501
-
- Loan ID # noqa: E501
-
- :return: The id of this Loan. # noqa: E501
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id):
- """Sets the id of this Loan.
-
- Loan ID # noqa: E501
-
- :param id: The id of this Loan. # noqa: E501
- :type: str
- """
-
- self._id = id
-
- @property
- def create_time(self):
- """Gets the create_time of this Loan. # noqa: E501
-
- Creation time # noqa: E501
-
- :return: The create_time of this Loan. # noqa: E501
- :rtype: str
- """
- return self._create_time
-
- @create_time.setter
- def create_time(self, create_time):
- """Sets the create_time of this Loan.
-
- Creation time # noqa: E501
-
- :param create_time: The create_time of this Loan. # noqa: E501
- :type: str
- """
-
- self._create_time = create_time
-
- @property
- def expire_time(self):
- """Gets the expire_time of this Loan. # noqa: E501
-
- Repay time of the loan. No value will be returned for lending loan # noqa: E501
-
- :return: The expire_time of this Loan. # noqa: E501
- :rtype: str
- """
- return self._expire_time
-
- @expire_time.setter
- def expire_time(self, expire_time):
- """Sets the expire_time of this Loan.
-
- Repay time of the loan. No value will be returned for lending loan # noqa: E501
-
- :param expire_time: The expire_time of this Loan. # noqa: E501
- :type: str
- """
-
- self._expire_time = expire_time
-
- @property
- def status(self):
- """Gets the status of this Loan. # noqa: E501
-
- Loan status open - not fully loaned loaned - all loaned out for lending loan; loaned in for borrowing side finished - loan is finished, either being all repaid or cancelled by the lender auto_repaid - automatically repaid by the system # noqa: E501
-
- :return: The status of this Loan. # noqa: E501
- :rtype: str
- """
- return self._status
-
- @status.setter
- def status(self, status):
- """Sets the status of this Loan.
-
- Loan status open - not fully loaned loaned - all loaned out for lending loan; loaned in for borrowing side finished - loan is finished, either being all repaid or cancelled by the lender auto_repaid - automatically repaid by the system # noqa: E501
-
- :param status: The status of this Loan. # noqa: E501
- :type: str
- """
- allowed_values = ["open", "loaned", "finished", "auto_repaid"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
- .format(status, allowed_values)
- )
-
- self._status = status
-
- @property
- def side(self):
- """Gets the side of this Loan. # noqa: E501
-
- Loan side # noqa: E501
-
- :return: The side of this Loan. # noqa: E501
- :rtype: str
- """
- return self._side
-
- @side.setter
- def side(self, side):
- """Sets the side of this Loan.
-
- Loan side # noqa: E501
-
- :param side: The side of this Loan. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and side is None: # noqa: E501
- raise ValueError("Invalid value for `side`, must not be `None`") # noqa: E501
- allowed_values = ["lend", "borrow"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and side not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `side` ({0}), must be one of {1}" # noqa: E501
- .format(side, allowed_values)
- )
-
- self._side = side
-
- @property
- def currency(self):
- """Gets the currency of this Loan. # noqa: E501
-
- Loan currency # noqa: E501
-
- :return: The currency of this Loan. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this Loan.
-
- Loan currency # noqa: E501
-
- :param currency: The currency of this Loan. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
-
- self._currency = currency
-
- @property
- def rate(self):
- """Gets the rate of this Loan. # noqa: E501
-
- Loan rate. Only rates in [0.0001, 0.01] are supported. Not required in lending. Market rate calculated from recent rates will be used if not set # noqa: E501
-
- :return: The rate of this Loan. # noqa: E501
- :rtype: str
- """
- return self._rate
-
- @rate.setter
- def rate(self, rate):
- """Sets the rate of this Loan.
-
- Loan rate. Only rates in [0.0001, 0.01] are supported. Not required in lending. Market rate calculated from recent rates will be used if not set # noqa: E501
-
- :param rate: The rate of this Loan. # noqa: E501
- :type: str
- """
-
- self._rate = rate
-
- @property
- def amount(self):
- """Gets the amount of this Loan. # noqa: E501
-
- Loan amount # noqa: E501
-
- :return: The amount of this Loan. # noqa: E501
- :rtype: str
- """
- return self._amount
-
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this Loan.
-
- Loan amount # noqa: E501
-
- :param amount: The amount of this Loan. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
- raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
-
- self._amount = amount
-
- @property
- def days(self):
- """Gets the days of this Loan. # noqa: E501
-
- Loan days. Only 10 is supported for now # noqa: E501
-
- :return: The days of this Loan. # noqa: E501
- :rtype: int
- """
- return self._days
-
- @days.setter
- def days(self, days):
- """Sets the days of this Loan.
-
- Loan days. Only 10 is supported for now # noqa: E501
-
- :param days: The days of this Loan. # noqa: E501
- :type: int
- """
-
- self._days = days
-
- @property
- def auto_renew(self):
- """Gets the auto_renew of this Loan. # noqa: E501
-
- Whether to auto renew the loan upon expiration # noqa: E501
-
- :return: The auto_renew of this Loan. # noqa: E501
- :rtype: bool
- """
- return self._auto_renew
-
- @auto_renew.setter
- def auto_renew(self, auto_renew):
- """Sets the auto_renew of this Loan.
-
- Whether to auto renew the loan upon expiration # noqa: E501
-
- :param auto_renew: The auto_renew of this Loan. # noqa: E501
- :type: bool
- """
-
- self._auto_renew = auto_renew
-
- @property
- def currency_pair(self):
- """Gets the currency_pair of this Loan. # noqa: E501
-
- Currency pair. Required if borrowing # noqa: E501
-
- :return: The currency_pair of this Loan. # noqa: E501
- :rtype: str
- """
- return self._currency_pair
-
- @currency_pair.setter
- def currency_pair(self, currency_pair):
- """Sets the currency_pair of this Loan.
-
- Currency pair. Required if borrowing # noqa: E501
-
- :param currency_pair: The currency_pair of this Loan. # noqa: E501
- :type: str
- """
-
- self._currency_pair = currency_pair
-
- @property
- def left(self):
- """Gets the left of this Loan. # noqa: E501
-
- Amount not lent out yet # noqa: E501
-
- :return: The left of this Loan. # noqa: E501
- :rtype: str
- """
- return self._left
-
- @left.setter
- def left(self, left):
- """Sets the left of this Loan.
-
- Amount not lent out yet # noqa: E501
-
- :param left: The left of this Loan. # noqa: E501
- :type: str
- """
-
- self._left = left
-
- @property
- def repaid(self):
- """Gets the repaid of this Loan. # noqa: E501
-
- Repaid amount # noqa: E501
-
- :return: The repaid of this Loan. # noqa: E501
- :rtype: str
- """
- return self._repaid
-
- @repaid.setter
- def repaid(self, repaid):
- """Sets the repaid of this Loan.
-
- Repaid amount # noqa: E501
-
- :param repaid: The repaid of this Loan. # noqa: E501
- :type: str
- """
-
- self._repaid = repaid
-
- @property
- def paid_interest(self):
- """Gets the paid_interest of this Loan. # noqa: E501
-
- Repaid interest # noqa: E501
-
- :return: The paid_interest of this Loan. # noqa: E501
- :rtype: str
- """
- return self._paid_interest
-
- @paid_interest.setter
- def paid_interest(self, paid_interest):
- """Sets the paid_interest of this Loan.
-
- Repaid interest # noqa: E501
-
- :param paid_interest: The paid_interest of this Loan. # noqa: E501
- :type: str
- """
-
- self._paid_interest = paid_interest
-
- @property
- def unpaid_interest(self):
- """Gets the unpaid_interest of this Loan. # noqa: E501
-
- Outstanding interest yet to be paid # noqa: E501
-
- :return: The unpaid_interest of this Loan. # noqa: E501
- :rtype: str
- """
- return self._unpaid_interest
-
- @unpaid_interest.setter
- def unpaid_interest(self, unpaid_interest):
- """Sets the unpaid_interest of this Loan.
-
- Outstanding interest yet to be paid # noqa: E501
-
- :param unpaid_interest: The unpaid_interest of this Loan. # noqa: E501
- :type: str
- """
-
- self._unpaid_interest = unpaid_interest
-
- @property
- def fee_rate(self):
- """Gets the fee_rate of this Loan. # noqa: E501
-
- Loan fee rate # noqa: E501
-
- :return: The fee_rate of this Loan. # noqa: E501
- :rtype: str
- """
- return self._fee_rate
-
- @fee_rate.setter
- def fee_rate(self, fee_rate):
- """Sets the fee_rate of this Loan.
-
- Loan fee rate # noqa: E501
-
- :param fee_rate: The fee_rate of this Loan. # noqa: E501
- :type: str
- """
-
- self._fee_rate = fee_rate
-
- @property
- def orig_id(self):
- """Gets the orig_id of this Loan. # noqa: E501
-
- Original loan ID of the loan if auto-renewed, otherwise equals to id # noqa: E501
-
- :return: The orig_id of this Loan. # noqa: E501
- :rtype: str
- """
- return self._orig_id
-
- @orig_id.setter
- def orig_id(self, orig_id):
- """Sets the orig_id of this Loan.
-
- Original loan ID of the loan if auto-renewed, otherwise equals to id # noqa: E501
-
- :param orig_id: The orig_id of this Loan. # noqa: E501
- :type: str
- """
-
- self._orig_id = orig_id
-
- @property
- def text(self):
- """Gets the text of this Loan. # noqa: E501
-
- User defined custom ID # noqa: E501
-
- :return: The text of this Loan. # noqa: E501
- :rtype: str
- """
- return self._text
-
- @text.setter
- def text(self, text):
- """Sets the text of this Loan.
-
- User defined custom ID # noqa: E501
-
- :param text: The text of this Loan. # noqa: E501
- :type: str
- """
-
- self._text = text
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, Loan):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, Loan):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/loan_patch.py b/gate_api/models/loan_patch.py
deleted file mode 100644
index 173f20f..0000000
--- a/gate_api/models/loan_patch.py
+++ /dev/null
@@ -1,244 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class LoanPatch(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'currency': 'str',
- 'side': 'str',
- 'auto_renew': 'bool',
- 'currency_pair': 'str',
- 'loan_id': 'str'
- }
-
- attribute_map = {
- 'currency': 'currency',
- 'side': 'side',
- 'auto_renew': 'auto_renew',
- 'currency_pair': 'currency_pair',
- 'loan_id': 'loan_id'
- }
-
- def __init__(self, currency=None, side=None, auto_renew=None, currency_pair=None, loan_id=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, bool, str, str, Configuration) -> None
- """LoanPatch - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._currency = None
- self._side = None
- self._auto_renew = None
- self._currency_pair = None
- self._loan_id = None
- self.discriminator = None
-
- self.currency = currency
- self.side = side
- self.auto_renew = auto_renew
- if currency_pair is not None:
- self.currency_pair = currency_pair
- if loan_id is not None:
- self.loan_id = loan_id
-
- @property
- def currency(self):
- """Gets the currency of this LoanPatch. # noqa: E501
-
- Loan currency # noqa: E501
-
- :return: The currency of this LoanPatch. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this LoanPatch.
-
- Loan currency # noqa: E501
-
- :param currency: The currency of this LoanPatch. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
-
- self._currency = currency
-
- @property
- def side(self):
- """Gets the side of this LoanPatch. # noqa: E501
-
- Loan side. Possible values are `lend` and `borrow`. For `LoanRecord` patching, only `lend` is supported # noqa: E501
-
- :return: The side of this LoanPatch. # noqa: E501
- :rtype: str
- """
- return self._side
-
- @side.setter
- def side(self, side):
- """Sets the side of this LoanPatch.
-
- Loan side. Possible values are `lend` and `borrow`. For `LoanRecord` patching, only `lend` is supported # noqa: E501
-
- :param side: The side of this LoanPatch. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and side is None: # noqa: E501
- raise ValueError("Invalid value for `side`, must not be `None`") # noqa: E501
- allowed_values = ["lend", "borrow"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and side not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `side` ({0}), must be one of {1}" # noqa: E501
- .format(side, allowed_values)
- )
-
- self._side = side
-
- @property
- def auto_renew(self):
- """Gets the auto_renew of this LoanPatch. # noqa: E501
-
- Auto renew # noqa: E501
-
- :return: The auto_renew of this LoanPatch. # noqa: E501
- :rtype: bool
- """
- return self._auto_renew
-
- @auto_renew.setter
- def auto_renew(self, auto_renew):
- """Sets the auto_renew of this LoanPatch.
-
- Auto renew # noqa: E501
-
- :param auto_renew: The auto_renew of this LoanPatch. # noqa: E501
- :type: bool
- """
- if self.local_vars_configuration.client_side_validation and auto_renew is None: # noqa: E501
- raise ValueError("Invalid value for `auto_renew`, must not be `None`") # noqa: E501
-
- self._auto_renew = auto_renew
-
- @property
- def currency_pair(self):
- """Gets the currency_pair of this LoanPatch. # noqa: E501
-
- Currency pair. Required if borrowing # noqa: E501
-
- :return: The currency_pair of this LoanPatch. # noqa: E501
- :rtype: str
- """
- return self._currency_pair
-
- @currency_pair.setter
- def currency_pair(self, currency_pair):
- """Sets the currency_pair of this LoanPatch.
-
- Currency pair. Required if borrowing # noqa: E501
-
- :param currency_pair: The currency_pair of this LoanPatch. # noqa: E501
- :type: str
- """
-
- self._currency_pair = currency_pair
-
- @property
- def loan_id(self):
- """Gets the loan_id of this LoanPatch. # noqa: E501
-
- Loan ID. Required for `LoanRecord` patching # noqa: E501
-
- :return: The loan_id of this LoanPatch. # noqa: E501
- :rtype: str
- """
- return self._loan_id
-
- @loan_id.setter
- def loan_id(self, loan_id):
- """Sets the loan_id of this LoanPatch.
-
- Loan ID. Required for `LoanRecord` patching # noqa: E501
-
- :param loan_id: The loan_id of this LoanPatch. # noqa: E501
- :type: str
- """
-
- self._loan_id = loan_id
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, LoanPatch):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, LoanPatch):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/loan_record.py b/gate_api/models/loan_record.py
deleted file mode 100644
index d07ad5a..0000000
--- a/gate_api/models/loan_record.py
+++ /dev/null
@@ -1,493 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class LoanRecord(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'id': 'str',
- 'loan_id': 'str',
- 'create_time': 'str',
- 'expire_time': 'str',
- 'status': 'str',
- 'borrow_user_id': 'str',
- 'currency': 'str',
- 'rate': 'str',
- 'amount': 'str',
- 'days': 'int',
- 'auto_renew': 'bool',
- 'repaid': 'str',
- 'paid_interest': 'str',
- 'unpaid_interest': 'str'
- }
-
- attribute_map = {
- 'id': 'id',
- 'loan_id': 'loan_id',
- 'create_time': 'create_time',
- 'expire_time': 'expire_time',
- 'status': 'status',
- 'borrow_user_id': 'borrow_user_id',
- 'currency': 'currency',
- 'rate': 'rate',
- 'amount': 'amount',
- 'days': 'days',
- 'auto_renew': 'auto_renew',
- 'repaid': 'repaid',
- 'paid_interest': 'paid_interest',
- 'unpaid_interest': 'unpaid_interest'
- }
-
- def __init__(self, id=None, loan_id=None, create_time=None, expire_time=None, status=None, borrow_user_id=None, currency=None, rate=None, amount=None, days=None, auto_renew=False, repaid=None, paid_interest=None, unpaid_interest=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, int, bool, str, str, str, Configuration) -> None
- """LoanRecord - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._id = None
- self._loan_id = None
- self._create_time = None
- self._expire_time = None
- self._status = None
- self._borrow_user_id = None
- self._currency = None
- self._rate = None
- self._amount = None
- self._days = None
- self._auto_renew = None
- self._repaid = None
- self._paid_interest = None
- self._unpaid_interest = None
- self.discriminator = None
-
- if id is not None:
- self.id = id
- if loan_id is not None:
- self.loan_id = loan_id
- if create_time is not None:
- self.create_time = create_time
- if expire_time is not None:
- self.expire_time = expire_time
- if status is not None:
- self.status = status
- if borrow_user_id is not None:
- self.borrow_user_id = borrow_user_id
- if currency is not None:
- self.currency = currency
- if rate is not None:
- self.rate = rate
- if amount is not None:
- self.amount = amount
- if days is not None:
- self.days = days
- if auto_renew is not None:
- self.auto_renew = auto_renew
- if repaid is not None:
- self.repaid = repaid
- if paid_interest is not None:
- self.paid_interest = paid_interest
- if unpaid_interest is not None:
- self.unpaid_interest = unpaid_interest
-
- @property
- def id(self):
- """Gets the id of this LoanRecord. # noqa: E501
-
- Loan record ID # noqa: E501
-
- :return: The id of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id):
- """Sets the id of this LoanRecord.
-
- Loan record ID # noqa: E501
-
- :param id: The id of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._id = id
-
- @property
- def loan_id(self):
- """Gets the loan_id of this LoanRecord. # noqa: E501
-
- Loan ID the record belongs to # noqa: E501
-
- :return: The loan_id of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._loan_id
-
- @loan_id.setter
- def loan_id(self, loan_id):
- """Sets the loan_id of this LoanRecord.
-
- Loan ID the record belongs to # noqa: E501
-
- :param loan_id: The loan_id of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._loan_id = loan_id
-
- @property
- def create_time(self):
- """Gets the create_time of this LoanRecord. # noqa: E501
-
- Loan time # noqa: E501
-
- :return: The create_time of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._create_time
-
- @create_time.setter
- def create_time(self, create_time):
- """Sets the create_time of this LoanRecord.
-
- Loan time # noqa: E501
-
- :param create_time: The create_time of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._create_time = create_time
-
- @property
- def expire_time(self):
- """Gets the expire_time of this LoanRecord. # noqa: E501
-
- Expiration time # noqa: E501
-
- :return: The expire_time of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._expire_time
-
- @expire_time.setter
- def expire_time(self, expire_time):
- """Sets the expire_time of this LoanRecord.
-
- Expiration time # noqa: E501
-
- :param expire_time: The expire_time of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._expire_time = expire_time
-
- @property
- def status(self):
- """Gets the status of this LoanRecord. # noqa: E501
-
- Loan record status # noqa: E501
-
- :return: The status of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._status
-
- @status.setter
- def status(self, status):
- """Sets the status of this LoanRecord.
-
- Loan record status # noqa: E501
-
- :param status: The status of this LoanRecord. # noqa: E501
- :type: str
- """
- allowed_values = ["loaned", "finished"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
- .format(status, allowed_values)
- )
-
- self._status = status
-
- @property
- def borrow_user_id(self):
- """Gets the borrow_user_id of this LoanRecord. # noqa: E501
-
- Garbled user ID # noqa: E501
-
- :return: The borrow_user_id of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._borrow_user_id
-
- @borrow_user_id.setter
- def borrow_user_id(self, borrow_user_id):
- """Sets the borrow_user_id of this LoanRecord.
-
- Garbled user ID # noqa: E501
-
- :param borrow_user_id: The borrow_user_id of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._borrow_user_id = borrow_user_id
-
- @property
- def currency(self):
- """Gets the currency of this LoanRecord. # noqa: E501
-
- Loan currency # noqa: E501
-
- :return: The currency of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this LoanRecord.
-
- Loan currency # noqa: E501
-
- :param currency: The currency of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._currency = currency
-
- @property
- def rate(self):
- """Gets the rate of this LoanRecord. # noqa: E501
-
- Loan rate # noqa: E501
-
- :return: The rate of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._rate
-
- @rate.setter
- def rate(self, rate):
- """Sets the rate of this LoanRecord.
-
- Loan rate # noqa: E501
-
- :param rate: The rate of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._rate = rate
-
- @property
- def amount(self):
- """Gets the amount of this LoanRecord. # noqa: E501
-
- Loan amount # noqa: E501
-
- :return: The amount of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._amount
-
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this LoanRecord.
-
- Loan amount # noqa: E501
-
- :param amount: The amount of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._amount = amount
-
- @property
- def days(self):
- """Gets the days of this LoanRecord. # noqa: E501
-
- Loan days # noqa: E501
-
- :return: The days of this LoanRecord. # noqa: E501
- :rtype: int
- """
- return self._days
-
- @days.setter
- def days(self, days):
- """Sets the days of this LoanRecord.
-
- Loan days # noqa: E501
-
- :param days: The days of this LoanRecord. # noqa: E501
- :type: int
- """
-
- self._days = days
-
- @property
- def auto_renew(self):
- """Gets the auto_renew of this LoanRecord. # noqa: E501
-
- Whether the record will auto renew on expiration # noqa: E501
-
- :return: The auto_renew of this LoanRecord. # noqa: E501
- :rtype: bool
- """
- return self._auto_renew
-
- @auto_renew.setter
- def auto_renew(self, auto_renew):
- """Sets the auto_renew of this LoanRecord.
-
- Whether the record will auto renew on expiration # noqa: E501
-
- :param auto_renew: The auto_renew of this LoanRecord. # noqa: E501
- :type: bool
- """
-
- self._auto_renew = auto_renew
-
- @property
- def repaid(self):
- """Gets the repaid of this LoanRecord. # noqa: E501
-
- Repaid amount # noqa: E501
-
- :return: The repaid of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._repaid
-
- @repaid.setter
- def repaid(self, repaid):
- """Sets the repaid of this LoanRecord.
-
- Repaid amount # noqa: E501
-
- :param repaid: The repaid of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._repaid = repaid
-
- @property
- def paid_interest(self):
- """Gets the paid_interest of this LoanRecord. # noqa: E501
-
- Repaid interest # noqa: E501
-
- :return: The paid_interest of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._paid_interest
-
- @paid_interest.setter
- def paid_interest(self, paid_interest):
- """Sets the paid_interest of this LoanRecord.
-
- Repaid interest # noqa: E501
-
- :param paid_interest: The paid_interest of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._paid_interest = paid_interest
-
- @property
- def unpaid_interest(self):
- """Gets the unpaid_interest of this LoanRecord. # noqa: E501
-
- Outstanding interest yet to be paid # noqa: E501
-
- :return: The unpaid_interest of this LoanRecord. # noqa: E501
- :rtype: str
- """
- return self._unpaid_interest
-
- @unpaid_interest.setter
- def unpaid_interest(self, unpaid_interest):
- """Sets the unpaid_interest of this LoanRecord.
-
- Outstanding interest yet to be paid # noqa: E501
-
- :param unpaid_interest: The unpaid_interest of this LoanRecord. # noqa: E501
- :type: str
- """
-
- self._unpaid_interest = unpaid_interest
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, LoanRecord):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, LoanRecord):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/margin_account.py b/gate_api/models/margin_account.py
index 0c2d6c5..45561e7 100644
--- a/gate_api/models/margin_account.py
+++ b/gate_api/models/margin_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -34,40 +34,55 @@ class MarginAccount(object):
"""
openapi_types = {
'currency_pair': 'str',
+ 'account_type': 'str',
+ 'leverage': 'str',
'locked': 'bool',
'risk': 'str',
+ 'mmr': 'str',
'base': 'MarginAccountCurrency',
'quote': 'MarginAccountCurrency'
}
attribute_map = {
'currency_pair': 'currency_pair',
+ 'account_type': 'account_type',
+ 'leverage': 'leverage',
'locked': 'locked',
'risk': 'risk',
+ 'mmr': 'mmr',
'base': 'base',
'quote': 'quote'
}
- def __init__(self, currency_pair=None, locked=None, risk=None, base=None, quote=None, local_vars_configuration=None): # noqa: E501
- # type: (str, bool, str, MarginAccountCurrency, MarginAccountCurrency, Configuration) -> None
+ def __init__(self, currency_pair=None, account_type=None, leverage=None, locked=None, risk=None, mmr=None, base=None, quote=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, bool, str, str, MarginAccountCurrency, MarginAccountCurrency, Configuration) -> None
"""MarginAccount - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
self._currency_pair = None
+ self._account_type = None
+ self._leverage = None
self._locked = None
self._risk = None
+ self._mmr = None
self._base = None
self._quote = None
self.discriminator = None
if currency_pair is not None:
self.currency_pair = currency_pair
+ if account_type is not None:
+ self.account_type = account_type
+ if leverage is not None:
+ self.leverage = leverage
if locked is not None:
self.locked = locked
if risk is not None:
self.risk = risk
+ if mmr is not None:
+ self.mmr = mmr
if base is not None:
self.base = base
if quote is not None:
@@ -96,11 +111,57 @@ def currency_pair(self, currency_pair):
self._currency_pair = currency_pair
+ @property
+ def account_type(self):
+ """Gets the account_type of this MarginAccount. # noqa: E501
+
+ Account type: risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated # noqa: E501
+
+ :return: The account_type of this MarginAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._account_type
+
+ @account_type.setter
+ def account_type(self, account_type):
+ """Sets the account_type of this MarginAccount.
+
+ Account type: risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated # noqa: E501
+
+ :param account_type: The account_type of this MarginAccount. # noqa: E501
+ :type: str
+ """
+
+ self._account_type = account_type
+
+ @property
+ def leverage(self):
+ """Gets the leverage of this MarginAccount. # noqa: E501
+
+ User's current market leverage multiplier # noqa: E501
+
+ :return: The leverage of this MarginAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._leverage
+
+ @leverage.setter
+ def leverage(self, leverage):
+ """Sets the leverage of this MarginAccount.
+
+ User's current market leverage multiplier # noqa: E501
+
+ :param leverage: The leverage of this MarginAccount. # noqa: E501
+ :type: str
+ """
+
+ self._leverage = leverage
+
@property
def locked(self):
"""Gets the locked of this MarginAccount. # noqa: E501
- Whether account is locked # noqa: E501
+ Whether the account is locked # noqa: E501
:return: The locked of this MarginAccount. # noqa: E501
:rtype: bool
@@ -111,7 +172,7 @@ def locked(self):
def locked(self, locked):
"""Sets the locked of this MarginAccount.
- Whether account is locked # noqa: E501
+ Whether the account is locked # noqa: E501
:param locked: The locked of this MarginAccount. # noqa: E501
:type: bool
@@ -123,7 +184,7 @@ def locked(self, locked):
def risk(self):
"""Gets the risk of this MarginAccount. # noqa: E501
- Current risk rate of margin account # noqa: E501
+ Current risk rate of the margin account (returned when the account is a risk rate account) # noqa: E501
:return: The risk of this MarginAccount. # noqa: E501
:rtype: str
@@ -134,7 +195,7 @@ def risk(self):
def risk(self, risk):
"""Sets the risk of this MarginAccount.
- Current risk rate of margin account # noqa: E501
+ Current risk rate of the margin account (returned when the account is a risk rate account) # noqa: E501
:param risk: The risk of this MarginAccount. # noqa: E501
:type: str
@@ -142,6 +203,29 @@ def risk(self, risk):
self._risk = risk
+ @property
+ def mmr(self):
+ """Gets the mmr of this MarginAccount. # noqa: E501
+
+ Leveraged Account Current Maintenance Margin Rate (returned when the Account is Account) # noqa: E501
+
+ :return: The mmr of this MarginAccount. # noqa: E501
+ :rtype: str
+ """
+ return self._mmr
+
+ @mmr.setter
+ def mmr(self, mmr):
+ """Sets the mmr of this MarginAccount.
+
+ Leveraged Account Current Maintenance Margin Rate (returned when the Account is Account) # noqa: E501
+
+ :param mmr: The mmr of this MarginAccount. # noqa: E501
+ :type: str
+ """
+
+ self._mmr = mmr
+
@property
def base(self):
"""Gets the base of this MarginAccount. # noqa: E501
diff --git a/gate_api/models/margin_account_book.py b/gate_api/models/margin_account_book.py
index 044bd9a..1ee6bbd 100644
--- a/gate_api/models/margin_account_book.py
+++ b/gate_api/models/margin_account_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -115,7 +115,7 @@ def id(self, id):
def time(self):
"""Gets the time of this MarginAccountBook. # noqa: E501
- Balance changed timestamp # noqa: E501
+ Account change timestamp # noqa: E501
:return: The time of this MarginAccountBook. # noqa: E501
:rtype: str
@@ -126,7 +126,7 @@ def time(self):
def time(self, time):
"""Sets the time of this MarginAccountBook.
- Balance changed timestamp # noqa: E501
+ Account change timestamp # noqa: E501
:param time: The time of this MarginAccountBook. # noqa: E501
:type: str
@@ -184,7 +184,7 @@ def currency(self, currency):
def currency_pair(self):
"""Gets the currency_pair of this MarginAccountBook. # noqa: E501
- Account currency pair # noqa: E501
+ Account trading pair # noqa: E501
:return: The currency_pair of this MarginAccountBook. # noqa: E501
:rtype: str
@@ -195,7 +195,7 @@ def currency_pair(self):
def currency_pair(self, currency_pair):
"""Sets the currency_pair of this MarginAccountBook.
- Account currency pair # noqa: E501
+ Account trading pair # noqa: E501
:param currency_pair: The currency_pair of this MarginAccountBook. # noqa: E501
:type: str
@@ -253,7 +253,7 @@ def balance(self, balance):
def type(self):
"""Gets the type of this MarginAccountBook. # noqa: E501
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
+ Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
:return: The type of this MarginAccountBook. # noqa: E501
:rtype: str
@@ -264,7 +264,7 @@ def type(self):
def type(self, type):
"""Sets the type of this MarginAccountBook.
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
+ Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
:param type: The type of this MarginAccountBook. # noqa: E501
:type: str
diff --git a/gate_api/models/margin_account_currency.py b/gate_api/models/margin_account_currency.py
index 7c727fd..cb96b38 100644
--- a/gate_api/models/margin_account_currency.py
+++ b/gate_api/models/margin_account_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -100,7 +100,7 @@ def currency(self, currency):
def available(self):
"""Gets the available of this MarginAccountCurrency. # noqa: E501
- Amount suitable for margin trading. # noqa: E501
+ Amount available for margin trading, available = margin + borrowed # noqa: E501
:return: The available of this MarginAccountCurrency. # noqa: E501
:rtype: str
@@ -111,7 +111,7 @@ def available(self):
def available(self, available):
"""Sets the available of this MarginAccountCurrency.
- Amount suitable for margin trading. # noqa: E501
+ Amount available for margin trading, available = margin + borrowed # noqa: E501
:param available: The available of this MarginAccountCurrency. # noqa: E501
:type: str
@@ -123,7 +123,7 @@ def available(self, available):
def locked(self):
"""Gets the locked of this MarginAccountCurrency. # noqa: E501
- Locked amount, used in margin trading # noqa: E501
+ Frozen funds, such as amounts already placed in margin market for order trading # noqa: E501
:return: The locked of this MarginAccountCurrency. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def locked(self):
def locked(self, locked):
"""Sets the locked of this MarginAccountCurrency.
- Locked amount, used in margin trading # noqa: E501
+ Frozen funds, such as amounts already placed in margin market for order trading # noqa: E501
:param locked: The locked of this MarginAccountCurrency. # noqa: E501
:type: str
@@ -146,7 +146,7 @@ def locked(self, locked):
def borrowed(self):
"""Gets the borrowed of this MarginAccountCurrency. # noqa: E501
- Borrowed amount # noqa: E501
+ Borrowed funds # noqa: E501
:return: The borrowed of this MarginAccountCurrency. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def borrowed(self):
def borrowed(self, borrowed):
"""Sets the borrowed of this MarginAccountCurrency.
- Borrowed amount # noqa: E501
+ Borrowed funds # noqa: E501
:param borrowed: The borrowed of this MarginAccountCurrency. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def borrowed(self, borrowed):
def interest(self):
"""Gets the interest of this MarginAccountCurrency. # noqa: E501
- Unpaid interests # noqa: E501
+ Unpaid interest # noqa: E501
:return: The interest of this MarginAccountCurrency. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def interest(self):
def interest(self, interest):
"""Sets the interest of this MarginAccountCurrency.
- Unpaid interests # noqa: E501
+ Unpaid interest # noqa: E501
:param interest: The interest of this MarginAccountCurrency. # noqa: E501
:type: str
diff --git a/gate_api/models/margin_currency_pair.py b/gate_api/models/margin_currency_pair.py
deleted file mode 100644
index 2ecaae1..0000000
--- a/gate_api/models/margin_currency_pair.py
+++ /dev/null
@@ -1,319 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class MarginCurrencyPair(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'id': 'str',
- 'base': 'str',
- 'quote': 'str',
- 'leverage': 'int',
- 'min_base_amount': 'str',
- 'min_quote_amount': 'str',
- 'max_quote_amount': 'str',
- 'status': 'int'
- }
-
- attribute_map = {
- 'id': 'id',
- 'base': 'base',
- 'quote': 'quote',
- 'leverage': 'leverage',
- 'min_base_amount': 'min_base_amount',
- 'min_quote_amount': 'min_quote_amount',
- 'max_quote_amount': 'max_quote_amount',
- 'status': 'status'
- }
-
- def __init__(self, id=None, base=None, quote=None, leverage=None, min_base_amount=None, min_quote_amount=None, max_quote_amount=None, status=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, int, str, str, str, int, Configuration) -> None
- """MarginCurrencyPair - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._id = None
- self._base = None
- self._quote = None
- self._leverage = None
- self._min_base_amount = None
- self._min_quote_amount = None
- self._max_quote_amount = None
- self._status = None
- self.discriminator = None
-
- if id is not None:
- self.id = id
- if base is not None:
- self.base = base
- if quote is not None:
- self.quote = quote
- if leverage is not None:
- self.leverage = leverage
- if min_base_amount is not None:
- self.min_base_amount = min_base_amount
- if min_quote_amount is not None:
- self.min_quote_amount = min_quote_amount
- if max_quote_amount is not None:
- self.max_quote_amount = max_quote_amount
- if status is not None:
- self.status = status
-
- @property
- def id(self):
- """Gets the id of this MarginCurrencyPair. # noqa: E501
-
- Currency pair # noqa: E501
-
- :return: The id of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id):
- """Sets the id of this MarginCurrencyPair.
-
- Currency pair # noqa: E501
-
- :param id: The id of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._id = id
-
- @property
- def base(self):
- """Gets the base of this MarginCurrencyPair. # noqa: E501
-
- Base currency # noqa: E501
-
- :return: The base of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._base
-
- @base.setter
- def base(self, base):
- """Sets the base of this MarginCurrencyPair.
-
- Base currency # noqa: E501
-
- :param base: The base of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._base = base
-
- @property
- def quote(self):
- """Gets the quote of this MarginCurrencyPair. # noqa: E501
-
- Quote currency # noqa: E501
-
- :return: The quote of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._quote
-
- @quote.setter
- def quote(self, quote):
- """Sets the quote of this MarginCurrencyPair.
-
- Quote currency # noqa: E501
-
- :param quote: The quote of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._quote = quote
-
- @property
- def leverage(self):
- """Gets the leverage of this MarginCurrencyPair. # noqa: E501
-
- Leverage # noqa: E501
-
- :return: The leverage of this MarginCurrencyPair. # noqa: E501
- :rtype: int
- """
- return self._leverage
-
- @leverage.setter
- def leverage(self, leverage):
- """Sets the leverage of this MarginCurrencyPair.
-
- Leverage # noqa: E501
-
- :param leverage: The leverage of this MarginCurrencyPair. # noqa: E501
- :type: int
- """
-
- self._leverage = leverage
-
- @property
- def min_base_amount(self):
- """Gets the min_base_amount of this MarginCurrencyPair. # noqa: E501
-
- Minimum base currency to loan, `null` means no limit # noqa: E501
-
- :return: The min_base_amount of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._min_base_amount
-
- @min_base_amount.setter
- def min_base_amount(self, min_base_amount):
- """Sets the min_base_amount of this MarginCurrencyPair.
-
- Minimum base currency to loan, `null` means no limit # noqa: E501
-
- :param min_base_amount: The min_base_amount of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._min_base_amount = min_base_amount
-
- @property
- def min_quote_amount(self):
- """Gets the min_quote_amount of this MarginCurrencyPair. # noqa: E501
-
- Minimum quote currency to loan, `null` means no limit # noqa: E501
-
- :return: The min_quote_amount of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._min_quote_amount
-
- @min_quote_amount.setter
- def min_quote_amount(self, min_quote_amount):
- """Sets the min_quote_amount of this MarginCurrencyPair.
-
- Minimum quote currency to loan, `null` means no limit # noqa: E501
-
- :param min_quote_amount: The min_quote_amount of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._min_quote_amount = min_quote_amount
-
- @property
- def max_quote_amount(self):
- """Gets the max_quote_amount of this MarginCurrencyPair. # noqa: E501
-
- Maximum borrowable amount for quote currency. Base currency limit is calculated by quote maximum and market price. `null` means no limit # noqa: E501
-
- :return: The max_quote_amount of this MarginCurrencyPair. # noqa: E501
- :rtype: str
- """
- return self._max_quote_amount
-
- @max_quote_amount.setter
- def max_quote_amount(self, max_quote_amount):
- """Sets the max_quote_amount of this MarginCurrencyPair.
-
- Maximum borrowable amount for quote currency. Base currency limit is calculated by quote maximum and market price. `null` means no limit # noqa: E501
-
- :param max_quote_amount: The max_quote_amount of this MarginCurrencyPair. # noqa: E501
- :type: str
- """
-
- self._max_quote_amount = max_quote_amount
-
- @property
- def status(self):
- """Gets the status of this MarginCurrencyPair. # noqa: E501
-
- Currency pair status - `0`: disabled - `1`: enabled # noqa: E501
-
- :return: The status of this MarginCurrencyPair. # noqa: E501
- :rtype: int
- """
- return self._status
-
- @status.setter
- def status(self, status):
- """Sets the status of this MarginCurrencyPair.
-
- Currency pair status - `0`: disabled - `1`: enabled # noqa: E501
-
- :param status: The status of this MarginCurrencyPair. # noqa: E501
- :type: int
- """
-
- self._status = status
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, MarginCurrencyPair):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, MarginCurrencyPair):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/margin_leverage_tier.py b/gate_api/models/margin_leverage_tier.py
new file mode 100644
index 0000000..ebf2237
--- /dev/null
+++ b/gate_api/models/margin_leverage_tier.py
@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class MarginLeverageTier(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'upper_limit': 'str',
+ 'mmr': 'str',
+ 'leverage': 'str'
+ }
+
+ attribute_map = {
+ 'upper_limit': 'upper_limit',
+ 'mmr': 'mmr',
+ 'leverage': 'leverage'
+ }
+
+ def __init__(self, upper_limit=None, mmr=None, leverage=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, Configuration) -> None
+ """MarginLeverageTier - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._upper_limit = None
+ self._mmr = None
+ self._leverage = None
+ self.discriminator = None
+
+ if upper_limit is not None:
+ self.upper_limit = upper_limit
+ if mmr is not None:
+ self.mmr = mmr
+ if leverage is not None:
+ self.leverage = leverage
+
+ @property
+ def upper_limit(self):
+ """Gets the upper_limit of this MarginLeverageTier. # noqa: E501
+
+ Maximum loan limit # noqa: E501
+
+ :return: The upper_limit of this MarginLeverageTier. # noqa: E501
+ :rtype: str
+ """
+ return self._upper_limit
+
+ @upper_limit.setter
+ def upper_limit(self, upper_limit):
+ """Sets the upper_limit of this MarginLeverageTier.
+
+ Maximum loan limit # noqa: E501
+
+ :param upper_limit: The upper_limit of this MarginLeverageTier. # noqa: E501
+ :type: str
+ """
+
+ self._upper_limit = upper_limit
+
+ @property
+ def mmr(self):
+ """Gets the mmr of this MarginLeverageTier. # noqa: E501
+
+ Maintenance margin rate # noqa: E501
+
+ :return: The mmr of this MarginLeverageTier. # noqa: E501
+ :rtype: str
+ """
+ return self._mmr
+
+ @mmr.setter
+ def mmr(self, mmr):
+ """Sets the mmr of this MarginLeverageTier.
+
+ Maintenance margin rate # noqa: E501
+
+ :param mmr: The mmr of this MarginLeverageTier. # noqa: E501
+ :type: str
+ """
+
+ self._mmr = mmr
+
+ @property
+ def leverage(self):
+ """Gets the leverage of this MarginLeverageTier. # noqa: E501
+
+ Maximum leverage multiple # noqa: E501
+
+ :return: The leverage of this MarginLeverageTier. # noqa: E501
+ :rtype: str
+ """
+ return self._leverage
+
+ @leverage.setter
+ def leverage(self, leverage):
+ """Sets the leverage of this MarginLeverageTier.
+
+ Maximum leverage multiple # noqa: E501
+
+ :param leverage: The leverage of this MarginLeverageTier. # noqa: E501
+ :type: str
+ """
+
+ self._leverage = leverage
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, MarginLeverageTier):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, MarginLeverageTier):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/margin_borrowable.py b/gate_api/models/margin_market_leverage.py
similarity index 54%
rename from gate_api/models/margin_borrowable.py
rename to gate_api/models/margin_market_leverage.py
index 4d8ebe2..f024010 100644
--- a/gate_api/models/margin_borrowable.py
+++ b/gate_api/models/margin_market_leverage.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class MarginBorrowable(object):
+class MarginMarketLeverage(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -33,104 +33,77 @@ class MarginBorrowable(object):
and the value is json key in definition.
"""
openapi_types = {
- 'currency': 'str',
'currency_pair': 'str',
- 'amount': 'str'
+ 'leverage': 'str'
}
attribute_map = {
- 'currency': 'currency',
'currency_pair': 'currency_pair',
- 'amount': 'amount'
+ 'leverage': 'leverage'
}
- def __init__(self, currency=None, currency_pair=None, amount=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, Configuration) -> None
- """MarginBorrowable - a model defined in OpenAPI""" # noqa: E501
+ def __init__(self, currency_pair=None, leverage=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, Configuration) -> None
+ """MarginMarketLeverage - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._currency = None
self._currency_pair = None
- self._amount = None
+ self._leverage = None
self.discriminator = None
- if currency is not None:
- self.currency = currency
if currency_pair is not None:
self.currency_pair = currency_pair
- if amount is not None:
- self.amount = amount
-
- @property
- def currency(self):
- """Gets the currency of this MarginBorrowable. # noqa: E501
-
- Currency detail # noqa: E501
-
- :return: The currency of this MarginBorrowable. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this MarginBorrowable.
-
- Currency detail # noqa: E501
-
- :param currency: The currency of this MarginBorrowable. # noqa: E501
- :type: str
- """
-
- self._currency = currency
+ self.leverage = leverage
@property
def currency_pair(self):
- """Gets the currency_pair of this MarginBorrowable. # noqa: E501
+ """Gets the currency_pair of this MarginMarketLeverage. # noqa: E501
- Currency pair # noqa: E501
+ Market # noqa: E501
- :return: The currency_pair of this MarginBorrowable. # noqa: E501
+ :return: The currency_pair of this MarginMarketLeverage. # noqa: E501
:rtype: str
"""
return self._currency_pair
@currency_pair.setter
def currency_pair(self, currency_pair):
- """Sets the currency_pair of this MarginBorrowable.
+ """Sets the currency_pair of this MarginMarketLeverage.
- Currency pair # noqa: E501
+ Market # noqa: E501
- :param currency_pair: The currency_pair of this MarginBorrowable. # noqa: E501
+ :param currency_pair: The currency_pair of this MarginMarketLeverage. # noqa: E501
:type: str
"""
self._currency_pair = currency_pair
@property
- def amount(self):
- """Gets the amount of this MarginBorrowable. # noqa: E501
+ def leverage(self):
+ """Gets the leverage of this MarginMarketLeverage. # noqa: E501
- Max borrowable amount # noqa: E501
+ Position leverage # noqa: E501
- :return: The amount of this MarginBorrowable. # noqa: E501
+ :return: The leverage of this MarginMarketLeverage. # noqa: E501
:rtype: str
"""
- return self._amount
+ return self._leverage
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this MarginBorrowable.
+ @leverage.setter
+ def leverage(self, leverage):
+ """Sets the leverage of this MarginMarketLeverage.
- Max borrowable amount # noqa: E501
+ Position leverage # noqa: E501
- :param amount: The amount of this MarginBorrowable. # noqa: E501
+ :param leverage: The leverage of this MarginMarketLeverage. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and leverage is None: # noqa: E501
+ raise ValueError("Invalid value for `leverage`, must not be `None`") # noqa: E501
- self._amount = amount
+ self._leverage = leverage
def to_dict(self):
"""Returns the model properties as a dict"""
@@ -166,14 +139,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, MarginBorrowable):
+ if not isinstance(other, MarginMarketLeverage):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, MarginBorrowable):
+ if not isinstance(other, MarginMarketLeverage):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/margin_tiers.py b/gate_api/models/margin_tiers.py
index 7ba2e3b..a1bb5e7 100644
--- a/gate_api/models/margin_tiers.py
+++ b/gate_api/models/margin_tiers.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/margin_transferable.py b/gate_api/models/margin_transferable.py
index 475eb4a..4031c74 100644
--- a/gate_api/models/margin_transferable.py
+++ b/gate_api/models/margin_transferable.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/max_uni_borrowable.py b/gate_api/models/max_uni_borrowable.py
index 308cd25..5ac2d09 100644
--- a/gate_api/models/max_uni_borrowable.py
+++ b/gate_api/models/max_uni_borrowable.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/mock_futures_order.py b/gate_api/models/mock_futures_order.py
index 7686660..3adadb8 100644
--- a/gate_api/models/mock_futures_order.py
+++ b/gate_api/models/mock_futures_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -64,7 +64,7 @@ def __init__(self, contract=None, size=None, left=None, local_vars_configuration
def contract(self):
"""Gets the contract of this MockFuturesOrder. # noqa: E501
- Futures name, currently only supports perpetual futures for BTC and ETH with USDT. # noqa: E501
+ Futures name, currently only supports USDT perpetual contracts for BTC and ETH # noqa: E501
:return: The contract of this MockFuturesOrder. # noqa: E501
:rtype: str
@@ -75,7 +75,7 @@ def contract(self):
def contract(self, contract):
"""Sets the contract of this MockFuturesOrder.
- Futures name, currently only supports perpetual futures for BTC and ETH with USDT. # noqa: E501
+ Futures name, currently only supports USDT perpetual contracts for BTC and ETH # noqa: E501
:param contract: The contract of this MockFuturesOrder. # noqa: E501
:type: str
@@ -89,7 +89,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this MockFuturesOrder. # noqa: E501
- Futures quantity, representing the initial order quantity, not involved in actual settlement. # noqa: E501
+ Contract quantity, representing the initial order quantity, not involved in actual settlement # noqa: E501
:return: The size of this MockFuturesOrder. # noqa: E501
:rtype: str
@@ -100,7 +100,7 @@ def size(self):
def size(self, size):
"""Sets the size of this MockFuturesOrder.
- Futures quantity, representing the initial order quantity, not involved in actual settlement. # noqa: E501
+ Contract quantity, representing the initial order quantity, not involved in actual settlement # noqa: E501
:param size: The size of this MockFuturesOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_futures_position.py b/gate_api/models/mock_futures_position.py
index c6e645c..158c6a7 100644
--- a/gate_api/models/mock_futures_position.py
+++ b/gate_api/models/mock_futures_position.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -60,7 +60,7 @@ def __init__(self, contract=None, size=None, local_vars_configuration=None): #
def contract(self):
"""Gets the contract of this MockFuturesPosition. # noqa: E501
- Futures name, currently only supports perpetual futures for BTC and ETH with USDT. # noqa: E501
+ Futures name, currently only supports USDT perpetual contracts for BTC and ETH # noqa: E501
:return: The contract of this MockFuturesPosition. # noqa: E501
:rtype: str
@@ -71,7 +71,7 @@ def contract(self):
def contract(self, contract):
"""Sets the contract of this MockFuturesPosition.
- Futures name, currently only supports perpetual futures for BTC and ETH with USDT. # noqa: E501
+ Futures name, currently only supports USDT perpetual contracts for BTC and ETH # noqa: E501
:param contract: The contract of this MockFuturesPosition. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this MockFuturesPosition. # noqa: E501
- Position size, measured in contract units. # noqa: E501
+ Position size, measured in contract quantity # noqa: E501
:return: The size of this MockFuturesPosition. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def size(self):
def size(self, size):
"""Sets the size of this MockFuturesPosition.
- Position size, measured in contract units. # noqa: E501
+ Position size, measured in contract quantity # noqa: E501
:param size: The size of this MockFuturesPosition. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_margin_result.py b/gate_api/models/mock_margin_result.py
index 232b895..7181f58 100644
--- a/gate_api/models/mock_margin_result.py
+++ b/gate_api/models/mock_margin_result.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -110,7 +110,7 @@ def type(self, type):
def profit_loss_ranges(self):
"""Gets the profit_loss_ranges of this MockMarginResult. # noqa: E501
- The results of 33 pressure scenarios for MR1 # noqa: E501
+ Results of 33 stress scenarios for MR1 # noqa: E501
:return: The profit_loss_ranges of this MockMarginResult. # noqa: E501
:rtype: list[ProfitLossRange]
@@ -121,7 +121,7 @@ def profit_loss_ranges(self):
def profit_loss_ranges(self, profit_loss_ranges):
"""Sets the profit_loss_ranges of this MockMarginResult.
- The results of 33 pressure scenarios for MR1 # noqa: E501
+ Results of 33 stress scenarios for MR1 # noqa: E501
:param profit_loss_ranges: The profit_loss_ranges of this MockMarginResult. # noqa: E501
:type: list[ProfitLossRange]
diff --git a/gate_api/models/mock_options_order.py b/gate_api/models/mock_options_order.py
index 4c9548e..7a5193c 100644
--- a/gate_api/models/mock_options_order.py
+++ b/gate_api/models/mock_options_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -64,7 +64,7 @@ def __init__(self, options_name=None, size=None, left=None, local_vars_configura
def options_name(self):
"""Gets the options_name of this MockOptionsOrder. # noqa: E501
- Option name, currently only supports options for BTC and ETH with USDT. # noqa: E501
+ Option name, currently only supports USDT options for BTC and ETH # noqa: E501
:return: The options_name of this MockOptionsOrder. # noqa: E501
:rtype: str
@@ -75,7 +75,7 @@ def options_name(self):
def options_name(self, options_name):
"""Sets the options_name of this MockOptionsOrder.
- Option name, currently only supports options for BTC and ETH with USDT. # noqa: E501
+ Option name, currently only supports USDT options for BTC and ETH # noqa: E501
:param options_name: The options_name of this MockOptionsOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_options_position.py b/gate_api/models/mock_options_position.py
index 79b310d..3d27436 100644
--- a/gate_api/models/mock_options_position.py
+++ b/gate_api/models/mock_options_position.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -60,7 +60,7 @@ def __init__(self, options_name=None, size=None, local_vars_configuration=None):
def options_name(self):
"""Gets the options_name of this MockOptionsPosition. # noqa: E501
- Option name, currently only supports options for BTC and ETH with USDT. # noqa: E501
+ Option name, currently only supports USDT options for BTC and ETH # noqa: E501
:return: The options_name of this MockOptionsPosition. # noqa: E501
:rtype: str
@@ -71,7 +71,7 @@ def options_name(self):
def options_name(self, options_name):
"""Sets the options_name of this MockOptionsPosition.
- Option name, currently only supports options for BTC and ETH with USDT. # noqa: E501
+ Option name, currently only supports USDT options for BTC and ETH # noqa: E501
:param options_name: The options_name of this MockOptionsPosition. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def options_name(self, options_name):
def size(self):
"""Gets the size of this MockOptionsPosition. # noqa: E501
- Position size, measured in contract units. # noqa: E501
+ Position size, measured in contract quantity # noqa: E501
:return: The size of this MockOptionsPosition. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def size(self):
def size(self, size):
"""Sets the size of this MockOptionsPosition.
- Position size, measured in contract units. # noqa: E501
+ Position size, measured in contract quantity # noqa: E501
:param size: The size of this MockOptionsPosition. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_risk_unit.py b/gate_api/models/mock_risk_unit.py
index 4c32074..7ae22d4 100644
--- a/gate_api/models/mock_risk_unit.py
+++ b/gate_api/models/mock_risk_unit.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -120,7 +120,7 @@ def symbol(self, symbol):
def spot_in_use(self):
"""Gets the spot_in_use of this MockRiskUnit. # noqa: E501
- Spot usage # noqa: E501
+ Spot hedge usage # noqa: E501
:return: The spot_in_use of this MockRiskUnit. # noqa: E501
:rtype: str
@@ -131,7 +131,7 @@ def spot_in_use(self):
def spot_in_use(self, spot_in_use):
"""Sets the spot_in_use of this MockRiskUnit.
- Spot usage # noqa: E501
+ Spot hedge usage # noqa: E501
:param spot_in_use: The spot_in_use of this MockRiskUnit. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_spot_balance.py b/gate_api/models/mock_spot_balance.py
index a5b3c90..721cf0b 100644
--- a/gate_api/models/mock_spot_balance.py
+++ b/gate_api/models/mock_spot_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def currency(self, currency):
def equity(self):
"""Gets the equity of this MockSpotBalance. # noqa: E501
- Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. # noqa: E501
+ Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports BTC and ETH # noqa: E501
:return: The equity of this MockSpotBalance. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def equity(self):
def equity(self, equity):
"""Sets the equity of this MockSpotBalance.
- Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. # noqa: E501
+ Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports BTC and ETH # noqa: E501
:param equity: The equity of this MockSpotBalance. # noqa: E501
:type: str
diff --git a/gate_api/models/mock_spot_order.py b/gate_api/models/mock_spot_order.py
index 94ee0e6..d8f70cb 100644
--- a/gate_api/models/mock_spot_order.py
+++ b/gate_api/models/mock_spot_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -73,7 +73,7 @@ def __init__(self, currency_pairs=None, order_price=None, count=None, left=None,
def currency_pairs(self):
"""Gets the currency_pairs of this MockSpotOrder. # noqa: E501
- Currency pair # noqa: E501
+ Market # noqa: E501
:return: The currency_pairs of this MockSpotOrder. # noqa: E501
:rtype: str
@@ -84,7 +84,7 @@ def currency_pairs(self):
def currency_pairs(self, currency_pairs):
"""Sets the currency_pairs of this MockSpotOrder.
- Currency pair # noqa: E501
+ Market # noqa: E501
:param currency_pairs: The currency_pairs of this MockSpotOrder. # noqa: E501
:type: str
@@ -123,7 +123,7 @@ def order_price(self, order_price):
def count(self):
"""Gets the count of this MockSpotOrder. # noqa: E501
- Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. # noqa: E501
+ Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports BTC and ETH Currently only supports three currencies: BTC, ETH # noqa: E501
:return: The count of this MockSpotOrder. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def count(self):
def count(self, count):
"""Sets the count of this MockSpotOrder.
- Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. # noqa: E501
+ Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports BTC and ETH Currently only supports three currencies: BTC, ETH # noqa: E501
:param count: The count of this MockSpotOrder. # noqa: E501
:type: str
@@ -146,7 +146,7 @@ def count(self, count):
def left(self):
"""Gets the left of this MockSpotOrder. # noqa: E501
- Unfilled quantity, involved in actual calculation. # noqa: E501
+ Unfilled quantity, involved in actual calculation # noqa: E501
:return: The left of this MockSpotOrder. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def left(self):
def left(self, left):
"""Sets the left of this MockSpotOrder.
- Unfilled quantity, involved in actual calculation. # noqa: E501
+ Unfilled quantity, involved in actual calculation # noqa: E501
:param left: The left of this MockSpotOrder. # noqa: E501
:type: str
@@ -171,7 +171,7 @@ def left(self, left):
def type(self):
"""Gets the type of this MockSpotOrder. # noqa: E501
- Order type, sell - sell order, buy - buy order. # noqa: E501
+ Order type, sell - sell order, buy - buy order # noqa: E501
:return: The type of this MockSpotOrder. # noqa: E501
:rtype: str
@@ -182,7 +182,7 @@ def type(self):
def type(self, type):
"""Sets the type of this MockSpotOrder.
- Order type, sell - sell order, buy - buy order. # noqa: E501
+ Order type, sell - sell order, buy - buy order # noqa: E501
:param type: The type of this MockSpotOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/multi_chain_address_item.py b/gate_api/models/multi_chain_address_item.py
index b8731b1..a18243c 100644
--- a/gate_api/models/multi_chain_address_item.py
+++ b/gate_api/models/multi_chain_address_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/multi_collateral_currency.py b/gate_api/models/multi_collateral_currency.py
index a350a96..95e5482 100644
--- a/gate_api/models/multi_collateral_currency.py
+++ b/gate_api/models/multi_collateral_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/multi_collateral_item.py b/gate_api/models/multi_collateral_item.py
index ddc6772..82cd1e4 100644
--- a/gate_api/models/multi_collateral_item.py
+++ b/gate_api/models/multi_collateral_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/multi_collateral_order.py b/gate_api/models/multi_collateral_order.py
index 514007b..24365fa 100644
--- a/gate_api/models/multi_collateral_order.py
+++ b/gate_api/models/multi_collateral_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -168,7 +168,7 @@ def order_type(self, order_type):
def fixed_type(self):
"""Gets the fixed_type of this MultiCollateralOrder. # noqa: E501
- Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days. # noqa: E501
+ Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days # noqa: E501
:return: The fixed_type of this MultiCollateralOrder. # noqa: E501
:rtype: str
@@ -179,7 +179,7 @@ def fixed_type(self):
def fixed_type(self, fixed_type):
"""Sets the fixed_type of this MultiCollateralOrder.
- Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days. # noqa: E501
+ Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days # noqa: E501
:param fixed_type: The fixed_type of this MultiCollateralOrder. # noqa: E501
:type: str
@@ -214,7 +214,7 @@ def fixed_rate(self, fixed_rate):
def expire_time(self):
"""Gets the expire_time of this MultiCollateralOrder. # noqa: E501
- Expiration time, timestamp, unit in seconds. # noqa: E501
+ Expiration time, timestamp, unit in seconds # noqa: E501
:return: The expire_time of this MultiCollateralOrder. # noqa: E501
:rtype: int
@@ -225,7 +225,7 @@ def expire_time(self):
def expire_time(self, expire_time):
"""Sets the expire_time of this MultiCollateralOrder.
- Expiration time, timestamp, unit in seconds. # noqa: E501
+ Expiration time, timestamp, unit in seconds # noqa: E501
:param expire_time: The expire_time of this MultiCollateralOrder. # noqa: E501
:type: int
@@ -237,7 +237,7 @@ def expire_time(self, expire_time):
def auto_renew(self):
"""Gets the auto_renew of this MultiCollateralOrder. # noqa: E501
- Fixed interest rate, automatic renewal # noqa: E501
+ Fixed interest rate, auto-renewal # noqa: E501
:return: The auto_renew of this MultiCollateralOrder. # noqa: E501
:rtype: bool
@@ -248,7 +248,7 @@ def auto_renew(self):
def auto_renew(self, auto_renew):
"""Sets the auto_renew of this MultiCollateralOrder.
- Fixed interest rate, automatic renewal # noqa: E501
+ Fixed interest rate, auto-renewal # noqa: E501
:param auto_renew: The auto_renew of this MultiCollateralOrder. # noqa: E501
:type: bool
@@ -260,7 +260,7 @@ def auto_renew(self, auto_renew):
def auto_repay(self):
"""Gets the auto_repay of this MultiCollateralOrder. # noqa: E501
- Fixed interest rate, automatic repayment # noqa: E501
+ Fixed interest rate, auto-repayment # noqa: E501
:return: The auto_repay of this MultiCollateralOrder. # noqa: E501
:rtype: bool
@@ -271,7 +271,7 @@ def auto_repay(self):
def auto_repay(self, auto_repay):
"""Sets the auto_repay of this MultiCollateralOrder.
- Fixed interest rate, automatic repayment # noqa: E501
+ Fixed interest rate, auto-repayment # noqa: E501
:param auto_repay: The auto_repay of this MultiCollateralOrder. # noqa: E501
:type: bool
@@ -283,7 +283,7 @@ def auto_repay(self, auto_repay):
def current_ltv(self):
"""Gets the current_ltv of this MultiCollateralOrder. # noqa: E501
- The current collateralization rate # noqa: E501
+ Current collateralization rate # noqa: E501
:return: The current_ltv of this MultiCollateralOrder. # noqa: E501
:rtype: str
@@ -294,7 +294,7 @@ def current_ltv(self):
def current_ltv(self, current_ltv):
"""Sets the current_ltv of this MultiCollateralOrder.
- The current collateralization rate # noqa: E501
+ Current collateralization rate # noqa: E501
:param current_ltv: The current_ltv of this MultiCollateralOrder. # noqa: E501
:type: str
@@ -352,7 +352,7 @@ def borrow_time(self, borrow_time):
def total_left_repay_usdt(self):
"""Gets the total_left_repay_usdt of this MultiCollateralOrder. # noqa: E501
- Value of Left repay amount converted in USDT # noqa: E501
+ Total outstanding value converted to USDT # noqa: E501
:return: The total_left_repay_usdt of this MultiCollateralOrder. # noqa: E501
:rtype: str
@@ -363,7 +363,7 @@ def total_left_repay_usdt(self):
def total_left_repay_usdt(self, total_left_repay_usdt):
"""Sets the total_left_repay_usdt of this MultiCollateralOrder.
- Value of Left repay amount converted in USDT # noqa: E501
+ Total outstanding value converted to USDT # noqa: E501
:param total_left_repay_usdt: The total_left_repay_usdt of this MultiCollateralOrder. # noqa: E501
:type: str
@@ -375,7 +375,7 @@ def total_left_repay_usdt(self, total_left_repay_usdt):
def total_left_collateral_usdt(self):
"""Gets the total_left_collateral_usdt of this MultiCollateralOrder. # noqa: E501
- Value of Collateral amount in USDT # noqa: E501
+ Total collateral value converted to USDT # noqa: E501
:return: The total_left_collateral_usdt of this MultiCollateralOrder. # noqa: E501
:rtype: str
@@ -386,7 +386,7 @@ def total_left_collateral_usdt(self):
def total_left_collateral_usdt(self, total_left_collateral_usdt):
"""Sets the total_left_collateral_usdt of this MultiCollateralOrder.
- Value of Collateral amount in USDT # noqa: E501
+ Total collateral value converted to USDT # noqa: E501
:param total_left_collateral_usdt: The total_left_collateral_usdt of this MultiCollateralOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/multi_collateral_record.py b/gate_api/models/multi_collateral_record.py
index e9f621d..a4bb4a3 100644
--- a/gate_api/models/multi_collateral_record.py
+++ b/gate_api/models/multi_collateral_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -133,7 +133,7 @@ def record_id(self, record_id):
def before_ltv(self):
"""Gets the before_ltv of this MultiCollateralRecord. # noqa: E501
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:return: The before_ltv of this MultiCollateralRecord. # noqa: E501
:rtype: str
@@ -144,7 +144,7 @@ def before_ltv(self):
def before_ltv(self, before_ltv):
"""Sets the before_ltv of this MultiCollateralRecord.
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:param before_ltv: The before_ltv of this MultiCollateralRecord. # noqa: E501
:type: str
@@ -156,7 +156,7 @@ def before_ltv(self, before_ltv):
def after_ltv(self):
"""Gets the after_ltv of this MultiCollateralRecord. # noqa: E501
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:return: The after_ltv of this MultiCollateralRecord. # noqa: E501
:rtype: str
@@ -167,7 +167,7 @@ def after_ltv(self):
def after_ltv(self, after_ltv):
"""Sets the after_ltv of this MultiCollateralRecord.
- The collateral ratio before adjustment # noqa: E501
+ Collateral ratio before adjustment # noqa: E501
:param after_ltv: The after_ltv of this MultiCollateralRecord. # noqa: E501
:type: str
@@ -179,7 +179,7 @@ def after_ltv(self, after_ltv):
def operate_time(self):
"""Gets the operate_time of this MultiCollateralRecord. # noqa: E501
- Operation time, timestamp in seconds. # noqa: E501
+ Operation time, timestamp in seconds # noqa: E501
:return: The operate_time of this MultiCollateralRecord. # noqa: E501
:rtype: int
@@ -190,7 +190,7 @@ def operate_time(self):
def operate_time(self, operate_time):
"""Sets the operate_time of this MultiCollateralRecord.
- Operation time, timestamp in seconds. # noqa: E501
+ Operation time, timestamp in seconds # noqa: E501
:param operate_time: The operate_time of this MultiCollateralRecord. # noqa: E501
:type: int
diff --git a/gate_api/models/multi_collateral_record_currency.py b/gate_api/models/multi_collateral_record_currency.py
index 40ac61e..c585d49 100644
--- a/gate_api/models/multi_collateral_record_currency.py
+++ b/gate_api/models/multi_collateral_record_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -151,7 +151,7 @@ def before_amount(self, before_amount):
def before_amount_usdt(self):
"""Gets the before_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
- USDT Amount before the operation. # noqa: E501
+ USDT Amount before the operation # noqa: E501
:return: The before_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def before_amount_usdt(self):
def before_amount_usdt(self, before_amount_usdt):
"""Sets the before_amount_usdt of this MultiCollateralRecordCurrency.
- USDT Amount before the operation. # noqa: E501
+ USDT Amount before the operation # noqa: E501
:param before_amount_usdt: The before_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
:type: str
@@ -174,7 +174,7 @@ def before_amount_usdt(self, before_amount_usdt):
def after_amount(self):
"""Gets the after_amount of this MultiCollateralRecordCurrency. # noqa: E501
- Amount after the operation. # noqa: E501
+ Amount after the operation # noqa: E501
:return: The after_amount of this MultiCollateralRecordCurrency. # noqa: E501
:rtype: str
@@ -185,7 +185,7 @@ def after_amount(self):
def after_amount(self, after_amount):
"""Sets the after_amount of this MultiCollateralRecordCurrency.
- Amount after the operation. # noqa: E501
+ Amount after the operation # noqa: E501
:param after_amount: The after_amount of this MultiCollateralRecordCurrency. # noqa: E501
:type: str
@@ -197,7 +197,7 @@ def after_amount(self, after_amount):
def after_amount_usdt(self):
"""Gets the after_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
- USDT Amount after the operation. # noqa: E501
+ USDT Amount after the operation # noqa: E501
:return: The after_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
:rtype: str
@@ -208,7 +208,7 @@ def after_amount_usdt(self):
def after_amount_usdt(self, after_amount_usdt):
"""Sets the after_amount_usdt of this MultiCollateralRecordCurrency.
- USDT Amount after the operation. # noqa: E501
+ USDT Amount after the operation # noqa: E501
:param after_amount_usdt: The after_amount_usdt of this MultiCollateralRecordCurrency. # noqa: E501
:type: str
diff --git a/gate_api/models/multi_loan_item.py b/gate_api/models/multi_loan_item.py
index d237838..02c2dd5 100644
--- a/gate_api/models/multi_loan_item.py
+++ b/gate_api/models/multi_loan_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/multi_loan_repay_item.py b/gate_api/models/multi_loan_repay_item.py
index 822936b..40d09f8 100644
--- a/gate_api/models/multi_loan_repay_item.py
+++ b/gate_api/models/multi_loan_repay_item.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -60,8 +60,7 @@ def __init__(self, currency=None, amount=None, repaid_all=None, local_vars_confi
self.currency = currency
if amount is not None:
self.amount = amount
- if repaid_all is not None:
- self.repaid_all = repaid_all
+ self.repaid_all = repaid_all
@property
def currency(self):
@@ -113,7 +112,7 @@ def amount(self, amount):
def repaid_all(self):
"""Gets the repaid_all of this MultiLoanRepayItem. # noqa: E501
- Repayment method, set to true for full repayment, false for partial repayment. # noqa: E501
+ Repayment method, set to true for full repayment, false for partial repayment # noqa: E501
:return: The repaid_all of this MultiLoanRepayItem. # noqa: E501
:rtype: bool
@@ -124,11 +123,13 @@ def repaid_all(self):
def repaid_all(self, repaid_all):
"""Sets the repaid_all of this MultiLoanRepayItem.
- Repayment method, set to true for full repayment, false for partial repayment. # noqa: E501
+ Repayment method, set to true for full repayment, false for partial repayment # noqa: E501
:param repaid_all: The repaid_all of this MultiLoanRepayItem. # noqa: E501
:type: bool
"""
+ if self.local_vars_configuration.client_side_validation and repaid_all is None: # noqa: E501
+ raise ValueError("Invalid value for `repaid_all`, must not be `None`") # noqa: E501
self._repaid_all = repaid_all
diff --git a/gate_api/models/multi_repay_record.py b/gate_api/models/multi_repay_record.py
index 9684714..82e18fc 100644
--- a/gate_api/models/multi_repay_record.py
+++ b/gate_api/models/multi_repay_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -158,7 +158,7 @@ def record_id(self, record_id):
def init_ltv(self):
"""Gets the init_ltv of this MultiRepayRecord. # noqa: E501
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:return: The init_ltv of this MultiRepayRecord. # noqa: E501
:rtype: str
@@ -169,7 +169,7 @@ def init_ltv(self):
def init_ltv(self, init_ltv):
"""Sets the init_ltv of this MultiRepayRecord.
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:param init_ltv: The init_ltv of this MultiRepayRecord. # noqa: E501
:type: str
@@ -227,7 +227,7 @@ def after_ltv(self, after_ltv):
def borrow_time(self):
"""Gets the borrow_time of this MultiRepayRecord. # noqa: E501
- Borrowing time, timestamp in seconds. # noqa: E501
+ Borrowing time, timestamp in seconds # noqa: E501
:return: The borrow_time of this MultiRepayRecord. # noqa: E501
:rtype: int
@@ -238,7 +238,7 @@ def borrow_time(self):
def borrow_time(self, borrow_time):
"""Sets the borrow_time of this MultiRepayRecord.
- Borrowing time, timestamp in seconds. # noqa: E501
+ Borrowing time, timestamp in seconds # noqa: E501
:param borrow_time: The borrow_time of this MultiRepayRecord. # noqa: E501
:type: int
@@ -250,7 +250,7 @@ def borrow_time(self, borrow_time):
def repay_time(self):
"""Gets the repay_time of this MultiRepayRecord. # noqa: E501
- Repayment time, timestamp in seconds. # noqa: E501
+ Repayment time, timestamp in seconds # noqa: E501
:return: The repay_time of this MultiRepayRecord. # noqa: E501
:rtype: int
@@ -261,7 +261,7 @@ def repay_time(self):
def repay_time(self, repay_time):
"""Sets the repay_time of this MultiRepayRecord.
- Repayment time, timestamp in seconds. # noqa: E501
+ Repayment time, timestamp in seconds # noqa: E501
:param repay_time: The repay_time of this MultiRepayRecord. # noqa: E501
:type: int
@@ -365,7 +365,7 @@ def total_interest_list(self, total_interest_list):
def left_repay_interest_list(self):
"""Gets the left_repay_interest_list of this MultiRepayRecord. # noqa: E501
- List of left repay interest # noqa: E501
+ List of remaining interest to be repaid # noqa: E501
:return: The left_repay_interest_list of this MultiRepayRecord. # noqa: E501
:rtype: list[RepayRecordLeftInterest]
@@ -376,7 +376,7 @@ def left_repay_interest_list(self):
def left_repay_interest_list(self, left_repay_interest_list):
"""Sets the left_repay_interest_list of this MultiRepayRecord.
- List of left repay interest # noqa: E501
+ List of remaining interest to be repaid # noqa: E501
:param left_repay_interest_list: The left_repay_interest_list of this MultiRepayRecord. # noqa: E501
:type: list[RepayRecordLeftInterest]
diff --git a/gate_api/models/multi_repay_resp.py b/gate_api/models/multi_repay_resp.py
index 75586d8..bb2f880 100644
--- a/gate_api/models/multi_repay_resp.py
+++ b/gate_api/models/multi_repay_resp.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/my_futures_trade.py b/gate_api/models/my_futures_trade.py
index 311039b..4066f32 100644
--- a/gate_api/models/my_futures_trade.py
+++ b/gate_api/models/my_futures_trade.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -107,7 +107,7 @@ def __init__(self, id=None, create_time=None, contract=None, order_id=None, size
def id(self):
"""Gets the id of this MyFuturesTrade. # noqa: E501
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:return: The id of this MyFuturesTrade. # noqa: E501
:rtype: int
@@ -118,7 +118,7 @@ def id(self):
def id(self, id):
"""Sets the id of this MyFuturesTrade.
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:param id: The id of this MyFuturesTrade. # noqa: E501
:type: int
@@ -130,7 +130,7 @@ def id(self, id):
def create_time(self):
"""Gets the create_time of this MyFuturesTrade. # noqa: E501
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:return: The create_time of this MyFuturesTrade. # noqa: E501
:rtype: float
@@ -141,7 +141,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this MyFuturesTrade.
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:param create_time: The create_time of this MyFuturesTrade. # noqa: E501
:type: float
@@ -176,7 +176,7 @@ def contract(self, contract):
def order_id(self):
"""Gets the order_id of this MyFuturesTrade. # noqa: E501
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:return: The order_id of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -187,7 +187,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this MyFuturesTrade.
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:param order_id: The order_id of this MyFuturesTrade. # noqa: E501
:type: str
@@ -222,7 +222,7 @@ def size(self, size):
def close_size(self):
"""Gets the close_size of this MyFuturesTrade. # noqa: E501
- Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
+ Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
:return: The close_size of this MyFuturesTrade. # noqa: E501
:rtype: int
@@ -233,7 +233,7 @@ def close_size(self):
def close_size(self, close_size):
"""Sets the close_size of this MyFuturesTrade.
- Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
+ Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
:param close_size: The close_size of this MyFuturesTrade. # noqa: E501
:type: int
@@ -245,7 +245,7 @@ def close_size(self, close_size):
def price(self):
"""Gets the price of this MyFuturesTrade. # noqa: E501
- Trading price # noqa: E501
+ Fill Price # noqa: E501
:return: The price of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -256,7 +256,7 @@ def price(self):
def price(self, price):
"""Sets the price of this MyFuturesTrade.
- Trading price # noqa: E501
+ Fill Price # noqa: E501
:param price: The price of this MyFuturesTrade. # noqa: E501
:type: str
@@ -268,7 +268,7 @@ def price(self, price):
def role(self):
"""Gets the role of this MyFuturesTrade. # noqa: E501
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:return: The role of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -279,7 +279,7 @@ def role(self):
def role(self, role):
"""Sets the role of this MyFuturesTrade.
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:param role: The role of this MyFuturesTrade. # noqa: E501
:type: str
@@ -297,7 +297,7 @@ def role(self, role):
def text(self):
"""Gets the text of this MyFuturesTrade. # noqa: E501
- User defined information # noqa: E501
+ Order custom information # noqa: E501
:return: The text of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -308,7 +308,7 @@ def text(self):
def text(self, text):
"""Sets the text of this MyFuturesTrade.
- User defined information # noqa: E501
+ Order custom information # noqa: E501
:param text: The text of this MyFuturesTrade. # noqa: E501
:type: str
@@ -320,7 +320,7 @@ def text(self, text):
def fee(self):
"""Gets the fee of this MyFuturesTrade. # noqa: E501
- Fee deducted # noqa: E501
+ Trade fee # noqa: E501
:return: The fee of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -331,7 +331,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this MyFuturesTrade.
- Fee deducted # noqa: E501
+ Trade fee # noqa: E501
:param fee: The fee of this MyFuturesTrade. # noqa: E501
:type: str
@@ -343,7 +343,7 @@ def fee(self, fee):
def point_fee(self):
"""Gets the point_fee of this MyFuturesTrade. # noqa: E501
- Points used to deduct fee # noqa: E501
+ Points used to deduct trade fee # noqa: E501
:return: The point_fee of this MyFuturesTrade. # noqa: E501
:rtype: str
@@ -354,7 +354,7 @@ def point_fee(self):
def point_fee(self, point_fee):
"""Sets the point_fee of this MyFuturesTrade.
- Points used to deduct fee # noqa: E501
+ Points used to deduct trade fee # noqa: E501
:param point_fee: The point_fee of this MyFuturesTrade. # noqa: E501
:type: str
diff --git a/gate_api/models/my_futures_trade_time_range.py b/gate_api/models/my_futures_trade_time_range.py
index 58b5d4b..81e915b 100644
--- a/gate_api/models/my_futures_trade_time_range.py
+++ b/gate_api/models/my_futures_trade_time_range.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -107,7 +107,7 @@ def __init__(self, trade_id=None, create_time=None, contract=None, order_id=None
def trade_id(self):
"""Gets the trade_id of this MyFuturesTradeTimeRange. # noqa: E501
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:return: The trade_id of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -118,7 +118,7 @@ def trade_id(self):
def trade_id(self, trade_id):
"""Sets the trade_id of this MyFuturesTradeTimeRange.
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:param trade_id: The trade_id of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -130,7 +130,7 @@ def trade_id(self, trade_id):
def create_time(self):
"""Gets the create_time of this MyFuturesTradeTimeRange. # noqa: E501
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:return: The create_time of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: float
@@ -141,7 +141,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this MyFuturesTradeTimeRange.
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:param create_time: The create_time of this MyFuturesTradeTimeRange. # noqa: E501
:type: float
@@ -176,7 +176,7 @@ def contract(self, contract):
def order_id(self):
"""Gets the order_id of this MyFuturesTradeTimeRange. # noqa: E501
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:return: The order_id of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -187,7 +187,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this MyFuturesTradeTimeRange.
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:param order_id: The order_id of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -222,7 +222,7 @@ def size(self, size):
def close_size(self):
"""Gets the close_size of this MyFuturesTradeTimeRange. # noqa: E501
- Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
+ Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
:return: The close_size of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: int
@@ -233,7 +233,7 @@ def close_size(self):
def close_size(self, close_size):
"""Sets the close_size of this MyFuturesTradeTimeRange.
- Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
+ Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short position close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long position close_size<0 && size<0 && size < close_size Close long position and open short position # noqa: E501
:param close_size: The close_size of this MyFuturesTradeTimeRange. # noqa: E501
:type: int
@@ -245,7 +245,7 @@ def close_size(self, close_size):
def price(self):
"""Gets the price of this MyFuturesTradeTimeRange. # noqa: E501
- Trading price # noqa: E501
+ Fill Price # noqa: E501
:return: The price of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -256,7 +256,7 @@ def price(self):
def price(self, price):
"""Sets the price of this MyFuturesTradeTimeRange.
- Trading price # noqa: E501
+ Fill Price # noqa: E501
:param price: The price of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -268,7 +268,7 @@ def price(self, price):
def role(self):
"""Gets the role of this MyFuturesTradeTimeRange. # noqa: E501
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:return: The role of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -279,7 +279,7 @@ def role(self):
def role(self, role):
"""Sets the role of this MyFuturesTradeTimeRange.
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:param role: The role of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -297,7 +297,7 @@ def role(self, role):
def text(self):
"""Gets the text of this MyFuturesTradeTimeRange. # noqa: E501
- User defined information # noqa: E501
+ Order custom information # noqa: E501
:return: The text of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -308,7 +308,7 @@ def text(self):
def text(self, text):
"""Sets the text of this MyFuturesTradeTimeRange.
- User defined information # noqa: E501
+ Order custom information # noqa: E501
:param text: The text of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -320,7 +320,7 @@ def text(self, text):
def fee(self):
"""Gets the fee of this MyFuturesTradeTimeRange. # noqa: E501
- Fee deducted # noqa: E501
+ Trade fee # noqa: E501
:return: The fee of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -331,7 +331,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this MyFuturesTradeTimeRange.
- Fee deducted # noqa: E501
+ Trade fee # noqa: E501
:param fee: The fee of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
@@ -343,7 +343,7 @@ def fee(self, fee):
def point_fee(self):
"""Gets the point_fee of this MyFuturesTradeTimeRange. # noqa: E501
- Points used to deduct fee # noqa: E501
+ Points used to deduct trade fee # noqa: E501
:return: The point_fee of this MyFuturesTradeTimeRange. # noqa: E501
:rtype: str
@@ -354,7 +354,7 @@ def point_fee(self):
def point_fee(self, point_fee):
"""Sets the point_fee of this MyFuturesTradeTimeRange.
- Points used to deduct fee # noqa: E501
+ Points used to deduct trade fee # noqa: E501
:param point_fee: The point_fee of this MyFuturesTradeTimeRange. # noqa: E501
:type: str
diff --git a/gate_api/models/open_orders.py b/gate_api/models/open_orders.py
index 2b5d58c..4d856f3 100644
--- a/gate_api/models/open_orders.py
+++ b/gate_api/models/open_orders.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def currency_pair(self, currency_pair):
def total(self):
"""Gets the total of this OpenOrders. # noqa: E501
- The total number of pending orders for this trading pair on the current page # noqa: E501
+ Total number of open orders for this trading pair on the current page # noqa: E501
:return: The total of this OpenOrders. # noqa: E501
:rtype: int
@@ -101,7 +101,7 @@ def total(self):
def total(self, total):
"""Sets the total of this OpenOrders.
- The total number of pending orders for this trading pair on the current page # noqa: E501
+ Total number of open orders for this trading pair on the current page # noqa: E501
:param total: The total of this OpenOrders. # noqa: E501
:type: int
diff --git a/gate_api/models/options_account.py b/gate_api/models/options_account.py
index e721370..e05a45c 100644
--- a/gate_api/models/options_account.py
+++ b/gate_api/models/options_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -170,7 +170,7 @@ def user(self, user):
def total(self):
"""Gets the total of this OptionsAccount. # noqa: E501
- 账户余额 # noqa: E501
+ Account Balance # noqa: E501
:return: The total of this OptionsAccount. # noqa: E501
:rtype: str
@@ -181,7 +181,7 @@ def total(self):
def total(self, total):
"""Sets the total of this OptionsAccount.
- 账户余额 # noqa: E501
+ Account Balance # noqa: E501
:param total: The total of this OptionsAccount. # noqa: E501
:type: str
@@ -193,7 +193,7 @@ def total(self, total):
def position_value(self):
"""Gets the position_value of this OptionsAccount. # noqa: E501
- 仓位价值，做多仓位价值为正，做空仓位价值为负 # noqa: E501
+ Position value, long position value is positive, short position value is negative # noqa: E501
:return: The position_value of this OptionsAccount. # noqa: E501
:rtype: str
@@ -204,7 +204,7 @@ def position_value(self):
def position_value(self, position_value):
"""Sets the position_value of this OptionsAccount.
- 仓位价值，做多仓位价值为正，做空仓位价值为负 # noqa: E501
+ Position value, long position value is positive, short position value is negative # noqa: E501
:param position_value: The position_value of this OptionsAccount. # noqa: E501
:type: str
@@ -216,7 +216,7 @@ def position_value(self, position_value):
def equity(self):
"""Gets the equity of this OptionsAccount. # noqa: E501
- 账户权益，账户余额与仓位价值的和 # noqa: E501
+ Account equity, the sum of account balance and position value # noqa: E501
:return: The equity of this OptionsAccount. # noqa: E501
:rtype: str
@@ -227,7 +227,7 @@ def equity(self):
def equity(self, equity):
"""Sets the equity of this OptionsAccount.
- 账户权益，账户余额与仓位价值的和 # noqa: E501
+ Account equity, the sum of account balance and position value # noqa: E501
:param equity: The equity of this OptionsAccount. # noqa: E501
:type: str
@@ -262,7 +262,7 @@ def short_enabled(self, short_enabled):
def mmp_enabled(self):
"""Gets the mmp_enabled of this OptionsAccount. # noqa: E501
- 是否启用MMP # noqa: E501
+ Whether to enable MMP # noqa: E501
:return: The mmp_enabled of this OptionsAccount. # noqa: E501
:rtype: bool
@@ -273,7 +273,7 @@ def mmp_enabled(self):
def mmp_enabled(self, mmp_enabled):
"""Sets the mmp_enabled of this OptionsAccount.
- 是否启用MMP # noqa: E501
+ Whether to enable MMP # noqa: E501
:param mmp_enabled: The mmp_enabled of this OptionsAccount. # noqa: E501
:type: bool
@@ -285,7 +285,7 @@ def mmp_enabled(self, mmp_enabled):
def liq_triggered(self):
"""Gets the liq_triggered of this OptionsAccount. # noqa: E501
- 是否触发仓位强平 # noqa: E501
+ Whether to trigger position liquidation # noqa: E501
:return: The liq_triggered of this OptionsAccount. # noqa: E501
:rtype: bool
@@ -296,7 +296,7 @@ def liq_triggered(self):
def liq_triggered(self, liq_triggered):
"""Sets the liq_triggered of this OptionsAccount.
- 是否触发仓位强平 # noqa: E501
+ Whether to trigger position liquidation # noqa: E501
:param liq_triggered: The liq_triggered of this OptionsAccount. # noqa: E501
:type: bool
@@ -429,7 +429,7 @@ def order_margin(self, order_margin):
def ask_order_margin(self):
"""Gets the ask_order_margin of this OptionsAccount. # noqa: E501
- 未完成卖单的保证金 # noqa: E501
+ Margin for outstanding sell orders # noqa: E501
:return: The ask_order_margin of this OptionsAccount. # noqa: E501
:rtype: str
@@ -440,7 +440,7 @@ def ask_order_margin(self):
def ask_order_margin(self, ask_order_margin):
"""Sets the ask_order_margin of this OptionsAccount.
- 未完成卖单的保证金 # noqa: E501
+ Margin for outstanding sell orders # noqa: E501
:param ask_order_margin: The ask_order_margin of this OptionsAccount. # noqa: E501
:type: str
@@ -452,7 +452,7 @@ def ask_order_margin(self, ask_order_margin):
def bid_order_margin(self):
"""Gets the bid_order_margin of this OptionsAccount. # noqa: E501
- 未完成买单的保证金 # noqa: E501
+ Margin for outstanding buy orders # noqa: E501
:return: The bid_order_margin of this OptionsAccount. # noqa: E501
:rtype: str
@@ -463,7 +463,7 @@ def bid_order_margin(self):
def bid_order_margin(self, bid_order_margin):
"""Sets the bid_order_margin of this OptionsAccount.
- 未完成买单的保证金 # noqa: E501
+ Margin for outstanding buy orders # noqa: E501
:param bid_order_margin: The bid_order_margin of this OptionsAccount. # noqa: E501
:type: str
@@ -498,7 +498,7 @@ def available(self, available):
def point(self):
"""Gets the point of this OptionsAccount. # noqa: E501
- POINT amount # noqa: E501
+ Point card amount # noqa: E501
:return: The point of this OptionsAccount. # noqa: E501
:rtype: str
@@ -509,7 +509,7 @@ def point(self):
def point(self, point):
"""Sets the point of this OptionsAccount.
- POINT amount # noqa: E501
+ Point card amount # noqa: E501
:param point: The point of this OptionsAccount. # noqa: E501
:type: str
@@ -521,7 +521,7 @@ def point(self, point):
def currency(self):
"""Gets the currency of this OptionsAccount. # noqa: E501
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:return: The currency of this OptionsAccount. # noqa: E501
:rtype: str
@@ -532,7 +532,7 @@ def currency(self):
def currency(self, currency):
"""Sets the currency of this OptionsAccount.
- Settle currency # noqa: E501
+ Settlement currency # noqa: E501
:param currency: The currency of this OptionsAccount. # noqa: E501
:type: str
@@ -544,7 +544,7 @@ def currency(self, currency):
def orders_limit(self):
"""Gets the orders_limit of this OptionsAccount. # noqa: E501
- 未完成订单数量上限 # noqa: E501
+ Maximum number of outstanding orders # noqa: E501
:return: The orders_limit of this OptionsAccount. # noqa: E501
:rtype: int
@@ -555,7 +555,7 @@ def orders_limit(self):
def orders_limit(self, orders_limit):
"""Sets the orders_limit of this OptionsAccount.
- 未完成订单数量上限 # noqa: E501
+ Maximum number of outstanding orders # noqa: E501
:param orders_limit: The orders_limit of this OptionsAccount. # noqa: E501
:type: int
@@ -567,7 +567,7 @@ def orders_limit(self, orders_limit):
def position_notional_limit(self):
"""Gets the position_notional_limit of this OptionsAccount. # noqa: E501
- 名义价值上限，包含仓位以及未完成订单的名义价值 # noqa: E501
+ Notional value upper limit, including the nominal value of positions and outstanding orders # noqa: E501
:return: The position_notional_limit of this OptionsAccount. # noqa: E501
:rtype: int
@@ -578,7 +578,7 @@ def position_notional_limit(self):
def position_notional_limit(self, position_notional_limit):
"""Sets the position_notional_limit of this OptionsAccount.
- 名义价值上限，包含仓位以及未完成订单的名义价值 # noqa: E501
+ Notional value upper limit, including the nominal value of positions and outstanding orders # noqa: E501
:param position_notional_limit: The position_notional_limit of this OptionsAccount. # noqa: E501
:type: int
diff --git a/gate_api/models/options_account_book.py b/gate_api/models/options_account_book.py
index e843486..e2809e2 100644
--- a/gate_api/models/options_account_book.py
+++ b/gate_api/models/options_account_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -146,7 +146,7 @@ def balance(self, balance):
def type(self):
"""Gets the type of this OptionsAccountBook. # noqa: E501
- Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate # noqa: E501
+ Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate # noqa: E501
:return: The type of this OptionsAccountBook. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def type(self):
def type(self, type):
"""Sets the type of this OptionsAccountBook.
- Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate # noqa: E501
+ Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate # noqa: E501
:param type: The type of this OptionsAccountBook. # noqa: E501
:type: str
@@ -169,7 +169,7 @@ def type(self, type):
def text(self):
"""Gets the text of this OptionsAccountBook. # noqa: E501
- custom text # noqa: E501
+ Remark # noqa: E501
:return: The text of this OptionsAccountBook. # noqa: E501
:rtype: str
@@ -180,7 +180,7 @@ def text(self):
def text(self, text):
"""Sets the text of this OptionsAccountBook.
- custom text # noqa: E501
+ Remark # noqa: E501
:param text: The text of this OptionsAccountBook. # noqa: E501
:type: str
diff --git a/gate_api/models/options_candlestick.py b/gate_api/models/options_candlestick.py
index 6a42d98..a41ffe9 100644
--- a/gate_api/models/options_candlestick.py
+++ b/gate_api/models/options_candlestick.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/options_contract.py b/gate_api/models/options_contract.py
index 7338171..2aec77e 100644
--- a/gate_api/models/options_contract.py
+++ b/gate_api/models/options_contract.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -200,7 +200,7 @@ def name(self, name):
def tag(self):
"""Gets the tag of this OptionsContract. # noqa: E501
- tag # noqa: E501
+ Tag # noqa: E501
:return: The tag of this OptionsContract. # noqa: E501
:rtype: str
@@ -211,7 +211,7 @@ def tag(self):
def tag(self, tag):
"""Sets the tag of this OptionsContract.
- tag # noqa: E501
+ Tag # noqa: E501
:param tag: The tag of this OptionsContract. # noqa: E501
:type: str
@@ -223,7 +223,7 @@ def tag(self, tag):
def create_time(self):
"""Gets the create_time of this OptionsContract. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this OptionsContract. # noqa: E501
:rtype: float
@@ -234,7 +234,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this OptionsContract.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this OptionsContract. # noqa: E501
:type: float
@@ -269,7 +269,7 @@ def expiration_time(self, expiration_time):
def is_call(self):
"""Gets the is_call of this OptionsContract. # noqa: E501
- `true` means call options, while `false` is put options # noqa: E501
+ `true` means call options, `false` means put options # noqa: E501
:return: The is_call of this OptionsContract. # noqa: E501
:rtype: bool
@@ -280,7 +280,7 @@ def is_call(self):
def is_call(self, is_call):
"""Sets the is_call of this OptionsContract.
- `true` means call options, while `false` is put options # noqa: E501
+ `true` means call options, `false` means put options # noqa: E501
:param is_call: The is_call of this OptionsContract. # noqa: E501
:type: bool
@@ -430,7 +430,7 @@ def index_price(self, index_price):
def maker_fee_rate(self):
"""Gets the maker_fee_rate of this OptionsContract. # noqa: E501
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:return: The maker_fee_rate of this OptionsContract. # noqa: E501
:rtype: str
@@ -441,7 +441,7 @@ def maker_fee_rate(self):
def maker_fee_rate(self, maker_fee_rate):
"""Sets the maker_fee_rate of this OptionsContract.
- Maker fee rate, where negative means rebate # noqa: E501
+ Maker fee rate, negative values indicate rebates # noqa: E501
:param maker_fee_rate: The maker_fee_rate of this OptionsContract. # noqa: E501
:type: str
@@ -522,7 +522,7 @@ def mark_price_round(self, mark_price_round):
def order_size_min(self):
"""Gets the order_size_min of this OptionsContract. # noqa: E501
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:return: The order_size_min of this OptionsContract. # noqa: E501
:rtype: int
@@ -533,7 +533,7 @@ def order_size_min(self):
def order_size_min(self, order_size_min):
"""Sets the order_size_min of this OptionsContract.
- Minimum order size the contract allowed # noqa: E501
+ Minimum order size allowed by the contract # noqa: E501
:param order_size_min: The order_size_min of this OptionsContract. # noqa: E501
:type: int
@@ -545,7 +545,7 @@ def order_size_min(self, order_size_min):
def order_size_max(self):
"""Gets the order_size_max of this OptionsContract. # noqa: E501
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:return: The order_size_max of this OptionsContract. # noqa: E501
:rtype: int
@@ -556,7 +556,7 @@ def order_size_max(self):
def order_size_max(self, order_size_max):
"""Sets the order_size_max of this OptionsContract.
- Maximum order size the contract allowed # noqa: E501
+ Maximum order size allowed by the contract # noqa: E501
:param order_size_max: The order_size_max of this OptionsContract. # noqa: E501
:type: int
@@ -568,7 +568,7 @@ def order_size_max(self, order_size_max):
def order_price_deviate(self):
"""Gets the order_price_deviate of this OptionsContract. # noqa: E501
- The positive and negative offset allowed between the order price and the current mark price, that is, the order price `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders # noqa: E501
+ The positive and negative offset allowed between the order price and the current mark price, that `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders # noqa: E501
:return: The order_price_deviate of this OptionsContract. # noqa: E501
:rtype: str
@@ -579,7 +579,7 @@ def order_price_deviate(self):
def order_price_deviate(self, order_price_deviate):
"""Sets the order_price_deviate of this OptionsContract.
- The positive and negative offset allowed between the order price and the current mark price, that is, the order price `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders # noqa: E501
+ The positive and negative offset allowed between the order price and the current mark price, that `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders # noqa: E501
:param order_price_deviate: The order_price_deviate of this OptionsContract. # noqa: E501
:type: str
@@ -591,7 +591,7 @@ def order_price_deviate(self, order_price_deviate):
def ref_discount_rate(self):
"""Gets the ref_discount_rate of this OptionsContract. # noqa: E501
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:return: The ref_discount_rate of this OptionsContract. # noqa: E501
:rtype: str
@@ -602,7 +602,7 @@ def ref_discount_rate(self):
def ref_discount_rate(self, ref_discount_rate):
"""Sets the ref_discount_rate of this OptionsContract.
- Referral fee rate discount # noqa: E501
+ Trading fee discount for referred users # noqa: E501
:param ref_discount_rate: The ref_discount_rate of this OptionsContract. # noqa: E501
:type: str
@@ -614,7 +614,7 @@ def ref_discount_rate(self, ref_discount_rate):
def ref_rebate_rate(self):
"""Gets the ref_rebate_rate of this OptionsContract. # noqa: E501
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:return: The ref_rebate_rate of this OptionsContract. # noqa: E501
:rtype: str
@@ -625,7 +625,7 @@ def ref_rebate_rate(self):
def ref_rebate_rate(self, ref_rebate_rate):
"""Sets the ref_rebate_rate of this OptionsContract.
- Referrer commission rate # noqa: E501
+ Commission rate for referrers # noqa: E501
:param ref_rebate_rate: The ref_rebate_rate of this OptionsContract. # noqa: E501
:type: str
@@ -637,7 +637,7 @@ def ref_rebate_rate(self, ref_rebate_rate):
def orderbook_id(self):
"""Gets the orderbook_id of this OptionsContract. # noqa: E501
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:return: The orderbook_id of this OptionsContract. # noqa: E501
:rtype: int
@@ -648,7 +648,7 @@ def orderbook_id(self):
def orderbook_id(self, orderbook_id):
"""Sets the orderbook_id of this OptionsContract.
- Current orderbook ID # noqa: E501
+ Orderbook update ID # noqa: E501
:param orderbook_id: The orderbook_id of this OptionsContract. # noqa: E501
:type: int
@@ -683,7 +683,7 @@ def trade_id(self, trade_id):
def trade_size(self):
"""Gets the trade_size of this OptionsContract. # noqa: E501
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:return: The trade_size of this OptionsContract. # noqa: E501
:rtype: int
@@ -694,7 +694,7 @@ def trade_size(self):
def trade_size(self, trade_size):
"""Sets the trade_size of this OptionsContract.
- Historical accumulated trade size # noqa: E501
+ Historical cumulative trading volume # noqa: E501
:param trade_size: The trade_size of this OptionsContract. # noqa: E501
:type: int
@@ -729,7 +729,7 @@ def position_size(self, position_size):
def orders_limit(self):
"""Gets the orders_limit of this OptionsContract. # noqa: E501
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:return: The orders_limit of this OptionsContract. # noqa: E501
:rtype: int
@@ -740,7 +740,7 @@ def orders_limit(self):
def orders_limit(self, orders_limit):
"""Sets the orders_limit of this OptionsContract.
- Maximum number of open orders # noqa: E501
+ Maximum number of pending orders # noqa: E501
:param orders_limit: The orders_limit of this OptionsContract. # noqa: E501
:type: int
diff --git a/gate_api/models/options_mmp.py b/gate_api/models/options_mmp.py
index c4484d6..5594392 100644
--- a/gate_api/models/options_mmp.py
+++ b/gate_api/models/options_mmp.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -107,7 +107,7 @@ def underlying(self, underlying):
def window(self):
"""Gets the window of this OptionsMMP. # noqa: E501
- 时间窗口（毫秒），1-5000之间，0表示停用MMP # noqa: E501
+ Time window (milliseconds), between 1-5000, 0 means disable MMP # noqa: E501
:return: The window of this OptionsMMP. # noqa: E501
:rtype: int
@@ -118,7 +118,7 @@ def window(self):
def window(self, window):
"""Sets the window of this OptionsMMP.
- 时间窗口（毫秒），1-5000之间，0表示停用MMP # noqa: E501
+ Time window (milliseconds), between 1-5000, 0 means disable MMP # noqa: E501
:param window: The window of this OptionsMMP. # noqa: E501
:type: int
@@ -132,7 +132,7 @@ def window(self, window):
def frozen_period(self):
"""Gets the frozen_period of this OptionsMMP. # noqa: E501
- 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 # noqa: E501
+ Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze # noqa: E501
:return: The frozen_period of this OptionsMMP. # noqa: E501
:rtype: int
@@ -143,7 +143,7 @@ def frozen_period(self):
def frozen_period(self, frozen_period):
"""Sets the frozen_period of this OptionsMMP.
- 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 # noqa: E501
+ Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze # noqa: E501
:param frozen_period: The frozen_period of this OptionsMMP. # noqa: E501
:type: int
@@ -157,7 +157,7 @@ def frozen_period(self, frozen_period):
def qty_limit(self):
"""Gets the qty_limit of this OptionsMMP. # noqa: E501
- 成交量上限（正数，至多2位小数） # noqa: E501
+ Trading volume upper limit (positive number, up to 2 decimal places) # noqa: E501
:return: The qty_limit of this OptionsMMP. # noqa: E501
:rtype: str
@@ -168,7 +168,7 @@ def qty_limit(self):
def qty_limit(self, qty_limit):
"""Sets the qty_limit of this OptionsMMP.
- 成交量上限（正数，至多2位小数） # noqa: E501
+ Trading volume upper limit (positive number, up to 2 decimal places) # noqa: E501
:param qty_limit: The qty_limit of this OptionsMMP. # noqa: E501
:type: str
@@ -182,7 +182,7 @@ def qty_limit(self, qty_limit):
def delta_limit(self):
"""Gets the delta_limit of this OptionsMMP. # noqa: E501
- 净delta值上限（正数，至多2位小数） # noqa: E501
+ Upper limit of net delta value (positive number, up to 2 decimal places) # noqa: E501
:return: The delta_limit of this OptionsMMP. # noqa: E501
:rtype: str
@@ -193,7 +193,7 @@ def delta_limit(self):
def delta_limit(self, delta_limit):
"""Sets the delta_limit of this OptionsMMP.
- 净delta值上限（正数，至多2位小数） # noqa: E501
+ Upper limit of net delta value (positive number, up to 2 decimal places) # noqa: E501
:param delta_limit: The delta_limit of this OptionsMMP. # noqa: E501
:type: str
@@ -207,7 +207,7 @@ def delta_limit(self, delta_limit):
def trigger_time_ms(self):
"""Gets the trigger_time_ms of this OptionsMMP. # noqa: E501
- 触发冻结时间（毫秒），0表示没有触发冻结 # noqa: E501
+ Trigger freeze time (milliseconds), 0 means no freeze is triggered # noqa: E501
:return: The trigger_time_ms of this OptionsMMP. # noqa: E501
:rtype: int
@@ -218,7 +218,7 @@ def trigger_time_ms(self):
def trigger_time_ms(self, trigger_time_ms):
"""Sets the trigger_time_ms of this OptionsMMP.
- 触发冻结时间（毫秒），0表示没有触发冻结 # noqa: E501
+ Trigger freeze time (milliseconds), 0 means no freeze is triggered # noqa: E501
:param trigger_time_ms: The trigger_time_ms of this OptionsMMP. # noqa: E501
:type: int
@@ -230,7 +230,7 @@ def trigger_time_ms(self, trigger_time_ms):
def frozen_until_ms(self):
"""Gets the frozen_until_ms of this OptionsMMP. # noqa: E501
- 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 # noqa: E501
+ Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered # noqa: E501
:return: The frozen_until_ms of this OptionsMMP. # noqa: E501
:rtype: int
@@ -241,7 +241,7 @@ def frozen_until_ms(self):
def frozen_until_ms(self, frozen_until_ms):
"""Sets the frozen_until_ms of this OptionsMMP.
- 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 # noqa: E501
+ Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered # noqa: E501
:param frozen_until_ms: The frozen_until_ms of this OptionsMMP. # noqa: E501
:type: int
diff --git a/gate_api/models/options_mmp_reset.py b/gate_api/models/options_mmp_reset.py
index 9ddc492..78658ba 100644
--- a/gate_api/models/options_mmp_reset.py
+++ b/gate_api/models/options_mmp_reset.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -111,7 +111,7 @@ def underlying(self, underlying):
def window(self):
"""Gets the window of this OptionsMMPReset. # noqa: E501
- 时间窗口（毫秒），1-5000之间，0表示停用MMP # noqa: E501
+ Time window (milliseconds), between 1-5000, 0 means disable MMP # noqa: E501
:return: The window of this OptionsMMPReset. # noqa: E501
:rtype: int
@@ -122,7 +122,7 @@ def window(self):
def window(self, window):
"""Sets the window of this OptionsMMPReset.
- 时间窗口（毫秒），1-5000之间，0表示停用MMP # noqa: E501
+ Time window (milliseconds), between 1-5000, 0 means disable MMP # noqa: E501
:param window: The window of this OptionsMMPReset. # noqa: E501
:type: int
@@ -134,7 +134,7 @@ def window(self, window):
def frozen_period(self):
"""Gets the frozen_period of this OptionsMMPReset. # noqa: E501
- 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 # noqa: E501
+ Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze # noqa: E501
:return: The frozen_period of this OptionsMMPReset. # noqa: E501
:rtype: int
@@ -145,7 +145,7 @@ def frozen_period(self):
def frozen_period(self, frozen_period):
"""Sets the frozen_period of this OptionsMMPReset.
- 冻结时长（毫秒），0表示一直冻结，需要调用重置API解冻 # noqa: E501
+ Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze # noqa: E501
:param frozen_period: The frozen_period of this OptionsMMPReset. # noqa: E501
:type: int
@@ -157,7 +157,7 @@ def frozen_period(self, frozen_period):
def qty_limit(self):
"""Gets the qty_limit of this OptionsMMPReset. # noqa: E501
- 成交量上限（正数，至多2位小数） # noqa: E501
+ Trading volume upper limit (positive number, up to 2 decimal places) # noqa: E501
:return: The qty_limit of this OptionsMMPReset. # noqa: E501
:rtype: str
@@ -168,7 +168,7 @@ def qty_limit(self):
def qty_limit(self, qty_limit):
"""Sets the qty_limit of this OptionsMMPReset.
- 成交量上限（正数，至多2位小数） # noqa: E501
+ Trading volume upper limit (positive number, up to 2 decimal places) # noqa: E501
:param qty_limit: The qty_limit of this OptionsMMPReset. # noqa: E501
:type: str
@@ -180,7 +180,7 @@ def qty_limit(self, qty_limit):
def delta_limit(self):
"""Gets the delta_limit of this OptionsMMPReset. # noqa: E501
- 净delta值上限（正数，至多2位小数） # noqa: E501
+ Upper limit of net delta value (positive number, up to 2 decimal places) # noqa: E501
:return: The delta_limit of this OptionsMMPReset. # noqa: E501
:rtype: str
@@ -191,7 +191,7 @@ def delta_limit(self):
def delta_limit(self, delta_limit):
"""Sets the delta_limit of this OptionsMMPReset.
- 净delta值上限（正数，至多2位小数） # noqa: E501
+ Upper limit of net delta value (positive number, up to 2 decimal places) # noqa: E501
:param delta_limit: The delta_limit of this OptionsMMPReset. # noqa: E501
:type: str
@@ -203,7 +203,7 @@ def delta_limit(self, delta_limit):
def trigger_time_ms(self):
"""Gets the trigger_time_ms of this OptionsMMPReset. # noqa: E501
- 触发冻结时间（毫秒），0表示没有触发冻结 # noqa: E501
+ Trigger freeze time (milliseconds), 0 means no freeze is triggered # noqa: E501
:return: The trigger_time_ms of this OptionsMMPReset. # noqa: E501
:rtype: int
@@ -214,7 +214,7 @@ def trigger_time_ms(self):
def trigger_time_ms(self, trigger_time_ms):
"""Sets the trigger_time_ms of this OptionsMMPReset.
- 触发冻结时间（毫秒），0表示没有触发冻结 # noqa: E501
+ Trigger freeze time (milliseconds), 0 means no freeze is triggered # noqa: E501
:param trigger_time_ms: The trigger_time_ms of this OptionsMMPReset. # noqa: E501
:type: int
@@ -226,7 +226,7 @@ def trigger_time_ms(self, trigger_time_ms):
def frozen_until_ms(self):
"""Gets the frozen_until_ms of this OptionsMMPReset. # noqa: E501
- 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 # noqa: E501
+ Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered # noqa: E501
:return: The frozen_until_ms of this OptionsMMPReset. # noqa: E501
:rtype: int
@@ -237,7 +237,7 @@ def frozen_until_ms(self):
def frozen_until_ms(self, frozen_until_ms):
"""Sets the frozen_until_ms of this OptionsMMPReset.
- 解冻时间（毫秒），如果未配置冻结时长，触发冻结后无解冻时间 # noqa: E501
+ Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered # noqa: E501
:param frozen_until_ms: The frozen_until_ms of this OptionsMMPReset. # noqa: E501
:type: int
diff --git a/gate_api/models/options_my_settlements.py b/gate_api/models/options_my_settlements.py
index f1eb838..24db92e 100644
--- a/gate_api/models/options_my_settlements.py
+++ b/gate_api/models/options_my_settlements.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -212,7 +212,7 @@ def settle_price(self, settle_price):
def size(self):
"""Gets the size of this OptionsMySettlements. # noqa: E501
- Size # noqa: E501
+ Settlement size # noqa: E501
:return: The size of this OptionsMySettlements. # noqa: E501
:rtype: int
@@ -223,7 +223,7 @@ def size(self):
def size(self, size):
"""Sets the size of this OptionsMySettlements.
- Size # noqa: E501
+ Settlement size # noqa: E501
:param size: The size of this OptionsMySettlements. # noqa: E501
:type: int
@@ -258,7 +258,7 @@ def settle_profit(self, settle_profit):
def fee(self):
"""Gets the fee of this OptionsMySettlements. # noqa: E501
- Fee (quote currency) # noqa: E501
+ Settlement fee (quote currency) # noqa: E501
:return: The fee of this OptionsMySettlements. # noqa: E501
:rtype: str
@@ -269,7 +269,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this OptionsMySettlements.
- Fee (quote currency) # noqa: E501
+ Settlement fee (quote currency) # noqa: E501
:param fee: The fee of this OptionsMySettlements. # noqa: E501
:type: str
@@ -281,7 +281,7 @@ def fee(self, fee):
def realised_pnl(self):
"""Gets the realised_pnl of this OptionsMySettlements. # noqa: E501
- The accumulated profit and loss of opening a position, including premium, fee, settlement profit, etc. (quote currency) # noqa: E501
+ Accumulated profit and loss from opening positions, including premium, fees, settlement profit, etc. (quote currency) # noqa: E501
:return: The realised_pnl of this OptionsMySettlements. # noqa: E501
:rtype: str
@@ -292,7 +292,7 @@ def realised_pnl(self):
def realised_pnl(self, realised_pnl):
"""Sets the realised_pnl of this OptionsMySettlements.
- The accumulated profit and loss of opening a position, including premium, fee, settlement profit, etc. (quote currency) # noqa: E501
+ Accumulated profit and loss from opening positions, including premium, fees, settlement profit, etc. (quote currency) # noqa: E501
:param realised_pnl: The realised_pnl of this OptionsMySettlements. # noqa: E501
:type: str
diff --git a/gate_api/models/options_my_trade.py b/gate_api/models/options_my_trade.py
index 1da411f..55435f0 100644
--- a/gate_api/models/options_my_trade.py
+++ b/gate_api/models/options_my_trade.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -92,7 +92,7 @@ def __init__(self, id=None, create_time=None, contract=None, order_id=None, size
def id(self):
"""Gets the id of this OptionsMyTrade. # noqa: E501
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:return: The id of this OptionsMyTrade. # noqa: E501
:rtype: int
@@ -103,7 +103,7 @@ def id(self):
def id(self, id):
"""Sets the id of this OptionsMyTrade.
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:param id: The id of this OptionsMyTrade. # noqa: E501
:type: int
@@ -115,7 +115,7 @@ def id(self, id):
def create_time(self):
"""Gets the create_time of this OptionsMyTrade. # noqa: E501
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:return: The create_time of this OptionsMyTrade. # noqa: E501
:rtype: float
@@ -126,7 +126,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this OptionsMyTrade.
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:param create_time: The create_time of this OptionsMyTrade. # noqa: E501
:type: float
@@ -161,7 +161,7 @@ def contract(self, contract):
def order_id(self):
"""Gets the order_id of this OptionsMyTrade. # noqa: E501
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:return: The order_id of this OptionsMyTrade. # noqa: E501
:rtype: int
@@ -172,7 +172,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this OptionsMyTrade.
- Order ID related # noqa: E501
+ Related order ID # noqa: E501
:param order_id: The order_id of this OptionsMyTrade. # noqa: E501
:type: int
@@ -207,7 +207,7 @@ def size(self, size):
def price(self):
"""Gets the price of this OptionsMyTrade. # noqa: E501
- Trading price (quote currency) # noqa: E501
+ Trade price (quote currency) # noqa: E501
:return: The price of this OptionsMyTrade. # noqa: E501
:rtype: str
@@ -218,7 +218,7 @@ def price(self):
def price(self, price):
"""Sets the price of this OptionsMyTrade.
- Trading price (quote currency) # noqa: E501
+ Trade price (quote currency) # noqa: E501
:param price: The price of this OptionsMyTrade. # noqa: E501
:type: str
@@ -253,7 +253,7 @@ def underlying_price(self, underlying_price):
def role(self):
"""Gets the role of this OptionsMyTrade. # noqa: E501
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:return: The role of this OptionsMyTrade. # noqa: E501
:rtype: str
@@ -264,7 +264,7 @@ def role(self):
def role(self, role):
"""Sets the role of this OptionsMyTrade.
- Trade role. Available values are `taker` and `maker` # noqa: E501
+ Trade role. taker - taker, maker - maker # noqa: E501
:param role: The role of this OptionsMyTrade. # noqa: E501
:type: str
diff --git a/gate_api/models/options_order.py b/gate_api/models/options_order.py
index 518746d..1f28133 100644
--- a/gate_api/models/options_order.py
+++ b/gate_api/models/options_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -267,7 +267,7 @@ def finish_time(self, finish_time):
def finish_as(self):
"""Gets the finish_as of this OptionsOrder. # noqa: E501
- 结束方式，包括： - filled: 完全成交 - cancelled: 用户撤销 - liquidated: 强制平仓撤销 - ioc: 未立即完全成交，因为tif设置为ioc - auto_deleveraged: 自动减仓撤销 - reduce_only: 增持仓位撤销，因为设置reduce_only或平仓 - position_closed: 因为仓位平掉了，所以挂单被撤掉 - reduce_out: 只减仓被排除的不容易成交的挂单 - mmp_cancelled: MMP撤销 # noqa: E501
+ Order finish reason: - filled: Fully filled - cancelled: User cancelled - liquidated: Cancelled due to liquidation - ioc: Not immediately fully filled due to IOC time-in-force setting - auto_deleveraged: Cancelled due to auto-deleveraging - reduce_only: Cancelled due to position increase while reduce-only is set - position_closed: Cancelled because the position was closed - reduce_out: Only reduce positions by excluding hard-to-fill orders - mmp_cancelled: Cancelled by MMP # noqa: E501
:return: The finish_as of this OptionsOrder. # noqa: E501
:rtype: str
@@ -278,7 +278,7 @@ def finish_as(self):
def finish_as(self, finish_as):
"""Sets the finish_as of this OptionsOrder.
- 结束方式，包括： - filled: 完全成交 - cancelled: 用户撤销 - liquidated: 强制平仓撤销 - ioc: 未立即完全成交，因为tif设置为ioc - auto_deleveraged: 自动减仓撤销 - reduce_only: 增持仓位撤销，因为设置reduce_only或平仓 - position_closed: 因为仓位平掉了，所以挂单被撤掉 - reduce_out: 只减仓被排除的不容易成交的挂单 - mmp_cancelled: MMP撤销 # noqa: E501
+ Order finish reason: - filled: Fully filled - cancelled: User cancelled - liquidated: Cancelled due to liquidation - ioc: Not immediately fully filled due to IOC time-in-force setting - auto_deleveraged: Cancelled due to auto-deleveraging - reduce_only: Cancelled due to position increase while reduce-only is set - position_closed: Cancelled because the position was closed - reduce_out: Only reduce positions by excluding hard-to-fill orders - mmp_cancelled: Cancelled by MMP # noqa: E501
:param finish_as: The finish_as of this OptionsOrder. # noqa: E501
:type: str
@@ -296,7 +296,7 @@ def finish_as(self, finish_as):
def status(self):
"""Gets the status of this OptionsOrder. # noqa: E501
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:return: The status of this OptionsOrder. # noqa: E501
:rtype: str
@@ -307,7 +307,7 @@ def status(self):
def status(self, status):
"""Sets the status of this OptionsOrder.
- Order status - `open`: waiting to be traded - `finished`: finished # noqa: E501
+ Order status - `open`: Pending - `finished`: Completed # noqa: E501
:param status: The status of this OptionsOrder. # noqa: E501
:type: str
@@ -325,7 +325,7 @@ def status(self, status):
def contract(self):
"""Gets the contract of this OptionsOrder. # noqa: E501
- Contract name # noqa: E501
+ Options identifier # noqa: E501
:return: The contract of this OptionsOrder. # noqa: E501
:rtype: str
@@ -336,7 +336,7 @@ def contract(self):
def contract(self, contract):
"""Sets the contract of this OptionsOrder.
- Contract name # noqa: E501
+ Options identifier # noqa: E501
:param contract: The contract of this OptionsOrder. # noqa: E501
:type: str
@@ -350,7 +350,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this OptionsOrder. # noqa: E501
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:return: The size of this OptionsOrder. # noqa: E501
:rtype: int
@@ -361,7 +361,7 @@ def size(self):
def size(self, size):
"""Sets the size of this OptionsOrder.
- Order size. Specify positive number to make a bid, and negative number to ask # noqa: E501
+ Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. # noqa: E501
:param size: The size of this OptionsOrder. # noqa: E501
:type: int
@@ -375,7 +375,7 @@ def size(self, size):
def iceberg(self):
"""Gets the iceberg of this OptionsOrder. # noqa: E501
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:return: The iceberg of this OptionsOrder. # noqa: E501
:rtype: int
@@ -386,7 +386,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this OptionsOrder.
- Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size # noqa: E501
+ Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. # noqa: E501
:param iceberg: The iceberg of this OptionsOrder. # noqa: E501
:type: int
@@ -398,7 +398,7 @@ def iceberg(self, iceberg):
def price(self):
"""Gets the price of this OptionsOrder. # noqa: E501
- Order price. 0 for market order with `tif` set as `ioc` (USDT) # noqa: E501
+ Order price. Price of 0 with `tif` set as `ioc` represents market order (quote currency) # noqa: E501
:return: The price of this OptionsOrder. # noqa: E501
:rtype: str
@@ -409,7 +409,7 @@ def price(self):
def price(self, price):
"""Sets the price of this OptionsOrder.
- Order price. 0 for market order with `tif` set as `ioc` (USDT) # noqa: E501
+ Order price. Price of 0 with `tif` set as `ioc` represents market order (quote currency) # noqa: E501
:param price: The price of this OptionsOrder. # noqa: E501
:type: str
@@ -536,7 +536,7 @@ def is_liq(self, is_liq):
def mmp(self):
"""Gets the mmp of this OptionsOrder. # noqa: E501
- 设置为 true 的时候，为MMP委托 # noqa: E501
+ When set to true, it is an MMP order # noqa: E501
:return: The mmp of this OptionsOrder. # noqa: E501
:rtype: bool
@@ -547,7 +547,7 @@ def mmp(self):
def mmp(self, mmp):
"""Sets the mmp of this OptionsOrder.
- 设置为 true 的时候，为MMP委托 # noqa: E501
+ When set to true, it is an MMP order # noqa: E501
:param mmp: The mmp of this OptionsOrder. # noqa: E501
:type: bool
@@ -559,7 +559,7 @@ def mmp(self, mmp):
def is_mmp(self):
"""Gets the is_mmp of this OptionsOrder. # noqa: E501
- 是否为MMP委托。对应请求中的`mmp`。 # noqa: E501
+ Whether it is an MMP order. Corresponds to `mmp` in the request # noqa: E501
:return: The is_mmp of this OptionsOrder. # noqa: E501
:rtype: bool
@@ -570,7 +570,7 @@ def is_mmp(self):
def is_mmp(self, is_mmp):
"""Sets the is_mmp of this OptionsOrder.
- 是否为MMP委托。对应请求中的`mmp`。 # noqa: E501
+ Whether it is an MMP order. Corresponds to `mmp` in the request # noqa: E501
:param is_mmp: The is_mmp of this OptionsOrder. # noqa: E501
:type: bool
@@ -582,7 +582,7 @@ def is_mmp(self, is_mmp):
def tif(self):
"""Gets the tif of this OptionsOrder. # noqa: E501
- Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee # noqa: E501
+ Time in force strategy. Market orders currently only support IOC mode - gtc: Good Till Cancelled - ioc: Immediate Or Cancelled, execute immediately or cancel, taker only - poc: Pending Or Cancelled, passive order, maker only # noqa: E501
:return: The tif of this OptionsOrder. # noqa: E501
:rtype: str
@@ -593,7 +593,7 @@ def tif(self):
def tif(self, tif):
"""Sets the tif of this OptionsOrder.
- Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee # noqa: E501
+ Time in force strategy. Market orders currently only support IOC mode - gtc: Good Till Cancelled - ioc: Immediate Or Cancelled, execute immediately or cancel, taker only - poc: Pending Or Cancelled, passive order, maker only # noqa: E501
:param tif: The tif of this OptionsOrder. # noqa: E501
:type: str
@@ -611,7 +611,7 @@ def tif(self, tif):
def left(self):
"""Gets the left of this OptionsOrder. # noqa: E501
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:return: The left of this OptionsOrder. # noqa: E501
:rtype: int
@@ -622,7 +622,7 @@ def left(self):
def left(self, left):
"""Sets the left of this OptionsOrder.
- Size left to be traded # noqa: E501
+ Unfilled quantity # noqa: E501
:param left: The left of this OptionsOrder. # noqa: E501
:type: int
@@ -634,7 +634,7 @@ def left(self, left):
def fill_price(self):
"""Gets the fill_price of this OptionsOrder. # noqa: E501
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:return: The fill_price of this OptionsOrder. # noqa: E501
:rtype: str
@@ -645,7 +645,7 @@ def fill_price(self):
def fill_price(self, fill_price):
"""Sets the fill_price of this OptionsOrder.
- Fill price of the order # noqa: E501
+ Fill price # noqa: E501
:param fill_price: The fill_price of this OptionsOrder. # noqa: E501
:type: str
@@ -726,7 +726,7 @@ def mkfr(self, mkfr):
def refu(self):
"""Gets the refu of this OptionsOrder. # noqa: E501
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:return: The refu of this OptionsOrder. # noqa: E501
:rtype: int
@@ -737,7 +737,7 @@ def refu(self):
def refu(self, refu):
"""Sets the refu of this OptionsOrder.
- Reference user ID # noqa: E501
+ Referrer user ID # noqa: E501
:param refu: The refu of this OptionsOrder. # noqa: E501
:type: int
diff --git a/gate_api/models/options_position.py b/gate_api/models/options_position.py
index b1465be..b20a575 100644
--- a/gate_api/models/options_position.py
+++ b/gate_api/models/options_position.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -223,7 +223,7 @@ def contract(self, contract):
def size(self):
"""Gets the size of this OptionsPosition. # noqa: E501
- Position size (contract size) # noqa: E501
+ Position size (contract quantity) # noqa: E501
:return: The size of this OptionsPosition. # noqa: E501
:rtype: int
@@ -234,7 +234,7 @@ def size(self):
def size(self, size):
"""Sets the size of this OptionsPosition.
- Position size (contract size) # noqa: E501
+ Position size (contract quantity) # noqa: E501
:param size: The size of this OptionsPosition. # noqa: E501
:type: int
@@ -315,7 +315,7 @@ def mark_iv(self, mark_iv):
def realised_pnl(self):
"""Gets the realised_pnl of this OptionsPosition. # noqa: E501
- Realized PNL # noqa: E501
+ Realized PnL # noqa: E501
:return: The realised_pnl of this OptionsPosition. # noqa: E501
:rtype: str
@@ -326,7 +326,7 @@ def realised_pnl(self):
def realised_pnl(self, realised_pnl):
"""Sets the realised_pnl of this OptionsPosition.
- Realized PNL # noqa: E501
+ Realized PnL # noqa: E501
:param realised_pnl: The realised_pnl of this OptionsPosition. # noqa: E501
:type: str
@@ -361,7 +361,7 @@ def unrealised_pnl(self, unrealised_pnl):
def pending_orders(self):
"""Gets the pending_orders of this OptionsPosition. # noqa: E501
- Current open orders # noqa: E501
+ Current pending order quantity # noqa: E501
:return: The pending_orders of this OptionsPosition. # noqa: E501
:rtype: int
@@ -372,7 +372,7 @@ def pending_orders(self):
def pending_orders(self, pending_orders):
"""Sets the pending_orders of this OptionsPosition.
- Current open orders # noqa: E501
+ Current pending order quantity # noqa: E501
:param pending_orders: The pending_orders of this OptionsPosition. # noqa: E501
:type: int
@@ -405,7 +405,7 @@ def close_order(self, close_order):
def delta(self):
"""Gets the delta of this OptionsPosition. # noqa: E501
- Delta # noqa: E501
+ Greek letter delta # noqa: E501
:return: The delta of this OptionsPosition. # noqa: E501
:rtype: str
@@ -416,7 +416,7 @@ def delta(self):
def delta(self, delta):
"""Sets the delta of this OptionsPosition.
- Delta # noqa: E501
+ Greek letter delta # noqa: E501
:param delta: The delta of this OptionsPosition. # noqa: E501
:type: str
@@ -428,7 +428,7 @@ def delta(self, delta):
def gamma(self):
"""Gets the gamma of this OptionsPosition. # noqa: E501
- Gamma # noqa: E501
+ Greek letter gamma # noqa: E501
:return: The gamma of this OptionsPosition. # noqa: E501
:rtype: str
@@ -439,7 +439,7 @@ def gamma(self):
def gamma(self, gamma):
"""Sets the gamma of this OptionsPosition.
- Gamma # noqa: E501
+ Greek letter gamma # noqa: E501
:param gamma: The gamma of this OptionsPosition. # noqa: E501
:type: str
@@ -451,7 +451,7 @@ def gamma(self, gamma):
def vega(self):
"""Gets the vega of this OptionsPosition. # noqa: E501
- Vega # noqa: E501
+ Greek letter vega # noqa: E501
:return: The vega of this OptionsPosition. # noqa: E501
:rtype: str
@@ -462,7 +462,7 @@ def vega(self):
def vega(self, vega):
"""Sets the vega of this OptionsPosition.
- Vega # noqa: E501
+ Greek letter vega # noqa: E501
:param vega: The vega of this OptionsPosition. # noqa: E501
:type: str
@@ -474,7 +474,7 @@ def vega(self, vega):
def theta(self):
"""Gets the theta of this OptionsPosition. # noqa: E501
- Theta # noqa: E501
+ Greek letter theta # noqa: E501
:return: The theta of this OptionsPosition. # noqa: E501
:rtype: str
@@ -485,7 +485,7 @@ def theta(self):
def theta(self, theta):
"""Sets the theta of this OptionsPosition.
- Theta # noqa: E501
+ Greek letter theta # noqa: E501
:param theta: The theta of this OptionsPosition. # noqa: E501
:type: str
diff --git a/gate_api/models/options_position_close.py b/gate_api/models/options_position_close.py
index be9d2eb..2cc0fbb 100644
--- a/gate_api/models/options_position_close.py
+++ b/gate_api/models/options_position_close.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -128,7 +128,7 @@ def contract(self, contract):
def side(self):
"""Gets the side of this OptionsPositionClose. # noqa: E501
- Position side, long or short # noqa: E501
+ Position side - `long`: Long position - `short`: Short position # noqa: E501
:return: The side of this OptionsPositionClose. # noqa: E501
:rtype: str
@@ -139,7 +139,7 @@ def side(self):
def side(self, side):
"""Sets the side of this OptionsPositionClose.
- Position side, long or short # noqa: E501
+ Position side - `long`: Long position - `short`: Short position # noqa: E501
:param side: The side of this OptionsPositionClose. # noqa: E501
:type: str
@@ -157,7 +157,7 @@ def side(self, side):
def pnl(self):
"""Gets the pnl of this OptionsPositionClose. # noqa: E501
- PNL # noqa: E501
+ PnL # noqa: E501
:return: The pnl of this OptionsPositionClose. # noqa: E501
:rtype: str
@@ -168,7 +168,7 @@ def pnl(self):
def pnl(self, pnl):
"""Sets the pnl of this OptionsPositionClose.
- PNL # noqa: E501
+ PnL # noqa: E501
:param pnl: The pnl of this OptionsPositionClose. # noqa: E501
:type: str
@@ -180,7 +180,7 @@ def pnl(self, pnl):
def text(self):
"""Gets the text of this OptionsPositionClose. # noqa: E501
- Text of close order # noqa: E501
+ Source of close order. See `order.text` field for specific values # noqa: E501
:return: The text of this OptionsPositionClose. # noqa: E501
:rtype: str
@@ -191,7 +191,7 @@ def text(self):
def text(self, text):
"""Sets the text of this OptionsPositionClose.
- Text of close order # noqa: E501
+ Source of close order. See `order.text` field for specific values # noqa: E501
:param text: The text of this OptionsPositionClose. # noqa: E501
:type: str
@@ -203,7 +203,7 @@ def text(self, text):
def settle_size(self):
"""Gets the settle_size of this OptionsPositionClose. # noqa: E501
- settlement size # noqa: E501
+ Settlement size # noqa: E501
:return: The settle_size of this OptionsPositionClose. # noqa: E501
:rtype: str
@@ -214,7 +214,7 @@ def settle_size(self):
def settle_size(self, settle_size):
"""Sets the settle_size of this OptionsPositionClose.
- settlement size # noqa: E501
+ Settlement size # noqa: E501
:param settle_size: The settle_size of this OptionsPositionClose. # noqa: E501
:type: str
diff --git a/gate_api/models/options_position_close_order.py b/gate_api/models/options_position_close_order.py
index 01f5dc7..31449b1 100644
--- a/gate_api/models/options_position_close_order.py
+++ b/gate_api/models/options_position_close_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -67,7 +67,7 @@ def __init__(self, id=None, price=None, is_liq=None, local_vars_configuration=No
def id(self):
"""Gets the id of this OptionsPositionCloseOrder. # noqa: E501
- Close order ID # noqa: E501
+ Order ID # noqa: E501
:return: The id of this OptionsPositionCloseOrder. # noqa: E501
:rtype: int
@@ -78,7 +78,7 @@ def id(self):
def id(self, id):
"""Sets the id of this OptionsPositionCloseOrder.
- Close order ID # noqa: E501
+ Order ID # noqa: E501
:param id: The id of this OptionsPositionCloseOrder. # noqa: E501
:type: int
@@ -90,7 +90,7 @@ def id(self, id):
def price(self):
"""Gets the price of this OptionsPositionCloseOrder. # noqa: E501
- Close order price （quote currency) # noqa: E501
+ Order price (quote currency) # noqa: E501
:return: The price of this OptionsPositionCloseOrder. # noqa: E501
:rtype: str
@@ -101,7 +101,7 @@ def price(self):
def price(self, price):
"""Sets the price of this OptionsPositionCloseOrder.
- Close order price （quote currency) # noqa: E501
+ Order price (quote currency) # noqa: E501
:param price: The price of this OptionsPositionCloseOrder. # noqa: E501
:type: str
@@ -113,7 +113,7 @@ def price(self, price):
def is_liq(self):
"""Gets the is_liq of this OptionsPositionCloseOrder. # noqa: E501
- Is the close order from liquidation # noqa: E501
+ Whether the close order is from liquidation # noqa: E501
:return: The is_liq of this OptionsPositionCloseOrder. # noqa: E501
:rtype: bool
@@ -124,7 +124,7 @@ def is_liq(self):
def is_liq(self, is_liq):
"""Sets the is_liq of this OptionsPositionCloseOrder.
- Is the close order from liquidation # noqa: E501
+ Whether the close order is from liquidation # noqa: E501
:param is_liq: The is_liq of this OptionsPositionCloseOrder. # noqa: E501
:type: bool
diff --git a/gate_api/models/options_settlement.py b/gate_api/models/options_settlement.py
index c82e5d6..d199ae4 100644
--- a/gate_api/models/options_settlement.py
+++ b/gate_api/models/options_settlement.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -82,7 +82,7 @@ def __init__(self, time=None, contract=None, profit=None, fee=None, strike_price
def time(self):
"""Gets the time of this OptionsSettlement. # noqa: E501
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:return: The time of this OptionsSettlement. # noqa: E501
:rtype: float
@@ -93,7 +93,7 @@ def time(self):
def time(self, time):
"""Sets the time of this OptionsSettlement.
- Last changed time of configuration # noqa: E501
+ Last configuration update time # noqa: E501
:param time: The time of this OptionsSettlement. # noqa: E501
:type: float
@@ -128,7 +128,7 @@ def contract(self, contract):
def profit(self):
"""Gets the profit of this OptionsSettlement. # noqa: E501
- Settlement profit per size (quote currency) # noqa: E501
+ Settlement profit per contract (quote currency) # noqa: E501
:return: The profit of this OptionsSettlement. # noqa: E501
:rtype: str
@@ -139,7 +139,7 @@ def profit(self):
def profit(self, profit):
"""Sets the profit of this OptionsSettlement.
- Settlement profit per size (quote currency) # noqa: E501
+ Settlement profit per contract (quote currency) # noqa: E501
:param profit: The profit of this OptionsSettlement. # noqa: E501
:type: str
@@ -151,7 +151,7 @@ def profit(self, profit):
def fee(self):
"""Gets the fee of this OptionsSettlement. # noqa: E501
- Settlement fee per size (quote currency) # noqa: E501
+ Settlement fee per contract (quote currency) # noqa: E501
:return: The fee of this OptionsSettlement. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this OptionsSettlement.
- Settlement fee per size (quote currency) # noqa: E501
+ Settlement fee per contract (quote currency) # noqa: E501
:param fee: The fee of this OptionsSettlement. # noqa: E501
:type: str
diff --git a/gate_api/models/options_ticker.py b/gate_api/models/options_ticker.py
index 2369175..8a645f8 100644
--- a/gate_api/models/options_ticker.py
+++ b/gate_api/models/options_ticker.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -165,7 +165,7 @@ def name(self, name):
def last_price(self):
"""Gets the last_price of this OptionsTicker. # noqa: E501
- Last trading price (quote currency) # noqa: E501
+ Last trade price (quote currency) # noqa: E501
:return: The last_price of this OptionsTicker. # noqa: E501
:rtype: str
@@ -176,7 +176,7 @@ def last_price(self):
def last_price(self, last_price):
"""Sets the last_price of this OptionsTicker.
- Last trading price (quote currency) # noqa: E501
+ Last trade price (quote currency) # noqa: E501
:param last_price: The last_price of this OptionsTicker. # noqa: E501
:type: str
@@ -441,7 +441,7 @@ def leverage(self, leverage):
def delta(self):
"""Gets the delta of this OptionsTicker. # noqa: E501
- Delta # noqa: E501
+ Greek letter delta # noqa: E501
:return: The delta of this OptionsTicker. # noqa: E501
:rtype: str
@@ -452,7 +452,7 @@ def delta(self):
def delta(self, delta):
"""Sets the delta of this OptionsTicker.
- Delta # noqa: E501
+ Greek letter delta # noqa: E501
:param delta: The delta of this OptionsTicker. # noqa: E501
:type: str
@@ -464,7 +464,7 @@ def delta(self, delta):
def gamma(self):
"""Gets the gamma of this OptionsTicker. # noqa: E501
- Gamma # noqa: E501
+ Greek letter gamma # noqa: E501
:return: The gamma of this OptionsTicker. # noqa: E501
:rtype: str
@@ -475,7 +475,7 @@ def gamma(self):
def gamma(self, gamma):
"""Sets the gamma of this OptionsTicker.
- Gamma # noqa: E501
+ Greek letter gamma # noqa: E501
:param gamma: The gamma of this OptionsTicker. # noqa: E501
:type: str
@@ -487,7 +487,7 @@ def gamma(self, gamma):
def vega(self):
"""Gets the vega of this OptionsTicker. # noqa: E501
- Vega # noqa: E501
+ Greek letter vega # noqa: E501
:return: The vega of this OptionsTicker. # noqa: E501
:rtype: str
@@ -498,7 +498,7 @@ def vega(self):
def vega(self, vega):
"""Sets the vega of this OptionsTicker.
- Vega # noqa: E501
+ Greek letter vega # noqa: E501
:param vega: The vega of this OptionsTicker. # noqa: E501
:type: str
@@ -510,7 +510,7 @@ def vega(self, vega):
def theta(self):
"""Gets the theta of this OptionsTicker. # noqa: E501
- Theta # noqa: E501
+ Greek letter theta # noqa: E501
:return: The theta of this OptionsTicker. # noqa: E501
:rtype: str
@@ -521,7 +521,7 @@ def theta(self):
def theta(self, theta):
"""Sets the theta of this OptionsTicker.
- Theta # noqa: E501
+ Greek letter theta # noqa: E501
:param theta: The theta of this OptionsTicker. # noqa: E501
:type: str
diff --git a/gate_api/models/options_underlying.py b/gate_api/models/options_underlying.py
index f150247..89abb3f 100644
--- a/gate_api/models/options_underlying.py
+++ b/gate_api/models/options_underlying.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/options_underlying_ticker.py b/gate_api/models/options_underlying_ticker.py
index df43bcb..8ce402e 100644
--- a/gate_api/models/options_underlying_ticker.py
+++ b/gate_api/models/options_underlying_ticker.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/order.py b/gate_api/models/order.py
index d47d497..7555321 100644
--- a/gate_api/models/order.py
+++ b/gate_api/models/order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -444,7 +444,7 @@ def currency_pair(self, currency_pair):
def type(self):
"""Gets the type of this Order. # noqa: E501
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:return: The type of this Order. # noqa: E501
:rtype: str
@@ -455,7 +455,7 @@ def type(self):
def type(self, type):
"""Sets the type of this Order.
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:param type: The type of this Order. # noqa: E501
:type: str
@@ -473,7 +473,7 @@ def type(self, type):
def account(self):
"""Gets the account of this Order. # noqa: E501
- 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` # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:return: The account of this Order. # noqa: E501
:rtype: str
@@ -484,7 +484,7 @@ def account(self):
def account(self, account):
"""Sets the account of this Order.
- 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` # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:param account: The account of this Order. # noqa: E501
:type: str
@@ -496,7 +496,7 @@ def account(self, account):
def side(self):
"""Gets the side of this Order. # noqa: E501
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:return: The side of this Order. # noqa: E501
:rtype: str
@@ -507,7 +507,7 @@ def side(self):
def side(self, side):
"""Sets the side of this Order.
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:param side: The side of this Order. # noqa: E501
:type: str
@@ -527,7 +527,7 @@ def side(self, side):
def amount(self):
"""Gets the amount of this Order. # noqa: E501
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:return: The amount of this Order. # noqa: E501
:rtype: str
@@ -538,7 +538,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this Order.
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:param amount: The amount of this Order. # noqa: E501
:type: str
@@ -552,7 +552,7 @@ def amount(self, amount):
def price(self):
"""Gets the price of this Order. # noqa: E501
- Price can't be empty when `type`= `limit` # noqa: E501
+ Trading price, required when `type`=`limit` # noqa: E501
:return: The price of this Order. # noqa: E501
:rtype: str
@@ -563,7 +563,7 @@ def price(self):
def price(self, price):
"""Sets the price of this Order.
- Price can't be empty when `type`= `limit` # noqa: E501
+ Trading price, required when `type`=`limit` # noqa: E501
:param price: The price of this Order. # noqa: E501
:type: str
@@ -604,7 +604,7 @@ def time_in_force(self, time_in_force):
def iceberg(self):
"""Gets the iceberg of this Order. # noqa: E501
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:return: The iceberg of this Order. # noqa: E501
:rtype: str
@@ -615,7 +615,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this Order.
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:param iceberg: The iceberg of this Order. # noqa: E501
:type: str
@@ -627,7 +627,7 @@ def iceberg(self, iceberg):
def auto_borrow(self):
"""Gets the auto_borrow of this Order. # noqa: E501
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:return: The auto_borrow of this Order. # noqa: E501
:rtype: bool
@@ -638,7 +638,7 @@ def auto_borrow(self):
def auto_borrow(self, auto_borrow):
"""Sets the auto_borrow of this Order.
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:param auto_borrow: The auto_borrow of this Order. # noqa: E501
:type: bool
@@ -650,7 +650,7 @@ def auto_borrow(self, auto_borrow):
def auto_repay(self):
"""Gets the auto_repay of this Order. # noqa: E501
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:return: The auto_repay of this Order. # noqa: E501
:rtype: bool
@@ -661,7 +661,7 @@ def auto_repay(self):
def auto_repay(self, auto_repay):
"""Sets the auto_repay of this Order.
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:param auto_repay: The auto_repay of this Order. # noqa: E501
:type: bool
@@ -696,7 +696,7 @@ def left(self, left):
def filled_amount(self):
"""Gets the filled_amount of this Order. # noqa: E501
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:return: The filled_amount of this Order. # noqa: E501
:rtype: str
@@ -707,7 +707,7 @@ def filled_amount(self):
def filled_amount(self, filled_amount):
"""Sets the filled_amount of this Order.
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:param filled_amount: The filled_amount of this Order. # noqa: E501
:type: str
@@ -880,7 +880,7 @@ def gt_fee(self, gt_fee):
def gt_maker_fee(self):
"""Gets the gt_maker_fee of this Order. # noqa: E501
- GT used to deduct maker fee # noqa: E501
+ GT amount used to deduct maker fee # noqa: E501
:return: The gt_maker_fee of this Order. # noqa: E501
:rtype: str
@@ -891,7 +891,7 @@ def gt_maker_fee(self):
def gt_maker_fee(self, gt_maker_fee):
"""Sets the gt_maker_fee of this Order.
- GT used to deduct maker fee # noqa: E501
+ GT amount used to deduct maker fee # noqa: E501
:param gt_maker_fee: The gt_maker_fee of this Order. # noqa: E501
:type: str
@@ -903,7 +903,7 @@ def gt_maker_fee(self, gt_maker_fee):
def gt_taker_fee(self):
"""Gets the gt_taker_fee of this Order. # noqa: E501
- GT used to deduct taker fee # noqa: E501
+ GT amount used to deduct taker fee # noqa: E501
:return: The gt_taker_fee of this Order. # noqa: E501
:rtype: str
@@ -914,7 +914,7 @@ def gt_taker_fee(self):
def gt_taker_fee(self, gt_taker_fee):
"""Sets the gt_taker_fee of this Order.
- GT used to deduct taker fee # noqa: E501
+ GT amount used to deduct taker fee # noqa: E501
:param gt_taker_fee: The gt_taker_fee of this Order. # noqa: E501
:type: str
@@ -926,7 +926,7 @@ def gt_taker_fee(self, gt_taker_fee):
def gt_discount(self):
"""Gets the gt_discount of this Order. # noqa: E501
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:return: The gt_discount of this Order. # noqa: E501
:rtype: bool
@@ -937,7 +937,7 @@ def gt_discount(self):
def gt_discount(self, gt_discount):
"""Sets the gt_discount of this Order.
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:param gt_discount: The gt_discount of this Order. # noqa: E501
:type: bool
@@ -1018,7 +1018,7 @@ def stp_id(self, stp_id):
def stp_act(self):
"""Gets the stp_act of this Order. # noqa: E501
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:return: The stp_act of this Order. # noqa: E501
:rtype: str
@@ -1029,7 +1029,7 @@ def stp_act(self):
def stp_act(self, stp_act):
"""Sets the stp_act of this Order.
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:param stp_act: The stp_act of this Order. # noqa: E501
:type: str
@@ -1047,7 +1047,7 @@ def stp_act(self, stp_act):
def finish_as(self):
"""Gets the finish_as of this Order. # noqa: E501
- Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown # noqa: E501
+ Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown # noqa: E501
:return: The finish_as of this Order. # noqa: E501
:rtype: str
@@ -1058,7 +1058,7 @@ def finish_as(self):
def finish_as(self, finish_as):
"""Sets the finish_as of this Order.
- Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown # noqa: E501
+ Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown # noqa: E501
:param finish_as: The finish_as of this Order. # noqa: E501
:type: str
diff --git a/gate_api/models/order_book.py b/gate_api/models/order_book.py
index c554292..a469fe7 100644
--- a/gate_api/models/order_book.py
+++ b/gate_api/models/order_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -144,7 +144,7 @@ def update(self, update):
def asks(self):
"""Gets the asks of this OrderBook. # noqa: E501
- Asks order depth # noqa: E501
+ Ask Depth # noqa: E501
:return: The asks of this OrderBook. # noqa: E501
:rtype: list[list[str]]
@@ -155,7 +155,7 @@ def asks(self):
def asks(self, asks):
"""Sets the asks of this OrderBook.
- Asks order depth # noqa: E501
+ Ask Depth # noqa: E501
:param asks: The asks of this OrderBook. # noqa: E501
:type: list[list[str]]
@@ -169,7 +169,7 @@ def asks(self, asks):
def bids(self):
"""Gets the bids of this OrderBook. # noqa: E501
- Bids order depth # noqa: E501
+ Bid Depth # noqa: E501
:return: The bids of this OrderBook. # noqa: E501
:rtype: list[list[str]]
@@ -180,7 +180,7 @@ def bids(self):
def bids(self, bids):
"""Sets the bids of this OrderBook.
- Bids order depth # noqa: E501
+ Bid Depth # noqa: E501
:param bids: The bids of this OrderBook. # noqa: E501
:type: list[list[str]]
diff --git a/gate_api/models/order_cancel.py b/gate_api/models/order_cancel.py
index 269239f..ba1457e 100644
--- a/gate_api/models/order_cancel.py
+++ b/gate_api/models/order_cancel.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -313,7 +313,7 @@ def amend_text(self, amend_text):
def succeeded(self):
"""Gets the succeeded of this OrderCancel. # noqa: E501
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:return: The succeeded of this OrderCancel. # noqa: E501
:rtype: bool
@@ -324,7 +324,7 @@ def succeeded(self):
def succeeded(self, succeeded):
"""Sets the succeeded of this OrderCancel.
- Whether the batch of orders succeeded # noqa: E501
+ Request execution result # noqa: E501
:param succeeded: The succeeded of this OrderCancel. # noqa: E501
:type: bool
@@ -528,7 +528,7 @@ def currency_pair(self, currency_pair):
def type(self):
"""Gets the type of this OrderCancel. # noqa: E501
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:return: The type of this OrderCancel. # noqa: E501
:rtype: str
@@ -539,7 +539,7 @@ def type(self):
def type(self, type):
"""Sets the type of this OrderCancel.
- Order Type - limit : Limit Order - market : Market Order # noqa: E501
+ Order Type - limit : Limit Order - market : Market Order # noqa: E501
:param type: The type of this OrderCancel. # noqa: E501
:type: str
@@ -557,7 +557,7 @@ def type(self, type):
def account(self):
"""Gets the account of this OrderCancel. # noqa: E501
- 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` # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:return: The account of this OrderCancel. # noqa: E501
:rtype: str
@@ -568,7 +568,7 @@ def account(self):
def account(self, account):
"""Sets the account of this OrderCancel.
- 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` # noqa: E501
+ Account type, spot - spot account, margin - leveraged account, unified - unified account # noqa: E501
:param account: The account of this OrderCancel. # noqa: E501
:type: str
@@ -580,7 +580,7 @@ def account(self, account):
def side(self):
"""Gets the side of this OrderCancel. # noqa: E501
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:return: The side of this OrderCancel. # noqa: E501
:rtype: str
@@ -591,7 +591,7 @@ def side(self):
def side(self, side):
"""Sets the side of this OrderCancel.
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:param side: The side of this OrderCancel. # noqa: E501
:type: str
@@ -611,7 +611,7 @@ def side(self, side):
def amount(self):
"""Gets the amount of this OrderCancel. # noqa: E501
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:return: The amount of this OrderCancel. # noqa: E501
:rtype: str
@@ -622,7 +622,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this OrderCancel.
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:param amount: The amount of this OrderCancel. # noqa: E501
:type: str
@@ -636,7 +636,7 @@ def amount(self, amount):
def price(self):
"""Gets the price of this OrderCancel. # noqa: E501
- Price can't be empty when `type`= `limit` # noqa: E501
+ Trading price, required when `type`=`limit` # noqa: E501
:return: The price of this OrderCancel. # noqa: E501
:rtype: str
@@ -647,7 +647,7 @@ def price(self):
def price(self, price):
"""Sets the price of this OrderCancel.
- Price can't be empty when `type`= `limit` # noqa: E501
+ Trading price, required when `type`=`limit` # noqa: E501
:param price: The price of this OrderCancel. # noqa: E501
:type: str
@@ -688,7 +688,7 @@ def time_in_force(self, time_in_force):
def iceberg(self):
"""Gets the iceberg of this OrderCancel. # noqa: E501
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:return: The iceberg of this OrderCancel. # noqa: E501
:rtype: str
@@ -699,7 +699,7 @@ def iceberg(self):
def iceberg(self, iceberg):
"""Sets the iceberg of this OrderCancel.
- Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. # noqa: E501
+ Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported # noqa: E501
:param iceberg: The iceberg of this OrderCancel. # noqa: E501
:type: str
@@ -711,7 +711,7 @@ def iceberg(self, iceberg):
def auto_borrow(self):
"""Gets the auto_borrow of this OrderCancel. # noqa: E501
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:return: The auto_borrow of this OrderCancel. # noqa: E501
:rtype: bool
@@ -722,7 +722,7 @@ def auto_borrow(self):
def auto_borrow(self, auto_borrow):
"""Sets the auto_borrow of this OrderCancel.
- Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. # noqa: E501
+ Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough # noqa: E501
:param auto_borrow: The auto_borrow of this OrderCancel. # noqa: E501
:type: bool
@@ -734,7 +734,7 @@ def auto_borrow(self, auto_borrow):
def auto_repay(self):
"""Gets the auto_repay of this OrderCancel. # noqa: E501
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:return: The auto_repay of this OrderCancel. # noqa: E501
:rtype: bool
@@ -745,7 +745,7 @@ def auto_repay(self):
def auto_repay(self, auto_repay):
"""Sets the auto_repay of this OrderCancel.
- Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. # noqa: E501
+ Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order # noqa: E501
:param auto_repay: The auto_repay of this OrderCancel. # noqa: E501
:type: bool
@@ -780,7 +780,7 @@ def left(self, left):
def filled_amount(self):
"""Gets the filled_amount of this OrderCancel. # noqa: E501
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:return: The filled_amount of this OrderCancel. # noqa: E501
:rtype: str
@@ -791,7 +791,7 @@ def filled_amount(self):
def filled_amount(self, filled_amount):
"""Sets the filled_amount of this OrderCancel.
- Amount traded to fill # noqa: E501
+ Amount filled # noqa: E501
:param filled_amount: The filled_amount of this OrderCancel. # noqa: E501
:type: str
@@ -964,7 +964,7 @@ def gt_fee(self, gt_fee):
def gt_maker_fee(self):
"""Gets the gt_maker_fee of this OrderCancel. # noqa: E501
- GT used to deduct maker fee # noqa: E501
+ GT amount used to deduct maker fee # noqa: E501
:return: The gt_maker_fee of this OrderCancel. # noqa: E501
:rtype: str
@@ -975,7 +975,7 @@ def gt_maker_fee(self):
def gt_maker_fee(self, gt_maker_fee):
"""Sets the gt_maker_fee of this OrderCancel.
- GT used to deduct maker fee # noqa: E501
+ GT amount used to deduct maker fee # noqa: E501
:param gt_maker_fee: The gt_maker_fee of this OrderCancel. # noqa: E501
:type: str
@@ -987,7 +987,7 @@ def gt_maker_fee(self, gt_maker_fee):
def gt_taker_fee(self):
"""Gets the gt_taker_fee of this OrderCancel. # noqa: E501
- GT used to deduct taker fee # noqa: E501
+ GT amount used to deduct taker fee # noqa: E501
:return: The gt_taker_fee of this OrderCancel. # noqa: E501
:rtype: str
@@ -998,7 +998,7 @@ def gt_taker_fee(self):
def gt_taker_fee(self, gt_taker_fee):
"""Sets the gt_taker_fee of this OrderCancel.
- GT used to deduct taker fee # noqa: E501
+ GT amount used to deduct taker fee # noqa: E501
:param gt_taker_fee: The gt_taker_fee of this OrderCancel. # noqa: E501
:type: str
@@ -1010,7 +1010,7 @@ def gt_taker_fee(self, gt_taker_fee):
def gt_discount(self):
"""Gets the gt_discount of this OrderCancel. # noqa: E501
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:return: The gt_discount of this OrderCancel. # noqa: E501
:rtype: bool
@@ -1021,7 +1021,7 @@ def gt_discount(self):
def gt_discount(self, gt_discount):
"""Sets the gt_discount of this OrderCancel.
- Whether GT fee discount is used # noqa: E501
+ Whether GT fee deduction is enabled # noqa: E501
:param gt_discount: The gt_discount of this OrderCancel. # noqa: E501
:type: bool
@@ -1102,7 +1102,7 @@ def stp_id(self, stp_id):
def stp_act(self):
"""Gets the stp_act of this OrderCancel. # noqa: E501
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:return: The stp_act of this OrderCancel. # noqa: E501
:rtype: str
@@ -1113,7 +1113,7 @@ def stp_act(self):
def stp_act(self, stp_act):
"""Sets the stp_act of this OrderCancel.
- Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled # noqa: E501
+ Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled # noqa: E501
:param stp_act: The stp_act of this OrderCancel. # noqa: E501
:type: str
diff --git a/gate_api/models/order_patch.py b/gate_api/models/order_patch.py
index 0f81cd5..8e59035 100644
--- a/gate_api/models/order_patch.py
+++ b/gate_api/models/order_patch.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -105,7 +105,7 @@ def currency_pair(self, currency_pair):
def account(self):
"""Gets the account of this OrderPatch. # noqa: E501
- 指定查询账户。 # noqa: E501
+ Specify query account # noqa: E501
:return: The account of this OrderPatch. # noqa: E501
:rtype: str
@@ -116,7 +116,7 @@ def account(self):
def account(self, account):
"""Sets the account of this OrderPatch.
- 指定查询账户。 # noqa: E501
+ Specify query account # noqa: E501
:param account: The account of this OrderPatch. # noqa: E501
:type: str
@@ -128,7 +128,7 @@ def account(self, account):
def amount(self):
"""Gets the amount of this OrderPatch. # noqa: E501
- New order amount. `amount` and `price` must specify one of them # noqa: E501
+ Trading quantity. Either `amount` or `price` must be specified # noqa: E501
:return: The amount of this OrderPatch. # noqa: E501
:rtype: str
@@ -139,7 +139,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this OrderPatch.
- New order amount. `amount` and `price` must specify one of them # noqa: E501
+ Trading quantity. Either `amount` or `price` must be specified # noqa: E501
:param amount: The amount of this OrderPatch. # noqa: E501
:type: str
@@ -151,7 +151,7 @@ def amount(self, amount):
def price(self):
"""Gets the price of this OrderPatch. # noqa: E501
- New order price. `amount` and `Price` must specify one of them\" # noqa: E501
+ Trading price. Either `amount` or `price` must be specified # noqa: E501
:return: The price of this OrderPatch. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def price(self):
def price(self, price):
"""Sets the price of this OrderPatch.
- New order price. `amount` and `Price` must specify one of them\" # noqa: E501
+ Trading price. Either `amount` or `price` must be specified # noqa: E501
:param price: The price of this OrderPatch. # noqa: E501
:type: str
@@ -174,7 +174,7 @@ def price(self, price):
def amend_text(self):
"""Gets the amend_text of this OrderPatch. # noqa: E501
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:return: The amend_text of this OrderPatch. # noqa: E501
:rtype: str
@@ -185,7 +185,7 @@ def amend_text(self):
def amend_text(self, amend_text):
"""Sets the amend_text of this OrderPatch.
- Custom info during amending order # noqa: E501
+ Custom info during order amendment # noqa: E501
:param amend_text: The amend_text of this OrderPatch. # noqa: E501
:type: str
diff --git a/gate_api/models/order_resp.py b/gate_api/models/order_resp.py
index 73a0d80..c95612a 100644
--- a/gate_api/models/order_resp.py
+++ b/gate_api/models/order_resp.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/partner_commission_history.py b/gate_api/models/partner_commission_history.py
index 2a39879..77c0d2f 100644
--- a/gate_api/models/partner_commission_history.py
+++ b/gate_api/models/partner_commission_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def total(self, total):
def list(self):
"""Gets the list of this PartnerCommissionHistory. # noqa: E501
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:return: The list of this PartnerCommissionHistory. # noqa: E501
:rtype: list[AgencyCommission]
@@ -96,7 +96,7 @@ def list(self):
def list(self, list):
"""Sets the list of this PartnerCommissionHistory.
- List of comission history # noqa: E501
+ List of commission history # noqa: E501
:param list: The list of this PartnerCommissionHistory. # noqa: E501
:type: list[AgencyCommission]
diff --git a/gate_api/models/partner_sub.py b/gate_api/models/partner_sub.py
index e908461..c82d656 100644
--- a/gate_api/models/partner_sub.py
+++ b/gate_api/models/partner_sub.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def user_id(self, user_id):
def user_join_time(self):
"""Gets the user_join_time of this PartnerSub. # noqa: E501
- The time when the user joined the system, in seconds Unix timestamp # noqa: E501
+ Time when user joined the system, Unix timestamp in seconds # noqa: E501
:return: The user_join_time of this PartnerSub. # noqa: E501
:rtype: int
@@ -101,7 +101,7 @@ def user_join_time(self):
def user_join_time(self, user_join_time):
"""Sets the user_join_time of this PartnerSub.
- The time when the user joined the system, in seconds Unix timestamp # noqa: E501
+ Time when user joined the system, Unix timestamp in seconds # noqa: E501
:param user_join_time: The user_join_time of this PartnerSub. # noqa: E501
:type: int
@@ -113,7 +113,7 @@ def user_join_time(self, user_join_time):
def type(self):
"""Gets the type of this PartnerSub. # noqa: E501
- Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) # noqa: E501
+ Type (1-Sub-agent 2-Indirect direct customer 3-Direct direct customer) # noqa: E501
:return: The type of this PartnerSub. # noqa: E501
:rtype: int
@@ -124,7 +124,7 @@ def type(self):
def type(self, type):
"""Sets the type of this PartnerSub.
- Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) # noqa: E501
+ Type (1-Sub-agent 2-Indirect direct customer 3-Direct direct customer) # noqa: E501
:param type: The type of this PartnerSub. # noqa: E501
:type: int
diff --git a/gate_api/models/partner_sub_list.py b/gate_api/models/partner_sub_list.py
index 735084d..9dec1e4 100644
--- a/gate_api/models/partner_sub_list.py
+++ b/gate_api/models/partner_sub_list.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/partner_transaction_history.py b/gate_api/models/partner_transaction_history.py
index 50cc3c8..3939e41 100644
--- a/gate_api/models/partner_transaction_history.py
+++ b/gate_api/models/partner_transaction_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/patch_uni_lend.py b/gate_api/models/patch_uni_lend.py
index dba7451..82e3a19 100644
--- a/gate_api/models/patch_uni_lend.py
+++ b/gate_api/models/patch_uni_lend.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/place_dual_investment_order.py b/gate_api/models/place_dual_investment_order.py
index 1878ce1..46346c1 100644
--- a/gate_api/models/place_dual_investment_order.py
+++ b/gate_api/models/place_dual_investment_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -34,43 +34,38 @@ class PlaceDualInvestmentOrder(object):
"""
openapi_types = {
'plan_id': 'str',
- 'copies': 'str',
- 'is_max': 'int',
- 'amount': 'str'
+ 'amount': 'str',
+ 'text': 'str'
}
attribute_map = {
'plan_id': 'plan_id',
- 'copies': 'copies',
- 'is_max': 'is_max',
- 'amount': 'amount'
+ 'amount': 'amount',
+ 'text': 'text'
}
- def __init__(self, plan_id=None, copies=None, is_max=None, amount=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, int, str, Configuration) -> None
+ def __init__(self, plan_id=None, amount=None, text=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, Configuration) -> None
"""PlaceDualInvestmentOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
self._plan_id = None
- self._copies = None
- self._is_max = None
self._amount = None
+ self._text = None
self.discriminator = None
self.plan_id = plan_id
- if copies is not None:
- self.copies = copies
- if is_max is not None:
- self.is_max = is_max
self.amount = amount
+ if text is not None:
+ self.text = text
@property
def plan_id(self):
"""Gets the plan_id of this PlaceDualInvestmentOrder. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The plan_id of this PlaceDualInvestmentOrder. # noqa: E501
:rtype: str
@@ -81,7 +76,7 @@ def plan_id(self):
def plan_id(self, plan_id):
"""Sets the plan_id of this PlaceDualInvestmentOrder.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param plan_id: The plan_id of this PlaceDualInvestmentOrder. # noqa: E501
:type: str
@@ -92,75 +87,52 @@ def plan_id(self, plan_id):
self._plan_id = plan_id
@property
- def copies(self):
- """Gets the copies of this PlaceDualInvestmentOrder. # noqa: E501
+ def amount(self):
+ """Gets the amount of this PlaceDualInvestmentOrder. # noqa: E501
- The number of copies is mutually exclusive with the amount field and will be deprecated soon. It is recommended to use the amount parameter. # noqa: E501
+ Subscription amount, mutually exclusive with copies field # noqa: E501
- :return: The copies of this PlaceDualInvestmentOrder. # noqa: E501
+ :return: The amount of this PlaceDualInvestmentOrder. # noqa: E501
:rtype: str
"""
- return self._copies
+ return self._amount
- @copies.setter
- def copies(self, copies):
- """Sets the copies of this PlaceDualInvestmentOrder.
+ @amount.setter
+ def amount(self, amount):
+ """Sets the amount of this PlaceDualInvestmentOrder.
- The number of copies is mutually exclusive with the amount field and will be deprecated soon. It is recommended to use the amount parameter. # noqa: E501
+ Subscription amount, mutually exclusive with copies field # noqa: E501
- :param copies: The copies of this PlaceDualInvestmentOrder. # noqa: E501
+ :param amount: The amount of this PlaceDualInvestmentOrder. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
+ raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
- self._copies = copies
-
- @property
- def is_max(self):
- """Gets the is_max of this PlaceDualInvestmentOrder. # noqa: E501
-
- Whether to purchase at the maximum. Mutually exclusive with the amount field. Will be deprecated soon. It is recommended to use the amount parameter. # noqa: E501
-
- :return: The is_max of this PlaceDualInvestmentOrder. # noqa: E501
- :rtype: int
- """
- return self._is_max
-
- @is_max.setter
- def is_max(self, is_max):
- """Sets the is_max of this PlaceDualInvestmentOrder.
-
- Whether to purchase at the maximum. Mutually exclusive with the amount field. Will be deprecated soon. It is recommended to use the amount parameter. # noqa: E501
-
- :param is_max: The is_max of this PlaceDualInvestmentOrder. # noqa: E501
- :type: int
- """
-
- self._is_max = is_max
+ self._amount = amount
@property
- def amount(self):
- """Gets the amount of this PlaceDualInvestmentOrder. # noqa: E501
+ def text(self):
+ """Gets the text of this PlaceDualInvestmentOrder. # noqa: E501
- Subscription amount, mutually exclusive with the copies field # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
- :return: The amount of this PlaceDualInvestmentOrder. # noqa: E501
+ :return: The text of this PlaceDualInvestmentOrder. # noqa: E501
:rtype: str
"""
- return self._amount
+ return self._text
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this PlaceDualInvestmentOrder.
+ @text.setter
+ def text(self, text):
+ """Sets the text of this PlaceDualInvestmentOrder.
- Subscription amount, mutually exclusive with the copies field # noqa: E501
+ Order custom information. Users can set custom ID with this field. Custom fields must meet the following conditions: 1. Must start with `t-` 2. Excluding `t-`, length cannot exceed 28 bytes 3. Can only contain numbers, letters, underscore(_), hyphen(-) or dot(.) # noqa: E501
- :param amount: The amount of this PlaceDualInvestmentOrder. # noqa: E501
+ :param text: The text of this PlaceDualInvestmentOrder. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
- raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
- self._amount = amount
+ self._text = text
def to_dict(self):
"""Returns the model properties as a dict"""
diff --git a/gate_api/models/position.py b/gate_api/models/position.py
index 0c4d905..2951397 100644
--- a/gate_api/models/position.py
+++ b/gate_api/models/position.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -63,7 +63,10 @@ class Position(object):
'cross_leverage_limit': 'str',
'update_time': 'int',
'update_id': 'int',
- 'open_time': 'int'
+ 'open_time': 'int',
+ 'risk_limit_table': 'str',
+ 'average_maintenance_rate': 'str',
+ 'pid': 'int'
}
attribute_map = {
@@ -97,11 +100,14 @@ class Position(object):
'cross_leverage_limit': 'cross_leverage_limit',
'update_time': 'update_time',
'update_id': 'update_id',
- 'open_time': 'open_time'
+ 'open_time': 'open_time',
+ 'risk_limit_table': 'risk_limit_table',
+ 'average_maintenance_rate': 'average_maintenance_rate',
+ 'pid': 'pid'
}
- def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limit=None, leverage_max=None, maintenance_rate=None, value=None, margin=None, entry_price=None, liq_price=None, mark_price=None, initial_margin=None, maintenance_margin=None, unrealised_pnl=None, realised_pnl=None, pnl_pnl=None, pnl_fund=None, pnl_fee=None, history_pnl=None, last_close_pnl=None, realised_point=None, history_point=None, adl_ranking=None, pending_orders=None, close_order=None, mode=None, cross_leverage_limit=None, update_time=None, update_id=None, open_time=None, local_vars_configuration=None): # noqa: E501
- # type: (int, str, int, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, int, int, PositionCloseOrder, str, str, int, int, int, Configuration) -> None
+ def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limit=None, leverage_max=None, maintenance_rate=None, value=None, margin=None, entry_price=None, liq_price=None, mark_price=None, initial_margin=None, maintenance_margin=None, unrealised_pnl=None, realised_pnl=None, pnl_pnl=None, pnl_fund=None, pnl_fee=None, history_pnl=None, last_close_pnl=None, realised_point=None, history_point=None, adl_ranking=None, pending_orders=None, close_order=None, mode=None, cross_leverage_limit=None, update_time=None, update_id=None, open_time=None, risk_limit_table=None, average_maintenance_rate=None, pid=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, int, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, int, int, PositionCloseOrder, str, str, int, int, int, str, str, int, Configuration) -> None
"""Position - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -138,6 +144,9 @@ def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limi
self._update_time = None
self._update_id = None
self._open_time = None
+ self._risk_limit_table = None
+ self._average_maintenance_rate = None
+ self._pid = None
self.discriminator = None
if user is not None:
@@ -201,6 +210,12 @@ def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limi
self.update_id = update_id
if open_time is not None:
self.open_time = open_time
+ if risk_limit_table is not None:
+ self.risk_limit_table = risk_limit_table
+ if average_maintenance_rate is not None:
+ self.average_maintenance_rate = average_maintenance_rate
+ if pid is not None:
+ self.pid = pid
@property
def user(self):
@@ -551,7 +566,7 @@ def unrealised_pnl(self, unrealised_pnl):
def realised_pnl(self):
"""Gets the realised_pnl of this Position. # noqa: E501
- Realized PNL # noqa: E501
+ Realized PnL # noqa: E501
:return: The realised_pnl of this Position. # noqa: E501
:rtype: str
@@ -562,7 +577,7 @@ def realised_pnl(self):
def realised_pnl(self, realised_pnl):
"""Sets the realised_pnl of this Position.
- Realized PNL # noqa: E501
+ Realized PnL # noqa: E501
:param realised_pnl: The realised_pnl of this Position. # noqa: E501
:type: str
@@ -597,7 +612,7 @@ def pnl_pnl(self, pnl_pnl):
def pnl_fund(self):
"""Gets the pnl_fund of this Position. # noqa: E501
- Realized PNL - Funding Fees # noqa: E501
+ Realized PNL - Funding Fees # noqa: E501
:return: The pnl_fund of this Position. # noqa: E501
:rtype: str
@@ -608,7 +623,7 @@ def pnl_fund(self):
def pnl_fund(self, pnl_fund):
"""Sets the pnl_fund of this Position.
- Realized PNL - Funding Fees # noqa: E501
+ Realized PNL - Funding Fees # noqa: E501
:param pnl_fund: The pnl_fund of this Position. # noqa: E501
:type: str
@@ -643,7 +658,7 @@ def pnl_fee(self, pnl_fee):
def history_pnl(self):
"""Gets the history_pnl of this Position. # noqa: E501
- History realized PNL # noqa: E501
+ Total realized PnL from closed positions # noqa: E501
:return: The history_pnl of this Position. # noqa: E501
:rtype: str
@@ -654,7 +669,7 @@ def history_pnl(self):
def history_pnl(self, history_pnl):
"""Sets the history_pnl of this Position.
- History realized PNL # noqa: E501
+ Total realized PnL from closed positions # noqa: E501
:param history_pnl: The history_pnl of this Position. # noqa: E501
:type: str
@@ -758,7 +773,7 @@ def adl_ranking(self, adl_ranking):
def pending_orders(self):
"""Gets the pending_orders of this Position. # noqa: E501
- Current open orders # noqa: E501
+ Current pending order quantity # noqa: E501
:return: The pending_orders of this Position. # noqa: E501
:rtype: int
@@ -769,7 +784,7 @@ def pending_orders(self):
def pending_orders(self, pending_orders):
"""Sets the pending_orders of this Position.
- Current open orders # noqa: E501
+ Current pending order quantity # noqa: E501
:param pending_orders: The pending_orders of this Position. # noqa: E501
:type: int
@@ -802,7 +817,7 @@ def close_order(self, close_order):
def mode(self):
"""Gets the mode of this Position. # noqa: E501
- Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode # noqa: E501
+ Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode # noqa: E501
:return: The mode of this Position. # noqa: E501
:rtype: str
@@ -813,7 +828,7 @@ def mode(self):
def mode(self, mode):
"""Sets the mode of this Position.
- Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode # noqa: E501
+ Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode # noqa: E501
:param mode: The mode of this Position. # noqa: E501
:type: str
@@ -831,7 +846,7 @@ def mode(self, mode):
def cross_leverage_limit(self):
"""Gets the cross_leverage_limit of this Position. # noqa: E501
- Cross margin leverage(valid only when `leverage` is 0) # noqa: E501
+ Cross margin leverage (valid only when `leverage` is 0) # noqa: E501
:return: The cross_leverage_limit of this Position. # noqa: E501
:rtype: str
@@ -842,7 +857,7 @@ def cross_leverage_limit(self):
def cross_leverage_limit(self, cross_leverage_limit):
"""Sets the cross_leverage_limit of this Position.
- Cross margin leverage(valid only when `leverage` is 0) # noqa: E501
+ Cross margin leverage (valid only when `leverage` is 0) # noqa: E501
:param cross_leverage_limit: The cross_leverage_limit of this Position. # noqa: E501
:type: str
@@ -877,7 +892,7 @@ def update_time(self, update_time):
def update_id(self):
"""Gets the update_id of this Position. # noqa: E501
- Update id. Each time the position is updated, the value will be +1. # noqa: E501
+ Update ID. The value increments by 1 each time the position is updated # noqa: E501
:return: The update_id of this Position. # noqa: E501
:rtype: int
@@ -888,7 +903,7 @@ def update_id(self):
def update_id(self, update_id):
"""Sets the update_id of this Position.
- Update id. Each time the position is updated, the value will be +1. # noqa: E501
+ Update ID. The value increments by 1 each time the position is updated # noqa: E501
:param update_id: The update_id of this Position. # noqa: E501
:type: int
@@ -919,6 +934,75 @@ def open_time(self, open_time):
self._open_time = open_time
+ @property
+ def risk_limit_table(self):
+ """Gets the risk_limit_table of this Position. # noqa: E501
+
+ Risk limit table ID # noqa: E501
+
+ :return: The risk_limit_table of this Position. # noqa: E501
+ :rtype: str
+ """
+ return self._risk_limit_table
+
+ @risk_limit_table.setter
+ def risk_limit_table(self, risk_limit_table):
+ """Sets the risk_limit_table of this Position.
+
+ Risk limit table ID # noqa: E501
+
+ :param risk_limit_table: The risk_limit_table of this Position. # noqa: E501
+ :type: str
+ """
+
+ self._risk_limit_table = risk_limit_table
+
+ @property
+ def average_maintenance_rate(self):
+ """Gets the average_maintenance_rate of this Position. # noqa: E501
+
+ Average maintenance margin rate # noqa: E501
+
+ :return: The average_maintenance_rate of this Position. # noqa: E501
+ :rtype: str
+ """
+ return self._average_maintenance_rate
+
+ @average_maintenance_rate.setter
+ def average_maintenance_rate(self, average_maintenance_rate):
+ """Sets the average_maintenance_rate of this Position.
+
+ Average maintenance margin rate # noqa: E501
+
+ :param average_maintenance_rate: The average_maintenance_rate of this Position. # noqa: E501
+ :type: str
+ """
+
+ self._average_maintenance_rate = average_maintenance_rate
+
+ @property
+ def pid(self):
+ """Gets the pid of this Position. # noqa: E501
+
+ Sub-account position ID # noqa: E501
+
+ :return: The pid of this Position. # noqa: E501
+ :rtype: int
+ """
+ return self._pid
+
+ @pid.setter
+ def pid(self, pid):
+ """Sets the pid of this Position.
+
+ Sub-account position ID # noqa: E501
+
+ :param pid: The pid of this Position. # noqa: E501
+ :type: int
+ """
+
+ self._pid = pid
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/position_close.py b/gate_api/models/position_close.py
index cdca838..3ab116d 100644
--- a/gate_api/models/position_close.py
+++ b/gate_api/models/position_close.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -163,7 +163,7 @@ def contract(self, contract):
def side(self):
"""Gets the side of this PositionClose. # noqa: E501
- Position side, long or short # noqa: E501
+ Position side - `long`: Long position - `short`: Short position # noqa: E501
:return: The side of this PositionClose. # noqa: E501
:rtype: str
@@ -174,7 +174,7 @@ def side(self):
def side(self, side):
"""Sets the side of this PositionClose.
- Position side, long or short # noqa: E501
+ Position side - `long`: Long position - `short`: Short position # noqa: E501
:param side: The side of this PositionClose. # noqa: E501
:type: str
@@ -192,7 +192,7 @@ def side(self, side):
def pnl(self):
"""Gets the pnl of this PositionClose. # noqa: E501
- PNL # noqa: E501
+ PnL # noqa: E501
:return: The pnl of this PositionClose. # noqa: E501
:rtype: str
@@ -203,7 +203,7 @@ def pnl(self):
def pnl(self, pnl):
"""Sets the pnl of this PositionClose.
- PNL # noqa: E501
+ PnL # noqa: E501
:param pnl: The pnl of this PositionClose. # noqa: E501
:type: str
@@ -284,7 +284,7 @@ def pnl_fee(self, pnl_fee):
def text(self):
"""Gets the text of this PositionClose. # noqa: E501
- Text of close order # noqa: E501
+ Source of close order. See `order.text` field for specific values # noqa: E501
:return: The text of this PositionClose. # noqa: E501
:rtype: str
@@ -295,7 +295,7 @@ def text(self):
def text(self, text):
"""Sets the text of this PositionClose.
- Text of close order # noqa: E501
+ Source of close order. See `order.text` field for specific values # noqa: E501
:param text: The text of this PositionClose. # noqa: E501
:type: str
@@ -376,7 +376,7 @@ def first_open_time(self, first_open_time):
def long_price(self):
"""Gets the long_price of this PositionClose. # noqa: E501
- When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price. # noqa: E501
+ When side is 'long', it indicates the opening average price; when side is 'short', it indicates the closing average price # noqa: E501
:return: The long_price of this PositionClose. # noqa: E501
:rtype: str
@@ -387,7 +387,7 @@ def long_price(self):
def long_price(self, long_price):
"""Sets the long_price of this PositionClose.
- When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price. # noqa: E501
+ When side is 'long', it indicates the opening average price; when side is 'short', it indicates the closing average price # noqa: E501
:param long_price: The long_price of this PositionClose. # noqa: E501
:type: str
@@ -399,7 +399,7 @@ def long_price(self, long_price):
def short_price(self):
"""Gets the short_price of this PositionClose. # noqa: E501
- When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price # noqa: E501
+ When side is 'long', it indicates the closing average price; when side is 'short', it indicates the opening average price # noqa: E501
:return: The short_price of this PositionClose. # noqa: E501
:rtype: str
@@ -410,7 +410,7 @@ def short_price(self):
def short_price(self, short_price):
"""Sets the short_price of this PositionClose.
- When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price # noqa: E501
+ When side is 'long', it indicates the closing average price; when side is 'short', it indicates the opening average price # noqa: E501
:param short_price: The short_price of this PositionClose. # noqa: E501
:type: str
diff --git a/gate_api/models/position_close_order.py b/gate_api/models/position_close_order.py
index c4a4bd3..575f3cd 100644
--- a/gate_api/models/position_close_order.py
+++ b/gate_api/models/position_close_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -67,7 +67,7 @@ def __init__(self, id=None, price=None, is_liq=None, local_vars_configuration=No
def id(self):
"""Gets the id of this PositionCloseOrder. # noqa: E501
- Close order ID # noqa: E501
+ Order ID # noqa: E501
:return: The id of this PositionCloseOrder. # noqa: E501
:rtype: int
@@ -78,7 +78,7 @@ def id(self):
def id(self, id):
"""Sets the id of this PositionCloseOrder.
- Close order ID # noqa: E501
+ Order ID # noqa: E501
:param id: The id of this PositionCloseOrder. # noqa: E501
:type: int
@@ -90,7 +90,7 @@ def id(self, id):
def price(self):
"""Gets the price of this PositionCloseOrder. # noqa: E501
- Close order price # noqa: E501
+ Order price # noqa: E501
:return: The price of this PositionCloseOrder. # noqa: E501
:rtype: str
@@ -101,7 +101,7 @@ def price(self):
def price(self, price):
"""Sets the price of this PositionCloseOrder.
- Close order price # noqa: E501
+ Order price # noqa: E501
:param price: The price of this PositionCloseOrder. # noqa: E501
:type: str
@@ -113,7 +113,7 @@ def price(self, price):
def is_liq(self):
"""Gets the is_liq of this PositionCloseOrder. # noqa: E501
- Is the close order from liquidation # noqa: E501
+ Whether the close order is from liquidation # noqa: E501
:return: The is_liq of this PositionCloseOrder. # noqa: E501
:rtype: bool
@@ -124,7 +124,7 @@ def is_liq(self):
def is_liq(self, is_liq):
"""Sets the is_liq of this PositionCloseOrder.
- Is the close order from liquidation # noqa: E501
+ Whether the close order is from liquidation # noqa: E501
:param is_liq: The is_liq of this PositionCloseOrder. # noqa: E501
:type: bool
diff --git a/gate_api/models/profit_loss_range.py b/gate_api/models/profit_loss_range.py
index d433429..9f6b1e0 100644
--- a/gate_api/models/profit_loss_range.py
+++ b/gate_api/models/profit_loss_range.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -113,7 +113,7 @@ def implied_volatility_percentage(self, implied_volatility_percentage):
def profit_loss(self):
"""Gets the profit_loss of this ProfitLossRange. # noqa: E501
- PNL # noqa: E501
+ PnL # noqa: E501
:return: The profit_loss of this ProfitLossRange. # noqa: E501
:rtype: str
@@ -124,7 +124,7 @@ def profit_loss(self):
def profit_loss(self, profit_loss):
"""Sets the profit_loss of this ProfitLossRange.
- PNL # noqa: E501
+ PnL # noqa: E501
:param profit_loss: The profit_loss of this ProfitLossRange. # noqa: E501
:type: str
diff --git a/gate_api/models/rebate_user_info.py b/gate_api/models/rebate_user_info.py
index 44680a5..c93d182 100644
--- a/gate_api/models/rebate_user_info.py
+++ b/gate_api/models/rebate_user_info.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/repay_currency_res.py b/gate_api/models/repay_currency_res.py
index e1d0c9d..f818b19 100644
--- a/gate_api/models/repay_currency_res.py
+++ b/gate_api/models/repay_currency_res.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -82,7 +82,7 @@ def __init__(self, succeeded=None, label=None, message=None, currency=None, repa
def succeeded(self):
"""Gets the succeeded of this RepayCurrencyRes. # noqa: E501
- Has the repayment been successful # noqa: E501
+ Whether the repayment was successful # noqa: E501
:return: The succeeded of this RepayCurrencyRes. # noqa: E501
:rtype: bool
@@ -93,7 +93,7 @@ def succeeded(self):
def succeeded(self, succeeded):
"""Sets the succeeded of this RepayCurrencyRes.
- Has the repayment been successful # noqa: E501
+ Whether the repayment was successful # noqa: E501
:param succeeded: The succeeded of this RepayCurrencyRes. # noqa: E501
:type: bool
@@ -105,7 +105,7 @@ def succeeded(self, succeeded):
def label(self):
"""Gets the label of this RepayCurrencyRes. # noqa: E501
- Error identifier for unsuccessful operations; empty for successful. # noqa: E501
+ Error identifier for failed operations; empty when successful # noqa: E501
:return: The label of this RepayCurrencyRes. # noqa: E501
:rtype: str
@@ -116,7 +116,7 @@ def label(self):
def label(self, label):
"""Sets the label of this RepayCurrencyRes.
- Error identifier for unsuccessful operations; empty for successful. # noqa: E501
+ Error identifier for failed operations; empty when successful # noqa: E501
:param label: The label of this RepayCurrencyRes. # noqa: E501
:type: str
@@ -128,7 +128,7 @@ def label(self, label):
def message(self):
"""Gets the message of this RepayCurrencyRes. # noqa: E501
- Error description in case of operation failure; empty when successful. # noqa: E501
+ Error description for failed operations; empty when successful # noqa: E501
:return: The message of this RepayCurrencyRes. # noqa: E501
:rtype: str
@@ -139,7 +139,7 @@ def message(self):
def message(self, message):
"""Sets the message of this RepayCurrencyRes.
- Error description in case of operation failure; empty when successful. # noqa: E501
+ Error description for failed operations; empty when successful # noqa: E501
:param message: The message of this RepayCurrencyRes. # noqa: E501
:type: str
diff --git a/gate_api/models/repay_loan.py b/gate_api/models/repay_loan.py
index b60f41e..f8d97d6 100644
--- a/gate_api/models/repay_loan.py
+++ b/gate_api/models/repay_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -114,7 +114,7 @@ def repay_amount(self, repay_amount):
def repaid_all(self):
"""Gets the repaid_all of this RepayLoan. # noqa: E501
- Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. # noqa: E501
+ Repayment method, set to `true` for full repayment, and `false` for partial repayment; When partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. # noqa: E501
:return: The repaid_all of this RepayLoan. # noqa: E501
:rtype: bool
@@ -125,7 +125,7 @@ def repaid_all(self):
def repaid_all(self, repaid_all):
"""Sets the repaid_all of this RepayLoan.
- Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. # noqa: E501
+ Repayment method, set to `true` for full repayment, and `false` for partial repayment; When partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. # noqa: E501
:param repaid_all: The repaid_all of this RepayLoan. # noqa: E501
:type: bool
diff --git a/gate_api/models/repay_multi_loan.py b/gate_api/models/repay_multi_loan.py
index 086aee9..20c2385 100644
--- a/gate_api/models/repay_multi_loan.py
+++ b/gate_api/models/repay_multi_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/repay_record.py b/gate_api/models/repay_record.py
index 048d0e8..faef08c 100644
--- a/gate_api/models/repay_record.py
+++ b/gate_api/models/repay_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -209,7 +209,7 @@ def borrow_currency(self, borrow_currency):
def collateral_currency(self):
"""Gets the collateral_currency of this RepayRecord. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this RepayRecord. # noqa: E501
:rtype: str
@@ -220,7 +220,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this RepayRecord.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this RepayRecord. # noqa: E501
:type: str
@@ -232,7 +232,7 @@ def collateral_currency(self, collateral_currency):
def init_ltv(self):
"""Gets the init_ltv of this RepayRecord. # noqa: E501
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:return: The init_ltv of this RepayRecord. # noqa: E501
:rtype: str
@@ -243,7 +243,7 @@ def init_ltv(self):
def init_ltv(self, init_ltv):
"""Sets the init_ltv of this RepayRecord.
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:param init_ltv: The init_ltv of this RepayRecord. # noqa: E501
:type: str
@@ -370,7 +370,7 @@ def after_left_principal(self, after_left_principal):
def before_left_collateral(self):
"""Gets the before_left_collateral of this RepayRecord. # noqa: E501
- Collateral quantity before repayment # noqa: E501
+ Collateral amount before repayment # noqa: E501
:return: The before_left_collateral of this RepayRecord. # noqa: E501
:rtype: str
@@ -381,7 +381,7 @@ def before_left_collateral(self):
def before_left_collateral(self, before_left_collateral):
"""Sets the before_left_collateral of this RepayRecord.
- Collateral quantity before repayment # noqa: E501
+ Collateral amount before repayment # noqa: E501
:param before_left_collateral: The before_left_collateral of this RepayRecord. # noqa: E501
:type: str
@@ -393,7 +393,7 @@ def before_left_collateral(self, before_left_collateral):
def after_left_collateral(self):
"""Gets the after_left_collateral of this RepayRecord. # noqa: E501
- Collateral quantity after repayment # noqa: E501
+ Collateral amount after repayment # noqa: E501
:return: The after_left_collateral of this RepayRecord. # noqa: E501
:rtype: str
@@ -404,7 +404,7 @@ def after_left_collateral(self):
def after_left_collateral(self, after_left_collateral):
"""Sets the after_left_collateral of this RepayRecord.
- Collateral quantity after repayment # noqa: E501
+ Collateral amount after repayment # noqa: E501
:param after_left_collateral: The after_left_collateral of this RepayRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/repay_record_currency.py b/gate_api/models/repay_record_currency.py
index 7e78118..1f175bc 100644
--- a/gate_api/models/repay_record_currency.py
+++ b/gate_api/models/repay_record_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -151,7 +151,7 @@ def before_amount(self, before_amount):
def before_amount_usdt(self):
"""Gets the before_amount_usdt of this RepayRecordCurrency. # noqa: E501
- USDT Amount before the operation. # noqa: E501
+ USDT Amount before the operation # noqa: E501
:return: The before_amount_usdt of this RepayRecordCurrency. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def before_amount_usdt(self):
def before_amount_usdt(self, before_amount_usdt):
"""Sets the before_amount_usdt of this RepayRecordCurrency.
- USDT Amount before the operation. # noqa: E501
+ USDT Amount before the operation # noqa: E501
:param before_amount_usdt: The before_amount_usdt of this RepayRecordCurrency. # noqa: E501
:type: str
@@ -174,7 +174,7 @@ def before_amount_usdt(self, before_amount_usdt):
def after_amount(self):
"""Gets the after_amount of this RepayRecordCurrency. # noqa: E501
- Amount after the operation. # noqa: E501
+ Amount after the operation # noqa: E501
:return: The after_amount of this RepayRecordCurrency. # noqa: E501
:rtype: str
@@ -185,7 +185,7 @@ def after_amount(self):
def after_amount(self, after_amount):
"""Sets the after_amount of this RepayRecordCurrency.
- Amount after the operation. # noqa: E501
+ Amount after the operation # noqa: E501
:param after_amount: The after_amount of this RepayRecordCurrency. # noqa: E501
:type: str
@@ -197,7 +197,7 @@ def after_amount(self, after_amount):
def after_amount_usdt(self):
"""Gets the after_amount_usdt of this RepayRecordCurrency. # noqa: E501
- USDT Amount after the operation. # noqa: E501
+ USDT Amount after the operation # noqa: E501
:return: The after_amount_usdt of this RepayRecordCurrency. # noqa: E501
:rtype: str
@@ -208,7 +208,7 @@ def after_amount_usdt(self):
def after_amount_usdt(self, after_amount_usdt):
"""Sets the after_amount_usdt of this RepayRecordCurrency.
- USDT Amount after the operation. # noqa: E501
+ USDT Amount after the operation # noqa: E501
:param after_amount_usdt: The after_amount_usdt of this RepayRecordCurrency. # noqa: E501
:type: str
diff --git a/gate_api/models/repay_record_left_interest.py b/gate_api/models/repay_record_left_interest.py
index ee3603e..604dd12 100644
--- a/gate_api/models/repay_record_left_interest.py
+++ b/gate_api/models/repay_record_left_interest.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/repay_record_repaid_currency.py b/gate_api/models/repay_record_repaid_currency.py
index e9283cb..5aa54fd 100644
--- a/gate_api/models/repay_record_repaid_currency.py
+++ b/gate_api/models/repay_record_repaid_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -197,7 +197,7 @@ def repaid_interest(self, repaid_interest):
def repaid_amount_usdt(self):
"""Gets the repaid_amount_usdt of this RepayRecordRepaidCurrency. # noqa: E501
- Value of the repayment amount in USDT # noqa: E501
+ Repayment amount converted to USDT # noqa: E501
:return: The repaid_amount_usdt of this RepayRecordRepaidCurrency. # noqa: E501
:rtype: str
@@ -208,7 +208,7 @@ def repaid_amount_usdt(self):
def repaid_amount_usdt(self, repaid_amount_usdt):
"""Sets the repaid_amount_usdt of this RepayRecordRepaidCurrency.
- Value of the repayment amount in USDT # noqa: E501
+ Repayment amount converted to USDT # noqa: E501
:param repaid_amount_usdt: The repaid_amount_usdt of this RepayRecordRepaidCurrency. # noqa: E501
:type: str
diff --git a/gate_api/models/repay_record_total_interest.py b/gate_api/models/repay_record_total_interest.py
index 96e8c21..11e31c4 100644
--- a/gate_api/models/repay_record_total_interest.py
+++ b/gate_api/models/repay_record_total_interest.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/repay_request.py b/gate_api/models/repay_request.py
deleted file mode 100644
index 733275a..0000000
--- a/gate_api/models/repay_request.py
+++ /dev/null
@@ -1,216 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class RepayRequest(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'currency_pair': 'str',
- 'currency': 'str',
- 'mode': 'str',
- 'amount': 'str'
- }
-
- attribute_map = {
- 'currency_pair': 'currency_pair',
- 'currency': 'currency',
- 'mode': 'mode',
- 'amount': 'amount'
- }
-
- def __init__(self, currency_pair=None, currency=None, mode=None, amount=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, Configuration) -> None
- """RepayRequest - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._currency_pair = None
- self._currency = None
- self._mode = None
- self._amount = None
- self.discriminator = None
-
- self.currency_pair = currency_pair
- self.currency = currency
- self.mode = mode
- if amount is not None:
- self.amount = amount
-
- @property
- def currency_pair(self):
- """Gets the currency_pair of this RepayRequest. # noqa: E501
-
- Currency pair # noqa: E501
-
- :return: The currency_pair of this RepayRequest. # noqa: E501
- :rtype: str
- """
- return self._currency_pair
-
- @currency_pair.setter
- def currency_pair(self, currency_pair):
- """Sets the currency_pair of this RepayRequest.
-
- Currency pair # noqa: E501
-
- :param currency_pair: The currency_pair of this RepayRequest. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and currency_pair is None: # noqa: E501
- raise ValueError("Invalid value for `currency_pair`, must not be `None`") # noqa: E501
-
- self._currency_pair = currency_pair
-
- @property
- def currency(self):
- """Gets the currency of this RepayRequest. # noqa: E501
-
- Loan currency # noqa: E501
-
- :return: The currency of this RepayRequest. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this RepayRequest.
-
- Loan currency # noqa: E501
-
- :param currency: The currency of this RepayRequest. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
-
- self._currency = currency
-
- @property
- def mode(self):
- """Gets the mode of this RepayRequest. # noqa: E501
-
- Repay mode. all - repay all; partial - repay only some portion # noqa: E501
-
- :return: The mode of this RepayRequest. # noqa: E501
- :rtype: str
- """
- return self._mode
-
- @mode.setter
- def mode(self, mode):
- """Sets the mode of this RepayRequest.
-
- Repay mode. all - repay all; partial - repay only some portion # noqa: E501
-
- :param mode: The mode of this RepayRequest. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and mode is None: # noqa: E501
- raise ValueError("Invalid value for `mode`, must not be `None`") # noqa: E501
- allowed_values = ["all", "partial"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and mode not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `mode` ({0}), must be one of {1}" # noqa: E501
- .format(mode, allowed_values)
- )
-
- self._mode = mode
-
- @property
- def amount(self):
- """Gets the amount of this RepayRequest. # noqa: E501
-
- Repay amount. Required in `partial` mode # noqa: E501
-
- :return: The amount of this RepayRequest. # noqa: E501
- :rtype: str
- """
- return self._amount
-
- @amount.setter
- def amount(self, amount):
- """Sets the amount of this RepayRequest.
-
- Repay amount. Required in `partial` mode # noqa: E501
-
- :param amount: The amount of this RepayRequest. # noqa: E501
- :type: str
- """
-
- self._amount = amount
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, RepayRequest):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, RepayRequest):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/repay_resp.py b/gate_api/models/repay_resp.py
index 498e604..f35f6bc 100644
--- a/gate_api/models/repay_resp.py
+++ b/gate_api/models/repay_resp.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/repayment.py b/gate_api/models/repayment.py
deleted file mode 100644
index bc82cdc..0000000
--- a/gate_api/models/repayment.py
+++ /dev/null
@@ -1,207 +0,0 @@
-# coding: utf-8
-
-"""
- Gate API v4
-
- Welcome to Gate.io API 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. # noqa: E501
-
- Contact: support@mail.gate.io
- Generated by: https://openapi-generator.tech
-"""
-
-
-import pprint
-import re # noqa: F401
-
-import six
-
-from gate_api.configuration import Configuration
-
-
-class Repayment(object):
- """NOTE: This class is auto generated by OpenAPI Generator.
- Ref: https://openapi-generator.tech
-
- Do not edit the class manually.
- """
-
- """
- Attributes:
- openapi_types (dict): The key is attribute name
- and the value is attribute type.
- attribute_map (dict): The key is attribute name
- and the value is json key in definition.
- """
- openapi_types = {
- 'id': 'str',
- 'create_time': 'str',
- 'principal': 'str',
- 'interest': 'str'
- }
-
- attribute_map = {
- 'id': 'id',
- 'create_time': 'create_time',
- 'principal': 'principal',
- 'interest': 'interest'
- }
-
- def __init__(self, id=None, create_time=None, principal=None, interest=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, Configuration) -> None
- """Repayment - a model defined in OpenAPI""" # noqa: E501
- if local_vars_configuration is None:
- local_vars_configuration = Configuration()
- self.local_vars_configuration = local_vars_configuration
-
- self._id = None
- self._create_time = None
- self._principal = None
- self._interest = None
- self.discriminator = None
-
- if id is not None:
- self.id = id
- if create_time is not None:
- self.create_time = create_time
- if principal is not None:
- self.principal = principal
- if interest is not None:
- self.interest = interest
-
- @property
- def id(self):
- """Gets the id of this Repayment. # noqa: E501
-
- Loan record ID # noqa: E501
-
- :return: The id of this Repayment. # noqa: E501
- :rtype: str
- """
- return self._id
-
- @id.setter
- def id(self, id):
- """Sets the id of this Repayment.
-
- Loan record ID # noqa: E501
-
- :param id: The id of this Repayment. # noqa: E501
- :type: str
- """
-
- self._id = id
-
- @property
- def create_time(self):
- """Gets the create_time of this Repayment. # noqa: E501
-
- Repayment time # noqa: E501
-
- :return: The create_time of this Repayment. # noqa: E501
- :rtype: str
- """
- return self._create_time
-
- @create_time.setter
- def create_time(self, create_time):
- """Sets the create_time of this Repayment.
-
- Repayment time # noqa: E501
-
- :param create_time: The create_time of this Repayment. # noqa: E501
- :type: str
- """
-
- self._create_time = create_time
-
- @property
- def principal(self):
- """Gets the principal of this Repayment. # noqa: E501
-
- Repaid principal # noqa: E501
-
- :return: The principal of this Repayment. # noqa: E501
- :rtype: str
- """
- return self._principal
-
- @principal.setter
- def principal(self, principal):
- """Sets the principal of this Repayment.
-
- Repaid principal # noqa: E501
-
- :param principal: The principal of this Repayment. # noqa: E501
- :type: str
- """
-
- self._principal = principal
-
- @property
- def interest(self):
- """Gets the interest of this Repayment. # noqa: E501
-
- Repaid interest # noqa: E501
-
- :return: The interest of this Repayment. # noqa: E501
- :rtype: str
- """
- return self._interest
-
- @interest.setter
- def interest(self, interest):
- """Sets the interest of this Repayment.
-
- Repaid interest # noqa: E501
-
- :param interest: The interest of this Repayment. # noqa: E501
- :type: str
- """
-
- self._interest = interest
-
- def to_dict(self):
- """Returns the model properties as a dict"""
- result = {}
-
- for attr, _ in six.iteritems(self.openapi_types):
- value = getattr(self, attr)
- if isinstance(value, list):
- result[attr] = list(map(
- lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
- value
- ))
- elif hasattr(value, "to_dict"):
- result[attr] = value.to_dict()
- elif isinstance(value, dict):
- result[attr] = dict(map(
- lambda item: (item[0], item[1].to_dict())
- if hasattr(item[1], "to_dict") else item,
- value.items()
- ))
- else:
- result[attr] = value
-
- return result
-
- def to_str(self):
- """Returns the string representation of the model"""
- return pprint.pformat(self.to_dict())
-
- def __repr__(self):
- """For `print` and `pprint`"""
- return self.to_str()
-
- def __eq__(self, other):
- """Returns true if both objects are equal"""
- if not isinstance(other, Repayment):
- return False
-
- return self.to_dict() == other.to_dict()
-
- def __ne__(self, other):
- """Returns true if both objects are not equal"""
- if not isinstance(other, Repayment):
- return True
-
- return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/risk_units.py b/gate_api/models/risk_units.py
index 041184a..9ab5a17 100644
--- a/gate_api/models/risk_units.py
+++ b/gate_api/models/risk_units.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -115,7 +115,7 @@ def symbol(self, symbol):
def spot_in_use(self):
"""Gets the spot_in_use of this RiskUnits. # noqa: E501
- Spot hedging utilization # noqa: E501
+ Spot hedging occupied amount # noqa: E501
:return: The spot_in_use of this RiskUnits. # noqa: E501
:rtype: str
@@ -126,7 +126,7 @@ def spot_in_use(self):
def spot_in_use(self, spot_in_use):
"""Sets the spot_in_use of this RiskUnits.
- Spot hedging utilization # noqa: E501
+ Spot hedging occupied amount # noqa: E501
:param spot_in_use: The spot_in_use of this RiskUnits. # noqa: E501
:type: str
diff --git a/gate_api/models/saved_address.py b/gate_api/models/saved_address.py
index e5abe91..d82f14d 100644
--- a/gate_api/models/saved_address.py
+++ b/gate_api/models/saved_address.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/small_balance.py b/gate_api/models/small_balance.py
index 3aa0ec8..a31cd14 100644
--- a/gate_api/models/small_balance.py
+++ b/gate_api/models/small_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/small_balance_history.py b/gate_api/models/small_balance_history.py
index d770b75..da3a1d3 100644
--- a/gate_api/models/small_balance_history.py
+++ b/gate_api/models/small_balance_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -123,7 +123,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this SmallBalanceHistory. # noqa: E501
- amount # noqa: E501
+ Swap Amount # noqa: E501
:return: The amount of this SmallBalanceHistory. # noqa: E501
:rtype: str
@@ -134,7 +134,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this SmallBalanceHistory.
- amount # noqa: E501
+ Swap Amount # noqa: E501
:param amount: The amount of this SmallBalanceHistory. # noqa: E501
:type: str
diff --git a/gate_api/models/spot_account.py b/gate_api/models/spot_account.py
index 0c86114..e4f1aba 100644
--- a/gate_api/models/spot_account.py
+++ b/gate_api/models/spot_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/spot_account_book.py b/gate_api/models/spot_account_book.py
index c035422..081b281 100644
--- a/gate_api/models/spot_account_book.py
+++ b/gate_api/models/spot_account_book.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -39,6 +39,7 @@ class SpotAccountBook(object):
'change': 'str',
'balance': 'str',
'type': 'str',
+ 'code': 'str',
'text': 'str'
}
@@ -49,11 +50,12 @@ class SpotAccountBook(object):
'change': 'change',
'balance': 'balance',
'type': 'type',
+ 'code': 'code',
'text': 'text'
}
- def __init__(self, id=None, time=None, currency=None, change=None, balance=None, type=None, text=None, local_vars_configuration=None): # noqa: E501
- # type: (str, int, str, str, str, str, str, Configuration) -> None
+ def __init__(self, id=None, time=None, currency=None, change=None, balance=None, type=None, code=None, text=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, int, str, str, str, str, str, str, Configuration) -> None
"""SpotAccountBook - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -65,6 +67,7 @@ def __init__(self, id=None, time=None, currency=None, change=None, balance=None,
self._change = None
self._balance = None
self._type = None
+ self._code = None
self._text = None
self.discriminator = None
@@ -80,6 +83,8 @@ def __init__(self, id=None, time=None, currency=None, change=None, balance=None,
self.balance = balance
if type is not None:
self.type = type
+ if code is not None:
+ self.code = code
if text is not None:
self.text = text
@@ -202,7 +207,7 @@ def balance(self, balance):
def type(self):
"""Gets the type of this SpotAccountBook. # noqa: E501
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
+ Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
:return: The type of this SpotAccountBook. # noqa: E501
:rtype: str
@@ -213,7 +218,7 @@ def type(self):
def type(self, type):
"""Sets the type of this SpotAccountBook.
- Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
+ Account book type. Please refer to [account book type](#accountbook-type) for more detail # noqa: E501
:param type: The type of this SpotAccountBook. # noqa: E501
:type: str
@@ -221,6 +226,29 @@ def type(self, type):
self._type = type
+ @property
+ def code(self):
+ """Gets the code of this SpotAccountBook. # noqa: E501
+
+ Account change code, see [Asset Record Code] (Asset Record Code) # noqa: E501
+
+ :return: The code of this SpotAccountBook. # noqa: E501
+ :rtype: str
+ """
+ return self._code
+
+ @code.setter
+ def code(self, code):
+ """Sets the code of this SpotAccountBook.
+
+ Account change code, see [Asset Record Code] (Asset Record Code) # noqa: E501
+
+ :param code: The code of this SpotAccountBook. # noqa: E501
+ :type: str
+ """
+
+ self._code = code
+
@property
def text(self):
"""Gets the text of this SpotAccountBook. # noqa: E501
diff --git a/gate_api/models/spot_currency_chain.py b/gate_api/models/spot_currency_chain.py
new file mode 100644
index 0000000..7dc9a48
--- /dev/null
+++ b/gate_api/models/spot_currency_chain.py
@@ -0,0 +1,235 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class SpotCurrencyChain(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'name': 'str',
+ 'addr': 'str',
+ 'withdraw_disabled': 'bool',
+ 'withdraw_delayed': 'bool',
+ 'deposit_disabled': 'bool'
+ }
+
+ attribute_map = {
+ 'name': 'name',
+ 'addr': 'addr',
+ 'withdraw_disabled': 'withdraw_disabled',
+ 'withdraw_delayed': 'withdraw_delayed',
+ 'deposit_disabled': 'deposit_disabled'
+ }
+
+ def __init__(self, name=None, addr=None, withdraw_disabled=None, withdraw_delayed=None, deposit_disabled=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, bool, bool, bool, Configuration) -> None
+ """SpotCurrencyChain - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._name = None
+ self._addr = None
+ self._withdraw_disabled = None
+ self._withdraw_delayed = None
+ self._deposit_disabled = None
+ self.discriminator = None
+
+ if name is not None:
+ self.name = name
+ if addr is not None:
+ self.addr = addr
+ if withdraw_disabled is not None:
+ self.withdraw_disabled = withdraw_disabled
+ if withdraw_delayed is not None:
+ self.withdraw_delayed = withdraw_delayed
+ if deposit_disabled is not None:
+ self.deposit_disabled = deposit_disabled
+
+ @property
+ def name(self):
+ """Gets the name of this SpotCurrencyChain. # noqa: E501
+
+ Blockchain name # noqa: E501
+
+ :return: The name of this SpotCurrencyChain. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this SpotCurrencyChain.
+
+ Blockchain name # noqa: E501
+
+ :param name: The name of this SpotCurrencyChain. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def addr(self):
+ """Gets the addr of this SpotCurrencyChain. # noqa: E501
+
+ token address # noqa: E501
+
+ :return: The addr of this SpotCurrencyChain. # noqa: E501
+ :rtype: str
+ """
+ return self._addr
+
+ @addr.setter
+ def addr(self, addr):
+ """Sets the addr of this SpotCurrencyChain.
+
+ token address # noqa: E501
+
+ :param addr: The addr of this SpotCurrencyChain. # noqa: E501
+ :type: str
+ """
+
+ self._addr = addr
+
+ @property
+ def withdraw_disabled(self):
+ """Gets the withdraw_disabled of this SpotCurrencyChain. # noqa: E501
+
+ Whether currency's withdrawal is disabled # noqa: E501
+
+ :return: The withdraw_disabled of this SpotCurrencyChain. # noqa: E501
+ :rtype: bool
+ """
+ return self._withdraw_disabled
+
+ @withdraw_disabled.setter
+ def withdraw_disabled(self, withdraw_disabled):
+ """Sets the withdraw_disabled of this SpotCurrencyChain.
+
+ Whether currency's withdrawal is disabled # noqa: E501
+
+ :param withdraw_disabled: The withdraw_disabled of this SpotCurrencyChain. # noqa: E501
+ :type: bool
+ """
+
+ self._withdraw_disabled = withdraw_disabled
+
+ @property
+ def withdraw_delayed(self):
+ """Gets the withdraw_delayed of this SpotCurrencyChain. # noqa: E501
+
+ Whether currency's withdrawal is delayed # noqa: E501
+
+ :return: The withdraw_delayed of this SpotCurrencyChain. # noqa: E501
+ :rtype: bool
+ """
+ return self._withdraw_delayed
+
+ @withdraw_delayed.setter
+ def withdraw_delayed(self, withdraw_delayed):
+ """Sets the withdraw_delayed of this SpotCurrencyChain.
+
+ Whether currency's withdrawal is delayed # noqa: E501
+
+ :param withdraw_delayed: The withdraw_delayed of this SpotCurrencyChain. # noqa: E501
+ :type: bool
+ """
+
+ self._withdraw_delayed = withdraw_delayed
+
+ @property
+ def deposit_disabled(self):
+ """Gets the deposit_disabled of this SpotCurrencyChain. # noqa: E501
+
+ Whether currency's deposit is disabled # noqa: E501
+
+ :return: The deposit_disabled of this SpotCurrencyChain. # noqa: E501
+ :rtype: bool
+ """
+ return self._deposit_disabled
+
+ @deposit_disabled.setter
+ def deposit_disabled(self, deposit_disabled):
+ """Sets the deposit_disabled of this SpotCurrencyChain.
+
+ Whether currency's deposit is disabled # noqa: E501
+
+ :param deposit_disabled: The deposit_disabled of this SpotCurrencyChain. # noqa: E501
+ :type: bool
+ """
+
+ self._deposit_disabled = deposit_disabled
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, SpotCurrencyChain):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, SpotCurrencyChain):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/spot_fee.py b/gate_api/models/spot_fee.py
index 9f0308b..0d5327c 100644
--- a/gate_api/models/spot_fee.py
+++ b/gate_api/models/spot_fee.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -171,7 +171,7 @@ def maker_fee(self, maker_fee):
def gt_discount(self):
"""Gets the gt_discount of this SpotFee. # noqa: E501
- If GT deduction is enabled # noqa: E501
+ Whether GT deduction discount is enabled # noqa: E501
:return: The gt_discount of this SpotFee. # noqa: E501
:rtype: bool
@@ -182,7 +182,7 @@ def gt_discount(self):
def gt_discount(self, gt_discount):
"""Sets the gt_discount of this SpotFee.
- If GT deduction is enabled # noqa: E501
+ Whether GT deduction discount is enabled # noqa: E501
:param gt_discount: The gt_discount of this SpotFee. # noqa: E501
:type: bool
@@ -217,7 +217,7 @@ def gt_taker_fee(self, gt_taker_fee):
def gt_maker_fee(self):
"""Gets the gt_maker_fee of this SpotFee. # noqa: E501
- Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled # noqa: E501
+ Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled # noqa: E501
:return: The gt_maker_fee of this SpotFee. # noqa: E501
:rtype: str
@@ -228,7 +228,7 @@ def gt_maker_fee(self):
def gt_maker_fee(self, gt_maker_fee):
"""Sets the gt_maker_fee of this SpotFee.
- Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled # noqa: E501
+ Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled # noqa: E501
:param gt_maker_fee: The gt_maker_fee of this SpotFee. # noqa: E501
:type: str
@@ -263,7 +263,7 @@ def loan_fee(self, loan_fee):
def point_type(self):
"""Gets the point_type of this SpotFee. # noqa: E501
- Point type. 0 - Initial version. 1 - new version since 202009 # noqa: E501
+ Point card type: 0 - Original version, 1 - New version since 202009 # noqa: E501
:return: The point_type of this SpotFee. # noqa: E501
:rtype: str
@@ -274,7 +274,7 @@ def point_type(self):
def point_type(self, point_type):
"""Sets the point_type of this SpotFee.
- Point type. 0 - Initial version. 1 - new version since 202009 # noqa: E501
+ Point card type: 0 - Original version, 1 - New version since 202009 # noqa: E501
:param point_type: The point_type of this SpotFee. # noqa: E501
:type: str
diff --git a/gate_api/models/spot_insurance_history.py b/gate_api/models/spot_insurance_history.py
index 8ea0939..249bc6d 100644
--- a/gate_api/models/spot_insurance_history.py
+++ b/gate_api/models/spot_insurance_history.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def currency(self, currency):
def balance(self):
"""Gets the balance of this SpotInsuranceHistory. # noqa: E501
- 余额 # noqa: E501
+ Balance # noqa: E501
:return: The balance of this SpotInsuranceHistory. # noqa: E501
:rtype: str
@@ -101,7 +101,7 @@ def balance(self):
def balance(self, balance):
"""Sets the balance of this SpotInsuranceHistory.
- 余额 # noqa: E501
+ Balance # noqa: E501
:param balance: The balance of this SpotInsuranceHistory. # noqa: E501
:type: str
diff --git a/gate_api/models/spot_price_put_order.py b/gate_api/models/spot_price_put_order.py
index 895fa41..72cfa78 100644
--- a/gate_api/models/spot_price_put_order.py
+++ b/gate_api/models/spot_price_put_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -39,6 +39,8 @@ class SpotPricePutOrder(object):
'amount': 'str',
'account': 'str',
'time_in_force': 'str',
+ 'auto_borrow': 'bool',
+ 'auto_repay': 'bool',
'text': 'str'
}
@@ -49,11 +51,13 @@ class SpotPricePutOrder(object):
'amount': 'amount',
'account': 'account',
'time_in_force': 'time_in_force',
+ 'auto_borrow': 'auto_borrow',
+ 'auto_repay': 'auto_repay',
'text': 'text'
}
- def __init__(self, type='limit', side=None, price=None, amount=None, account='normal', time_in_force='gtc', text=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, type='limit', side=None, price=None, amount=None, account='normal', time_in_force='gtc', auto_borrow=False, auto_repay=False, text=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, bool, bool, str, Configuration) -> None
"""SpotPricePutOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -65,6 +69,8 @@ def __init__(self, type='limit', side=None, price=None, amount=None, account='no
self._amount = None
self._account = None
self._time_in_force = None
+ self._auto_borrow = None
+ self._auto_repay = None
self._text = None
self.discriminator = None
@@ -76,6 +82,10 @@ def __init__(self, type='limit', side=None, price=None, amount=None, account='no
self.account = account
if time_in_force is not None:
self.time_in_force = time_in_force
+ if auto_borrow is not None:
+ self.auto_borrow = auto_borrow
+ if auto_repay is not None:
+ self.auto_repay = auto_repay
if text is not None:
self.text = text
@@ -168,7 +178,7 @@ def price(self, price):
def amount(self):
"""Gets the amount of this SpotPricePutOrder. # noqa: E501
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:return: The amount of this SpotPricePutOrder. # noqa: E501
:rtype: str
@@ -179,7 +189,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this SpotPricePutOrder.
- When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` # noqa: E501
+ Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC` # noqa: E501
:param amount: The amount of this SpotPricePutOrder. # noqa: E501
:type: str
@@ -193,7 +203,7 @@ def amount(self, amount):
def account(self):
"""Gets the account of this SpotPricePutOrder. # noqa: E501
- Trading account type. Portfolio margin account must set to `cross_margin` - normal: spot trading - margin: margin trading - cross_margin: cross_margin trading # noqa: E501
+ Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account # noqa: E501
:return: The account of this SpotPricePutOrder. # noqa: E501
:rtype: str
@@ -204,14 +214,14 @@ def account(self):
def account(self, account):
"""Sets the account of this SpotPricePutOrder.
- Trading account type. Portfolio margin account must set to `cross_margin` - normal: spot trading - margin: margin trading - cross_margin: cross_margin trading # noqa: E501
+ Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account # noqa: E501
:param account: The account of this SpotPricePutOrder. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and account is None: # noqa: E501
raise ValueError("Invalid value for `account`, must not be `None`") # noqa: E501
- allowed_values = ["normal", "margin", "cross_margin"] # noqa: E501
+ allowed_values = ["normal", "margin", "unified"] # noqa: E501
if self.local_vars_configuration.client_side_validation and account not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `account` ({0}), must be one of {1}" # noqa: E501
@@ -249,11 +259,57 @@ def time_in_force(self, time_in_force):
self._time_in_force = time_in_force
+ @property
+ def auto_borrow(self):
+ """Gets the auto_borrow of this SpotPricePutOrder. # noqa: E501
+
+ Whether to borrow coins automatically # noqa: E501
+
+ :return: The auto_borrow of this SpotPricePutOrder. # noqa: E501
+ :rtype: bool
+ """
+ return self._auto_borrow
+
+ @auto_borrow.setter
+ def auto_borrow(self, auto_borrow):
+ """Sets the auto_borrow of this SpotPricePutOrder.
+
+ Whether to borrow coins automatically # noqa: E501
+
+ :param auto_borrow: The auto_borrow of this SpotPricePutOrder. # noqa: E501
+ :type: bool
+ """
+
+ self._auto_borrow = auto_borrow
+
+ @property
+ def auto_repay(self):
+ """Gets the auto_repay of this SpotPricePutOrder. # noqa: E501
+
+ Whether to repay the loan automatically # noqa: E501
+
+ :return: The auto_repay of this SpotPricePutOrder. # noqa: E501
+ :rtype: bool
+ """
+ return self._auto_repay
+
+ @auto_repay.setter
+ def auto_repay(self, auto_repay):
+ """Sets the auto_repay of this SpotPricePutOrder.
+
+ Whether to repay the loan automatically # noqa: E501
+
+ :param auto_repay: The auto_repay of this SpotPricePutOrder. # noqa: E501
+ :type: bool
+ """
+
+ self._auto_repay = auto_repay
+
@property
def text(self):
"""Gets the text of this SpotPricePutOrder. # noqa: E501
- The source of the order, including: - web: web - api: api - app: app # noqa: E501
+ The source of the order, including: - web: Web - api: API call - app: Mobile app # noqa: E501
:return: The text of this SpotPricePutOrder. # noqa: E501
:rtype: str
@@ -264,7 +320,7 @@ def text(self):
def text(self, text):
"""Sets the text of this SpotPricePutOrder.
- The source of the order, including: - web: web - api: api - app: app # noqa: E501
+ The source of the order, including: - web: Web - api: API call - app: Mobile app # noqa: E501
:param text: The text of this SpotPricePutOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/spot_price_trigger.py b/gate_api/models/spot_price_trigger.py
index 41f2447..5e49da6 100644
--- a/gate_api/models/spot_price_trigger.py
+++ b/gate_api/models/spot_price_trigger.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -89,7 +89,7 @@ def price(self, price):
def rule(self):
"""Gets the rule of this SpotPriceTrigger. # noqa: E501
- Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field # noqa: E501
+ Price trigger condition - `>=`: triggered when market price is greater than or equal to `price` - `<=`: triggered when market price is less than or equal to `price` # noqa: E501
:return: The rule of this SpotPriceTrigger. # noqa: E501
:rtype: str
@@ -100,7 +100,7 @@ def rule(self):
def rule(self, rule):
"""Sets the rule of this SpotPriceTrigger.
- Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field # noqa: E501
+ Price trigger condition - `>=`: triggered when market price is greater than or equal to `price` - `<=`: triggered when market price is less than or equal to `price` # noqa: E501
:param rule: The rule of this SpotPriceTrigger. # noqa: E501
:type: str
@@ -120,7 +120,7 @@ def rule(self, rule):
def expiration(self):
"""Gets the expiration of this SpotPriceTrigger. # noqa: E501
- How long (in seconds) to wait for the condition to be triggered before cancelling the order. # noqa: E501
+ Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout # noqa: E501
:return: The expiration of this SpotPriceTrigger. # noqa: E501
:rtype: int
@@ -131,7 +131,7 @@ def expiration(self):
def expiration(self, expiration):
"""Sets the expiration of this SpotPriceTrigger.
- How long (in seconds) to wait for the condition to be triggered before cancelling the order. # noqa: E501
+ Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout # noqa: E501
:param expiration: The expiration of this SpotPriceTrigger. # noqa: E501
:type: int
diff --git a/gate_api/models/spot_price_triggered_order.py b/gate_api/models/spot_price_triggered_order.py
index 36d9bfe..69e14df 100644
--- a/gate_api/models/spot_price_triggered_order.py
+++ b/gate_api/models/spot_price_triggered_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -191,7 +191,7 @@ def user(self, user):
def market(self):
"""Gets the market of this SpotPriceTriggeredOrder. # noqa: E501
- Currency pair # noqa: E501
+ Market # noqa: E501
:return: The market of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -202,7 +202,7 @@ def market(self):
def market(self, market):
"""Sets the market of this SpotPriceTriggeredOrder.
- Currency pair # noqa: E501
+ Market # noqa: E501
:param market: The market of this SpotPriceTriggeredOrder. # noqa: E501
:type: str
@@ -216,7 +216,7 @@ def market(self, market):
def ctime(self):
"""Gets the ctime of this SpotPriceTriggeredOrder. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The ctime of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: int
@@ -227,7 +227,7 @@ def ctime(self):
def ctime(self, ctime):
"""Sets the ctime of this SpotPriceTriggeredOrder.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param ctime: The ctime of this SpotPriceTriggeredOrder. # noqa: E501
:type: int
@@ -239,7 +239,7 @@ def ctime(self, ctime):
def ftime(self):
"""Gets the ftime of this SpotPriceTriggeredOrder. # noqa: E501
- Finished time # noqa: E501
+ End time # noqa: E501
:return: The ftime of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: int
@@ -250,7 +250,7 @@ def ftime(self):
def ftime(self, ftime):
"""Sets the ftime of this SpotPriceTriggeredOrder.
- Finished time # noqa: E501
+ End time # noqa: E501
:param ftime: The ftime of this SpotPriceTriggeredOrder. # noqa: E501
:type: int
@@ -262,7 +262,7 @@ def ftime(self, ftime):
def fired_order_id(self):
"""Gets the fired_order_id of this SpotPriceTriggeredOrder. # noqa: E501
- ID of the newly created order on condition triggered # noqa: E501
+ ID of the order created after trigger # noqa: E501
:return: The fired_order_id of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: int
@@ -273,7 +273,7 @@ def fired_order_id(self):
def fired_order_id(self, fired_order_id):
"""Sets the fired_order_id of this SpotPriceTriggeredOrder.
- ID of the newly created order on condition triggered # noqa: E501
+ ID of the order created after trigger # noqa: E501
:param fired_order_id: The fired_order_id of this SpotPriceTriggeredOrder. # noqa: E501
:type: int
@@ -285,7 +285,7 @@ def fired_order_id(self, fired_order_id):
def status(self):
"""Gets the status of this SpotPriceTriggeredOrder. # noqa: E501
- Status - open: open - cancelled: being manually cancelled - finish: successfully executed - failed: failed to execute - expired - expired # noqa: E501
+ Status - open: Running - cancelled: Manually cancelled - finish: Successfully completed - failed: Failed to execute - expired: Expired # noqa: E501
:return: The status of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -296,7 +296,7 @@ def status(self):
def status(self, status):
"""Sets the status of this SpotPriceTriggeredOrder.
- Status - open: open - cancelled: being manually cancelled - finish: successfully executed - failed: failed to execute - expired - expired # noqa: E501
+ Status - open: Running - cancelled: Manually cancelled - finish: Successfully completed - failed: Failed to execute - expired: Expired # noqa: E501
:param status: The status of this SpotPriceTriggeredOrder. # noqa: E501
:type: str
@@ -308,7 +308,7 @@ def status(self, status):
def reason(self):
"""Gets the reason of this SpotPriceTriggeredOrder. # noqa: E501
- Additional remarks on how the order was finished # noqa: E501
+ Additional description of how the order was completed # noqa: E501
:return: The reason of this SpotPriceTriggeredOrder. # noqa: E501
:rtype: str
@@ -319,7 +319,7 @@ def reason(self):
def reason(self, reason):
"""Sets the reason of this SpotPriceTriggeredOrder.
- Additional remarks on how the order was finished # noqa: E501
+ Additional description of how the order was completed # noqa: E501
:param reason: The reason of this SpotPriceTriggeredOrder. # noqa: E501
:type: str
diff --git a/gate_api/models/stp_group.py b/gate_api/models/stp_group.py
index 70da380..52ba304 100644
--- a/gate_api/models/stp_group.py
+++ b/gate_api/models/stp_group.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -142,7 +142,7 @@ def creator_id(self, creator_id):
def create_time(self):
"""Gets the create_time of this StpGroup. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this StpGroup. # noqa: E501
:rtype: int
@@ -153,7 +153,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this StpGroup.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this StpGroup. # noqa: E501
:type: int
diff --git a/gate_api/models/stp_group_user.py b/gate_api/models/stp_group_user.py
index 776f7b2..e6584f3 100644
--- a/gate_api/models/stp_group_user.py
+++ b/gate_api/models/stp_group_user.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -113,7 +113,7 @@ def stp_id(self, stp_id):
def create_time(self):
"""Gets the create_time of this StpGroupUser. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this StpGroupUser. # noqa: E501
:rtype: int
@@ -124,7 +124,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this StpGroupUser.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this StpGroupUser. # noqa: E501
:type: int
diff --git a/gate_api/models/structured_buy.py b/gate_api/models/structured_buy.py
index 4c495b1..285adf7 100644
--- a/gate_api/models/structured_buy.py
+++ b/gate_api/models/structured_buy.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -62,7 +62,7 @@ def __init__(self, pid=None, amount=None, local_vars_configuration=None): # noq
def pid(self):
"""Gets the pid of this StructuredBuy. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The pid of this StructuredBuy. # noqa: E501
:rtype: str
@@ -73,7 +73,7 @@ def pid(self):
def pid(self, pid):
"""Sets the pid of this StructuredBuy.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param pid: The pid of this StructuredBuy. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def pid(self, pid):
def amount(self):
"""Gets the amount of this StructuredBuy. # noqa: E501
- Purchase Amount # noqa: E501
+ Buy Quantity # noqa: E501
:return: The amount of this StructuredBuy. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this StructuredBuy.
- Purchase Amount # noqa: E501
+ Buy Quantity # noqa: E501
:param amount: The amount of this StructuredBuy. # noqa: E501
:type: str
diff --git a/gate_api/models/structured_get_project_list.py b/gate_api/models/structured_get_project_list.py
index a051a06..664a021 100644
--- a/gate_api/models/structured_get_project_list.py
+++ b/gate_api/models/structured_get_project_list.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -112,7 +112,7 @@ def __init__(self, id=None, type=None, name_en=None, investment_coin=None, inves
def id(self):
"""Gets the id of this StructuredGetProjectList. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The id of this StructuredGetProjectList. # noqa: E501
:rtype: int
@@ -123,7 +123,7 @@ def id(self):
def id(self, id):
"""Sets the id of this StructuredGetProjectList.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param id: The id of this StructuredGetProjectList. # noqa: E501
:type: int
@@ -135,7 +135,7 @@ def id(self, id):
def type(self):
"""Gets the type of this StructuredGetProjectList. # noqa: E501
- product type: `SharkFin2.0`-Shark Fin2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball # noqa: E501
+ Product Type: `SharkFin2.0`-Shark Fin 2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball # noqa: E501
:return: The type of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -146,7 +146,7 @@ def type(self):
def type(self, type):
"""Sets the type of this StructuredGetProjectList.
- product type: `SharkFin2.0`-Shark Fin2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball # noqa: E501
+ Product Type: `SharkFin2.0`-Shark Fin 2.0 `BullishSharkFin`-Bullish Shark Fin `BearishSharkFin`-Bearish Shark Fin `DoubleNoTouch`-Double No-Touch `RangeAccrual`-Range Accrual `SnowBall`-Snow Ball # noqa: E501
:param type: The type of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -158,7 +158,7 @@ def type(self, type):
def name_en(self):
"""Gets the name_en of this StructuredGetProjectList. # noqa: E501
- name # noqa: E501
+ Product Name # noqa: E501
:return: The name_en of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -169,7 +169,7 @@ def name_en(self):
def name_en(self, name_en):
"""Sets the name_en of this StructuredGetProjectList.
- name # noqa: E501
+ Product Name # noqa: E501
:param name_en: The name_en of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -181,7 +181,7 @@ def name_en(self, name_en):
def investment_coin(self):
"""Gets the investment_coin of this StructuredGetProjectList. # noqa: E501
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:return: The investment_coin of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -192,7 +192,7 @@ def investment_coin(self):
def investment_coin(self, investment_coin):
"""Sets the investment_coin of this StructuredGetProjectList.
- Investment Currency # noqa: E501
+ Investment Token # noqa: E501
:param investment_coin: The investment_coin of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -204,7 +204,7 @@ def investment_coin(self, investment_coin):
def investment_period(self):
"""Gets the investment_period of this StructuredGetProjectList. # noqa: E501
- Investment term # noqa: E501
+ Investment Period # noqa: E501
:return: The investment_period of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -215,7 +215,7 @@ def investment_period(self):
def investment_period(self, investment_period):
"""Sets the investment_period of this StructuredGetProjectList.
- Investment term # noqa: E501
+ Investment Period # noqa: E501
:param investment_period: The investment_period of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -227,7 +227,7 @@ def investment_period(self, investment_period):
def min_annual_rate(self):
"""Gets the min_annual_rate of this StructuredGetProjectList. # noqa: E501
- Minimum annual rate # noqa: E501
+ Minimum Annual Rate # noqa: E501
:return: The min_annual_rate of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -238,7 +238,7 @@ def min_annual_rate(self):
def min_annual_rate(self, min_annual_rate):
"""Sets the min_annual_rate of this StructuredGetProjectList.
- Minimum annual rate # noqa: E501
+ Minimum Annual Rate # noqa: E501
:param min_annual_rate: The min_annual_rate of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -250,7 +250,7 @@ def min_annual_rate(self, min_annual_rate):
def mid_annual_rate(self):
"""Gets the mid_annual_rate of this StructuredGetProjectList. # noqa: E501
- Intermediate annual rate # noqa: E501
+ Intermediate Annual Rate # noqa: E501
:return: The mid_annual_rate of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -261,7 +261,7 @@ def mid_annual_rate(self):
def mid_annual_rate(self, mid_annual_rate):
"""Sets the mid_annual_rate of this StructuredGetProjectList.
- Intermediate annual rate # noqa: E501
+ Intermediate Annual Rate # noqa: E501
:param mid_annual_rate: The mid_annual_rate of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -273,7 +273,7 @@ def mid_annual_rate(self, mid_annual_rate):
def max_annual_rate(self):
"""Gets the max_annual_rate of this StructuredGetProjectList. # noqa: E501
- Maximum annual rate # noqa: E501
+ Maximum Annual Rate # noqa: E501
:return: The max_annual_rate of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -284,7 +284,7 @@ def max_annual_rate(self):
def max_annual_rate(self, max_annual_rate):
"""Sets the max_annual_rate of this StructuredGetProjectList.
- Maximum annual rate # noqa: E501
+ Maximum Annual Rate # noqa: E501
:param max_annual_rate: The max_annual_rate of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -296,7 +296,7 @@ def max_annual_rate(self, max_annual_rate):
def watch_market(self):
"""Gets the watch_market of this StructuredGetProjectList. # noqa: E501
- Watch market # noqa: E501
+ Underlying Market # noqa: E501
:return: The watch_market of this StructuredGetProjectList. # noqa: E501
:rtype: str
@@ -307,7 +307,7 @@ def watch_market(self):
def watch_market(self, watch_market):
"""Sets the watch_market of this StructuredGetProjectList.
- Watch market # noqa: E501
+ Underlying Market # noqa: E501
:param watch_market: The watch_market of this StructuredGetProjectList. # noqa: E501
:type: str
@@ -319,7 +319,7 @@ def watch_market(self, watch_market):
def start_time(self):
"""Gets the start_time of this StructuredGetProjectList. # noqa: E501
- start time # noqa: E501
+ Start Time # noqa: E501
:return: The start_time of this StructuredGetProjectList. # noqa: E501
:rtype: int
@@ -330,7 +330,7 @@ def start_time(self):
def start_time(self, start_time):
"""Sets the start_time of this StructuredGetProjectList.
- start time # noqa: E501
+ Start Time # noqa: E501
:param start_time: The start_time of this StructuredGetProjectList. # noqa: E501
:type: int
@@ -342,7 +342,7 @@ def start_time(self, start_time):
def end_time(self):
"""Gets the end_time of this StructuredGetProjectList. # noqa: E501
- Finished time # noqa: E501
+ End time # noqa: E501
:return: The end_time of this StructuredGetProjectList. # noqa: E501
:rtype: int
@@ -353,7 +353,7 @@ def end_time(self):
def end_time(self, end_time):
"""Sets the end_time of this StructuredGetProjectList.
- Finished time # noqa: E501
+ End time # noqa: E501
:param end_time: The end_time of this StructuredGetProjectList. # noqa: E501
:type: int
diff --git a/gate_api/models/structured_order_list.py b/gate_api/models/structured_order_list.py
index 43911a9..4f75222 100644
--- a/gate_api/models/structured_order_list.py
+++ b/gate_api/models/structured_order_list.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -110,7 +110,7 @@ def id(self, id):
def pid(self):
"""Gets the pid of this StructuredOrderList. # noqa: E501
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:return: The pid of this StructuredOrderList. # noqa: E501
:rtype: str
@@ -121,7 +121,7 @@ def pid(self):
def pid(self, pid):
"""Sets the pid of this StructuredOrderList.
- Plan ID # noqa: E501
+ Product ID # noqa: E501
:param pid: The pid of this StructuredOrderList. # noqa: E501
:type: str
diff --git a/gate_api/models/sub_account.py b/gate_api/models/sub_account.py
index f94b684..ad8b79e 100644
--- a/gate_api/models/sub_account.py
+++ b/gate_api/models/sub_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -91,7 +91,7 @@ def __init__(self, remark=None, login_name=None, password=None, email=None, stat
def remark(self):
"""Gets the remark of this SubAccount. # noqa: E501
- custom text # noqa: E501
+ Remark # noqa: E501
:return: The remark of this SubAccount. # noqa: E501
:rtype: str
@@ -102,7 +102,7 @@ def remark(self):
def remark(self, remark):
"""Sets the remark of this SubAccount.
- custom text # noqa: E501
+ Remark # noqa: E501
:param remark: The remark of this SubAccount. # noqa: E501
:type: str
@@ -114,7 +114,7 @@ def remark(self, remark):
def login_name(self):
"""Gets the login_name of this SubAccount. # noqa: E501
- Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters # noqa: E501
+ Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters # noqa: E501
:return: The login_name of this SubAccount. # noqa: E501
:rtype: str
@@ -125,7 +125,7 @@ def login_name(self):
def login_name(self, login_name):
"""Sets the login_name of this SubAccount.
- Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters # noqa: E501
+ Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters # noqa: E501
:param login_name: The login_name of this SubAccount. # noqa: E501
:type: str
@@ -185,7 +185,7 @@ def email(self, email):
def state(self):
"""Gets the state of this SubAccount. # noqa: E501
- State: 1-normal, 2-locked\" # noqa: E501
+ Sub-account status: 1-normal, 2-locked # noqa: E501
:return: The state of this SubAccount. # noqa: E501
:rtype: int
@@ -196,7 +196,7 @@ def state(self):
def state(self, state):
"""Sets the state of this SubAccount.
- State: 1-normal, 2-locked\" # noqa: E501
+ Sub-account status: 1-normal, 2-locked # noqa: E501
:param state: The state of this SubAccount. # noqa: E501
:type: int
@@ -208,7 +208,7 @@ def state(self, state):
def type(self):
"""Gets the type of this SubAccount. # noqa: E501
- \"Sub-account type: 1 - sub-account, 3 - cross margin account # noqa: E501
+ Sub-account type: 1-Regular sub-account, 3-Cross margin sub-account # noqa: E501
:return: The type of this SubAccount. # noqa: E501
:rtype: int
@@ -219,7 +219,7 @@ def type(self):
def type(self, type):
"""Sets the type of this SubAccount.
- \"Sub-account type: 1 - sub-account, 3 - cross margin account # noqa: E501
+ Sub-account type: 1-Regular sub-account, 3-Cross margin sub-account # noqa: E501
:param type: The type of this SubAccount. # noqa: E501
:type: int
@@ -231,7 +231,7 @@ def type(self, type):
def user_id(self):
"""Gets the user_id of this SubAccount. # noqa: E501
- The user id of the sub-account # noqa: E501
+ Sub-account user ID # noqa: E501
:return: The user_id of this SubAccount. # noqa: E501
:rtype: int
@@ -242,7 +242,7 @@ def user_id(self):
def user_id(self, user_id):
"""Sets the user_id of this SubAccount.
- The user id of the sub-account # noqa: E501
+ Sub-account user ID # noqa: E501
:param user_id: The user_id of this SubAccount. # noqa: E501
:type: int
diff --git a/gate_api/models/sub_account_balance.py b/gate_api/models/sub_account_balance.py
index 4f321cc..7af2fb8 100644
--- a/gate_api/models/sub_account_balance.py
+++ b/gate_api/models/sub_account_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/sub_account_cross_margin_balance.py b/gate_api/models/sub_account_cross_margin_balance.py
index cfb4539..524294f 100644
--- a/gate_api/models/sub_account_cross_margin_balance.py
+++ b/gate_api/models/sub_account_cross_margin_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/sub_account_futures_balance.py b/gate_api/models/sub_account_futures_balance.py
index 24b1e2b..c499b88 100644
--- a/gate_api/models/sub_account_futures_balance.py
+++ b/gate_api/models/sub_account_futures_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/sub_account_key.py b/gate_api/models/sub_account_key.py
index b2b2bae..c644eb6 100644
--- a/gate_api/models/sub_account_key.py
+++ b/gate_api/models/sub_account_key.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -33,7 +33,7 @@ class SubAccountKey(object):
and the value is json key in definition.
"""
openapi_types = {
- 'user_id': 'str',
+ 'user_id': 'int',
'mode': 'int',
'name': 'str',
'perms': 'list[SubAccountKeyPerms]',
@@ -59,7 +59,7 @@ class SubAccountKey(object):
}
def __init__(self, user_id=None, mode=None, name=None, perms=None, ip_whitelist=None, key=None, state=None, created_at=None, updated_at=None, last_access=None, local_vars_configuration=None): # noqa: E501
- # type: (str, int, str, list[SubAccountKeyPerms], list[str], str, int, int, int, int, Configuration) -> None
+ # type: (int, int, str, list[SubAccountKeyPerms], list[str], str, int, int, int, int, Configuration) -> None
"""SubAccountKey - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -105,7 +105,7 @@ def user_id(self):
User ID # noqa: E501
:return: The user_id of this SubAccountKey. # noqa: E501
- :rtype: str
+ :rtype: int
"""
return self._user_id
@@ -116,7 +116,7 @@ def user_id(self, user_id):
User ID # noqa: E501
:param user_id: The user_id of this SubAccountKey. # noqa: E501
- :type: str
+ :type: int
"""
self._user_id = user_id
@@ -148,7 +148,7 @@ def mode(self, mode):
def name(self):
"""Gets the name of this SubAccountKey. # noqa: E501
- API key name # noqa: E501
+ API Key Name # noqa: E501
:return: The name of this SubAccountKey. # noqa: E501
:rtype: str
@@ -159,7 +159,7 @@ def name(self):
def name(self, name):
"""Sets the name of this SubAccountKey.
- API key name # noqa: E501
+ API Key Name # noqa: E501
:param name: The name of this SubAccountKey. # noqa: E501
:type: str
@@ -192,7 +192,7 @@ def perms(self, perms):
def ip_whitelist(self):
"""Gets the ip_whitelist of this SubAccountKey. # noqa: E501
- ip white list (list will be removed if no value is passed) # noqa: E501
+ IP whitelist (list will be cleared if no value is passed) # noqa: E501
:return: The ip_whitelist of this SubAccountKey. # noqa: E501
:rtype: list[str]
@@ -203,7 +203,7 @@ def ip_whitelist(self):
def ip_whitelist(self, ip_whitelist):
"""Sets the ip_whitelist of this SubAccountKey.
- ip white list (list will be removed if no value is passed) # noqa: E501
+ IP whitelist (list will be cleared if no value is passed) # noqa: E501
:param ip_whitelist: The ip_whitelist of this SubAccountKey. # noqa: E501
:type: list[str]
@@ -238,7 +238,7 @@ def key(self, key):
def state(self):
"""Gets the state of this SubAccountKey. # noqa: E501
- State 1 - normal 2 - locked 3 - frozen # noqa: E501
+ Status: 1-Normal 2-Frozen 3-Locked # noqa: E501
:return: The state of this SubAccountKey. # noqa: E501
:rtype: int
@@ -249,7 +249,7 @@ def state(self):
def state(self, state):
"""Sets the state of this SubAccountKey.
- State 1 - normal 2 - locked 3 - frozen # noqa: E501
+ Status: 1-Normal 2-Frozen 3-Locked # noqa: E501
:param state: The state of this SubAccountKey. # noqa: E501
:type: int
@@ -261,7 +261,7 @@ def state(self, state):
def created_at(self):
"""Gets the created_at of this SubAccountKey. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The created_at of this SubAccountKey. # noqa: E501
:rtype: int
@@ -272,7 +272,7 @@ def created_at(self):
def created_at(self, created_at):
"""Sets the created_at of this SubAccountKey.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param created_at: The created_at of this SubAccountKey. # noqa: E501
:type: int
@@ -284,7 +284,7 @@ def created_at(self, created_at):
def updated_at(self):
"""Gets the updated_at of this SubAccountKey. # noqa: E501
- Last update time # noqa: E501
+ Last Update Time # noqa: E501
:return: The updated_at of this SubAccountKey. # noqa: E501
:rtype: int
@@ -295,7 +295,7 @@ def updated_at(self):
def updated_at(self, updated_at):
"""Sets the updated_at of this SubAccountKey.
- Last update time # noqa: E501
+ Last Update Time # noqa: E501
:param updated_at: The updated_at of this SubAccountKey. # noqa: E501
:type: int
@@ -307,7 +307,7 @@ def updated_at(self, updated_at):
def last_access(self):
"""Gets the last_access of this SubAccountKey. # noqa: E501
- Last access time # noqa: E501
+ Last Access Time # noqa: E501
:return: The last_access of this SubAccountKey. # noqa: E501
:rtype: int
@@ -318,7 +318,7 @@ def last_access(self):
def last_access(self, last_access):
"""Sets the last_access of this SubAccountKey.
- Last access time # noqa: E501
+ Last Access Time # noqa: E501
:param last_access: The last_access of this SubAccountKey. # noqa: E501
:type: int
diff --git a/gate_api/models/sub_account_key_perms.py b/gate_api/models/sub_account_key_perms.py
index f989ba7..fa9a9f3 100644
--- a/gate_api/models/sub_account_key_perms.py
+++ b/gate_api/models/sub_account_key_perms.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -62,7 +62,7 @@ def __init__(self, name=None, read_only=None, local_vars_configuration=None): #
def name(self):
"""Gets the name of this SubAccountKeyPerms. # noqa: E501
- Permission function name (no value will be cleared) - wallet: wallet - spot: spot/leverage - futures: perpetual contract - delivery: delivery contract - earn: financial management - custody: custody - options: options - account: account information - loan: loan - margin: leverage - unified: unified account - copy: copy # noqa: E501
+ Permission function name (no value will be cleared) - wallet: wallet - spot: spot/margin - futures: perpetual contract - delivery: delivery contract - earn: earn - custody: custody - options: options - account: account information - loan: lending - margin: margin - unified: unified account - copy: copy trading # noqa: E501
:return: The name of this SubAccountKeyPerms. # noqa: E501
:rtype: str
@@ -73,7 +73,7 @@ def name(self):
def name(self, name):
"""Sets the name of this SubAccountKeyPerms.
- Permission function name (no value will be cleared) - wallet: wallet - spot: spot/leverage - futures: perpetual contract - delivery: delivery contract - earn: financial management - custody: custody - options: options - account: account information - loan: loan - margin: leverage - unified: unified account - copy: copy # noqa: E501
+ Permission function name (no value will be cleared) - wallet: wallet - spot: spot/margin - futures: perpetual contract - delivery: delivery contract - earn: earn - custody: custody - options: options - account: account information - loan: lending - margin: margin - unified: unified account - copy: copy trading # noqa: E501
:param name: The name of this SubAccountKeyPerms. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def name(self, name):
def read_only(self):
"""Gets the read_only of this SubAccountKeyPerms. # noqa: E501
- read only # noqa: E501
+ Read Only # noqa: E501
:return: The read_only of this SubAccountKeyPerms. # noqa: E501
:rtype: bool
@@ -96,7 +96,7 @@ def read_only(self):
def read_only(self, read_only):
"""Sets the read_only of this SubAccountKeyPerms.
- read only # noqa: E501
+ Read Only # noqa: E501
:param read_only: The read_only of this SubAccountKeyPerms. # noqa: E501
:type: bool
diff --git a/gate_api/models/sub_account_margin_balance.py b/gate_api/models/sub_account_margin_balance.py
index bb0edf3..22d8025 100644
--- a/gate_api/models/sub_account_margin_balance.py
+++ b/gate_api/models/sub_account_margin_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/sub_account_to_sub_account.py b/gate_api/models/sub_account_to_sub_account.py
index 3880810..c082521 100644
--- a/gate_api/models/sub_account_to_sub_account.py
+++ b/gate_api/models/sub_account_to_sub_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -106,7 +106,7 @@ def currency(self, currency):
def sub_account_type(self):
"""Gets the sub_account_type of this SubAccountToSubAccount. # noqa: E501
- Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) # noqa: E501
+ Transfer from account (deprecated, use `sub_account_from_type` and `sub_account_to_type` instead) # noqa: E501
:return: The sub_account_type of this SubAccountToSubAccount. # noqa: E501
:rtype: str
@@ -117,7 +117,7 @@ def sub_account_type(self):
def sub_account_type(self, sub_account_type):
"""Sets the sub_account_type of this SubAccountToSubAccount.
- Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) # noqa: E501
+ Transfer from account (deprecated, use `sub_account_from_type` and `sub_account_to_type` instead) # noqa: E501
:param sub_account_type: The sub_account_type of this SubAccountToSubAccount. # noqa: E501
:type: str
@@ -154,7 +154,7 @@ def sub_account_from(self, sub_account_from):
def sub_account_from_type(self):
"""Gets the sub_account_from_type of this SubAccountToSubAccount. # noqa: E501
- The sub-account's outgoing trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account. # noqa: E501
+ Source sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
:return: The sub_account_from_type of this SubAccountToSubAccount. # noqa: E501
:rtype: str
@@ -165,7 +165,7 @@ def sub_account_from_type(self):
def sub_account_from_type(self, sub_account_from_type):
"""Sets the sub_account_from_type of this SubAccountToSubAccount.
- The sub-account's outgoing trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account. # noqa: E501
+ Source sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
:param sub_account_from_type: The sub_account_from_type of this SubAccountToSubAccount. # noqa: E501
:type: str
@@ -204,7 +204,7 @@ def sub_account_to(self, sub_account_to):
def sub_account_to_type(self):
"""Gets the sub_account_to_type of this SubAccountToSubAccount. # noqa: E501
- The sub-account's incoming trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
:return: The sub_account_to_type of this SubAccountToSubAccount. # noqa: E501
:rtype: str
@@ -215,7 +215,7 @@ def sub_account_to_type(self):
def sub_account_to_type(self, sub_account_to_type):
"""Sets the sub_account_to_type of this SubAccountToSubAccount.
- The sub-account's incoming trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account # noqa: E501
:param sub_account_to_type: The sub_account_to_type of this SubAccountToSubAccount. # noqa: E501
:type: str
diff --git a/gate_api/models/sub_account_transfer.py b/gate_api/models/sub_account_transfer.py
index 0497ece..9ab7c79 100644
--- a/gate_api/models/sub_account_transfer.py
+++ b/gate_api/models/sub_account_transfer.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -33,86 +33,46 @@ class SubAccountTransfer(object):
and the value is json key in definition.
"""
openapi_types = {
- 'currency': 'str',
'sub_account': 'str',
- 'direction': 'str',
+ 'sub_account_type': 'str',
+ 'currency': 'str',
'amount': 'str',
- 'uid': 'str',
- 'client_order_id': 'str',
- 'timest': 'str',
- 'source': 'str',
- 'sub_account_type': 'str'
+ 'direction': 'str',
+ 'client_order_id': 'str'
}
attribute_map = {
- 'currency': 'currency',
'sub_account': 'sub_account',
- 'direction': 'direction',
+ 'sub_account_type': 'sub_account_type',
+ 'currency': 'currency',
'amount': 'amount',
- 'uid': 'uid',
- 'client_order_id': 'client_order_id',
- 'timest': 'timest',
- 'source': 'source',
- 'sub_account_type': 'sub_account_type'
+ 'direction': 'direction',
+ 'client_order_id': 'client_order_id'
}
- def __init__(self, currency=None, sub_account=None, direction=None, amount=None, uid=None, client_order_id=None, timest=None, source=None, sub_account_type='spot', local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, sub_account=None, sub_account_type='spot', currency=None, amount=None, direction=None, client_order_id=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, Configuration) -> None
"""SubAccountTransfer - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._currency = None
self._sub_account = None
- self._direction = None
+ self._sub_account_type = None
+ self._currency = None
self._amount = None
- self._uid = None
+ self._direction = None
self._client_order_id = None
- self._timest = None
- self._source = None
- self._sub_account_type = None
self.discriminator = None
- self.currency = currency
self.sub_account = sub_account
- self.direction = direction
+ if sub_account_type is not None:
+ self.sub_account_type = sub_account_type
+ self.currency = currency
self.amount = amount
- if uid is not None:
- self.uid = uid
+ self.direction = direction
if client_order_id is not None:
self.client_order_id = client_order_id
- if timest is not None:
- self.timest = timest
- if source is not None:
- self.source = source
- if sub_account_type is not None:
- self.sub_account_type = sub_account_type
-
- @property
- def currency(self):
- """Gets the currency of this SubAccountTransfer. # noqa: E501
-
- Transfer currency name # noqa: E501
-
- :return: The currency of this SubAccountTransfer. # noqa: E501
- :rtype: str
- """
- return self._currency
-
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this SubAccountTransfer.
-
- Transfer currency name # noqa: E501
-
- :param currency: The currency of this SubAccountTransfer. # noqa: E501
- :type: str
- """
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
-
- self._currency = currency
@property
def sub_account(self):
@@ -140,29 +100,52 @@ def sub_account(self, sub_account):
self._sub_account = sub_account
@property
- def direction(self):
- """Gets the direction of this SubAccountTransfer. # noqa: E501
+ def sub_account_type(self):
+ """Gets the sub_account_type of this SubAccountTransfer. # noqa: E501
- Transfer direction. to - transfer into sub account; from - transfer out from sub account # noqa: E501
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account # noqa: E501
- :return: The direction of this SubAccountTransfer. # noqa: E501
+ :return: The sub_account_type of this SubAccountTransfer. # noqa: E501
:rtype: str
"""
- return self._direction
+ return self._sub_account_type
- @direction.setter
- def direction(self, direction):
- """Sets the direction of this SubAccountTransfer.
+ @sub_account_type.setter
+ def sub_account_type(self, sub_account_type):
+ """Sets the sub_account_type of this SubAccountTransfer.
- Transfer direction. to - transfer into sub account; from - transfer out from sub account # noqa: E501
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account # noqa: E501
- :param direction: The direction of this SubAccountTransfer. # noqa: E501
+ :param sub_account_type: The sub_account_type of this SubAccountTransfer. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and direction is None: # noqa: E501
- raise ValueError("Invalid value for `direction`, must not be `None`") # noqa: E501
- self._direction = direction
+ self._sub_account_type = sub_account_type
+
+ @property
+ def currency(self):
+ """Gets the currency of this SubAccountTransfer. # noqa: E501
+
+ Transfer currency name # noqa: E501
+
+ :return: The currency of this SubAccountTransfer. # noqa: E501
+ :rtype: str
+ """
+ return self._currency
+
+ @currency.setter
+ def currency(self, currency):
+ """Sets the currency of this SubAccountTransfer.
+
+ Transfer currency name # noqa: E501
+
+ :param currency: The currency of this SubAccountTransfer. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
+ raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
+
+ self._currency = currency
@property
def amount(self):
@@ -190,33 +173,35 @@ def amount(self, amount):
self._amount = amount
@property
- def uid(self):
- """Gets the uid of this SubAccountTransfer. # noqa: E501
+ def direction(self):
+ """Gets the direction of this SubAccountTransfer. # noqa: E501
- Main account user ID # noqa: E501
+ Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501
- :return: The uid of this SubAccountTransfer. # noqa: E501
+ :return: The direction of this SubAccountTransfer. # noqa: E501
:rtype: str
"""
- return self._uid
+ return self._direction
- @uid.setter
- def uid(self, uid):
- """Sets the uid of this SubAccountTransfer.
+ @direction.setter
+ def direction(self, direction):
+ """Sets the direction of this SubAccountTransfer.
- Main account user ID # noqa: E501
+ Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501
- :param uid: The uid of this SubAccountTransfer. # noqa: E501
+ :param direction: The direction of this SubAccountTransfer. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and direction is None: # noqa: E501
+ raise ValueError("Invalid value for `direction`, must not be `None`") # noqa: E501
- self._uid = uid
+ self._direction = direction
@property
def client_order_id(self):
"""Gets the client_order_id of this SubAccountTransfer. # noqa: E501
- The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters. # noqa: E501
+ Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters # noqa: E501
:return: The client_order_id of this SubAccountTransfer. # noqa: E501
:rtype: str
@@ -227,7 +212,7 @@ def client_order_id(self):
def client_order_id(self, client_order_id):
"""Sets the client_order_id of this SubAccountTransfer.
- The custom ID provided by the customer serves as a safeguard against duplicate transfers. It can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_', with a length ranging from 1 to 64 characters. # noqa: E501
+ Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters # noqa: E501
:param client_order_id: The client_order_id of this SubAccountTransfer. # noqa: E501
:type: str
@@ -235,75 +220,6 @@ def client_order_id(self, client_order_id):
self._client_order_id = client_order_id
- @property
- def timest(self):
- """Gets the timest of this SubAccountTransfer. # noqa: E501
-
- Transfer timestamp # noqa: E501
-
- :return: The timest of this SubAccountTransfer. # noqa: E501
- :rtype: str
- """
- return self._timest
-
- @timest.setter
- def timest(self, timest):
- """Sets the timest of this SubAccountTransfer.
-
- Transfer timestamp # noqa: E501
-
- :param timest: The timest of this SubAccountTransfer. # noqa: E501
- :type: str
- """
-
- self._timest = timest
-
- @property
- def source(self):
- """Gets the source of this SubAccountTransfer. # noqa: E501
-
- Where the operation is initiated from # noqa: E501
-
- :return: The source of this SubAccountTransfer. # noqa: E501
- :rtype: str
- """
- return self._source
-
- @source.setter
- def source(self, source):
- """Sets the source of this SubAccountTransfer.
-
- Where the operation is initiated from # noqa: E501
-
- :param source: The source of this SubAccountTransfer. # noqa: E501
- :type: str
- """
-
- self._source = source
-
- @property
- def sub_account_type(self):
- """Gets the sub_account_type of this SubAccountTransfer. # noqa: E501
-
- Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account # noqa: E501
-
- :return: The sub_account_type of this SubAccountTransfer. # noqa: E501
- :rtype: str
- """
- return self._sub_account_type
-
- @sub_account_type.setter
- def sub_account_type(self, sub_account_type):
- """Sets the sub_account_type of this SubAccountTransfer.
-
- Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account # noqa: E501
-
- :param sub_account_type: The sub_account_type of this SubAccountTransfer. # noqa: E501
- :type: str
- """
-
- self._sub_account_type = sub_account_type
-
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/sub_account_transfer_record_item.py b/gate_api/models/sub_account_transfer_record_item.py
new file mode 100644
index 0000000..650a595
--- /dev/null
+++ b/gate_api/models/sub_account_transfer_record_item.py
@@ -0,0 +1,379 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class SubAccountTransferRecordItem(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'timest': 'str',
+ 'uid': 'str',
+ 'sub_account': 'str',
+ 'sub_account_type': 'str',
+ 'currency': 'str',
+ 'amount': 'str',
+ 'direction': 'str',
+ 'source': 'str',
+ 'client_order_id': 'str',
+ 'status': 'str'
+ }
+
+ attribute_map = {
+ 'timest': 'timest',
+ 'uid': 'uid',
+ 'sub_account': 'sub_account',
+ 'sub_account_type': 'sub_account_type',
+ 'currency': 'currency',
+ 'amount': 'amount',
+ 'direction': 'direction',
+ 'source': 'source',
+ 'client_order_id': 'client_order_id',
+ 'status': 'status'
+ }
+
+ def __init__(self, timest=None, uid=None, sub_account=None, sub_account_type='spot', currency=None, amount=None, direction=None, source=None, client_order_id=None, status=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ """SubAccountTransferRecordItem - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._timest = None
+ self._uid = None
+ self._sub_account = None
+ self._sub_account_type = None
+ self._currency = None
+ self._amount = None
+ self._direction = None
+ self._source = None
+ self._client_order_id = None
+ self._status = None
+ self.discriminator = None
+
+ if timest is not None:
+ self.timest = timest
+ if uid is not None:
+ self.uid = uid
+ self.sub_account = sub_account
+ if sub_account_type is not None:
+ self.sub_account_type = sub_account_type
+ self.currency = currency
+ self.amount = amount
+ self.direction = direction
+ if source is not None:
+ self.source = source
+ if client_order_id is not None:
+ self.client_order_id = client_order_id
+ if status is not None:
+ self.status = status
+
+ @property
+ def timest(self):
+ """Gets the timest of this SubAccountTransferRecordItem. # noqa: E501
+
+ Transfer timestamp # noqa: E501
+
+ :return: The timest of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._timest
+
+ @timest.setter
+ def timest(self, timest):
+ """Sets the timest of this SubAccountTransferRecordItem.
+
+ Transfer timestamp # noqa: E501
+
+ :param timest: The timest of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._timest = timest
+
+ @property
+ def uid(self):
+ """Gets the uid of this SubAccountTransferRecordItem. # noqa: E501
+
+ Main account user ID # noqa: E501
+
+ :return: The uid of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._uid
+
+ @uid.setter
+ def uid(self, uid):
+ """Sets the uid of this SubAccountTransferRecordItem.
+
+ Main account user ID # noqa: E501
+
+ :param uid: The uid of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._uid = uid
+
+ @property
+ def sub_account(self):
+ """Gets the sub_account of this SubAccountTransferRecordItem. # noqa: E501
+
+ Sub account user ID # noqa: E501
+
+ :return: The sub_account of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._sub_account
+
+ @sub_account.setter
+ def sub_account(self, sub_account):
+ """Sets the sub_account of this SubAccountTransferRecordItem.
+
+ Sub account user ID # noqa: E501
+
+ :param sub_account: The sub_account of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and sub_account is None: # noqa: E501
+ raise ValueError("Invalid value for `sub_account`, must not be `None`") # noqa: E501
+
+ self._sub_account = sub_account
+
+ @property
+ def sub_account_type(self):
+ """Gets the sub_account_type of this SubAccountTransferRecordItem. # noqa: E501
+
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account # noqa: E501
+
+ :return: The sub_account_type of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._sub_account_type
+
+ @sub_account_type.setter
+ def sub_account_type(self, sub_account_type):
+ """Sets the sub_account_type of this SubAccountTransferRecordItem.
+
+ Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account # noqa: E501
+
+ :param sub_account_type: The sub_account_type of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._sub_account_type = sub_account_type
+
+ @property
+ def currency(self):
+ """Gets the currency of this SubAccountTransferRecordItem. # noqa: E501
+
+ Transfer currency name # noqa: E501
+
+ :return: The currency of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._currency
+
+ @currency.setter
+ def currency(self, currency):
+ """Sets the currency of this SubAccountTransferRecordItem.
+
+ Transfer currency name # noqa: E501
+
+ :param currency: The currency of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
+ raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
+
+ self._currency = currency
+
+ @property
+ def amount(self):
+ """Gets the amount of this SubAccountTransferRecordItem. # noqa: E501
+
+ Transfer amount # noqa: E501
+
+ :return: The amount of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._amount
+
+ @amount.setter
+ def amount(self, amount):
+ """Sets the amount of this SubAccountTransferRecordItem.
+
+ Transfer amount # noqa: E501
+
+ :param amount: The amount of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
+ raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
+
+ self._amount = amount
+
+ @property
+ def direction(self):
+ """Gets the direction of this SubAccountTransferRecordItem. # noqa: E501
+
+ Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501
+
+ :return: The direction of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._direction
+
+ @direction.setter
+ def direction(self, direction):
+ """Sets the direction of this SubAccountTransferRecordItem.
+
+ Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501
+
+ :param direction: The direction of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and direction is None: # noqa: E501
+ raise ValueError("Invalid value for `direction`, must not be `None`") # noqa: E501
+
+ self._direction = direction
+
+ @property
+ def source(self):
+ """Gets the source of this SubAccountTransferRecordItem. # noqa: E501
+
+ Source of the transfer operation # noqa: E501
+
+ :return: The source of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source):
+ """Sets the source of this SubAccountTransferRecordItem.
+
+ Source of the transfer operation # noqa: E501
+
+ :param source: The source of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._source = source
+
+ @property
+ def client_order_id(self):
+ """Gets the client_order_id of this SubAccountTransferRecordItem. # noqa: E501
+
+ Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters # noqa: E501
+
+ :return: The client_order_id of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._client_order_id
+
+ @client_order_id.setter
+ def client_order_id(self, client_order_id):
+ """Sets the client_order_id of this SubAccountTransferRecordItem.
+
+ Customer-defined ID to prevent duplicate transfers. Can be a combination of letters (case-sensitive), numbers, hyphens '-', and underscores '_'. Can be pure letters or pure numbers with length between 1-64 characters # noqa: E501
+
+ :param client_order_id: The client_order_id of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._client_order_id = client_order_id
+
+ @property
+ def status(self):
+ """Gets the status of this SubAccountTransferRecordItem. # noqa: E501
+
+ Sub-account transfer record status, currently only 'success' # noqa: E501
+
+ :return: The status of this SubAccountTransferRecordItem. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this SubAccountTransferRecordItem.
+
+ Sub-account transfer record status, currently only 'success' # noqa: E501
+
+ :param status: The status of this SubAccountTransferRecordItem. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, SubAccountTransferRecordItem):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, SubAccountTransferRecordItem):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/sub_cross_margin_account.py b/gate_api/models/sub_cross_margin_account.py
index 4678b68..0e43bca 100644
--- a/gate_api/models/sub_cross_margin_account.py
+++ b/gate_api/models/sub_cross_margin_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -35,7 +35,7 @@ class SubCrossMarginAccount(object):
openapi_types = {
'user_id': 'int',
'locked': 'bool',
- 'balances': 'dict(str, CrossMarginBalance1)',
+ 'balances': 'dict(str, CrossMarginBalance)',
'total': 'str',
'borrowed': 'str',
'borrowed_net': 'str',
@@ -71,7 +71,7 @@ class SubCrossMarginAccount(object):
}
def __init__(self, user_id=None, locked=None, balances=None, total=None, borrowed=None, borrowed_net=None, net=None, leverage=None, interest=None, risk=None, total_initial_margin=None, total_margin_balance=None, total_maintenance_margin=None, total_initial_margin_rate=None, total_maintenance_margin_rate=None, total_available_margin=None, local_vars_configuration=None): # noqa: E501
- # type: (int, bool, dict(str, CrossMarginBalance1), str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ # type: (int, bool, dict(str, CrossMarginBalance), str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
"""SubCrossMarginAccount - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -132,7 +132,7 @@ def __init__(self, user_id=None, locked=None, balances=None, total=None, borrowe
def user_id(self):
"""Gets the user_id of this SubCrossMarginAccount. # noqa: E501
- User ID of the cross margin account. 0 means that the subaccount has not yet opened a cross margin account # noqa: E501
+ Cross margin account user ID. 0 means this sub-account has not yet opened a cross margin account # noqa: E501
:return: The user_id of this SubCrossMarginAccount. # noqa: E501
:rtype: int
@@ -143,7 +143,7 @@ def user_id(self):
def user_id(self, user_id):
"""Sets the user_id of this SubCrossMarginAccount.
- User ID of the cross margin account. 0 means that the subaccount has not yet opened a cross margin account # noqa: E501
+ Cross margin account user ID. 0 means this sub-account has not yet opened a cross margin account # noqa: E501
:param user_id: The user_id of this SubCrossMarginAccount. # noqa: E501
:type: int
@@ -155,7 +155,7 @@ def user_id(self, user_id):
def locked(self):
"""Gets the locked of this SubCrossMarginAccount. # noqa: E501
- Whether account is locked # noqa: E501
+ Whether the account is locked # noqa: E501
:return: The locked of this SubCrossMarginAccount. # noqa: E501
:rtype: bool
@@ -166,7 +166,7 @@ def locked(self):
def locked(self, locked):
"""Sets the locked of this SubCrossMarginAccount.
- Whether account is locked # noqa: E501
+ Whether the account is locked # noqa: E501
:param locked: The locked of this SubCrossMarginAccount. # noqa: E501
:type: bool
@@ -180,7 +180,7 @@ def balances(self):
:return: The balances of this SubCrossMarginAccount. # noqa: E501
- :rtype: dict(str, CrossMarginBalance1)
+ :rtype: dict(str, CrossMarginBalance)
"""
return self._balances
@@ -190,7 +190,7 @@ def balances(self, balances):
:param balances: The balances of this SubCrossMarginAccount. # noqa: E501
- :type: dict(str, CrossMarginBalance1)
+ :type: dict(str, CrossMarginBalance)
"""
self._balances = balances
@@ -245,7 +245,7 @@ def borrowed(self, borrowed):
def borrowed_net(self):
"""Gets the borrowed_net of this SubCrossMarginAccount. # noqa: E501
- Total borrowed value in USDT * borrowed factor # noqa: E501
+ Total borrowed value in USDT * leverage factor # noqa: E501
:return: The borrowed_net of this SubCrossMarginAccount. # noqa: E501
:rtype: str
@@ -256,7 +256,7 @@ def borrowed_net(self):
def borrowed_net(self, borrowed_net):
"""Sets the borrowed_net of this SubCrossMarginAccount.
- Total borrowed value in USDT * borrowed factor # noqa: E501
+ Total borrowed value in USDT * leverage factor # noqa: E501
:param borrowed_net: The borrowed_net of this SubCrossMarginAccount. # noqa: E501
:type: str
@@ -314,7 +314,7 @@ def leverage(self, leverage):
def interest(self):
"""Gets the interest of this SubCrossMarginAccount. # noqa: E501
- Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
+ Total unpaid interest in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
:return: The interest of this SubCrossMarginAccount. # noqa: E501
:rtype: str
@@ -325,7 +325,7 @@ def interest(self):
def interest(self, interest):
"""Sets the interest of this SubCrossMarginAccount.
- Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
+ Total unpaid interest in USDT, i.e., the sum of all currencies' `interest*price*discount` # noqa: E501
:param interest: The interest of this SubCrossMarginAccount. # noqa: E501
:type: str
@@ -337,7 +337,7 @@ def interest(self, interest):
def risk(self):
"""Gets the risk of this SubCrossMarginAccount. # noqa: E501
- Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
+ Risk rate. When it falls below 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
:return: The risk of this SubCrossMarginAccount. # noqa: E501
:rtype: str
@@ -348,7 +348,7 @@ def risk(self):
def risk(self, risk):
"""Sets the risk of this SubCrossMarginAccount.
- Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
+ Risk rate. When it falls below 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` # noqa: E501
:param risk: The risk of this SubCrossMarginAccount. # noqa: E501
:type: str
diff --git a/gate_api/models/sub_user_mode.py b/gate_api/models/sub_user_mode.py
index 8253743..2c73505 100644
--- a/gate_api/models/sub_user_mode.py
+++ b/gate_api/models/sub_user_mode.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def user_id(self, user_id):
def is_unified(self):
"""Gets the is_unified of this SubUserMode. # noqa: E501
- Is it a unified account? # noqa: E501
+ Whether it is a unified account # noqa: E501
:return: The is_unified of this SubUserMode. # noqa: E501
:rtype: bool
@@ -101,7 +101,7 @@ def is_unified(self):
def is_unified(self, is_unified):
"""Sets the is_unified of this SubUserMode.
- Is it a unified account? # noqa: E501
+ Whether it is a unified account # noqa: E501
:param is_unified: The is_unified of this SubUserMode. # noqa: E501
:type: bool
@@ -113,7 +113,7 @@ def is_unified(self, is_unified):
def mode(self):
"""Gets the mode of this SubUserMode. # noqa: E501
- Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
:return: The mode of this SubUserMode. # noqa: E501
:rtype: str
@@ -124,7 +124,7 @@ def mode(self):
def mode(self, mode):
"""Sets the mode of this SubUserMode.
- Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode # noqa: E501
:param mode: The mode of this SubUserMode. # noqa: E501
:type: str
diff --git a/gate_api/models/swap_coin.py b/gate_api/models/swap_coin.py
new file mode 100644
index 0000000..14d56e4
--- /dev/null
+++ b/gate_api/models/swap_coin.py
@@ -0,0 +1,210 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class SwapCoin(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'coin': 'str',
+ 'side': 'str',
+ 'amount': 'str',
+ 'pid': 'int'
+ }
+
+ attribute_map = {
+ 'coin': 'coin',
+ 'side': 'side',
+ 'amount': 'amount',
+ 'pid': 'pid'
+ }
+
+ def __init__(self, coin=None, side=None, amount=None, pid=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, int, Configuration) -> None
+ """SwapCoin - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._coin = None
+ self._side = None
+ self._amount = None
+ self._pid = None
+ self.discriminator = None
+
+ self.coin = coin
+ self.side = side
+ self.amount = amount
+ if pid is not None:
+ self.pid = pid
+
+ @property
+ def coin(self):
+ """Gets the coin of this SwapCoin. # noqa: E501
+
+ Currency # noqa: E501
+
+ :return: The coin of this SwapCoin. # noqa: E501
+ :rtype: str
+ """
+ return self._coin
+
+ @coin.setter
+ def coin(self, coin):
+ """Sets the coin of this SwapCoin.
+
+ Currency # noqa: E501
+
+ :param coin: The coin of this SwapCoin. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and coin is None: # noqa: E501
+ raise ValueError("Invalid value for `coin`, must not be `None`") # noqa: E501
+
+ self._coin = coin
+
+ @property
+ def side(self):
+ """Gets the side of this SwapCoin. # noqa: E501
+
+ 0 - Stake 1 - Redeem # noqa: E501
+
+ :return: The side of this SwapCoin. # noqa: E501
+ :rtype: str
+ """
+ return self._side
+
+ @side.setter
+ def side(self, side):
+ """Sets the side of this SwapCoin.
+
+ 0 - Stake 1 - Redeem # noqa: E501
+
+ :param side: The side of this SwapCoin. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and side is None: # noqa: E501
+ raise ValueError("Invalid value for `side`, must not be `None`") # noqa: E501
+
+ self._side = side
+
+ @property
+ def amount(self):
+ """Gets the amount of this SwapCoin. # noqa: E501
+
+ Size # noqa: E501
+
+ :return: The amount of this SwapCoin. # noqa: E501
+ :rtype: str
+ """
+ return self._amount
+
+ @amount.setter
+ def amount(self, amount):
+ """Sets the amount of this SwapCoin.
+
+ Size # noqa: E501
+
+ :param amount: The amount of this SwapCoin. # noqa: E501
+ :type: str
+ """
+ if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
+ raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
+
+ self._amount = amount
+
+ @property
+ def pid(self):
+ """Gets the pid of this SwapCoin. # noqa: E501
+
+ DeFi-type Mining Protocol Identifier # noqa: E501
+
+ :return: The pid of this SwapCoin. # noqa: E501
+ :rtype: int
+ """
+ return self._pid
+
+ @pid.setter
+ def pid(self, pid):
+ """Sets the pid of this SwapCoin.
+
+ DeFi-type Mining Protocol Identifier # noqa: E501
+
+ :param pid: The pid of this SwapCoin. # noqa: E501
+ :type: int
+ """
+
+ self._pid = pid
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, SwapCoin):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, SwapCoin):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/swap_coin_struct.py b/gate_api/models/swap_coin_struct.py
new file mode 100644
index 0000000..8a7ae01
--- /dev/null
+++ b/gate_api/models/swap_coin_struct.py
@@ -0,0 +1,515 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class SwapCoinStruct(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'id': 'int',
+ 'pid': 'int',
+ 'uid': 'int',
+ 'coin': 'str',
+ 'type': 'int',
+ 'subtype': 'str',
+ 'amount': 'str',
+ 'exchange_rate': 'str',
+ 'exchange_amount': 'str',
+ 'update_stamp': 'int',
+ 'create_stamp': 'int',
+ 'status': 'int',
+ 'protocol_type': 'int',
+ 'client_order_id': 'str',
+ 'source': 'str'
+ }
+
+ attribute_map = {
+ 'id': 'id',
+ 'pid': 'pid',
+ 'uid': 'uid',
+ 'coin': 'coin',
+ 'type': 'type',
+ 'subtype': 'subtype',
+ 'amount': 'amount',
+ 'exchange_rate': 'exchange_rate',
+ 'exchange_amount': 'exchange_amount',
+ 'update_stamp': 'updateStamp',
+ 'create_stamp': 'createStamp',
+ 'status': 'status',
+ 'protocol_type': 'protocol_type',
+ 'client_order_id': 'client_order_id',
+ 'source': 'source'
+ }
+
+ def __init__(self, id=None, pid=None, uid=None, coin=None, type=None, subtype=None, amount=None, exchange_rate=None, exchange_amount=None, update_stamp=None, create_stamp=None, status=None, protocol_type=None, client_order_id=None, source=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, int, str, int, str, str, str, str, int, int, int, int, str, str, Configuration) -> None
+ """SwapCoinStruct - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._id = None
+ self._pid = None
+ self._uid = None
+ self._coin = None
+ self._type = None
+ self._subtype = None
+ self._amount = None
+ self._exchange_rate = None
+ self._exchange_amount = None
+ self._update_stamp = None
+ self._create_stamp = None
+ self._status = None
+ self._protocol_type = None
+ self._client_order_id = None
+ self._source = None
+ self.discriminator = None
+
+ if id is not None:
+ self.id = id
+ if pid is not None:
+ self.pid = pid
+ if uid is not None:
+ self.uid = uid
+ if coin is not None:
+ self.coin = coin
+ if type is not None:
+ self.type = type
+ if subtype is not None:
+ self.subtype = subtype
+ if amount is not None:
+ self.amount = amount
+ if exchange_rate is not None:
+ self.exchange_rate = exchange_rate
+ if exchange_amount is not None:
+ self.exchange_amount = exchange_amount
+ if update_stamp is not None:
+ self.update_stamp = update_stamp
+ if create_stamp is not None:
+ self.create_stamp = create_stamp
+ if status is not None:
+ self.status = status
+ if protocol_type is not None:
+ self.protocol_type = protocol_type
+ if client_order_id is not None:
+ self.client_order_id = client_order_id
+ if source is not None:
+ self.source = source
+
+ @property
+ def id(self):
+ """Gets the id of this SwapCoinStruct. # noqa: E501
+
+ Order ID # noqa: E501
+
+ :return: The id of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._id
+
+ @id.setter
+ def id(self, id):
+ """Sets the id of this SwapCoinStruct.
+
+ Order ID # noqa: E501
+
+ :param id: The id of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._id = id
+
+ @property
+ def pid(self):
+ """Gets the pid of this SwapCoinStruct. # noqa: E501
+
+ Product ID # noqa: E501
+
+ :return: The pid of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._pid
+
+ @pid.setter
+ def pid(self, pid):
+ """Sets the pid of this SwapCoinStruct.
+
+ Product ID # noqa: E501
+
+ :param pid: The pid of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._pid = pid
+
+ @property
+ def uid(self):
+ """Gets the uid of this SwapCoinStruct. # noqa: E501
+
+ User ID # noqa: E501
+
+ :return: The uid of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._uid
+
+ @uid.setter
+ def uid(self, uid):
+ """Sets the uid of this SwapCoinStruct.
+
+ User ID # noqa: E501
+
+ :param uid: The uid of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._uid = uid
+
+ @property
+ def coin(self):
+ """Gets the coin of this SwapCoinStruct. # noqa: E501
+
+ Currency # noqa: E501
+
+ :return: The coin of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._coin
+
+ @coin.setter
+ def coin(self, coin):
+ """Sets the coin of this SwapCoinStruct.
+
+ Currency # noqa: E501
+
+ :param coin: The coin of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._coin = coin
+
+ @property
+ def type(self):
+ """Gets the type of this SwapCoinStruct. # noqa: E501
+
+ Type 0-Staking 1-Redemption # noqa: E501
+
+ :return: The type of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this SwapCoinStruct.
+
+ Type 0-Staking 1-Redemption # noqa: E501
+
+ :param type: The type of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._type = type
+
+ @property
+ def subtype(self):
+ """Gets the subtype of this SwapCoinStruct. # noqa: E501
+
+ SubType # noqa: E501
+
+ :return: The subtype of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._subtype
+
+ @subtype.setter
+ def subtype(self, subtype):
+ """Sets the subtype of this SwapCoinStruct.
+
+ SubType # noqa: E501
+
+ :param subtype: The subtype of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._subtype = subtype
+
+ @property
+ def amount(self):
+ """Gets the amount of this SwapCoinStruct. # noqa: E501
+
+ Amount # noqa: E501
+
+ :return: The amount of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._amount
+
+ @amount.setter
+ def amount(self, amount):
+ """Sets the amount of this SwapCoinStruct.
+
+ Amount # noqa: E501
+
+ :param amount: The amount of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._amount = amount
+
+ @property
+ def exchange_rate(self):
+ """Gets the exchange_rate of this SwapCoinStruct. # noqa: E501
+
+ Exchange ratio # noqa: E501
+
+ :return: The exchange_rate of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._exchange_rate
+
+ @exchange_rate.setter
+ def exchange_rate(self, exchange_rate):
+ """Sets the exchange_rate of this SwapCoinStruct.
+
+ Exchange ratio # noqa: E501
+
+ :param exchange_rate: The exchange_rate of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._exchange_rate = exchange_rate
+
+ @property
+ def exchange_amount(self):
+ """Gets the exchange_amount of this SwapCoinStruct. # noqa: E501
+
+ Redemption Amount # noqa: E501
+
+ :return: The exchange_amount of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._exchange_amount
+
+ @exchange_amount.setter
+ def exchange_amount(self, exchange_amount):
+ """Sets the exchange_amount of this SwapCoinStruct.
+
+ Redemption Amount # noqa: E501
+
+ :param exchange_amount: The exchange_amount of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._exchange_amount = exchange_amount
+
+ @property
+ def update_stamp(self):
+ """Gets the update_stamp of this SwapCoinStruct. # noqa: E501
+
+ UpdateTimestamp # noqa: E501
+
+ :return: The update_stamp of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._update_stamp
+
+ @update_stamp.setter
+ def update_stamp(self, update_stamp):
+ """Sets the update_stamp of this SwapCoinStruct.
+
+ UpdateTimestamp # noqa: E501
+
+ :param update_stamp: The update_stamp of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._update_stamp = update_stamp
+
+ @property
+ def create_stamp(self):
+ """Gets the create_stamp of this SwapCoinStruct. # noqa: E501
+
+ Transaction timestamp # noqa: E501
+
+ :return: The create_stamp of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._create_stamp
+
+ @create_stamp.setter
+ def create_stamp(self, create_stamp):
+ """Sets the create_stamp of this SwapCoinStruct.
+
+ Transaction timestamp # noqa: E501
+
+ :param create_stamp: The create_stamp of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._create_stamp = create_stamp
+
+ @property
+ def status(self):
+ """Gets the status of this SwapCoinStruct. # noqa: E501
+
+ status 1-success # noqa: E501
+
+ :return: The status of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this SwapCoinStruct.
+
+ status 1-success # noqa: E501
+
+ :param status: The status of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._status = status
+
+ @property
+ def protocol_type(self):
+ """Gets the protocol_type of this SwapCoinStruct. # noqa: E501
+
+ DEFI Protocol Type # noqa: E501
+
+ :return: The protocol_type of this SwapCoinStruct. # noqa: E501
+ :rtype: int
+ """
+ return self._protocol_type
+
+ @protocol_type.setter
+ def protocol_type(self, protocol_type):
+ """Sets the protocol_type of this SwapCoinStruct.
+
+ DEFI Protocol Type # noqa: E501
+
+ :param protocol_type: The protocol_type of this SwapCoinStruct. # noqa: E501
+ :type: int
+ """
+
+ self._protocol_type = protocol_type
+
+ @property
+ def client_order_id(self):
+ """Gets the client_order_id of this SwapCoinStruct. # noqa: E501
+
+ Reference ID # noqa: E501
+
+ :return: The client_order_id of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._client_order_id
+
+ @client_order_id.setter
+ def client_order_id(self, client_order_id):
+ """Sets the client_order_id of this SwapCoinStruct.
+
+ Reference ID # noqa: E501
+
+ :param client_order_id: The client_order_id of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._client_order_id = client_order_id
+
+ @property
+ def source(self):
+ """Gets the source of this SwapCoinStruct. # noqa: E501
+
+ Order Origin # noqa: E501
+
+ :return: The source of this SwapCoinStruct. # noqa: E501
+ :rtype: str
+ """
+ return self._source
+
+ @source.setter
+ def source(self, source):
+ """Sets the source of this SwapCoinStruct.
+
+ Order Origin # noqa: E501
+
+ :param source: The source of this SwapCoinStruct. # noqa: E501
+ :type: str
+ """
+
+ self._source = source
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, SwapCoinStruct):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, SwapCoinStruct):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/system_time.py b/gate_api/models/system_time.py
index 570a069..285a0e7 100644
--- a/gate_api/models/system_time.py
+++ b/gate_api/models/system_time.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/ticker.py b/gate_api/models/ticker.py
index 32a0666..289c557 100644
--- a/gate_api/models/ticker.py
+++ b/gate_api/models/ticker.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -203,7 +203,7 @@ def lowest_ask(self, lowest_ask):
def lowest_size(self):
"""Gets the lowest_size of this Ticker. # noqa: E501
- The latest seller's lowest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data # noqa: E501
+ Latest seller's lowest price quantity; not available for batch queries; available for single queries, empty if no data # noqa: E501
:return: The lowest_size of this Ticker. # noqa: E501
:rtype: str
@@ -214,7 +214,7 @@ def lowest_size(self):
def lowest_size(self, lowest_size):
"""Sets the lowest_size of this Ticker.
- The latest seller's lowest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data # noqa: E501
+ Latest seller's lowest price quantity; not available for batch queries; available for single queries, empty if no data # noqa: E501
:param lowest_size: The lowest_size of this Ticker. # noqa: E501
:type: str
@@ -249,7 +249,7 @@ def highest_bid(self, highest_bid):
def highest_size(self):
"""Gets the highest_size of this Ticker. # noqa: E501
- The latest buyer's highest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data # noqa: E501
+ Latest buyer's highest price quantity; not available for batch queries; available for single queries, empty if no data # noqa: E501
:return: The highest_size of this Ticker. # noqa: E501
:rtype: str
@@ -260,7 +260,7 @@ def highest_size(self):
def highest_size(self, highest_size):
"""Sets the highest_size of this Ticker.
- The latest buyer's highest price quantity; does not exist for batch query; exists for single query, and is empty if there is no data # noqa: E501
+ Latest buyer's highest price quantity; not available for batch queries; available for single queries, empty if no data # noqa: E501
:param highest_size: The highest_size of this Ticker. # noqa: E501
:type: str
@@ -272,7 +272,7 @@ def highest_size(self, highest_size):
def change_percentage(self):
"""Gets the change_percentage of this Ticker. # noqa: E501
- Change percentage in the last 24h # noqa: E501
+ 24h price change percentage (negative for decrease, e.g., -7.45) # noqa: E501
:return: The change_percentage of this Ticker. # noqa: E501
:rtype: str
@@ -283,7 +283,7 @@ def change_percentage(self):
def change_percentage(self, change_percentage):
"""Sets the change_percentage of this Ticker.
- Change percentage in the last 24h # noqa: E501
+ 24h price change percentage (negative for decrease, e.g., -7.45) # noqa: E501
:param change_percentage: The change_percentage of this Ticker. # noqa: E501
:type: str
@@ -295,7 +295,7 @@ def change_percentage(self, change_percentage):
def change_utc0(self):
"""Gets the change_utc0 of this Ticker. # noqa: E501
- utc0 timezone, the percentage change in the last 24 hours # noqa: E501
+ UTC+0 timezone, 24h price change percentage, negative for decline (e.g., -7.45) # noqa: E501
:return: The change_utc0 of this Ticker. # noqa: E501
:rtype: str
@@ -306,7 +306,7 @@ def change_utc0(self):
def change_utc0(self, change_utc0):
"""Sets the change_utc0 of this Ticker.
- utc0 timezone, the percentage change in the last 24 hours # noqa: E501
+ UTC+0 timezone, 24h price change percentage, negative for decline (e.g., -7.45) # noqa: E501
:param change_utc0: The change_utc0 of this Ticker. # noqa: E501
:type: str
@@ -318,7 +318,7 @@ def change_utc0(self, change_utc0):
def change_utc8(self):
"""Gets the change_utc8 of this Ticker. # noqa: E501
- utc8 timezone, the percentage change in the last 24 hours # noqa: E501
+ UTC+8 timezone, 24h price change percentage, negative for decline (e.g., -7.45) # noqa: E501
:return: The change_utc8 of this Ticker. # noqa: E501
:rtype: str
@@ -329,7 +329,7 @@ def change_utc8(self):
def change_utc8(self, change_utc8):
"""Sets the change_utc8 of this Ticker.
- utc8 timezone, the percentage change in the last 24 hours # noqa: E501
+ UTC+8 timezone, 24h price change percentage, negative for decline (e.g., -7.45) # noqa: E501
:param change_utc8: The change_utc8 of this Ticker. # noqa: E501
:type: str
@@ -341,7 +341,7 @@ def change_utc8(self, change_utc8):
def base_volume(self):
"""Gets the base_volume of this Ticker. # noqa: E501
- Base currency trade volume in the last 24h # noqa: E501
+ Base currency trading volume in the last 24h # noqa: E501
:return: The base_volume of this Ticker. # noqa: E501
:rtype: str
@@ -352,7 +352,7 @@ def base_volume(self):
def base_volume(self, base_volume):
"""Sets the base_volume of this Ticker.
- Base currency trade volume in the last 24h # noqa: E501
+ Base currency trading volume in the last 24h # noqa: E501
:param base_volume: The base_volume of this Ticker. # noqa: E501
:type: str
@@ -364,7 +364,7 @@ def base_volume(self, base_volume):
def quote_volume(self):
"""Gets the quote_volume of this Ticker. # noqa: E501
- Quote currency trade volume in the last 24h # noqa: E501
+ Quote currency trading volume in the last 24h # noqa: E501
:return: The quote_volume of this Ticker. # noqa: E501
:rtype: str
@@ -375,7 +375,7 @@ def quote_volume(self):
def quote_volume(self, quote_volume):
"""Sets the quote_volume of this Ticker.
- Quote currency trade volume in the last 24h # noqa: E501
+ Quote currency trading volume in the last 24h # noqa: E501
:param quote_volume: The quote_volume of this Ticker. # noqa: E501
:type: str
@@ -387,7 +387,7 @@ def quote_volume(self, quote_volume):
def high_24h(self):
"""Gets the high_24h of this Ticker. # noqa: E501
- Highest price in 24h # noqa: E501
+ 24h High # noqa: E501
:return: The high_24h of this Ticker. # noqa: E501
:rtype: str
@@ -398,7 +398,7 @@ def high_24h(self):
def high_24h(self, high_24h):
"""Sets the high_24h of this Ticker.
- Highest price in 24h # noqa: E501
+ 24h High # noqa: E501
:param high_24h: The high_24h of this Ticker. # noqa: E501
:type: str
@@ -410,7 +410,7 @@ def high_24h(self, high_24h):
def low_24h(self):
"""Gets the low_24h of this Ticker. # noqa: E501
- Lowest price in 24h # noqa: E501
+ 24h Low # noqa: E501
:return: The low_24h of this Ticker. # noqa: E501
:rtype: str
@@ -421,7 +421,7 @@ def low_24h(self):
def low_24h(self, low_24h):
"""Sets the low_24h of this Ticker.
- Lowest price in 24h # noqa: E501
+ 24h Low # noqa: E501
:param low_24h: The low_24h of this Ticker. # noqa: E501
:type: str
@@ -456,7 +456,7 @@ def etf_net_value(self, etf_net_value):
def etf_pre_net_value(self):
"""Gets the etf_pre_net_value of this Ticker. # noqa: E501
- ETF previous net value at re-balancing time # noqa: E501
+ ETF net value at previous rebalancing point # noqa: E501
:return: The etf_pre_net_value of this Ticker. # noqa: E501
:rtype: str
@@ -467,7 +467,7 @@ def etf_pre_net_value(self):
def etf_pre_net_value(self, etf_pre_net_value):
"""Sets the etf_pre_net_value of this Ticker.
- ETF previous net value at re-balancing time # noqa: E501
+ ETF net value at previous rebalancing point # noqa: E501
:param etf_pre_net_value: The etf_pre_net_value of this Ticker. # noqa: E501
:type: str
@@ -479,7 +479,7 @@ def etf_pre_net_value(self, etf_pre_net_value):
def etf_pre_timestamp(self):
"""Gets the etf_pre_timestamp of this Ticker. # noqa: E501
- ETF previous re-balancing time # noqa: E501
+ ETF previous rebalancing time # noqa: E501
:return: The etf_pre_timestamp of this Ticker. # noqa: E501
:rtype: int
@@ -490,7 +490,7 @@ def etf_pre_timestamp(self):
def etf_pre_timestamp(self, etf_pre_timestamp):
"""Sets the etf_pre_timestamp of this Ticker.
- ETF previous re-balancing time # noqa: E501
+ ETF previous rebalancing time # noqa: E501
:param etf_pre_timestamp: The etf_pre_timestamp of this Ticker. # noqa: E501
:type: int
diff --git a/gate_api/models/total_balance.py b/gate_api/models/total_balance.py
index 0adc29b..9dd8b78 100644
--- a/gate_api/models/total_balance.py
+++ b/gate_api/models/total_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -83,7 +83,7 @@ def total(self, total):
def details(self):
"""Gets the details of this TotalBalance. # noqa: E501
- Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: futures account - delivery: delivery account - warrant: warrant account - cbbc: cbbc account # noqa: E501
+ Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: perpetual contract account - delivery: delivery contract account - warrant: warrant account - cbbc: CBBC account # noqa: E501
:return: The details of this TotalBalance. # noqa: E501
:rtype: dict(str, AccountBalance)
@@ -94,7 +94,7 @@ def details(self):
def details(self, details):
"""Sets the details of this TotalBalance.
- Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: futures account - delivery: delivery account - warrant: warrant account - cbbc: cbbc account # noqa: E501
+ Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: perpetual contract account - delivery: delivery contract account - warrant: warrant account - cbbc: CBBC account # noqa: E501
:param details: The details of this TotalBalance. # noqa: E501
:type: dict(str, AccountBalance)
diff --git a/gate_api/models/trade.py b/gate_api/models/trade.py
index cffe9a0..7fbeff8 100644
--- a/gate_api/models/trade.py
+++ b/gate_api/models/trade.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -132,7 +132,7 @@ def __init__(self, id=None, create_time=None, create_time_ms=None, currency_pair
def id(self):
"""Gets the id of this Trade. # noqa: E501
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:return: The id of this Trade. # noqa: E501
:rtype: str
@@ -143,7 +143,7 @@ def id(self):
def id(self, id):
"""Sets the id of this Trade.
- Trade ID # noqa: E501
+ Fill ID # noqa: E501
:param id: The id of this Trade. # noqa: E501
:type: str
@@ -155,7 +155,7 @@ def id(self, id):
def create_time(self):
"""Gets the create_time of this Trade. # noqa: E501
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:return: The create_time of this Trade. # noqa: E501
:rtype: str
@@ -166,7 +166,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this Trade.
- Trading time # noqa: E501
+ Fill Time # noqa: E501
:param create_time: The create_time of this Trade. # noqa: E501
:type: str
@@ -224,7 +224,7 @@ def currency_pair(self, currency_pair):
def side(self):
"""Gets the side of this Trade. # noqa: E501
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:return: The side of this Trade. # noqa: E501
:rtype: str
@@ -235,7 +235,7 @@ def side(self):
def side(self, side):
"""Sets the side of this Trade.
- Order side # noqa: E501
+ Buy or sell order # noqa: E501
:param side: The side of this Trade. # noqa: E501
:type: str
@@ -253,7 +253,7 @@ def side(self, side):
def role(self):
"""Gets the role of this Trade. # noqa: E501
- Trade role. No value in public endpoints # noqa: E501
+ Trade role, not returned in public endpoints # noqa: E501
:return: The role of this Trade. # noqa: E501
:rtype: str
@@ -264,7 +264,7 @@ def role(self):
def role(self, role):
"""Sets the role of this Trade.
- Trade role. No value in public endpoints # noqa: E501
+ Trade role, not returned in public endpoints # noqa: E501
:param role: The role of this Trade. # noqa: E501
:type: str
@@ -328,7 +328,7 @@ def price(self, price):
def order_id(self):
"""Gets the order_id of this Trade. # noqa: E501
- Related order ID. No value in public endpoints # noqa: E501
+ Related order ID, not returned in public endpoints # noqa: E501
:return: The order_id of this Trade. # noqa: E501
:rtype: str
@@ -339,7 +339,7 @@ def order_id(self):
def order_id(self, order_id):
"""Sets the order_id of this Trade.
- Related order ID. No value in public endpoints # noqa: E501
+ Related order ID, not returned in public endpoints # noqa: E501
:param order_id: The order_id of this Trade. # noqa: E501
:type: str
@@ -351,7 +351,7 @@ def order_id(self, order_id):
def fee(self):
"""Gets the fee of this Trade. # noqa: E501
- Fee deducted. No value in public endpoints # noqa: E501
+ Fee deducted, not returned in public endpoints # noqa: E501
:return: The fee of this Trade. # noqa: E501
:rtype: str
@@ -362,7 +362,7 @@ def fee(self):
def fee(self, fee):
"""Sets the fee of this Trade.
- Fee deducted. No value in public endpoints # noqa: E501
+ Fee deducted, not returned in public endpoints # noqa: E501
:param fee: The fee of this Trade. # noqa: E501
:type: str
@@ -374,7 +374,7 @@ def fee(self, fee):
def fee_currency(self):
"""Gets the fee_currency of this Trade. # noqa: E501
- Fee currency unit. No value in public endpoints # noqa: E501
+ Fee currency unit, not returned in public endpoints # noqa: E501
:return: The fee_currency of this Trade. # noqa: E501
:rtype: str
@@ -385,7 +385,7 @@ def fee_currency(self):
def fee_currency(self, fee_currency):
"""Sets the fee_currency of this Trade.
- Fee currency unit. No value in public endpoints # noqa: E501
+ Fee currency unit, not returned in public endpoints # noqa: E501
:param fee_currency: The fee_currency of this Trade. # noqa: E501
:type: str
@@ -397,7 +397,7 @@ def fee_currency(self, fee_currency):
def point_fee(self):
"""Gets the point_fee of this Trade. # noqa: E501
- Points used to deduct fee. No value in public endpoints # noqa: E501
+ Points used to deduct fee, not returned in public endpoints # noqa: E501
:return: The point_fee of this Trade. # noqa: E501
:rtype: str
@@ -408,7 +408,7 @@ def point_fee(self):
def point_fee(self, point_fee):
"""Sets the point_fee of this Trade.
- Points used to deduct fee. No value in public endpoints # noqa: E501
+ Points used to deduct fee, not returned in public endpoints # noqa: E501
:param point_fee: The point_fee of this Trade. # noqa: E501
:type: str
@@ -420,7 +420,7 @@ def point_fee(self, point_fee):
def gt_fee(self):
"""Gets the gt_fee of this Trade. # noqa: E501
- GT used to deduct fee. No value in public endpoints # noqa: E501
+ GT used to deduct fee, not returned in public endpoints # noqa: E501
:return: The gt_fee of this Trade. # noqa: E501
:rtype: str
@@ -431,7 +431,7 @@ def gt_fee(self):
def gt_fee(self, gt_fee):
"""Sets the gt_fee of this Trade.
- GT used to deduct fee. No value in public endpoints # noqa: E501
+ GT used to deduct fee, not returned in public endpoints # noqa: E501
:param gt_fee: The gt_fee of this Trade. # noqa: E501
:type: str
@@ -466,7 +466,7 @@ def amend_text(self, amend_text):
def sequence_id(self):
"""Gets the sequence_id of this Trade. # noqa: E501
- Represents a unique and consecutive trade ID within a single market. It is used to track and identify trades in the specific market # noqa: E501
+ Consecutive trade ID within a single market. Used to track and identify trades in the specific market # noqa: E501
:return: The sequence_id of this Trade. # noqa: E501
:rtype: str
@@ -477,7 +477,7 @@ def sequence_id(self):
def sequence_id(self, sequence_id):
"""Sets the sequence_id of this Trade.
- Represents a unique and consecutive trade ID within a single market. It is used to track and identify trades in the specific market # noqa: E501
+ Consecutive trade ID within a single market. Used to track and identify trades in the specific market # noqa: E501
:param sequence_id: The sequence_id of this Trade. # noqa: E501
:type: str
@@ -489,7 +489,7 @@ def sequence_id(self, sequence_id):
def text(self):
"""Gets the text of this Trade. # noqa: E501
- User defined information. No value in public endpoints # noqa: E501
+ User-defined information, not returned in public endpoints # noqa: E501
:return: The text of this Trade. # noqa: E501
:rtype: str
@@ -500,7 +500,7 @@ def text(self):
def text(self, text):
"""Sets the text of this Trade.
- User defined information. No value in public endpoints # noqa: E501
+ User-defined information, not returned in public endpoints # noqa: E501
:param text: The text of this Trade. # noqa: E501
:type: str
diff --git a/gate_api/models/trade_fee.py b/gate_api/models/trade_fee.py
index 47b0c08..7b3fd5a 100644
--- a/gate_api/models/trade_fee.py
+++ b/gate_api/models/trade_fee.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -186,7 +186,7 @@ def maker_fee(self, maker_fee):
def gt_discount(self):
"""Gets the gt_discount of this TradeFee. # noqa: E501
- If GT deduction is enabled # noqa: E501
+ Whether GT deduction discount is enabled # noqa: E501
:return: The gt_discount of this TradeFee. # noqa: E501
:rtype: bool
@@ -197,7 +197,7 @@ def gt_discount(self):
def gt_discount(self, gt_discount):
"""Sets the gt_discount of this TradeFee.
- If GT deduction is enabled # noqa: E501
+ Whether GT deduction discount is enabled # noqa: E501
:param gt_discount: The gt_discount of this TradeFee. # noqa: E501
:type: bool
@@ -232,7 +232,7 @@ def gt_taker_fee(self, gt_taker_fee):
def gt_maker_fee(self):
"""Gets the gt_maker_fee of this TradeFee. # noqa: E501
- Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled # noqa: E501
+ Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled # noqa: E501
:return: The gt_maker_fee of this TradeFee. # noqa: E501
:rtype: str
@@ -243,7 +243,7 @@ def gt_maker_fee(self):
def gt_maker_fee(self, gt_maker_fee):
"""Sets the gt_maker_fee of this TradeFee.
- Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled # noqa: E501
+ Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled # noqa: E501
:param gt_maker_fee: The gt_maker_fee of this TradeFee. # noqa: E501
:type: str
@@ -278,7 +278,7 @@ def loan_fee(self, loan_fee):
def point_type(self):
"""Gets the point_type of this TradeFee. # noqa: E501
- Point type. 0 - Initial version. 1 - new version since 202009 # noqa: E501
+ Point card type: 0 - Original version, 1 - New version since 202009 # noqa: E501
:return: The point_type of this TradeFee. # noqa: E501
:rtype: str
@@ -289,7 +289,7 @@ def point_type(self):
def point_type(self, point_type):
"""Sets the point_type of this TradeFee.
- Point type. 0 - Initial version. 1 - new version since 202009 # noqa: E501
+ Point card type: 0 - Original version, 1 - New version since 202009 # noqa: E501
:param point_type: The point_type of this TradeFee. # noqa: E501
:type: str
@@ -301,7 +301,7 @@ def point_type(self, point_type):
def futures_taker_fee(self):
"""Gets the futures_taker_fee of this TradeFee. # noqa: E501
- Futures trading taker fee # noqa: E501
+ Perpetual contract taker fee rate # noqa: E501
:return: The futures_taker_fee of this TradeFee. # noqa: E501
:rtype: str
@@ -312,7 +312,7 @@ def futures_taker_fee(self):
def futures_taker_fee(self, futures_taker_fee):
"""Sets the futures_taker_fee of this TradeFee.
- Futures trading taker fee # noqa: E501
+ Perpetual contract taker fee rate # noqa: E501
:param futures_taker_fee: The futures_taker_fee of this TradeFee. # noqa: E501
:type: str
@@ -324,7 +324,7 @@ def futures_taker_fee(self, futures_taker_fee):
def futures_maker_fee(self):
"""Gets the futures_maker_fee of this TradeFee. # noqa: E501
- Future trading maker fee # noqa: E501
+ Perpetual contract maker fee rate # noqa: E501
:return: The futures_maker_fee of this TradeFee. # noqa: E501
:rtype: str
@@ -335,7 +335,7 @@ def futures_maker_fee(self):
def futures_maker_fee(self, futures_maker_fee):
"""Sets the futures_maker_fee of this TradeFee.
- Future trading maker fee # noqa: E501
+ Perpetual contract maker fee rate # noqa: E501
:param futures_maker_fee: The futures_maker_fee of this TradeFee. # noqa: E501
:type: str
@@ -347,7 +347,7 @@ def futures_maker_fee(self, futures_maker_fee):
def delivery_taker_fee(self):
"""Gets the delivery_taker_fee of this TradeFee. # noqa: E501
- Delivery trading taker fee # noqa: E501
+ Delivery contract taker fee rate # noqa: E501
:return: The delivery_taker_fee of this TradeFee. # noqa: E501
:rtype: str
@@ -358,7 +358,7 @@ def delivery_taker_fee(self):
def delivery_taker_fee(self, delivery_taker_fee):
"""Sets the delivery_taker_fee of this TradeFee.
- Delivery trading taker fee # noqa: E501
+ Delivery contract taker fee rate # noqa: E501
:param delivery_taker_fee: The delivery_taker_fee of this TradeFee. # noqa: E501
:type: str
@@ -370,7 +370,7 @@ def delivery_taker_fee(self, delivery_taker_fee):
def delivery_maker_fee(self):
"""Gets the delivery_maker_fee of this TradeFee. # noqa: E501
- Delivery trading maker fee # noqa: E501
+ Delivery contract maker fee rate # noqa: E501
:return: The delivery_maker_fee of this TradeFee. # noqa: E501
:rtype: str
@@ -381,7 +381,7 @@ def delivery_maker_fee(self):
def delivery_maker_fee(self, delivery_maker_fee):
"""Sets the delivery_maker_fee of this TradeFee.
- Delivery trading maker fee # noqa: E501
+ Delivery contract maker fee rate # noqa: E501
:param delivery_maker_fee: The delivery_maker_fee of this TradeFee. # noqa: E501
:type: str
diff --git a/gate_api/models/transaction_id.py b/gate_api/models/transaction_id.py
index 8b3da4d..d902340 100644
--- a/gate_api/models/transaction_id.py
+++ b/gate_api/models/transaction_id.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -57,7 +57,7 @@ def __init__(self, tx_id=None, local_vars_configuration=None): # noqa: E501
def tx_id(self):
"""Gets the tx_id of this TransactionID. # noqa: E501
- Order id # noqa: E501
+ Order ID # noqa: E501
:return: The tx_id of this TransactionID. # noqa: E501
:rtype: int
@@ -68,7 +68,7 @@ def tx_id(self):
def tx_id(self, tx_id):
"""Sets the tx_id of this TransactionID.
- Order id # noqa: E501
+ Order ID # noqa: E501
:param tx_id: The tx_id of this TransactionID. # noqa: E501
:type: int
diff --git a/gate_api/models/transfer.py b/gate_api/models/transfer.py
index 0e49717..aaf2469 100644
--- a/gate_api/models/transfer.py
+++ b/gate_api/models/transfer.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -78,7 +78,7 @@ def __init__(self, currency=None, _from=None, to=None, amount=None, currency_pai
def currency(self):
"""Gets the currency of this Transfer. # noqa: E501
- Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency # noqa: E501
+ Transfer currency name. For contract accounts, `currency` can be set to `POINT` (points) or supported settlement currencies (e.g., `BTC`, `USDT`) # noqa: E501
:return: The currency of this Transfer. # noqa: E501
:rtype: str
@@ -89,7 +89,7 @@ def currency(self):
def currency(self, currency):
"""Sets the currency of this Transfer.
- Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency # noqa: E501
+ Transfer currency name. For contract accounts, `currency` can be set to `POINT` (points) or supported settlement currencies (e.g., `BTC`, `USDT`) # noqa: E501
:param currency: The currency of this Transfer. # noqa: E501
:type: str
@@ -190,7 +190,7 @@ def amount(self, amount):
def currency_pair(self):
"""Gets the currency_pair of this Transfer. # noqa: E501
- Margin currency pair. Required if transfer from or to margin account # noqa: E501
+ Margin trading pair. Required when transferring to or from margin account # noqa: E501
:return: The currency_pair of this Transfer. # noqa: E501
:rtype: str
@@ -201,7 +201,7 @@ def currency_pair(self):
def currency_pair(self, currency_pair):
"""Sets the currency_pair of this Transfer.
- Margin currency pair. Required if transfer from or to margin account # noqa: E501
+ Margin trading pair. Required when transferring to or from margin account # noqa: E501
:param currency_pair: The currency_pair of this Transfer. # noqa: E501
:type: str
@@ -213,7 +213,7 @@ def currency_pair(self, currency_pair):
def settle(self):
"""Gets the settle of this Transfer. # noqa: E501
- Futures settle currency. Required if transferring from or to futures account # noqa: E501
+ Contract settlement currency. Required when transferring to or from contract account # noqa: E501
:return: The settle of this Transfer. # noqa: E501
:rtype: str
@@ -224,7 +224,7 @@ def settle(self):
def settle(self, settle):
"""Sets the settle of this Transfer.
- Futures settle currency. Required if transferring from or to futures account # noqa: E501
+ Contract settlement currency. Required when transferring to or from contract account # noqa: E501
:param settle: The settle of this Transfer. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_interest_mode.py b/gate_api/models/transfer_order_status.py
similarity index 54%
rename from gate_api/models/uni_interest_mode.py
rename to gate_api/models/transfer_order_status.py
index 56ec36f..527b77a 100644
--- a/gate_api/models/uni_interest_mode.py
+++ b/gate_api/models/transfer_order_status.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class UniInterestMode(object):
+class TransferOrderStatus(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -33,76 +33,74 @@ class UniInterestMode(object):
and the value is json key in definition.
"""
openapi_types = {
- 'currency': 'str',
- 'status': 'bool'
+ 'tx_id': 'str',
+ 'status': 'str'
}
attribute_map = {
- 'currency': 'currency',
+ 'tx_id': 'tx_id',
'status': 'status'
}
- def __init__(self, currency=None, status=None, local_vars_configuration=None): # noqa: E501
- # type: (str, bool, Configuration) -> None
- """UniInterestMode - a model defined in OpenAPI""" # noqa: E501
+ def __init__(self, tx_id=None, status=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, Configuration) -> None
+ """TransferOrderStatus - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
- self._currency = None
+ self._tx_id = None
self._status = None
self.discriminator = None
- self.currency = currency
- self.status = status
+ if tx_id is not None:
+ self.tx_id = tx_id
+ if status is not None:
+ self.status = status
@property
- def currency(self):
- """Gets the currency of this UniInterestMode. # noqa: E501
+ def tx_id(self):
+ """Gets the tx_id of this TransferOrderStatus. # noqa: E501
- Currency # noqa: E501
+ Order ID # noqa: E501
- :return: The currency of this UniInterestMode. # noqa: E501
+ :return: The tx_id of this TransferOrderStatus. # noqa: E501
:rtype: str
"""
- return self._currency
+ return self._tx_id
- @currency.setter
- def currency(self, currency):
- """Sets the currency of this UniInterestMode.
+ @tx_id.setter
+ def tx_id(self, tx_id):
+ """Sets the tx_id of this TransferOrderStatus.
- Currency # noqa: E501
+ Order ID # noqa: E501
- :param currency: The currency of this UniInterestMode. # noqa: E501
+ :param tx_id: The tx_id of this TransferOrderStatus. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
- self._currency = currency
+ self._tx_id = tx_id
@property
def status(self):
- """Gets the status of this UniInterestMode. # noqa: E501
+ """Gets the status of this TransferOrderStatus. # noqa: E501
- Interest toggle settings, true - interest reinvestment, false - regular dividend # noqa: E501
+ Transfer status: PENDING - Processing, SUCCESS - Transfer successful, FAIL - Transfer failed, PARTIAL_SUCCESS - Partially successful (this status appears when transferring between sub-accounts) # noqa: E501
- :return: The status of this UniInterestMode. # noqa: E501
- :rtype: bool
+ :return: The status of this TransferOrderStatus. # noqa: E501
+ :rtype: str
"""
return self._status
@status.setter
def status(self, status):
- """Sets the status of this UniInterestMode.
+ """Sets the status of this TransferOrderStatus.
- Interest toggle settings, true - interest reinvestment, false - regular dividend # noqa: E501
+ Transfer status: PENDING - Processing, SUCCESS - Transfer successful, FAIL - Transfer failed, PARTIAL_SUCCESS - Partially successful (this status appears when transferring between sub-accounts) # noqa: E501
- :param status: The status of this UniInterestMode. # noqa: E501
- :type: bool
+ :param status: The status of this TransferOrderStatus. # noqa: E501
+ :type: str
"""
- if self.local_vars_configuration.client_side_validation and status is None: # noqa: E501
- raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501
self._status = status
@@ -140,14 +138,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, UniInterestMode):
+ if not isinstance(other, TransferOrderStatus):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, UniInterestMode):
+ if not isinstance(other, TransferOrderStatus):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/cross_margin_repay_request.py b/gate_api/models/transferables_result.py
similarity index 63%
rename from gate_api/models/cross_margin_repay_request.py
rename to gate_api/models/transferables_result.py
index 406a95d..a2659ba 100644
--- a/gate_api/models/cross_margin_repay_request.py
+++ b/gate_api/models/transferables_result.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class CrossMarginRepayRequest(object):
+class TransferablesResult(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -44,7 +44,7 @@ class CrossMarginRepayRequest(object):
def __init__(self, currency=None, amount=None, local_vars_configuration=None): # noqa: E501
# type: (str, str, Configuration) -> None
- """CrossMarginRepayRequest - a model defined in OpenAPI""" # noqa: E501
+ """TransferablesResult - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
@@ -53,56 +53,54 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None):
self._amount = None
self.discriminator = None
- self.currency = currency
- self.amount = amount
+ if currency is not None:
+ self.currency = currency
+ if amount is not None:
+ self.amount = amount
@property
def currency(self):
- """Gets the currency of this CrossMarginRepayRequest. # noqa: E501
+ """Gets the currency of this TransferablesResult. # noqa: E501
- Repayment currency # noqa: E501
+ Currency detail # noqa: E501
- :return: The currency of this CrossMarginRepayRequest. # noqa: E501
+ :return: The currency of this TransferablesResult. # noqa: E501
:rtype: str
"""
return self._currency
@currency.setter
def currency(self, currency):
- """Sets the currency of this CrossMarginRepayRequest.
+ """Sets the currency of this TransferablesResult.
- Repayment currency # noqa: E501
+ Currency detail # noqa: E501
- :param currency: The currency of this CrossMarginRepayRequest. # noqa: E501
+ :param currency: The currency of this TransferablesResult. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
- raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
self._currency = currency
@property
def amount(self):
- """Gets the amount of this CrossMarginRepayRequest. # noqa: E501
+ """Gets the amount of this TransferablesResult. # noqa: E501
- Repayment amount # noqa: E501
+ Maximum transferable amount # noqa: E501
- :return: The amount of this CrossMarginRepayRequest. # noqa: E501
+ :return: The amount of this TransferablesResult. # noqa: E501
:rtype: str
"""
return self._amount
@amount.setter
def amount(self, amount):
- """Sets the amount of this CrossMarginRepayRequest.
+ """Sets the amount of this TransferablesResult.
- Repayment amount # noqa: E501
+ Maximum transferable amount # noqa: E501
- :param amount: The amount of this CrossMarginRepayRequest. # noqa: E501
+ :param amount: The amount of this TransferablesResult. # noqa: E501
:type: str
"""
- if self.local_vars_configuration.client_side_validation and amount is None: # noqa: E501
- raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501
self._amount = amount
@@ -140,14 +138,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginRepayRequest):
+ if not isinstance(other, TransferablesResult):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginRepayRequest):
+ if not isinstance(other, TransferablesResult):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/trigger_order_response.py b/gate_api/models/trigger_order_response.py
index 4681081..2e0b560 100644
--- a/gate_api/models/trigger_order_response.py
+++ b/gate_api/models/trigger_order_response.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/trigger_time.py b/gate_api/models/trigger_time.py
index d8d64f3..6b7c80d 100644
--- a/gate_api/models/trigger_time.py
+++ b/gate_api/models/trigger_time.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -57,7 +57,7 @@ def __init__(self, trigger_time=None, local_vars_configuration=None): # noqa: E
def trigger_time(self):
"""Gets the trigger_time of this TriggerTime. # noqa: E501
- Timestamp of the end of the countdown, in milliseconds # noqa: E501
+ Timestamp when countdown ends, in milliseconds # noqa: E501
:return: The trigger_time of this TriggerTime. # noqa: E501
:rtype: int
@@ -68,7 +68,7 @@ def trigger_time(self):
def trigger_time(self, trigger_time):
"""Sets the trigger_time of this TriggerTime.
- Timestamp of the end of the countdown, in milliseconds # noqa: E501
+ Timestamp when countdown ends, in milliseconds # noqa: E501
:param trigger_time: The trigger_time of this TriggerTime. # noqa: E501
:type: int
diff --git a/gate_api/models/uid_push_order.py b/gate_api/models/uid_push_order.py
index 5bfe729..eb36625 100644
--- a/gate_api/models/uid_push_order.py
+++ b/gate_api/models/uid_push_order.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -40,7 +40,8 @@ class UidPushOrder(object):
'amount': 'str',
'create_time': 'int',
'status': 'str',
- 'message': 'str'
+ 'message': 'str',
+ 'transaction_type': 'str'
}
attribute_map = {
@@ -51,11 +52,12 @@ class UidPushOrder(object):
'amount': 'amount',
'create_time': 'create_time',
'status': 'status',
- 'message': 'message'
+ 'message': 'message',
+ 'transaction_type': 'transaction_type'
}
- def __init__(self, id=None, push_uid=None, receive_uid=None, currency=None, amount=None, create_time=None, status=None, message=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, int, str, str, int, str, str, Configuration) -> None
+ def __init__(self, id=None, push_uid=None, receive_uid=None, currency=None, amount=None, create_time=None, status=None, message=None, transaction_type=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, int, str, str, int, str, str, str, Configuration) -> None
"""UidPushOrder - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -69,6 +71,7 @@ def __init__(self, id=None, push_uid=None, receive_uid=None, currency=None, amou
self._create_time = None
self._status = None
self._message = None
+ self._transaction_type = None
self.discriminator = None
if id is not None:
@@ -87,6 +90,8 @@ def __init__(self, id=None, push_uid=None, receive_uid=None, currency=None, amou
self.status = status
if message is not None:
self.message = message
+ if transaction_type is not None:
+ self.transaction_type = transaction_type
@property
def id(self):
@@ -207,7 +212,7 @@ def amount(self, amount):
def create_time(self):
"""Gets the create_time of this UidPushOrder. # noqa: E501
- Creation time # noqa: E501
+ Created time # noqa: E501
:return: The create_time of this UidPushOrder. # noqa: E501
:rtype: int
@@ -218,7 +223,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this UidPushOrder.
- Creation time # noqa: E501
+ Created time # noqa: E501
:param create_time: The create_time of this UidPushOrder. # noqa: E501
:type: int
@@ -230,7 +235,7 @@ def create_time(self, create_time):
def status(self):
"""Gets the status of this UidPushOrder. # noqa: E501
- 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 # noqa: E501
+ Withdrawal status: - CREATING: Creating - PENDING: Waiting for recipient (Please contact the recipient to accept the transfer on Gate official website) - CANCELLING: Cancelling - CANCELLED: Cancelled - REFUSING: Refusing - REFUSED: Refused - RECEIVING: Receiving - RECEIVED: Success # noqa: E501
:return: The status of this UidPushOrder. # noqa: E501
:rtype: str
@@ -241,7 +246,7 @@ def status(self):
def status(self, status):
"""Sets the status of this UidPushOrder.
- 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 # noqa: E501
+ Withdrawal status: - CREATING: Creating - PENDING: Waiting for recipient (Please contact the recipient to accept the transfer on Gate official website) - CANCELLING: Cancelling - CANCELLED: Cancelled - REFUSING: Refusing - REFUSED: Refused - RECEIVING: Receiving - RECEIVED: Success # noqa: E501
:param status: The status of this UidPushOrder. # noqa: E501
:type: str
@@ -253,7 +258,7 @@ def status(self, status):
def message(self):
"""Gets the message of this UidPushOrder. # noqa: E501
- PENDING Reason Tips # noqa: E501
+ PENDING reason tips # noqa: E501
:return: The message of this UidPushOrder. # noqa: E501
:rtype: str
@@ -264,7 +269,7 @@ def message(self):
def message(self, message):
"""Sets the message of this UidPushOrder.
- PENDING Reason Tips # noqa: E501
+ PENDING reason tips # noqa: E501
:param message: The message of this UidPushOrder. # noqa: E501
:type: str
@@ -272,6 +277,29 @@ def message(self, message):
self._message = message
+ @property
+ def transaction_type(self):
+ """Gets the transaction_type of this UidPushOrder. # noqa: E501
+
+ Order Type # noqa: E501
+
+ :return: The transaction_type of this UidPushOrder. # noqa: E501
+ :rtype: str
+ """
+ return self._transaction_type
+
+ @transaction_type.setter
+ def transaction_type(self, transaction_type):
+ """Sets the transaction_type of this UidPushOrder.
+
+ Order Type # noqa: E501
+
+ :param transaction_type: The transaction_type of this UidPushOrder. # noqa: E501
+ :type: str
+ """
+
+ self._transaction_type = transaction_type
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/uid_push_withdrawal.py b/gate_api/models/uid_push_withdrawal.py
index 20cc498..da15f5c 100644
--- a/gate_api/models/uid_push_withdrawal.py
+++ b/gate_api/models/uid_push_withdrawal.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/uid_push_withdrawal_resp.py b/gate_api/models/uid_push_withdrawal_resp.py
index 8ca17ee..7afe6eb 100644
--- a/gate_api/models/uid_push_withdrawal_resp.py
+++ b/gate_api/models/uid_push_withdrawal_resp.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/uni_currency.py b/gate_api/models/uni_currency.py
index df2d2b5..eee7b2c 100644
--- a/gate_api/models/uni_currency.py
+++ b/gate_api/models/uni_currency.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -100,7 +100,7 @@ def currency(self, currency):
def min_lend_amount(self):
"""Gets the min_lend_amount of this UniCurrency. # noqa: E501
- The minimum lending amount, in the unit of the currency. # noqa: E501
+ The minimum lending amount, in the unit of the currency # noqa: E501
:return: The min_lend_amount of this UniCurrency. # noqa: E501
:rtype: str
@@ -111,7 +111,7 @@ def min_lend_amount(self):
def min_lend_amount(self, min_lend_amount):
"""Sets the min_lend_amount of this UniCurrency.
- The minimum lending amount, in the unit of the currency. # noqa: E501
+ The minimum lending amount, in the unit of the currency # noqa: E501
:param min_lend_amount: The min_lend_amount of this UniCurrency. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_currency_interest.py b/gate_api/models/uni_currency_interest.py
index fc5b64b..525ec59 100644
--- a/gate_api/models/uni_currency_interest.py
+++ b/gate_api/models/uni_currency_interest.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def currency(self, currency):
def interest_status(self):
"""Gets the interest_status of this UniCurrencyInterest. # noqa: E501
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:return: The interest_status of this UniCurrencyInterest. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def interest_status(self):
def interest_status(self, interest_status):
"""Sets the interest_status of this UniCurrencyInterest.
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:param interest_status: The interest_status of this UniCurrencyInterest. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_currency_pair.py b/gate_api/models/uni_currency_pair.py
index 226fa8e..362d6b1 100644
--- a/gate_api/models/uni_currency_pair.py
+++ b/gate_api/models/uni_currency_pair.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/uni_interest_record.py b/gate_api/models/uni_interest_record.py
index 1fcf11e..f06d5fd 100644
--- a/gate_api/models/uni_interest_record.py
+++ b/gate_api/models/uni_interest_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -174,7 +174,7 @@ def interest(self, interest):
def interest_status(self):
"""Gets the interest_status of this UniInterestRecord. # noqa: E501
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:return: The interest_status of this UniInterestRecord. # noqa: E501
:rtype: str
@@ -185,7 +185,7 @@ def interest_status(self):
def interest_status(self, interest_status):
"""Sets the interest_status of this UniInterestRecord.
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:param interest_status: The interest_status of this UniInterestRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_lend.py b/gate_api/models/uni_lend.py
index 0e2be68..8c00a50 100644
--- a/gate_api/models/uni_lend.py
+++ b/gate_api/models/uni_lend.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -148,7 +148,7 @@ def current_amount(self, current_amount):
def amount(self):
"""Gets the amount of this UniLend. # noqa: E501
- Total amount # noqa: E501
+ Total Lending Amount # noqa: E501
:return: The amount of this UniLend. # noqa: E501
:rtype: str
@@ -159,7 +159,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UniLend.
- Total amount # noqa: E501
+ Total Lending Amount # noqa: E501
:param amount: The amount of this UniLend. # noqa: E501
:type: str
@@ -171,7 +171,7 @@ def amount(self, amount):
def lent_amount(self):
"""Gets the lent_amount of this UniLend. # noqa: E501
- Lent amount # noqa: E501
+ Lent Amount # noqa: E501
:return: The lent_amount of this UniLend. # noqa: E501
:rtype: str
@@ -182,7 +182,7 @@ def lent_amount(self):
def lent_amount(self, lent_amount):
"""Sets the lent_amount of this UniLend.
- Lent amount # noqa: E501
+ Lent Amount # noqa: E501
:param lent_amount: The lent_amount of this UniLend. # noqa: E501
:type: str
@@ -194,7 +194,7 @@ def lent_amount(self, lent_amount):
def frozen_amount(self):
"""Gets the frozen_amount of this UniLend. # noqa: E501
- Frozen amount # noqa: E501
+ Pending Redemption Amount # noqa: E501
:return: The frozen_amount of this UniLend. # noqa: E501
:rtype: str
@@ -205,7 +205,7 @@ def frozen_amount(self):
def frozen_amount(self, frozen_amount):
"""Sets the frozen_amount of this UniLend.
- Frozen amount # noqa: E501
+ Pending Redemption Amount # noqa: E501
:param frozen_amount: The frozen_amount of this UniLend. # noqa: E501
:type: str
@@ -240,7 +240,7 @@ def min_rate(self, min_rate):
def interest_status(self):
"""Gets the interest_status of this UniLend. # noqa: E501
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:return: The interest_status of this UniLend. # noqa: E501
:rtype: str
@@ -251,7 +251,7 @@ def interest_status(self):
def interest_status(self, interest_status):
"""Sets the interest_status of this UniLend.
- Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment # noqa: E501
+ Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment # noqa: E501
:param interest_status: The interest_status of this UniLend. # noqa: E501
:type: str
@@ -263,7 +263,7 @@ def interest_status(self, interest_status):
def reinvest_left_amount(self):
"""Gets the reinvest_left_amount of this UniLend. # noqa: E501
- Amount not reinvested # noqa: E501
+ Non-reinvested Amount # noqa: E501
:return: The reinvest_left_amount of this UniLend. # noqa: E501
:rtype: str
@@ -274,7 +274,7 @@ def reinvest_left_amount(self):
def reinvest_left_amount(self, reinvest_left_amount):
"""Sets the reinvest_left_amount of this UniLend.
- Amount not reinvested # noqa: E501
+ Non-reinvested Amount # noqa: E501
:param reinvest_left_amount: The reinvest_left_amount of this UniLend. # noqa: E501
:type: str
@@ -286,7 +286,7 @@ def reinvest_left_amount(self, reinvest_left_amount):
def create_time(self):
"""Gets the create_time of this UniLend. # noqa: E501
- Created time of the lending order # noqa: E501
+ Lending Order Creation Time # noqa: E501
:return: The create_time of this UniLend. # noqa: E501
:rtype: int
@@ -297,7 +297,7 @@ def create_time(self):
def create_time(self, create_time):
"""Sets the create_time of this UniLend.
- Created time of the lending order # noqa: E501
+ Lending Order Creation Time # noqa: E501
:param create_time: The create_time of this UniLend. # noqa: E501
:type: int
@@ -309,7 +309,7 @@ def create_time(self, create_time):
def update_time(self):
"""Gets the update_time of this UniLend. # noqa: E501
- Upated time of the lending order # noqa: E501
+ Lending Order Last Update Time # noqa: E501
:return: The update_time of this UniLend. # noqa: E501
:rtype: int
@@ -320,7 +320,7 @@ def update_time(self):
def update_time(self, update_time):
"""Sets the update_time of this UniLend.
- Upated time of the lending order # noqa: E501
+ Lending Order Last Update Time # noqa: E501
:param update_time: The update_time of this UniLend. # noqa: E501
:type: int
diff --git a/gate_api/models/uni_lend_interest.py b/gate_api/models/uni_lend_interest.py
index ccbfa43..80f3a0a 100644
--- a/gate_api/models/uni_lend_interest.py
+++ b/gate_api/models/uni_lend_interest.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def currency(self, currency):
def interest(self):
"""Gets the interest of this UniLendInterest. # noqa: E501
- Interest # noqa: E501
+ Interest income # noqa: E501
:return: The interest of this UniLendInterest. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def interest(self):
def interest(self, interest):
"""Sets the interest of this UniLendInterest.
- Interest # noqa: E501
+ Interest income # noqa: E501
:param interest: The interest of this UniLendInterest. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_lend_record.py b/gate_api/models/uni_lend_record.py
index 14095af..a435111 100644
--- a/gate_api/models/uni_lend_record.py
+++ b/gate_api/models/uni_lend_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -110,7 +110,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this UniLendRecord. # noqa: E501
- current amount # noqa: E501
+ Current Amount # noqa: E501
:return: The amount of this UniLendRecord. # noqa: E501
:rtype: str
@@ -121,7 +121,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UniLendRecord.
- current amount # noqa: E501
+ Current Amount # noqa: E501
:param amount: The amount of this UniLendRecord. # noqa: E501
:type: str
@@ -133,7 +133,7 @@ def amount(self, amount):
def last_wallet_amount(self):
"""Gets the last_wallet_amount of this UniLendRecord. # noqa: E501
- Last wallet amount # noqa: E501
+ Previous Available Amount # noqa: E501
:return: The last_wallet_amount of this UniLendRecord. # noqa: E501
:rtype: str
@@ -144,7 +144,7 @@ def last_wallet_amount(self):
def last_wallet_amount(self, last_wallet_amount):
"""Sets the last_wallet_amount of this UniLendRecord.
- Last wallet amount # noqa: E501
+ Previous Available Amount # noqa: E501
:param last_wallet_amount: The last_wallet_amount of this UniLendRecord. # noqa: E501
:type: str
@@ -156,7 +156,7 @@ def last_wallet_amount(self, last_wallet_amount):
def last_lent_amount(self):
"""Gets the last_lent_amount of this UniLendRecord. # noqa: E501
- Last lent amount # noqa: E501
+ Previous Lent Amount # noqa: E501
:return: The last_lent_amount of this UniLendRecord. # noqa: E501
:rtype: str
@@ -167,7 +167,7 @@ def last_lent_amount(self):
def last_lent_amount(self, last_lent_amount):
"""Sets the last_lent_amount of this UniLendRecord.
- Last lent amount # noqa: E501
+ Previous Lent Amount # noqa: E501
:param last_lent_amount: The last_lent_amount of this UniLendRecord. # noqa: E501
:type: str
@@ -179,7 +179,7 @@ def last_lent_amount(self, last_lent_amount):
def last_frozen_amount(self):
"""Gets the last_frozen_amount of this UniLendRecord. # noqa: E501
- Last frozen amount # noqa: E501
+ Previous Frozen Amount # noqa: E501
:return: The last_frozen_amount of this UniLendRecord. # noqa: E501
:rtype: str
@@ -190,7 +190,7 @@ def last_frozen_amount(self):
def last_frozen_amount(self, last_frozen_amount):
"""Sets the last_frozen_amount of this UniLendRecord.
- Last frozen amount # noqa: E501
+ Previous Frozen Amount # noqa: E501
:param last_frozen_amount: The last_frozen_amount of this UniLendRecord. # noqa: E501
:type: str
@@ -202,7 +202,7 @@ def last_frozen_amount(self, last_frozen_amount):
def type(self):
"""Gets the type of this UniLendRecord. # noqa: E501
- Record type: lend - lend, redeem - redeem # noqa: E501
+ Record Type: lend - Lend, redeem - Redeem # noqa: E501
:return: The type of this UniLendRecord. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UniLendRecord.
- Record type: lend - lend, redeem - redeem # noqa: E501
+ Record Type: lend - Lend, redeem - Redeem # noqa: E501
:param type: The type of this UniLendRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_loan.py b/gate_api/models/uni_loan.py
index 0ae80fd..0010ef5 100644
--- a/gate_api/models/uni_loan.py
+++ b/gate_api/models/uni_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -128,7 +128,7 @@ def currency_pair(self, currency_pair):
def amount(self):
"""Gets the amount of this UniLoan. # noqa: E501
- amount # noqa: E501
+ Amount to Repay # noqa: E501
:return: The amount of this UniLoan. # noqa: E501
:rtype: str
@@ -139,7 +139,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UniLoan.
- amount # noqa: E501
+ Amount to Repay # noqa: E501
:param amount: The amount of this UniLoan. # noqa: E501
:type: str
@@ -151,7 +151,7 @@ def amount(self, amount):
def type(self):
"""Gets the type of this UniLoan. # noqa: E501
- Loan type, platform - platform, margin - margin # noqa: E501
+ Loan type: platform borrowing - platform, margin borrowing - margin # noqa: E501
:return: The type of this UniLoan. # noqa: E501
:rtype: str
@@ -162,7 +162,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UniLoan.
- Loan type, platform - platform, margin - margin # noqa: E501
+ Loan type: platform borrowing - platform, margin borrowing - margin # noqa: E501
:param type: The type of this UniLoan. # noqa: E501
:type: str
@@ -197,7 +197,7 @@ def create_time(self, create_time):
def update_time(self):
"""Gets the update_time of this UniLoan. # noqa: E501
- Updated time # noqa: E501
+ Last Update Time # noqa: E501
:return: The update_time of this UniLoan. # noqa: E501
:rtype: int
@@ -208,7 +208,7 @@ def update_time(self):
def update_time(self, update_time):
"""Sets the update_time of this UniLoan.
- Updated time # noqa: E501
+ Last Update Time # noqa: E501
:param update_time: The update_time of this UniLoan. # noqa: E501
:type: int
diff --git a/gate_api/models/uni_loan_interest_record.py b/gate_api/models/uni_loan_interest_record.py
index 2327f01..537866f 100644
--- a/gate_api/models/uni_loan_interest_record.py
+++ b/gate_api/models/uni_loan_interest_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -133,7 +133,7 @@ def currency_pair(self, currency_pair):
def actual_rate(self):
"""Gets the actual_rate of this UniLoanInterestRecord. # noqa: E501
- Actual rate # noqa: E501
+ Actual Rate # noqa: E501
:return: The actual_rate of this UniLoanInterestRecord. # noqa: E501
:rtype: str
@@ -144,7 +144,7 @@ def actual_rate(self):
def actual_rate(self, actual_rate):
"""Sets the actual_rate of this UniLoanInterestRecord.
- Actual rate # noqa: E501
+ Actual Rate # noqa: E501
:param actual_rate: The actual_rate of this UniLoanInterestRecord. # noqa: E501
:type: str
@@ -202,7 +202,7 @@ def status(self, status):
def type(self):
"""Gets the type of this UniLoanInterestRecord. # noqa: E501
- Type, platform - platform，margin - margin # noqa: E501
+ Type: platform - Platform borrowing, margin - Margin borrowing # noqa: E501
:return: The type of this UniLoanInterestRecord. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UniLoanInterestRecord.
- Type, platform - platform，margin - margin # noqa: E501
+ Type: platform - Platform borrowing, margin - Margin borrowing # noqa: E501
:param type: The type of this UniLoanInterestRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/uni_loan_record.py b/gate_api/models/uni_loan_record.py
index 900a247..460120b 100644
--- a/gate_api/models/uni_loan_record.py
+++ b/gate_api/models/uni_loan_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -77,7 +77,7 @@ def __init__(self, type=None, currency_pair=None, currency=None, amount=None, cr
def type(self):
"""Gets the type of this UniLoanRecord. # noqa: E501
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:return: The type of this UniLoanRecord. # noqa: E501
:rtype: str
@@ -88,7 +88,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UniLoanRecord.
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:param type: The type of this UniLoanRecord. # noqa: E501
:type: str
@@ -146,7 +146,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this UniLoanRecord. # noqa: E501
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:return: The amount of this UniLoanRecord. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UniLoanRecord.
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:param amount: The amount of this UniLoanRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_account.py b/gate_api/models/unified_account.py
index 3ae2673..7c3f5e4 100644
--- a/gate_api/models/unified_account.py
+++ b/gate_api/models/unified_account.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -51,7 +51,8 @@ class UnifiedAccount(object):
'leverage': 'str',
'spot_order_loss': 'str',
'spot_hedge': 'bool',
- 'use_funding': 'bool'
+ 'use_funding': 'bool',
+ 'is_all_collateral': 'bool'
}
attribute_map = {
@@ -73,11 +74,12 @@ class UnifiedAccount(object):
'leverage': 'leverage',
'spot_order_loss': 'spot_order_loss',
'spot_hedge': 'spot_hedge',
- 'use_funding': 'use_funding'
+ 'use_funding': 'use_funding',
+ 'is_all_collateral': 'is_all_collateral'
}
- def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None, total=None, borrowed=None, total_initial_margin=None, total_margin_balance=None, total_maintenance_margin=None, total_initial_margin_rate=None, total_maintenance_margin_rate=None, total_available_margin=None, unified_account_total=None, unified_account_total_liab=None, unified_account_total_equity=None, leverage=None, spot_order_loss=None, spot_hedge=None, use_funding=None, local_vars_configuration=None): # noqa: E501
- # type: (int, int, bool, dict(str, UnifiedBalance), str, str, str, str, str, str, str, str, str, str, str, str, str, bool, bool, Configuration) -> None
+ def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None, total=None, borrowed=None, total_initial_margin=None, total_margin_balance=None, total_maintenance_margin=None, total_initial_margin_rate=None, total_maintenance_margin_rate=None, total_available_margin=None, unified_account_total=None, unified_account_total_liab=None, unified_account_total_equity=None, leverage=None, spot_order_loss=None, spot_hedge=None, use_funding=None, is_all_collateral=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, int, bool, dict(str, UnifiedBalance), str, str, str, str, str, str, str, str, str, str, str, str, str, bool, bool, bool, Configuration) -> None
"""UnifiedAccount - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -102,6 +104,7 @@ def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None,
self._spot_order_loss = None
self._spot_hedge = None
self._use_funding = None
+ self._is_all_collateral = None
self.discriminator = None
if user_id is not None:
@@ -142,6 +145,8 @@ def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None,
self.spot_hedge = spot_hedge
if use_funding is not None:
self.use_funding = use_funding
+ if is_all_collateral is not None:
+ self.is_all_collateral = is_all_collateral
@property
def user_id(self):
@@ -170,7 +175,7 @@ def user_id(self, user_id):
def refresh_time(self):
"""Gets the refresh_time of this UnifiedAccount. # noqa: E501
- Time of the most recent refresh # noqa: E501
+ Last refresh time # noqa: E501
:return: The refresh_time of this UnifiedAccount. # noqa: E501
:rtype: int
@@ -181,7 +186,7 @@ def refresh_time(self):
def refresh_time(self, refresh_time):
"""Sets the refresh_time of this UnifiedAccount.
- Time of the most recent refresh # noqa: E501
+ Last refresh time # noqa: E501
:param refresh_time: The refresh_time of this UnifiedAccount. # noqa: E501
:type: int
@@ -237,7 +242,7 @@ def balances(self, balances):
def total(self):
"""Gets the total of this UnifiedAccount. # noqa: E501
- Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be deprecated, replaced by unified_account_total) # noqa: E501
+ Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be removed, replaced by unified_account_total) # noqa: E501
:return: The total of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -248,7 +253,7 @@ def total(self):
def total(self, total):
"""Sets the total of this UnifiedAccount.
- Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be deprecated, replaced by unified_account_total) # noqa: E501
+ Total account assets converted to USD, i.e. the sum of `(available + freeze) * price` in all currencies (deprecated, to be removed, replaced by unified_account_total) # noqa: E501
:param total: The total of this UnifiedAccount. # noqa: E501
:type: str
@@ -260,7 +265,7 @@ def total(self, total):
def borrowed(self):
"""Gets the borrowed of this UnifiedAccount. # noqa: E501
- The total borrowed amount of the account converted into USD, i.e. the sum of `borrowed * price` of all currencies (excluding Point Cards). It is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode. # noqa: E501
+ Total borrowed amount converted to USD, i.e. the sum of `borrowed * price` of all currencies (excluding point cards), valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:return: The borrowed of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -271,7 +276,7 @@ def borrowed(self):
def borrowed(self, borrowed):
"""Sets the borrowed of this UnifiedAccount.
- The total borrowed amount of the account converted into USD, i.e. the sum of `borrowed * price` of all currencies (excluding Point Cards). It is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode. # noqa: E501
+ Total borrowed amount converted to USD, i.e. the sum of `borrowed * price` of all currencies (excluding point cards), valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:param borrowed: The borrowed of this UnifiedAccount. # noqa: E501
:type: str
@@ -421,7 +426,7 @@ def total_available_margin(self, total_available_margin):
def unified_account_total(self):
"""Gets the unified_account_total of this UnifiedAccount. # noqa: E501
- Unify the total account assets, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Total unified account assets, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:return: The unified_account_total of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -432,7 +437,7 @@ def unified_account_total(self):
def unified_account_total(self, unified_account_total):
"""Sets the unified_account_total of this UnifiedAccount.
- Unify the total account assets, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Total unified account assets, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:param unified_account_total: The unified_account_total of this UnifiedAccount. # noqa: E501
:type: str
@@ -444,7 +449,7 @@ def unified_account_total(self, unified_account_total):
def unified_account_total_liab(self):
"""Gets the unified_account_total_liab of this UnifiedAccount. # noqa: E501
- Unify the total loan of the account, valid in the cross-currency margin/combined margin mode, and 0 in other modes such as single-currency margin mode # noqa: E501
+ Total unified account borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:return: The unified_account_total_liab of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -455,7 +460,7 @@ def unified_account_total_liab(self):
def unified_account_total_liab(self, unified_account_total_liab):
"""Sets the unified_account_total_liab of this UnifiedAccount.
- Unify the total loan of the account, valid in the cross-currency margin/combined margin mode, and 0 in other modes such as single-currency margin mode # noqa: E501
+ Total unified account borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:param unified_account_total_liab: The unified_account_total_liab of this UnifiedAccount. # noqa: E501
:type: str
@@ -467,7 +472,7 @@ def unified_account_total_liab(self, unified_account_total_liab):
def unified_account_total_equity(self):
"""Gets the unified_account_total_equity of this UnifiedAccount. # noqa: E501
- Unify the total account equity, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Total unified account equity, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:return: The unified_account_total_equity of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -478,7 +483,7 @@ def unified_account_total_equity(self):
def unified_account_total_equity(self, unified_account_total_equity):
"""Sets the unified_account_total_equity of this UnifiedAccount.
- Unify the total account equity, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Total unified account equity, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:param unified_account_total_equity: The unified_account_total_equity of this UnifiedAccount. # noqa: E501
:type: str
@@ -490,7 +495,7 @@ def unified_account_total_equity(self, unified_account_total_equity):
def leverage(self):
"""Gets the leverage of this UnifiedAccount. # noqa: E501
- Actual leverage, valid in cross-currency margin/combined margin mode # noqa: E501
+ Actual leverage ratio, valid in cross-currency margin/combined margin mode # noqa: E501
:return: The leverage of this UnifiedAccount. # noqa: E501
:rtype: str
@@ -501,7 +506,7 @@ def leverage(self):
def leverage(self, leverage):
"""Sets the leverage of this UnifiedAccount.
- Actual leverage, valid in cross-currency margin/combined margin mode # noqa: E501
+ Actual leverage ratio, valid in cross-currency margin/combined margin mode # noqa: E501
:param leverage: The leverage of this UnifiedAccount. # noqa: E501
:type: str
@@ -536,7 +541,7 @@ def spot_order_loss(self, spot_order_loss):
def spot_hedge(self):
"""Gets the spot_hedge of this UnifiedAccount. # noqa: E501
- Spot hedging status, true - enabled, false - not enabled. # noqa: E501
+ Spot hedging status: true - enabled, false - disabled # noqa: E501
:return: The spot_hedge of this UnifiedAccount. # noqa: E501
:rtype: bool
@@ -547,7 +552,7 @@ def spot_hedge(self):
def spot_hedge(self, spot_hedge):
"""Sets the spot_hedge of this UnifiedAccount.
- Spot hedging status, true - enabled, false - not enabled. # noqa: E501
+ Spot hedging status: true - enabled, false - disabled # noqa: E501
:param spot_hedge: The spot_hedge of this UnifiedAccount. # noqa: E501
:type: bool
@@ -559,7 +564,7 @@ def spot_hedge(self, spot_hedge):
def use_funding(self):
"""Gets the use_funding of this UnifiedAccount. # noqa: E501
- Whether to use funds as margin # noqa: E501
+ Whether to use Earn funds as margin # noqa: E501
:return: The use_funding of this UnifiedAccount. # noqa: E501
:rtype: bool
@@ -570,7 +575,7 @@ def use_funding(self):
def use_funding(self, use_funding):
"""Sets the use_funding of this UnifiedAccount.
- Whether to use funds as margin # noqa: E501
+ Whether to use Earn funds as margin # noqa: E501
:param use_funding: The use_funding of this UnifiedAccount. # noqa: E501
:type: bool
@@ -578,6 +583,29 @@ def use_funding(self, use_funding):
self._use_funding = use_funding
+ @property
+ def is_all_collateral(self):
+ """Gets the is_all_collateral of this UnifiedAccount. # noqa: E501
+
+ Whether all currencies are used as margin: true - all currencies as margin, false - no # noqa: E501
+
+ :return: The is_all_collateral of this UnifiedAccount. # noqa: E501
+ :rtype: bool
+ """
+ return self._is_all_collateral
+
+ @is_all_collateral.setter
+ def is_all_collateral(self, is_all_collateral):
+ """Sets the is_all_collateral of this UnifiedAccount.
+
+ Whether all currencies are used as margin: true - all currencies as margin, false - no # noqa: E501
+
+ :param is_all_collateral: The is_all_collateral of this UnifiedAccount. # noqa: E501
+ :type: bool
+ """
+
+ self._is_all_collateral = is_all_collateral
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/unified_balance.py b/gate_api/models/unified_balance.py
index c6390e9..1d7171a 100644
--- a/gate_api/models/unified_balance.py
+++ b/gate_api/models/unified_balance.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -51,7 +51,8 @@ class UnifiedBalance(object):
'imr': 'str',
'mmr': 'str',
'margin_balance': 'str',
- 'available_margin': 'str'
+ 'available_margin': 'str',
+ 'enabled_collateral': 'bool'
}
attribute_map = {
@@ -73,11 +74,12 @@ class UnifiedBalance(object):
'imr': 'imr',
'mmr': 'mmr',
'margin_balance': 'margin_balance',
- 'available_margin': 'available_margin'
+ 'available_margin': 'available_margin',
+ 'enabled_collateral': 'enabled_collateral'
}
- def __init__(self, available=None, freeze=None, borrowed=None, negative_liab=None, futures_pos_liab=None, equity=None, total_freeze=None, total_liab=None, spot_in_use=None, funding=None, funding_version=None, cross_balance=None, iso_balance=None, im=None, mm=None, imr=None, mmr=None, margin_balance=None, available_margin=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, available=None, freeze=None, borrowed=None, negative_liab=None, futures_pos_liab=None, equity=None, total_freeze=None, total_liab=None, spot_in_use=None, funding=None, funding_version=None, cross_balance=None, iso_balance=None, im=None, mm=None, imr=None, mmr=None, margin_balance=None, available_margin=None, enabled_collateral=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, str, bool, Configuration) -> None
"""UnifiedBalance - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -102,6 +104,7 @@ def __init__(self, available=None, freeze=None, borrowed=None, negative_liab=Non
self._mmr = None
self._margin_balance = None
self._available_margin = None
+ self._enabled_collateral = None
self.discriminator = None
if available is not None:
@@ -142,12 +145,14 @@ def __init__(self, available=None, freeze=None, borrowed=None, negative_liab=Non
self.margin_balance = margin_balance
if available_margin is not None:
self.available_margin = available_margin
+ if enabled_collateral is not None:
+ self.enabled_collateral = enabled_collateral
@property
def available(self):
"""Gets the available of this UnifiedBalance. # noqa: E501
- Available amount is valid in single currency margin/cross-currency margin/combined margin mode, and the calculation is different in different modes # noqa: E501
+ Available balance, valid in single currency margin/cross-currency margin/combined margin mode, calculation varies by mode # noqa: E501
:return: The available of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -158,7 +163,7 @@ def available(self):
def available(self, available):
"""Sets the available of this UnifiedBalance.
- Available amount is valid in single currency margin/cross-currency margin/combined margin mode, and the calculation is different in different modes # noqa: E501
+ Available balance, valid in single currency margin/cross-currency margin/combined margin mode, calculation varies by mode # noqa: E501
:param available: The available of this UnifiedBalance. # noqa: E501
:type: str
@@ -170,7 +175,7 @@ def available(self, available):
def freeze(self):
"""Gets the freeze of this UnifiedBalance. # noqa: E501
- The locked amount is valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Locked balance, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:return: The freeze of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -181,7 +186,7 @@ def freeze(self):
def freeze(self, freeze):
"""Sets the freeze of this UnifiedBalance.
- The locked amount is valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
+ Locked balance, valid in single currency margin/cross-currency margin/combined margin mode # noqa: E501
:param freeze: The freeze of this UnifiedBalance. # noqa: E501
:type: str
@@ -193,7 +198,7 @@ def freeze(self, freeze):
def borrowed(self):
"""Gets the borrowed of this UnifiedBalance. # noqa: E501
- Borrow limit, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
+ Borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:return: The borrowed of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -204,7 +209,7 @@ def borrowed(self):
def borrowed(self, borrowed):
"""Sets the borrowed of this UnifiedBalance.
- Borrow limit, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
+ Borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:param borrowed: The borrowed of this UnifiedBalance. # noqa: E501
:type: str
@@ -216,7 +221,7 @@ def borrowed(self, borrowed):
def negative_liab(self):
"""Gets the negative_liab of this UnifiedBalance. # noqa: E501
- Negative balance loan is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode # noqa: E501
+ Negative balance borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:return: The negative_liab of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -227,7 +232,7 @@ def negative_liab(self):
def negative_liab(self, negative_liab):
"""Sets the negative_liab of this UnifiedBalance.
- Negative balance loan is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode # noqa: E501
+ Negative balance borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:param negative_liab: The negative_liab of this UnifiedBalance. # noqa: E501
:type: str
@@ -285,7 +290,7 @@ def equity(self, equity):
def total_freeze(self):
"""Gets the total_freeze of this UnifiedBalance. # noqa: E501
- Total occupancy (discarded, to be offline field) # noqa: E501
+ Total frozen (deprecated, to be removed) # noqa: E501
:return: The total_freeze of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -296,7 +301,7 @@ def total_freeze(self):
def total_freeze(self, total_freeze):
"""Sets the total_freeze of this UnifiedBalance.
- Total occupancy (discarded, to be offline field) # noqa: E501
+ Total frozen (deprecated, to be removed) # noqa: E501
:param total_freeze: The total_freeze of this UnifiedBalance. # noqa: E501
:type: str
@@ -308,7 +313,7 @@ def total_freeze(self, total_freeze):
def total_liab(self):
"""Gets the total_liab of this UnifiedBalance. # noqa: E501
- Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
+ Total borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:return: The total_liab of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -319,7 +324,7 @@ def total_liab(self):
def total_liab(self, total_liab):
"""Sets the total_liab of this UnifiedBalance.
- Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
+ Total borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode # noqa: E501
:param total_liab: The total_liab of this UnifiedBalance. # noqa: E501
:type: str
@@ -354,7 +359,7 @@ def spot_in_use(self, spot_in_use):
def funding(self):
"""Gets the funding of this UnifiedBalance. # noqa: E501
- Yubibao financial management amount, effective when Yubibao financial management is turned on as a unified account margin switch # noqa: E501
+ Uniloan financial management amount, effective when turned on as a unified account margin switch # noqa: E501
:return: The funding of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -365,7 +370,7 @@ def funding(self):
def funding(self, funding):
"""Sets the funding of this UnifiedBalance.
- Yubibao financial management amount, effective when Yubibao financial management is turned on as a unified account margin switch # noqa: E501
+ Uniloan financial management amount, effective when turned on as a unified account margin switch # noqa: E501
:param funding: The funding of this UnifiedBalance. # noqa: E501
:type: str
@@ -469,7 +474,7 @@ def im(self, im):
def mm(self):
"""Gets the mm of this UnifiedBalance. # noqa: E501
- 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 # noqa: E501
+ Cross margin maintenance margin, valid in single-currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
:return: The mm of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -480,7 +485,7 @@ def mm(self):
def mm(self, mm):
"""Sets the mm of this UnifiedBalance.
- 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 # noqa: E501
+ Cross margin maintenance margin, valid in single-currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
:param mm: The mm of this UnifiedBalance. # noqa: E501
:type: str
@@ -561,7 +566,7 @@ def margin_balance(self, margin_balance):
def available_margin(self):
"""Gets the available_margin of this UnifiedBalance. # noqa: E501
- Full margin available for full position is valid in single currency margin mode, and is 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
+ Cross margin available balance, valid in single currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
:return: The available_margin of this UnifiedBalance. # noqa: E501
:rtype: str
@@ -572,7 +577,7 @@ def available_margin(self):
def available_margin(self, available_margin):
"""Sets the available_margin of this UnifiedBalance.
- Full margin available for full position is valid in single currency margin mode, and is 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
+ Cross margin available balance, valid in single currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode # noqa: E501
:param available_margin: The available_margin of this UnifiedBalance. # noqa: E501
:type: str
@@ -580,6 +585,29 @@ def available_margin(self, available_margin):
self._available_margin = available_margin
+ @property
+ def enabled_collateral(self):
+ """Gets the enabled_collateral of this UnifiedBalance. # noqa: E501
+
+ Currency enabled as margin: true - Enabled, false - Disabled # noqa: E501
+
+ :return: The enabled_collateral of this UnifiedBalance. # noqa: E501
+ :rtype: bool
+ """
+ return self._enabled_collateral
+
+ @enabled_collateral.setter
+ def enabled_collateral(self, enabled_collateral):
+ """Sets the enabled_collateral of this UnifiedBalance.
+
+ Currency enabled as margin: true - Enabled, false - Disabled # noqa: E501
+
+ :param enabled_collateral: The enabled_collateral of this UnifiedBalance. # noqa: E501
+ :type: bool
+ """
+
+ self._enabled_collateral = enabled_collateral
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/gate_api/models/unified_borrowable.py b/gate_api/models/unified_borrowable.py
index d61ad46..7201c76 100644
--- a/gate_api/models/unified_borrowable.py
+++ b/gate_api/models/unified_borrowable.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/cross_margin_transferable.py b/gate_api/models/unified_borrowable1.py
similarity index 73%
rename from gate_api/models/cross_margin_transferable.py
rename to gate_api/models/unified_borrowable1.py
index 531070e..626d1af 100644
--- a/gate_api/models/cross_margin_transferable.py
+++ b/gate_api/models/unified_borrowable1.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -18,7 +18,7 @@
from gate_api.configuration import Configuration
-class CrossMarginTransferable(object):
+class UnifiedBorrowable1(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
@@ -44,7 +44,7 @@ class CrossMarginTransferable(object):
def __init__(self, currency=None, amount=None, local_vars_configuration=None): # noqa: E501
# type: (str, str, Configuration) -> None
- """CrossMarginTransferable - a model defined in OpenAPI""" # noqa: E501
+ """UnifiedBorrowable1 - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
@@ -60,22 +60,22 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None):
@property
def currency(self):
- """Gets the currency of this CrossMarginTransferable. # noqa: E501
+ """Gets the currency of this UnifiedBorrowable1. # noqa: E501
Currency detail # noqa: E501
- :return: The currency of this CrossMarginTransferable. # noqa: E501
+ :return: The currency of this UnifiedBorrowable1. # noqa: E501
:rtype: str
"""
return self._currency
@currency.setter
def currency(self, currency):
- """Sets the currency of this CrossMarginTransferable.
+ """Sets the currency of this UnifiedBorrowable1.
Currency detail # noqa: E501
- :param currency: The currency of this CrossMarginTransferable. # noqa: E501
+ :param currency: The currency of this UnifiedBorrowable1. # noqa: E501
:type: str
"""
@@ -83,22 +83,22 @@ def currency(self, currency):
@property
def amount(self):
- """Gets the amount of this CrossMarginTransferable. # noqa: E501
+ """Gets the amount of this UnifiedBorrowable1. # noqa: E501
- Max transferable amount # noqa: E501
+ Maximum borrowable amount # noqa: E501
- :return: The amount of this CrossMarginTransferable. # noqa: E501
+ :return: The amount of this UnifiedBorrowable1. # noqa: E501
:rtype: str
"""
return self._amount
@amount.setter
def amount(self, amount):
- """Sets the amount of this CrossMarginTransferable.
+ """Sets the amount of this UnifiedBorrowable1.
- Max transferable amount # noqa: E501
+ Maximum borrowable amount # noqa: E501
- :param amount: The amount of this CrossMarginTransferable. # noqa: E501
+ :param amount: The amount of this UnifiedBorrowable1. # noqa: E501
:type: str
"""
@@ -138,14 +138,14 @@ def __repr__(self):
def __eq__(self, other):
"""Returns true if both objects are equal"""
- if not isinstance(other, CrossMarginTransferable):
+ if not isinstance(other, UnifiedBorrowable1):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
- if not isinstance(other, CrossMarginTransferable):
+ if not isinstance(other, UnifiedBorrowable1):
return True
return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/unified_collateral_req.py b/gate_api/models/unified_collateral_req.py
new file mode 100644
index 0000000..6e4c9c2
--- /dev/null
+++ b/gate_api/models/unified_collateral_req.py
@@ -0,0 +1,185 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UnifiedCollateralReq(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'collateral_type': 'int',
+ 'enable_list': 'list[str]',
+ 'disable_list': 'list[str]'
+ }
+
+ attribute_map = {
+ 'collateral_type': 'collateral_type',
+ 'enable_list': 'enable_list',
+ 'disable_list': 'disable_list'
+ }
+
+ def __init__(self, collateral_type=None, enable_list=None, disable_list=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, list[str], list[str], Configuration) -> None
+ """UnifiedCollateralReq - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._collateral_type = None
+ self._enable_list = None
+ self._disable_list = None
+ self.discriminator = None
+
+ if collateral_type is not None:
+ self.collateral_type = collateral_type
+ if enable_list is not None:
+ self.enable_list = enable_list
+ if disable_list is not None:
+ self.disable_list = disable_list
+
+ @property
+ def collateral_type(self):
+ """Gets the collateral_type of this UnifiedCollateralReq. # noqa: E501
+
+ User-set collateral mode: 0(all)-All currencies as collateral, 1(custom)-Custom currencies as collateral. When collateral_type is 0(all), enable_list and disable_list parameters are invalid # noqa: E501
+
+ :return: The collateral_type of this UnifiedCollateralReq. # noqa: E501
+ :rtype: int
+ """
+ return self._collateral_type
+
+ @collateral_type.setter
+ def collateral_type(self, collateral_type):
+ """Sets the collateral_type of this UnifiedCollateralReq.
+
+ User-set collateral mode: 0(all)-All currencies as collateral, 1(custom)-Custom currencies as collateral. When collateral_type is 0(all), enable_list and disable_list parameters are invalid # noqa: E501
+
+ :param collateral_type: The collateral_type of this UnifiedCollateralReq. # noqa: E501
+ :type: int
+ """
+ allowed_values = [0, 1] # noqa: E501
+ if self.local_vars_configuration.client_side_validation and collateral_type not in allowed_values: # noqa: E501
+ raise ValueError(
+ "Invalid value for `collateral_type` ({0}), must be one of {1}" # noqa: E501
+ .format(collateral_type, allowed_values)
+ )
+
+ self._collateral_type = collateral_type
+
+ @property
+ def enable_list(self):
+ """Gets the enable_list of this UnifiedCollateralReq. # noqa: E501
+
+ Currency list, where collateral_type=1(custom) indicates the addition logic # noqa: E501
+
+ :return: The enable_list of this UnifiedCollateralReq. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._enable_list
+
+ @enable_list.setter
+ def enable_list(self, enable_list):
+ """Sets the enable_list of this UnifiedCollateralReq.
+
+ Currency list, where collateral_type=1(custom) indicates the addition logic # noqa: E501
+
+ :param enable_list: The enable_list of this UnifiedCollateralReq. # noqa: E501
+ :type: list[str]
+ """
+
+ self._enable_list = enable_list
+
+ @property
+ def disable_list(self):
+ """Gets the disable_list of this UnifiedCollateralReq. # noqa: E501
+
+ Disable list, indicating the disable logic # noqa: E501
+
+ :return: The disable_list of this UnifiedCollateralReq. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._disable_list
+
+ @disable_list.setter
+ def disable_list(self, disable_list):
+ """Sets the disable_list of this UnifiedCollateralReq.
+
+ Disable list, indicating the disable logic # noqa: E501
+
+ :param disable_list: The disable_list of this UnifiedCollateralReq. # noqa: E501
+ :type: list[str]
+ """
+
+ self._disable_list = disable_list
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UnifiedCollateralReq):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UnifiedCollateralReq):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/unified_collateral_res.py b/gate_api/models/unified_collateral_res.py
new file mode 100644
index 0000000..a1cd842
--- /dev/null
+++ b/gate_api/models/unified_collateral_res.py
@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UnifiedCollateralRes(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'is_success': 'bool'
+ }
+
+ attribute_map = {
+ 'is_success': 'is_success'
+ }
+
+ def __init__(self, is_success=None, local_vars_configuration=None): # noqa: E501
+ # type: (bool, Configuration) -> None
+ """UnifiedCollateralRes - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._is_success = None
+ self.discriminator = None
+
+ if is_success is not None:
+ self.is_success = is_success
+
+ @property
+ def is_success(self):
+ """Gets the is_success of this UnifiedCollateralRes. # noqa: E501
+
+ Whether the setting was successful # noqa: E501
+
+ :return: The is_success of this UnifiedCollateralRes. # noqa: E501
+ :rtype: bool
+ """
+ return self._is_success
+
+ @is_success.setter
+ def is_success(self, is_success):
+ """Sets the is_success of this UnifiedCollateralRes.
+
+ Whether the setting was successful # noqa: E501
+
+ :param is_success: The is_success of this UnifiedCollateralRes. # noqa: E501
+ :type: bool
+ """
+
+ self._is_success = is_success
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UnifiedCollateralRes):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UnifiedCollateralRes):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/unified_currency.py b/gate_api/models/unified_currency.py
new file mode 100644
index 0000000..1039e91
--- /dev/null
+++ b/gate_api/models/unified_currency.py
@@ -0,0 +1,263 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UnifiedCurrency(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'name': 'str',
+ 'prec': 'str',
+ 'min_borrow_amount': 'str',
+ 'user_max_borrow_amount': 'str',
+ 'total_max_borrow_amount': 'str',
+ 'loan_status': 'str'
+ }
+
+ attribute_map = {
+ 'name': 'name',
+ 'prec': 'prec',
+ 'min_borrow_amount': 'min_borrow_amount',
+ 'user_max_borrow_amount': 'user_max_borrow_amount',
+ 'total_max_borrow_amount': 'total_max_borrow_amount',
+ 'loan_status': 'loan_status'
+ }
+
+ def __init__(self, name=None, prec=None, min_borrow_amount=None, user_max_borrow_amount=None, total_max_borrow_amount=None, loan_status=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, Configuration) -> None
+ """UnifiedCurrency - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._name = None
+ self._prec = None
+ self._min_borrow_amount = None
+ self._user_max_borrow_amount = None
+ self._total_max_borrow_amount = None
+ self._loan_status = None
+ self.discriminator = None
+
+ if name is not None:
+ self.name = name
+ if prec is not None:
+ self.prec = prec
+ if min_borrow_amount is not None:
+ self.min_borrow_amount = min_borrow_amount
+ if user_max_borrow_amount is not None:
+ self.user_max_borrow_amount = user_max_borrow_amount
+ if total_max_borrow_amount is not None:
+ self.total_max_borrow_amount = total_max_borrow_amount
+ if loan_status is not None:
+ self.loan_status = loan_status
+
+ @property
+ def name(self):
+ """Gets the name of this UnifiedCurrency. # noqa: E501
+
+ Currency name # noqa: E501
+
+ :return: The name of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this UnifiedCurrency.
+
+ Currency name # noqa: E501
+
+ :param name: The name of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def prec(self):
+ """Gets the prec of this UnifiedCurrency. # noqa: E501
+
+ Currency precision # noqa: E501
+
+ :return: The prec of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._prec
+
+ @prec.setter
+ def prec(self, prec):
+ """Sets the prec of this UnifiedCurrency.
+
+ Currency precision # noqa: E501
+
+ :param prec: The prec of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._prec = prec
+
+ @property
+ def min_borrow_amount(self):
+ """Gets the min_borrow_amount of this UnifiedCurrency. # noqa: E501
+
+ Minimum borrowable limit, in currency units # noqa: E501
+
+ :return: The min_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._min_borrow_amount
+
+ @min_borrow_amount.setter
+ def min_borrow_amount(self, min_borrow_amount):
+ """Sets the min_borrow_amount of this UnifiedCurrency.
+
+ Minimum borrowable limit, in currency units # noqa: E501
+
+ :param min_borrow_amount: The min_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._min_borrow_amount = min_borrow_amount
+
+ @property
+ def user_max_borrow_amount(self):
+ """Gets the user_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+
+ User's maximum borrowable limit, in USDT # noqa: E501
+
+ :return: The user_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._user_max_borrow_amount
+
+ @user_max_borrow_amount.setter
+ def user_max_borrow_amount(self, user_max_borrow_amount):
+ """Sets the user_max_borrow_amount of this UnifiedCurrency.
+
+ User's maximum borrowable limit, in USDT # noqa: E501
+
+ :param user_max_borrow_amount: The user_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._user_max_borrow_amount = user_max_borrow_amount
+
+ @property
+ def total_max_borrow_amount(self):
+ """Gets the total_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+
+ Platform's maximum borrowable limit, in USDT # noqa: E501
+
+ :return: The total_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._total_max_borrow_amount
+
+ @total_max_borrow_amount.setter
+ def total_max_borrow_amount(self, total_max_borrow_amount):
+ """Sets the total_max_borrow_amount of this UnifiedCurrency.
+
+ Platform's maximum borrowable limit, in USDT # noqa: E501
+
+ :param total_max_borrow_amount: The total_max_borrow_amount of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._total_max_borrow_amount = total_max_borrow_amount
+
+ @property
+ def loan_status(self):
+ """Gets the loan_status of this UnifiedCurrency. # noqa: E501
+
+ Lending status - `disable` : Lending prohibited - `enable` : Lending supported # noqa: E501
+
+ :return: The loan_status of this UnifiedCurrency. # noqa: E501
+ :rtype: str
+ """
+ return self._loan_status
+
+ @loan_status.setter
+ def loan_status(self, loan_status):
+ """Sets the loan_status of this UnifiedCurrency.
+
+ Lending status - `disable` : Lending prohibited - `enable` : Lending supported # noqa: E501
+
+ :param loan_status: The loan_status of this UnifiedCurrency. # noqa: E501
+ :type: str
+ """
+
+ self._loan_status = loan_status
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UnifiedCurrency):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UnifiedCurrency):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/unified_discount.py b/gate_api/models/unified_discount.py
index 4c608ee..27cad2c 100644
--- a/gate_api/models/unified_discount.py
+++ b/gate_api/models/unified_discount.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/gate_api/models/unified_discount_tiers.py b/gate_api/models/unified_discount_tiers.py
index 524f165..1487ce8 100644
--- a/gate_api/models/unified_discount_tiers.py
+++ b/gate_api/models/unified_discount_tiers.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -146,7 +146,7 @@ def lower_limit(self, lower_limit):
def upper_limit(self):
"""Gets the upper_limit of this UnifiedDiscountTiers. # noqa: E501
- Upper limit,＋ indicates positive infinity # noqa: E501
+ Upper limit, + indicates positive infinity # noqa: E501
:return: The upper_limit of this UnifiedDiscountTiers. # noqa: E501
:rtype: str
@@ -157,7 +157,7 @@ def upper_limit(self):
def upper_limit(self, upper_limit):
"""Sets the upper_limit of this UnifiedDiscountTiers.
- Upper limit,＋ indicates positive infinity # noqa: E501
+ Upper limit, + indicates positive infinity # noqa: E501
:param upper_limit: The upper_limit of this UnifiedDiscountTiers. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_history_loan_rate.py b/gate_api/models/unified_history_loan_rate.py
index 70b0100..dd3edd2 100644
--- a/gate_api/models/unified_history_loan_rate.py
+++ b/gate_api/models/unified_history_loan_rate.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -95,7 +95,7 @@ def currency(self, currency):
def tier(self):
"""Gets the tier of this UnifiedHistoryLoanRate. # noqa: E501
- The VIP level of the floating rate required # noqa: E501
+ VIP level for the floating rate to be retrieved # noqa: E501
:return: The tier of this UnifiedHistoryLoanRate. # noqa: E501
:rtype: str
@@ -106,7 +106,7 @@ def tier(self):
def tier(self, tier):
"""Sets the tier of this UnifiedHistoryLoanRate.
- The VIP level of the floating rate required # noqa: E501
+ VIP level for the floating rate to be retrieved # noqa: E501
:param tier: The tier of this UnifiedHistoryLoanRate. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def tier(self, tier):
def tier_up_rate(self):
"""Gets the tier_up_rate of this UnifiedHistoryLoanRate. # noqa: E501
- VIP level corresponding floating rate # noqa: E501
+ Floating rate corresponding to VIP level # noqa: E501
:return: The tier_up_rate of this UnifiedHistoryLoanRate. # noqa: E501
:rtype: str
@@ -129,7 +129,7 @@ def tier_up_rate(self):
def tier_up_rate(self, tier_up_rate):
"""Sets the tier_up_rate of this UnifiedHistoryLoanRate.
- VIP level corresponding floating rate # noqa: E501
+ Floating rate corresponding to VIP level # noqa: E501
:param tier_up_rate: The tier_up_rate of this UnifiedHistoryLoanRate. # noqa: E501
:type: str
@@ -141,7 +141,7 @@ def tier_up_rate(self, tier_up_rate):
def rates(self):
"""Gets the rates of this UnifiedHistoryLoanRate. # noqa: E501
- Historical interest rate information, one data per hour, the array size is determined by the page and limit parameters provided by the interface request parameters, sorted from recent to far in time # noqa: E501
+ Historical interest rate information, one data point per hour, array size determined by page and limit parameters from the API request, sorted by time from recent to distant # noqa: E501
:return: The rates of this UnifiedHistoryLoanRate. # noqa: E501
:rtype: list[UnifiedHistoryLoanRateRates]
@@ -152,7 +152,7 @@ def rates(self):
def rates(self, rates):
"""Sets the rates of this UnifiedHistoryLoanRate.
- Historical interest rate information, one data per hour, the array size is determined by the page and limit parameters provided by the interface request parameters, sorted from recent to far in time # noqa: E501
+ Historical interest rate information, one data point per hour, array size determined by page and limit parameters from the API request, sorted by time from recent to distant # noqa: E501
:param rates: The rates of this UnifiedHistoryLoanRate. # noqa: E501
:type: list[UnifiedHistoryLoanRateRates]
diff --git a/gate_api/models/unified_history_loan_rate_rates.py b/gate_api/models/unified_history_loan_rate_rates.py
index 4099a31..100221f 100644
--- a/gate_api/models/unified_history_loan_rate_rates.py
+++ b/gate_api/models/unified_history_loan_rate_rates.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -62,7 +62,7 @@ def __init__(self, time=None, rate=None, local_vars_configuration=None): # noqa
def time(self):
"""Gets the time of this UnifiedHistoryLoanRateRates. # noqa: E501
- The hourly timestamp corresponding to the interest rate, in milliseconds # noqa: E501
+ Hourly timestamp corresponding to this interest rate, in milliseconds # noqa: E501
:return: The time of this UnifiedHistoryLoanRateRates. # noqa: E501
:rtype: int
@@ -73,7 +73,7 @@ def time(self):
def time(self, time):
"""Sets the time of this UnifiedHistoryLoanRateRates.
- The hourly timestamp corresponding to the interest rate, in milliseconds # noqa: E501
+ Hourly timestamp corresponding to this interest rate, in milliseconds # noqa: E501
:param time: The time of this UnifiedHistoryLoanRateRates. # noqa: E501
:type: int
@@ -85,7 +85,7 @@ def time(self, time):
def rate(self):
"""Gets the rate of this UnifiedHistoryLoanRateRates. # noqa: E501
- Historical interest rates for this hour # noqa: E501
+ Historical interest rate for this hour # noqa: E501
:return: The rate of this UnifiedHistoryLoanRateRates. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def rate(self):
def rate(self, rate):
"""Sets the rate of this UnifiedHistoryLoanRateRates.
- Historical interest rates for this hour # noqa: E501
+ Historical interest rate for this hour # noqa: E501
:param rate: The rate of this UnifiedHistoryLoanRateRates. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_leverage_config.py b/gate_api/models/unified_leverage_config.py
index ead9684..1e4bf22 100644
--- a/gate_api/models/unified_leverage_config.py
+++ b/gate_api/models/unified_leverage_config.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -202,7 +202,7 @@ def available_margin(self, available_margin):
def borrowable(self):
"""Gets the borrowable of this UnifiedLeverageConfig. # noqa: E501
- The current leverage you can choose is # noqa: E501
+ Maximum borrowable amount at current leverage # noqa: E501
:return: The borrowable of this UnifiedLeverageConfig. # noqa: E501
:rtype: str
@@ -213,7 +213,7 @@ def borrowable(self):
def borrowable(self, borrowable):
"""Sets the borrowable of this UnifiedLeverageConfig.
- The current leverage you can choose is # noqa: E501
+ Maximum borrowable amount at current leverage # noqa: E501
:param borrowable: The borrowable of this UnifiedLeverageConfig. # noqa: E501
:type: str
@@ -225,7 +225,7 @@ def borrowable(self, borrowable):
def except_leverage_borrowable(self):
"""Gets the except_leverage_borrowable of this UnifiedLeverageConfig. # noqa: E501
- The maximum amount of margin that can be borrowed and the maximum amount of Yubibao that can be borrowed, whichever is smaller # noqa: E501
+ Maximum borrowable from margin and maximum borrowable from Earn, whichever is smaller # noqa: E501
:return: The except_leverage_borrowable of this UnifiedLeverageConfig. # noqa: E501
:rtype: str
@@ -236,7 +236,7 @@ def except_leverage_borrowable(self):
def except_leverage_borrowable(self, except_leverage_borrowable):
"""Sets the except_leverage_borrowable of this UnifiedLeverageConfig.
- The maximum amount of margin that can be borrowed and the maximum amount of Yubibao that can be borrowed, whichever is smaller # noqa: E501
+ Maximum borrowable from margin and maximum borrowable from Earn, whichever is smaller # noqa: E501
:param except_leverage_borrowable: The except_leverage_borrowable of this UnifiedLeverageConfig. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_leverage_setting.py b/gate_api/models/unified_leverage_setting.py
index ee4958d..4ac92bb 100644
--- a/gate_api/models/unified_leverage_setting.py
+++ b/gate_api/models/unified_leverage_setting.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -53,10 +53,8 @@ def __init__(self, currency=None, leverage=None, local_vars_configuration=None):
self._leverage = None
self.discriminator = None
- if currency is not None:
- self.currency = currency
- if leverage is not None:
- self.leverage = leverage
+ self.currency = currency
+ self.leverage = leverage
@property
def currency(self):
@@ -78,6 +76,8 @@ def currency(self, currency):
:param currency: The currency of this UnifiedLeverageSetting. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and currency is None: # noqa: E501
+ raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501
self._currency = currency
@@ -85,7 +85,7 @@ def currency(self, currency):
def leverage(self):
"""Gets the leverage of this UnifiedLeverageSetting. # noqa: E501
- multiple # noqa: E501
+ Multiplier # noqa: E501
:return: The leverage of this UnifiedLeverageSetting. # noqa: E501
:rtype: str
@@ -96,11 +96,13 @@ def leverage(self):
def leverage(self, leverage):
"""Sets the leverage of this UnifiedLeverageSetting.
- multiple # noqa: E501
+ Multiplier # noqa: E501
:param leverage: The leverage of this UnifiedLeverageSetting. # noqa: E501
:type: str
"""
+ if self.local_vars_configuration.client_side_validation and leverage is None: # noqa: E501
+ raise ValueError("Invalid value for `leverage`, must not be `None`") # noqa: E501
self._leverage = leverage
diff --git a/gate_api/models/unified_loan.py b/gate_api/models/unified_loan.py
index c7a9e03..d8d000c 100644
--- a/gate_api/models/unified_loan.py
+++ b/gate_api/models/unified_loan.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -99,7 +99,7 @@ def currency(self, currency):
def type(self):
"""Gets the type of this UnifiedLoan. # noqa: E501
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:return: The type of this UnifiedLoan. # noqa: E501
:rtype: str
@@ -110,7 +110,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UnifiedLoan.
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:param type: The type of this UnifiedLoan. # noqa: E501
:type: str
@@ -130,7 +130,7 @@ def type(self, type):
def amount(self):
"""Gets the amount of this UnifiedLoan. # noqa: E501
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:return: The amount of this UnifiedLoan. # noqa: E501
:rtype: str
@@ -141,7 +141,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UnifiedLoan.
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:param amount: The amount of this UnifiedLoan. # noqa: E501
:type: str
@@ -155,7 +155,7 @@ def amount(self, amount):
def repaid_all(self):
"""Gets the repaid_all of this UnifiedLoan. # noqa: E501
- Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. # noqa: E501
+ Full repayment, only used for repayment operations. When set to `true`, overrides `amount` and directly repays the full amount # noqa: E501
:return: The repaid_all of this UnifiedLoan. # noqa: E501
:rtype: bool
@@ -166,7 +166,7 @@ def repaid_all(self):
def repaid_all(self, repaid_all):
"""Sets the repaid_all of this UnifiedLoan.
- Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. # noqa: E501
+ Full repayment, only used for repayment operations. When set to `true`, overrides `amount` and directly repays the full amount # noqa: E501
:param repaid_all: The repaid_all of this UnifiedLoan. # noqa: E501
:type: bool
diff --git a/gate_api/models/unified_loan_record.py b/gate_api/models/unified_loan_record.py
index 5d763c8..4cce938 100644
--- a/gate_api/models/unified_loan_record.py
+++ b/gate_api/models/unified_loan_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -92,7 +92,7 @@ def __init__(self, id=None, type=None, repayment_type=None, borrow_type=None, cu
def id(self):
"""Gets the id of this UnifiedLoanRecord. # noqa: E501
- id # noqa: E501
+ ID # noqa: E501
:return: The id of this UnifiedLoanRecord. # noqa: E501
:rtype: int
@@ -103,7 +103,7 @@ def id(self):
def id(self, id):
"""Sets the id of this UnifiedLoanRecord.
- id # noqa: E501
+ ID # noqa: E501
:param id: The id of this UnifiedLoanRecord. # noqa: E501
:type: int
@@ -115,7 +115,7 @@ def id(self, id):
def type(self):
"""Gets the type of this UnifiedLoanRecord. # noqa: E501
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:return: The type of this UnifiedLoanRecord. # noqa: E501
:rtype: str
@@ -126,7 +126,7 @@ def type(self):
def type(self, type):
"""Sets the type of this UnifiedLoanRecord.
- type: borrow - borrow, repay - repay # noqa: E501
+ Type: `borrow` - borrow, `repay` - repay # noqa: E501
:param type: The type of this UnifiedLoanRecord. # noqa: E501
:type: str
@@ -138,7 +138,7 @@ def type(self, type):
def repayment_type(self):
"""Gets the repayment_type of this UnifiedLoanRecord. # noqa: E501
- Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation # noqa: E501
+ Repayment type: none - No repayment type, manual_repay - Manual repayment, auto_repay - Automatic repayment, cancel_auto_repay - Automatic repayment after order cancellation, different_currencies_repayment - Cross-currency repayment # noqa: E501
:return: The repayment_type of this UnifiedLoanRecord. # noqa: E501
:rtype: str
@@ -149,7 +149,7 @@ def repayment_type(self):
def repayment_type(self, repayment_type):
"""Sets the repayment_type of this UnifiedLoanRecord.
- Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation # noqa: E501
+ Repayment type: none - No repayment type, manual_repay - Manual repayment, auto_repay - Automatic repayment, cancel_auto_repay - Automatic repayment after order cancellation, different_currencies_repayment - Cross-currency repayment # noqa: E501
:param repayment_type: The repayment_type of this UnifiedLoanRecord. # noqa: E501
:type: str
@@ -161,7 +161,7 @@ def repayment_type(self, repayment_type):
def borrow_type(self):
"""Gets the borrow_type of this UnifiedLoanRecord. # noqa: E501
- Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment # noqa: E501
+ Borrowing type, returned when querying loan records: manual_borrow - Manual borrowing, auto_borrow - Automatic borrowing # noqa: E501
:return: The borrow_type of this UnifiedLoanRecord. # noqa: E501
:rtype: str
@@ -172,7 +172,7 @@ def borrow_type(self):
def borrow_type(self, borrow_type):
"""Sets the borrow_type of this UnifiedLoanRecord.
- Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment # noqa: E501
+ Borrowing type, returned when querying loan records: manual_borrow - Manual borrowing, auto_borrow - Automatic borrowing # noqa: E501
:param borrow_type: The borrow_type of this UnifiedLoanRecord. # noqa: E501
:type: str
@@ -230,7 +230,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this UnifiedLoanRecord. # noqa: E501
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:return: The amount of this UnifiedLoanRecord. # noqa: E501
:rtype: str
@@ -241,7 +241,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UnifiedLoanRecord.
- The amount of lending or repaying # noqa: E501
+ Borrow or repayment amount # noqa: E501
:param amount: The amount of this UnifiedLoanRecord. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_loan_result.py b/gate_api/models/unified_loan_result.py
new file mode 100644
index 0000000..58dced5
--- /dev/null
+++ b/gate_api/models/unified_loan_result.py
@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UnifiedLoanResult(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'tran_id': 'int'
+ }
+
+ attribute_map = {
+ 'tran_id': 'tran_id'
+ }
+
+ def __init__(self, tran_id=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, Configuration) -> None
+ """UnifiedLoanResult - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._tran_id = None
+ self.discriminator = None
+
+ if tran_id is not None:
+ self.tran_id = tran_id
+
+ @property
+ def tran_id(self):
+ """Gets the tran_id of this UnifiedLoanResult. # noqa: E501
+
+ Transaction ID # noqa: E501
+
+ :return: The tran_id of this UnifiedLoanResult. # noqa: E501
+ :rtype: int
+ """
+ return self._tran_id
+
+ @tran_id.setter
+ def tran_id(self, tran_id):
+ """Sets the tran_id of this UnifiedLoanResult.
+
+ Transaction ID # noqa: E501
+
+ :param tran_id: The tran_id of this UnifiedLoanResult. # noqa: E501
+ :type: int
+ """
+
+ self._tran_id = tran_id
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UnifiedLoanResult):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UnifiedLoanResult):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/unified_margin_tiers.py b/gate_api/models/unified_margin_tiers.py
index 2cf4e6d..8e61cbe 100644
--- a/gate_api/models/unified_margin_tiers.py
+++ b/gate_api/models/unified_margin_tiers.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def currency(self, currency):
def margin_tiers(self):
"""Gets the margin_tiers of this UnifiedMarginTiers. # noqa: E501
- Margin tiers # noqa: E501
+ Tiered margin # noqa: E501
:return: The margin_tiers of this UnifiedMarginTiers. # noqa: E501
:rtype: list[MarginTiers]
@@ -96,7 +96,7 @@ def margin_tiers(self):
def margin_tiers(self, margin_tiers):
"""Sets the margin_tiers of this UnifiedMarginTiers.
- Margin tiers # noqa: E501
+ Tiered margin # noqa: E501
:param margin_tiers: The margin_tiers of this UnifiedMarginTiers. # noqa: E501
:type: list[MarginTiers]
diff --git a/gate_api/models/unified_mode_set.py b/gate_api/models/unified_mode_set.py
index 41f6476..8fe6a71 100644
--- a/gate_api/models/unified_mode_set.py
+++ b/gate_api/models/unified_mode_set.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -61,7 +61,7 @@ def __init__(self, mode=None, settings=None, local_vars_configuration=None): #
def mode(self):
"""Gets the mode of this UnifiedModeSet. # noqa: E501
- Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode # noqa: E501
:return: The mode of this UnifiedModeSet. # noqa: E501
:rtype: str
@@ -72,7 +72,7 @@ def mode(self):
def mode(self, mode):
"""Sets the mode of this UnifiedModeSet.
- Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model # noqa: E501
+ Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode # noqa: E501
:param mode: The mode of this UnifiedModeSet. # noqa: E501
:type: str
diff --git a/gate_api/models/unified_portfolio_input.py b/gate_api/models/unified_portfolio_input.py
index 2cb0816..57ca957 100644
--- a/gate_api/models/unified_portfolio_input.py
+++ b/gate_api/models/unified_portfolio_input.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -225,7 +225,7 @@ def options_orders(self, options_orders):
def spot_hedge(self):
"""Gets the spot_hedge of this UnifiedPortfolioInput. # noqa: E501
- Whether to enable spot hedging. # noqa: E501
+ Whether to enable spot hedging # noqa: E501
:return: The spot_hedge of this UnifiedPortfolioInput. # noqa: E501
:rtype: bool
@@ -236,7 +236,7 @@ def spot_hedge(self):
def spot_hedge(self, spot_hedge):
"""Sets the spot_hedge of this UnifiedPortfolioInput.
- Whether to enable spot hedging. # noqa: E501
+ Whether to enable spot hedging # noqa: E501
:param spot_hedge: The spot_hedge of this UnifiedPortfolioInput. # noqa: E501
:type: bool
diff --git a/gate_api/models/unified_portfolio_output.py b/gate_api/models/unified_portfolio_output.py
index cf656e4..ed08278 100644
--- a/gate_api/models/unified_portfolio_output.py
+++ b/gate_api/models/unified_portfolio_output.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -72,7 +72,7 @@ def __init__(self, maintain_margin_total=None, initial_margin_total=None, calcul
def maintain_margin_total(self):
"""Gets the maintain_margin_total of this UnifiedPortfolioOutput. # noqa: E501
- Total maintenance margin, including only the portfolio margin calculation results for positions in the risk unit, excluding borrowed margin. If borrowing exists, conventional borrowing margin requirements will still apply. # noqa: E501
+ Total maintenance margin, including only portfolio margin calculation results for positions in risk units, excluding borrowing margin. If borrowing exists, conventional borrowing margin requirements will still apply # noqa: E501
:return: The maintain_margin_total of this UnifiedPortfolioOutput. # noqa: E501
:rtype: str
@@ -83,7 +83,7 @@ def maintain_margin_total(self):
def maintain_margin_total(self, maintain_margin_total):
"""Sets the maintain_margin_total of this UnifiedPortfolioOutput.
- Total maintenance margin, including only the portfolio margin calculation results for positions in the risk unit, excluding borrowed margin. If borrowing exists, conventional borrowing margin requirements will still apply. # noqa: E501
+ Total maintenance margin, including only portfolio margin calculation results for positions in risk units, excluding borrowing margin. If borrowing exists, conventional borrowing margin requirements will still apply # noqa: E501
:param maintain_margin_total: The maintain_margin_total of this UnifiedPortfolioOutput. # noqa: E501
:type: str
@@ -95,7 +95,7 @@ def maintain_margin_total(self, maintain_margin_total):
def initial_margin_total(self):
"""Gets the initial_margin_total of this UnifiedPortfolioOutput. # noqa: E501
- Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders. # noqa: E501
+ Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders # noqa: E501
:return: The initial_margin_total of this UnifiedPortfolioOutput. # noqa: E501
:rtype: str
@@ -106,7 +106,7 @@ def initial_margin_total(self):
def initial_margin_total(self, initial_margin_total):
"""Sets the initial_margin_total of this UnifiedPortfolioOutput.
- Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders. # noqa: E501
+ Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders # noqa: E501
:param initial_margin_total: The initial_margin_total of this UnifiedPortfolioOutput. # noqa: E501
:type: str
@@ -118,7 +118,7 @@ def initial_margin_total(self, initial_margin_total):
def calculate_time(self):
"""Gets the calculate_time of this UnifiedPortfolioOutput. # noqa: E501
- Calculate time # noqa: E501
+ Calculation time # noqa: E501
:return: The calculate_time of this UnifiedPortfolioOutput. # noqa: E501
:rtype: int
@@ -129,7 +129,7 @@ def calculate_time(self):
def calculate_time(self, calculate_time):
"""Sets the calculate_time of this UnifiedPortfolioOutput.
- Calculate time # noqa: E501
+ Calculation time # noqa: E501
:param calculate_time: The calculate_time of this UnifiedPortfolioOutput. # noqa: E501
:type: int
diff --git a/gate_api/models/unified_risk_units.py b/gate_api/models/unified_risk_units.py
index df9d67c..7197a7e 100644
--- a/gate_api/models/unified_risk_units.py
+++ b/gate_api/models/unified_risk_units.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -90,7 +90,7 @@ def user_id(self, user_id):
def spot_hedge(self):
"""Gets the spot_hedge of this UnifiedRiskUnits. # noqa: E501
- Spot hedging status, true - enabled, false - not enabled. # noqa: E501
+ Spot hedging status: true - enabled, false - disabled # noqa: E501
:return: The spot_hedge of this UnifiedRiskUnits. # noqa: E501
:rtype: bool
@@ -101,7 +101,7 @@ def spot_hedge(self):
def spot_hedge(self, spot_hedge):
"""Sets the spot_hedge of this UnifiedRiskUnits.
- Spot hedging status, true - enabled, false - not enabled. # noqa: E501
+ Spot hedging status: true - enabled, false - disabled # noqa: E501
:param spot_hedge: The spot_hedge of this UnifiedRiskUnits. # noqa: E501
:type: bool
diff --git a/gate_api/models/unified_settings.py b/gate_api/models/unified_settings.py
index 3df4c77..7ab84b4 100644
--- a/gate_api/models/unified_settings.py
+++ b/gate_api/models/unified_settings.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -72,7 +72,7 @@ def __init__(self, usdt_futures=None, spot_hedge=None, use_funding=None, options
def usdt_futures(self):
"""Gets the usdt_futures of this UnifiedSettings. # noqa: E501
- USDT contract switch. In cross-currency margin mode, it can only be turned on and not off # noqa: E501
+ USDT futures switch. In cross-currency margin mode, can only be enabled and cannot be disabled # noqa: E501
:return: The usdt_futures of this UnifiedSettings. # noqa: E501
:rtype: bool
@@ -83,7 +83,7 @@ def usdt_futures(self):
def usdt_futures(self, usdt_futures):
"""Sets the usdt_futures of this UnifiedSettings.
- USDT contract switch. In cross-currency margin mode, it can only be turned on and not off # noqa: E501
+ USDT futures switch. In cross-currency margin mode, can only be enabled and cannot be disabled # noqa: E501
:param usdt_futures: The usdt_futures of this UnifiedSettings. # noqa: E501
:type: bool
@@ -95,7 +95,7 @@ def usdt_futures(self, usdt_futures):
def spot_hedge(self):
"""Gets the spot_hedge of this UnifiedSettings. # noqa: E501
- 现货对冲开关。 # noqa: E501
+ Spot hedging switch # noqa: E501
:return: The spot_hedge of this UnifiedSettings. # noqa: E501
:rtype: bool
@@ -106,7 +106,7 @@ def spot_hedge(self):
def spot_hedge(self, spot_hedge):
"""Sets the spot_hedge of this UnifiedSettings.
- 现货对冲开关。 # noqa: E501
+ Spot hedging switch # noqa: E501
:param spot_hedge: The spot_hedge of this UnifiedSettings. # noqa: E501
:type: bool
@@ -118,7 +118,7 @@ def spot_hedge(self, spot_hedge):
def use_funding(self):
"""Gets the use_funding of this UnifiedSettings. # noqa: E501
- When the mode is set to combined margin mode, will funds be used as margin # noqa: E501
+ Earn switch, when mode is cross-currency margin mode, whether to use Earn funds as margin # noqa: E501
:return: The use_funding of this UnifiedSettings. # noqa: E501
:rtype: bool
@@ -129,7 +129,7 @@ def use_funding(self):
def use_funding(self, use_funding):
"""Sets the use_funding of this UnifiedSettings.
- When the mode is set to combined margin mode, will funds be used as margin # noqa: E501
+ Earn switch, when mode is cross-currency margin mode, whether to use Earn funds as margin # noqa: E501
:param use_funding: The use_funding of this UnifiedSettings. # noqa: E501
:type: bool
@@ -141,7 +141,7 @@ def use_funding(self, use_funding):
def options(self):
"""Gets the options of this UnifiedSettings. # noqa: E501
- Option switch. In cross-currency margin mode, it can only be turned on and not off # noqa: E501
+ Options switch. In cross-currency margin mode, can only be enabled and cannot be disabled # noqa: E501
:return: The options of this UnifiedSettings. # noqa: E501
:rtype: bool
@@ -152,7 +152,7 @@ def options(self):
def options(self, options):
"""Sets the options of this UnifiedSettings.
- Option switch. In cross-currency margin mode, it can only be turned on and not off # noqa: E501
+ Options switch. In cross-currency margin mode, can only be enabled and cannot be disabled # noqa: E501
:param options: The options of this UnifiedSettings. # noqa: E501
:type: bool
diff --git a/gate_api/models/unified_transferable.py b/gate_api/models/unified_transferable.py
index cfdb6ce..e4b5311 100644
--- a/gate_api/models/unified_transferable.py
+++ b/gate_api/models/unified_transferable.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -85,7 +85,7 @@ def currency(self, currency):
def amount(self):
"""Gets the amount of this UnifiedTransferable. # noqa: E501
- The maximum amount that can be transferred out # noqa: E501
+ Maximum transferable amount # noqa: E501
:return: The amount of this UnifiedTransferable. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this UnifiedTransferable.
- The maximum amount that can be transferred out # noqa: E501
+ Maximum transferable amount # noqa: E501
:param amount: The amount of this UnifiedTransferable. # noqa: E501
:type: str
diff --git a/gate_api/models/user_ltv_info.py b/gate_api/models/user_ltv_info.py
index 579ed3d..e56f15a 100644
--- a/gate_api/models/user_ltv_info.py
+++ b/gate_api/models/user_ltv_info.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -87,7 +87,7 @@ def __init__(self, collateral_currency=None, borrow_currency=None, init_ltv=None
def collateral_currency(self):
"""Gets the collateral_currency of this UserLtvInfo. # noqa: E501
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:return: The collateral_currency of this UserLtvInfo. # noqa: E501
:rtype: str
@@ -98,7 +98,7 @@ def collateral_currency(self):
def collateral_currency(self, collateral_currency):
"""Sets the collateral_currency of this UserLtvInfo.
- Collateral # noqa: E501
+ Collateral currency # noqa: E501
:param collateral_currency: The collateral_currency of this UserLtvInfo. # noqa: E501
:type: str
@@ -133,7 +133,7 @@ def borrow_currency(self, borrow_currency):
def init_ltv(self):
"""Gets the init_ltv of this UserLtvInfo. # noqa: E501
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:return: The init_ltv of this UserLtvInfo. # noqa: E501
:rtype: str
@@ -144,7 +144,7 @@ def init_ltv(self):
def init_ltv(self, init_ltv):
"""Sets the init_ltv of this UserLtvInfo.
- The initial collateralization rate # noqa: E501
+ Initial collateralization rate # noqa: E501
:param init_ltv: The init_ltv of this UserLtvInfo. # noqa: E501
:type: str
@@ -156,7 +156,7 @@ def init_ltv(self, init_ltv):
def alert_ltv(self):
"""Gets the alert_ltv of this UserLtvInfo. # noqa: E501
- Warning collateralization ratio # noqa: E501
+ Warning collateralization rate # noqa: E501
:return: The alert_ltv of this UserLtvInfo. # noqa: E501
:rtype: str
@@ -167,7 +167,7 @@ def alert_ltv(self):
def alert_ltv(self, alert_ltv):
"""Sets the alert_ltv of this UserLtvInfo.
- Warning collateralization ratio # noqa: E501
+ Warning collateralization rate # noqa: E501
:param alert_ltv: The alert_ltv of this UserLtvInfo. # noqa: E501
:type: str
@@ -179,7 +179,7 @@ def alert_ltv(self, alert_ltv):
def liquidate_ltv(self):
"""Gets the liquidate_ltv of this UserLtvInfo. # noqa: E501
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:return: The liquidate_ltv of this UserLtvInfo. # noqa: E501
:rtype: str
@@ -190,7 +190,7 @@ def liquidate_ltv(self):
def liquidate_ltv(self, liquidate_ltv):
"""Sets the liquidate_ltv of this UserLtvInfo.
- The liquidation collateralization rate # noqa: E501
+ Liquidation collateralization rate # noqa: E501
:param liquidate_ltv: The liquidate_ltv of this UserLtvInfo. # noqa: E501
:type: str
diff --git a/gate_api/models/user_sub.py b/gate_api/models/user_sub.py
new file mode 100644
index 0000000..d3728b1
--- /dev/null
+++ b/gate_api/models/user_sub.py
@@ -0,0 +1,207 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UserSub(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'uid': 'int',
+ 'belong': 'str',
+ 'type': 'int',
+ 'ref_uid': 'int'
+ }
+
+ attribute_map = {
+ 'uid': 'uid',
+ 'belong': 'belong',
+ 'type': 'type',
+ 'ref_uid': 'ref_uid'
+ }
+
+ def __init__(self, uid=None, belong=None, type=None, ref_uid=None, local_vars_configuration=None): # noqa: E501
+ # type: (int, str, int, int, Configuration) -> None
+ """UserSub - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._uid = None
+ self._belong = None
+ self._type = None
+ self._ref_uid = None
+ self.discriminator = None
+
+ if uid is not None:
+ self.uid = uid
+ if belong is not None:
+ self.belong = belong
+ if type is not None:
+ self.type = type
+ if ref_uid is not None:
+ self.ref_uid = ref_uid
+
+ @property
+ def uid(self):
+ """Gets the uid of this UserSub. # noqa: E501
+
+ User ID # noqa: E501
+
+ :return: The uid of this UserSub. # noqa: E501
+ :rtype: int
+ """
+ return self._uid
+
+ @uid.setter
+ def uid(self, uid):
+ """Sets the uid of this UserSub.
+
+ User ID # noqa: E501
+
+ :param uid: The uid of this UserSub. # noqa: E501
+ :type: int
+ """
+
+ self._uid = uid
+
+ @property
+ def belong(self):
+ """Gets the belong of this UserSub. # noqa: E501
+
+ User's system affiliation (partner/referral). Empty means not belonging to any system # noqa: E501
+
+ :return: The belong of this UserSub. # noqa: E501
+ :rtype: str
+ """
+ return self._belong
+
+ @belong.setter
+ def belong(self, belong):
+ """Sets the belong of this UserSub.
+
+ User's system affiliation (partner/referral). Empty means not belonging to any system # noqa: E501
+
+ :param belong: The belong of this UserSub. # noqa: E501
+ :type: str
+ """
+
+ self._belong = belong
+
+ @property
+ def type(self):
+ """Gets the type of this UserSub. # noqa: E501
+
+ Type (0-Not in system 1-Direct subordinate agent 2-Indirect subordinate agent 3-Direct direct customer 4-Indirect direct customer 5-Regular user) # noqa: E501
+
+ :return: The type of this UserSub. # noqa: E501
+ :rtype: int
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this UserSub.
+
+ Type (0-Not in system 1-Direct subordinate agent 2-Indirect subordinate agent 3-Direct direct customer 4-Indirect direct customer 5-Regular user) # noqa: E501
+
+ :param type: The type of this UserSub. # noqa: E501
+ :type: int
+ """
+
+ self._type = type
+
+ @property
+ def ref_uid(self):
+ """Gets the ref_uid of this UserSub. # noqa: E501
+
+ Inviter user ID # noqa: E501
+
+ :return: The ref_uid of this UserSub. # noqa: E501
+ :rtype: int
+ """
+ return self._ref_uid
+
+ @ref_uid.setter
+ def ref_uid(self, ref_uid):
+ """Sets the ref_uid of this UserSub.
+
+ Inviter user ID # noqa: E501
+
+ :param ref_uid: The ref_uid of this UserSub. # noqa: E501
+ :type: int
+ """
+
+ self._ref_uid = ref_uid
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UserSub):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UserSub):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/user_sub_relation.py b/gate_api/models/user_sub_relation.py
new file mode 100644
index 0000000..533e250
--- /dev/null
+++ b/gate_api/models/user_sub_relation.py
@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+ Gate API
+
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
+
+ Contact: support@mail.gate.com
+ Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from gate_api.configuration import Configuration
+
+
+class UserSubRelation(object):
+ """NOTE: This class is auto generated by OpenAPI Generator.
+ Ref: https://openapi-generator.tech
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ openapi_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ openapi_types = {
+ 'list': 'list[UserSub]'
+ }
+
+ attribute_map = {
+ 'list': 'list'
+ }
+
+ def __init__(self, list=None, local_vars_configuration=None): # noqa: E501
+ # type: (list[UserSub], Configuration) -> None
+ """UserSubRelation - a model defined in OpenAPI""" # noqa: E501
+ if local_vars_configuration is None:
+ local_vars_configuration = Configuration()
+ self.local_vars_configuration = local_vars_configuration
+
+ self._list = None
+ self.discriminator = None
+
+ if list is not None:
+ self.list = list
+
+ @property
+ def list(self):
+ """Gets the list of this UserSubRelation. # noqa: E501
+
+ Subordinate relationship list # noqa: E501
+
+ :return: The list of this UserSubRelation. # noqa: E501
+ :rtype: list[UserSub]
+ """
+ return self._list
+
+ @list.setter
+ def list(self, list):
+ """Sets the list of this UserSubRelation.
+
+ Subordinate relationship list # noqa: E501
+
+ :param list: The list of this UserSubRelation. # noqa: E501
+ :type: list[UserSub]
+ """
+
+ self._list = list
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.openapi_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, UserSubRelation):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, UserSubRelation):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/gate_api/models/user_total_amount.py b/gate_api/models/user_total_amount.py
index 26a1bb3..759f31e 100644
--- a/gate_api/models/user_total_amount.py
+++ b/gate_api/models/user_total_amount.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -62,7 +62,7 @@ def __init__(self, borrow_amount=None, collateral_amount=None, local_vars_config
def borrow_amount(self):
"""Gets the borrow_amount of this UserTotalAmount. # noqa: E501
- Total borrowing amount, calculated in USDT # noqa: E501
+ Total borrowing amount in USDT # noqa: E501
:return: The borrow_amount of this UserTotalAmount. # noqa: E501
:rtype: str
@@ -73,7 +73,7 @@ def borrow_amount(self):
def borrow_amount(self, borrow_amount):
"""Sets the borrow_amount of this UserTotalAmount.
- Total borrowing amount, calculated in USDT # noqa: E501
+ Total borrowing amount in USDT # noqa: E501
:param borrow_amount: The borrow_amount of this UserTotalAmount. # noqa: E501
:type: str
@@ -85,7 +85,7 @@ def borrow_amount(self, borrow_amount):
def collateral_amount(self):
"""Gets the collateral_amount of this UserTotalAmount. # noqa: E501
- Total collateral amount, calculated in USDT # noqa: E501
+ Total collateral amount in USDT # noqa: E501
:return: The collateral_amount of this UserTotalAmount. # noqa: E501
:rtype: str
@@ -96,7 +96,7 @@ def collateral_amount(self):
def collateral_amount(self, collateral_amount):
"""Sets the collateral_amount of this UserTotalAmount.
- Total collateral amount, calculated in USDT # noqa: E501
+ Total collateral amount in USDT # noqa: E501
:param collateral_amount: The collateral_amount of this UserTotalAmount. # noqa: E501
:type: str
diff --git a/gate_api/models/withdraw_status.py b/gate_api/models/withdraw_status.py
index b91f1ba..8803fc9 100644
--- a/gate_api/models/withdraw_status.py
+++ b/gate_api/models/withdraw_status.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -181,7 +181,7 @@ def name_cn(self, name_cn):
def deposit(self):
"""Gets the deposit of this WithdrawStatus. # noqa: E501
- Deposits fee # noqa: E501
+ Deposit fee # noqa: E501
:return: The deposit of this WithdrawStatus. # noqa: E501
:rtype: str
@@ -192,7 +192,7 @@ def deposit(self):
def deposit(self, deposit):
"""Sets the deposit of this WithdrawStatus.
- Deposits fee # noqa: E501
+ Deposit fee # noqa: E501
:param deposit: The deposit of this WithdrawStatus. # noqa: E501
:type: str
diff --git a/gate_api/models/withdrawal_record.py b/gate_api/models/withdrawal_record.py
index e205e2f..ee0cf4c 100644
--- a/gate_api/models/withdrawal_record.py
+++ b/gate_api/models/withdrawal_record.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -42,6 +42,8 @@ class WithdrawalRecord(object):
'fee': 'str',
'currency': 'str',
'address': 'str',
+ 'fail_reason': 'str',
+ 'timestamp2': 'str',
'memo': 'str',
'status': 'str',
'chain': 'str'
@@ -57,13 +59,15 @@ class WithdrawalRecord(object):
'fee': 'fee',
'currency': 'currency',
'address': 'address',
+ 'fail_reason': 'fail_reason',
+ 'timestamp2': 'timestamp2',
'memo': 'memo',
'status': 'status',
'chain': 'chain'
}
- def __init__(self, id=None, txid=None, block_number=None, withdraw_order_id=None, timestamp=None, amount=None, fee=None, currency=None, address=None, memo=None, status=None, chain=None, local_vars_configuration=None): # noqa: E501
- # type: (str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
+ def __init__(self, id=None, txid=None, block_number=None, withdraw_order_id=None, timestamp=None, amount=None, fee=None, currency=None, address=None, fail_reason=None, timestamp2=None, memo=None, status=None, chain=None, local_vars_configuration=None): # noqa: E501
+ # type: (str, str, str, str, str, str, str, str, str, str, str, str, str, str, Configuration) -> None
"""WithdrawalRecord - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
@@ -78,6 +82,8 @@ def __init__(self, id=None, txid=None, block_number=None, withdraw_order_id=None
self._fee = None
self._currency = None
self._address = None
+ self._fail_reason = None
+ self._timestamp2 = None
self._memo = None
self._status = None
self._chain = None
@@ -99,6 +105,10 @@ def __init__(self, id=None, txid=None, block_number=None, withdraw_order_id=None
self.currency = currency
if address is not None:
self.address = address
+ if fail_reason is not None:
+ self.fail_reason = fail_reason
+ if timestamp2 is not None:
+ self.timestamp2 = timestamp2
if memo is not None:
self.memo = memo
if status is not None:
@@ -155,7 +165,7 @@ def txid(self, txid):
def block_number(self):
"""Gets the block_number of this WithdrawalRecord. # noqa: E501
- 区块编号 # noqa: E501
+ Block Number # noqa: E501
:return: The block_number of this WithdrawalRecord. # noqa: E501
:rtype: str
@@ -166,7 +176,7 @@ def block_number(self):
def block_number(self, block_number):
"""Sets the block_number of this WithdrawalRecord.
- 区块编号 # noqa: E501
+ Block Number # noqa: E501
:param block_number: The block_number of this WithdrawalRecord. # noqa: E501
:type: str
@@ -224,7 +234,7 @@ def timestamp(self, timestamp):
def amount(self):
"""Gets the amount of this WithdrawalRecord. # noqa: E501
- Currency amount # noqa: E501
+ Token amount # noqa: E501
:return: The amount of this WithdrawalRecord. # noqa: E501
:rtype: str
@@ -235,7 +245,7 @@ def amount(self):
def amount(self, amount):
"""Sets the amount of this WithdrawalRecord.
- Currency amount # noqa: E501
+ Token amount # noqa: E501
:param amount: The amount of this WithdrawalRecord. # noqa: E501
:type: str
@@ -297,7 +307,7 @@ def currency(self, currency):
def address(self):
"""Gets the address of this WithdrawalRecord. # noqa: E501
- Withdrawal address. Required for withdrawals # noqa: E501
+ Withdrawal address # noqa: E501
:return: The address of this WithdrawalRecord. # noqa: E501
:rtype: str
@@ -308,7 +318,7 @@ def address(self):
def address(self, address):
"""Sets the address of this WithdrawalRecord.
- Withdrawal address. Required for withdrawals # noqa: E501
+ Withdrawal address # noqa: E501
:param address: The address of this WithdrawalRecord. # noqa: E501
:type: str
@@ -316,6 +326,52 @@ def address(self, address):
self._address = address
+ @property
+ def fail_reason(self):
+ """Gets the fail_reason of this WithdrawalRecord. # noqa: E501
+
+ Reason for withdrawal failure. Has a value when status = CANCEL, empty for all other statuses # noqa: E501
+
+ :return: The fail_reason of this WithdrawalRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._fail_reason
+
+ @fail_reason.setter
+ def fail_reason(self, fail_reason):
+ """Sets the fail_reason of this WithdrawalRecord.
+
+ Reason for withdrawal failure. Has a value when status = CANCEL, empty for all other statuses # noqa: E501
+
+ :param fail_reason: The fail_reason of this WithdrawalRecord. # noqa: E501
+ :type: str
+ """
+
+ self._fail_reason = fail_reason
+
+ @property
+ def timestamp2(self):
+ """Gets the timestamp2 of this WithdrawalRecord. # noqa: E501
+
+ Withdrawal final time, i.e.: withdrawal cancellation time or withdrawal success time When status = CANCEL, corresponds to cancellation time When status = DONE and block_number > 0, it is the withdrawal success time # noqa: E501
+
+ :return: The timestamp2 of this WithdrawalRecord. # noqa: E501
+ :rtype: str
+ """
+ return self._timestamp2
+
+ @timestamp2.setter
+ def timestamp2(self, timestamp2):
+ """Sets the timestamp2 of this WithdrawalRecord.
+
+ Withdrawal final time, i.e.: withdrawal cancellation time or withdrawal success time When status = CANCEL, corresponds to cancellation time When status = DONE and block_number > 0, it is the withdrawal success time # noqa: E501
+
+ :param timestamp2: The timestamp2 of this WithdrawalRecord. # noqa: E501
+ :type: str
+ """
+
+ self._timestamp2 = timestamp2
+
@property
def memo(self):
"""Gets the memo of this WithdrawalRecord. # noqa: E501
@@ -343,7 +399,7 @@ def memo(self, memo):
def status(self):
"""Gets the status of this WithdrawalRecord. # noqa: E501
- 交易状态 - DONE: 完成 (block_number > 0 才算真的上链完成) - CANCEL: 已取消 - REQUEST: 请求中 - MANUAL: 待人工审核 - BCODE: 充值码操作 - EXTPEND: 已经发送等待确认 - FAIL: 链上失败等待确认 - INVALID: 无效订单 - VERIFY: 验证中 - PROCES: 处理中 - PEND: 处理中 - DMOVE: 待人工审核 - SPLITPEND: cny提现大于5w,自动分单 # noqa: E501
+ Transaction status - DONE: Completed (block_number > 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 - REVIEW: Under review # noqa: E501
:return: The status of this WithdrawalRecord. # noqa: E501
:rtype: str
@@ -354,17 +410,11 @@ def status(self):
def status(self, status):
"""Sets the status of this WithdrawalRecord.
- 交易状态 - DONE: 完成 (block_number > 0 才算真的上链完成) - CANCEL: 已取消 - REQUEST: 请求中 - MANUAL: 待人工审核 - BCODE: 充值码操作 - EXTPEND: 已经发送等待确认 - FAIL: 链上失败等待确认 - INVALID: 无效订单 - VERIFY: 验证中 - PROCES: 处理中 - PEND: 处理中 - DMOVE: 待人工审核 - SPLITPEND: cny提现大于5w,自动分单 # noqa: E501
+ Transaction status - DONE: Completed (block_number > 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 - REVIEW: Under review # noqa: E501
:param status: The status of this WithdrawalRecord. # noqa: E501
:type: str
"""
- allowed_values = ["DONE", "CANCEL", "REQUEST", "MANUAL", "BCODE", "EXTPEND", "FAIL", "INVALID", "VERIFY", "PROCES", "PEND", "DMOVE", "SPLITPEND"] # noqa: E501
- if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501
- raise ValueError(
- "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501
- .format(status, allowed_values)
- )
self._status = status
diff --git a/gate_api/rest.py b/gate_api/rest.py
index 66d4dfc..8781e1b 100644
--- a/gate_api/rest.py
+++ b/gate_api/rest.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
diff --git a/setup.cfg b/setup.cfg
index 4d8daf3..1d2fcfb 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -6,8 +6,8 @@ classifiers:
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
-maintainer = gateio
-maintainer_email = dev@mail.gate.io
+maintainer = gate
+maintainer_email = dev@mail.gate.com
[flake8]
max-line-length=99
diff --git a/setup.py b/setup.py
index eaace4f..d0fc88e 100644
--- a/setup.py
+++ b/setup.py
@@ -1,11 +1,11 @@
# coding: utf-8
"""
- Gate API v4
+ Gate API
- Welcome to Gate.io API 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. # noqa: E501
+ Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. # noqa: E501
- Contact: support@mail.gate.io
+ Contact: support@mail.gate.com
Generated by: https://openapi-generator.tech
"""
@@ -13,7 +13,7 @@
from setuptools import setup, find_packages # noqa: H301
NAME = "gate-api"
-VERSION = "4.88.0"
+VERSION = "7.1.8"
# To install the library, run the following
#
# python setup.py install
@@ -26,11 +26,11 @@
setup(
name=NAME,
version=VERSION,
- description="Gate API v4",
+ description="Gate API",
author="Gate API support",
- author_email="support@mail.gate.io",
+ author_email="support@mail.gate.com",
url="https://github.com/gateio/gateapi-python",
- keywords=["OpenAPI", "OpenAPI-Generator", "Gate API v4"],
+ keywords=["OpenAPI", "OpenAPI-Generator", "Gate API"],
install_requires=REQUIRES,
packages=find_packages(exclude=["test", "tests"]),
include_package_data=True,