diff --git a/README.md b/README.md index 71b1b9d..802396f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # 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. +APIv4 provides operations 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: v4.102.6 -- Package version: 6.102.6 +- 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.com/page/contacts](https://www.gate.com/page/contacts) @@ -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,287 +105,288 @@ 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* | [**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 estimate 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* | [**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. -*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* | [**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* | [**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* | [**get_unified_transferables**](docs/UnifiedApi.md#get_unified_transferables) | **GET** /unified/transferables | Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. -*UnifiedApi* | [**get_unified_borrowable_list**](docs/UnifiedApi.md#get_unified_borrowable_list) | **GET** /unified/batch_borrowable | Batch query unified account can be borrowed up to a maximum. -*UnifiedApi* | [**list_unified_loans**](docs/UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | List loans. -*UnifiedApi* | [**create_unified_loan**](docs/UnifiedApi.md#create_unified_loan) | **POST** /unified/loans | Borrow or repay. -*UnifiedApi* | [**list_unified_loan_records**](docs/UnifiedApi.md#list_unified_loan_records) | **GET** /unified/loan_records | Get load records. -*UnifiedApi* | [**list_unified_loan_interest_records**](docs/UnifiedApi.md#list_unified_loan_interest_records) | **GET** /unified/interest_records | List interest records. -*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* | [**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 | 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 the leverage multiple of the user currency. -*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* | [**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 | Get account detail. -*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. -*CollateralLoanApi* | [**list_collateral_records**](docs/CollateralLoanApi.md#list_collateral_records) | **GET** /loan/collateral/collaterals | Query collateral adjustment records. -*CollateralLoanApi* | [**operate_collateral**](docs/CollateralLoanApi.md#operate_collateral) | **POST** /loan/collateral/collaterals | Increase or redeem collateral. -*CollateralLoanApi* | [**get_user_total_amount**](docs/CollateralLoanApi.md#get_user_total_amount) | **GET** /loan/collateral/total_amount | Query the total borrowing and collateral amount for the user. -*CollateralLoanApi* | [**get_user_ltv_info**](docs/CollateralLoanApi.md#get_user_ltv_info) | **GET** /loan/collateral/ltv | Query user's collateralization ratio. -*CollateralLoanApi* | [**list_collateral_currencies**](docs/CollateralLoanApi.md#list_collateral_currencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies. -*DeliveryApi* | [**list_delivery_contracts**](docs/DeliveryApi.md#list_delivery_contracts) | **GET** /delivery/{settle}/contracts | List all futures contracts. -*DeliveryApi* | [**get_delivery_contract**](docs/DeliveryApi.md#get_delivery_contract) | **GET** /delivery/{settle}/contracts/{contract} | Get a single contract. -*DeliveryApi* | [**list_delivery_order_book**](docs/DeliveryApi.md#list_delivery_order_book) | **GET** /delivery/{settle}/order_book | Futures order book. -*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* | [**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 Price-triggered 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 Price-triggered Orders. -*DeliveryApi* | [**get_price_triggered_delivery_order**](docs/DeliveryApi.md#get_price_triggered_delivery_order) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order. -*DeliveryApi* | [**cancel_price_triggered_delivery_order**](docs/DeliveryApi.md#cancel_price_triggered_delivery_order) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order. -*EarnApi* | [**swap_eth2**](docs/EarnApi.md#swap_eth2) | **POST** /earn/staking/eth2/swap | ETH2 swap. -*EarnApi* | [**rate_list_eth2**](docs/EarnApi.md#rate_list_eth2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical rate of return 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. -*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* | [**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. -*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 to the full position-by-store 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* | [**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* | [**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* | [**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 | List All Price-triggered 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 Price-triggered 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. -*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_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* | [**get_user_margin_tier**](docs/MarginApi.md#get_user_margin_tier) | **GET** /margin/user/loan_margin_tiers | Check the user's own leverage lending gradient in the current market. -*MarginApi* | [**get_market_margin_tier**](docs/MarginApi.md#get_market_margin_tier) | **GET** /margin/loan_margin_tiers | Query the current market leverage lending gradient. -*MarginApi* | [**set_user_market_leverage**](docs/MarginApi.md#set_user_market_leverage) | **POST** /margin/leverage/user_market_setting | Set the user market leverage multiple. -*MarginApi* | [**list_margin_user_account**](docs/MarginApi.md#list_margin_user_account) | **GET** /margin/user/account | Query the user's leverage account list. -*MarginApi* | [**list_cross_margin_loans**](docs/MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | List 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 | 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. -*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. -*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* | [**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* | [**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. +*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 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 | 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 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* | [**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 | 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 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 | 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 | 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 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 | 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 | 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 +*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 | 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} | 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 | 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 | 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 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 | 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 | 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 | 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 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 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 | 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* | [**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. -*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 | 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. -*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* | [**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* | [**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 Price-triggered 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. -*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* | [**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* | [**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* | [**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. -*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. +*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 | 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* | [**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 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 | 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 | 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 | 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 | 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 | 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 ## Documentation For Models @@ -485,6 +485,7 @@ Class | Method | HTTP request | Description - [FuturesTicker](docs/FuturesTicker.md) - [FuturesTrade](docs/FuturesTrade.md) - [IndexConstituent](docs/IndexConstituent.md) + - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) - [InlineResponse2001](docs/InlineResponse2001.md) - [InsuranceRecord](docs/InsuranceRecord.md) diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 597c4d5..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_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. +[**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 | 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,14 +74,14 @@ 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) # **get_account_rate_limit** > list[AccountRateLimit] get_account_rate_limit() -Get user transaction rate limit information. +Get user transaction rate limit information ### Example @@ -109,7 +109,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.AccountApi(api_client) try: - # Get user transaction rate limit information. + # Get user transaction rate limit information api_response = api_instance.get_account_rate_limit() print(api_response) except GateApiException as ex: @@ -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,16 +206,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_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. +Only the main account is allowed to create a new STP user group ### Example @@ -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 can query the account. +Only the main account that created this STP group can query the account ID list in the current STP group ### Example @@ -310,10 +310,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) -stp_id = 1 # int | STP Group ID. +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: @@ -326,7 +326,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stp_id** | **int**| STP Group ID. | + **stp_id** | **int**| STP Group ID | ### Return type @@ -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 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 @@ -379,11 +379,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) -stp_id = 1 # int | STP Group ID. -request_body = [[1,2,3]] # list[int] | User ID. +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: @@ -396,8 +396,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stp_id** | **int**| STP Group ID. | - **request_body** | [**list[int]**](int.md)| User ID. | + **stp_id** | **int**| STP Group ID | + **request_body** | [**list[int]**](int.md)| User ID | ### Return type @@ -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 @@ -450,11 +450,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) -stp_id = 1 # int | STP Group ID. -user_id = 1 # int | STP user ID, multiple can be separated by commas. +stp_id = 1 # int | STP Group ID +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: @@ -467,8 +467,8 @@ 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. | + **stp_id** | **int**| STP Group ID | + **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** > 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: @@ -551,16 +551,16 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **set_debit_fee** > 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 @@ -589,7 +589,7 @@ api_instance = gate_api.AccountApi(api_client) debit_fee = gate_api.DebitFee() # DebitFee | try: - # Set GT deduction. + # 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)) @@ -619,7 +619,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/AccountBalance.md b/docs/AccountBalance.md index ccf42f5..7941688 100644 --- a/docs/AccountBalance.md +++ b/docs/AccountBalance.md @@ -1,13 +1,13 @@ # AccountBalance -Total balances calculated with specified currency unit. +Total balances calculated with specified currency unit ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **str** | Account total balance amount. | [optional] -**currency** | **str** | Currency. | [optional] +**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 16a25d9..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] -**user_id** | **int** | User ID. | [optional] -**tier** | **int** | User VIP level. | [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 - Normal user, 1 - Copy trading leader, follower, 3 - Both 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 bdb74c8..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 a4275da..b91882b 100644 --- a/docs/AccountRateLimit.md +++ b/docs/AccountRateLimit.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tier** | **str** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) | [optional] -**ratio** | **str** | Transaction rate. | [optional] -**main_ratio** | **str** | Total transaction ratio of main account. | [optional] -**updated_at** | **str** | Update time. | [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 a378726..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] -**user_id** | **int** | User ID. | [optional] -**group_name** | **str** | Group name. | [optional] -**commission_amount** | **str** | Commission Amount. | [optional] -**commission_asset** | **str** | Commission Asset. | [optional] -**source** | **str** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [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** | Transaction amount | [optional] +**commission_asset** | **str** | Commission Asset | [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 e343af0..195a454 100644 --- a/docs/AgencyCommissionHistory.md +++ b/docs/AgencyCommissionHistory.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Currency pair. | [optional] -**total** | **int** | Total. | [optional] -**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of comission history. | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**total** | **int** | Total | [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 4a60c7c..930d2b7 100644 --- a/docs/AgencyTransaction.md +++ b/docs/AgencyTransaction.md @@ -3,15 +3,15 @@ ## Properties 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. | [optional] -**fee_asset** | **str** | Fee currency. | [optional] -**currency_pair** | **str** | Currency pair. | [optional] -**amount** | **str** | Commission Amount. | [optional] -**amount_asset** | **str** | Commission Asset. | [optional] -**source** | **str** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [optional] +**transaction_time** | **int** | Transaction Time. (unix timestamp) | [optional] +**user_id** | **int** | User ID | [optional] +**group_name** | **str** | Group name | [optional] +**fee** | **str** | Fee | [optional] +**fee_asset** | **str** | Fee currency | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**amount** | **str** | Transaction amount | [optional] +**amount_asset** | **str** | Commission Asset | [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/AgencyTransactionHistory.md b/docs/AgencyTransactionHistory.md index c98aed3..a79d13c 100644 --- a/docs/AgencyTransactionHistory.md +++ b/docs/AgencyTransactionHistory.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Currency pair. | [optional] -**total** | **int** | Total. | [optional] -**list** | [**list[AgencyTransaction]**](AgencyTransaction.md) | List of transaction history. | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**total** | **int** | Total | [optional] +**list** | [**list[AgencyTransaction]**](AgencyTransaction.md) | List of transaction 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/AutoRepaySetting.md b/docs/AutoRepaySetting.md index e17f633..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 cdbf4ee..62bc971 100644 --- a/docs/BatchAmendItem.md +++ b/docs/BatchAmendItem.md @@ -1,15 +1,15 @@ # BatchAmendItem -Order information that needs to be modified. +Order information that needs to be modified ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **str** | The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). | -**currency_pair** | **str** | Currency pair. | -**account** | **str** | Default spot, unified account and warehouse-by-store leverage account. | [optional] -**amount** | **str** | Trading Quantity. Only one of amountor pricecan be specified. | [optional] -**price** | **str** | Trading Price. Only one of amountor pricecan be specified. | [optional] -**amend_text** | **str** | Custom info during amending order. | [optional] +**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 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 47e64a9..41df706 100644 --- a/docs/BatchAmendOrderReq.md +++ b/docs/BatchAmendOrderReq.md @@ -1,14 +1,14 @@ # BatchAmendOrderReq -Modify contract order parameters. +Modify contract order parameters ## Properties 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, 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] +**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** | 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 a51e2eb..c7599b6 100644 --- a/docs/BatchFuturesOrder.md +++ b/docs/BatchFuturesOrder.md @@ -1,36 +1,36 @@ # BatchFuturesOrder -Futures order details. +Futures order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **bool** | Whether the batch of orders succeeded. | [optional] -**label** | **str** | Error label, only exists if execution fails. | [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 - 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] -**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] -**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] +**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 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** | 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] +**tkfr** | **str** | Taker fee | [optional] [readonly] +**mkfr** | **str** | Maker fee | [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, 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 9734f45..7840bc6 100644 --- a/docs/BatchOrder.md +++ b/docs/BatchOrder.md @@ -1,43 +1,43 @@ # BatchOrder -Batch order details. +Batch order details ## Properties 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] -**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] -**create_time** | **str** | Creation time of order. | [optional] [readonly] -**update_time** | **str** | Last modification time of order. | [optional] [readonly] -**create_time_ms** | **int** | Creation time of order (in milliseconds). | [optional] [readonly] -**update_time_ms** | **int** | Last modification time of order (in milliseconds). | [optional] [readonly] +**order_id** | **str** | Order ID | [optional] +**amend_text** | **str** | The custom data that the user remarked when amending the order | [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] +**create_time** | **str** | Creation time of order | [optional] [readonly] +**update_time** | **str** | Last modification time of order | [optional] [readonly] +**create_time_ms** | **int** | Creation time of order (in milliseconds) | [optional] [readonly] +**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] +**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 - 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] +**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] -**left** | **str** | Amount left to fill. | [optional] [readonly] -**filled_amount** | **str** | Amount traded to fill. | [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] -**fee** | **str** | Fee deducted. | [optional] [readonly] -**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] -**rebated_fee** | **str** | Rebated fee. | [optional] [readonly] -**rebated_fee_currency** | **str** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **str** | Fee deducted | [optional] [readonly] +**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 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, 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] diff --git a/docs/BorrowCurrencyInfo.md b/docs/BorrowCurrencyInfo.md index f9b6c0a..64ca722 100644 --- a/docs/BorrowCurrencyInfo.md +++ b/docs/BorrowCurrencyInfo.md @@ -3,11 +3,11 @@ ## Properties 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] +**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** | 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 dcdf074..0cbfd46 100644 --- a/docs/BrokerCommission.md +++ b/docs/BrokerCommission.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **int** | Total. | [optional] -**list** | [**list[BrokerCommission1]**](BrokerCommission1.md) | List of comission history. | [optional] +**total** | **int** | Total | [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 b411106..0382e9c 100644 --- a/docs/BrokerCommission1.md +++ b/docs/BrokerCommission1.md @@ -3,17 +3,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commission_time** | **int** | Commission Time. (unix timestamp). | [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.、Alpha | [optional] -**currency_pair** | **str** | Currency pair. | [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** | 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 token address | [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 index 262352f..d6a0912 100644 --- a/docs/BrokerCommissionSubBrokerInfo.md +++ b/docs/BrokerCommissionSubBrokerInfo.md @@ -1,13 +1,13 @@ # BrokerCommissionSubBrokerInfo -The sub broker info. +Sub-broker information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_id** | **int** | The sub broker user ID. | [optional] -**original_commission_rate** | **str** | The sub broker original commission rate. | [optional] -**relative_commission_rate** | **str** | The sub broker relative commission rate. | [optional] -**commission_rate** | **str** | The sub broker actual commission rate. | [optional] +**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/BrokerTransaction.md b/docs/BrokerTransaction.md index e974fdf..c450894 100644 --- a/docs/BrokerTransaction.md +++ b/docs/BrokerTransaction.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **int** | Total. | [optional] -**list** | [**list[BrokerTransaction1]**](BrokerTransaction1.md) | List of transaction history. | [optional] +**total** | **int** | Total | [optional] +**list** | [**list[BrokerTransaction1]**](BrokerTransaction1.md) | List of transaction 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/BrokerTransaction1.md b/docs/BrokerTransaction1.md index a28ac63..07833a8 100644 --- a/docs/BrokerTransaction1.md +++ b/docs/BrokerTransaction1.md @@ -3,16 +3,16 @@ ## Properties 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] -**currency_pair** | **str** | Currency pair. | [optional] -**amount** | **str** | Commission Amount. | [optional] -**fee_asset** | **str** | Fee currency. | [optional] -**source** | **str** | Rebate Type: Spot、Futures、Options.、Alpha | [optional] +**transaction_time** | **int** | Transaction Time. (unix timestamp) | [optional] +**user_id** | **int** | User ID | [optional] +**group_name** | **str** | Group name | [optional] +**fee** | **str** | Fee amount (USDT) | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**amount** | **str** | Transaction amount | [optional] +**fee_asset** | **str** | Fee currency | [optional] +**source** | **str** | Commission transaction type: Spot, Futures, Options, Alpha | [optional] **sub_broker_info** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] -**alpha_contract_addr** | **str** | Alpha token address | [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 4cfa42a..4d2953b 100644 --- a/docs/CancelBatchOrder.md +++ b/docs/CancelBatchOrder.md @@ -1,10 +1,10 @@ # CancelBatchOrder -Info of order to be cancelled. +Info of order to be cancelled ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Order currency pair. | +**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] diff --git a/docs/CancelOrderResult.md b/docs/CancelOrderResult.md index 6316135..8aa2f77 100644 --- a/docs/CancelOrderResult.md +++ b/docs/CancelOrderResult.md @@ -1,16 +1,16 @@ # CancelOrderResult -Order cancellation result. +Order cancellation result ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Order currency pair. | [optional] -**id** | **str** | Order ID. | [optional] -**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** | Default is empty (deprecated). | [optional] +**currency_pair** | **str** | Order currency pair | [optional] +**id** | **str** | Order ID | [optional] +**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 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 d070fcd..945eda4 100644 --- a/docs/CollateralAdjust.md +++ b/docs/CollateralAdjust.md @@ -3,9 +3,9 @@ ## Properties 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] +**order_id** | **int** | Order ID | +**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 777c60a..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] +**order_id** | **int** | Order ID | [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 b758aae..4b14840 100644 --- a/docs/CollateralAlign.md +++ b/docs/CollateralAlign.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | -**collateral_currency** | **str** | Collateral. | -**collateral_amount** | **str** | Collateral amount. | -**type** | **str** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | +**order_id** | **int** | Order ID | +**collateral_currency** | **str** | Collateral currency | +**collateral_amount** | **str** | Collateral amount | +**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/CollateralCurrency.md b/docs/CollateralCurrency.md index 330e7f3..016d704 100644 --- a/docs/CollateralCurrency.md +++ b/docs/CollateralCurrency.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**amount** | **str** | Size. | [optional] +**currency** | **str** | Currency | [optional] +**amount** | **str** | Size | [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/CollateralCurrencyInfo.md b/docs/CollateralCurrencyInfo.md index 1401846..0b1e1f4 100644 --- a/docs/CollateralCurrencyInfo.md +++ b/docs/CollateralCurrencyInfo.md @@ -3,10 +3,10 @@ ## Properties 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] +**currency** | **str** | Currency | [optional] +**index_price** | **str** | Currency Index Price | [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 5b53bf7..1a64fff 100644 --- a/docs/CollateralCurrencyRes.md +++ b/docs/CollateralCurrencyRes.md @@ -3,11 +3,11 @@ ## Properties 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] -**currency** | **str** | Currency. | [optional] -**amount** | **str** | Quantity of successful collateral operation; 0 if the operation fails. | [optional] +**succeeded** | **bool** | Update success status | [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** | 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 c41614e..f9a94d0 100644 --- a/docs/CollateralCurrentRate.md +++ b/docs/CollateralCurrentRate.md @@ -1,11 +1,11 @@ # CollateralCurrentRate -Multi-currency pledge current interest rate. +Multi-collateral current interest rate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**current_rate** | **str** | Currency current interest rate. | [optional] +**currency** | **str** | Currency | [optional] +**current_rate** | **str** | Currency current interest 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/CollateralFixRate.md b/docs/CollateralFixRate.md index e97f9aa..2f3f84f 100644 --- a/docs/CollateralFixRate.md +++ b/docs/CollateralFixRate.md @@ -1,13 +1,13 @@ # CollateralFixRate -Multi-collateral fixed interest rate. +Multi-collateral fixed interest rate ## Properties 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] +**currency** | **str** | Currency | [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 f120c03..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_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. -[**list_collateral_currencies**](CollateralLoanApi.md#list_collateral_currencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies. +[**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 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 @@ -45,13 +45,13 @@ configuration = gate_api.Configuration( 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) -borrow_currency = 'USDT' # str | Borrowed currency. (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) +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: @@ -64,10 +64,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 100] - **collateral_currency** | **str**| Collateral. | [optional] - **borrow_currency** | **str**| Borrowed currency. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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 @@ -319,16 +319,16 @@ configuration = gate_api.Configuration( api_client = gate_api.ApiClient(configuration) # Create an instance of the API class 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) -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) +source = 'repay' # str | Operation type: repay - Regular repayment, liquidate - Liquidation +borrow_currency = 'USDT' # str | Borrowed currency (optional) +collateral_currency = 'BTC' # str | Collateral currency (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) +_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: @@ -341,13 +341,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **source** | **str**| Operation type: repay - Regular repayment, liquidate - Liquidation. | - **borrow_currency** | **str**| Borrowed currency. | [optional] - **collateral_currency** | **str**| Collateral. | [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] + **source** | **str**| Operation type: repay - Regular repayment, liquidate - Liquidation | + **borrow_currency** | **str**| Borrowed currency | [optional] + **collateral_currency** | **str**| Collateral currency | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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,14 +365,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_collateral_records** > list[CollateralRecord] list_collateral_records(page=page, limit=limit, _from=_from, to=to, borrow_currency=borrow_currency, collateral_currency=collateral_currency) -Query collateral adjustment records. +Query collateral adjustment records ### Example @@ -398,15 +398,15 @@ configuration = gate_api.Configuration( 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) -borrow_currency = 'USDT' # str | Borrowed currency. (optional) -collateral_currency = 'BTC' # str | Collateral. (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) +_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 currency (optional) try: - # Query collateral adjustment records. + # Query collateral adjustment records api_response = api_instance.list_collateral_records(page=page, limit=limit, _from=_from, to=to, borrow_currency=borrow_currency, collateral_currency=collateral_currency) print(api_response) except GateApiException as ex: @@ -419,12 +419,12 @@ 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] - **borrow_currency** | **str**| Borrowed currency. | [optional] - **collateral_currency** | **str**| Collateral. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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 currency | [optional] ### Return type @@ -442,14 +442,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) # **operate_collateral** > operate_collateral(collateral_align) -Increase or redeem collateral. +Increase or redeem collateral ### Example @@ -478,7 +478,7 @@ api_instance = gate_api.CollateralLoanApi(api_client) collateral_align = gate_api.CollateralAlign() # CollateralAlign | try: - # Increase or redeem collateral. + # Increase or redeem collateral api_instance.operate_collateral(collateral_align) except GateApiException as ex: print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message)) @@ -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. -borrow_currency = 'USDT' # str | Borrowed currency. +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,8 +621,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collateral_currency** | **str**| Collateral. | - **borrow_currency** | **str**| Borrowed currency. | + **collateral_currency** | **str**| Collateral currency | + **borrow_currency** | **str**| Borrowed currency | ### Return type @@ -640,14 +640,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_collateral_currencies** > list[CollateralLoanCurrency] list_collateral_currencies(loan_currency=loan_currency) -Query supported borrowing and collateral currencies. +Query supported borrowing and collateral currencies ### Example @@ -664,10 +664,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) -loan_currency = 'BTC' # str | The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. (optional) +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. + # Query supported borrowing and collateral currencies api_response = api_instance.list_collateral_currencies(loan_currency=loan_currency) print(api_response) except GateApiException as ex: @@ -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. | [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/CollateralLoanCurrency.md b/docs/CollateralLoanCurrency.md index baa61a8..fc4151a 100644 --- a/docs/CollateralLoanCurrency.md +++ b/docs/CollateralLoanCurrency.md @@ -1,11 +1,11 @@ # CollateralLoanCurrency -Supported borrowing and collateral currencies. +Supported borrowing and collateral currencies ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loan_currency** | **str** | Borrowed currency. | [optional] -**collateral_currency** | **list[str]** | List of supported collateral currencies. | [optional] +**loan_currency** | **str** | Borrowed currency | [optional] +**collateral_currency** | **list[str]** | List of supported collateral currencies | [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/CollateralLtv.md b/docs/CollateralLtv.md index d9e0504..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 4596948..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_amount** | **str** | Collateral amount. | [optional] -**borrow_currency** | **str** | Borrowed currency. | [optional] -**borrow_amount** | **str** | Borrowing 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] +**order_id** | **int** | Order ID | [optional] +**collateral_currency** | **str** | Collateral currency | [optional] +**collateral_amount** | **str** | Collateral amount | [optional] +**borrow_currency** | **str** | Borrowed currency | [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** | 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] +**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 c083f74..f2fbfa7 100644 --- a/docs/CollateralRecord.md +++ b/docs/CollateralRecord.md @@ -1,19 +1,19 @@ # CollateralRecord -Collateral record. +Collateral record ## Properties 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] +**order_id** | **int** | Order ID | [optional] +**record_id** | **int** | Collateral record ID | [optional] +**borrow_currency** | **str** | Borrowed currency | [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 aa2cf9b..d7adc71 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -1,47 +1,49 @@ # Contract -Futures contract details. +Futures contract details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Futures contract. | [optional] -**type** | **str** | Futures contract type. | [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, 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] -**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] -**trade_id** | **int** | Current trade ID. | [optional] -**trade_size** | **int** | Historical accumulated trade size. | [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` contract is offline | [optional] -**orders_limit** | **int** | Maximum number of open orders. | [optional] -**enable_bonus** | **bool** | Whether bouns is enabled. | [optional] -**enable_credit** | **bool** | Whether portfolio margin account is enabled. | [optional] -**create_time** | **float** | Created time of the contract. | [optional] +**name** | **str** | Futures contract | [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 - 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, 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** | 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 cumulative trading volume | [optional] +**position_size** | **int** | Current total long position size | [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, trading, delisting, delisted. | [optional] -**launch_time** | **int** | Contract expiry timestamp. | [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 17b9038..f20a520 100644 --- a/docs/ContractStat.md +++ b/docs/ContractStat.md @@ -3,19 +3,20 @@ ## Properties 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] -**top_lsr_account** | **float** | Top trader long/short account ratio. | [optional] -**top_lsr_size** | **float** | Top trader long/short position ratio. | [optional] +**time** | **int** | Stat timestamp | [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 19f275b..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 5bd65b3..5cf1cd3 100644 --- a/docs/CountdownCancelAllFuturesTask.md +++ b/docs/CountdownCancelAllFuturesTask.md @@ -1,11 +1,11 @@ # 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 countdown | -**contract** | **str** | Futures contract. | [optional] +**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 79811ac..0f50bb0 100644 --- a/docs/CountdownCancelAllOptionsTask.md +++ b/docs/CountdownCancelAllOptionsTask.md @@ -1,12 +1,12 @@ # 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 countdown | -**contract** | **str** | Options contract name. | [optional] -**underlying** | **str** | Underlying. | [optional] +**contract** | **str** | Options contract name | [optional] +**underlying** | **str** | Underlying | [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/CountdownCancelAllSpotTask.md b/docs/CountdownCancelAllSpotTask.md index a5d3d52..49c09a8 100644 --- a/docs/CountdownCancelAllSpotTask.md +++ b/docs/CountdownCancelAllSpotTask.md @@ -1,11 +1,11 @@ # 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 countdown | -**currency_pair** | **str** | Currency pair. | [optional] +**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 9c83f9f..41db4cc 100644 --- a/docs/CreateCollateralOrder.md +++ b/docs/CreateCollateralOrder.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateral_amount** | **str** | Collateral amount. | -**collateral_currency** | **str** | Collateral. | -**borrow_amount** | **str** | Borrowing amount. | -**borrow_currency** | **str** | Borrowed currency. | +**collateral_amount** | **str** | Collateral 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 81b82ab..72aa727 100644 --- a/docs/CreateMultiCollateralOrder.md +++ b/docs/CreateMultiCollateralOrder.md @@ -3,15 +3,15 @@ ## Properties 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] -**borrow_currency** | **str** | Borrowed currency. | -**borrow_amount** | **str** | Borrowing amount. | -**collateral_currencies** | [**list[CollateralCurrency]**](CollateralCurrency.md) | Collateral currency and amount. | [optional] +**order_id** | **str** | Order ID | [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** | 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 61b2db6..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] +**currency** | **str** | Currency name | +**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 56dc03f..22ad9da 100644 --- a/docs/CreateUniLoan.md +++ b/docs/CreateUniLoan.md @@ -1,14 +1,14 @@ # CreateUniLoan -Borrow or repay. +Borrow or repay ## Properties 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 repaid in full. | [optional] -**currency_pair** | **str** | Currency pair. | +**currency** | **str** | Currency | +**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/CrossMarginBalance.md b/docs/CrossMarginBalance.md index d2f7b95..f4ccc54 100644 --- a/docs/CrossMarginBalance.md +++ b/docs/CrossMarginBalance.md @@ -3,10 +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] +**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/CrossMarginLoan.md b/docs/CrossMarginLoan.md index 9cdba3e..662a94c 100644 --- a/docs/CrossMarginLoan.md +++ b/docs/CrossMarginLoan.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Loan record ID. | [optional] [readonly] -**create_time** | **int** | Creation timestamp, in milliseconds. | [optional] [readonly] -**update_time** | **int** | Update timestamp, in milliseconds. | [optional] [readonly] -**currency** | **str** | Currency name. | -**amount** | **str** | Borrowed amount. | -**text** | **str** | User defined custom ID. | [optional] +**id** | **str** | Loan record ID | [optional] [readonly] +**create_time** | **int** | Creation timestamp, in milliseconds | [optional] [readonly] +**update_time** | **int** | Update timestamp, in milliseconds | [optional] [readonly] +**currency** | **str** | Currency name | +**amount** | **str** | Borrowed amount | +**text** | **str** | User defined custom ID | [optional] **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] +**repaid** | **str** | Repaid amount | [optional] [readonly] +**repaid_interest** | **str** | Repaid interest | [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 f0a7fea..3997879 100644 --- a/docs/CrossMarginRepayment.md +++ b/docs/CrossMarginRepayment.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Loan record ID. | [optional] -**create_time** | **int** | Repayment time. | [optional] -**loan_id** | **str** | Loan record ID. | [optional] -**currency** | **str** | Currency name. | [optional] -**principal** | **str** | Repaid principal. | [optional] -**interest** | **str** | Repaid interest. | [optional] +**id** | **str** | Loan record ID | [optional] +**create_time** | **int** | Repayment time | [optional] +**loan_id** | **str** | Loan record ID | [optional] +**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 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 fd491f8..27e0400 100644 --- a/docs/Currency.md +++ b/docs/Currency.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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 (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] +**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 (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** | The main chain corresponding to the coin. | [optional] -**chains** | [**list[SpotCurrencyChain]**](SpotCurrencyChain.md) | All links corresponding to coins. | [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 369f3d3..90a4984 100644 --- a/docs/CurrencyChain.md +++ b/docs/CurrencyChain.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **str** | Chain name. | [optional] -**name_cn** | **str** | Chain name in Chinese. | [optional] -**name_en** | **str** | Chain name in English. | [optional] +**chain** | **str** | Chain name | [optional] +**name_cn** | **str** | Chain name in Chinese | [optional] +**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] -**decimal** | **str** | Withdrawal precision. | [optional] +**is_disabled** | **int** | If it is disabled. 0 means NOT being disabled | [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 065967e..3f5f39f 100644 --- a/docs/CurrencyPair.md +++ b/docs/CurrencyPair.md @@ -1,28 +1,28 @@ # CurrencyPair -Spot currency pair. +Spot currency pair ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Currency pair. | [optional] -**base** | **str** | Base currency. | [optional] -**base_name** | **str** | Transaction currency name. | [optional] -**quote** | **str** | Quote currency. | [optional] -**quote_name** | **str** | Name of the denominated currency. | [optional] -**fee** | **str** | Trading fee. | [optional] -**min_base_amount** | **str** | Minimum amount of base currency to trade, `null` means no limit. | [optional] -**min_quote_amount** | **str** | Minimum amount of quote currency to trade, `null` means no limit. | [optional] -**max_base_amount** | **str** | Maximum amount of base currency to trade, `null` means no limit. | [optional] -**max_quote_amount** | **str** | Maximum amount of quote currency to trade, `null` means no limit. | [optional] -**amount_precision** | **int** | Amount scale. | [optional] -**precision** | **int** | Price scale. | [optional] -**trade_status** | **str** | How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: 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] +**id** | **str** | Currency pair | [optional] +**base** | **str** | Base currency | [optional] +**base_name** | **str** | Base currency name | [optional] +**quote** | **str** | Quote currency | [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** | 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 57a33eb..656a6a8 100644 --- a/docs/CurrencyQuota.md +++ b/docs/CurrencyQuota.md @@ -1,14 +1,14 @@ # CurrencyQuota -Currency Quota. +Currency Quota ## Properties 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] -**left_quote_usdt** | **str** | Remaining currency limit converted to USDT. | [optional] +**currency** | **str** | Currency | [optional] +**index_price** | **str** | Currency Index Price | [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/DebitFee.md b/docs/DebitFee.md index d04d9bc..98d0744 100644 --- a/docs/DebitFee.md +++ b/docs/DebitFee.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**enabled** | **bool** | Whether GT fee discount is used. | +**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 0ed5f6b..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. -[**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 Price-triggered 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 Price-triggered 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_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 | 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 @@ -55,10 +55,10 @@ configuration = gate_api.Configuration( 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. +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: @@ -71,7 +71,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | ### Return type @@ -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 @@ -113,11 +113,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. +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: @@ -130,8 +130,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -149,16 +149,16 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information. | - | +**200** | Contract 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) # **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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -175,14 +175,14 @@ configuration = gate_api.Configuration( 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. -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 to return depth update ID. This ID increments by 1 each time. (optional) (default to False) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +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: @@ -195,11 +195,11 @@ except ApiException as e: 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to False] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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** | Depth query successful. | - | +**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 @@ -241,15 +241,15 @@ configuration = gate_api.Configuration( 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. -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 | 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持,新的请求请使用 `from` 和 `to` 字段来限定时间范围 (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +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) 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: @@ -262,10 +262,10 @@ except ApiException as e: 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**| 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持,新的请求请使用 `from` 和 `to` 字段来限定时间范围 | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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] @@ -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` @@ -311,15 +311,15 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. +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 | 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 specified (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 | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time (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: @@ -332,12 +332,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **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**| 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 specified | [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**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time | [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[DeliveryTicker] list_delivery_tickers(settle, contract=contract) -List futures tickers. +Get all futures trading statistics ### Example @@ -379,11 +379,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. (optional) +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: @@ -396,8 +396,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | [optional] ### Return type @@ -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 @@ -439,11 +439,11 @@ configuration = gate_api.Configuration( 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) +settle = 'usdt' # str | Settle currency +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: @@ -456,8 +456,8 @@ 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] + **settle** | **str**| Settle currency | + **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 @@ -508,10 +508,10 @@ configuration = gate_api.Configuration( 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. +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: @@ -524,7 +524,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | ### Return type @@ -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 @@ -575,14 +575,14 @@ configuration = gate_api.Configuration( 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) +settle = 'usdt' # str | Settle currency +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 | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate (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: @@ -595,11 +595,11 @@ 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] + **settle** | **str**| Settle currency | + **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**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [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 @@ -650,10 +650,10 @@ configuration = gate_api.Configuration( 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. +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: @@ -666,7 +666,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | ### Return type @@ -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 @@ -717,11 +717,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. +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: @@ -734,8 +734,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -753,14 +753,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_delivery_position_margin** > Position update_delivery_position_margin(settle, contract, change) -Update position margin. +Update position margin ### Example @@ -786,12 +786,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. -change = '0.01' # str | Margin change amount, positive number increases, negative number. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +change = '0.01' # str | Margin change amount, positive number increases, negative number decreases try: - # Update position margin. + # Update position margin api_response = api_instance.update_delivery_position_margin(settle, contract, change) print(api_response) except GateApiException as ex: @@ -804,9 +804,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **change** | **str**| Margin change amount, positive number increases, negative number. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **change** | **str**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -824,14 +824,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_delivery_position_leverage** > Position update_delivery_position_leverage(settle, contract, leverage) -Update position leverage. +Update position leverage ### Example @@ -857,12 +857,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. -leverage = '10' # str | New position leverage. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +leverage = '10' # str | New position leverage try: - # Update position leverage. + # Update position leverage api_response = api_instance.update_delivery_position_leverage(settle, contract, leverage) print(api_response) except GateApiException as ex: @@ -875,9 +875,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **leverage** | **str**| New position leverage. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **leverage** | **str**| New position leverage | ### Return type @@ -895,14 +895,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_delivery_position_risk_limit** > Position update_delivery_position_risk_limit(settle, contract, risk_limit) -Update position risk limit. +Update position risk limit ### Example @@ -928,12 +928,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. -risk_limit = '10' # str | New position risk limit. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +risk_limit = '10' # str | New position risk limit try: - # Update position risk limit. + # Update position risk limit api_response = api_instance.update_delivery_position_risk_limit(settle, contract, risk_limit) print(api_response) except GateApiException as ex: @@ -946,9 +946,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **risk_limit** | **str**| New position risk limit. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **risk_limit** | **str**| New position risk limit | ### Return type @@ -966,16 +966,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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) # **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 @@ -1001,16 +1001,16 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) -last_id = '12345' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) -count_total = 0 # int | Whether to return total number matched. Default to 0(no return). (optional) (default to 0) +settle = 'usdt' # str | Settle currency +status = 'open' # str | Query order list based on status +contract = 'BTC_USDT_20200814' # str | Futures contract (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) +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: @@ -1023,13 +1023,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **status** | **str**| Only list the orders with this status. | - **contract** | **str**| Futures contract. | [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] - **last_id** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **count_total** | **int**| Whether to return total number matched. Default to 0(no return). | [optional] [default to 0] + **settle** | **str**| Settle currency | + **status** | **str**| Query order list based on status | + **contract** | **str**| Futures contract | [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] + **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 @@ -1082,11 +1082,11 @@ configuration = gate_api.Configuration( 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. +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: @@ -1099,7 +1099,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_order** | [**FuturesOrder**](FuturesOrder.md)| | ### Return type @@ -1118,16 +1118,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details. | - | +**201** | 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_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 @@ -1153,12 +1153,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT_20200814' # str | Futures contract. -side = 'ask' # str | All bids or asks. Both included if not specified. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract +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: @@ -1171,9 +1171,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **side** | **str**| All bids or asks. Both included if not specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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 @@ -1226,11 +1226,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -1243,8 +1243,8 @@ 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. | + **settle** | **str**| Settle currency | + **order_id** | **str**| ID returned when order is successfully created | ### Return type @@ -1262,14 +1262,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | 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_delivery_order** > FuturesOrder cancel_delivery_order(settle, order_id) -Cancel a single order. +Cancel single order ### Example @@ -1295,11 +1295,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -1312,8 +1312,8 @@ 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. | + **settle** | **str**| Settle currency | + **order_id** | **str**| ID returned when order is successfully created | ### Return type @@ -1331,14 +1331,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | 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) # **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 @@ -1364,16 +1364,16 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) -last_id = '12345' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) -count_total = 0 # int | Whether to return total number matched. Default to 0(no return). (optional) (default to 0) +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 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 | 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: @@ -1386,13 +1386,13 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] - **last_id** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **count_total** | **int**| Whether to return total number matched. Default to 0(no return). | [optional] [default to 0] + **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 returned in a single list | [optional] [default to 100] + **offset** | **int**| List offset, starting from 0 | [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 @@ -1443,12 +1443,12 @@ configuration = gate_api.Configuration( 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. -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) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract (optional) +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: @@ -1461,9 +1461,9 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | [optional] + **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 @@ -1514,13 +1514,13 @@ configuration = gate_api.Configuration( 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. -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) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract (optional) +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: @@ -1533,10 +1533,10 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | [optional] + **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 @@ -1587,13 +1587,13 @@ configuration = gate_api.Configuration( 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. -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) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract (optional) +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: @@ -1606,10 +1606,10 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | [optional] + **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 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 @@ -1653,13 +1653,13 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT_20200814' # str | Futures contract (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 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: @@ -1672,10 +1672,10 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | [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 @@ -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 Price-triggered Orders. +Query auto order list ### Example @@ -1726,14 +1726,14 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +settle = 'usdt' # str | Settle currency +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 returned in a single list (optional) (default to 100) +offset = 0 # int | List offset, starting from 0 (optional) (default to 0) try: - # List All Price-triggered 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: @@ -1746,11 +1746,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **status** | **str**| Only list the orders with this 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **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 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 @@ -1801,11 +1801,11 @@ configuration = gate_api.Configuration( 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. +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: @@ -1818,7 +1818,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_price_triggered_order** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -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 Price-triggered Orders. +Cancel all auto orders ### Example @@ -1870,11 +1870,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract try: - # Cancel All Price-triggered Orders. + # Cancel all auto orders api_response = api_instance.cancel_price_triggered_delivery_order_list(settle, contract) print(api_response) except GateApiException as ex: @@ -1887,8 +1887,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -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 @@ -1939,11 +1939,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -1956,8 +1956,8 @@ 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. | + **settle** | **str**| Settle currency | + **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 @@ -2008,11 +2008,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -2025,8 +2025,8 @@ 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. | + **settle** | **str**| Settle currency | + **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/DeliveryCandlestick.md b/docs/DeliveryCandlestick.md index bc74e96..16cbd49 100644 --- a/docs/DeliveryCandlestick.md +++ b/docs/DeliveryCandlestick.md @@ -1,15 +1,15 @@ # DeliveryCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **float** | Unix timestamp in seconds. | [optional] -**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **str** | Close price (quote currency). | [optional] -**h** | **str** | Highest price (quote currency). | [optional] -**l** | **str** | Lowest price (quote currency). | [optional] -**o** | **str** | Open price (quote currency). | [optional] +**t** | **float** | Unix timestamp in seconds | [optional] +**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **str** | Close price (quote currency) | [optional] +**h** | **str** | Highest price (quote currency) | [optional] +**l** | **str** | Lowest price (quote currency) | [optional] +**o** | **str** | Open price (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/DeliveryContract.md b/docs/DeliveryContract.md index f7b45cf..9675b71 100644 --- a/docs/DeliveryContract.md +++ b/docs/DeliveryContract.md @@ -1,47 +1,47 @@ # DeliveryContract -Futures contract details. +Futures contract details ## Properties 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] -**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, 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] -**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] -**basis_rate** | **str** | Fair basis rate. | [optional] -**basis_value** | **str** | Fair basis value. | [optional] -**basis_impact_value** | **str** | Funding used for calculating impact bid, ask price. | [optional] -**settle_price** | **str** | Settle price. | [optional] -**settle_price_interval** | **int** | Settle price update interval. | [optional] -**settle_price_duration** | **int** | Settle price update duration in seconds. | [optional] -**expire_time** | **int** | Contract expiry timestamp. | [optional] -**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] -**trade_id** | **int** | Current trade ID. | [optional] -**trade_size** | **int** | Historical accumulated trade size. | [optional] -**position_size** | **int** | Current total long position size. | [optional] -**config_change_time** | **float** | Last changed time of configuration. | [optional] -**in_delisting** | **bool** | Contract is delisting. | [optional] -**orders_limit** | **int** | Maximum number of open orders. | [optional] +**name** | **str** | Futures contract | [optional] +**underlying** | **str** | Underlying | [optional] +**cycle** | **str** | Cycle type, e.g. WEEKLY, QUARTERLY | [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 - 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, 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] +**basis_rate** | **str** | Fair basis rate | [optional] +**basis_value** | **str** | Fair basis value | [optional] +**basis_impact_value** | **str** | Funding used for calculating impact bid, ask price | [optional] +**settle_price** | **str** | Settle price | [optional] +**settle_price_interval** | **int** | Settle price update interval | [optional] +**settle_price_duration** | **int** | Settle price update duration in seconds | [optional] +**expire_time** | **int** | Contract expiry timestamp | [optional] +**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 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 cumulative trading volume | [optional] +**position_size** | **int** | Current total long position size | [optional] +**config_change_time** | **float** | Last configuration update time | [optional] +**in_delisting** | **bool** | Contract is delisting | [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/DeliverySettlement.md b/docs/DeliverySettlement.md index 6fb01e0..06a479a 100644 --- a/docs/DeliverySettlement.md +++ b/docs/DeliverySettlement.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **int** | Liquidation time. | [optional] [readonly] -**contract** | **str** | Futures contract. | [optional] [readonly] -**leverage** | **str** | Position leverage. | [optional] [readonly] -**size** | **int** | Position size. | [optional] [readonly] -**margin** | **str** | Position margin. | [optional] [readonly] -**entry_price** | **str** | Average entry price. | [optional] [readonly] -**settle_price** | **str** | Settled price. | [optional] [readonly] -**profit** | **str** | Profit. | [optional] [readonly] -**fee** | **str** | Fee deducted. | [optional] [readonly] +**time** | **int** | Liquidation time | [optional] [readonly] +**contract** | **str** | Futures contract | [optional] [readonly] +**leverage** | **str** | Position leverage | [optional] [readonly] +**size** | **int** | Position size | [optional] [readonly] +**margin** | **str** | Position margin | [optional] [readonly] +**entry_price** | **str** | Average entry price | [optional] [readonly] +**settle_price** | **str** | Settled price | [optional] [readonly] +**profit** | **str** | Profit | [optional] [readonly] +**fee** | **str** | Fee deducted | [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/DeliveryTicker.md b/docs/DeliveryTicker.md index 5f09c1b..b8de016 100644 --- a/docs/DeliveryTicker.md +++ b/docs/DeliveryTicker.md @@ -3,29 +3,29 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **str** | Futures contract. | [optional] -**last** | **str** | Last trading price. | [optional] -**change_percentage** | **str** | Change percentage. | [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] -**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] +**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] +**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/DepositAddress.md b/docs/DepositAddress.md index 2d624ac..b28d7ec 100644 --- a/docs/DepositAddress.md +++ b/docs/DepositAddress.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | -**address** | **str** | Deposit address. | +**currency** | **str** | Currency detail | +**address** | **str** | Deposit address | **multichain_addresses** | [**list[MultiChainAddressItem]**](MultiChainAddressItem.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/DepositRecord.md b/docs/DepositRecord.md index 020bc4c..e5fa3b5 100644 --- a/docs/DepositRecord.md +++ b/docs/DepositRecord.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Record ID. | [optional] [readonly] -**txid** | **str** | Hash record of the withdrawal. | [optional] [readonly] +**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** | Currency amount. | -**currency** | **str** | Currency name. | -**address** | **str** | Withdrawal address. Required for withdrawals. | [optional] -**memo** | **str** | Additional remarks with regards to the withdrawal. | [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. | +**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 cb08085..91f79de 100644 --- a/docs/DualGetOrders.md +++ b/docs/DualGetOrders.md @@ -3,23 +3,23 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Order ID. | [optional] -**plan_id** | **int** | Plan ID. | [optional] -**copies** | **str** | Copies. | [optional] -**invest_amount** | **str** | Investment Amount. | [optional] -**settlement_amount** | **str** | Settlement Amount. | [optional] -**create_time** | **int** | Creation time. | [optional] -**complete_time** | **int** | Completion Time. | [optional] -**status** | **str** | Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed | [optional] -**invest_currency** | **str** | Investment Currency. | [optional] -**exercise_currency** | **str** | Strike Currency. | [optional] -**exercise_price** | **str** | Strike price. | [optional] -**settlement_price** | **str** | settlement price. | [optional] -**settlement_currency** | **str** | Settle currency. | [optional] -**apy_display** | **str** | APY. | [optional] -**apy_settlement** | **str** | Settlement APY. | [optional] -**delivery_time** | **int** | Settlement time. | [optional] -**text** | **str** | Custom order information. | [optional] +**id** | **int** | Order ID | [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** | 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 1f893b6..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] -**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] +**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 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 ae6b0c1..a2b83b8 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -4,22 +4,22 @@ 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 rate of return 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**](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** > swap_eth2(eth2_swap) -ETH2 swap. +ETH2 swap ### Example @@ -48,7 +48,7 @@ api_instance = gate_api.EarnApi(api_client) eth2_swap = gate_api.Eth2Swap() # Eth2Swap | try: - # ETH2 swap. + # ETH2 swap api_instance.swap_eth2(eth2_swap) except GateApiException as ex: print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message)) @@ -78,16 +78,16 @@ 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 rate of return query. +ETH2 historical return rate query -Check the ETH earnings rate record for the last 31 days. +Query ETH earnings rate records for the last 31 days ### Example @@ -115,7 +115,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.EarnApi(api_client) try: - # ETH2 historical rate of return query. + # ETH2 historical return rate query api_response = api_instance.rate_list_eth2() print(api_response) except GateApiException as ex: @@ -143,14 +143,14 @@ 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_dual_investment_plans** > list[DualGetPlans] list_dual_investment_plans(plan_id=plan_id) -Dual Investment product list. +Dual Investment product list ### Example @@ -167,10 +167,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) -plan_id = 1 # int | Financial project id. (optional) +plan_id = 1 # int | Financial project ID (optional) try: - # Dual Investment product list. + # Dual Investment product list api_response = api_instance.list_dual_investment_plans(plan_id=plan_id) print(api_response) except GateApiException as ex: @@ -183,7 +183,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **plan_id** | **int**| Financial project id. | [optional] + **plan_id** | **int**| Financial project ID | [optional] ### Return type @@ -201,14 +201,14 @@ 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(_from=_from, to=to, page=page, limit=limit) -Dual Investment order list. +Dual Investment order list ### Example @@ -234,13 +234,13 @@ 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 checkout 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 to be returned in a single list. (optional) (default to 100) +_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. + # Dual Investment order list api_response = api_instance.list_dual_orders(_from=_from, to=to, page=page, limit=limit) print(api_response) except GateApiException as ex: @@ -253,10 +253,10 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **_from** | **int**| Start checkout time. | [optional] - **to** | **int**| End settlement 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] + **_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 @@ -274,14 +274,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) # **place_dual_order** > place_dual_order(place_dual_investment_order) -Place Dual Investment order. +Place Dual Investment order ### Example @@ -310,7 +310,7 @@ api_instance = gate_api.EarnApi(api_client) place_dual_investment_order = gate_api.PlaceDualInvestmentOrder() # PlaceDualInvestmentOrder | try: - # Place Dual Investment order. + # Place Dual Investment order api_instance.place_dual_order(place_dual_investment_order) except GateApiException as ex: print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message)) @@ -340,14 +340,14 @@ 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) # **list_structured_products** > list[StructuredGetProjectList] list_structured_products(status, type=type, page=page, limit=limit) -Structured Product List. +Structured Product List ### Example @@ -366,11 +366,11 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.EarnApi(api_client) 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) +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: - # Structured Product List. + # Structured Product List api_response = api_instance.list_structured_products(status, type=type, page=page, limit=limit) print(api_response) except GateApiException as ex: @@ -385,8 +385,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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] + **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 @@ -404,14 +404,14 @@ 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_structured_orders** > list[StructuredOrderList] list_structured_orders(_from=_from, to=to, page=page, limit=limit) -Structured Product Order List. +Structured Product Order List ### Example @@ -439,11 +439,11 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.EarnApi(api_client) _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) +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: - # Structured Product Order List. + # Structured Product Order List api_response = api_instance.list_structured_orders(_from=_from, to=to, page=page, limit=limit) print(api_response) except GateApiException as ex: @@ -458,8 +458,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **_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] + **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 @@ -477,14 +477,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) # **place_structured_order** > place_structured_order(structured_buy) -Place Structured Product Order. +Place Structured Product Order ### Example @@ -513,7 +513,7 @@ api_instance = gate_api.EarnApi(api_client) structured_buy = gate_api.StructuredBuy() # StructuredBuy | try: - # Place Structured Product Order. + # Place Structured Product Order api_instance.place_structured_order(structured_buy) except GateApiException as ex: print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message)) @@ -543,14 +543,14 @@ 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** -> list[str] find_coin(find_coin) +> object find_coin(find_coin) -Staking Coins. +Staking coins ### Example @@ -579,7 +579,7 @@ api_instance = gate_api.EarnApi(api_client) find_coin = gate_api.FindCoin() # FindCoin | try: - # Staking Coins. + # Staking coins api_response = api_instance.find_coin(find_coin) print(api_response) except GateApiException as ex: @@ -596,7 +596,7 @@ Name | Type | Description | Notes ### Return type -**list[str]** +**object** ### Authorization @@ -610,14 +610,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) # **swap_staking_coin** > SwapCoinStruct swap_staking_coin(swap_coin) -On-chain Token Swap for Earned Coins. +On-chain token swap for earned coins ### Example @@ -646,7 +646,7 @@ api_instance = gate_api.EarnApi(api_client) swap_coin = gate_api.SwapCoin() # SwapCoin | try: - # On-chain Token Swap for Earned Coins. + # On-chain token swap for earned coins api_response = api_instance.swap_staking_coin(swap_coin) print(api_response) except GateApiException as ex: @@ -677,7 +677,7 @@ Name | Type | Description | Notes ### 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) diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 5dfa439..5128e5d 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -4,23 +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. -[**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 estimate annualized interest rate. +[**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 @@ -39,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: @@ -67,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 @@ -91,10 +91,10 @@ 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. +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: @@ -107,7 +107,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | + **currency** | **str**| Currency | ### Return type @@ -125,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 @@ -158,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) -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) +currency = 'BTC' # str | Query by specified currency name (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: - # 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: @@ -176,9 +176,9 @@ except ApiException as e: 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] + **currency** | **str**| Query by specified currency name | [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 @@ -196,14 +196,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) # **create_uni_lend** > create_uni_lend(create_uni_lend) -Lend or redeem. +Create lending or redemption 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. @@ -234,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)) @@ -264,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 @@ -302,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)) @@ -332,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 @@ -365,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) -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) +currency = 'BTC' # str | Query by specified currency name (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) _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 | type: lend - lend, redeem - redeem. (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: @@ -386,12 +386,12 @@ except ApiException as e: 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] + **currency** | **str**| Query by specified currency name | [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] **_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**| type: lend - lend, redeem - redeem. | [optional] + **type** | **str**| Operation type: lend - Lend, redeem - Redeem | [optional] ### Return type @@ -409,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 @@ -442,10 +442,10 @@ 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. +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: @@ -458,7 +458,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | + **currency** | **str**| Currency | ### Return type @@ -476,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 @@ -509,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) -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) +currency = 'BTC' # str | Query by specified currency name (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) _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: @@ -529,9 +529,9 @@ except ApiException as e: 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] + **currency** | **str**| Query by specified currency name | [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] **_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] @@ -551,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) # **get_uni_interest_status** > UniCurrencyInterest get_uni_interest_status(currency) -query currency interest compounding status. +Query currency interest compounding status ### Example @@ -584,10 +584,10 @@ 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. +currency = 'btc' # str | Currency try: - # query currency interest compounding status. + # Query currency interest compounding status api_response = api_instance.get_uni_interest_status(currency) print(api_response) except GateApiException as ex: @@ -600,7 +600,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | + **currency** | **str**| Currency | ### Return type @@ -618,14 +618,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_chart** > list[InlineResponse200] list_uni_chart(_from, to, asset) -UniLoan currency annualized trend chart. +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 @@ -653,12 +653,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) -_from = 1719763200 # int | Start timestamp, unit s, maximum span of 30 days. -to = 1722441600 # int | End timestamp, unit s, maximum span of 30 days. -asset = 'BTC' # str | Currency name. +_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: - # UniLoan currency annualized trend chart. + # UniLoan currency annualized trend chart api_response = api_instance.list_uni_chart(_from, to, asset) print(api_response) except GateApiException as ex: @@ -671,9 +671,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **_from** | **int**| Start timestamp, unit s, maximum span of 30 days. | - **to** | **int**| End timestamp, unit s, maximum span of 30 days. | - **asset** | **str**| Currency name. | + **_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 @@ -698,7 +698,7 @@ Name | Type | Description | Notes # **list_uni_rate** > list[InlineResponse2001] list_uni_rate() -Currency estimate annualized interest 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 @@ -728,7 +728,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.EarnUniApi(api_client) try: - # Currency estimate annualized interest rate. + # Currency estimated annualized interest rate api_response = api_instance.list_uni_rate() print(api_response) except GateApiException as ex: diff --git a/docs/Eth2RateList.md b/docs/Eth2RateList.md index 9cf6772..574d27a 100644 --- a/docs/Eth2RateList.md +++ b/docs/Eth2RateList.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**date_time** | **int** | Date and Time Stamp. | [optional] -**date** | **str** | Date. | [optional] -**rate** | **str** | percentage. | [optional] +**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 a7eb910..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/FindCoin.md b/docs/FindCoin.md index 3aa2fdf..784880a 100644 --- a/docs/FindCoin.md +++ b/docs/FindCoin.md @@ -3,8 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coin** | **str** | Currency. | [optional] -**cointype** | **str** | Coin Type swap-Voucher lock-Locked. | [optional] +**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 93ee6f6..39fd84a 100644 --- a/docs/FlashSwapApi.md +++ b/docs/FlashSwapApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**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. -[**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. +[**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 | 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} | 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_currency_pair** > list[FlashSwapCurrencyPair] list_flash_swap_currency_pair(currency=currency, page=page, limit=limit) -List All Supported Currency Pairs In Flash Swap. +List All Supported Currency Pairs In Flash Swap `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. @@ -33,12 +33,12 @@ 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) -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) +currency = 'BTC' # str | Query by specified currency name (optional) +page = 1 # int | Page number (optional) (default to 1) +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. + # List All Supported Currency Pairs In Flash Swap api_response = api_instance.list_flash_swap_currency_pair(currency=currency, page=page, limit=limit) print(api_response) except GateApiException as ex: @@ -51,9 +51,9 @@ except ApiException as e: 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: 1000. | [optional] [default to 1000] + **currency** | **str**| Query by specified currency name | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **limit** | **int**| Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 | [optional] [default to 1000] ### Return type @@ -71,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 @@ -104,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) - ascending order(oldest first) (optional) -limit = 100 # int | Maximum number of records to be returned in a single list. (optional) (default to 100) -page = 1 # int | Page number. (optional) (default to 1) +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: @@ -125,12 +125,12 @@ 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) - ascending order(oldest first) | [optional] - **limit** | **int**| Maximum number of records to be returned in a single list. | [optional] [default to 100] - **page** | **int**| Page number. | [optional] [default to 1] + **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 @@ -148,14 +148,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_flash_swap_order** > FlashSwapOrder create_flash_swap_order(flash_swap_order_request) -Create a flash swap order. +Create a flash swap order Initiate a flash swap preview in advance because order creation requires a preview result @@ -186,7 +186,7 @@ api_instance = gate_api.FlashSwapApi(api_client) flash_swap_order_request = gate_api.FlashSwapOrderRequest() # FlashSwapOrderRequest | try: - # Create a flash swap order. + # Create a flash swap order api_response = api_instance.create_flash_swap_order(flash_swap_order_request) print(api_response) except GateApiException as ex: @@ -217,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 @@ -250,10 +250,10 @@ configuration = gate_api.Configuration( api_client = gate_api.ApiClient(configuration) # Create an instance of the API class api_instance = gate_api.FlashSwapApi(api_client) -order_id = 1 # int | Flash swap order ID. +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: @@ -266,7 +266,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **order_id** | **int**| Flash swap order ID. | + **order_id** | **int**| Flash swap order ID | ### Return type @@ -284,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 @@ -320,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: @@ -351,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/FlashSwapCurrencyPair.md b/docs/FlashSwapCurrencyPair.md index 8b9ad7a..28eacbc 100644 --- a/docs/FlashSwapCurrencyPair.md +++ b/docs/FlashSwapCurrencyPair.md @@ -1,16 +1,16 @@ # FlashSwapCurrencyPair -List all supported currencies in flash swap. +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/FlashSwapOrder.md b/docs/FlashSwapOrder.md index 1de23b8..bde41a4 100644 --- a/docs/FlashSwapOrder.md +++ b/docs/FlashSwapOrder.md @@ -1,17 +1,17 @@ # FlashSwapOrder -Flash swap order. +Flash swap order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Flash swap order ID. | [optional] [readonly] -**create_time** | **int** | Creation time of order (in milliseconds). | [optional] [readonly] -**user_id** | **int** | User ID. | [optional] [readonly] -**sell_currency** | **str** | Currency to sell. | [optional] [readonly] -**sell_amount** | **str** | Amount to sell. | [optional] [readonly] -**buy_currency** | **str** | Currency to buy. | [optional] [readonly] -**buy_amount** | **str** | Amount to buy. | [optional] [readonly] -**price** | **str** | Price. | [optional] [readonly] +**id** | **int** | Flash swap order ID | [optional] [readonly] +**create_time** | **int** | Creation time of order (in milliseconds) | [optional] [readonly] +**user_id** | **int** | User ID | [optional] [readonly] +**sell_currency** | **str** | Currency to sell | [optional] [readonly] +**sell_amount** | **str** | Amount to sell | [optional] [readonly] +**buy_currency** | **str** | Currency to buy | [optional] [readonly] +**buy_amount** | **str** | Amount to buy | [optional] [readonly] +**price** | **str** | Price | [optional] [readonly] **status** | **int** | Flash swap order status `1` - success `2` - failure | [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 e501402..4ee4133 100644 --- a/docs/FlashSwapOrderPreview.md +++ b/docs/FlashSwapOrderPreview.md @@ -1,15 +1,15 @@ # FlashSwapOrderPreview -Initiate a flash swap order preview. +Flash swap order preview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**preview_id** | **str** | Preview result ID. | [optional] +**preview_id** | **str** | Preview result ID | [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] +**sell_amount** | **str** | Amount to sell | [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] +**buy_amount** | **str** | Amount to buy | [optional] +**price** | **str** | 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/FlashSwapOrderRequest.md b/docs/FlashSwapOrderRequest.md index 44ea215..aea0466 100644 --- a/docs/FlashSwapOrderRequest.md +++ b/docs/FlashSwapOrderRequest.md @@ -1,14 +1,14 @@ # FlashSwapOrderRequest -Parameters of flash swap order creation. +Parameters of flash swap order creation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**preview_id** | **str** | Preview result ID. | +**preview_id** | **str** | Preview result ID | **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). | +**sell_amount** | **str** | Amount to sell (based on the preview result) | **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). | +**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 47d59e6..3a45a36 100644 --- a/docs/FlashSwapPreviewRequest.md +++ b/docs/FlashSwapPreviewRequest.md @@ -1,12 +1,12 @@ # FlashSwapPreviewRequest -Parameters of flash swap order creation. +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/FundingAccount.md b/docs/FundingAccount.md index a1a4e84..f84f8fe 100644 --- a/docs/FundingAccount.md +++ b/docs/FundingAccount.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency name. | [optional] -**available** | **str** | Available assets to lend, which is identical to spot account `available`. | [optional] -**locked** | **str** | Locked amount. i.e. amount in `open` loans. | [optional] -**lent** | **str** | Outstanding loan amount yet to be repaid. | [optional] -**total_lent** | **str** | Amount used for lending. total_lent = lent + locked. | [optional] +**currency** | **str** | Currency name | [optional] +**available** | **str** | Available assets to lend, which is identical to spot account `available` | [optional] +**locked** | **str** | Locked amount. i.e. amount in `open` loans | [optional] +**lent** | **str** | Outstanding loan amount yet to be repaid | [optional] +**total_lent** | **str** | Amount used for lending. total_lent = lent + locked | [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/FundingRateRecord.md b/docs/FundingRateRecord.md index 19961eb..add60cd 100644 --- a/docs/FundingRateRecord.md +++ b/docs/FundingRateRecord.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **int** | Unix timestamp in seconds. | [optional] -**r** | **str** | Funding rate. | [optional] +**t** | **int** | Unix timestamp in seconds | [optional] +**r** | **str** | Funding 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/FutureCancelOrderResult.md b/docs/FutureCancelOrderResult.md index b4b0be4..865d529 100644 --- a/docs/FutureCancelOrderResult.md +++ b/docs/FutureCancelOrderResult.md @@ -1,13 +1,13 @@ # FutureCancelOrderResult -Order cancellation result. +Order cancellation result ## Properties 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] +**id** | **str** | Order ID | [optional] +**user_id** | **int** | User ID | [optional] +**succeeded** | **bool** | Whether cancellation 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 c8851c7..590e0c8 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -4,30 +4,31 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | **str** | total is the balance after the user's accumulated deposit, withdraw, profit and loss (including realized profit and loss, fund, fee and referral rebate), excluding unrealized profit and loss. total = SUM(history_dnw, history_pnl, history_fee, history_refr, history_fund) | [optional] -**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 withdrawn. The transfer amount needs to deduct the bonus) | [optional] -**point** | **str** | POINT amount. | [optional] -**currency** | **str** | Settle currency. | [optional] -**in_dual_mode** | **bool** | Whether dual mode is enabled. | [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] -**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] -**cross_margin_balance** | **str** | Full margin balance, suitable for the new classic account margin model. | [optional] -**cross_mmr** | **str** | Maintain margin ratio for the full position, suitable for the new classic account margin model | [optional] -**cross_imr** | **str** | The initial margin rate of the full position is 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] -**enable_new_dual_mode** | **bool** | Whether to open a new two-way position mode. | [optional] +**unrealised_pnl** | **str** | Unrealized PNL | [optional] +**position_margin** | **str** | Position margin | [optional] +**order_margin** | **str** | Order margin of unfinished orders | [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 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** | 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] +**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 3ee9fc8..0056f17 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -3,14 +3,14 @@ ## Properties 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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] -**text** | **str** | Comment. | [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** | Account change record ID. | [optional] +**time** | **float** | Change time | [optional] +**change** | **str** | Change amount | [optional] +**balance** | **str** | Balance after change | [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] +**trade_id** | **str** | trade 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/FuturesAccountHistory.md b/docs/FuturesAccountHistory.md index 04e343f..202fdc6 100644 --- a/docs/FuturesAccountHistory.md +++ b/docs/FuturesAccountHistory.md @@ -1,19 +1,19 @@ # FuturesAccountHistory -Statistical data. +Statistical data ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dnw** | **str** | total amount of deposit and withdraw. | [optional] -**pnl** | **str** | total amount of trading profit and loss. | [optional] -**fee** | **str** | total amount of fee. | [optional] -**refr** | **str** | total amount of referrer rebates. | [optional] -**fund** | **str** | total amount of funding costs. | [optional] -**point_dnw** | **str** | total amount of point deposit and withdraw. | [optional] -**point_fee** | **str** | total amount of point fee. | [optional] -**point_refr** | **str** | total amount of referrer rebates of point fee. | [optional] -**bonus_dnw** | **str** | total amount of perpetual contract bonus transfer. | [optional] -**bonus_offset** | **str** | total amount of perpetual contract bonus deduction. | [optional] +**dnw** | **str** | total amount of deposit and withdraw | [optional] +**pnl** | **str** | total amount of trading profit and loss | [optional] +**fee** | **str** | total amount of fee | [optional] +**refr** | **str** | total amount of referrer rebates | [optional] +**fund** | **str** | total amount of funding costs | [optional] +**point_dnw** | **str** | total amount of point deposit and withdraw | [optional] +**point_fee** | **str** | total amount of point fee | [optional] +**point_refr** | **str** | total amount of referrer rebates of point fee | [optional] +**bonus_dnw** | **str** | total amount of perpetual contract bonus transfer | [optional] +**bonus_offset** | **str** | total amount of perpetual contract bonus deduction | [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 bf1b06d..75ce6fe 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -4,61 +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. -[**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 to the full position-by-store 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. -[**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. -[**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. -[**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 | List All Price-triggered 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 Price-triggered 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. +[**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 | 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 | 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 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 @@ -75,12 +76,12 @@ configuration = gate_api.Configuration( 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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +settle = 'usdt' # str | Settle currency +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: @@ -93,9 +94,9 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **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 @@ -113,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 @@ -137,11 +138,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +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: @@ -154,8 +155,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -173,16 +174,16 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information. | - | +**200** | Contract 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) # **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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -199,14 +200,14 @@ configuration = gate_api.Configuration( 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. -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 to return depth update ID. This ID increments by 1 each time. (optional) (default to False) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +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,11 +220,11 @@ except ApiException as e: 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to False] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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 @@ -241,14 +242,14 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Depth query successful. | - | +**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,16 +266,16 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -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) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +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) 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,10 +288,10 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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] @@ -311,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` @@ -337,16 +338,17 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +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 | 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 specified (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. 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)) @@ -358,12 +360,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **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**| 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 specified | [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. 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 @@ -381,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 @@ -407,15 +410,15 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +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 | 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 specified (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: @@ -428,12 +431,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **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**| 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 specified | [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 @@ -451,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 @@ -475,11 +478,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +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: @@ -492,8 +495,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [optional] ### Return type @@ -511,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,14 +538,14 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -limit = 100 # int | Maximum number of records to be returned in a single list. (optional) (default to 100) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +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 +558,9 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **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] @@ -577,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 @@ -601,11 +604,11 @@ configuration = gate_api.Configuration( 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) +settle = 'usdt' # str | Settle currency +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: @@ -618,8 +621,8 @@ 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] + **settle** | **str**| Settle currency | + **limit** | **int**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -637,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 @@ -661,14 +664,14 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -_from = 1604561000 # int | Start timestamp. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +_from = 1604561000 # int | Start timestamp (optional) 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: @@ -681,9 +684,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **_from** | **int**| Start timestamp. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **_from** | **int**| Start timestamp | [optional] **interval** | **str**| | [optional] [default to '5m'] **limit** | **int**| | [optional] [default to 30] @@ -703,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 @@ -727,11 +730,11 @@ configuration = gate_api.Configuration( 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. -index = 'BTC_USDT' # str | Index name. +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: @@ -744,8 +747,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **index** | **str**| Index name. | + **settle** | **str**| Settle currency | + **index** | **str**| Index name | ### Return type @@ -763,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 -The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details +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,14 +792,14 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (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) -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: - # 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,11 +812,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [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] - **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 @@ -831,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 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,13 +860,13 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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,10 +879,10 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if 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 @@ -897,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 @@ -930,10 +933,10 @@ configuration = gate_api.Configuration( 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. +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: @@ -946,7 +949,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | ### Return type @@ -964,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 passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. +If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. ### Example @@ -999,16 +1002,16 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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) -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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction (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,13 +1024,13 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if 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] **_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**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: 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] ### Return type @@ -1045,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 @@ -1078,13 +1081,13 @@ configuration = gate_api.Configuration( 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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +settle = 'usdt' # str | Settle currency +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: @@ -1097,10 +1100,10 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **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 @@ -1118,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 @@ -1151,11 +1154,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +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: @@ -1168,8 +1171,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -1187,14 +1190,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_position_margin** > Position update_position_margin(settle, contract, change) -Update position margin. +Update position margin ### Example @@ -1220,12 +1223,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -change = '0.01' # str | Margin change amount, positive number increases, negative number. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +change = '0.01' # str | Margin change amount, positive number increases, negative number decreases try: - # Update position margin. + # Update position margin api_response = api_instance.update_position_margin(settle, contract, change) print(api_response) except GateApiException as ex: @@ -1238,9 +1241,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **change** | **str**| Margin change amount, positive number increases, negative number. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **change** | **str**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -1258,14 +1261,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_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. +Update position leverage ### Example @@ -1291,14 +1294,15 @@ configuration = gate_api.Configuration( 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. -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) +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) +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) + # Update position leverage + 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)) @@ -1310,10 +1314,11 @@ except ApiException as e: 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] + **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] + **pid** | **int**| Product ID | [optional] ### Return type @@ -1331,14 +1336,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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_position_cross_mode** > Position update_position_cross_mode(settle, futures_position_cross_mode) -Switch to the full position-by-store mode. +Switch Position Margin Mode ### Example @@ -1364,11 +1369,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency futures_position_cross_mode = gate_api.FuturesPositionCrossMode() # FuturesPositionCrossMode | try: - # Switch to the full position-by-store mode. + # Switch Position Margin Mode api_response = api_instance.update_position_cross_mode(settle, futures_position_cross_mode) print(api_response) except GateApiException as ex: @@ -1381,7 +1386,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_position_cross_mode** | [**FuturesPositionCrossMode**](FuturesPositionCrossMode.md)| | ### Return type @@ -1400,14 +1405,83 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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) -Update position risk limit. +Update position risk limit ### Example @@ -1433,12 +1507,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -risk_limit = '1000000' # str | New Risk Limit Value. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +risk_limit = '1000000' # str | New risk limit value try: - # Update position risk limit. + # Update position risk limit api_response = api_instance.update_position_risk_limit(settle, contract, risk_limit) print(api_response) except GateApiException as ex: @@ -1451,9 +1525,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **risk_limit** | **str**| New Risk Limit Value. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **risk_limit** | **str**| New risk limit value | ### Return type @@ -1471,16 +1545,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**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) # **set_dual_mode** > FuturesAccount set_dual_mode(settle, dual_mode) -Enable or disable dual mode. +Set position mode -The prerequisite for changing mode is that all positions have no holdings. +The prerequisite for changing mode is that all positions have no holdings and no pending orders ### Example @@ -1506,11 +1580,11 @@ configuration = gate_api.Configuration( 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. -dual_mode = true # bool | Whether to enable dual mode. +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: @@ -1523,8 +1597,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **dual_mode** | **bool**| Whether to enable dual mode. | + **settle** | **str**| Settle currency | + **dual_mode** | **bool**| Whether to enable dual mode | ### Return type @@ -1542,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 @@ -1575,11 +1649,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +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: @@ -1592,8 +1666,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | ### Return type @@ -1611,14 +1685,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) # **update_dual_mode_position_margin** > list[Position] update_dual_mode_position_margin(settle, contract, change, dual_side) -Update position margin in dual mode. +Update position margin in dual mode ### Example @@ -1644,13 +1718,13 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -change = '0.01' # str | Margin change amount, positive number increases, negative number. -dual_side = 'dual_long' # str | Long or short position. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +change = '0.01' # str | Margin change amount, positive number increases, negative number decreases +dual_side = 'dual_long' # str | Long or short position try: - # Update position margin in dual mode. + # Update position margin in dual mode api_response = api_instance.update_dual_mode_position_margin(settle, contract, change, dual_side) print(api_response) except GateApiException as ex: @@ -1663,10 +1737,10 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **change** | **str**| Margin change amount, positive number increases, negative number. | - **dual_side** | **str**| Long or short position. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **change** | **str**| Margin change amount, positive number increases, negative number decreases | + **dual_side** | **str**| Long or short position | ### Return type @@ -1684,14 +1758,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) # **update_dual_mode_position_leverage** > list[Position] update_dual_mode_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit) -Update position leverage in dual mode. +Update position leverage in dual mode ### Example @@ -1717,13 +1791,13 @@ configuration = gate_api.Configuration( 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. -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) +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) try: - # Update position leverage in dual mode. + # Update position leverage in dual mode api_response = api_instance.update_dual_mode_position_leverage(settle, contract, leverage, cross_leverage_limit=cross_leverage_limit) print(api_response) except GateApiException as ex: @@ -1736,10 +1810,10 @@ except ApiException as e: 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] + **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] ### Return type @@ -1757,14 +1831,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) # **update_dual_mode_position_risk_limit** > list[Position] update_dual_mode_position_risk_limit(settle, contract, risk_limit) -Update position risk limit in dual mode. +Update position risk limit in dual mode ### Example @@ -1790,12 +1864,12 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. -risk_limit = '1000000' # str | New Risk Limit Value. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract +risk_limit = '1000000' # str | New risk limit value try: - # Update position risk limit in dual mode. + # Update position risk limit in dual mode api_response = api_instance.update_dual_mode_position_risk_limit(settle, contract, risk_limit) print(api_response) except GateApiException as ex: @@ -1808,9 +1882,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | - **risk_limit** | **str**| New Risk Limit Value. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | + **risk_limit** | **str**| New risk limit value | ### Return type @@ -1828,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`. @@ -1863,15 +1937,15 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) -last_id = '12345' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) +settle = 'usdt' # str | Settle currency +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 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 | 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: @@ -1884,12 +1958,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **status** | **str**| Only list the orders with this 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] - **last_id** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] + **settle** | **str**| Settle currency | + **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 returned in a single list | [optional] [default to 100] + **offset** | **int**| List offset, starting from 0 | [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] ### Return type @@ -1907,14 +1981,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_futures_order** > FuturesOrder create_futures_order(settle, futures_order, x_gate_exptime=x_gate_exptime) -Create a futures order. +Place futures order - 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` @@ -1942,12 +2016,12 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency futures_order = gate_api.FuturesOrder() # FuturesOrder | 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: @@ -1960,7 +2034,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_order** | [**FuturesOrder**](FuturesOrder.md)| | **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] @@ -1980,16 +2054,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details. | - | +**201** | 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_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 @@ -2015,14 +2089,16 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract. +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract 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, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (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)) @@ -2034,10 +2110,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract. | + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract | **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, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders | [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 @@ -2055,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 @@ -2088,15 +2166,15 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (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) -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) +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: @@ -2109,12 +2187,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [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] - **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] + **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 @@ -2132,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 @@ -2167,12 +2245,12 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency futures_order = [gate_api.FuturesOrder()] # list[FuturesOrder] | 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: @@ -2185,7 +2263,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_order** | [**list[FuturesOrder]**](FuturesOrder.md)| | **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] @@ -2205,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. @@ -2240,11 +2318,11 @@ configuration = gate_api.Configuration( 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. +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. 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: @@ -2257,7 +2335,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | ### Return type @@ -2276,14 +2354,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | 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) # **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 @@ -2309,13 +2387,13 @@ configuration = gate_api.Configuration( 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. +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. 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' # 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: @@ -2328,7 +2406,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **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. 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** | **str**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional] @@ -2349,14 +2427,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | 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_futures_order** > FuturesOrder cancel_futures_order(settle, order_id, x_gate_exptime=x_gate_exptime) -Cancel a single order. +Cancel single order ### Example @@ -2382,12 +2460,12 @@ configuration = gate_api.Configuration( 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. +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. 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: @@ -2400,7 +2478,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **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. 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] @@ -2420,14 +2498,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | 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) # **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`. @@ -2455,15 +2533,15 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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: @@ -2476,11 +2554,11 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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 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] ### Return type @@ -2499,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 @@ -2532,16 +2610,16 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (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) -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) -role = 'maker' # str | Query role, maker or taker. (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) 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: @@ -2554,13 +2632,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [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] - **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] - **role** | **str**| Query role, maker or taker. | [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] ### Return type @@ -2578,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 @@ -2611,17 +2689,17 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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) -side = 'short' # str | Query side. long or shot. (optional) -pnl = 'profit' # str | Query profit or loss. (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: @@ -2634,14 +2712,14 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if 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] **_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] + **side** | **str**| Query side. long or shot | [optional] + **pnl** | **str**| Query profit or loss | [optional] ### Return type @@ -2659,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 @@ -2692,14 +2770,17 @@ configuration = gate_api.Configuration( 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. -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) +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 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)) @@ -2711,10 +2792,13 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if 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] + **_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 @@ -2732,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 @@ -2765,14 +2849,17 @@ configuration = gate_api.Configuration( 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. -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) +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 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)) @@ -2784,10 +2871,13 @@ except ApiException as e: 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] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if 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] + **_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 @@ -2805,14 +2895,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) # **countdown_cancel_all_futures** > TriggerTime countdown_cancel_all_futures(settle, countdown_cancel_all_futures_task) -Countdown cancel orders. +Countdown cancel orders 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. @@ -2840,11 +2930,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency countdown_cancel_all_futures_task = gate_api.CountdownCancelAllFuturesTask() # CountdownCancelAllFuturesTask | try: - # Countdown cancel orders. + # Countdown cancel orders api_response = api_instance.countdown_cancel_all_futures(settle, countdown_cancel_all_futures_task) print(api_response) except GateApiException as ex: @@ -2857,7 +2947,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **countdown_cancel_all_futures_task** | [**CountdownCancelAllFuturesTask**](CountdownCancelAllFuturesTask.md)| | ### Return type @@ -2876,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 @@ -2909,11 +2999,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +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: @@ -2926,8 +3016,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [optional] ### Return type @@ -2945,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 different order IDs can be specified. A maximum of 20 records. +Multiple different order IDs can be specified, maximum 20 records per request ### Example @@ -2980,12 +3070,12 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency request_body = ['request_body_example'] # list[str] | 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: @@ -2998,7 +3088,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **request_body** | [**list[str]**](str.md)| | **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] @@ -3018,16 +3108,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancellation operation completed. | - | +**200** | Order cancellation operation 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) # **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 -Multiple different order IDs can be specified. A maximum of 10 orders can. +Multiple different order IDs can be specified, maximum 10 orders per request ### Example @@ -3053,12 +3143,12 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency batch_amend_order_req = [gate_api.BatchAmendOrderReq()] # list[BatchAmendOrderReq] | 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: @@ -3071,7 +3161,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **batch_amend_order_req** | [**list[BatchAmendOrderReq]**](BatchAmendOrderReq.md)| | **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] @@ -3091,16 +3181,16 @@ 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. +Query risk limit table by table_id -Just pass table_id. +Just pass table_id ### Example @@ -3117,11 +3207,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +table_id = 'CYBER_USDT_20241122' # str | Risk limit table ID try: - # Query risk limit table by table_id. + # 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: @@ -3134,8 +3224,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **table_id** | **str**| Risk limit table ID. | + **settle** | **str**| Settle currency | + **table_id** | **str**| Risk limit table ID | ### Return type @@ -3153,14 +3243,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_orders** > list[FuturesPriceTriggeredOrder] list_price_triggered_orders(settle, status, contract=contract, limit=limit, offset=offset) -List All Price-triggered Orders. +Query auto order list ### Example @@ -3186,14 +3276,14 @@ configuration = gate_api.Configuration( 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +settle = 'usdt' # str | Settle currency +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 returned in a single list (optional) (default to 100) +offset = 0 # int | List offset, starting from 0 (optional) (default to 0) try: - # List All Price-triggered 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: @@ -3206,11 +3296,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **status** | **str**| Only list the orders with this 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **str**| Settle currency | + **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 returned in a single list | [optional] [default to 100] + **offset** | **int**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -3228,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 @@ -3261,11 +3351,11 @@ configuration = gate_api.Configuration( 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. +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: @@ -3278,7 +3368,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | + **settle** | **str**| Settle currency | **futures_price_triggered_order** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -3297,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 Price-triggered Orders. +Cancel all auto orders ### Example @@ -3330,11 +3420,11 @@ configuration = gate_api.Configuration( 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. -contract = 'BTC_USDT' # str | Futures contract, return related data only if specified. (optional) +settle = 'usdt' # str | Settle currency +contract = 'BTC_USDT' # str | Futures contract, return related data only if specified (optional) try: - # Cancel All Price-triggered Orders. + # Cancel all auto orders api_response = api_instance.cancel_price_triggered_order_list(settle, contract=contract) print(api_response) except GateApiException as ex: @@ -3347,8 +3437,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **str**| Settle currency. | - **contract** | **str**| Futures contract, return related data only if specified. | [optional] + **settle** | **str**| Settle currency | + **contract** | **str**| Futures contract, return related data only if specified | [optional] ### Return type @@ -3366,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 @@ -3399,11 +3489,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -3416,8 +3506,8 @@ 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. | + **settle** | **str**| Settle currency | + **order_id** | **str**| ID returned when order is successfully created | ### Return type @@ -3435,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 @@ -3468,11 +3558,11 @@ configuration = gate_api.Configuration( 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. +settle = 'usdt' # str | Settle currency +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: @@ -3485,8 +3575,8 @@ 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. | + **settle** | **str**| Settle currency | + **order_id** | **str**| ID returned when order is successfully created | ### Return type @@ -3504,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 50b659f..1f2d674 100644 --- a/docs/FuturesAutoDeleverage.md +++ b/docs/FuturesAutoDeleverage.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **int** | Automatic deleveraging time. | [optional] [readonly] -**user** | **int** | User ID. | [optional] [readonly] -**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] -**entry_price** | **str** | Average entry price. | [optional] [readonly] -**fill_price** | **str** | Average fill price. | [optional] [readonly] -**trade_size** | **int** | Trading size. | [optional] [readonly] -**position_size** | **int** | Positions after auto-deleveraging. | [optional] [readonly] +**time** | **int** | Automatic deleveraging time | [optional] [readonly] +**user** | **int** | User ID | [optional] [readonly] +**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] +**entry_price** | **str** | Average entry price | [optional] [readonly] +**fill_price** | **str** | Average fill price | [optional] [readonly] +**trade_size** | **int** | Trading size | [optional] [readonly] +**position_size** | **int** | Positions after auto-deleveraging | [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/FuturesBatchAmendOrderRequest.md b/docs/FuturesBatchAmendOrderRequest.md index 0507bb0..b8a8467 100644 --- a/docs/FuturesBatchAmendOrderRequest.md +++ b/docs/FuturesBatchAmendOrderRequest.md @@ -1,14 +1,14 @@ # FuturesBatchAmendOrderRequest -Modify contract order parameters. +Modify contract order parameters ## Properties 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, 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] +**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** | 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/FuturesCandlestick.md b/docs/FuturesCandlestick.md index 974b990..202685d 100644 --- a/docs/FuturesCandlestick.md +++ b/docs/FuturesCandlestick.md @@ -1,16 +1,16 @@ # FuturesCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **float** | Unix timestamp in seconds. | [optional] -**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **str** | Close price (quote currency). | [optional] -**h** | **str** | Highest price (quote currency). | [optional] -**l** | **str** | Lowest price (quote currency). | [optional] -**o** | **str** | Open price (quote currency). | [optional] -**sum** | **str** | Trading volume (unit: Quote currency). | [optional] +**t** | **float** | Unix timestamp in seconds | [optional] +**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **str** | Close price (quote currency) | [optional] +**h** | **str** | Highest price (quote currency) | [optional] +**l** | **str** | Lowest price (quote currency) | [optional] +**o** | **str** | Open price (quote currency) | [optional] +**sum** | **str** | Trading volume (unit: 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/FuturesFee.md b/docs/FuturesFee.md index aeb73a3..5b3c0df 100644 --- a/docs/FuturesFee.md +++ b/docs/FuturesFee.md @@ -1,11 +1,11 @@ # FuturesFee -The returned result is a map type, where the key represents the market and 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 ------------ | ------------- | ------------- | ------------- -**taker_fee** | **str** | Taker fee. | [optional] [readonly] -**maker_fee** | **str** | maker fee. | [optional] [readonly] +**taker_fee** | **str** | Taker fee | [optional] [readonly] +**maker_fee** | **str** | maker fee | [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/FuturesIndexConstituents.md b/docs/FuturesIndexConstituents.md index 9bb2f84..7564bbe 100644 --- a/docs/FuturesIndexConstituents.md +++ b/docs/FuturesIndexConstituents.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**index** | **str** | Index name. | [optional] [readonly] -**constituents** | [**list[IndexConstituent]**](IndexConstituent.md) | Constituents. | [optional] [readonly] +**index** | **str** | Index name | [optional] [readonly] +**constituents** | [**list[IndexConstituent]**](IndexConstituent.md) | Constituents | [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/FuturesInitialOrder.md b/docs/FuturesInitialOrder.md index 3bc08fc..6c6dd28 100644 --- a/docs/FuturesInitialOrder.md +++ b/docs/FuturesInitialOrder.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **str** | Futures contract. | +**contract** | **str** | Futures contract | **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. | +**price** | **str** | Order price. Set to 0 to use market price | **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 order currently only supports ioc mode mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] [default to 'gtc'] -**text** | **str** | The source of the order, including: - web: web - api: api - app: app | [optional] +**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** | Do not set auto_size When the dual-position mode is closed all positions (size=0), auto_size, close_long, close_short, short When the double-storey mode partially closes the position (size ≠ 0), there is no need to set auto_size | [optional] -**is_reduce_only** | **bool** | Is the order reduce-only. | [optional] [readonly] -**is_close** | **bool** | Is the order to close position. | [optional] [readonly] +**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] [[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/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md index caeec4f..704f833 100644 --- a/docs/FuturesLimitRiskTiers.md +++ b/docs/FuturesLimitRiskTiers.md @@ -1,16 +1,16 @@ # 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 ------------ | ------------- | ------------- | ------------- -**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] -**contract** | **str** | Markets, visible only during market pagination requests. | [optional] -**deduction** | **str** | Maintenance margin quick calculation deduction. | [optional] +**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] +**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 950f29b..daf3c5e 100644 --- a/docs/FuturesLiqOrder.md +++ b/docs/FuturesLiqOrder.md @@ -3,13 +3,13 @@ ## Properties 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] +**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] [[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/FuturesLiquidate.md b/docs/FuturesLiquidate.md index d6a7f7d..78b62b2 100644 --- a/docs/FuturesLiquidate.md +++ b/docs/FuturesLiquidate.md @@ -3,18 +3,18 @@ ## Properties 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] -**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] -**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] +**time** | **int** | Liquidation time | [optional] [readonly] +**contract** | **str** | Futures contract | [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] +**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] [[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/FuturesOrder.md b/docs/FuturesOrder.md index c8c7294..1d0de6a 100644 --- a/docs/FuturesOrder.md +++ b/docs/FuturesOrder.md @@ -1,35 +1,38 @@ # FuturesOrder -Futures order details. +Futures order details ## Properties 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] -**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 - 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] -**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] -**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] +**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 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** | 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** | Order custom information, users can use this field to set a custom ID, and the user-defined field must meet the following conditions: 1. Must start with `t-` 2. If `t-` is not calculated, the length cannot exceed 28 bytes 3. The input content can only contain numbers, letters, underscores (_), midscores (-) or dots (.) In addition to user-defined information, the following are internal reserved fields that identifies the source of the order: - web: web page - api: API call - app: mobile terminal - auto_deleveraging: Automatic position reduction - liquidation: Liquidation under the classic account’s old liquidation mode - liq-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: insurance | [optional] -**tkfr** | **str** | Taker fee. | [optional] [readonly] -**mkfr** | **str** | Maker fee. | [optional] [readonly] -**refu** | **int** | Reference user ID. | [optional] [readonly] +**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** | 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, 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] +**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] +**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 cb338e2..4e3bce2 100644 --- a/docs/FuturesOrderAmendment.md +++ b/docs/FuturesOrderAmendment.md @@ -4,8 +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] +**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 400b6d3..392c531 100644 --- a/docs/FuturesOrderBook.md +++ b/docs/FuturesOrderBook.md @@ -4,10 +4,10 @@ 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. | +**current** | **float** | Response data generation timestamp | [optional] +**update** | **float** | Order book changed timestamp | [optional] +**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/FuturesOrderBookItem.md b/docs/FuturesOrderBookItem.md index 40ed9e4..9f3356e 100644 --- a/docs/FuturesOrderBookItem.md +++ b/docs/FuturesOrderBookItem.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**p** | **str** | Price (quote currency). | [optional] -**s** | **int** | Size. | [optional] +**p** | **str** | Price (quote currency) | [optional] +**s** | **int** | Size | [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/FuturesPositionCrossMode.md b/docs/FuturesPositionCrossMode.md index 4496195..65b0f1d 100644 --- a/docs/FuturesPositionCrossMode.md +++ b/docs/FuturesPositionCrossMode.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **str** | Full position-by-position model, ISOLATED-by-position, CROSS-full position. | -**contract** | **str** | Contract Market. | +**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 6adb80f..91041ef 100644 --- a/docs/FuturesPremiumIndex.md +++ b/docs/FuturesPremiumIndex.md @@ -1,14 +1,14 @@ # FuturesPremiumIndex -data point in every timestamp. +data point in every timestamp ## Properties 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] -**o** | **str** | Open price. | [optional] +**t** | **float** | Unix timestamp in seconds | [optional] +**c** | **str** | Close price | [optional] +**h** | **str** | Highest 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 7fd21de..5fd4eeb 100644 --- a/docs/FuturesPriceTrigger.md +++ b/docs/FuturesPriceTrigger.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**strategy_type** | **int** | Trigger Policy - 0: Price trigger, that is, when the price meets the conditions - 1: Price spread trigger, i.e. the last price specified in `price_type` minus the second-last price difference At present, only 0 is the latest transaction price | [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** | Price Condition Type - 1: Indicates that the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price` Trigger, while Trigger.Price must > last_price - based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_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 e210f9d..d28e980 100644 --- a/docs/FuturesPriceTriggeredOrder.md +++ b/docs/FuturesPriceTriggeredOrder.md @@ -1,21 +1,21 @@ # FuturesPriceTriggeredOrder -Futures order details. +Futures price-triggered order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **initial** | [**FuturesInitialOrder**](FuturesInitialOrder.md) | | **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 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** | Types of stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: loss, short position - `close-long-position`: Position stop-profit stop loss, used to close long positions - `close-short-position`: Position stop-profit stop loss, used to close all short positions - `plan-close-long-position`: Position plan take profit and stop loss, used to close long positions in all or part of long positions - `plan-close-short-position`: Position plan stop-profit and stop loss, used to close all short positions or partially close short positions The two types of entrusted order stop-profit and stop-loss are read-only and cannot be passed in through requests | [optional] -**me_order_id** | **int** | Corresponding order ID of order take-profit/stop-loss. | [optional] [readonly] +**id** | **int** | Auto order ID | [optional] [readonly] +**user** | **int** | User ID | [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 index cdae523..10b759a 100644 --- a/docs/FuturesRiskLimitTier.md +++ b/docs/FuturesRiskLimitTier.md @@ -1,15 +1,15 @@ # FuturesRiskLimitTier -Information for each tier of the risk limit ladder. +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. | [optional] +**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 9cd349b..d0f8511 100644 --- a/docs/FuturesTicker.md +++ b/docs/FuturesTicker.md @@ -3,27 +3,32 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **str** | Futures contract. | [optional] -**last** | **str** | Last trading price. | [optional] -**change_percentage** | **str** | Change percentage. | [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] -**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] +**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] -**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] +**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 6b6970a..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] -**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. an internal trade, this field will not be returned. | [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** | 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/IndexConstituent.md b/docs/IndexConstituent.md index 1caf740..a80703f 100644 --- a/docs/IndexConstituent.md +++ b/docs/IndexConstituent.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exchange** | **str** | Exchange. | [optional] -**symbols** | **list[str]** | Symbol list. | [optional] +**exchange** | **str** | Exchange | [optional] +**symbols** | **list[str]** | Symbol 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/InlineObject.md b/docs/InlineObject.md new file mode 100644 index 0000000..dccf5f1 --- /dev/null +++ b/docs/InlineObject.md @@ -0,0 +1,11 @@ +# InlineObject + +## 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/InlineResponse2001.md b/docs/InlineResponse2001.md index 67b01b4..31a5f58 100644 --- a/docs/InlineResponse2001.md +++ b/docs/InlineResponse2001.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **str** | | [optional] -**est_rate** | **str** | Unconverted percentage. | [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/InsuranceRecord.md b/docs/InsuranceRecord.md index 3527179..cc34afc 100644 --- a/docs/InsuranceRecord.md +++ b/docs/InsuranceRecord.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **int** | Unix timestamp in seconds. | [optional] -**b** | **str** | Insurance balance. | [optional] +**t** | **int** | Unix timestamp in seconds | [optional] +**b** | **str** | Insurance balance | [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 8c6c629..869f179 100644 --- a/docs/LedgerRecord.md +++ b/docs/LedgerRecord.md @@ -3,18 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Record ID. | [optional] [readonly] -**txid** | **str** | Hash record of the withdrawal. | [optional] [readonly] -**withdraw_order_id** | **str** | User-defined order number when withdrawing. 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. | -**currency** | **str** | Currency name. | -**address** | **str** | Withdrawal address. Required for withdrawals. | [optional] -**memo** | **str** | Additional remarks with regards to the withdrawal. | [optional] -**withdraw_id** | **str** | The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time | [optional] -**asset_class** | **str** | The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone | [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 - REVIEW: Under review | [optional] [readonly] -**chain** | **str** | Name of the chain used in withdrawals. | +**id** | **str** | Record ID | [optional] [readonly] +**txid** | **str** | Hash record of the withdrawal | [optional] [readonly] +**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** | Token amount | +**currency** | **str** | Currency name | +**address** | **str** | Withdrawal address. Required for withdrawals | [optional] +**memo** | **str** | Additional remarks with regards to the withdrawal | [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** | 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 34893a0..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] -**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] +**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 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/MarginAccount.md b/docs/MarginAccount.md index f35da74..265656e 100644 --- a/docs/MarginAccount.md +++ b/docs/MarginAccount.md @@ -1,14 +1,14 @@ # 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] -**account_type** | **str** | Account type, risk - risk rate account, mmr - maintenance margin market not activated | [optional] -**leverage** | **str** | User current market leverage multiple. | [optional] -**locked** | **bool** | Whether account is locked. | [optional] -**risk** | **str** | Leveraged Account Current Risk Rate (Returned when the Account is a Risk Rate Account) | [optional] +**currency_pair** | **str** | Currency pair | [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 afc8922..f5f8c61 100644 --- a/docs/MarginAccountBook.md +++ b/docs/MarginAccountBook.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Balance change record ID. | [optional] -**time** | **str** | Balance changed 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] -**change** | **str** | Amount changed. Positive value means transferring in, while negative out. | [optional] -**balance** | **str** | Balance after change. | [optional] +**id** | **str** | Balance change record ID | [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 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] [[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 c821455..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] +**currency** | **str** | Currency name | [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 2f92726..935da57 100644 --- a/docs/MarginApi.md +++ b/docs/MarginApi.md @@ -4,24 +4,24 @@ 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_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. -[**get_user_margin_tier**](MarginApi.md#get_user_margin_tier) | **GET** /margin/user/loan_margin_tiers | Check the user's own leverage lending gradient in the current market. -[**get_market_margin_tier**](MarginApi.md#get_market_margin_tier) | **GET** /margin/loan_margin_tiers | Query the current market leverage lending gradient. -[**set_user_market_leverage**](MarginApi.md#set_user_market_leverage) | **POST** /margin/leverage/user_market_setting | Set the user market leverage multiple. -[**list_margin_user_account**](MarginApi.md#list_margin_user_account) | **GET** /margin/user/account | Query the user's leverage account list. -[**list_cross_margin_loans**](MarginApi.md#list_cross_margin_loans) | **GET** /margin/cross/loans | List 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**](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 | 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 | 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** > list[MarginAccount] list_margin_accounts(currency_pair=currency_pair) -Margin account list. +Margin account list ### Example @@ -47,10 +47,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) -currency_pair = 'BTC_USDT' # str | Currency pair. (optional) +currency_pair = 'BTC_USDT' # str | Currency pair (optional) try: - # Margin account list. + # Margin account list api_response = api_instance.list_margin_accounts(currency_pair=currency_pair) print(api_response) except GateApiException as ex: @@ -63,7 +63,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | [optional] + **currency_pair** | **str**| Currency pair | [optional] ### Return type @@ -81,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 @@ -116,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) -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) +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 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: @@ -138,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] - **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] + **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 returned in a single list | [optional] [default to 100] ### Return type @@ -162,14 +162,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_funding_accounts** > list[FundingAccount] list_funding_accounts(currency=currency) -Funding account list. +Funding account list ### Example @@ -195,10 +195,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) -currency = 'BTC' # str | Retrieve data of the specified currency. (optional) +currency = 'BTC' # str | Query by specified currency name (optional) try: - # Funding account list. + # Funding account list api_response = api_instance.list_funding_accounts(currency=currency) print(api_response) except GateApiException as ex: @@ -211,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 @@ -229,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 @@ -264,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: @@ -292,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 @@ -325,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: @@ -341,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 @@ -359,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 @@ -392,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_pair = 'BTC_USDT' # str | Currency pair. (optional) +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: @@ -409,8 +409,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Retrieve data of the specified currency. | - **currency_pair** | **str**| Currency pair. | [optional] + **currency** | **str**| Query by specified currency name | + **currency_pair** | **str**| Currency pair | [optional] ### Return type @@ -428,14 +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) # **get_user_margin_tier** > list[MarginLeverageTier] get_user_margin_tier(currency_pair) -Check the user's own leverage lending gradient in the current market. +Query user's own leverage lending tiers in current market ### Example @@ -461,10 +461,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) -currency_pair = 'BTC_USDT' # str | Currency pair. +currency_pair = 'BTC_USDT' # str | Currency pair try: - # Check the user's own leverage lending gradient in the current market. + # 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: @@ -477,7 +477,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | + **currency_pair** | **str**| Currency pair | ### Return type @@ -495,14 +495,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_market_margin_tier** > list[MarginLeverageTier] get_market_margin_tier(currency_pair) -Query the current market leverage lending gradient. +Query current market leverage lending tiers ### Example @@ -519,10 +519,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) -currency_pair = 'BTC_USDT' # str | Currency pair. +currency_pair = 'BTC_USDT' # str | Currency pair try: - # Query the current market leverage lending gradient. + # Query current market leverage lending tiers api_response = api_instance.get_market_margin_tier(currency_pair) print(api_response) except GateApiException as ex: @@ -535,7 +535,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | + **currency_pair** | **str**| Currency pair | ### Return type @@ -553,14 +553,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) # **set_user_market_leverage** > set_user_market_leverage(margin_market_leverage) -Set the user market leverage multiple. +Set user market leverage multiplier ### Example @@ -589,7 +589,7 @@ api_instance = gate_api.MarginApi(api_client) margin_market_leverage = gate_api.MarginMarketLeverage() # MarginMarketLeverage | try: - # Set the user market leverage multiple. + # 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)) @@ -619,16 +619,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) # **list_margin_user_account** > list[MarginAccount] list_margin_user_account(currency_pair=currency_pair) -Query the user's leverage account list. +Query user's isolated margin account list -Support querying risk rate per position account and margin rate per position account +Supports querying risk ratio isolated accounts and margin ratio isolated accounts ### Example @@ -654,10 +654,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) -currency_pair = 'BTC_USDT' # str | Currency pair. (optional) +currency_pair = 'BTC_USDT' # str | Currency pair (optional) try: - # Query the user's leverage account list. + # 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: @@ -670,7 +670,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | [optional] + **currency_pair** | **str**| Currency pair | [optional] ### Return type @@ -688,16 +688,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_cross_margin_loans** > list[CrossMarginLoan] list_cross_margin_loans(status, currency=currency, limit=limit, offset=offset, reverse=reverse) -List cross margin borrow history. (deprecated). +Query cross margin borrow history (deprecated) -Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. +Sorted by creation time in descending order by default. Set `reverse=false` for ascending order ### Example @@ -723,14 +723,14 @@ 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 = 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) +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: - # List cross margin borrow history. (deprecated). + # 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: @@ -743,10 +743,10 @@ except ApiException as e: 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] + **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 @@ -765,16 +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) # **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). +Retrieve cross margin repayments. (deprecated) -Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. +Sorted by creation time in descending order by default. Set `reverse=false` for ascending order ### Example @@ -802,12 +802,12 @@ api_client = gate_api.ApiClient(configuration) 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) +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: - # Retrieve cross margin repayments. (deprecated). + # 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: @@ -822,8 +822,8 @@ 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] + **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 @@ -842,7 +842,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) diff --git a/docs/MarginLeverageTier.md b/docs/MarginLeverageTier.md index c2fa771..0a36030 100644 --- a/docs/MarginLeverageTier.md +++ b/docs/MarginLeverageTier.md @@ -1,12 +1,12 @@ # MarginLeverageTier -Market gradient information. +Market gradient information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**upper_limit** | **str** | Maximum loan limit. | [optional] -**mmr** | **str** | Maintenance margin rate. | [optional] -**leverage** | **str** | Maximum leverage multiple. | [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 index d4f0707..63ce686 100644 --- a/docs/MarginMarketLeverage.md +++ b/docs/MarginMarketLeverage.md @@ -1,11 +1,11 @@ # MarginMarketLeverage -Market leverage settings. +Market leverage settings ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Currency pair. | [optional] -**leverage** | **str** | Position leverage. | +**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/MarginTiers.md b/docs/MarginTiers.md index 7a07dd4..455092c 100644 --- a/docs/MarginTiers.md +++ b/docs/MarginTiers.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tier** | **str** | Tier. | [optional] -**margin_rate** | **str** | Discount. | [optional] -**lower_limit** | **str** | Lower limit. | [optional] -**upper_limit** | **str** | Upper limit, \"\" indicates greater than (the last tier). | [optional] -**leverage** | **str** | Position leverage. | [optional] +**tier** | **str** | Tier | [optional] +**margin_rate** | **str** | Discount | [optional] +**lower_limit** | **str** | Lower limit | [optional] +**upper_limit** | **str** | Upper limit, \"\" indicates greater than (the last tier) | [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/MarginTransferable.md b/docs/MarginTransferable.md index 6a34651..af64207 100644 --- a/docs/MarginTransferable.md +++ b/docs/MarginTransferable.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**currency_pair** | **str** | Currency pair. | [optional] -**amount** | **str** | Max transferable amount. | [optional] +**currency** | **str** | Currency detail | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**amount** | **str** | Max 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/MarginUniApi.md b/docs/MarginUniApi.md index 98768b1..02afa4e 100644 --- a/docs/MarginUniApi.md +++ b/docs/MarginUniApi.md @@ -4,20 +4,20 @@ 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. -[**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_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 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 | 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** > list[UniCurrencyPair] list_uni_currency_pairs() -List lending markets. +List lending markets ### Example @@ -36,7 +36,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.MarginUniApi(api_client) try: - # List lending markets. + # List lending markets api_response = api_instance.list_uni_currency_pairs() print(api_response) except GateApiException as ex: @@ -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 @@ -88,10 +88,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) -currency_pair = 'AE_USDT' # str | Currency pair. +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: @@ -104,7 +104,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | + **currency_pair** | **str**| Currency pair | ### Return type @@ -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 @@ -224,13 +224,13 @@ 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_pair = 'BTC_USDT' # str | Currency pair. (optional) -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) +currency_pair = 'BTC_USDT' # str | Currency pair (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 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: @@ -243,10 +243,10 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | [optional] - **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] + **currency_pair** | **str**| Currency pair | [optional] + **currency** | **str**| Query by specified currency name | [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 @@ -264,14 +264,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) # **create_uni_loan** > create_uni_loan(create_uni_loan) -Borrow or repay. +Borrow or repay ### Example @@ -300,7 +300,7 @@ api_instance = gate_api.MarginUniApi(api_client) create_uni_loan = gate_api.CreateUniLoan() # CreateUniLoan | try: - # Borrow or repay. + # Borrow or repay api_instance.create_uni_loan(create_uni_loan) except GateApiException as ex: print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message)) @@ -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) -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) +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 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] - **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] + **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 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 @@ -438,15 +438,15 @@ 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_pair = 'BTC_USDT' # str | Currency pair. (optional) -currency = 'BTC' # str | Retrieve data of the specified 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) +currency_pair = 'BTC_USDT' # str | Currency pair (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 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: @@ -459,10 +459,10 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | [optional] - **currency** | **str**| Retrieve data of the specified 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] + **currency_pair** | **str**| Currency pair | [optional] + **currency** | **str**| Query by specified currency name | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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] @@ -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_pair = 'BTC_USDT' # str | Currency pair. +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,8 +532,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Retrieve data of the specified currency. | - **currency_pair** | **str**| Currency pair. | + **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/MaxUniBorrowable.md b/docs/MaxUniBorrowable.md index 99c0a5a..107dbab 100644 --- a/docs/MaxUniBorrowable.md +++ b/docs/MaxUniBorrowable.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [readonly] -**currency_pair** | **str** | Currency pair. | [optional] [readonly] -**borrowable** | **str** | Maximum borrowable. | [readonly] +**currency** | **str** | Currency | [readonly] +**currency_pair** | **str** | Currency pair | [optional] [readonly] +**borrowable** | **str** | Maximum borrowable | [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/MockFuturesOrder.md b/docs/MockFuturesOrder.md index b0ab054..0d03d06 100644 --- a/docs/MockFuturesOrder.md +++ b/docs/MockFuturesOrder.md @@ -1,12 +1,12 @@ # MockFuturesOrder -Futures order. +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. | -**left** | **str** | Unfilled contract quantity, involved in actual calculation. | +**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 9563213..f6eccc7 100644 --- a/docs/MockFuturesPosition.md +++ b/docs/MockFuturesPosition.md @@ -1,11 +1,11 @@ # MockFuturesPosition -Futures positions. +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 76b8d2a..0ea3b20 100644 --- a/docs/MockMarginResult.md +++ b/docs/MockMarginResult.md @@ -1,16 +1,16 @@ # MockMarginResult -Margin result. +Margin result ## Properties 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` position | [optional] -**profit_loss_ranges** | [**list[ProfitLossRange]**](ProfitLossRange.md) | The results of 3 pressure scenarios for MR1. | [optional] +**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) | Results of 33 stress scenarios for MR1 | [optional] **max_loss** | [**ProfitLossRange**](.md) | 最大损失 | [optional] -**mr1** | **str** | Stress testing. | [optional] -**mr2** | **str** | Basis spread risk. | [optional] -**mr3** | **str** | Volatility spread risk. | [optional] -**mr4** | **str** | Option short risk. | [optional] +**mr1** | **str** | Stress testing | [optional] +**mr2** | **str** | Basis spread risk | [optional] +**mr3** | **str** | Volatility spread risk | [optional] +**mr4** | **str** | Option short risk | [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/MockOptionsOrder.md b/docs/MockOptionsOrder.md index 819b975..054d3f4 100644 --- a/docs/MockOptionsOrder.md +++ b/docs/MockOptionsOrder.md @@ -1,12 +1,12 @@ # MockOptionsOrder -Option orders. +Option orders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**options_name** | **str** | Option name, currently only supports options for BTC and ETH with USDT. | -**size** | **str** | Initial order quantity, not involved in actual calculation. | -**left** | **str** | Unfilled contract quantity, involved in actual calculation. | +**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 | [[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/MockOptionsPosition.md b/docs/MockOptionsPosition.md index 61310f3..f7c0e53 100644 --- a/docs/MockOptionsPosition.md +++ b/docs/MockOptionsPosition.md @@ -1,11 +1,11 @@ # MockOptionsPosition -Options positions. +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 84e2a86..cf6f234 100644 --- a/docs/MockRiskUnit.md +++ b/docs/MockRiskUnit.md @@ -1,18 +1,18 @@ # MockRiskUnit -Risk unit. +Risk unit ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **str** | Risk unit name. | [optional] -**spot_in_use** | **str** | Spot usage. | [optional] -**maintain_margin** | **str** | Maintenance margin. | [optional] -**initial_margin** | **str** | Initial margin. | [optional] -**margin_result** | [**list[MockMarginResult]**](MockMarginResult.md) | Margin result. | [optional] -**delta** | **str** | Total Delta of risk unit. | [optional] -**gamma** | **str** | Total Gamma of risk unit. | [optional] -**theta** | **str** | Total Theta of risk unit. | [optional] -**vega** | **str** | Total Vega of risk unit. | [optional] +**symbol** | **str** | Risk unit name | [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] +**delta** | **str** | Total Delta of risk unit | [optional] +**gamma** | **str** | Total Gamma of risk unit | [optional] +**theta** | **str** | Total Theta of risk unit | [optional] +**vega** | **str** | Total Vega of 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/MockSpotBalance.md b/docs/MockSpotBalance.md index bf1f10a..54bb762 100644 --- a/docs/MockSpotBalance.md +++ b/docs/MockSpotBalance.md @@ -1,11 +1,11 @@ # MockSpotBalance -Spot. +Spot ## Properties 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. | +**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 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 5ce7657..3b3d340 100644 --- a/docs/MockSpotOrder.md +++ b/docs/MockSpotOrder.md @@ -1,14 +1,14 @@ # MockSpotOrder -Spot orders. +Spot orders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pairs** | **str** | Currency pair. | -**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. | +**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 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/MultiChainAddressItem.md b/docs/MultiChainAddressItem.md index d7d5f88..5309ff3 100644 --- a/docs/MultiChainAddressItem.md +++ b/docs/MultiChainAddressItem.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **str** | Name of the chain. | [optional] -**address** | **str** | Deposit address. | [optional] -**payment_id** | **str** | Notes that some currencies required(e.g., Tag, Memo) when depositing. | [optional] -**payment_name** | **str** | Note type, `Tag` or `Memo`. | [optional] +**chain** | **str** | Name of the chain | [optional] +**address** | **str** | Deposit address | [optional] +**payment_id** | **str** | Notes that some currencies required(e.g., Tag, Memo) when depositing | [optional] +**payment_name** | **str** | Note type, `Tag` or `Memo` | [optional] **obtain_failed** | **int** | The obtain failed status- 0: address successfully obtained- 1: failed to obtain 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/MultiCollateralCurrency.md b/docs/MultiCollateralCurrency.md index 68958c2..f309656 100644 --- a/docs/MultiCollateralCurrency.md +++ b/docs/MultiCollateralCurrency.md @@ -1,11 +1,11 @@ # MultiCollateralCurrency -Borrowing and collateral currencies supported for Multi-Collateral. +Borrowing and collateral currencies supported for Multi-Collateral ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loan_currencies** | [**list[MultiLoanItem]**](MultiLoanItem.md) | List of supported borrowing currencies. | [optional] -**collateral_currencies** | [**list[MultiCollateralItem]**](MultiCollateralItem.md) | List of supported collateral currencies. | [optional] +**loan_currencies** | [**list[MultiLoanItem]**](MultiLoanItem.md) | List of supported borrowing currencies | [optional] +**collateral_currencies** | [**list[MultiCollateralItem]**](MultiCollateralItem.md) | List of supported collateral currencies | [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/MultiCollateralItem.md b/docs/MultiCollateralItem.md index 57a7909..3e9ba07 100644 --- a/docs/MultiCollateralItem.md +++ b/docs/MultiCollateralItem.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**index_price** | **str** | Currency Index Price. | [optional] -**discount** | **str** | Discount. | [optional] +**currency** | **str** | Currency | [optional] +**index_price** | **str** | Currency Index Price | [optional] +**discount** | **str** | Discount | [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/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index abecee3..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_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. +[**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 | 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 @@ -47,13 +47,13 @@ configuration = gate_api.Configuration( 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 | Query the current interest rate of the currency in the previous hour. (optional) +page = 1 # int | Page number (optional) (default to 1) +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: @@ -66,9 +66,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**| Query the current interest rate of the currency in the previous hour. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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 @@ -254,15 +254,15 @@ 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 = '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) +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 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: @@ -275,12 +275,12 @@ except ApiException as e: 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] + **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 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,14 +365,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_multi_collateral_records** > list[MultiCollateralRecord] list_multi_collateral_records(page=page, limit=limit, _from=_from, to=to, collateral_currency=collateral_currency) -Query collateral adjustment records. +Query collateral adjustment records ### Example @@ -398,14 +398,14 @@ configuration = gate_api.Configuration( 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) +page = 1 # int | Page number (optional) (default to 1) +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. + # Query collateral adjustment records api_response = api_instance.list_multi_collateral_records(page=page, limit=limit, _from=_from, to=to, collateral_currency=collateral_currency) print(api_response) except GateApiException as ex: @@ -418,11 +418,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 10] - **_from** | **int**| Start timestamp of the query. | [optional] - **to** | **int**| Time range ending, default to current time. | [optional] - **collateral_currency** | **str**| Collateral. | [optional] + **page** | **int**| Page number | [optional] [default to 1] + **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 type: collateral - Collateral currency, borrow - Borrowing. -currency = 'BTC' # str | When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed +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 type: collateral - Collateral currency, borrow - Borrowing. | - **currency** | **str**| When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed | + **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 previous 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 currency name query array, separated by commas, maximum 100items. -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 currency name query array, separated by commas, maximum 100items. | - **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 8c4672c..3162049 100644 --- a/docs/MultiCollateralOrder.md +++ b/docs/MultiCollateralOrder.md @@ -1,23 +1,23 @@ # MultiCollateralOrder -Multi-Collateral Order. +Multi-Collateral Order ## Properties 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_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] +**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_rate** | **str** | Fixed interest 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] -**borrow_currencies** | [**list[BorrowCurrencyInfo]**](BorrowCurrencyInfo.md) | Borrowing Currency List. | [optional] -**collateral_currencies** | [**list[CollateralCurrencyInfo]**](CollateralCurrencyInfo.md) | Collateral Currency List. | [optional] +**borrow_time** | **int** | Borrowing time, timestamp in seconds | [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] [[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/MultiCollateralRecord.md b/docs/MultiCollateralRecord.md index 9a56b77..5f48cd6 100644 --- a/docs/MultiCollateralRecord.md +++ b/docs/MultiCollateralRecord.md @@ -1,16 +1,16 @@ # 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] -**borrow_currencies** | [**list[MultiCollateralRecordCurrency]**](MultiCollateralRecordCurrency.md) | Borrowing Currency List. | [optional] -**collateral_currencies** | [**list[MultiCollateralRecordCurrency]**](MultiCollateralRecordCurrency.md) | Collateral Currency List. | [optional] +**order_id** | **int** | Order ID | [optional] +**record_id** | **int** | Collateral record ID | [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] [[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/MultiCollateralRecordCurrency.md b/docs/MultiCollateralRecordCurrency.md index babf82e..9e3f5e1 100644 --- a/docs/MultiCollateralRecordCurrency.md +++ b/docs/MultiCollateralRecordCurrency.md @@ -3,12 +3,12 @@ ## Properties 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] +**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] [[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/MultiLoanItem.md b/docs/MultiLoanItem.md index 78e58e5..3c45fc2 100644 --- a/docs/MultiLoanItem.md +++ b/docs/MultiLoanItem.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**price** | **str** | Latest price of the currency. | [optional] +**currency** | **str** | Currency | [optional] +**price** | **str** | Latest price of the 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/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md index 97bdfd1..f381f48 100644 --- a/docs/MultiLoanRepayItem.md +++ b/docs/MultiLoanRepayItem.md @@ -3,9 +3,9 @@ ## Properties 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] +**currency** | **str** | Repayment currency | [optional] +**amount** | **str** | Size | [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 1c1e6b6..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] -**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_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] +**order_id** | **int** | Order ID | [optional] +**record_id** | **int** | Repayment record ID | [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_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 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 406a64a..2d7ebe0 100644 --- a/docs/MultiRepayResp.md +++ b/docs/MultiRepayResp.md @@ -1,11 +1,11 @@ # MultiRepayResp -Repay Multi-Collateral Loan. +Multi-currency collateral repayment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | [optional] -**repaid_currencies** | [**list[RepayCurrencyRes]**](RepayCurrencyRes.md) | Repay Currency List. | [optional] +**order_id** | **int** | Order ID | [optional] +**repaid_currencies** | [**list[RepayCurrencyRes]**](RepayCurrencyRes.md) | Repay 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/MyFuturesTrade.md b/docs/MyFuturesTrade.md index 3e4b2a7..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] -**contract** | **str** | Futures contract. | [optional] -**order_id** | **str** | Order ID related. | [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 > 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] +**id** | **int** | Fill ID | [optional] +**create_time** | **float** | Fill Time | [optional] +**contract** | **str** | Futures contract | [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 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 a4fdb38..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] -**contract** | **str** | Futures contract. | [optional] -**order_id** | **str** | Order ID related. | [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 > 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] +**trade_id** | **str** | Fill ID | [optional] +**create_time** | **float** | Fill Time | [optional] +**contract** | **str** | Futures contract | [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 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 985e3d6..ec395b5 100644 --- a/docs/OpenOrders.md +++ b/docs/OpenOrders.md @@ -3,8 +3,8 @@ ## Properties 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] +**currency_pair** | **str** | Currency pair | [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 6c830c2..d9a6eec 100644 --- a/docs/OptionsAccount.md +++ b/docs/OptionsAccount.md @@ -3,24 +3,24 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **int** | User ID. | [optional] -**total** | **str** | Account balance. | [optional] +**user** | **int** | User ID | [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** | Whether to enable MMP. | [optional] -**liq_triggered** | **bool** | Whether to trigger position liquidation. | [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** | 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** | 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** | Maximum number of outstanding orders. | [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** | 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 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 4e9ac46..8ae81ce 100644 --- a/docs/OptionsAccountBook.md +++ b/docs/OptionsAccountBook.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **float** | Change time. | [optional] -**change** | **str** | Amount changed (USDT). | [optional] -**balance** | **str** | Account total balance after change (USDT). | [optional] +**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_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] -**text** | **str** | custom text. | [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 543bd2a..de8bf8b 100644 --- a/docs/OptionsApi.md +++ b/docs/OptionsApi.md @@ -4,31 +4,31 @@ 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_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. -[**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. -[**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. +[**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 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 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 | 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 @@ -108,10 +108,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) -underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint). +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: @@ -124,7 +124,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | ### Return type @@ -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 @@ -166,11 +166,11 @@ configuration = gate_api.Configuration( 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) +underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint) +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: @@ -183,8 +183,8 @@ 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] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **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,14 +260,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_settlements** > list[OptionsSettlement] list_options_settlements(underlying, limit=limit, offset=offset, _from=_from, to=to) -List settlement history. +List settlement history ### Example @@ -284,14 +284,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) -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint) +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) try: - # List settlement history. + # List settlement history api_response = api_instance.list_options_settlements(underlying, limit=limit, offset=offset, _from=_from, to=to) print(api_response) except GateApiException as ex: @@ -304,9 +304,9 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **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] @@ -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 @@ -351,11 +351,11 @@ api_client = gate_api.ApiClient(configuration) # Create an instance of the API class api_instance = gate_api.OptionsApi(api_client) contract = 'BTC_USDT-20211130-65000-C' # str | -underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint). +underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint) 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: @@ -369,7 +369,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **str**| | - **underlying** | **str**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | **at** | **int**| | ### Return type @@ -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 @@ -421,15 +421,15 @@ configuration = gate_api.Configuration( 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). -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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) 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: @@ -442,10 +442,10 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **str**| Options contract name | [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 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] @@ -465,16 +465,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_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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -491,13 +491,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) -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 to return depth update ID. This ID increments by 1 each time. (optional) (default to False) +contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name +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: @@ -510,10 +510,10 @@ 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to False] + **contract** | **str**| Options contract name | + **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** | Depth query successful. | - | +**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 @@ -555,10 +555,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) -underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint). +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: @@ -571,7 +571,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | ### Return type @@ -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 @@ -613,10 +613,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) -underlying = 'BTC_USDT' # str | Underlying. +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: @@ -629,7 +629,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying. | + **underlying** | **str**| Underlying | ### Return type @@ -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 @@ -671,14 +671,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) -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) +contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name +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 | Interval time between data points. (optional) (default to '5m') +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: @@ -691,11 +691,11 @@ 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] + **contract** | **str**| Options contract name | + **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**| Interval time between data points. | [optional] [default to '5m'] + **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 @@ -737,14 +737,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) -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) +underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint) +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 | Interval time between data points. (optional) (default to '5m') +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: @@ -757,11 +757,11 @@ 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] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **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**| Interval time between data points. | [optional] [default to '5m'] + **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 @@ -803,15 +803,15 @@ configuration = gate_api.Configuration( 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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional) +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 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: @@ -824,10 +824,10 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **contract** | **str**| Options contract name | [optional] + **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 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] @@ -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) -offset = 0 # int | List offset, starting from 0. (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) -type = 'dnw' # str | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL (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] - **offset** | **int**| List offset, starting from 0. | [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] - **type** | **str**| Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL | [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,14 +985,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_positions** > list[OptionsPosition] list_options_positions(underlying=underlying) -List user's positions of specified underlying. +List user's positions of specified underlying ### Example @@ -1018,10 +1018,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) -underlying = 'BTC_USDT' # str | Underlying. (optional) +underlying = 'BTC_USDT' # str | Underlying (optional) try: - # List user's positions of specified underlying. + # List user's positions of specified underlying api_response = api_instance.list_options_positions(underlying=underlying) print(api_response) except GateApiException as ex: @@ -1034,7 +1034,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying. | [optional] + **underlying** | **str**| Underlying | [optional] ### Return type @@ -1052,14 +1052,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_position** > OptionsPosition get_options_position(contract) -Get specified contract position. +Get specified contract position ### Example @@ -1088,7 +1088,7 @@ api_instance = gate_api.OptionsApi(api_client) contract = 'BTC_USDT-20211130-65000-C' # str | try: - # Get specified contract position. + # Get specified contract position api_response = api_instance.get_options_position(contract) print(api_response) except GateApiException as ex: @@ -1119,14 +1119,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_options_position_close** > list[OptionsPositionClose] list_options_position_close(underlying, contract=contract) -List user's liquidation history of specified underlying. +List user's liquidation history of specified underlying ### Example @@ -1152,11 +1152,11 @@ configuration = gate_api.Configuration( 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). -contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name. (optional) +underlying = 'BTC_USDT' # str | Underlying (Obtained by listing underlying endpoint) +contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional) try: - # List user's liquidation history of specified underlying. + # List user's liquidation history of specified underlying api_response = api_instance.list_options_position_close(underlying, contract=contract) print(api_response) except GateApiException as ex: @@ -1169,8 +1169,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying (Obtained by listing underlying endpoint). | - **contract** | **str**| Options contract name. | [optional] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **str**| Options contract name | [optional] ### Return type @@ -1188,14 +1188,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_orders** > list[OptionsOrder] list_options_orders(status, contract=contract, underlying=underlying, limit=limit, offset=offset, _from=_from, to=to) -List options orders. +List options orders ### Example @@ -1221,16 +1221,16 @@ 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. -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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) try: - # List options orders. + # List options orders api_response = api_instance.list_options_orders(status, contract=contract, underlying=underlying, limit=limit, offset=offset, _from=_from, to=to) print(api_response) except GateApiException as ex: @@ -1243,11 +1243,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **str**| Only list the orders with this 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **status** | **str**| Query order list based on status | + **contract** | **str**| Options contract name | [optional] + **underlying** | **str**| Underlying | [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 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] @@ -1267,14 +1267,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_options_order** > OptionsOrder create_options_order(options_order) -Create an options order. +Create an options order ### Example @@ -1303,7 +1303,7 @@ api_instance = gate_api.OptionsApi(api_client) options_order = gate_api.OptionsOrder() # OptionsOrder | try: - # Create an options order. + # Create an options order api_response = api_instance.create_options_order(options_order) print(api_response) except GateApiException as ex: @@ -1334,14 +1334,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order detail. | - | +**201** | Order detail | - | [[Back to top]](#) [[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_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 @@ -1367,12 +1367,12 @@ configuration = gate_api.Configuration( 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) -underlying = 'BTC_USDT' # str | Underlying. (optional) -side = 'ask' # str | All bids or asks. Both included if not specified. (optional) +contract = 'BTC_USDT-20210916-5000-C' # str | Options contract name (optional) +underlying = 'BTC_USDT' # str | Underlying (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: @@ -1385,9 +1385,9 @@ except ApiException as e: 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] + **contract** | **str**| Options contract name | [optional] + **underlying** | **str**| Underlying | [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 @@ -1472,14 +1472,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail. | - | +**200** | Order detail | - | [[Back to top]](#) [[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_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 @@ -1539,14 +1539,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail. | - | +**200** | Order detail | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **countdown_cancel_all_options** > TriggerTime countdown_cancel_all_options(countdown_cancel_all_options_task) -Countdown cancel orders. +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, 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. @@ -1577,7 +1577,7 @@ api_instance = gate_api.OptionsApi(api_client) countdown_cancel_all_options_task = gate_api.CountdownCancelAllOptionsTask() # CountdownCancelAllOptionsTask | try: - # Countdown cancel orders. + # Countdown cancel orders api_response = api_instance.countdown_cancel_all_options(countdown_cancel_all_options_task) print(api_response) except GateApiException as ex: @@ -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 @@ -1641,15 +1641,15 @@ configuration = gate_api.Configuration( 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). -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 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) 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: @@ -1662,10 +1662,10 @@ except ApiException as e: 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **str**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **str**| Options contract name | [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 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] @@ -1685,7 +1685,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) @@ -1718,7 +1718,7 @@ configuration = gate_api.Configuration( 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. (optional) +underlying = 'BTC_USDT' # str | Underlying (optional) try: # MMP Query. @@ -1734,7 +1734,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **str**| Underlying. | [optional] + **underlying** | **str**| Underlying | [optional] ### Return type @@ -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) @@ -1819,7 +1819,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information. | - | +**200** | MMP 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) @@ -1886,7 +1886,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information. | - | +**200** | MMP 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) diff --git a/docs/OptionsCandlestick.md b/docs/OptionsCandlestick.md index 3b0d385..963ccda 100644 --- a/docs/OptionsCandlestick.md +++ b/docs/OptionsCandlestick.md @@ -1,15 +1,15 @@ # OptionsCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **float** | Unix timestamp in seconds. | [optional] -**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **str** | Close price (quote currency, unit: underlying corresponding option price). | [optional] +**t** | **float** | Unix timestamp in seconds | [optional] +**v** | **int** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **str** | Close price (quote currency, unit: underlying corresponding option price) | [optional] **h** | **str** | Highest price (quote currency, unit: underlying corresponding option price) | [optional] -**l** | **str** | Lowest price (quote currency, unit: underlying corresponding option price). | [optional] -**o** | **str** | Open price (quote currency, unit: underlying corresponding option price). | [optional] +**l** | **str** | Lowest price (quote currency, unit: underlying corresponding option price) | [optional] +**o** | **str** | Open price (quote currency, unit: underlying corresponding option 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/OptionsContract.md b/docs/OptionsContract.md index 42dcd06..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] -**expiration_time** | **float** | Expiration time. | [optional] -**is_call** | **bool** | `true` means call options, while `false` is 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] -**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 `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] -**trade_id** | **int** | Current trade ID. | [optional] -**trade_size** | **int** | Historical accumulated trade size. | [optional] -**position_size** | **int** | Current total long position size. | [optional] -**orders_limit** | **int** | Maximum number of open orders. | [optional] +**name** | **str** | Options contract name | [optional] +**tag** | **str** | Tag | [optional] +**create_time** | **float** | Created time | [optional] +**expiration_time** | **float** | Expiration time | [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, 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 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 cumulative trading volume | [optional] +**position_size** | **int** | Current total long position size | [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 0a24089..2e8b73f 100644 --- a/docs/OptionsMMP.md +++ b/docs/OptionsMMP.md @@ -4,13 +4,13 @@ MMP Settings ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **str** | Underlying. | -**window** | **int** | Time window (milliseconds), between 1-5000, 0 means disabling MMP. | +**underlying** | **str** | Underlying | +**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] +**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 4e26ae9..1244357 100644 --- a/docs/OptionsMMPReset.md +++ b/docs/OptionsMMPReset.md @@ -4,13 +4,13 @@ MMP Reset ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **str** | Underlying. | -**window** | **int** | Time window (milliseconds), between 1-5000, 0 means disabling MMP. | [optional] [readonly] +**underlying** | **str** | Underlying | +**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] +**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 004e0ac..c6df4a3 100644 --- a/docs/OptionsMySettlements.md +++ b/docs/OptionsMySettlements.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **float** | Settlement time. | [optional] -**underlying** | **str** | Underlying. | [optional] -**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] -**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] +**time** | **float** | Settlement time | [optional] +**underlying** | **str** | Underlying | [optional] +**contract** | **str** | Options contract name | [optional] +**strike_price** | **str** | Strike price (quote currency) | [optional] +**settle_price** | **str** | Settlement price (quote currency) | [optional] +**size** | **int** | Settlement size | [optional] +**settle_profit** | **str** | Settlement profit (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 d072076..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] -**contract** | **str** | Options contract name. | [optional] -**order_id** | **int** | Order ID related. | [optional] -**size** | **int** | Trading size. | [optional] -**price** | **str** | Trading price (quote currency). | [optional] -**underlying_price** | **str** | Underlying price (quote currency). | [optional] -**role** | **str** | Trade role. Available values are `taker` and `maker`. | [optional] +**id** | **int** | Fill ID | [optional] +**create_time** | **float** | Fill Time | [optional] +**contract** | **str** | Options contract name | [optional] +**order_id** | **int** | Related order ID | [optional] +**size** | **int** | Trading size | [optional] +**price** | **str** | Trade price (quote currency) | [optional] +**underlying_price** | **str** | Underlying price (quote currency) | [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 d6a2c18..484b6e0 100644 --- a/docs/OptionsOrder.md +++ b/docs/OptionsOrder.md @@ -1,34 +1,34 @@ # OptionsOrder -Options order detail. +Options order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Options 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** | Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled | [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] -**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** | When set to true, delegate to MMP. | [optional] [default to False] -**is_mmp** | **bool** | Whether it is MMP delegation. Corresponds to `mmp` in the request. | [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] +**id** | **int** | Options 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** | 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** | 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] -**refr** | **str** | Referrer rebate. | [optional] [readonly] +**tkfr** | **str** | Taker fee | [optional] [readonly] +**mkfr** | **str** | Maker fee | [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 ca2b9e8..b6dbefe 100644 --- a/docs/OptionsPosition.md +++ b/docs/OptionsPosition.md @@ -1,25 +1,25 @@ # OptionsPosition -Options position information. +Options contract position details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **int** | User ID. | [optional] [readonly] -**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] -**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] -**unrealised_pnl** | **str** | Unrealized PNL. | [optional] [readonly] -**pending_orders** | **int** | Current open orders. | [optional] [readonly] +**user** | **int** | User ID | [optional] [readonly] +**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 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] +**unrealised_pnl** | **str** | Unrealized PNL | [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 66fed5b..ea97971 100644 --- a/docs/OptionsPositionClose.md +++ b/docs/OptionsPositionClose.md @@ -3,12 +3,12 @@ ## Properties 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] +**time** | **float** | Position close time | [optional] [readonly] +**contract** | **str** | Options contract name | [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 8701bc4..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 6a1bddf..651d917 100644 --- a/docs/OptionsSettlement.md +++ b/docs/OptionsSettlement.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **float** | Last changed time of configuration. | [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] -**strike_price** | **str** | Strike price (quote currency). | [optional] -**settle_price** | **str** | Settlement price (quote currency). | [optional] +**time** | **float** | Last configuration update time | [optional] +**contract** | **str** | Options contract name | [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] [[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/OptionsTicker.md b/docs/OptionsTicker.md index e7426c4..1fef6d8 100644 --- a/docs/OptionsTicker.md +++ b/docs/OptionsTicker.md @@ -1,27 +1,27 @@ # 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] -**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] -**ask1_price** | **str** | Best ask price. | [optional] -**bid1_size** | **int** | Best bid size. | [optional] -**bid1_price** | **str** | Best bid price. | [optional] -**position_size** | **int** | Current total long position size. | [optional] -**mark_iv** | **str** | Implied volatility. | [optional] -**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] -**rho** | **str** | Rho. | [optional] +**name** | **str** | Options contract name | [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] +**ask1_price** | **str** | Best ask price | [optional] +**bid1_size** | **int** | Best bid size | [optional] +**bid1_price** | **str** | Best bid price | [optional] +**position_size** | **int** | Current total long position size | [optional] +**mark_iv** | **str** | Implied volatility | [optional] +**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** | 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/OptionsUnderlying.md b/docs/OptionsUnderlying.md index 4a1de9e..30897a6 100644 --- a/docs/OptionsUnderlying.md +++ b/docs/OptionsUnderlying.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Underlying name. | [optional] -**index_price** | **str** | Spot index price (quote currency). | [optional] +**name** | **str** | Underlying name | [optional] +**index_price** | **str** | Spot index price (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/OptionsUnderlyingTicker.md b/docs/OptionsUnderlyingTicker.md index f86f6ad..07be739 100644 --- a/docs/OptionsUnderlyingTicker.md +++ b/docs/OptionsUnderlyingTicker.md @@ -1,12 +1,12 @@ # OptionsUnderlyingTicker -Options underlying detail. +Options underlying detail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**trade_put** | **int** | Total put options trades amount in last 24h. | [optional] -**trade_call** | **int** | Total call options trades amount in last 24h. | [optional] -**index_price** | **str** | Index price (quote currency). | [optional] +**trade_put** | **int** | Total put options trades amount in last 24h | [optional] +**trade_call** | **int** | Total call options trades amount in last 24h | [optional] +**index_price** | **str** | Index price (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/Order.md b/docs/Order.md index d88100b..7eb5f0a 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -1,43 +1,43 @@ # Order -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Order ID. | [optional] [readonly] +**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] -**create_time** | **str** | Creation time of order. | [optional] [readonly] -**update_time** | **str** | Last modification time of order. | [optional] [readonly] -**create_time_ms** | **int** | Creation time of order (in milliseconds). | [optional] [readonly] -**update_time_ms** | **int** | Last modification time of order (in milliseconds). | [optional] [readonly] +**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional] [readonly] +**create_time** | **str** | Creation time of order | [optional] [readonly] +**update_time** | **str** | Last modification time of order | [optional] [readonly] +**create_time_ms** | **int** | Creation time of order (in milliseconds) | [optional] [readonly] +**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. | +**currency_pair** | **str** | Currency pair | **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** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When 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] +**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] -**left** | **str** | Amount left to fill. | [optional] [readonly] -**filled_amount** | **str** | Amount traded to fill. | [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] -**fee** | **str** | Fee deducted. | [optional] [readonly] -**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] -**rebated_fee** | **str** | Rebated fee. | [optional] [readonly] -**rebated_fee_currency** | **str** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **str** | Fee deducted | [optional] [readonly] +**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 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, 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** | 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] diff --git a/docs/OrderBook.md b/docs/OrderBook.md index 6050a17..2bfae72 100644 --- a/docs/OrderBook.md +++ b/docs/OrderBook.md @@ -4,10 +4,10 @@ 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. | +**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]]** | 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 3a86e21..0a14fe2 100644 --- a/docs/OrderCancel.md +++ b/docs/OrderCancel.md @@ -1,46 +1,46 @@ # OrderCancel -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Order ID. | [optional] [readonly] +**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] -**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] -**update_time** | **str** | Last modification time of order. | [optional] [readonly] -**create_time_ms** | **int** | Creation time of order (in milliseconds). | [optional] [readonly] -**update_time_ms** | **int** | Last modification time of order (in milliseconds). | [optional] [readonly] +**amend_text** | **str** | The custom data that the user remarked when amending the order | [optional] [readonly] +**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] +**update_time** | **str** | Last modification time of order | [optional] [readonly] +**create_time_ms** | **int** | Creation time of order (in milliseconds) | [optional] [readonly] +**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. | +**currency_pair** | **str** | Currency pair | **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** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When 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] +**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] -**left** | **str** | Amount left to fill. | [optional] [readonly] -**filled_amount** | **str** | Amount traded to fill. | [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] -**fee** | **str** | Fee deducted. | [optional] [readonly] -**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] -**rebated_fee** | **str** | Rebated fee. | [optional] [readonly] -**rebated_fee_currency** | **str** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **str** | Fee deducted | [optional] [readonly] +**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 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, 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 26c176b..f5c838e 100644 --- a/docs/OrderPatch.md +++ b/docs/OrderPatch.md @@ -1,14 +1,14 @@ # OrderPatch -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Currency pair. | [optional] -**account** | **str** | Specify query account. | [optional] -**amount** | **str** | Trading Quantity. Either amountor pricemust be specified. | [optional] -**price** | **str** | Trading Price. Either amountor pricemust be specified. | [optional] -**amend_text** | **str** | Custom info during amending order. | [optional] +**currency_pair** | **str** | Currency pair | [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/OrderResp.md b/docs/OrderResp.md index 749f53e..c89354c 100644 --- a/docs/OrderResp.md +++ b/docs/OrderResp.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | [optional] +**order_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/PartnerCommissionHistory.md b/docs/PartnerCommissionHistory.md index 2a2f590..057575b 100644 --- a/docs/PartnerCommissionHistory.md +++ b/docs/PartnerCommissionHistory.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **int** | Total. | [optional] -**list** | [**list[AgencyCommission]**](AgencyCommission.md) | List of comission history. | [optional] +**total** | **int** | Total | [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 e7a0989..9337d3a 100644 --- a/docs/PartnerSub.md +++ b/docs/PartnerSub.md @@ -3,9 +3,9 @@ ## Properties 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_id** | **int** | User ID | [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/PartnerSubList.md b/docs/PartnerSubList.md index 37085a9..c77bc6f 100644 --- a/docs/PartnerSubList.md +++ b/docs/PartnerSubList.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **int** | Total. | [optional] -**list** | [**list[PartnerSub]**](PartnerSub.md) | Subordinate list. | [optional] +**total** | **int** | Total | [optional] +**list** | [**list[PartnerSub]**](PartnerSub.md) | Subordinate 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/PartnerTransactionHistory.md b/docs/PartnerTransactionHistory.md index 7df8289..707f40b 100644 --- a/docs/PartnerTransactionHistory.md +++ b/docs/PartnerTransactionHistory.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **int** | Total. | [optional] -**list** | [**list[AgencyTransaction]**](AgencyTransaction.md) | List of transaction history. | [optional] +**total** | **int** | Total | [optional] +**list** | [**list[AgencyTransaction]**](AgencyTransaction.md) | List of transaction 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/PatchUniLend.md b/docs/PatchUniLend.md index 5aeda0f..b622196 100644 --- a/docs/PatchUniLend.md +++ b/docs/PatchUniLend.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency name. | [optional] -**min_rate** | **str** | Minimum interest rate. | [optional] +**currency** | **str** | Currency name | [optional] +**min_rate** | **str** | Minimum interest 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/PlaceDualInvestmentOrder.md b/docs/PlaceDualInvestmentOrder.md index 78ac28d..f957b47 100644 --- a/docs/PlaceDualInvestmentOrder.md +++ b/docs/PlaceDualInvestmentOrder.md @@ -1,12 +1,12 @@ # PlaceDualInvestmentOrder -Dual Investment order. +Dual Investment Order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**plan_id** | **str** | Plan ID. | -**amount** | **str** | Subscription amount, mutually exclusive with the copies field. | -**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] +**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 36fcc5d..5c4065b 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -1,42 +1,43 @@ # Position -Futures position details. +Futures position details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **int** | User ID. | [optional] [readonly] -**contract** | **str** | Futures contract. | [optional] [readonly] -**size** | **int** | Position size. | [optional] [readonly] +**user** | **int** | User ID | [optional] [readonly] +**contract** | **str** | Futures contract | [optional] [readonly] +**size** | **int** | Position size | [optional] [readonly] **leverage** | **str** | Position leverage. 0 means cross margin; positive number means isolated margin | [optional] -**risk_limit** | **str** | Position risk limit. | [optional] -**leverage_max** | **str** | Maximum leverage under current risk limit. | [optional] [readonly] -**maintenance_rate** | **str** | Maintenance rate under current risk limit. | [optional] [readonly] -**value** | **str** | Position value calculated in settlement currency. | [optional] [readonly] -**margin** | **str** | Position margin. | [optional] -**entry_price** | **str** | Entry price. | [optional] [readonly] -**liq_price** | **str** | Liquidation price. | [optional] [readonly] -**mark_price** | **str** | Current mark price. | [optional] [readonly] +**risk_limit** | **str** | Position risk limit | [optional] +**leverage_max** | **str** | Maximum leverage under current risk limit | [optional] [readonly] +**maintenance_rate** | **str** | Maintenance rate under current risk limit | [optional] [readonly] +**value** | **str** | Position value calculated in settlement currency | [optional] [readonly] +**margin** | **str** | Position margin | [optional] +**entry_price** | **str** | Entry price | [optional] [readonly] +**liq_price** | **str** | Liquidation price | [optional] [readonly] +**mark_price** | **str** | Current mark price | [optional] [readonly] **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] -**pnl_pnl** | **str** | Realized PNL - Position P/L. | [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] -**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] +**unrealised_pnl** | **str** | Unrealized 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_fee** | **str** | Realized PNL - Transaction Fees | [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`: 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] -**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] +**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. 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 775029c..93bf9cf 100644 --- a/docs/PositionClose.md +++ b/docs/PositionClose.md @@ -3,19 +3,19 @@ ## Properties 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] -**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] -**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 closing average price. | [optional] [readonly] -**short_price** | **str** | When 'side' is 'long,' it indicates the opening average price; when closing average price | [optional] [readonly] +**time** | **float** | Position close time | [optional] [readonly] +**contract** | **str** | Futures contract | [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** | 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 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 6366d4f..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 f05d06d..963c54a 100644 --- a/docs/ProfitLossRange.md +++ b/docs/ProfitLossRange.md @@ -1,12 +1,12 @@ # ProfitLossRange -Profit and loss range. +Profit and loss range ## Properties 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] +**price_percentage** | **str** | Percentage change in price | [optional] +**implied_volatility_percentage** | **str** | Percentage change in implied volatility | [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 8f98e45..f7e8f50 100644 --- a/docs/RebateApi.md +++ b/docs/RebateApi.md @@ -4,23 +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. -[**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. -[**user_sub_relation**](RebateApi.md#user_sub_relation) | **GET** /rebate/user/sub_relation | User-subordinate relationship. +[**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 | 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 @@ -46,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) -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 | 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: @@ -67,12 +67,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 @@ -90,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 @@ -125,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) -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 | 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)) @@ -146,12 +147,13 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Filter by currency. Return all currency records if not specified. | [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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 @@ -169,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 @@ -204,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) -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 | 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: @@ -225,12 +227,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 @@ -248,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 @@ -283,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) -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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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 | 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: @@ -304,12 +306,12 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Filter by currency. Return all currency records if not specified. | [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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 @@ -327,16 +329,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_sub_list** > PartnerSubList partner_sub_list(user_id=user_id, limit=limit, offset=offset) -Partner subordinate list. +Partner subordinate list -Including sub-agents, direct customers, indirect customers. +Including sub-agents, direct customers, and indirect customers ### Example @@ -362,12 +364,12 @@ configuration = gate_api.Configuration( 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) -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) +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 subordinate list. + # Partner subordinate list api_response = api_instance.partner_sub_list(user_id=user_id, limit=limit, offset=offset) print(api_response) except GateApiException as ex: @@ -380,9 +382,9 @@ 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] - **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] + **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 @@ -400,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 @@ -435,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) -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) +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 | 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: @@ -455,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] - **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] + **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**| 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 @@ -477,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 @@ -512,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) -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) +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 | 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: @@ -532,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] - **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] + **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**| 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 @@ -554,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 @@ -589,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: @@ -617,16 +619,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) # **user_sub_relation** > UserSubRelation user_sub_relation(user_id_list) -User-subordinate relationship. +User subordinate relationship -Query whether the specified user is in the system. +Query whether the specified user is within the system ### Example @@ -652,10 +654,10 @@ configuration = gate_api.Configuration( 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 the user's ID list, split by,, if there are more than 100, take 100. +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. + # User subordinate relationship api_response = api_instance.user_sub_relation(user_id_list) print(api_response) except GateApiException as ex: @@ -668,7 +670,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id_list** | **str**| Query the user's ID list, split by,, if there are more than 100, take 100. | + **user_id_list** | **str**| Query user ID list, separated by commas. If more than 100, only 100 will be returned | ### Return type @@ -686,7 +688,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) diff --git a/docs/RebateUserInfo.md b/docs/RebateUserInfo.md index 1e721c4..0f97b11 100644 --- a/docs/RebateUserInfo.md +++ b/docs/RebateUserInfo.md @@ -1,10 +1,10 @@ # RebateUserInfo -Retrieve user rebate information. +Retrieve user rebate information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**invite_uid** | **int** | My inviter's UID. | [optional] +**invite_uid** | **int** | My inviter's UID | [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/RepayCurrencyRes.md b/docs/RepayCurrencyRes.md index d190f4b..9715d48 100644 --- a/docs/RepayCurrencyRes.md +++ b/docs/RepayCurrencyRes.md @@ -3,12 +3,12 @@ ## 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] -**currency** | **str** | Repayment currency. | [optional] -**repaid_principal** | **str** | Principal. | [optional] -**repaid_interest** | **str** | Principal. | [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] [[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/RepayLoan.md b/docs/RepayLoan.md index fd8388f..92c8463 100644 --- a/docs/RepayLoan.md +++ b/docs/RepayLoan.md @@ -1,11 +1,11 @@ # RepayLoan -Repay. +Repay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | -**repay_amount** | **str** | Repayment amount, it is mandatory when making partial repayments. | +**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 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 9cf08c2..eb1c0ab 100644 --- a/docs/RepayMultiLoan.md +++ b/docs/RepayMultiLoan.md @@ -1,11 +1,11 @@ # RepayMultiLoan -Repay Multi-Collateral Loan. +Multi-currency collateral repayment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | -**repay_items** | [**list[MultiLoanRepayItem]**](MultiLoanRepayItem.md) | Repay Currency Item. | +**order_id** | **int** | Order ID | +**repay_items** | [**list[MultiLoanRepayItem]**](MultiLoanRepayItem.md) | Repay Currency Item | [[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/RepayRecord.md b/docs/RepayRecord.md index a583be6..a9cf6cf 100644 --- a/docs/RepayRecord.md +++ b/docs/RepayRecord.md @@ -1,22 +1,22 @@ # RepayRecord -Repayment record. +Repayment record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order ID. | [optional] -**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] -**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] +**order_id** | **int** | Order ID | [optional] +**record_id** | **int** | Repayment record ID | [optional] +**repaid_amount** | **str** | Repayment amount | [optional] +**borrow_currency** | **str** | Borrowed currency | [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 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 514d3c3..d8a1c90 100644 --- a/docs/RepayRecordCurrency.md +++ b/docs/RepayRecordCurrency.md @@ -3,12 +3,12 @@ ## Properties 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] +**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] [[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/RepayRecordLeftInterest.md b/docs/RepayRecordLeftInterest.md index 9bde226..79ca1d9 100644 --- a/docs/RepayRecordLeftInterest.md +++ b/docs/RepayRecordLeftInterest.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**index_price** | **str** | Currency Index Price. | [optional] -**before_amount** | **str** | Interest amount before repayment. | [optional] -**before_amount_usdt** | **str** | Converted value of interest before repayment in USDT. | [optional] -**after_amount** | **str** | Interest amount after repayment. | [optional] -**after_amount_usdt** | **str** | Converted value of interest after repayment in USDT. | [optional] +**currency** | **str** | Currency | [optional] +**index_price** | **str** | Currency Index Price | [optional] +**before_amount** | **str** | Interest amount before repayment | [optional] +**before_amount_usdt** | **str** | Converted value of interest before repayment in USDT | [optional] +**after_amount** | **str** | Interest amount after repayment | [optional] +**after_amount_usdt** | **str** | Converted value of interest after repayment 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/RepayRecordRepaidCurrency.md b/docs/RepayRecordRepaidCurrency.md index 36b657a..b49320d 100644 --- a/docs/RepayRecordRepaidCurrency.md +++ b/docs/RepayRecordRepaidCurrency.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Repayment currency. | [optional] -**index_price** | **str** | Currency Index Price. | [optional] -**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] +**currency** | **str** | Repayment currency | [optional] +**index_price** | **str** | Currency Index Price | [optional] +**repaid_amount** | **str** | Repayment amount | [optional] +**repaid_principal** | **str** | Principal | [optional] +**repaid_interest** | **str** | Interest | [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/RepayRecordTotalInterest.md b/docs/RepayRecordTotalInterest.md index e7d143d..8c7a2cc 100644 --- a/docs/RepayRecordTotalInterest.md +++ b/docs/RepayRecordTotalInterest.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**index_price** | **str** | Currency Index Price. | [optional] -**amount** | **str** | Interest Amount. | [optional] -**amount_usdt** | **str** | Interest amount converted to USDT. | [optional] +**currency** | **str** | Currency | [optional] +**index_price** | **str** | Currency Index Price | [optional] +**amount** | **str** | Interest Amount | [optional] +**amount_usdt** | **str** | Interest 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/RepayResp.md b/docs/RepayResp.md index f3a2776..f7124e3 100644 --- a/docs/RepayResp.md +++ b/docs/RepayResp.md @@ -1,11 +1,11 @@ # RepayResp -Repay. +Repay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**repaid_principal** | **str** | Principal. | [optional] -**repaid_interest** | **str** | Interest. | [optional] +**repaid_principal** | **str** | Principal | [optional] +**repaid_interest** | **str** | 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 ddef59b..dcff46e 100644 --- a/docs/RiskUnits.md +++ b/docs/RiskUnits.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **str** | Risk unit flag. | [optional] -**spot_in_use** | **str** | Spot hedging utilization. | [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] -**gamma** | **str** | Total Gamma of risk unit. | [optional] -**theta** | **str** | Total Theta of risk unit. | [optional] -**vega** | **str** | Total Vega of risk unit. | [optional] +**symbol** | **str** | Risk unit flag | [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] +**gamma** | **str** | Total Gamma of risk unit | [optional] +**theta** | **str** | Total Theta of risk unit | [optional] +**vega** | **str** | Total Vega of 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/SavedAddress.md b/docs/SavedAddress.md index 77d7657..117d52d 100644 --- a/docs/SavedAddress.md +++ b/docs/SavedAddress.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**chain** | **str** | Chain name. | [optional] -**address** | **str** | Address. | [optional] -**name** | **str** | Name. | [optional] -**tag** | **str** | Tag. | [optional] -**verified** | **str** | Whether to pass the verification 0-unverified, 1-verified. | [optional] +**currency** | **str** | Currency | [optional] +**chain** | **str** | Chain name | [optional] +**address** | **str** | Address | [optional] +**name** | **str** | Name | [optional] +**tag** | **str** | Tag | [optional] +**verified** | **str** | Whether to pass the verification 0-unverified, 1-verified | [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/SmallBalance.md b/docs/SmallBalance.md index 945735a..7302d38 100644 --- a/docs/SmallBalance.md +++ b/docs/SmallBalance.md @@ -1,13 +1,13 @@ # SmallBalance -Convert Small Balance. +Small Balance Conversion ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**available_balance** | **str** | Available balance. | [optional] -**estimated_as_btc** | **str** | Estimated as BTC. | [optional] -**convertible_to_gt** | **str** | Estimated conversion to GT. | [optional] +**currency** | **str** | Currency | [optional] +**available_balance** | **str** | Available balance | [optional] +**estimated_as_btc** | **str** | Estimated as BTC | [optional] +**convertible_to_gt** | **str** | Estimated conversion to GT | [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/SmallBalanceHistory.md b/docs/SmallBalanceHistory.md index 4e094c3..5a5f5b0 100644 --- a/docs/SmallBalanceHistory.md +++ b/docs/SmallBalanceHistory.md @@ -1,14 +1,14 @@ # 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] -**gt_amount** | **str** | GT amount. | [optional] [readonly] -**create_time** | **int** | Exchange time (in seconds). | [optional] [readonly] +**id** | **str** | Order ID | [optional] [readonly] +**currency** | **str** | Currency | [optional] [readonly] +**amount** | **str** | Swap Amount | [optional] [readonly] +**gt_amount** | **str** | GT amount | [optional] [readonly] +**create_time** | **int** | Exchange time (in seconds) | [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/SpotAccount.md b/docs/SpotAccount.md index 9ce8e92..6bb761e 100644 --- a/docs/SpotAccount.md +++ b/docs/SpotAccount.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**available** | **str** | Available amount. | [optional] -**locked** | **str** | Locked amount, used in trading. | [optional] -**update_id** | **int** | Version number. | [optional] +**currency** | **str** | Currency detail | [optional] +**available** | **str** | Available amount | [optional] +**locked** | **str** | Locked amount, used in trading | [optional] +**update_id** | **int** | Version number | [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/SpotAccountBook.md b/docs/SpotAccountBook.md index 9d79d3e..80d34cb 100644 --- a/docs/SpotAccountBook.md +++ b/docs/SpotAccountBook.md @@ -3,14 +3,14 @@ ## 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] +**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] -**code** | **str** | Account change code, see [Asset Record Code] (Asset Record Code). | [optional] -**text** | **str** | Additional information. | [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 15709cf..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_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. -[**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. -[**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 Price-triggered 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_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 +[**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 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 | 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 -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. +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 @@ -114,10 +114,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 = 'GT' # str | Currency name. +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: @@ -130,7 +130,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency name. | + **currency** | **str**| Currency name | ### Return type @@ -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: @@ -202,14 +202,14 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All currency pairs retrieved. | - | +**200** | All currency pairs 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_currency_pair** > CurrencyPair get_currency_pair(currency_pair) -Get details of a specifc currency pair. +Query single currency pair details ### Example @@ -226,10 +226,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 = 'ETH_BTC' # str | Currency pair. +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: @@ -242,7 +242,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | + **currency_pair** | **str**| Currency pair | ### Return type @@ -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 @@ -286,11 +286,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) -currency_pair = 'BTC_USDT' # str | Currency pair. (optional) -timezone = 'utc0' # str | Timezone. (optional) +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: @@ -303,8 +303,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency_pair** | **str**| Currency pair. | [optional] - **timezone** | **str**| Timezone. | [optional] + **currency_pair** | **str**| Currency pair | [optional] + **timezone** | **str**| Timezone | [optional] ### Return type @@ -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 -Market depth buy orders are sorted by price from high to low, sell orders are reversed +Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high ### Example @@ -348,13 +348,13 @@ 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 | 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) +currency_pair = 'BTC_USDT' # str | Currency pair +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: @@ -367,10 +367,10 @@ 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] + **currency_pair** | **str**| Currency pair | + **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 -Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. +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 @@ -414,16 +414,16 @@ 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 | 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 the currency name to query in batches, and support up to 100 pass parameters at a time. (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) -page = 1 # int | Page number. (optional) (default to 1) +currency_pair = 'BTC_USDT' # str | Currency pair +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: @@ -436,13 +436,13 @@ 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 the currency name to query in batches, and support up to 100 pass parameters at a time. | [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] - **page** | **int**| Page number. | [optional] [default to 1] + **currency_pair** | **str**| Currency pair | + **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 @@ -486,14 +486,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 | 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) +currency_pair = 'BTC_USDT' # str | Currency pair +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 | 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 specified (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: @@ -506,11 +506,11 @@ 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] + **currency_pair** | **str**| Currency pair | + **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**| 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 specified | [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, code=code) -Query account book. +Query spot account transaction history -Record query time range is not allowed to exceed 30 days. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. +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,16 @@ 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) -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) -code = 'code_example' # str | Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` (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 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. + # 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: @@ -788,13 +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] - **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] - **code** | **str**| Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` | [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 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 @@ -812,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 @@ -851,7 +851,7 @@ order = [gate_api.Order()] # list[Order] | 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: @@ -883,14 +883,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) # **list_all_open_orders** > list[OpenOrders] list_all_open_orders(page=page, limit=limit, account=account) -List all open orders. +List all open orders 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. @@ -918,12 +918,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) -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 = 'spot' # str | Specify query account. (optional) +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 = 'spot' # str | Specify query account (optional) try: - # List all open orders. + # List all open orders api_response = api_instance.list_all_open_orders(page=page, limit=limit, account=account) print(api_response) except GateApiException as ex: @@ -936,9 +936,9 @@ except ApiException as e: 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 query account. | [optional] + **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 query account | [optional] ### Return type @@ -956,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 @@ -994,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: @@ -1025,16 +1025,16 @@ 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) # **list_orders** > list[Order] list_orders(currency_pair, status, page=page, limit=limit, account=account, _from=_from, to=to, side=side) -List orders. +List orders -Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end 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 @@ -1060,17 +1060,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_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) +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 = 'spot' # str | Specify query account. (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. + # List orders api_response = api_instance.list_orders(currency_pair, status, page=page, limit=limit, account=account, _from=_from, to=to, side=side) print(api_response) except GateApiException as ex: @@ -1083,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] + **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 query account. | [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 @@ -1108,16 +1108,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_order** > Order create_order(order, x_gate_exptime=x_gate_exptime) -Create an order. +Create an order -Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions +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 @@ -1147,7 +1147,7 @@ order = gate_api.Order() # Order | 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. + # Create an order api_response = api_instance.create_order(order, x_gate_exptime=x_gate_exptime) print(api_response) except GateApiException as ex: @@ -1179,16 +1179,16 @@ 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) # **cancel_orders** > list[OrderCancel] cancel_orders(currency_pair=currency_pair, side=side, account=account, action_mode=action_mode, x_gate_exptime=x_gate_exptime) -Cancel all `open` orders in specified currency pair. +Cancel all `open` orders in specified currency pair -When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under 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 @@ -1214,14 +1214,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 | Currency pair. (optional) -side = 'sell' # str | All bids or 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) +currency_pair = 'BTC_USDT' # str | Currency pair (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. + # Cancel all `open` orders in specified currency pair api_response = api_instance.cancel_orders(currency_pair=currency_pair, side=side, account=account, action_mode=action_mode, x_gate_exptime=x_gate_exptime) print(api_response) except GateApiException as ex: @@ -1234,10 +1234,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: 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] + **currency_pair** | **str**| Currency pair | [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 @@ -1256,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 @@ -1295,7 +1295,7 @@ cancel_batch_order = [gate_api.CancelBatchOrder()] # list[CancelBatchOrder] | 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: @@ -1327,16 +1327,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Batch cancellation completed. | - | +**200** | Batch cancellation 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_order** > Order get_order(order_id, currency_pair, account=account) -Get a single order. +Query single order details -By default, orders for spot, unified account and warehouse-by-site leverage account are checked. +By default, queries orders for spot, unified account, and isolated margin accounts. ### Example @@ -1363,11 +1363,11 @@ api_client = gate_api.ApiClient(configuration) # Create an instance of the API class api_instance = gate_api.SpotApi(api_client) 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 transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. -account = 'spot' # str | Specify query account. (optional) +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: @@ -1381,8 +1381,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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 transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. | - **account** | **str**| Specify query account. | [optional] + **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 @@ -1400,14 +1400,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Detail retrieved. | - | +**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) # **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 By default, orders for spot, unified accounts and leveraged accounts are revoked. @@ -1436,13 +1436,13 @@ api_client = gate_api.ApiClient(configuration) # Create an instance of the API class api_instance = gate_api.SpotApi(api_client) 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 = '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) +currency_pair = 'BTC_USDT' # str | Currency pair +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: @@ -1456,9 +1456,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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 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] + **currency_pair** | **str**| Currency pair | + **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 @@ -1477,14 +1477,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancelled. | - | +**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) # **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 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. @@ -1514,12 +1514,12 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.SpotApi(api_client) 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 = 'spot' # str | Specify query account. (optional) +currency_pair = 'BTC_USDT' # str | Currency pair (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: @@ -1534,8 +1534,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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 query account. | [optional] + **currency_pair** | **str**| Currency pair | [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 @@ -1554,14 +1554,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) # **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 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. @@ -1589,16 +1589,16 @@ 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. (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) -page = 1 # int | Page number. (optional) (default to 1) +currency_pair = 'BTC_USDT' # str | Retrieve results with specified currency pair (optional) +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 = 'spot' # str | Specify query account. (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: @@ -1611,13 +1611,13 @@ 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] - **page** | **int**| Page number. | [optional] [default to 1] + **currency_pair** | **str**| Retrieve results with specified currency pair | [optional] + **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 query account. | [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 @@ -1635,14 +1635,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_system_time** > SystemTime get_system_time() -Get server current time. +Get server current time ### Example @@ -1661,7 +1661,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.SpotApi(api_client) try: - # Get server current time. + # Get server current time api_response = api_instance.get_system_time() print(api_response) except GateApiException as ex: @@ -1689,14 +1689,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) # **countdown_cancel_all_spot** > TriggerTime countdown_cancel_all_spot(countdown_cancel_all_spot_task) -Countdown cancel orders. +Countdown cancel orders 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. @@ -1727,7 +1727,7 @@ api_instance = gate_api.SpotApi(api_client) countdown_cancel_all_spot_task = gate_api.CountdownCancelAllSpotTask() # CountdownCancelAllSpotTask | try: - # Countdown cancel orders. + # Countdown cancel orders api_response = api_instance.countdown_cancel_all_spot(countdown_cancel_all_spot_task) print(api_response) except GateApiException as ex: @@ -1758,16 +1758,16 @@ 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) # **amend_batch_orders** > list[BatchOrder] amend_batch_orders(batch_amend_item, x_gate_exptime=x_gate_exptime) -Batch modification of orders. +Batch modification of orders -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 is consistent with the order list order. +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 @@ -1797,7 +1797,7 @@ batch_amend_item = [gate_api.BatchAmendItem()] # list[BatchAmendItem] | 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. + # Batch modification of orders api_response = api_instance.amend_batch_orders(batch_amend_item, x_gate_exptime=x_gate_exptime) print(api_response) except GateApiException as ex: @@ -1829,14 +1829,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order modification executed successfully. | - | +**200** | Order modification executed 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_spot_insurance_history** > list[SpotInsuranceHistory] get_spot_insurance_history(business, currency, _from, to, page=page, limit=limit) -Query spot insurance fund historical data. +Query spot insurance fund historical data ### Example @@ -1854,14 +1854,14 @@ api_client = gate_api.ApiClient(configuration) # Create an instance of the API class 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. -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) +currency = 'BTC' # str | Currency +_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) try: - # Query spot insurance fund historical data. + # Query spot insurance fund historical data api_response = api_instance.get_spot_insurance_history(business, currency, _from, to, page=page, limit=limit) print(api_response) except GateApiException as ex: @@ -1875,11 +1875,11 @@ except ApiException as e: 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. | - **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] + **currency** | **str**| Currency | + **_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] ### Return type @@ -1897,14 +1897,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_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 @@ -1930,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 `unified`. (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) +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: @@ -1950,11 +1950,11 @@ 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 `unified`. | [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] + **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 @@ -1972,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 @@ -2008,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: @@ -2039,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 Price-triggered Orders. +Cancel all auto orders ### Example @@ -2072,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 `unified`. (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 Price-triggered 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: @@ -2089,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 `unified`. | [optional] + **market** | **str**| Trading market | [optional] + **account** | **str**| Trading account type. Unified account must be set to `unified` | [optional] ### Return type @@ -2108,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 @@ -2141,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: @@ -2157,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 @@ -2175,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 @@ -2208,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: @@ -2224,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 @@ -2242,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 index ad873a8..d461e15 100644 --- a/docs/SpotCurrencyChain.md +++ b/docs/SpotCurrencyChain.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Chain 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] +**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 675c25c..e007cf0 100644 --- a/docs/SpotFee.md +++ b/docs/SpotFee.md @@ -3,15 +3,15 @@ ## Properties 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] +**user_id** | **int** | User ID | [optional] +**taker_fee** | **str** | taker fee rate | [optional] +**maker_fee** | **str** | maker fee rate | [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] -**loan_fee** | **str** | Loan fee rate of margin lending. | [optional] -**point_type** | **str** | Point type. 0 - Initial version. 1 - new version since 202009. | [optional] -**currency_pair** | **str** | Currency pair. | [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 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] [[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/SpotInsuranceHistory.md b/docs/SpotInsuranceHistory.md index fccc107..3d1f006 100644 --- a/docs/SpotInsuranceHistory.md +++ b/docs/SpotInsuranceHistory.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] -**balance** | **str** | balance. | [optional] -**time** | **int** | Creation time, timestamp, milliseconds. | [optional] +**currency** | **str** | Currency | [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 1e27338..899f6d7 100644 --- a/docs/SpotPricePutOrder.md +++ b/docs/SpotPricePutOrder.md @@ -5,13 +5,13 @@ 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 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 `unified` -normal: spot trading - margin: margin trading - unified: unified trading | [default to 'normal'] +**price** | **str** | Order price | +**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'] -**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 - 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 3c1f2bd..0208586 100644 --- a/docs/SpotPriceTrigger.md +++ b/docs/SpotPriceTrigger.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**price** | **str** | Trigger price. | -**rule** | **str** | Price trigger condition - `>=`: triggered when market price larger than or equal to `price` field - `<=`: or equal to `price` field | -**expiration** | **int** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | +**price** | **str** | Trigger price | +**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 c9faff4..5c524ae 100644 --- a/docs/SpotPriceTriggeredOrder.md +++ b/docs/SpotPriceTriggeredOrder.md @@ -1,19 +1,19 @@ # SpotPriceTriggeredOrder -Spot order detail. +Spot price order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **trigger** | [**SpotPriceTrigger**](SpotPriceTrigger.md) | | **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] +**id** | **int** | Auto order ID | [optional] [readonly] +**user** | **int** | User ID | [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 4098086..8a02186 100644 --- a/docs/StpGroup.md +++ b/docs/StpGroup.md @@ -3,10 +3,10 @@ ## Properties 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] +**id** | **int** | STP Group ID | [optional] +**name** | **str** | STP Group name | +**creator_id** | **int** | Creator ID | [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 1eb88f0..2e05e1a 100644 --- a/docs/StpGroupUser.md +++ b/docs/StpGroupUser.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_id** | **int** | User ID. | [optional] -**stp_id** | **int** | STP Group ID. | [optional] -**create_time** | **int** | Creation time. | [optional] +**user_id** | **int** | User ID | [optional] +**stp_id** | **int** | STP Group ID | [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 5252d47..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 1aa9d35..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 27f4742..3f52c75 100644 --- a/docs/StructuredOrderList.md +++ b/docs/StructuredOrderList.md @@ -1,16 +1,16 @@ # StructuredOrderList -Structured order. +Structured order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Order ID. | [optional] -**pid** | **str** | Plan ID. | [optional] -**lock_coin** | **str** | Locked coin. | [optional] -**amount** | **str** | Locked amount. | [optional] +**id** | **int** | Order 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] -**income** | **str** | Income. | [optional] -**create_time** | **int** | Created time. | [optional] +**income** | **str** | Income | [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/SubAccount.md b/docs/SubAccount.md index 837077f..4778a33 100644 --- a/docs/SubAccount.md +++ b/docs/SubAccount.md @@ -3,14 +3,14 @@ ## 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 | -**password** | **str** | The sub-account's password. (Default: the same as main account's password). | [optional] +**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] -**create_time** | **int** | Created time. | [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 5f61557..dfae02b 100644 --- a/docs/SubAccountApi.md +++ b/docs/SubAccountApi.md @@ -4,23 +4,23 @@ All URIs are relative to *https://api.gateio.ws/api/v4* 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. -[**list_unified_mode**](SubAccountApi.md#list_unified_mode) | **GET** /sub_accounts/unified_mode | Get sub-account mode. +[**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 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 # **list_sub_accounts** > list[SubAccount] list_sub_accounts(type=type) -List sub-accounts. +List sub-accounts ### Example @@ -46,10 +46,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) -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. + # List sub-accounts api_response = api_instance.list_sub_accounts(type=type) print(api_response) except GateApiException as ex: @@ -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,14 +80,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_accounts** > SubAccount create_sub_accounts(sub_account) -Create a new sub-account. +Create a new sub-account ### Example @@ -116,7 +116,7 @@ api_instance = gate_api.SubAccountApi(api_client) sub_account = gate_api.SubAccount() # SubAccount | try: - # Create a new sub-account. + # Create a new sub-account api_response = api_instance.create_sub_accounts(sub_account) print(api_response) except GateApiException as ex: @@ -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** > 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,7 +331,7 @@ 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 @@ -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,16 +689,16 @@ 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) # **list_unified_mode** > list[SubUserMode] list_unified_mode() -Get sub-account mode. +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 @@ -726,7 +726,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.SubAccountApi(api_client) try: - # Get sub-account mode. + # Get sub-account mode api_response = api_instance.list_unified_mode() print(api_response) except GateApiException as ex: @@ -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/SubAccountBalance.md b/docs/SubAccountBalance.md index 5927e74..753d3dd 100644 --- a/docs/SubAccountBalance.md +++ b/docs/SubAccountBalance.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **str** | User ID. | [optional] -**available** | **dict(str, str)** | Available balances of currencies. | [optional] +**uid** | **str** | User ID | [optional] +**available** | **dict(str, str)** | Available balances of currencies | [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/SubAccountCrossMarginBalance.md b/docs/SubAccountCrossMarginBalance.md index 586ea60..ebb3791 100644 --- a/docs/SubAccountCrossMarginBalance.md +++ b/docs/SubAccountCrossMarginBalance.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **str** | User ID. | [optional] +**uid** | **str** | User ID | [optional] **available** | [**SubCrossMarginAccount**](.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/SubAccountFuturesBalance.md b/docs/SubAccountFuturesBalance.md index f3a9231..d5ddf25 100644 --- a/docs/SubAccountFuturesBalance.md +++ b/docs/SubAccountFuturesBalance.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **str** | User ID. | [optional] -**available** | [**dict(str, FuturesAccount)**](FuturesAccount.md) | Futures account balances. | [optional] +**uid** | **str** | User ID | [optional] +**available** | [**dict(str, FuturesAccount)**](FuturesAccount.md) | Futures account balances | [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/SubAccountKey.md b/docs/SubAccountKey.md index fdc7ff1..54fbdc5 100644 --- a/docs/SubAccountKey.md +++ b/docs/SubAccountKey.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_id** | **int** | User ID. | [optional] [readonly] -**mode** | **int** | Mode: 1 - classic 2 - portfolio account. | [optional] -**name** | **str** | API key name. | [optional] +**user_id** | **int** | User ID | [optional] [readonly] +**mode** | **int** | Mode: 1 - classic 2 - portfolio account | [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] -**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] +**ip_whitelist** | **list[str]** | IP whitelist (list will be cleared if no value is passed) | [optional] +**key** | **str** | API Key | [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 0c8eb3e..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/SubAccountMarginBalance.md b/docs/SubAccountMarginBalance.md index 7a648d5..817fd31 100644 --- a/docs/SubAccountMarginBalance.md +++ b/docs/SubAccountMarginBalance.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **str** | User ID. | [optional] -**available** | [**list[MarginAccount]**](MarginAccount.md) | Margin account balances. | [optional] +**uid** | **str** | User ID | [optional] +**available** | [**list[MarginAccount]**](MarginAccount.md) | Margin account balances | [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 0f201a8..ad18faf 100644 --- a/docs/SubAccountToSubAccount.md +++ b/docs/SubAccountToSubAccount.md @@ -3,13 +3,13 @@ ## Properties 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_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_to** | **str** | Transfer to the user id of the sub-account. | -**sub_account_to_type** | **str** | Transferred sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account | -**amount** | **str** | Transfer amount. | +**currency** | **str** | Transfer currency name | +**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** | 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** | 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 4724a8d..c591078 100644 --- a/docs/SubAccountTransfer.md +++ b/docs/SubAccountTransfer.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sub_account** | **str** | Sub account user ID. | -**sub_account_type** | **str** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 | -**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] +**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 | +**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 index a0c42d5..ebfe07e 100644 --- a/docs/SubAccountTransferRecordItem.md +++ b/docs/SubAccountTransferRecordItem.md @@ -3,16 +3,16 @@ ## 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 user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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** | Where the operation is initiated from. | [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] -**status** | **str** | Sub-account transfer record status, currently only success. | [optional] +**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 8ee99f1..b3ab224 100644 --- a/docs/SubCrossMarginAccount.md +++ b/docs/SubCrossMarginAccount.md @@ -3,22 +3,22 @@ ## 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] +**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] -**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] -**total_initial_margin** | **str** | Total initial margin. | [optional] -**total_margin_balance** | **str** | Total margin balance. | [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] +**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 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] +**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] [[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/SubUserMode.md b/docs/SubUserMode.md index 7f2067a..a1d0c6d 100644 --- a/docs/SubUserMode.md +++ b/docs/SubUserMode.md @@ -3,9 +3,9 @@ ## Properties 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] +**user_id** | **int** | User ID | [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/SwapCoin.md b/docs/SwapCoin.md index ed922e4..3dc278b 100644 --- a/docs/SwapCoin.md +++ b/docs/SwapCoin.md @@ -1,13 +1,13 @@ # SwapCoin -Blockchain Mining. +Blockchain Mining ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coin** | **str** | Currency. | -**side** | **str** | 0 - Stake 1 - Redeem. | -**amount** | **str** | Size. | -**pid** | **int** | DeFi-type Mining Protocol Identifier. | [optional] +**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 index 6085062..15735e1 100644 --- a/docs/SwapCoinStruct.md +++ b/docs/SwapCoinStruct.md @@ -3,21 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Order ID. | [optional] -**pid** | **int** | Plan ID. | [optional] -**uid** | **int** | User ID. | [optional] -**coin** | **str** | Currency. | [optional] -**type** | **int** | 类型 0-质押 1-赎回 | [optional] -**subtype** | **str** | 子类型 | [optional] -**amount** | **str** | Amount. | [optional] -**exchange_rate** | **str** | Exchange Ratio. | [optional] -**exchange_amount** | **str** | 兑换金额 | [optional] -**update_stamp** | **int** | 更新时间戳 | [optional] -**create_stamp** | **int** | Transaction timestamp. | [optional] -**status** | **int** | status 1-success. | [optional] -**protocol_type** | **int** | DEFI协议类型 | [optional] -**client_order_id** | **str** | 参考ID | [optional] -**source** | **str** | Order source. | [optional] +**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/SystemTime.md b/docs/SystemTime.md index c746f50..abcf889 100644 --- a/docs/SystemTime.md +++ b/docs/SystemTime.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**server_time** | **int** | Server current time(ms). | [optional] +**server_time** | **int** | Server current time(ms) | [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 dde227e..8f0a410 100644 --- a/docs/Ticker.md +++ b/docs/Ticker.md @@ -3,23 +3,23 @@ ## Properties 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] -**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] -**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_leverage** | **str** | ETF current leverage. | [optional] +**currency_pair** | **str** | Currency pair | [optional] +**last** | **str** | Last trading price | [optional] +**lowest_ask** | **str** | Recent lowest ask | [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** | 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 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 e1a1269..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 6ccc74d..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] -**create_time_ms** | **str** | Trading time, with millisecond precision. | [optional] -**currency_pair** | **str** | Currency pair. | [optional] -**side** | **str** | Buy or sell order. | [optional] -**role** | **str** | Trade role. No value 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] -**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] +**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** | 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, 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** | 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 f887e70..4914a3f 100644 --- a/docs/TradeFee.md +++ b/docs/TradeFee.md @@ -3,18 +3,18 @@ ## Properties 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] +**user_id** | **int** | User ID | [optional] +**taker_fee** | **str** | taker fee rate | [optional] +**maker_fee** | **str** | maker fee rate | [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] -**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] +**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 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 b8ea4fb..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 5ab897e..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 | -**_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** | **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 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 index 1747331..ff17da4 100644 --- a/docs/TransferOrderStatus.md +++ b/docs/TransferOrderStatus.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] +**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/TransferablesResult.md b/docs/TransferablesResult.md index fb48a0a..87b8b07 100644 --- a/docs/TransferablesResult.md +++ b/docs/TransferablesResult.md @@ -1,11 +1,11 @@ # TransferablesResult -Batch query unified account can be transferred up to a maximum of results. +Batch query unified account maximum transferable results ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**amount** | **str** | The maximum amount that can be transferred out. | [optional] +**currency** | **str** | Currency detail | [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/TriggerOrderResponse.md b/docs/TriggerOrderResponse.md index 6df39d4..6f44aa3 100644 --- a/docs/TriggerOrderResponse.md +++ b/docs/TriggerOrderResponse.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Auto order ID. | [optional] +**id** | **int** | Auto 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/TriggerTime.md b/docs/TriggerTime.md index abec3d8..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 4b58560..25eb840 100644 --- a/docs/UidPushOrder.md +++ b/docs/UidPushOrder.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Order ID. | [optional] -**push_uid** | **int** | Initiator User ID. | [optional] -**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] -**transaction_type** | **str** | Order Type. | [optional] +**id** | **int** | Order ID | [optional] +**push_uid** | **int** | Initiator User ID | [optional] +**receive_uid** | **int** | Recipient User ID | [optional] +**currency** | **str** | Currency name | [optional] +**amount** | **str** | Transfer amount | [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/UidPushWithdrawal.md b/docs/UidPushWithdrawal.md index 6b60d98..2510006 100644 --- a/docs/UidPushWithdrawal.md +++ b/docs/UidPushWithdrawal.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**receive_uid** | **int** | Recipient UID. | -**currency** | **str** | Currency name. | -**amount** | **str** | Transfer amount. | +**receive_uid** | **int** | Recipient UID | +**currency** | **str** | Currency name | +**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/UidPushWithdrawalResp.md b/docs/UidPushWithdrawalResp.md index ff67310..5363c0f 100644 --- a/docs/UidPushWithdrawalResp.md +++ b/docs/UidPushWithdrawalResp.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Order ID. | [optional] +**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/UniCurrency.md b/docs/UniCurrency.md index b292331..02ea971 100644 --- a/docs/UniCurrency.md +++ b/docs/UniCurrency.md @@ -1,14 +1,14 @@ # UniCurrency -Currency detail. +Currency detail ## Properties 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] -**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] +**currency** | **str** | Currency name | [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] [[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/UniCurrencyInterest.md b/docs/UniCurrencyInterest.md index 9cdac87..96c01fc 100644 --- a/docs/UniCurrencyInterest.md +++ b/docs/UniCurrencyInterest.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] [readonly] +**currency** | **str** | Currency | [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/UniCurrencyPair.md b/docs/UniCurrencyPair.md index 1f9577a..4e0d0c6 100644 --- a/docs/UniCurrencyPair.md +++ b/docs/UniCurrencyPair.md @@ -1,13 +1,13 @@ # UniCurrencyPair -Currency pair of the loan. +Currency pair of the loan ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency_pair** | **str** | Currency pair. | [optional] [readonly] -**base_min_borrow_amount** | **str** | Minimum borrow amount of base currency. | [optional] [readonly] -**quote_min_borrow_amount** | **str** | Minimum borrow amount of quote currency. | [optional] [readonly] -**leverage** | **str** | Position leverage. | [optional] [readonly] +**currency_pair** | **str** | Currency pair | [optional] [readonly] +**base_min_borrow_amount** | **str** | Minimum borrow amount of base currency | [optional] [readonly] +**quote_min_borrow_amount** | **str** | Minimum borrow amount of quote currency | [optional] [readonly] +**leverage** | **str** | Position leverage | [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 380e96f..9486ec0 100644 --- a/docs/UniInterestRecord.md +++ b/docs/UniInterestRecord.md @@ -1,15 +1,15 @@ # UniInterestRecord -Interest Record. +Interest Record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **int** | Status: 0 - fail, 1 - success. | [optional] [readonly] -**currency** | **str** | Currency. | [optional] [readonly] -**actual_rate** | **str** | Actual Rate. | [optional] [readonly] -**interest** | **str** | Interest. | [optional] [readonly] +**status** | **int** | Status: 0 - fail, 1 - success | [optional] [readonly] +**currency** | **str** | Currency | [optional] [readonly] +**actual_rate** | **str** | Actual Rate | [optional] [readonly] +**interest** | **str** | Interest | [optional] [readonly] **interest_status** | **str** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] -**create_time** | **int** | Created time. | [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 71024a2..7080ac5 100644 --- a/docs/UniLend.md +++ b/docs/UniLend.md @@ -1,19 +1,19 @@ # UniLend -Loan record. +Loan record ## Properties 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] -**min_rate** | **str** | Minimum interest rate. | [optional] [readonly] +**currency** | **str** | Currency | [optional] [readonly] +**current_amount** | **str** | Current 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 - Normal 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] +**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 552f3ed..899acfb 100644 --- a/docs/UniLendInterest.md +++ b/docs/UniLendInterest.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency. | [optional] [readonly] -**interest** | **str** | Interest. | [optional] [readonly] +**currency** | **str** | Currency | [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 69046fe..39c187a 100644 --- a/docs/UniLendRecord.md +++ b/docs/UniLendRecord.md @@ -1,16 +1,16 @@ # 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] -**create_time** | **int** | Created time. | [optional] [readonly] +**currency** | **str** | Currency name | [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 5ba0c26..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] -**create_time** | **int** | Created time. | [optional] [readonly] -**update_time** | **int** | Updated time. | [optional] [readonly] +**currency** | **str** | Currency | [optional] [readonly] +**currency_pair** | **str** | Currency pair | [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** | 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 ba2d464..e93539b 100644 --- a/docs/UniLoanInterestRecord.md +++ b/docs/UniLoanInterestRecord.md @@ -1,16 +1,16 @@ # 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] -**interest** | **str** | Interest. | [optional] [readonly] -**status** | **int** | Status: 0 - fail, 1 - success. | [optional] [readonly] -**type** | **str** | Type, platform - platform,margin - margin. | [optional] [readonly] -**create_time** | **int** | Created time. | [optional] [readonly] +**currency** | **str** | Currency name | [optional] [readonly] +**currency_pair** | **str** | Currency pair | [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 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 4168177..b34be2c 100644 --- a/docs/UniLoanRecord.md +++ b/docs/UniLoanRecord.md @@ -1,14 +1,14 @@ # UniLoanRecord -Loan records. +Borrowing Records ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] -**create_time** | **int** | Created time. | [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** | 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 c23f933..4d2d24b 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -3,26 +3,26 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_id** | **int** | User ID. | [optional] -**refresh_time** | **int** | Time of the most recent refresh. | [optional] +**user_id** | **int** | User ID | [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] -**is_all_collateral** | **bool** | Whether all currencies are used as margin, true - false - No | [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 f6b4d58..5c23e08 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -4,36 +4,36 @@ 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. -[**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. -[**get_unified_transferables**](UnifiedApi.md#get_unified_transferables) | **GET** /unified/transferables | Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. -[**get_unified_borrowable_list**](UnifiedApi.md#get_unified_borrowable_list) | **GET** /unified/batch_borrowable | Batch query unified account can be borrowed up to a maximum. -[**list_unified_loans**](UnifiedApi.md#list_unified_loans) | **GET** /unified/loans | List 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 | 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. -[**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 | 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 the leverage multiple of the user currency. -[**set_user_leverage_currency_setting**](UnifiedApi.md#set_user_leverage_currency_setting) | **POST** /unified/leverage/user_currency_setting | Set the 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**](UnifiedApi.md#list_unified_accounts) | **GET** /unified/accounts | Get unified account information +[**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 | 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 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 | 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, sub_uid=sub_uid) -Get unified account information. +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 @@ -59,11 +59,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) -currency = 'BTC' # str | Retrieve data of the specified currency. (optional) -sub_uid = '10001' # str | Sub account user ID. (optional) +currency = 'BTC' # str | Query by specified currency name (optional) +sub_uid = '10001' # str | Sub account user ID (optional) try: - # Get unified account information. + # Get unified account information api_response = api_instance.list_unified_accounts(currency=currency, sub_uid=sub_uid) print(api_response) except GateApiException as ex: @@ -76,8 +76,8 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Retrieve data of the specified currency. | [optional] - **sub_uid** | **str**| Sub account user ID. | [optional] + **currency** | **str**| Query by specified currency name | [optional] + **sub_uid** | **str**| Sub account user ID | [optional] ### Return type @@ -95,14 +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) # **get_unified_borrowable** > UnifiedBorrowable get_unified_borrowable(currency) -Query about the maximum borrowing for the unified account. +Query maximum borrowable amount for unified account ### Example @@ -128,10 +128,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) -currency = 'BTC' # str | Retrieve data of the specified currency. +currency = 'BTC' # str | Query by specified currency name try: - # Query about the maximum borrowing for the unified account. + # Query maximum borrowable amount for unified account api_response = api_instance.get_unified_borrowable(currency) print(api_response) except GateApiException as ex: @@ -144,7 +144,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Retrieve data of the specified currency. | + **currency** | **str**| Query by specified currency name | ### Return type @@ -162,14 +162,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) -Query about the maximum transferable for the unified account. +Query maximum transferable amount for unified account ### Example @@ -195,10 +195,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) -currency = 'BTC' # str | Retrieve data of the specified currency. +currency = 'BTC' # str | Query by specified currency name try: - # Query about the maximum transferable for the unified account. + # Query maximum transferable amount for unified account api_response = api_instance.get_unified_transferable(currency) print(api_response) except GateApiException as ex: @@ -211,7 +211,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Retrieve data of the specified currency. | + **currency** | **str**| Query by specified currency name | ### Return type @@ -229,14 +229,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_transferables** > list[TransferablesResult] get_unified_transferables(currencies) -Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. +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 @@ -262,10 +262,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,ETH' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. +currencies = 'BTC,ETH' # str | Specify the currency name to query in batches, and support up to 100 pass parameters at a time try: - # Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. + # 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: @@ -278,7 +278,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | + **currencies** | **str**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | ### Return type @@ -296,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_borrowable_list** > list[UnifiedBorrowable1] get_unified_borrowable_list(currencies) -Batch query unified account can be borrowed up to a maximum. +Batch query unified account maximum borrowable amount ### Example @@ -329,10 +329,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: - # Batch query unified account can be borrowed up to a maximum. + # Batch query unified account maximum borrowable amount api_response = api_instance.get_unified_borrowable_list(currencies) print(api_response) except GateApiException as ex: @@ -345,7 +345,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 @@ -363,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 @@ -396,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) -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) +currency = 'BTC' # str | Query by specified currency name (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) +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: @@ -415,10 +415,10 @@ except ApiException as e: 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] - **type** | **str**| Loan type, platform - platform, margin - margin. | [optional] + **currency** | **str**| Query by specified currency name | [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] + **type** | **str**| Loan type: platform borrowing - platform, margin borrowing - margin | [optional] ### Return type @@ -436,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** > UnifiedLoanResult create_unified_loan(unified_loan) -Borrow or repay. +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 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 @@ -474,7 +474,7 @@ api_instance = gate_api.UnifiedApi(api_client) unified_loan = gate_api.UnifiedLoan() # UnifiedLoan | try: - # Borrow or repay. + # Borrow or repay api_response = api_instance.create_unified_loan(unified_loan) print(api_response) except GateApiException as ex: @@ -505,14 +505,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_unified_loan_records** > list[UnifiedLoanRecord] list_unified_loan_records(type=type, currency=currency, page=page, limit=limit) -Get load records. +Query loan records ### Example @@ -538,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, repaying the borrowed funds (optional) -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) +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 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: @@ -557,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, repaying the borrowed funds | [optional] - **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] + **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 number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -578,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 @@ -611,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) -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) +currency = 'BTC' # str | Query by specified currency name (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) +_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: @@ -632,12 +632,12 @@ except ApiException as e: 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 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] + **currency** | **str**| Query by specified currency name | [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] + **_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 @@ -655,16 +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() -Get user risk unit details. +Get user risk unit details -Retrieve user risk unit details, only valid in portfolio margin mode. +Get user risk unit details, only valid in portfolio margin mode ### Example @@ -692,7 +692,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.UnifiedApi(api_client) try: - # Get user risk unit details. + # Get user risk unit details api_response = api_instance.get_unified_risk_units() print(api_response) except GateApiException as ex: @@ -720,14 +720,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_unified_mode** > UnifiedModeSet get_unified_mode() -Query mode of the unified account. +Query mode of the unified account Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode @@ -757,7 +757,7 @@ api_client = gate_api.ApiClient(configuration) api_instance = gate_api.UnifiedApi(api_client) try: - # Query mode of the unified account. + # Query mode of the unified account api_response = api_instance.get_unified_mode() print(api_response) except GateApiException as ex: @@ -785,14 +785,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_mode** > set_unified_mode(unified_mode_set) -Set mode of the unified account. +Set unified account mode 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\" } ``` @@ -823,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)) @@ -853,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 @@ -888,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: @@ -904,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 @@ -922,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 @@ -948,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: @@ -976,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 @@ -1002,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: @@ -1030,16 +1030,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) # **calculate_portfolio_margin** > UnifiedPortfolioOutput calculate_portfolio_margin(unified_portfolio_input) -Portfolio margin calculator. +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 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 @@ -1059,7 +1059,7 @@ api_instance = gate_api.UnifiedApi(api_client) unified_portfolio_input = gate_api.UnifiedPortfolioInput() # UnifiedPortfolioInput | try: - # Portfolio margin calculator. + # Portfolio margin calculator api_response = api_instance.calculate_portfolio_margin(unified_portfolio_input) print(api_response) except GateApiException as ex: @@ -1090,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) -Minimum currency leverage that can be set. +Maximum and minimum currency leverage that can be set ### Example @@ -1123,10 +1123,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) -currency = 'BTC' # str | Currency. +currency = 'BTC' # str | Currency try: - # Minimum currency leverage that can be set. + # 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: @@ -1139,7 +1139,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | + **currency** | **str**| Currency | ### Return type @@ -1157,16 +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 the leverage multiple of the user 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 @@ -1192,10 +1192,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) -currency = 'BTC' # str | Currency. (optional) +currency = 'BTC' # str | Currency (optional) try: - # Get the leverage multiple of the user currency. + # Get user currency leverage api_response = api_instance.get_user_leverage_currency_setting(currency=currency) print(api_response) except GateApiException as ex: @@ -1208,11 +1208,11 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | [optional] + **currency** | **str**| Currency | [optional] ### Return type -[**UnifiedLeverageSetting**](UnifiedLeverageSetting.md) +[**list[UnifiedLeverageSetting]**](UnifiedLeverageSetting.md) ### Authorization @@ -1226,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) -Set the loan currency leverage. +Set loan currency leverage ### Example @@ -1262,7 +1262,7 @@ api_instance = gate_api.UnifiedApi(api_client) unified_leverage_setting = gate_api.UnifiedLeverageSetting() # UnifiedLeverageSetting | try: - # Set the loan currency leverage. + # 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)) @@ -1292,14 +1292,14 @@ 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. +List of loan currencies supported by unified account ### Example @@ -1316,10 +1316,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) -currency = 'BTC' # str | Currency. (optional) +currency = 'BTC' # str | Currency (optional) try: - # List of loan currencies supported by unified account. + # List of loan currencies supported by unified account api_response = api_instance.list_unified_currencies(currency=currency) print(api_response) except GateApiException as ex: @@ -1332,7 +1332,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency. | [optional] + **currency** | **str**| Currency | [optional] ### Return type @@ -1350,14 +1350,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_history_loan_rate** > UnifiedHistoryLoanRate get_history_loan_rate(currency, tier=tier, page=page, limit=limit) -get historical lending rates. +Get historical lending rates ### Example @@ -1374,13 +1374,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 = '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) +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. + # 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: @@ -1393,10 +1393,10 @@ except ApiException as e: 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] + **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 @@ -1414,14 +1414,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) # **set_unified_collateral** > UnifiedCollateralRes set_unified_collateral(unified_collateral_req) -Set Collateral Currency. +Set collateral currency ### Example @@ -1450,7 +1450,7 @@ api_instance = gate_api.UnifiedApi(api_client) unified_collateral_req = gate_api.UnifiedCollateralReq() # UnifiedCollateralReq | try: - # Set Collateral Currency. + # Set collateral currency api_response = api_instance.set_unified_collateral(unified_collateral_req) print(api_response) except GateApiException as ex: @@ -1481,7 +1481,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | UpdateSuccess. | - | +**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 089024e..748cf98 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -3,26 +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** | Uniloan financial management amount, effective when turned on as a unified account margin switch | [optional] -**funding_version** | **str** | Funding version. | [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** | The full position maintains margin, which is valid in the single currency margin mode, and other cross-currency margin combination margin mode is 0. | [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] -**enabled_collateral** | **bool** | Currency enabled as margin: true - Enabled, false - Disabled. | [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/UnifiedBorrowable.md b/docs/UnifiedBorrowable.md index 586ef0e..edd2c95 100644 --- a/docs/UnifiedBorrowable.md +++ b/docs/UnifiedBorrowable.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**amount** | **str** | Max borrowable amount. | [optional] +**currency** | **str** | Currency detail | [optional] +**amount** | **str** | Max 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/UnifiedBorrowable1.md b/docs/UnifiedBorrowable1.md index ef1e387..81b38b3 100644 --- a/docs/UnifiedBorrowable1.md +++ b/docs/UnifiedBorrowable1.md @@ -1,11 +1,11 @@ # UnifiedBorrowable1 -Batch query unified account can be borrowed up to a maximum of results. +Batch query unified account maximum borrowable results ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**amount** | **str** | The maximum amount to borrow. | [optional] +**currency** | **str** | Currency detail | [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 index b4b0d43..fc1976a 100644 --- a/docs/UnifiedCollateralReq.md +++ b/docs/UnifiedCollateralReq.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateral_type** | **int** | User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid | [optional] -**enable_list** | **list[str]** | Currency list, where collateral_type=1(custom) indicates the logic of addition | [optional] -**disable_list** | **list[str]** | Cancellation list, indicating the logic of cancellation. | [optional] +**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 index 15a28a1..7432c38 100644 --- a/docs/UnifiedCollateralRes.md +++ b/docs/UnifiedCollateralRes.md @@ -1,10 +1,10 @@ # UnifiedCollateralRes -Return of unified account collateral mode settings. +Unified account collateral mode settings response ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**is_success** | **bool** | Whether the setting was successful. | [optional] +**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 index cc9f22c..db33f77 100644 --- a/docs/UnifiedCurrency.md +++ b/docs/UnifiedCurrency.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Currency name. | [optional] -**prec** | **str** | Currency precision. | [optional] -**min_borrow_amount** | **str** | The minimum debit limit is the unit of currency. | [optional] -**user_max_borrow_amount** | **str** | The minimum debit limit is the unit of currency. | [optional] -**total_max_borrow_amount** | **str** | The maximum debit limit for the platform is USDT. | [optional] -**loan_status** | **str** | Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending | [optional] +**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 635a46d..a242849 100644 --- a/docs/UnifiedDiscount.md +++ b/docs/UnifiedDiscount.md @@ -1,11 +1,11 @@ # UnifiedDiscount -Currency discount tiers. +Unified account tiered discount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency name. | [optional] -**discount_tiers** | [**list[UnifiedDiscountTiers]**](UnifiedDiscountTiers.md) | Tiered discount. | [optional] +**currency** | **str** | Currency name | [optional] +**discount_tiers** | [**list[UnifiedDiscountTiers]**](UnifiedDiscountTiers.md) | Tiered discount | [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/UnifiedDiscountTiers.md b/docs/UnifiedDiscountTiers.md index 2cfb6e8..ba78cc7 100644 --- a/docs/UnifiedDiscountTiers.md +++ b/docs/UnifiedDiscountTiers.md @@ -3,11 +3,11 @@ ## Properties 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] -**leverage** | **str** | Position leverage. | [optional] +**tier** | **str** | Tier | [optional] +**discount** | **str** | Discount | [optional] +**lower_limit** | **str** | Lower limit | [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 78de5ce..4414cf5 100644 --- a/docs/UnifiedHistoryLoanRate.md +++ b/docs/UnifiedHistoryLoanRate.md @@ -3,10 +3,10 @@ ## Properties 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] +**currency** | **str** | Currency name | [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 e14fa78..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 8f6e458..4f70f0d 100644 --- a/docs/UnifiedLeverageConfig.md +++ b/docs/UnifiedLeverageConfig.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**current_leverage** | **str** | Current leverage ratio. | [optional] -**min_leverage** | **str** | Minimum adjustable leverage ratio. | [optional] -**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 be borrowed, whichever is smaller | [optional] +**current_leverage** | **str** | Current leverage ratio | [optional] +**min_leverage** | **str** | Minimum adjustable leverage ratio | [optional] +**max_leverage** | **str** | Maximum adjustable leverage ratio | [optional] +**debit** | **str** | Current liabilities | [optional] +**available_margin** | **str** | Available Margin | [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 b62d735..63a8b10 100644 --- a/docs/UnifiedLeverageSetting.md +++ b/docs/UnifiedLeverageSetting.md @@ -1,11 +1,11 @@ # UnifiedLeverageSetting -Loan currency leverage. +Leverage multiplier for borrowing currency ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency name. | -**leverage** | **str** | multiple. | +**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 93dc10c..0f950f3 100644 --- a/docs/UnifiedLoan.md +++ b/docs/UnifiedLoan.md @@ -1,14 +1,14 @@ # UnifiedLoan -Borrow or repay. +Borrow or repay ## Properties 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] -**text** | **str** | User defined custom ID. | [optional] +**currency** | **str** | Currency | +**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 cff2542..29d2159 100644 --- a/docs/UnifiedLoanRecord.md +++ b/docs/UnifiedLoanRecord.md @@ -1,17 +1,17 @@ # 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 after withdrawal, different_currencies_repayment - Different currency repayment | [optional] [readonly] -**borrow_type** | **str** | Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment | [optional] -**currency_pair** | **str** | Currency pair. | [optional] [readonly] -**currency** | **str** | Currency. | [optional] [readonly] -**amount** | **str** | The amount of lending or repaying. | [optional] [readonly] -**create_time** | **int** | Created time. | [optional] [readonly] +**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** | 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 index 3c8a6aa..8db1d72 100644 --- a/docs/UnifiedLoanResult.md +++ b/docs/UnifiedLoanResult.md @@ -1,10 +1,10 @@ # UnifiedLoanResult -Unified account loan and repayment response results. +Unified account borrowing and repayment response result ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tran_id** | **int** | Transaction id. | [optional] +**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 e9009f2..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] +**currency** | **str** | Currency name | [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 6f32795..465188f 100644 --- a/docs/UnifiedPortfolioInput.md +++ b/docs/UnifiedPortfolioInput.md @@ -1,16 +1,16 @@ # UnifiedPortfolioInput -Input for the portfolio margin calculator. +Portfolio margin calculator input ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**spot_balances** | [**list[MockSpotBalance]**](MockSpotBalance.md) | Spot. | [optional] -**spot_orders** | [**list[MockSpotOrder]**](MockSpotOrder.md) | Spot orders. | [optional] -**futures_positions** | [**list[MockFuturesPosition]**](MockFuturesPosition.md) | Futures positions. | [optional] -**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_balances** | [**list[MockSpotBalance]**](MockSpotBalance.md) | Spot | [optional] +**spot_orders** | [**list[MockSpotOrder]**](MockSpotOrder.md) | Spot orders | [optional] +**futures_positions** | [**list[MockFuturesPosition]**](MockFuturesPosition.md) | Futures positions | [optional] +**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] [[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 e711905..08d671a 100644 --- a/docs/UnifiedPortfolioOutput.md +++ b/docs/UnifiedPortfolioOutput.md @@ -1,13 +1,13 @@ # 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, orders. | [optional] -**calculate_time** | **int** | Calculate time. | [optional] -**risk_unit** | [**list[MockRiskUnit]**](MockRiskUnit.md) | Risk unit. | [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 06882fa..ef263da 100644 --- a/docs/UnifiedRiskUnits.md +++ b/docs/UnifiedRiskUnits.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user_id** | **int** | User ID. | [optional] -**spot_hedge** | **bool** | Spot hedging status, true - enabled, false - not enabled. | [optional] -**risk_units** | [**list[RiskUnits]**](RiskUnits.md) | Risk unit. | [optional] +**user_id** | **int** | User ID | [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 1375e15..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** | Spot hedging switch. | [optional] -**use_funding** | **bool** | switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds 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 4aaa663..1d07c53 100644 --- a/docs/UnifiedTransferable.md +++ b/docs/UnifiedTransferable.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **str** | Currency detail. | [optional] -**amount** | **str** | The maximum amount that can be transferred out. | [optional] +**currency** | **str** | Currency detail | [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 09e7c50..1483aff 100644 --- a/docs/UserLtvInfo.md +++ b/docs/UserLtvInfo.md @@ -1,16 +1,16 @@ # UserLtvInfo -User's currency statistics data. +User's currency statistics data ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateral_currency** | **str** | Collateral. | [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] -**min_borrow_amount** | **str** | Minimum borrowable amount for the loan currency. | [optional] -**left_borrowable_amount** | **str** | Remaining borrowable amount for the loan currency. | [optional] +**collateral_currency** | **str** | Collateral currency | [optional] +**borrow_currency** | **str** | Borrowed currency | [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] [[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/UserSub.md b/docs/UserSub.md index 9aefe18..c5432f0 100644 --- a/docs/UserSub.md +++ b/docs/UserSub.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **int** | User ID. | [optional] -**belong** | **str** | The system to which the user belongs (partner referral). If empty, it means not belonging to any system. | [optional] -**type** | **int** | Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct customer 4-indirect direct customer 5-ordinary user) | [optional] -**ref_uid** | **int** | Inviter user ID. | [optional] +**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 index 7eeaf25..912227c 100644 --- a/docs/UserSubRelation.md +++ b/docs/UserSubRelation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**list** | [**list[UserSub]**](UserSub.md) | Subordinate relationship list. | [optional] +**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 0582c8e..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 a3a6706..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. -[**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. -[**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. -[**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. -[**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_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 | 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 | 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 | 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 | 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 @@ -47,10 +47,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 = 'GT' # str | Currency name. +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: @@ -63,7 +63,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency name. | + **currency** | **str**| Currency name | ### Return type @@ -81,14 +81,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_deposit_address** > DepositAddress get_deposit_address(currency) -Generate currency deposit address. +Generate currency deposit address ### Example @@ -114,10 +114,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 name. +currency = 'USDT' # str | Currency name try: - # Generate currency deposit address. + # Generate currency deposit address api_response = api_instance.get_deposit_address(currency) print(api_response) except GateApiException as ex: @@ -130,7 +130,7 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Currency name. | + **currency** | **str**| Currency name | ### Return type @@ -148,16 +148,16 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Address successfully generated. | - | +**200** | Address successfully generated | - | [[Back to top]](#) [[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, 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,17 +183,17 @@ 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) -withdraw_id = 'withdraw_id_example' # str | The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time (optional) -asset_class = 'asset_class_example' # str | The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas 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 when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried (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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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. + # 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: @@ -206,14 +206,14 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| Filter by currency. Return all currency records if not specified. | [optional] - **withdraw_id** | **str**| The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time | [optional] - **asset_class** | **str**| The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone | [optional] - **withdraw_order_id** | **str**| User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried | [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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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 @@ -231,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[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 @@ -266,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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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: @@ -286,11 +286,11 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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 @@ -308,16 +308,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) # **transfer** > TransactionID transfer(transfer) -Transfer between trading accounts. +Transfer between trading accounts -Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. 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 @@ -346,7 +346,7 @@ api_instance = gate_api.WalletApi(api_client) transfer = gate_api.Transfer() # Transfer | try: - # Transfer between trading accounts. + # Transfer between trading accounts api_response = api_instance.transfer(transfer) print(api_response) except GateApiException as ex: @@ -377,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[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 20-04-10can be retrieved +Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved ### Example @@ -412,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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) +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: @@ -432,11 +432,11 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] + **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 @@ -454,16 +454,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) # **transfer_with_sub_account** > TransactionID transfer_with_sub_account(sub_account_transfer) -Transfer between main and sub accounts. +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 @@ -492,7 +492,7 @@ api_instance = gate_api.WalletApi(api_client) sub_account_transfer = gate_api.SubAccountTransfer() # SubAccountTransfer | try: - # Transfer between main and sub accounts. + # Transfer between main and sub accounts api_response = api_instance.transfer_with_sub_account(sub_account_transfer) print(api_response) except GateApiException as ex: @@ -523,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 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 @@ -561,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: @@ -592,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** > TransferOrderStatus get_transfer_order_status(client_order_id=client_order_id, tx_id=tx_id) -Transfer status query. +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 @@ -627,11 +627,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) -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. + # Transfer status query api_response = api_instance.get_transfer_order_status(client_order_id=client_order_id, tx_id=tx_id) print(api_response) except GateApiException as ex: @@ -644,8 +644,8 @@ 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 @@ -663,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 @@ -696,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: @@ -712,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 @@ -730,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 @@ -763,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: @@ -779,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 @@ -797,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 @@ -830,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: @@ -846,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 @@ -864,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 @@ -897,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: @@ -914,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 @@ -933,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 @@ -966,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: @@ -982,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 @@ -1000,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 @@ -1033,13 +1033,13 @@ 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. -chain = '' # str | Chain name. (optional) (default to '') -limit = '50' # str | Maximum number returned, 100 at most. (optional) (default to '50') -page = 1 # int | Page number. (optional) (default to 1) +currency = 'USDT' # str | Currency +chain = '' # str | Chain name (optional) (default to '') +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: @@ -1052,10 +1052,10 @@ except ApiException as e: 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'] - **page** | **int**| Page number. | [optional] [default to 1] + **currency** | **str**| Currency | + **chain** | **str**| Chain name | [optional] [default to ''] + **limit** | **str**| Maximum number returned, up to 100 | [optional] [default to '50'] + **page** | **int**| Page number | [optional] [default to 1] ### Return type @@ -1073,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 @@ -1106,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: @@ -1123,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 @@ -1142,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` /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 @@ -1177,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: @@ -1193,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 @@ -1211,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 @@ -1246,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: @@ -1274,14 +1274,14 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **convert_small_balance** > convert_small_balance(convert_small_balance) -Convert small balance. +Convert small balance currency ### Example @@ -1310,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)) @@ -1340,14 +1340,14 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **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 @@ -1373,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) -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) +currency = 'currency_example' # str | Currency to convert (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: - # 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: @@ -1391,9 +1391,9 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **str**| 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] + **currency** | **str**| Currency to convert | [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 @@ -1411,14 +1411,14 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_push_orders** > 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 @@ -1444,15 +1444,15 @@ configuration = gate_api.Configuration( 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) -offset = 0 # int | List offset, starting from 0. (optional) (default to 0) -transaction_type = 'withdraw' # str | The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. (optional) (default to 'withdraw') +id = 56 # int | Order ID (optional) +_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. + # 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: @@ -1465,12 +1465,12 @@ 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] - **offset** | **int**| List offset, starting from 0. | [optional] [default to 0] - **transaction_type** | **str**| The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. | [optional] [default to 'withdraw'] + **id** | **int**| Order ID | [optional] + **_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 @@ -1488,7 +1488,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/WithdrawStatus.md b/docs/WithdrawStatus.md index 50ae2ab..38ade7b 100644 --- a/docs/WithdrawStatus.md +++ b/docs/WithdrawStatus.md @@ -3,18 +3,18 @@ ## Properties 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] -**withdraw_percent** | **str** | Withdrawal fee rate percentage. | [optional] -**withdraw_fix** | **str** | Fixed withdrawal fee. | [optional] -**withdraw_day_limit** | **str** | Daily allowed withdrawal amount. | [optional] -**withdraw_amount_mini** | **str** | Minimum withdrawal amount. | [optional] -**withdraw_day_limit_remain** | **str** | Daily withdrawal amount left. | [optional] -**withdraw_eachtime_limit** | **str** | Maximum amount for each withdrawal. | [optional] -**withdraw_fix_on_chains** | **dict(str, str)** | Fixed withdrawal fee on multiple chains. | [optional] -**withdraw_percent_on_chains** | **dict(str, str)** | Percentage withdrawal fee on multiple chains. | [optional] +**currency** | **str** | Currency | [optional] +**name** | **str** | Currency name | [optional] +**name_cn** | **str** | Currency Chinese name | [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] +**withdraw_amount_mini** | **str** | Minimum withdrawal amount | [optional] +**withdraw_day_limit_remain** | **str** | Daily withdrawal amount left | [optional] +**withdraw_eachtime_limit** | **str** | Maximum amount for each withdrawal | [optional] +**withdraw_fix_on_chains** | **dict(str, str)** | Fixed withdrawal fee on multiple chains | [optional] +**withdraw_percent_on_chains** | **dict(str, str)** | Percentage withdrawal fee on multiple chains | [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/WithdrawalApi.md b/docs/WithdrawalApi.md index 33fb990..1c49178 100644 --- a/docs/WithdrawalApi.md +++ b/docs/WithdrawalApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw. -[**withdraw_push_order**](WithdrawalApi.md#withdraw_push_order) | **POST** /withdrawals/push | UID transfer. -[**cancel_withdrawal**](WithdrawalApi.md#cancel_withdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID. +[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw +[**withdraw_push_order**](WithdrawalApi.md#withdraw_push_order) | **POST** /withdrawals/push | UID transfer +[**cancel_withdrawal**](WithdrawalApi.md#cancel_withdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID # **withdraw** > LedgerRecord withdraw(ledger_record) -Withdraw. +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 @@ -43,7 +43,7 @@ api_instance = gate_api.WithdrawalApi(api_client) ledger_record = gate_api.LedgerRecord() # LedgerRecord | try: - # Withdraw. + # Withdraw api_response = api_instance.withdraw(ledger_record) print(api_response) except GateApiException as ex: @@ -74,16 +74,16 @@ 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) # **withdraw_push_order** > UidPushWithdrawalResp withdraw_push_order(uid_push_withdrawal) -UID transfer. +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 @@ -112,7 +112,7 @@ api_instance = gate_api.WithdrawalApi(api_client) uid_push_withdrawal = gate_api.UidPushWithdrawal() # UidPushWithdrawal | try: - # UID transfer. + # UID transfer api_response = api_instance.withdraw_push_order(uid_push_withdrawal) print(api_response) except GateApiException as ex: @@ -143,14 +143,14 @@ 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) # **cancel_withdrawal** > LedgerRecord cancel_withdrawal(withdrawal_id) -Cancel withdrawal with specified ID. +Cancel withdrawal with specified ID ### Example @@ -179,7 +179,7 @@ api_instance = gate_api.WithdrawalApi(api_client) withdrawal_id = '210496' # str | try: - # Cancel withdrawal with specified ID. + # Cancel withdrawal with specified ID api_response = api_instance.cancel_withdrawal(withdrawal_id) print(api_response) except GateApiException as ex: @@ -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 bb88a26..9cb30af 100644 --- a/docs/WithdrawalRecord.md +++ b/docs/WithdrawalRecord.md @@ -3,20 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Record ID. | [optional] [readonly] -**txid** | **str** | Hash record of the withdrawal. | [optional] [readonly] -**block_number** | **str** | Block Number. | [optional] [readonly] +**id** | **str** | Record ID | [optional] [readonly] +**txid** | **str** | Hash record of the withdrawal | [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. | -**fee** | **str** | fee. | [optional] [readonly] -**currency** | **str** | Currency name. | -**address** | **str** | Withdrawal address. | [optional] -**fail_reason** | **str** | The reason for withdrawal failure is that there is a value when status = CANCEL, and the rest of the state is empty | [optional] -**timestamp2** | **str** | The withdrawal end time, i.e.: withdrawal cancel time or withdrawal success time When status = CANCEL, the corresponding cancel time When status = DONE and block_number > 0, it is the | [optional] -**memo** | **str** | Additional remarks with regards to the withdrawal. | [optional] +**timestamp** | **str** | Operation time | [optional] [readonly] +**amount** | **str** | Token amount | +**fee** | **str** | fee | [optional] [readonly] +**currency** | **str** | Currency name | +**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** | 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. | +**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 140abbc..060b069 100644 --- a/gate_api/__init__.py +++ b/gate_api/__init__.py @@ -5,7 +5,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -14,7 +14,7 @@ from __future__ import absolute_import -__version__ = "6.102.6" +__version__ = "7.1.8" # import apis into sdk package from gate_api.api.earn_uni_api import EarnUniApi @@ -138,6 +138,7 @@ from gate_api.models.futures_ticker import FuturesTicker from gate_api.models.futures_trade import FuturesTrade from gate_api.models.index_constituent import IndexConstituent +from gate_api.models.inline_object import InlineObject from gate_api.models.inline_response200 import InlineResponse200 from gate_api.models.inline_response2001 import InlineResponse2001 from gate_api.models.insurance_record import InsuranceRecord diff --git a/gate_api/api/account_api.py b/gate_api/api/account_api.py index c6a5f87..5f381d6 100644 --- a/gate_api/api/account_api.py +++ b/gate_api/api/account_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -140,7 +140,7 @@ def get_account_detail_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_account_rate_limit(self, **kwargs): # noqa: E501 - """Get user transaction rate limit information. # noqa: E501 + """Get user transaction rate limit information # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -163,7 +163,7 @@ def get_account_rate_limit(self, **kwargs): # noqa: E501 return self.get_account_rate_limit_with_http_info(**kwargs) # noqa: E501 def get_account_rate_limit_with_http_info(self, **kwargs): # noqa: E501 - """Get user transaction rate limit information. # noqa: E501 + """Get user transaction rate limit 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,9 +353,9 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.create_stp_group(stp_group, async_req=True) @@ -378,9 +378,9 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.create_stp_group_with_http_info(stp_group, async_req=True) @@ -471,16 +471,16 @@ 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 can query the account. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int stp_id: STP Group ID. (required) + :param int stp_id: STP Group ID (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -496,16 +496,16 @@ 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 can query the account. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int stp_id: STP Group ID. (required) + :param int stp_id: STP Group 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 @@ -585,17 +585,17 @@ 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 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int stp_id: STP Group ID. (required) - :param list[int] request_body: User ID. (required) + :param int stp_id: STP Group ID (required) + :param list[int] request_body: User ID (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -611,17 +611,17 @@ 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 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int stp_id: STP Group ID. (required) - :param list[int] request_body: User ID. (required) + :param int stp_id: STP Group ID (required) + :param list[int] request_body: 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 @@ -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 @@ -721,8 +721,8 @@ def delete_stp_group_users(self, stp_id, user_id, **kwargs): # noqa: E501 >>> result = thread.get() :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 stp_id: STP Group ID (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 @@ -747,8 +747,8 @@ def delete_stp_group_users_with_http_info(self, stp_id, user_id, **kwargs): # n >>> result = thread.get() :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 stp_id: STP Group ID (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) @@ -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) @@ -940,9 +940,9 @@ def get_debit_fee_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def set_debit_fee(self, debit_fee, **kwargs): # noqa: E501 - """Set GT deduction. # 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(debit_fee, async_req=True) @@ -965,9 +965,9 @@ def set_debit_fee(self, debit_fee, **kwargs): # noqa: E501 return self.set_debit_fee_with_http_info(debit_fee, **kwargs) # noqa: E501 def set_debit_fee_with_http_info(self, debit_fee, **kwargs): # noqa: E501 - """Set GT deduction. # 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(debit_fee, async_req=True) diff --git a/gate_api/api/collateral_loan_api.py b/gate_api/api/collateral_loan_api.py index 032f17b..a96b375 100644 --- a/gate_api/api/collateral_loan_api.py +++ b/gate_api/api/collateral_loan_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -45,10 +45,10 @@ def list_collateral_loan_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 str borrow_currency: Borrowed currency. + :param int page: Page number + :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 data. Default is True. @@ -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 @@ -72,10 +72,10 @@ def list_collateral_loan_orders_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 str borrow_currency: Borrowed currency. + :param int page: Page number + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -518,13 +518,13 @@ def list_repay_records(self, source, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 source: Operation type: repay - Regular repayment, liquidate - Liquidation (required) + :param str borrow_currency: Borrowed currency + :param str collateral_currency: Collateral currency + :param int page: Page number + :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 @@ -548,13 +548,13 @@ def list_repay_records_with_http_info(self, source, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 source: Operation type: repay - Regular repayment, liquidate - Liquidation (required) + :param str borrow_currency: Borrowed currency + :param str collateral_currency: Collateral currency + :param int page: Page number + :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 @@ -658,7 +658,7 @@ def list_repay_records_with_http_info(self, source, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_collateral_records(self, **kwargs): # noqa: E501 - """Query collateral adjustment records. # noqa: E501 + """Query collateral adjustment records # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -666,12 +666,12 @@ def list_collateral_records(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 borrow_currency: Borrowed currency. - :param str collateral_currency: Collateral. + :param int page: Page number + :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 currency :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -687,7 +687,7 @@ def list_collateral_records(self, **kwargs): # noqa: E501 return self.list_collateral_records_with_http_info(**kwargs) # noqa: E501 def list_collateral_records_with_http_info(self, **kwargs): # noqa: E501 - """Query collateral adjustment records. # noqa: E501 + """Query collateral adjustment records # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -695,12 +695,12 @@ def list_collateral_records_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 borrow_currency: Borrowed currency. - :param str collateral_currency: Collateral. + :param int page: Page number + :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 currency :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -797,7 +797,7 @@ def list_collateral_records_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def operate_collateral(self, collateral_align, **kwargs): # noqa: E501 - """Increase or redeem collateral. # noqa: E501 + """Increase or redeem collateral # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -821,7 +821,7 @@ def operate_collateral(self, collateral_align, **kwargs): # noqa: E501 return self.operate_collateral_with_http_info(collateral_align, **kwargs) # noqa: E501 def operate_collateral_with_http_info(self, collateral_align, **kwargs): # noqa: E501 - """Increase or redeem collateral. # noqa: E501 + """Increase or redeem collateral # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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,8 +1020,8 @@ 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 borrow_currency: Borrowed currency. (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 data. Default is True. @@ -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,8 +1045,8 @@ 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 borrow_currency: Borrowed currency. (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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1133,7 +1133,7 @@ def get_user_ltv_info_with_http_info(self, collateral_currency, borrow_currency, collection_formats=collection_formats) def list_collateral_currencies(self, **kwargs): # noqa: E501 - """Query supported borrowing and collateral currencies. # noqa: E501 + """Query supported borrowing and collateral currencies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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. + :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. @@ -1157,7 +1157,7 @@ def list_collateral_currencies(self, **kwargs): # noqa: E501 return self.list_collateral_currencies_with_http_info(**kwargs) # noqa: E501 def list_collateral_currencies_with_http_info(self, **kwargs): # noqa: E501 - """Query supported borrowing and collateral currencies. # noqa: E501 + """Query supported borrowing and collateral currencies # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=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. + :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 3ce1462..4979aa5 100644 --- a/gate_api/api/delivery_api.py +++ b/gate_api/api/delivery_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -45,7 +45,7 @@ def list_delivery_contracts(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -69,7 +69,7 @@ def list_delivery_contracts_with_http_info(self, settle, **kwargs): # noqa: E50 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle 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 @@ -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 @@ -157,8 +157,8 @@ def get_delivery_contract(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -182,8 +182,8 @@ def get_delivery_contract_with_http_info(self, settle, contract, **kwargs): # n >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -270,20 +270,20 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_delivery_order_book(settle, contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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,20 +299,20 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_delivery_order_book_with_http_info(settle, contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 @@ -420,10 +420,10 @@ def list_delivery_trades(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :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: 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持,新的请求请使用 `from` 和 `to` 字段来限定时间范围 + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -449,10 +449,10 @@ def list_delivery_trades_with_http_info(self, settle, contract, **kwargs): # no >>> result = thread.get() :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: 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持,新的请求请使用 `from` 和 `to` 字段来限定时间范围 + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 _return_http_data_only: response data without head status code @@ -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 @@ -566,12 +566,12 @@ def list_delivery_candlesticks(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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: Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time + :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 @@ -596,12 +596,12 @@ def list_delivery_candlesticks_with_http_info(self, settle, contract, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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: Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time + :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 @@ -710,8 +710,8 @@ def list_delivery_tickers(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. + :param str settle: Settle currency (required) + :param str contract: Futures contract :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -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 @@ -735,8 +735,8 @@ def list_delivery_tickers_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. + :param str settle: Settle currency (required) + :param str contract: Futures contract :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -827,8 +827,8 @@ def list_delivery_insurance_ledger(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :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 @@ -852,8 +852,8 @@ def list_delivery_insurance_ledger_with_http_info(self, settle, **kwargs): # no >>> result = thread.get() :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 str settle: Settle currency (required) + :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 @@ -948,7 +948,7 @@ def list_delivery_accounts(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -972,7 +972,7 @@ def list_delivery_accounts_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle 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 @@ -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 @@ -1060,11 +1060,11 @@ def list_delivery_account_book(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :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: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate + :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 @@ -1088,11 +1088,11 @@ def list_delivery_account_book_with_http_info(self, settle, **kwargs): # noqa: >>> result = thread.get() :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 str settle: Settle currency (required) + :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: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate + :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 @@ -1196,7 +1196,7 @@ def list_delivery_positions(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1220,7 +1220,7 @@ def list_delivery_positions_with_http_info(self, settle, **kwargs): # noqa: E50 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle 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 @@ -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 @@ -1308,8 +1308,8 @@ def get_delivery_position(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1333,8 +1333,8 @@ def get_delivery_position_with_http_info(self, settle, contract, **kwargs): # n >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1421,7 +1421,7 @@ def get_delivery_position_with_http_info(self, settle, contract, **kwargs): # n collection_formats=collection_formats) def update_delivery_position_margin(self, settle, contract, change, **kwargs): # noqa: E501 - """Update position margin. # noqa: E501 + """Update position margin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1429,9 +1429,9 @@ def update_delivery_position_margin(self, settle, contract, change, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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. @@ -1447,7 +1447,7 @@ def update_delivery_position_margin(self, settle, contract, change, **kwargs): return self.update_delivery_position_margin_with_http_info(settle, contract, change, **kwargs) # noqa: E501 def update_delivery_position_margin_with_http_info(self, settle, contract, change, **kwargs): # noqa: E501 - """Update position margin. # noqa: E501 + """Update position margin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1455,9 +1455,9 @@ def update_delivery_position_margin_with_http_info(self, settle, contract, chang >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 @@ -1551,7 +1551,7 @@ def update_delivery_position_margin_with_http_info(self, settle, contract, chang collection_formats=collection_formats) def update_delivery_position_leverage(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage. # noqa: E501 + """Update position leverage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1559,9 +1559,9 @@ def update_delivery_position_leverage(self, settle, contract, leverage, **kwargs >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str leverage: New position leverage. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param str leverage: New position leverage (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1577,7 +1577,7 @@ def update_delivery_position_leverage(self, settle, contract, leverage, **kwargs return self.update_delivery_position_leverage_with_http_info(settle, contract, leverage, **kwargs) # noqa: E501 def update_delivery_position_leverage_with_http_info(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage. # noqa: E501 + """Update position leverage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1585,9 +1585,9 @@ def update_delivery_position_leverage_with_http_info(self, settle, contract, lev >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str leverage: New position leverage. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param str leverage: New position 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 @@ -1681,7 +1681,7 @@ def update_delivery_position_leverage_with_http_info(self, settle, contract, lev collection_formats=collection_formats) def update_delivery_position_risk_limit(self, settle, contract, risk_limit, **kwargs): # noqa: E501 - """Update position risk limit. # noqa: E501 + """Update position risk limit # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1689,9 +1689,9 @@ def update_delivery_position_risk_limit(self, settle, contract, risk_limit, **kw >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str risk_limit: New position risk limit. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param str risk_limit: New position risk limit (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1707,7 +1707,7 @@ def update_delivery_position_risk_limit(self, settle, contract, risk_limit, **kw return self.update_delivery_position_risk_limit_with_http_info(settle, contract, risk_limit, **kwargs) # noqa: E501 def update_delivery_position_risk_limit_with_http_info(self, settle, contract, risk_limit, **kwargs): # noqa: E501 - """Update position risk limit. # noqa: E501 + """Update position risk limit # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1715,9 +1715,9 @@ def update_delivery_position_risk_limit_with_http_info(self, settle, contract, r >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str risk_limit: New position risk limit. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param str risk_limit: New position risk limit (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,22 +1811,22 @@ 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) >>> result = thread.get() :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 contract: Futures contract. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - :param int count_total: Whether to return total number matched. Default to 0(no return). + :param str settle: Settle currency (required) + :param str status: Query order list based on status (required) + :param str contract: Futures contract + :param int limit: Maximum number of records returned in a single list + :param int offset: List offset, starting from 0 + :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,22 +1842,22 @@ 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) >>> result = thread.get() :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 contract: Futures contract. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - :param int count_total: Whether to return total number matched. Default to 0(no return). + :param str settle: Settle currency (required) + :param str status: Query order list based on status (required) + :param str contract: Futures contract + :param int limit: Maximum number of records returned in a single list + :param int offset: List offset, starting from 0 + :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,16 +1965,16 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesOrder futures_order: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -1991,16 +1991,16 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesOrder futures_order: (required) :param _return_http_data_only: response data without head status code and headers @@ -2092,18 +2092,18 @@ 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) >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (required) + :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,18 +2119,18 @@ 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) >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (required) + :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,17 +2220,17 @@ 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) >>> result = thread.get() :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 settle: Settle currency (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,17 +2246,17 @@ 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) >>> result = thread.get() :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 settle: Settle currency (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 @@ -2351,8 +2351,8 @@ def cancel_delivery_order(self, settle, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :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 settle: Settle currency (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 @@ -2376,8 +2376,8 @@ def cancel_delivery_order_with_http_info(self, settle, order_id, **kwargs): # n >>> result = thread.get() :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 settle: Settle currency (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 @@ -2472,13 +2472,13 @@ def get_my_delivery_trades(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - :param int count_total: Whether to return total number matched. Default to 0(no return). + :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 returned in a single list + :param int offset: List offset, starting from 0 + :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 @@ -2502,13 +2502,13 @@ def get_my_delivery_trades_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - :param int count_total: Whether to return total number matched. Default to 0(no return). + :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 returned in a single list + :param int offset: List offset, starting from 0 + :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 @@ -2620,9 +2620,9 @@ def list_delivery_position_close(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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 @@ -2646,9 +2646,9 @@ def list_delivery_position_close_with_http_info(self, settle, **kwargs): # noqa >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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 @@ -2746,10 +2746,10 @@ def list_delivery_liquidates(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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 @@ -2773,10 +2773,10 @@ def list_delivery_liquidates_with_http_info(self, settle, **kwargs): # noqa: E5 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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 @@ -2877,10 +2877,10 @@ def list_delivery_settlements(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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 @@ -2904,10 +2904,10 @@ def list_delivery_settlements_with_http_info(self, settle, **kwargs): # noqa: E >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract + :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,19 +3000,19 @@ 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 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract + :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 data. Default is True. @@ -3028,19 +3028,19 @@ 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 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 Price-triggered 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 @@ -3143,11 +3143,11 @@ def list_price_triggered_delivery_orders(self, settle, status, **kwargs): # noq >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :param str settle: Settle currency (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 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 data. Default is True. @@ -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 Price-triggered 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 @@ -3171,11 +3171,11 @@ def list_price_triggered_delivery_orders_with_http_info(self, settle, status, ** >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :param str settle: Settle currency (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 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -3285,7 +3285,7 @@ def create_price_triggered_delivery_order(self, settle, futures_price_triggered_ >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesPriceTriggeredOrder futures_price_triggered_order: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -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 @@ -3310,7 +3310,7 @@ def create_price_triggered_delivery_order_with_http_info(self, settle, futures_p >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesPriceTriggeredOrder futures_price_triggered_order: (required) :param _return_http_data_only: response data without head status code and headers @@ -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 Price-triggered 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 @@ -3410,8 +3410,8 @@ def cancel_price_triggered_delivery_order_list(self, settle, contract, **kwargs) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 Price-triggered 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 @@ -3435,8 +3435,8 @@ def cancel_price_triggered_delivery_order_list_with_http_info(self, settle, cont >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -3531,8 +3531,8 @@ def get_price_triggered_delivery_order(self, settle, order_id, **kwargs): # noq >>> result = thread.get() :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 settle: Settle currency (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 @@ -3556,8 +3556,8 @@ def get_price_triggered_delivery_order_with_http_info(self, settle, order_id, ** >>> result = thread.get() :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 settle: Settle currency (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 @@ -3652,8 +3652,8 @@ def cancel_price_triggered_delivery_order(self, settle, order_id, **kwargs): # >>> result = thread.get() :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 settle: Settle currency (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 @@ -3677,8 +3677,8 @@ def cancel_price_triggered_delivery_order_with_http_info(self, settle, order_id, >>> result = thread.get() :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 settle: Settle currency (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 1072c16..2076555 100644 --- a/gate_api/api/earn_api.py +++ b/gate_api/api/earn_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,7 +37,7 @@ def __init__(self, api_client=None): self.api_client = api_client def swap_eth2(self, eth2_swap, **kwargs): # noqa: E501 - """ETH2 swap. # noqa: E501 + """ETH2 swap # 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 swap_eth2(self, eth2_swap, **kwargs): # noqa: E501 return self.swap_eth2_with_http_info(eth2_swap, **kwargs) # noqa: E501 def swap_eth2_with_http_info(self, eth2_swap, **kwargs): # noqa: E501 - """ETH2 swap. # noqa: E501 + """ETH2 swap # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -149,9 +149,9 @@ def swap_eth2_with_http_info(self, eth2_swap, **kwargs): # noqa: E501 collection_formats=collection_formats) def rate_list_eth2(self, **kwargs): # noqa: E501 - """ETH2 historical rate of return query. # noqa: E501 + """ETH2 historical return rate query # noqa: E501 - Check the ETH earnings rate record for the last 31 days. # 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) @@ -173,9 +173,9 @@ def rate_list_eth2(self, **kwargs): # noqa: E501 return self.rate_list_eth2_with_http_info(**kwargs) # noqa: E501 def rate_list_eth2_with_http_info(self, **kwargs): # noqa: E501 - """ETH2 historical rate of return query. # noqa: E501 + """ETH2 historical return rate query # noqa: E501 - Check the ETH earnings rate record for the last 31 days. # 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) @@ -254,7 +254,7 @@ def rate_list_eth2_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_dual_investment_plans(self, **kwargs): # noqa: E501 - """Dual Investment product list. # noqa: E501 + """Dual Investment product list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -262,7 +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 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. @@ -278,7 +278,7 @@ def list_dual_investment_plans(self, **kwargs): # noqa: E501 return self.list_dual_investment_plans_with_http_info(**kwargs) # noqa: E501 def list_dual_investment_plans_with_http_info(self, **kwargs): # noqa: E501 - """Dual Investment product list. # noqa: E501 + """Dual Investment product list # 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_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 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 @@ -362,7 +362,7 @@ def list_dual_investment_plans_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_dual_orders(self, **kwargs): # noqa: E501 - """Dual Investment order list. # noqa: E501 + """Dual Investment order list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -370,10 +370,10 @@ def list_dual_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int _from: Start checkout time. - :param int to: End settlement time. - :param int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :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. @@ -389,7 +389,7 @@ def list_dual_orders(self, **kwargs): # noqa: E501 return self.list_dual_orders_with_http_info(**kwargs) # noqa: E501 def list_dual_orders_with_http_info(self, **kwargs): # noqa: E501 - """Dual Investment order list. # noqa: E501 + """Dual Investment order list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -397,10 +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 checkout time. - :param int to: End settlement time. - :param int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :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 @@ -491,7 +491,7 @@ def list_dual_orders_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def place_dual_order(self, place_dual_investment_order, **kwargs): # noqa: E501 - """Place Dual Investment order. # noqa: E501 + """Place Dual Investment order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -515,7 +515,7 @@ def place_dual_order(self, place_dual_investment_order, **kwargs): # noqa: E501 return self.place_dual_order_with_http_info(place_dual_investment_order, **kwargs) # noqa: E501 def place_dual_order_with_http_info(self, place_dual_investment_order, **kwargs): # noqa: E501 - """Place Dual Investment order. # noqa: E501 + """Place Dual Investment order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -603,7 +603,7 @@ def place_dual_order_with_http_info(self, place_dual_investment_order, **kwargs) collection_formats=collection_formats) def list_structured_products(self, status, **kwargs): # noqa: E501 - """Structured Product List. # noqa: E501 + """Structured Product List # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -613,8 +613,8 @@ def list_structured_products(self, status, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 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. @@ -630,7 +630,7 @@ def list_structured_products(self, status, **kwargs): # noqa: E501 return self.list_structured_products_with_http_info(status, **kwargs) # noqa: E501 def list_structured_products_with_http_info(self, status, **kwargs): # noqa: E501 - """Structured Product List. # noqa: E501 + """Structured Product List # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -640,8 +640,8 @@ def list_structured_products_with_http_info(self, status, **kwargs): # noqa: E5 :param bool async_req: execute request asynchronously :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 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 @@ -736,7 +736,7 @@ def list_structured_products_with_http_info(self, status, **kwargs): # noqa: E5 collection_formats=collection_formats) def list_structured_orders(self, **kwargs): # noqa: E501 - """Structured Product Order List. # noqa: E501 + """Structured Product Order List # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -746,8 +746,8 @@ def list_structured_orders(self, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 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. @@ -763,7 +763,7 @@ def list_structured_orders(self, **kwargs): # noqa: E501 return self.list_structured_orders_with_http_info(**kwargs) # noqa: E501 def list_structured_orders_with_http_info(self, **kwargs): # noqa: E501 - """Structured Product Order List. # noqa: E501 + """Structured Product Order List # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -773,8 +773,8 @@ def list_structured_orders_with_http_info(self, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 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 @@ -865,7 +865,7 @@ def list_structured_orders_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def place_structured_order(self, structured_buy, **kwargs): # noqa: E501 - """Place Structured Product Order. # noqa: E501 + """Place Structured Product Order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -889,7 +889,7 @@ def place_structured_order(self, structured_buy, **kwargs): # noqa: E501 return self.place_structured_order_with_http_info(structured_buy, **kwargs) # noqa: E501 def place_structured_order_with_http_info(self, structured_buy, **kwargs): # noqa: E501 - """Place Structured Product Order. # noqa: E501 + """Place Structured Product Order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -977,7 +977,7 @@ def place_structured_order_with_http_info(self, structured_buy, **kwargs): # no collection_formats=collection_formats) def find_coin(self, find_coin, **kwargs): # noqa: E501 - """Staking Coins. # 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 @@ -993,7 +993,7 @@ def find_coin(self, find_coin, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :rtype: list[str] + :rtype: object :return: If the method is called asynchronously, returns the request thread. """ @@ -1001,7 +1001,7 @@ def find_coin(self, find_coin, **kwargs): # noqa: E501 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 + """Staking coins # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1019,7 +1019,7 @@ def find_coin_with_http_info(self, find_coin, **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[str], status_code(int), headers(HTTPHeaderDict)) + :rtype: tuple(object, status_code(int), headers(HTTPHeaderDict)) :return: If the method is called asynchronously, returns the request thread. """ @@ -1084,7 +1084,7 @@ def find_coin_with_http_info(self, find_coin, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[str]', # noqa: E501 + 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 @@ -1093,7 +1093,7 @@ def find_coin_with_http_info(self, find_coin, **kwargs): # noqa: E501 collection_formats=collection_formats) def swap_staking_coin(self, swap_coin, **kwargs): # noqa: E501 - """On-chain Token Swap for Earned Coins. # 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 @@ -1117,7 +1117,7 @@ def swap_staking_coin(self, swap_coin, **kwargs): # noqa: E501 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 + """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 diff --git a/gate_api/api/earn_uni_api.py b/gate_api/api/earn_uni_api.py index 46acd1b..4d37fd4 100644 --- a/gate_api/api/earn_uni_api.py +++ b/gate_api/api/earn_uni_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -148,7 +148,7 @@ def get_uni_currency(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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. @@ -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 @@ -172,7 +172,7 @@ def get_uni_currency_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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 @@ -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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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,7 +376,7 @@ 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: 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 @@ -401,7 +401,7 @@ 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: 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 @@ -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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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: type: lend - lend, redeem - redeem. + :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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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: type: lend - lend, redeem - redeem. + :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 @@ -751,7 +751,7 @@ def get_uni_interest(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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. @@ -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 @@ -775,7 +775,7 @@ def get_uni_interest_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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 @@ -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,9 +863,9 @@ 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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -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,9 +891,9 @@ 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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -989,7 +989,7 @@ def list_uni_interest_records_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_uni_interest_status(self, currency, **kwargs): # noqa: E501 - """query currency interest compounding status. # 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 @@ -997,7 +997,7 @@ def get_uni_interest_status(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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. @@ -1013,7 +1013,7 @@ def get_uni_interest_status(self, currency, **kwargs): # noqa: E501 return self.get_uni_interest_status_with_http_info(currency, **kwargs) # noqa: E501 def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E501 - """query currency interest compounding status. # 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 @@ -1021,7 +1021,7 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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 @@ -1101,7 +1101,7 @@ def get_uni_interest_status_with_http_info(self, currency, **kwargs): # noqa: E collection_formats=collection_formats) def list_uni_chart(self, _from, to, asset, **kwargs): # noqa: E501 - """UniLoan currency annualized trend chart. # 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 @@ -1110,9 +1110,9 @@ def list_uni_chart(self, _from, to, asset, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int _from: Start timestamp, unit s, maximum span of 30 days. (required) - :param int to: End timestamp, unit s, maximum span of 30 days. (required) - :param str asset: Currency name. (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. @@ -1128,7 +1128,7 @@ def list_uni_chart(self, _from, to, asset, **kwargs): # noqa: E501 return self.list_uni_chart_with_http_info(_from, to, asset, **kwargs) # noqa: E501 def list_uni_chart_with_http_info(self, _from, to, asset, **kwargs): # noqa: E501 - """UniLoan currency annualized trend chart. # 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 @@ -1137,9 +1137,9 @@ def list_uni_chart_with_http_info(self, _from, to, asset, **kwargs): # noqa: E5 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int _from: Start timestamp, unit s, maximum span of 30 days. (required) - :param int to: End timestamp, unit s, maximum span of 30 days. (required) - :param str asset: Currency name. (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 @@ -1233,7 +1233,7 @@ def list_uni_chart_with_http_info(self, _from, to, asset, **kwargs): # noqa: E5 collection_formats=collection_formats) def list_uni_rate(self, **kwargs): # noqa: E501 - """Currency estimate annualized interest rate. # 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 @@ -1257,7 +1257,7 @@ def list_uni_rate(self, **kwargs): # noqa: E501 return self.list_uni_rate_with_http_info(**kwargs) # noqa: E501 def list_uni_rate_with_http_info(self, **kwargs): # noqa: E501 - """Currency estimate annualized interest rate. # 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 diff --git a/gate_api/api/flash_swap_api.py b/gate_api/api/flash_swap_api.py index 617f794..ffbba85 100644 --- a/gate_api/api/flash_swap_api.py +++ b/gate_api/api/flash_swap_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,7 +37,7 @@ def __init__(self, api_client=None): self.api_client = api_client def list_flash_swap_currency_pair(self, **kwargs): # noqa: E501 - """List All Supported Currency Pairs In Flash Swap. # noqa: E501 + """List All Supported Currency Pairs In Flash Swap # noqa: E501 `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -46,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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 1000. + :param str currency: Query by specified currency name + :param int page: Page number + :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. @@ -64,7 +64,7 @@ def list_flash_swap_currency_pair(self, **kwargs): # noqa: E501 return self.list_flash_swap_currency_pair_with_http_info(**kwargs) # noqa: E501 def list_flash_swap_currency_pair_with_http_info(self, **kwargs): # noqa: E501 - """List All Supported Currency Pairs In Flash Swap. # noqa: E501 + """List All Supported Currency Pairs In Flash Swap # noqa: E501 `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -73,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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 1000. + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -163,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 @@ -171,12 +171,12 @@ 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) - ascending order(oldest first) - :param int limit: Maximum number of records to be returned in a single list. - :param int page: Page number. + :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 data. Default is True. @@ -192,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 @@ -200,12 +200,12 @@ 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) - ascending order(oldest first) - :param int limit: Maximum number of records to be returned in a single list. - :param int page: Page number. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -302,7 +302,7 @@ def list_flash_swap_orders_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_flash_swap_order(self, flash_swap_order_request, **kwargs): # noqa: E501 - """Create a flash swap order. # noqa: E501 + """Create a flash swap order # noqa: E501 Initiate a flash swap preview in advance because order creation requires a preview result # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -327,7 +327,7 @@ def create_flash_swap_order(self, flash_swap_order_request, **kwargs): # noqa: return self.create_flash_swap_order_with_http_info(flash_swap_order_request, **kwargs) # noqa: E501 def create_flash_swap_order_with_http_info(self, flash_swap_order_request, **kwargs): # noqa: E501 - """Create a flash swap order. # noqa: E501 + """Create a flash swap order # noqa: E501 Initiate a flash swap preview in advance because order creation requires a preview result # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -420,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 @@ -428,7 +428,7 @@ def get_flash_swap_order(self, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int order_id: Flash swap order ID. (required) + :param int order_id: Flash swap order ID (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -444,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 @@ -452,7 +452,7 @@ def get_flash_swap_order_with_http_info(self, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param int order_id: Flash swap order ID. (required) + :param int order_id: Flash swap order 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 @@ -532,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 @@ -556,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 3230541..5d20be4 100644 --- a/gate_api/api/futures_api.py +++ b/gate_api/api/futures_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -45,9 +45,9 @@ def list_futures_contracts(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :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 data. Default is True. @@ -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 @@ -71,9 +71,9 @@ def list_futures_contracts_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -173,8 +173,8 @@ def get_futures_contract(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -198,8 +198,8 @@ def get_futures_contract_with_http_info(self, settle, contract, **kwargs): # no >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -286,20 +286,20 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_futures_order_book(settle, contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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,20 +315,20 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_futures_order_book_with_http_info(settle, contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 @@ -436,10 +436,10 @@ def list_futures_trades(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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. @@ -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 @@ -466,10 +466,10 @@ def list_futures_trades_with_http_info(self, settle, contract, **kwargs): # noq >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :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. @@ -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 @@ -589,12 +589,13 @@ def list_futures_candlesticks(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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. 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 @@ -619,12 +620,13 @@ def list_futures_candlesticks_with_http_info(self, settle, contract, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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. 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 @@ -734,12 +739,12 @@ def list_futures_premium_index(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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 @@ -764,12 +769,12 @@ def list_futures_premium_index_with_http_info(self, settle, contract, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :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: 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 specified - :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 @@ -878,8 +883,8 @@ def list_futures_tickers(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -903,8 +908,8 @@ def list_futures_tickers_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -995,9 +1000,9 @@ def list_futures_funding_rate_history(self, settle, contract, **kwargs): # noqa >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 @@ -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 @@ -1023,9 +1028,9 @@ def list_futures_funding_rate_history_with_http_info(self, settle, contract, **k >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (required) + :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 @@ -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 @@ -1135,8 +1140,8 @@ def list_futures_insurance_ledger(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :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 @@ -1160,8 +1165,8 @@ def list_futures_insurance_ledger_with_http_info(self, settle, **kwargs): # noq >>> result = thread.get() :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 str settle: Settle currency (required) + :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 @@ -1256,9 +1261,9 @@ def list_contract_stats(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param int _from: Start timestamp. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param int _from: Start timestamp :param str interval: :param int limit: :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -1284,9 +1289,9 @@ def list_contract_stats_with_http_info(self, settle, contract, **kwargs): # noq >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param int _from: Start timestamp. + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) + :param int _from: Start timestamp :param str interval: :param int limit: :param _return_http_data_only: response data without head status code @@ -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 @@ -1396,8 +1401,8 @@ def get_index_constituents(self, settle, index, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str index: Index name. (required) + :param str settle: Settle currency (required) + :param str index: Index name (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1421,8 +1426,8 @@ def get_index_constituents_with_http_info(self, settle, index, **kwargs): # noq >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str index: Index name. (required) + :param str settle: Settle currency (required) + :param str index: Index 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 @@ -1509,20 +1514,20 @@ 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 - The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details # 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) >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 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. @@ -1538,20 +1543,20 @@ 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 - The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details # 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) >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 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 @@ -1647,19 +1652,19 @@ 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 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if 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 data. Default is True. @@ -1675,19 +1680,19 @@ 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 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -1790,7 +1795,7 @@ def list_futures_accounts(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1814,7 +1819,7 @@ def list_futures_accounts_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle 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 @@ -1894,22 +1899,22 @@ 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 passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. # 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 str type: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + :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,22 +1930,22 @@ 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 passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. # 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 str type: Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + :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 @@ -2052,10 +2057,10 @@ def list_positions(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 int offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :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 data. Default is True. @@ -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 @@ -2079,10 +2084,10 @@ def list_positions_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 int offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -2185,8 +2190,8 @@ def get_position(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -2210,8 +2215,8 @@ def get_position_with_http_info(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -2298,7 +2303,7 @@ def get_position_with_http_info(self, settle, contract, **kwargs): # noqa: E501 collection_formats=collection_formats) def update_position_margin(self, settle, contract, change, **kwargs): # noqa: E501 - """Update position margin. # noqa: E501 + """Update position margin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2306,9 +2311,9 @@ def update_position_margin(self, settle, contract, change, **kwargs): # noqa: E >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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. @@ -2324,7 +2329,7 @@ def update_position_margin(self, settle, contract, change, **kwargs): # noqa: E return self.update_position_margin_with_http_info(settle, contract, change, **kwargs) # noqa: E501 def update_position_margin_with_http_info(self, settle, contract, change, **kwargs): # noqa: E501 - """Update position margin. # noqa: E501 + """Update position margin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2332,9 +2337,9 @@ def update_position_margin_with_http_info(self, settle, contract, change, **kwar >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 @@ -2428,7 +2433,7 @@ def update_position_margin_with_http_info(self, settle, contract, change, **kwar collection_formats=collection_formats) def update_position_leverage(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage. # noqa: E501 + """Update position leverage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2436,10 +2441,11 @@ def update_position_leverage(self, settle, contract, leverage, **kwargs): # noq >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 int pid: Product ID :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2455,7 +2461,7 @@ def update_position_leverage(self, settle, contract, leverage, **kwargs): # noq return self.update_position_leverage_with_http_info(settle, contract, leverage, **kwargs) # noqa: E501 def update_position_leverage_with_http_info(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage. # noqa: E501 + """Update position leverage # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2463,10 +2469,11 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, ** >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 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 = {} @@ -2563,7 +2573,7 @@ def update_position_leverage_with_http_info(self, settle, contract, leverage, ** collection_formats=collection_formats) def update_position_cross_mode(self, settle, futures_position_cross_mode, **kwargs): # noqa: E501 - """Switch to the full position-by-store mode. # 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 @@ -2571,7 +2581,7 @@ def update_position_cross_mode(self, settle, futures_position_cross_mode, **kwar >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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 @@ -2588,7 +2598,7 @@ def update_position_cross_mode(self, settle, futures_position_cross_mode, **kwar 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 to the full position-by-store mode. # 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 @@ -2596,7 +2606,7 @@ def update_position_cross_mode_with_http_info(self, settle, futures_position_cro >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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 @@ -2687,8 +2697,133 @@ def update_position_cross_mode_with_http_info(self, settle, futures_position_cro _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 + """Update position risk limit # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2696,9 +2831,9 @@ def update_position_risk_limit(self, settle, contract, risk_limit, **kwargs): # >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (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. @@ -2714,7 +2849,7 @@ def update_position_risk_limit(self, settle, contract, risk_limit, **kwargs): # return self.update_position_risk_limit_with_http_info(settle, contract, risk_limit, **kwargs) # noqa: E501 def update_position_risk_limit_with_http_info(self, settle, contract, risk_limit, **kwargs): # noqa: E501 - """Update position risk limit. # noqa: E501 + """Update position risk limit # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2722,9 +2857,9 @@ def update_position_risk_limit_with_http_info(self, settle, contract, risk_limit >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (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 @@ -2818,17 +2953,17 @@ 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 - The prerequisite for changing mode is that all positions have no holdings. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param bool dual_mode: Whether to enable dual mode. (required) + :param str settle: Settle currency (required) + :param bool dual_mode: Whether to enable dual mode (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2844,17 +2979,17 @@ 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 - The prerequisite for changing mode is that all positions have no holdings. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param bool dual_mode: Whether to enable dual mode. (required) + :param str settle: Settle currency (required) + :param bool dual_mode: Whether to enable dual 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 @@ -2941,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 @@ -2949,8 +3084,8 @@ def get_dual_mode_position(self, settle, contract, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2966,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 @@ -2974,8 +3109,8 @@ def get_dual_mode_position_with_http_info(self, settle, contract, **kwargs): # >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -3062,7 +3197,7 @@ def get_dual_mode_position_with_http_info(self, settle, contract, **kwargs): # collection_formats=collection_formats) def update_dual_mode_position_margin(self, settle, contract, change, dual_side, **kwargs): # noqa: E501 - """Update position margin in dual mode. # noqa: E501 + """Update position margin 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 @@ -3070,10 +3205,10 @@ def update_dual_mode_position_margin(self, settle, contract, change, dual_side, >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) - :param str dual_side: Long or short position. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 data. Default is True. @@ -3089,7 +3224,7 @@ def update_dual_mode_position_margin(self, settle, contract, change, dual_side, return self.update_dual_mode_position_margin_with_http_info(settle, contract, change, dual_side, **kwargs) # noqa: E501 def update_dual_mode_position_margin_with_http_info(self, settle, contract, change, dual_side, **kwargs): # noqa: E501 - """Update position margin in dual mode. # noqa: E501 + """Update position margin 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 @@ -3097,10 +3232,10 @@ def update_dual_mode_position_margin_with_http_info(self, settle, contract, chan >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) - :param str change: Margin change amount, positive number increases, negative number. (required) - :param str dual_side: Long or short position. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -3201,7 +3336,7 @@ def update_dual_mode_position_margin_with_http_info(self, settle, contract, chan collection_formats=collection_formats) def update_dual_mode_position_leverage(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage in dual mode. # noqa: E501 + """Update position leverage 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 @@ -3209,10 +3344,10 @@ def update_dual_mode_position_leverage(self, settle, contract, leverage, **kwarg >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -3228,7 +3363,7 @@ def update_dual_mode_position_leverage(self, settle, contract, leverage, **kwarg return self.update_dual_mode_position_leverage_with_http_info(settle, contract, leverage, **kwargs) # noqa: E501 def update_dual_mode_position_leverage_with_http_info(self, settle, contract, leverage, **kwargs): # noqa: E501 - """Update position leverage in dual mode. # noqa: E501 + """Update position leverage 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 @@ -3236,10 +3371,10 @@ def update_dual_mode_position_leverage_with_http_info(self, settle, contract, le >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -3336,7 +3471,7 @@ def update_dual_mode_position_leverage_with_http_info(self, settle, contract, le collection_formats=collection_formats) def update_dual_mode_position_risk_limit(self, settle, contract, risk_limit, **kwargs): # noqa: E501 - """Update position risk limit in dual mode. # noqa: E501 + """Update position risk limit 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 @@ -3344,9 +3479,9 @@ def update_dual_mode_position_risk_limit(self, settle, contract, risk_limit, **k >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (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. @@ -3362,7 +3497,7 @@ def update_dual_mode_position_risk_limit(self, settle, contract, risk_limit, **k return self.update_dual_mode_position_risk_limit_with_http_info(settle, contract, risk_limit, **kwargs) # noqa: E501 def update_dual_mode_position_risk_limit_with_http_info(self, settle, contract, risk_limit, **kwargs): # noqa: E501 - """Update position risk limit in dual mode. # noqa: E501 + """Update position risk limit 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 @@ -3370,9 +3505,9 @@ def update_dual_mode_position_risk_limit_with_http_info(self, settle, contract, >>> result = thread.get() :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 settle: Settle currency (required) + :param str contract: Futures contract (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 @@ -3466,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 @@ -3475,12 +3610,12 @@ def list_futures_orders(self, settle, status, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. + :param str settle: Settle currency (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 returned in a single list + :param int offset: List offset, starting from 0 + :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. @@ -3496,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 @@ -3505,12 +3640,12 @@ def list_futures_orders_with_http_info(self, settle, status, **kwargs): # noqa: >>> result = thread.get() :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 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 offset: List offset, starting from 0. - :param str last_id: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. + :param str settle: Settle currency (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 returned in a single list + :param int offset: List offset, starting from 0 + :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 @@ -3615,7 +3750,7 @@ 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 - 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 @@ -3624,7 +3759,7 @@ def create_futures_order(self, settle, futures_order, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesOrder futures_order: (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 @@ -3642,7 +3777,7 @@ 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 - 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 @@ -3651,7 +3786,7 @@ def create_futures_order_with_http_info(self, settle, futures_order, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesOrder futures_order: (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 @@ -3747,19 +3882,21 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 str side: Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders + :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. @@ -3775,19 +3912,21 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) - :param str contract: Futures contract. (required) + :param str settle: Settle currency (required) + :param str contract: Futures contract (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 str side: Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders + :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 @@ -3808,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( [ @@ -3847,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: @@ -3880,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 @@ -3888,12 +4033,12 @@ def get_orders_with_time_range(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 data. Default is True. @@ -3909,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 @@ -3917,12 +4062,12 @@ def get_orders_with_time_range_with_http_info(self, settle, **kwargs): # noqa: >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -4023,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 @@ -4032,7 +4177,7 @@ def create_batch_futures_order(self, settle, futures_order, **kwargs): # noqa: >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[FuturesOrder] futures_order: (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 @@ -4050,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 @@ -4059,7 +4204,7 @@ def create_batch_futures_order_with_http_info(self, settle, futures_order, **kwa >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[FuturesOrder] futures_order: (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 @@ -4155,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 @@ -4164,7 +4309,7 @@ def get_futures_order(self, settle, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 @@ -4181,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 @@ -4190,7 +4335,7 @@ def get_futures_order_with_http_info(self, settle, order_id, **kwargs): # noqa: >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 @@ -4278,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 @@ -4286,7 +4431,7 @@ def amend_futures_order(self, settle, order_id, futures_order_amendment, **kwarg >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 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 @@ -4305,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 @@ -4313,7 +4458,7 @@ def amend_futures_order_with_http_info(self, settle, order_id, futures_order_ame >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 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 @@ -4417,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 @@ -4425,7 +4570,7 @@ def cancel_futures_order(self, settle, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 @@ -4443,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 @@ -4451,7 +4596,7 @@ def cancel_futures_order_with_http_info(self, settle, order_id, **kwargs): # no >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :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. 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 @@ -4543,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 @@ -4552,11 +4697,11 @@ def get_my_trades(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :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 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 be returned without reading/decoding response @@ -4573,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 @@ -4582,11 +4727,11 @@ def get_my_trades_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :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 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 and headers @@ -4688,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 @@ -4696,13 +4841,13 @@ def get_my_trades_with_time_range(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 to be returned in a single list. - :param int offset: List offset, starting from 0. - :param str role: Query role, maker or taker. + :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 _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -4718,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 @@ -4726,13 +4871,13 @@ def get_my_trades_with_time_range_with_http_info(self, settle, **kwargs): # noq >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :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 to be returned in a single list. - :param int offset: List offset, starting from 0. - :param str role: Query role, maker or taker. + :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 _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -4836,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 @@ -4844,14 +4989,14 @@ def list_position_close(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 str side: Query side. long or shot. - :param str pnl: Query profit or loss. + :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 data. Default is True. @@ -4867,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 @@ -4875,14 +5020,14 @@ def list_position_close_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 str side: Query side. long or shot. - :param str pnl: Query profit or loss. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -4989,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 @@ -4997,10 +5142,13 @@ def list_liquidates(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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. @@ -5016,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 @@ -5024,10 +5172,13 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 @@ -5048,6 +5199,9 @@ def list_liquidates_with_http_info(self, settle, **kwargs): # noqa: E501 'settle', 'contract', 'limit', + 'offset', + '_from', + 'to', 'at' ] all_params.extend( @@ -5076,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 = {} @@ -5087,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 @@ -5120,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 @@ -5128,10 +5290,13 @@ def list_auto_deleverages(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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. @@ -5147,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 @@ -5155,10 +5320,13 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified + :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 @@ -5179,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( @@ -5207,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 = {} @@ -5218,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 @@ -5251,7 +5430,7 @@ def list_auto_deleverages_with_http_info(self, settle, **kwargs): # noqa: E501 collection_formats=collection_formats) def countdown_cancel_all_futures(self, settle, countdown_cancel_all_futures_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # noqa: E501 + """Countdown cancel orders # 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 @@ -5260,7 +5439,7 @@ def countdown_cancel_all_futures(self, settle, countdown_cancel_all_futures_task >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param CountdownCancelAllFuturesTask countdown_cancel_all_futures_task: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -5277,7 +5456,7 @@ def countdown_cancel_all_futures(self, settle, countdown_cancel_all_futures_task return self.countdown_cancel_all_futures_with_http_info(settle, countdown_cancel_all_futures_task, **kwargs) # noqa: E501 def countdown_cancel_all_futures_with_http_info(self, settle, countdown_cancel_all_futures_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # noqa: E501 + """Countdown cancel orders # 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 @@ -5286,7 +5465,7 @@ def countdown_cancel_all_futures_with_http_info(self, settle, countdown_cancel_a >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param CountdownCancelAllFuturesTask countdown_cancel_all_futures_task: (required) :param _return_http_data_only: response data without head status code and headers @@ -5378,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 @@ -5386,8 +5565,8 @@ def get_futures_fee(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -5403,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 @@ -5411,8 +5590,8 @@ def get_futures_fee_with_http_info(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -5495,16 +5674,16 @@ 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 different order IDs can be specified. 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[str] request_body: (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 @@ -5522,16 +5701,16 @@ 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 different order IDs can be specified. 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[str] request_body: (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 @@ -5627,16 +5806,16 @@ 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 - Multiple different order IDs can be specified. A maximum of 10 orders can. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[BatchAmendOrderReq] batch_amend_order_req: (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 @@ -5654,16 +5833,16 @@ 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 - Multiple different order IDs can be specified. A maximum of 10 orders can. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param list[BatchAmendOrderReq] batch_amend_order_req: (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 @@ -5759,17 +5938,17 @@ def amend_batch_future_orders_with_http_info(self, settle, batch_amend_order_req 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 + """Query risk limit table by table_id # noqa: E501 - Just pass 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 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. @@ -5785,17 +5964,17 @@ def get_futures_risk_limit_table(self, settle, table_id, **kwargs): # noqa: E50 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 + """Query risk limit table by table_id # noqa: E501 - Just pass 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 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 @@ -5882,7 +6061,7 @@ def get_futures_risk_limit_table_with_http_info(self, settle, table_id, **kwargs collection_formats=collection_formats) def list_price_triggered_orders(self, settle, status, **kwargs): # noqa: E501 - """List All Price-triggered 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 @@ -5890,11 +6069,11 @@ def list_price_triggered_orders(self, settle, status, **kwargs): # noqa: E501 >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :param str settle: Settle currency (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 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 data. Default is True. @@ -5910,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 Price-triggered 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 @@ -5918,11 +6097,11 @@ def list_price_triggered_orders_with_http_info(self, settle, status, **kwargs): >>> result = thread.get() :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 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 offset: List offset, starting from 0. + :param str settle: Settle currency (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 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -6024,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 @@ -6032,7 +6211,7 @@ def create_price_triggered_order(self, settle, futures_price_triggered_order, ** >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesPriceTriggeredOrder futures_price_triggered_order: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -6049,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 @@ -6057,7 +6236,7 @@ def create_price_triggered_order_with_http_info(self, settle, futures_price_trig >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str settle: Settle currency. (required) + :param str settle: Settle currency (required) :param FuturesPriceTriggeredOrder futures_price_triggered_order: (required) :param _return_http_data_only: response data without head status code and headers @@ -6149,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 Price-triggered 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 @@ -6157,8 +6336,8 @@ def cancel_price_triggered_order_list(self, settle, **kwargs): # noqa: E501 >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -6174,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 Price-triggered 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 @@ -6182,8 +6361,8 @@ def cancel_price_triggered_order_list_with_http_info(self, settle, **kwargs): # >>> result = thread.get() :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 str settle: Settle currency (required) + :param str contract: Futures contract, return related data only if specified :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -6266,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 @@ -6274,8 +6453,8 @@ def get_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E501 >>> result = thread.get() :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 settle: Settle currency (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. @@ -6291,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 @@ -6299,8 +6478,8 @@ def get_price_triggered_order_with_http_info(self, settle, order_id, **kwargs): >>> result = thread.get() :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 settle: Settle currency (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 @@ -6387,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 @@ -6395,8 +6574,8 @@ def cancel_price_triggered_order(self, settle, order_id, **kwargs): # noqa: E50 >>> result = thread.get() :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 settle: Settle currency (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. @@ -6412,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 @@ -6420,8 +6599,8 @@ def cancel_price_triggered_order_with_http_info(self, settle, order_id, **kwargs >>> result = thread.get() :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 settle: Settle currency (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 d08dd1a..9464f10 100644 --- a/gate_api/api/margin_api.py +++ b/gate_api/api/margin_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,7 +37,7 @@ def __init__(self, api_client=None): self.api_client = api_client def list_margin_accounts(self, **kwargs): # noqa: E501 - """Margin account list. # noqa: E501 + """Margin account list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -45,7 +45,7 @@ def list_margin_accounts(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. + :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. @@ -61,7 +61,7 @@ def list_margin_accounts(self, **kwargs): # noqa: E501 return self.list_margin_accounts_with_http_info(**kwargs) # noqa: E501 def list_margin_accounts_with_http_info(self, **kwargs): # noqa: E501 - """Margin account list. # noqa: E501 + """Margin account list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -69,7 +69,7 @@ def list_margin_accounts_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. + :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 @@ -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 int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :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 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 int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :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 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 @@ -291,7 +291,7 @@ def list_margin_account_book_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_funding_accounts(self, **kwargs): # noqa: E501 - """Funding account list. # noqa: E501 + """Funding account list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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. @@ -315,7 +315,7 @@ def list_funding_accounts(self, **kwargs): # noqa: E501 return self.list_funding_accounts_with_http_info(**kwargs) # noqa: E501 def list_funding_accounts_with_http_info(self, **kwargs): # noqa: E501 - """Funding account list. # noqa: E501 + """Funding account list # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=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,8 +622,8 @@ 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_pair: Currency pair. + :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 data. Default is True. @@ -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,8 +647,8 @@ 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_pair: Currency pair. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -731,7 +731,7 @@ def get_margin_transferable_with_http_info(self, currency, **kwargs): # noqa: E collection_formats=collection_formats) def get_user_margin_tier(self, currency_pair, **kwargs): # noqa: E501 - """Check the user's own leverage lending gradient in the current market. # 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 @@ -739,7 +739,7 @@ def get_user_margin_tier(self, currency_pair, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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. @@ -755,7 +755,7 @@ def get_user_margin_tier(self, currency_pair, **kwargs): # noqa: E501 return self.get_user_margin_tier_with_http_info(currency_pair, **kwargs) # noqa: E501 def get_user_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: E501 - """Check the user's own leverage lending gradient in the current market. # 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 @@ -763,7 +763,7 @@ def get_user_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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 @@ -843,7 +843,7 @@ def get_user_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: collection_formats=collection_formats) def get_market_margin_tier(self, currency_pair, **kwargs): # noqa: E501 - """Query the current market leverage lending gradient. # 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 @@ -851,7 +851,7 @@ def get_market_margin_tier(self, currency_pair, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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. @@ -867,7 +867,7 @@ def get_market_margin_tier(self, currency_pair, **kwargs): # noqa: E501 return self.get_market_margin_tier_with_http_info(currency_pair, **kwargs) # noqa: E501 def get_market_margin_tier_with_http_info(self, currency_pair, **kwargs): # noqa: E501 - """Query the current market leverage lending gradient. # 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 @@ -875,7 +875,7 @@ def get_market_margin_tier_with_http_info(self, currency_pair, **kwargs): # noq >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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 @@ -955,7 +955,7 @@ def get_market_margin_tier_with_http_info(self, currency_pair, **kwargs): # noq collection_formats=collection_formats) def set_user_market_leverage(self, margin_market_leverage, **kwargs): # noqa: E501 - """Set the user market leverage multiple. # 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 @@ -979,7 +979,7 @@ def set_user_market_leverage(self, margin_market_leverage, **kwargs): # noqa: E return self.set_user_market_leverage_with_http_info(margin_market_leverage, **kwargs) # noqa: E501 def set_user_market_leverage_with_http_info(self, margin_market_leverage, **kwargs): # noqa: E501 - """Set the user market leverage multiple. # 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 @@ -1067,16 +1067,16 @@ def set_user_market_leverage_with_http_info(self, margin_market_leverage, **kwar collection_formats=collection_formats) def list_margin_user_account(self, **kwargs): # noqa: E501 - """Query the user's leverage account list. # noqa: E501 + """Query user's isolated margin account list # noqa: E501 - Support querying risk rate per position account and margin rate per position account # 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_margin_user_account(async_req=True) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. + :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. @@ -1092,16 +1092,16 @@ def list_margin_user_account(self, **kwargs): # noqa: E501 return self.list_margin_user_account_with_http_info(**kwargs) # noqa: E501 def list_margin_user_account_with_http_info(self, **kwargs): # noqa: E501 - """Query the user's leverage account list. # noqa: E501 + """Query user's isolated margin account list # noqa: E501 - Support querying risk rate per position account and margin rate per position account # 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_margin_user_account_with_http_info(async_req=True) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. + :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 @@ -1177,19 +1177,19 @@ def list_margin_user_account_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_cross_margin_loans(self, status, **kwargs): # noqa: E501 - """List cross margin borrow history. (deprecated). # noqa: E501 + """Query cross margin borrow history (deprecated) # noqa: E501 - Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # 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.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 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 @@ -1206,19 +1206,19 @@ def list_cross_margin_loans(self, status, **kwargs): # noqa: E501 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. (deprecated). # noqa: E501 + """Query cross margin borrow history (deprecated) # noqa: E501 - Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # 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.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 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 @@ -1317,9 +1317,9 @@ def list_cross_margin_loans_with_http_info(self, status, **kwargs): # noqa: E50 collection_formats=collection_formats) def list_cross_margin_repayments(self, **kwargs): # noqa: E501 - """Retrieve cross margin repayments. (deprecated). # noqa: E501 + """Retrieve cross margin repayments. (deprecated) # noqa: E501 - Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # 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.list_cross_margin_repayments(async_req=True) @@ -1328,8 +1328,8 @@ def list_cross_margin_repayments(self, **kwargs): # noqa: E501 :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 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 @@ -1346,9 +1346,9 @@ def list_cross_margin_repayments(self, **kwargs): # noqa: E501 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. (deprecated). # noqa: E501 + """Retrieve cross margin repayments. (deprecated) # noqa: E501 - Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. # 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.list_cross_margin_repayments_with_http_info(async_req=True) @@ -1357,8 +1357,8 @@ def list_cross_margin_repayments_with_http_info(self, **kwargs): # noqa: E501 :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 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 diff --git a/gate_api/api/margin_uni_api.py b/gate_api/api/margin_uni_api.py index 7f6f473..6ba4bde 100644 --- a/gate_api/api/margin_uni_api.py +++ b/gate_api/api/margin_uni_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,7 +37,7 @@ def __init__(self, api_client=None): self.api_client = api_client def list_uni_currency_pairs(self, **kwargs): # noqa: E501 - """List lending markets. # noqa: E501 + """List lending markets # 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_currency_pairs(self, **kwargs): # noqa: E501 return self.list_uni_currency_pairs_with_http_info(**kwargs) # noqa: E501 def list_uni_currency_pairs_with_http_info(self, **kwargs): # noqa: E501 - """List lending markets. # noqa: E501 + """List lending markets # 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_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 @@ -148,7 +148,7 @@ def get_uni_currency_pair(self, currency_pair, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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. @@ -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 @@ -172,7 +172,7 @@ def get_uni_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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 @@ -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 @@ -381,10 +381,10 @@ def list_uni_loans(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :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 str currency_pair: Currency pair + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -408,10 +408,10 @@ def list_uni_loans_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :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 str currency_pair: Currency pair + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -502,7 +502,7 @@ def list_uni_loans_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_uni_loan(self, create_uni_loan, **kwargs): # noqa: E501 - """Borrow or repay. # noqa: E501 + """Borrow or repay # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -526,7 +526,7 @@ def create_uni_loan(self, create_uni_loan, **kwargs): # noqa: E501 return self.create_uni_loan_with_http_info(create_uni_loan, **kwargs) # noqa: E501 def create_uni_loan_with_http_info(self, create_uni_loan, **kwargs): # noqa: E501 - """Borrow or repay. # noqa: E501 + """Borrow or repay # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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 currency_pair: Currency pair. - :param int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :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 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 currency_pair: Currency pair. - :param int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :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 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 @@ -756,10 +756,10 @@ def list_uni_loan_interest_records(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :param str currency: Retrieve data of the specified currency. - :param int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :param str currency_pair: Currency pair + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -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 @@ -785,10 +785,10 @@ def list_uni_loan_interest_records_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :param str currency: Retrieve data of the specified currency. - :param int page: Page number. - :param int limit: Maximum number of records to be returned in a single list. + :param str currency_pair: Currency pair + :param str currency: Query by specified currency name + :param int page: Page number + :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 @@ -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,8 +895,8 @@ 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_pair: Currency pair. (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 data. Default is True. @@ -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,8 +920,8 @@ 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_pair: Currency pair. (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 :param _preload_content: if False, the urllib3.HTTPResponse object will diff --git a/gate_api/api/multi_collateral_loan_api.py b/gate_api/api/multi_collateral_loan_api.py index ac80d44..4578f3f 100644 --- a/gate_api/api/multi_collateral_loan_api.py +++ b/gate_api/api/multi_collateral_loan_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -45,9 +45,9 @@ def list_multi_collateral_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :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: Query the current interest rate of the currency in the previous hour. + :param int page: Page number + :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 @@ -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 @@ -72,9 +72,9 @@ def list_multi_collateral_orders_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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: Query the current interest rate of the currency in the previous hour. + :param int page: Page number + :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 @@ -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 @@ -402,12 +402,12 @@ def list_multi_repay_records(self, type, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 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 @@ -431,12 +431,12 @@ def list_multi_repay_records_with_http_info(self, type, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :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 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 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 @@ -653,7 +653,7 @@ def repay_multi_collateral_loan_with_http_info(self, repay_multi_loan, **kwargs) collection_formats=collection_formats) def list_multi_collateral_records(self, **kwargs): # noqa: E501 - """Query collateral adjustment records. # noqa: E501 + """Query collateral adjustment records # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -661,11 +661,11 @@ def list_multi_collateral_records(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 page: Page number + :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. @@ -681,7 +681,7 @@ def list_multi_collateral_records(self, **kwargs): # noqa: E501 return self.list_multi_collateral_records_with_http_info(**kwargs) # noqa: E501 def list_multi_collateral_records_with_http_info(self, **kwargs): # noqa: E501 - """Query collateral adjustment records. # noqa: E501 + """Query collateral adjustment records # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -689,11 +689,11 @@ def list_multi_collateral_records_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 page: Page number + :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 type: collateral - Collateral currency, borrow - Borrowing. (required) - :param str currency: When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (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 type: collateral - Collateral currency, borrow - Borrowing. (required) - :param str currency: When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (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 previous 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 currency name query array, separated by commas, maximum 100items. (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 previous 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 currency name query array, separated by commas, maximum 100items. (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 2ba2988..3c6fd4a 100644 --- a/gate_api/api/options_api.py +++ b/gate_api/api/options_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -148,7 +148,7 @@ def list_options_expirations(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -172,7 +172,7 @@ def list_options_expirations_with_http_info(self, underlying, **kwargs): # noqa >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -260,8 +260,8 @@ def list_options_contracts(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :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 str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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 @@ -285,8 +285,8 @@ def list_options_contracts_with_http_info(self, underlying, **kwargs): # noqa: >>> result = thread.get() :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 str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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 @@ -481,7 +481,7 @@ def get_options_contract_with_http_info(self, contract, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_options_settlements(self, underlying, **kwargs): # noqa: E501 - """List settlement history. # noqa: E501 + """List settlement history # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -489,9 +489,9 @@ def list_options_settlements(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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 _preload_content: if False, the urllib3.HTTPResponse object will @@ -509,7 +509,7 @@ def list_options_settlements(self, underlying, **kwargs): # noqa: E501 return self.list_options_settlements_with_http_info(underlying, **kwargs) # noqa: E501 def list_options_settlements_with_http_info(self, underlying, **kwargs): # noqa: E501 - """List settlement history. # noqa: E501 + """List settlement history # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -517,9 +517,9 @@ def list_options_settlements_with_http_info(self, underlying, **kwargs): # noqa >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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 _return_http_data_only: response data without head status code @@ -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 @@ -628,7 +628,7 @@ def get_options_settlement(self, contract, underlying, at, **kwargs): # noqa: E :param bool async_req: execute request asynchronously :param str contract: (required) - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param int at: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -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 @@ -654,7 +654,7 @@ def get_options_settlement_with_http_info(self, contract, underlying, at, **kwar :param bool async_req: execute request asynchronously :param str contract: (required) - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param int at: (required) :param _return_http_data_only: response data without head status code and headers @@ -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 @@ -757,10 +757,10 @@ def list_my_options_settlements(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name + :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 _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -786,10 +786,10 @@ def list_my_options_settlements_with_http_info(self, underlying, **kwargs): # n >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name + :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 _return_http_data_only: response data without head status code @@ -892,19 +892,19 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_options_order_book(contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str contract: Options contract name (required) + :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,19 +920,19 @@ 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 + 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 asynchronous HTTP request, please pass async_req=True >>> thread = api.list_options_order_book_with_http_info(contract, async_req=True) >>> result = thread.get() :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 to return depth update ID. This ID increments by 1 each time. + :param str contract: Options contract name (required) + :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 @@ -1033,7 +1033,7 @@ def list_options_tickers(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1057,7 +1057,7 @@ def list_options_tickers_with_http_info(self, underlying, **kwargs): # noqa: E5 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -1145,7 +1145,7 @@ def list_options_underlying_tickers(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. (required) + :param str underlying: Underlying (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is 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 @@ -1169,7 +1169,7 @@ def list_options_underlying_tickers_with_http_info(self, underlying, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. (required) + :param str underlying: Underlying (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -1257,11 +1257,11 @@ def list_options_candlesticks(self, contract, **kwargs): # noqa: E501 >>> result = thread.get() :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 str contract: Options contract name (required) + :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: Interval time between data points. + :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 @@ -1285,11 +1285,11 @@ def list_options_candlesticks_with_http_info(self, contract, **kwargs): # noqa: >>> result = thread.get() :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 str contract: Options contract name (required) + :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: Interval time between data points. + :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 @@ -1393,11 +1393,11 @@ def list_options_underlying_candlesticks(self, underlying, **kwargs): # noqa: E >>> result = thread.get() :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 str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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: Interval time between data points. + :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 @@ -1421,11 +1421,11 @@ def list_options_underlying_candlesticks_with_http_info(self, underlying, **kwar >>> result = thread.get() :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 str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :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: Interval time between data points. + :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 @@ -1529,10 +1529,10 @@ def list_options_trades(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 int offset: List offset, starting from 0. + :param str contract: Options contract name + :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 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 @@ -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 @@ -1558,10 +1558,10 @@ def list_options_trades_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 int offset: List offset, starting from 0. + :param str contract: Options contract name + :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 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 @@ -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 offset: List offset, starting from 0. + :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 str type: Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL + :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 offset: List offset, starting from 0. + :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 str type: Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL + :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 @@ -1897,7 +1897,7 @@ def list_options_account_book_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_options_positions(self, **kwargs): # noqa: E501 - """List user's positions of specified underlying. # noqa: E501 + """List user's positions of specified underlying # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1905,7 +1905,7 @@ def list_options_positions(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. + :param str underlying: Underlying :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1921,7 +1921,7 @@ def list_options_positions(self, **kwargs): # noqa: E501 return self.list_options_positions_with_http_info(**kwargs) # noqa: E501 def list_options_positions_with_http_info(self, **kwargs): # noqa: E501 - """List user's positions of specified underlying. # noqa: E501 + """List user's positions of specified underlying # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1929,7 +1929,7 @@ def list_options_positions_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. + :param str underlying: Underlying :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -2005,7 +2005,7 @@ def list_options_positions_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_options_position(self, contract, **kwargs): # noqa: E501 - """Get specified contract position. # noqa: E501 + """Get specified contract position # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2029,7 +2029,7 @@ def get_options_position(self, contract, **kwargs): # noqa: E501 return self.get_options_position_with_http_info(contract, **kwargs) # noqa: E501 def get_options_position_with_http_info(self, contract, **kwargs): # noqa: E501 - """Get specified contract position. # noqa: E501 + """Get specified contract position # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2117,7 +2117,7 @@ def get_options_position_with_http_info(self, contract, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_options_position_close(self, underlying, **kwargs): # noqa: E501 - """List user's liquidation history of specified underlying. # noqa: E501 + """List user's liquidation history of specified underlying # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2125,8 +2125,8 @@ def list_options_position_close(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) - :param str contract: Options contract name. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2142,7 +2142,7 @@ def list_options_position_close(self, underlying, **kwargs): # noqa: E501 return self.list_options_position_close_with_http_info(underlying, **kwargs) # noqa: E501 def list_options_position_close_with_http_info(self, underlying, **kwargs): # noqa: E501 - """List user's liquidation history of specified underlying. # noqa: E501 + """List user's liquidation history of specified underlying # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2150,8 +2150,8 @@ def list_options_position_close_with_http_info(self, underlying, **kwargs): # n >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying (Obtained by listing underlying endpoint). (required) - :param str contract: Options contract name. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -2234,7 +2234,7 @@ def list_options_position_close_with_http_info(self, underlying, **kwargs): # n collection_formats=collection_formats) def list_options_orders(self, status, **kwargs): # noqa: E501 - """List options orders. # noqa: E501 + """List options orders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2242,11 +2242,11 @@ 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 contract: Options contract name. - :param str underlying: Underlying. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 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 _preload_content: if False, the urllib3.HTTPResponse object will @@ -2264,7 +2264,7 @@ def list_options_orders(self, status, **kwargs): # noqa: E501 return self.list_options_orders_with_http_info(status, **kwargs) # noqa: E501 def list_options_orders_with_http_info(self, status, **kwargs): # noqa: E501 - """List options orders. # noqa: E501 + """List options orders # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2272,11 +2272,11 @@ 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 contract: Options contract name. - :param str underlying: Underlying. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 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 _return_http_data_only: response data without head status code @@ -2382,7 +2382,7 @@ def list_options_orders_with_http_info(self, status, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_options_order(self, options_order, **kwargs): # noqa: E501 - """Create an options order. # noqa: E501 + """Create an options order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2406,7 +2406,7 @@ def create_options_order(self, options_order, **kwargs): # noqa: E501 return self.create_options_order_with_http_info(options_order, **kwargs) # noqa: E501 def create_options_order_with_http_info(self, options_order, **kwargs): # noqa: E501 - """Create an options order. # noqa: E501 + """Create an options order # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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 @@ -2506,9 +2506,9 @@ def cancel_options_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 contract: Options contract name + :param str underlying: Underlying + :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 @@ -2532,9 +2532,9 @@ def cancel_options_orders_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 contract: Options contract name + :param str underlying: Underlying + :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 @@ -2840,7 +2840,7 @@ def cancel_options_order_with_http_info(self, order_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def countdown_cancel_all_options(self, countdown_cancel_all_options_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # 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, 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 @@ -2865,7 +2865,7 @@ def countdown_cancel_all_options(self, countdown_cancel_all_options_task, **kwar return self.countdown_cancel_all_options_with_http_info(countdown_cancel_all_options_task, **kwargs) # noqa: E501 def countdown_cancel_all_options_with_http_info(self, countdown_cancel_all_options_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # 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, 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 @@ -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 @@ -2966,10 +2966,10 @@ def list_my_options_trades(self, underlying, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name + :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 _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -2995,10 +2995,10 @@ def list_my_options_trades_with_http_info(self, underlying, **kwargs): # noqa: >>> result = thread.get() :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 offset: List offset, starting from 0. + :param str underlying: Underlying (Obtained by listing underlying endpoint) (required) + :param str contract: Options contract name + :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 _return_http_data_only: response data without head status code @@ -3109,7 +3109,7 @@ def get_options_mmp(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. + :param str underlying: Underlying :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -3133,7 +3133,7 @@ def get_options_mmp_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str underlying: Underlying. + :param str underlying: Underlying :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/rebate_api.py b/gate_api/api/rebate_api.py index aab8176..f04f15e 100644 --- a/gate_api/api/rebate_api.py +++ b/gate_api/api/rebate_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,21 +37,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 data. Default is True. @@ -67,21 +67,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -178,21 +178,22 @@ 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 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 offset: List offset, starting from 0. + :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: 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 data. Default is True. @@ -208,21 +209,22 @@ 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 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 offset: List offset, starting from 0. + :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: 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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,21 +324,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 data. Default is True. @@ -349,21 +354,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -460,21 +465,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 data. Default is True. @@ -490,21 +495,21 @@ 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 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 offset: List offset, starting from 0. + :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: 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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -601,18 +606,18 @@ def partner_commissions_history_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def partner_sub_list(self, **kwargs): # noqa: E501 - """Partner subordinate list. # 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param int user_id: User ID. If not specified, all user records will be returned + :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 data. Default is True. @@ -628,18 +633,18 @@ def partner_sub_list(self, **kwargs): # noqa: E501 return self.partner_sub_list_with_http_info(**kwargs) # noqa: E501 def partner_sub_list_with_http_info(self, **kwargs): # noqa: E501 - """Partner subordinate list. # 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) >>> result = thread.get() :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 offset: List offset, starting from 0. + :param int user_id: User ID. If not specified, all user records will be returned + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 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 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: 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 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 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: 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 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 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: 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 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 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: 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 @@ -1102,16 +1107,16 @@ def rebate_user_info_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def user_sub_relation(self, user_id_list, **kwargs): # noqa: E501 - """User-subordinate relationship. # noqa: E501 + """User subordinate relationship # noqa: E501 - Query whether the specified user is in the system. # 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 the user's ID list, split by,, if there are more than 100, take 100. (required) + :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. @@ -1127,16 +1132,16 @@ def user_sub_relation(self, user_id_list, **kwargs): # noqa: E501 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 + """User subordinate relationship # noqa: E501 - Query whether the specified user is in the system. # 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 the user's ID list, split by,, if there are more than 100, take 100. (required) + :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 diff --git a/gate_api/api/spot_api.py b/gate_api/api/spot_api.py index bce4696..1894742 100644 --- a/gate_api/api/spot_api.py +++ b/gate_api/api/spot_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 - 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 + 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 - 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 + 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 @@ -150,7 +150,7 @@ def get_currency(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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. @@ -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 @@ -174,7 +174,7 @@ def get_currency_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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 @@ -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 @@ -365,7 +365,7 @@ def get_currency_pair(self, currency_pair, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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. @@ -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 @@ -389,7 +389,7 @@ def get_currency_pair_with_http_info(self, currency_pair, **kwargs): # noqa: E5 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: 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 @@ -469,17 +469,17 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :param str timezone: Timezone. + :param str currency_pair: Currency pair + :param str timezone: Timezone :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -495,17 +495,17 @@ 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency_pair: Currency pair. - :param str timezone: Timezone. + :param str currency_pair: Currency pair + :param str timezone: Timezone :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -584,19 +584,19 @@ 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 - Market depth buy orders are sorted by price from high to low, sell orders are reversed # 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) >>> result = thread.get() :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 currency_pair: Currency pair (required) + :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,19 +612,19 @@ 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 - Market depth buy orders are sorted by price from high to low, sell orders are reversed # 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) >>> result = thread.get() :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 currency_pair: Currency pair (required) + :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,22 +715,22 @@ 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 - Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. 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 + 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) >>> result = thread.get() :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 the currency name to query in batches, and support up to 100 pass parameters at a time. - :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 page: Page number. + :param str currency_pair: Currency pair (required) + :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 data. Default is True. @@ -746,22 +746,22 @@ 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 - Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. 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 + 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) >>> result = thread.get() :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 the currency name to query in batches, and support up to 100 pass parameters at a time. - :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 page: Page number. + :param str currency_pair: Currency pair (required) + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -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 @@ -874,11 +874,11 @@ def list_candlesticks(self, currency_pair, **kwargs): # noqa: E501 >>> result = thread.get() :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 str currency_pair: Currency pair (required) + :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: 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 specified - :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 @@ -903,11 +903,11 @@ def list_candlesticks_with_http_info(self, currency_pair, **kwargs): # noqa: E5 >>> result = thread.get() :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 str currency_pair: Currency pair (required) + :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: 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 specified - :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,22 +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 - Record query time range is not allowed to exceed 30 days. 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 + 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 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 str code: Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` + :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 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. @@ -1362,22 +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 - Record query time range is not allowed to exceed 30 days. 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 + 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 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 str code: Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` + :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 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 @@ -1477,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) @@ -1503,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) @@ -1600,7 +1600,7 @@ def create_batch_orders_with_http_info(self, order, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_all_open_orders(self, **kwargs): # noqa: E501 - """List all open orders. # noqa: E501 + """List all open orders # 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 @@ -1609,9 +1609,9 @@ def list_all_open_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 query account. + :param int page: Page number + :param int limit: Maximum number of records returned in one page in each currency pair + :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. @@ -1627,7 +1627,7 @@ def list_all_open_orders(self, **kwargs): # noqa: E501 return self.list_all_open_orders_with_http_info(**kwargs) # noqa: E501 def list_all_open_orders_with_http_info(self, **kwargs): # noqa: E501 - """List all open orders. # noqa: E501 + """List all open orders # 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 @@ -1636,9 +1636,9 @@ def list_all_open_orders_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 query account. + :param int page: Page number + :param int limit: Maximum number of records returned in one page in each currency pair + :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 @@ -1726,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) @@ -1751,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) @@ -1844,23 +1844,23 @@ def create_cross_liquidate_order_with_http_info(self, liquidate_order, **kwargs) collection_formats=collection_formats) def list_orders(self, currency_pair, status, **kwargs): # noqa: E501 - """List orders. # noqa: E501 + """List orders # noqa: E501 - Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end 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 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 query account. - :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. @@ -1876,23 +1876,23 @@ def list_orders(self, currency_pair, status, **kwargs): # noqa: E501 return self.list_orders_with_http_info(currency_pair, status, **kwargs) # noqa: E501 def list_orders_with_http_info(self, currency_pair, status, **kwargs): # noqa: E501 - """List orders. # noqa: E501 + """List orders # noqa: E501 - Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end 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 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 query account. - :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 @@ -2003,9 +2003,9 @@ def list_orders_with_http_info(self, currency_pair, status, **kwargs): # noqa: collection_formats=collection_formats) def create_order(self, order, **kwargs): # noqa: E501 - """Create an order. # noqa: E501 + """Create an order # noqa: E501 - Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions # 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) @@ -2029,9 +2029,9 @@ def create_order(self, order, **kwargs): # noqa: E501 return self.create_order_with_http_info(order, **kwargs) # noqa: E501 def create_order_with_http_info(self, order, **kwargs): # noqa: E501 - """Create an order. # noqa: E501 + """Create an order # noqa: E501 - Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions # 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) @@ -2126,19 +2126,19 @@ def create_order_with_http_info(self, order, **kwargs): # noqa: E501 collection_formats=collection_formats) def cancel_orders(self, **kwargs): # noqa: E501 - """Cancel all `open` orders in specified currency pair. # noqa: E501 + """Cancel all `open` orders in specified currency pair # noqa: E501 - When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under 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) >>> result = thread.get() :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: 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 currency_pair: Currency pair + :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 @@ -2155,19 +2155,19 @@ def cancel_orders(self, **kwargs): # noqa: E501 return self.cancel_orders_with_http_info(**kwargs) # noqa: E501 def cancel_orders_with_http_info(self, **kwargs): # noqa: E501 - """Cancel all `open` orders in specified currency pair. # noqa: E501 + """Cancel all `open` orders in specified currency pair # noqa: E501 - When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under 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) >>> result = thread.get() :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: 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 currency_pair: Currency pair + :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 @@ -2256,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 @@ -2282,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 @@ -2379,9 +2379,9 @@ 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 - By default, orders for spot, unified account and warehouse-by-site leverage account are checked. # 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) @@ -2389,8 +2389,8 @@ def get_order(self, order_id, currency_pair, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) - :param str account: Specify query account. + :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. @@ -2406,9 +2406,9 @@ 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 - By default, orders for spot, unified account and warehouse-by-site leverage account are checked. # 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) @@ -2416,8 +2416,8 @@ def get_order_with_http_info(self, order_id, currency_pair, **kwargs): # noqa: :param bool async_req: execute request asynchronously :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 transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) - :param str account: Specify query account. + :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 @@ -2507,7 +2507,7 @@ 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 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 @@ -2517,9 +2517,9 @@ def cancel_order(self, order_id, currency_pair, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 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 currency_pair: Currency pair (required) + :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 @@ -2536,7 +2536,7 @@ 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 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 @@ -2546,9 +2546,9 @@ def cancel_order_with_http_info(self, order_id, currency_pair, **kwargs): # noq :param bool async_req: execute request asynchronously :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 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 currency_pair: Currency pair (required) + :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 @@ -2645,7 +2645,7 @@ 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 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 @@ -2656,8 +2656,8 @@ def amend_order(self, order_id, order_patch, **kwargs): # noqa: E501 :param bool async_req: execute request asynchronously :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 query account. + :param str currency_pair: Currency pair + :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 @@ -2674,7 +2674,7 @@ 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 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 @@ -2685,8 +2685,8 @@ def amend_order_with_http_info(self, order_id, order_patch, **kwargs): # noqa: :param bool async_req: execute request asynchronously :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 query account. + :param str currency_pair: Currency pair + :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 @@ -2787,7 +2787,7 @@ 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 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 @@ -2796,13 +2796,13 @@ def list_my_trades(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 page: Page number. + :param str currency_pair: Retrieve results with specified currency pair + :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 query account. - :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. @@ -2818,7 +2818,7 @@ 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 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 @@ -2827,13 +2827,13 @@ def list_my_trades_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 page: Page number. + :param str currency_pair: Retrieve results with specified currency pair + :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 query account. - :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 @@ -2933,7 +2933,7 @@ def list_my_trades_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_system_time(self, **kwargs): # noqa: E501 - """Get server current time. # noqa: E501 + """Get server current time # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2956,7 +2956,7 @@ def get_system_time(self, **kwargs): # noqa: E501 return self.get_system_time_with_http_info(**kwargs) # noqa: E501 def get_system_time_with_http_info(self, **kwargs): # noqa: E501 - """Get server current time. # noqa: E501 + """Get server current time # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3036,7 +3036,7 @@ def get_system_time_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def countdown_cancel_all_spot(self, countdown_cancel_all_spot_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # noqa: E501 + """Countdown cancel orders # 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 @@ -3061,7 +3061,7 @@ def countdown_cancel_all_spot(self, countdown_cancel_all_spot_task, **kwargs): return self.countdown_cancel_all_spot_with_http_info(countdown_cancel_all_spot_task, **kwargs) # noqa: E501 def countdown_cancel_all_spot_with_http_info(self, countdown_cancel_all_spot_task, **kwargs): # noqa: E501 - """Countdown cancel orders. # noqa: E501 + """Countdown cancel orders # 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 @@ -3154,9 +3154,9 @@ def countdown_cancel_all_spot_with_http_info(self, countdown_cancel_all_spot_tas collection_formats=collection_formats) def amend_batch_orders(self, batch_amend_item, **kwargs): # noqa: E501 - """Batch modification of orders. # noqa: E501 + """Batch modification of orders # 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 is consistent with the order list order. # 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) @@ -3180,9 +3180,9 @@ def amend_batch_orders(self, batch_amend_item, **kwargs): # noqa: E501 return self.amend_batch_orders_with_http_info(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 + """Batch modification of orders # 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 is consistent with the order list order. # 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) @@ -3277,7 +3277,7 @@ def amend_batch_orders_with_http_info(self, batch_amend_item, **kwargs): # noqa collection_formats=collection_formats) def get_spot_insurance_history(self, business, currency, _from, to, **kwargs): # noqa: E501 - """Query spot insurance fund historical data. # noqa: E501 + """Query spot insurance fund historical data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3286,11 +3286,11 @@ 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 page: Page number. - :param int limit: The maximum number of items returned in the list, the default value is 30. + :param str currency: Currency (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 be returned without reading/decoding response data. Default is True. @@ -3306,7 +3306,7 @@ def get_spot_insurance_history(self, business, currency, _from, to, **kwargs): return self.get_spot_insurance_history_with_http_info(business, currency, _from, to, **kwargs) # noqa: E501 def get_spot_insurance_history_with_http_info(self, business, currency, _from, to, **kwargs): # noqa: E501 - """Query spot insurance fund historical data. # noqa: E501 + """Query spot insurance fund historical data # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3315,11 +3315,11 @@ 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 page: Page number. - :param int limit: The maximum number of items returned in the list, the default value is 30. + :param str currency: Currency (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 and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -3432,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 @@ -3440,11 +3440,11 @@ 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 `unified`. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 data. Default is True. @@ -3460,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 @@ -3468,11 +3468,11 @@ 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 `unified`. - :param int limit: Maximum number of records to be returned in a single list. - :param int offset: List offset, starting from 0. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -3570,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 @@ -3594,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 @@ -3686,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 Price-triggered 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 @@ -3694,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 `unified`. + :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. @@ -3711,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 Price-triggered 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 @@ -3719,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 `unified`. + :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 @@ -3799,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 @@ -3807,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. @@ -3823,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 @@ -3831,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 @@ -3911,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 @@ -3919,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. @@ -3935,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 @@ -3943,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 eb7fbbe..2c864c3 100644 --- a/gate_api/api/sub_account_api.py +++ b/gate_api/api/sub_account_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,7 +37,7 @@ def __init__(self, api_client=None): self.api_client = api_client def list_sub_accounts(self, **kwargs): # noqa: E501 - """List sub-accounts. # noqa: E501 + """List sub-accounts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -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. @@ -61,7 +61,7 @@ def list_sub_accounts(self, **kwargs): # noqa: E501 return self.list_sub_accounts_with_http_info(**kwargs) # noqa: E501 def list_sub_accounts_with_http_info(self, **kwargs): # noqa: E501 - """List sub-accounts. # noqa: E501 + """List sub-accounts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=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 @@ -145,7 +145,7 @@ def list_sub_accounts_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_sub_accounts(self, sub_account, **kwargs): # noqa: E501 - """Create a new sub-account. # noqa: E501 + """Create a new sub-account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -169,7 +169,7 @@ def create_sub_accounts(self, sub_account, **kwargs): # noqa: E501 return self.create_sub_accounts_with_http_info(sub_account, **kwargs) # noqa: E501 def create_sub_accounts_with_http_info(self, sub_account, **kwargs): # noqa: E501 - """Create a new sub-account. # noqa: E501 + """Create a new sub-account # 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 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 @@ -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 @@ -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 @@ -1194,9 +1194,9 @@ def unlock_sub_account_with_http_info(self, user_id, **kwargs): # noqa: E501 collection_formats=collection_formats) def list_unified_mode(self, **kwargs): # noqa: E501 - """Get sub-account mode. # 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) @@ -1218,9 +1218,9 @@ def list_unified_mode(self, **kwargs): # noqa: E501 return self.list_unified_mode_with_http_info(**kwargs) # noqa: E501 def list_unified_mode_with_http_info(self, **kwargs): # noqa: E501 - """Get sub-account mode. # 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 bba6f75..a6deb68 100644 --- a/gate_api/api/unified_api.py +++ b/gate_api/api/unified_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,17 +37,17 @@ def __init__(self, api_client=None): self.api_client = api_client def list_unified_accounts(self, **kwargs): # noqa: E501 - """Get unified account information. # 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 sub_uid: Sub account user ID. + :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. @@ -63,17 +63,17 @@ def list_unified_accounts(self, **kwargs): # noqa: E501 return self.list_unified_accounts_with_http_info(**kwargs) # noqa: E501 def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501 - """Get unified account information. # 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 sub_uid: Sub account user ID. + :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 @@ -152,7 +152,7 @@ def list_unified_accounts_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_unified_borrowable(self, currency, **kwargs): # noqa: E501 - """Query about the maximum borrowing for the unified account. # noqa: E501 + """Query maximum borrowable 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 @@ -160,7 +160,7 @@ def get_unified_borrowable(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 _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -176,7 +176,7 @@ def get_unified_borrowable(self, currency, **kwargs): # noqa: E501 return self.get_unified_borrowable_with_http_info(currency, **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 + """Query maximum borrowable 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 @@ -184,7 +184,7 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5 >>> 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 _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -264,7 +264,7 @@ def get_unified_borrowable_with_http_info(self, currency, **kwargs): # noqa: E5 collection_formats=collection_formats) def get_unified_transferable(self, currency, **kwargs): # noqa: E501 - """Query about the maximum transferable for the unified account. # 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 @@ -272,7 +272,7 @@ def get_unified_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 _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -288,7 +288,7 @@ def get_unified_transferable(self, currency, **kwargs): # noqa: E501 return self.get_unified_transferable_with_http_info(currency, **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 + """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 @@ -296,7 +296,7 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa: >>> 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 _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -376,7 +376,7 @@ def get_unified_transferable_with_http_info(self, currency, **kwargs): # noqa: collection_formats=collection_formats) def get_unified_transferables(self, currencies, **kwargs): # noqa: E501 - """Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. # 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 @@ -384,7 +384,7 @@ def get_unified_transferables(self, currencies, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currencies: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (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. @@ -400,7 +400,7 @@ def get_unified_transferables(self, currencies, **kwargs): # noqa: E501 return self.get_unified_transferables_with_http_info(currencies, **kwargs) # noqa: E501 def get_unified_transferables_with_http_info(self, currencies, **kwargs): # noqa: E501 - """Batch query can be transferred out at most for unified accounts; each currency is the maximum value. After the user withdraws the currency, the amount of transferable currency will be changed. # 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 @@ -408,7 +408,7 @@ def get_unified_transferables_with_http_info(self, currencies, **kwargs): # noq >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currencies: Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (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 @@ -488,7 +488,7 @@ def get_unified_transferables_with_http_info(self, currencies, **kwargs): # noq collection_formats=collection_formats) def get_unified_borrowable_list(self, currencies, **kwargs): # noqa: E501 - """Batch query unified account can be borrowed up to a maximum. # 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 @@ -496,7 +496,7 @@ def get_unified_borrowable_list(self, currencies, **kwargs): # noqa: E501 >>> 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. @@ -512,7 +512,7 @@ def get_unified_borrowable_list(self, currencies, **kwargs): # noqa: E501 return self.get_unified_borrowable_list_with_http_info(currencies, **kwargs) # noqa: E501 def get_unified_borrowable_list_with_http_info(self, currencies, **kwargs): # noqa: E501 - """Batch query unified account can be borrowed up to a maximum. # 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 @@ -520,7 +520,7 @@ def get_unified_borrowable_list_with_http_info(self, currencies, **kwargs): # n >>> 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 @@ -607,7 +607,7 @@ def get_unified_borrowable_list_with_http_info(self, currencies, **kwargs): # n 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 @@ -615,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 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 str currency: Query by specified currency name + :param int page: Page number + :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. @@ -634,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 @@ -642,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 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 str currency: Query by specified currency name + :param int page: Page number + :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 @@ -736,9 +736,9 @@ def list_unified_loans_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def create_unified_loan(self, unified_loan, **kwargs): # noqa: E501 - """Borrow or repay. # 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 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) @@ -761,9 +761,9 @@ def create_unified_loan(self, unified_loan, **kwargs): # noqa: E501 return self.create_unified_loan_with_http_info(unified_loan, **kwargs) # noqa: E501 def create_unified_loan_with_http_info(self, unified_loan, **kwargs): # noqa: E501 - """Borrow or repay. # 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 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) @@ -854,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 @@ -862,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, repaying the borrowed funds - :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 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 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. @@ -881,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 @@ -889,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, repaying the borrowed funds - :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 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 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 @@ -983,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 @@ -991,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 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 str currency: Query by specified currency name + :param int page: Page number + :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. @@ -1012,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 @@ -1020,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 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 str currency: Query by specified currency name + :param int page: Page number + :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 @@ -1122,9 +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 - """Get user risk unit details. # noqa: E501 + """Get user risk unit details # noqa: E501 - Retrieve user risk unit details, only valid in portfolio margin mode. # 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) @@ -1146,9 +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 - """Get user risk unit details. # noqa: E501 + """Get user risk unit details # noqa: E501 - Retrieve user risk unit details, only valid in portfolio margin mode. # 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) @@ -1227,7 +1227,7 @@ def get_unified_risk_units_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_unified_mode(self, **kwargs): # noqa: E501 - """Query mode of the unified account. # noqa: E501 + """Query mode of the unified account # 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 This method makes a synchronous HTTP request by default. To make an @@ -1251,7 +1251,7 @@ def get_unified_mode(self, **kwargs): # noqa: E501 return self.get_unified_mode_with_http_info(**kwargs) # noqa: E501 def get_unified_mode_with_http_info(self, **kwargs): # noqa: E501 - """Query mode of the unified account. # noqa: E501 + """Query mode of the unified account # 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 This method makes a synchronous HTTP request by default. To make an @@ -1332,7 +1332,7 @@ 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 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 @@ -1357,7 +1357,7 @@ 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 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 @@ -1446,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. @@ -1471,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 @@ -1567,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 @@ -1590,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 @@ -1670,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 @@ -1693,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 @@ -1773,9 +1773,9 @@ def list_loan_margin_tiers_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def calculate_portfolio_margin(self, unified_portfolio_input, **kwargs): # noqa: E501 - """Portfolio margin calculator. # 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 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) @@ -1798,9 +1798,9 @@ def calculate_portfolio_margin(self, unified_portfolio_input, **kwargs): # noqa return self.calculate_portfolio_margin_with_http_info(unified_portfolio_input, **kwargs) # noqa: E501 def calculate_portfolio_margin_with_http_info(self, unified_portfolio_input, **kwargs): # noqa: E501 - """Portfolio margin calculator. # 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 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) @@ -1891,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 - """Minimum currency leverage that can be set. # 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 @@ -1899,7 +1899,7 @@ def get_user_leverage_currency_config(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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. @@ -1915,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 - """Minimum currency leverage that can be set. # 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 @@ -1923,7 +1923,7 @@ def get_user_leverage_currency_config_with_http_info(self, currency, **kwargs): >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. (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 @@ -2003,16 +2003,16 @@ 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 leverage multiple of the user currency. # noqa: E501 + """Get user currency leverage # noqa: E501 - Get the user's currency leverage. If currency is not passed, query all currencies. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. + :param str currency: Currency :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2020,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. """ @@ -2028,16 +2028,16 @@ 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 leverage multiple of the user currency. # noqa: E501 + """Get user currency leverage # noqa: E501 - Get the user's currency leverage. If currency is not passed, query all currencies. # 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) >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. + :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 @@ -2047,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. """ @@ -2104,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 @@ -2113,7 +2113,7 @@ def get_user_leverage_currency_setting_with_http_info(self, **kwargs): # noqa: collection_formats=collection_formats) def set_user_leverage_currency_setting(self, unified_leverage_setting, **kwargs): # noqa: E501 - """Set the loan currency leverage. # 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 @@ -2137,7 +2137,7 @@ def set_user_leverage_currency_setting(self, unified_leverage_setting, **kwargs) 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, unified_leverage_setting, **kwargs): # noqa: E501 - """Set the loan currency leverage. # 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 @@ -2225,7 +2225,7 @@ def set_user_leverage_currency_setting_with_http_info(self, unified_leverage_set collection_formats=collection_formats) def list_unified_currencies(self, **kwargs): # noqa: E501 - """List of loan currencies supported by unified account. # 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 @@ -2233,7 +2233,7 @@ def list_unified_currencies(self, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency. + :param str currency: Currency :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -2249,7 +2249,7 @@ def list_unified_currencies(self, **kwargs): # noqa: E501 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 + """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 @@ -2257,7 +2257,7 @@ def list_unified_currencies_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 :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -2333,7 +2333,7 @@ def list_unified_currencies_with_http_info(self, **kwargs): # noqa: E501 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 @@ -2341,10 +2341,10 @@ def get_history_loan_rate(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Currency (required) + :param str tier: VIP level for the floating rate to be queried + :param int page: Page number + :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. @@ -2360,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 @@ -2368,10 +2368,10 @@ def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E50 >>> result = thread.get() :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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Currency (required) + :param str tier: VIP level for the floating rate to be queried + :param int page: Page number + :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 @@ -2466,7 +2466,7 @@ def get_history_loan_rate_with_http_info(self, currency, **kwargs): # noqa: E50 collection_formats=collection_formats) def set_unified_collateral(self, unified_collateral_req, **kwargs): # noqa: E501 - """Set Collateral Currency. # 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 @@ -2490,7 +2490,7 @@ def set_unified_collateral(self, unified_collateral_req, **kwargs): # noqa: E50 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 + """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 diff --git a/gate_api/api/wallet_api.py b/gate_api/api/wallet_api.py index 7466e47..0284850 100644 --- a/gate_api/api/wallet_api.py +++ b/gate_api/api/wallet_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -45,7 +45,7 @@ def list_currency_chains(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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. @@ -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 @@ -69,7 +69,7 @@ def list_currency_chains_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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 @@ -149,7 +149,7 @@ def list_currency_chains_with_http_info(self, currency, **kwargs): # noqa: E501 collection_formats=collection_formats) def get_deposit_address(self, currency, **kwargs): # noqa: E501 - """Generate currency deposit address. # noqa: E501 + """Generate currency deposit address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -157,7 +157,7 @@ def get_deposit_address(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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. @@ -173,7 +173,7 @@ def get_deposit_address(self, currency, **kwargs): # noqa: E501 return self.get_deposit_address_with_http_info(currency, **kwargs) # noqa: E501 def get_deposit_address_with_http_info(self, currency, **kwargs): # noqa: E501 - """Generate currency deposit address. # noqa: E501 + """Generate currency deposit address # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -181,7 +181,7 @@ def get_deposit_address_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :param bool async_req: execute request asynchronously - :param str currency: Currency name. (required) + :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 @@ -261,23 +261,23 @@ 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 str withdraw_id: The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time - :param str asset_class: The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone - :param str withdraw_order_id: User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried - :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 offset: List offset, starting from 0. + :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 data. Default is True. @@ -293,23 +293,23 @@ 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 str withdraw_id: The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time - :param str asset_class: The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone - :param str withdraw_order_id: User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried - :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 offset: List offset, starting from 0. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -412,20 +412,20 @@ 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 int offset: List offset, starting from 0. + :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 data. Default is True. @@ -441,20 +441,20 @@ 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 int offset: List offset, starting from 0. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -548,9 +548,9 @@ def list_deposits_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def transfer(self, transfer, **kwargs): # noqa: E501 - """Transfer between trading accounts. # 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. 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) @@ -573,9 +573,9 @@ def transfer(self, transfer, **kwargs): # noqa: E501 return self.transfer_with_http_info(transfer, **kwargs) # noqa: E501 def transfer_with_http_info(self, transfer, **kwargs): # noqa: E501 - """Transfer between trading accounts. # 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. 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) @@ -666,20 +666,20 @@ 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 20-04-10can 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 int offset: List offset, starting from 0. + :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 data. Default is True. @@ -695,20 +695,20 @@ 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 20-04-10can 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 int offset: List offset, starting from 0. + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -802,9 +802,9 @@ def list_sub_account_transfers_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def transfer_with_sub_account(self, sub_account_transfer, **kwargs): # noqa: E501 - """Transfer between main and sub accounts. # 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) @@ -827,9 +827,9 @@ def transfer_with_sub_account(self, sub_account_transfer, **kwargs): # noqa: E5 return self.transfer_with_sub_account_with_http_info(sub_account_transfer, **kwargs) # noqa: E501 def transfer_with_sub_account_with_http_info(self, sub_account_transfer, **kwargs): # noqa: E501 - """Transfer between main and sub accounts. # 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) @@ -920,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 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) @@ -945,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 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) @@ -1038,17 +1038,17 @@ def sub_account_to_sub_account_with_http_info(self, sub_account_to_sub_account, collection_formats=collection_formats) def get_transfer_order_status(self, **kwargs): # noqa: E501 - """Transfer status query. # 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. @@ -1064,17 +1064,17 @@ def get_transfer_order_status(self, **kwargs): # noqa: E501 return self.get_transfer_order_status_with_http_info(**kwargs) # noqa: E501 def get_transfer_order_status_with_http_info(self, **kwargs): # noqa: E501 - """Transfer status query. # 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 @@ -1153,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 @@ -1161,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. @@ -1177,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 @@ -1185,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 @@ -1261,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 @@ -1269,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. @@ -1285,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 @@ -1293,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 @@ -1369,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 @@ -1377,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. @@ -1393,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 @@ -1401,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 @@ -1477,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 @@ -1485,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. @@ -1502,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 @@ -1510,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 @@ -1590,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 @@ -1598,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. @@ -1614,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 @@ -1622,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 @@ -1698,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 @@ -1706,10 +1706,10 @@ def list_saved_address(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :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 int page: Page number. + :param str currency: Currency (required) + :param str chain: Chain name + :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 data. Default is True. @@ -1725,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 @@ -1733,10 +1733,10 @@ def list_saved_address_with_http_info(self, currency, **kwargs): # noqa: E501 >>> result = thread.get() :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 int page: Page number. + :param str currency: Currency (required) + :param str chain: Chain name + :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 :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1827,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 @@ -1835,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. @@ -1852,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 @@ -1860,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 @@ -1940,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` /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. @@ -1965,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` /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 @@ -2050,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 @@ -2073,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 @@ -2153,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 @@ -2177,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 @@ -2265,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 @@ -2273,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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Currency to convert + :param int page: Page number + :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. @@ -2291,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 @@ -2299,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 int page: Page number. - :param int limit: Maximum response items. Default: 100, minimum: 1, Maximum: 100. + :param str currency: Currency to convert + :param int page: Page number + :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 @@ -2389,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 @@ -2397,12 +2397,12 @@ def list_push_orders(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. - :param str transaction_type: The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. + :param int id: Order ID + :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. @@ -2418,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 @@ -2426,12 +2426,12 @@ def list_push_orders_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :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 offset: List offset, starting from 0. - :param str transaction_type: The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. + :param int id: Order ID + :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 diff --git a/gate_api/api/withdrawal_api.py b/gate_api/api/withdrawal_api.py index 1d5f282..7fb64dd 100644 --- a/gate_api/api/withdrawal_api.py +++ b/gate_api/api/withdrawal_api.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -37,9 +37,9 @@ def __init__(self, api_client=None): self.api_client = api_client def withdraw(self, ledger_record, **kwargs): # noqa: E501 - """Withdraw. # 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) @@ -62,9 +62,9 @@ def withdraw(self, ledger_record, **kwargs): # noqa: E501 return self.withdraw_with_http_info(ledger_record, **kwargs) # noqa: E501 def withdraw_with_http_info(self, ledger_record, **kwargs): # noqa: E501 - """Withdraw. # 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) @@ -155,9 +155,9 @@ def withdraw_with_http_info(self, ledger_record, **kwargs): # noqa: E501 collection_formats=collection_formats) def withdraw_push_order(self, uid_push_withdrawal, **kwargs): # noqa: E501 - """UID transfer. # 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) @@ -180,9 +180,9 @@ def withdraw_push_order(self, uid_push_withdrawal, **kwargs): # noqa: E501 return self.withdraw_push_order_with_http_info(uid_push_withdrawal, **kwargs) # noqa: E501 def withdraw_push_order_with_http_info(self, uid_push_withdrawal, **kwargs): # noqa: E501 - """UID transfer. # 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) @@ -273,7 +273,7 @@ def withdraw_push_order_with_http_info(self, uid_push_withdrawal, **kwargs): # collection_formats=collection_formats) def cancel_withdrawal(self, withdrawal_id, **kwargs): # noqa: E501 - """Cancel withdrawal with specified ID. # noqa: E501 + """Cancel withdrawal with specified ID # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -297,7 +297,7 @@ def cancel_withdrawal(self, withdrawal_id, **kwargs): # noqa: E501 return self.cancel_withdrawal_with_http_info(withdrawal_id, **kwargs) # noqa: E501 def cancel_withdrawal_with_http_info(self, withdrawal_id, **kwargs): # noqa: E501 - """Cancel withdrawal with specified ID. # noqa: E501 + """Cancel withdrawal with specified ID # 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_client.py b/gate_api/api_client.py index b801eaa..5d90c48 100644 --- a/gate_api/api_client.py +++ b/gate_api/api_client.py @@ -2,7 +2,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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/6.102.6/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 218bc37..e1a45a1 100644 --- a/gate_api/configuration.py +++ b/gate_api/configuration.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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: v4.102.6\n"\ - "SDK Package Version: 6.102.6".\ + "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 916a649..31ff2ea 100644 --- a/gate_api/exceptions.py +++ b/gate_api/exceptions.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 diff --git a/gate_api/models/__init__.py b/gate_api/models/__init__.py index d31cd80..4976416 100644 --- a/gate_api/models/__init__.py +++ b/gate_api/models/__init__.py @@ -4,7 +4,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -108,6 +108,7 @@ from gate_api.models.futures_ticker import FuturesTicker from gate_api.models.futures_trade import FuturesTrade from gate_api.models.index_constituent import IndexConstituent +from gate_api.models.inline_object import InlineObject from gate_api.models.inline_response200 import InlineResponse200 from gate_api.models.inline_response2001 import InlineResponse2001 from gate_api.models.insurance_record import InsuranceRecord diff --git a/gate_api/models/account_balance.py b/gate_api/models/account_balance.py index 144d955..f213fb7 100644 --- a/gate_api/models/account_balance.py +++ b/gate_api/models/account_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, amount=None, currency=None, unrealised_pnl=None, borrowed=Non def amount(self): """Gets the amount of this AccountBalance. # noqa: E501 - Account total balance amount. # noqa: E501 + Account total balance amount # noqa: E501 :return: The amount of this AccountBalance. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this AccountBalance. - Account total balance amount. # noqa: E501 + Account total balance amount # noqa: E501 :param amount: The amount of this AccountBalance. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def amount(self, amount): def currency(self): """Gets the currency of this AccountBalance. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this AccountBalance. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this AccountBalance. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this AccountBalance. # noqa: E501 :type: str @@ -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 8698af6..7854045 100644 --- a/gate_api/models/account_detail.py +++ b/gate_api/models/account_detail.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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] @@ -128,7 +128,7 @@ def currency_pairs(self, currency_pairs): def user_id(self): """Gets the user_id of this AccountDetail. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this AccountDetail. # noqa: E501 :rtype: int @@ -139,7 +139,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this AccountDetail. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this AccountDetail. # noqa: E501 :type: int @@ -151,7 +151,7 @@ def user_id(self, user_id): def tier(self): """Gets the tier of this AccountDetail. # noqa: E501 - User VIP level. # noqa: E501 + User VIP level # noqa: E501 :return: The tier of this AccountDetail. # noqa: E501 :rtype: int @@ -162,7 +162,7 @@ def tier(self): def tier(self, tier): """Sets the tier of this AccountDetail. - User VIP level. # noqa: E501 + User VIP level # noqa: E501 :param tier: The tier of this AccountDetail. # noqa: E501 :type: int @@ -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 - Normal user, 1 - Copy trading leader, follower, 3 - Both 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 - Normal user, 1 - Copy trading leader, follower, 3 - Both 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 cc5b2d7..d9e3728 100644 --- a/gate_api/models/account_detail_key.py +++ b/gate_api/models/account_detail_key.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 bb34e7c..2fd7e27 100644 --- a/gate_api/models/account_rate_limit.py +++ b/gate_api/models/account_rate_limit.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -141,7 +141,7 @@ def main_ratio(self, main_ratio): def updated_at(self): """Gets the updated_at of this AccountRateLimit. # noqa: E501 - Update time. # noqa: E501 + Update time # noqa: E501 :return: The updated_at of this AccountRateLimit. # noqa: E501 :rtype: str @@ -152,7 +152,7 @@ def updated_at(self): def updated_at(self, updated_at): """Sets the updated_at of this AccountRateLimit. - Update time. # noqa: E501 + Update time # noqa: E501 :param updated_at: The updated_at of this AccountRateLimit. # noqa: E501 :type: str diff --git a/gate_api/models/agency_commission.py b/gate_api/models/agency_commission.py index 7f50c74..d843953 100644 --- a/gate_api/models/agency_commission.py +++ b/gate_api/models/agency_commission.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -105,7 +105,7 @@ def commission_time(self, commission_time): def user_id(self): """Gets the user_id of this AgencyCommission. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this AgencyCommission. # noqa: E501 :rtype: int @@ -116,7 +116,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this AgencyCommission. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this AgencyCommission. # noqa: E501 :type: int @@ -128,7 +128,7 @@ def user_id(self, user_id): def group_name(self): """Gets the group_name of this AgencyCommission. # noqa: E501 - Group name. # noqa: E501 + Group name # noqa: E501 :return: The group_name of this AgencyCommission. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def group_name(self): def group_name(self, group_name): """Sets the group_name of this AgencyCommission. - Group name. # noqa: E501 + Group name # noqa: E501 :param group_name: The group_name of this AgencyCommission. # noqa: E501 :type: str @@ -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 @@ -174,7 +174,7 @@ def commission_amount(self, commission_amount): def commission_asset(self): """Gets the commission_asset of this AgencyCommission. # noqa: E501 - Commission Asset. # noqa: E501 + Commission Asset # noqa: E501 :return: The commission_asset of this AgencyCommission. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def commission_asset(self): def commission_asset(self, commission_asset): """Sets the commission_asset of this AgencyCommission. - Commission Asset. # noqa: E501 + Commission Asset # noqa: E501 :param commission_asset: The commission_asset 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 84ffc87..50fd672 100644 --- a/gate_api/models/agency_commission_history.py +++ b/gate_api/models/agency_commission_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency_pair=None, total=None, list=None, local_vars_configu def currency_pair(self): """Gets the currency_pair of this AgencyCommissionHistory. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this AgencyCommissionHistory. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this AgencyCommissionHistory. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this AgencyCommissionHistory. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency_pair(self, currency_pair): def total(self): """Gets the total of this AgencyCommissionHistory. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this AgencyCommissionHistory. # noqa: E501 :rtype: int @@ -101,7 +101,7 @@ def total(self): def total(self, total): """Sets the total of this AgencyCommissionHistory. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this AgencyCommissionHistory. # noqa: E501 :type: int @@ -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 7b863be..abdf119 100644 --- a/gate_api/models/agency_transaction.py +++ b/gate_api/models/agency_transaction.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=Non def transaction_time(self): """Gets the transaction_time of this AgencyTransaction. # noqa: E501 - Transaction Time. (unix timestamp). # noqa: E501 + Transaction Time. (unix timestamp) # noqa: E501 :return: The transaction_time of this AgencyTransaction. # noqa: E501 :rtype: int @@ -108,7 +108,7 @@ def transaction_time(self): def transaction_time(self, transaction_time): """Sets the transaction_time of this AgencyTransaction. - Transaction Time. (unix timestamp). # noqa: E501 + Transaction Time. (unix timestamp) # noqa: E501 :param transaction_time: The transaction_time of this AgencyTransaction. # noqa: E501 :type: int @@ -120,7 +120,7 @@ def transaction_time(self, transaction_time): def user_id(self): """Gets the user_id of this AgencyTransaction. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this AgencyTransaction. # noqa: E501 :rtype: int @@ -131,7 +131,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this AgencyTransaction. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this AgencyTransaction. # noqa: E501 :type: int @@ -143,7 +143,7 @@ def user_id(self, user_id): def group_name(self): """Gets the group_name of this AgencyTransaction. # noqa: E501 - Group name. # noqa: E501 + Group name # noqa: E501 :return: The group_name of this AgencyTransaction. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def group_name(self): def group_name(self, group_name): """Sets the group_name of this AgencyTransaction. - Group name. # noqa: E501 + Group name # noqa: E501 :param group_name: The group_name of this AgencyTransaction. # noqa: E501 :type: str @@ -166,7 +166,7 @@ def group_name(self, group_name): def fee(self): """Gets the fee of this AgencyTransaction. # noqa: E501 - Fee. # noqa: E501 + Fee # noqa: E501 :return: The fee of this AgencyTransaction. # noqa: E501 :rtype: str @@ -177,7 +177,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this AgencyTransaction. - Fee. # noqa: E501 + Fee # noqa: E501 :param fee: The fee of this AgencyTransaction. # noqa: E501 :type: str @@ -189,7 +189,7 @@ def fee(self, fee): def fee_asset(self): """Gets the fee_asset of this AgencyTransaction. # noqa: E501 - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :return: The fee_asset of this AgencyTransaction. # noqa: E501 :rtype: str @@ -200,7 +200,7 @@ def fee_asset(self): def fee_asset(self, fee_asset): """Sets the fee_asset of this AgencyTransaction. - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :param fee_asset: The fee_asset of this AgencyTransaction. # noqa: E501 :type: str @@ -212,7 +212,7 @@ def fee_asset(self, fee_asset): def currency_pair(self): """Gets the currency_pair of this AgencyTransaction. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this AgencyTransaction. # noqa: E501 :rtype: str @@ -223,7 +223,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this AgencyTransaction. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this AgencyTransaction. # noqa: E501 :type: str @@ -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 @@ -258,7 +258,7 @@ def amount(self, amount): def amount_asset(self): """Gets the amount_asset of this AgencyTransaction. # noqa: E501 - Commission Asset. # noqa: E501 + Commission Asset # noqa: E501 :return: The amount_asset of this AgencyTransaction. # noqa: E501 :rtype: str @@ -269,7 +269,7 @@ def amount_asset(self): def amount_asset(self, amount_asset): """Sets the amount_asset of this AgencyTransaction. - Commission Asset. # noqa: E501 + Commission Asset # noqa: E501 :param amount_asset: The amount_asset 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 4824fae..99dfdeb 100644 --- a/gate_api/models/agency_transaction_history.py +++ b/gate_api/models/agency_transaction_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency_pair=None, total=None, list=None, local_vars_configu def currency_pair(self): """Gets the currency_pair of this AgencyTransactionHistory. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this AgencyTransactionHistory. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this AgencyTransactionHistory. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this AgencyTransactionHistory. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency_pair(self, currency_pair): def total(self): """Gets the total of this AgencyTransactionHistory. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this AgencyTransactionHistory. # noqa: E501 :rtype: int @@ -101,7 +101,7 @@ def total(self): def total(self, total): """Sets the total of this AgencyTransactionHistory. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this AgencyTransactionHistory. # noqa: E501 :type: int @@ -113,7 +113,7 @@ def total(self, total): def list(self): """Gets the list of this AgencyTransactionHistory. # noqa: E501 - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :return: The list of this AgencyTransactionHistory. # noqa: E501 :rtype: list[AgencyTransaction] @@ -124,7 +124,7 @@ def list(self): def list(self, list): """Sets the list of this AgencyTransactionHistory. - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :param list: The list of this AgencyTransactionHistory. # noqa: E501 :type: list[AgencyTransaction] diff --git a/gate_api/models/auto_repay_setting.py b/gate_api/models/auto_repay_setting.py index b4b8261..a3d0994 100644 --- a/gate_api/models/auto_repay_setting.py +++ b/gate_api/models/auto_repay_setting.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 f71b418..7125ac0 100644 --- a/gate_api/models/batch_amend_item.py +++ b/gate_api/models/batch_amend_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -110,7 +110,7 @@ def order_id(self, order_id): def currency_pair(self): """Gets the currency_pair of this BatchAmendItem. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this BatchAmendItem. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this BatchAmendItem. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 spot, unified account and warehouse-by-store leverage account. # 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 spot, unified account and warehouse-by-store leverage account. # 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 - Trading Quantity. Only one of amountor pricecan 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. - Trading Quantity. Only one of amountor pricecan 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 - Trading Price. Only one of amountor pricecan 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. - Trading Price. Only one of amountor pricecan 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 bd76cce..c357589 100644 --- a/gate_api/models/batch_amend_order_req.py +++ b/gate_api/models/batch_amend_order_req.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, order_id=None, text=None, size=None, price=None, amend_text=N def order_id(self): """Gets the order_id of this BatchAmendOrderReq. # noqa: E501 - Order id, order_id and text must contain at least one. # noqa: E501 + Order id, order_id and text must contain at least one # noqa: E501 :return: The order_id of this BatchAmendOrderReq. # noqa: E501 :rtype: int @@ -88,7 +88,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this BatchAmendOrderReq. - Order id, order_id and text must contain at least one. # noqa: E501 + Order id, order_id and text must contain at least one # noqa: E501 :param order_id: The order_id of this BatchAmendOrderReq. # noqa: E501 :type: int @@ -100,7 +100,7 @@ def order_id(self, order_id): def text(self): """Gets the text of this BatchAmendOrderReq. # noqa: E501 - User-defined order text, at least one of order_id and text must be passed. # noqa: E501 + User-defined order text, at least one of order_id and text must be passed # noqa: E501 :return: The text of this BatchAmendOrderReq. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def text(self): def text(self, text): """Sets the text of this BatchAmendOrderReq. - User-defined order text, at least one of order_id and text must be passed. # noqa: E501 + User-defined order text, at least one of order_id and text must be passed # noqa: E501 :param text: The text of this BatchAmendOrderReq. # noqa: E501 :type: str @@ -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, 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, 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 a7dba9c..0448f1a 100644 --- a/gate_api/models/batch_futures_order.py +++ b/gate_api/models/batch_futures_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -215,7 +215,7 @@ def succeeded(self, succeeded): def label(self): """Gets the label of this BatchFuturesOrder. # noqa: E501 - Error label, only exists if execution fails. # noqa: E501 + Error label, only exists if execution fails # noqa: E501 :return: The label of this BatchFuturesOrder. # noqa: E501 :rtype: str @@ -226,7 +226,7 @@ def label(self): def label(self, label): """Sets the label of this BatchFuturesOrder. - Error label, only exists if execution fails. # noqa: E501 + Error label, only exists if execution fails # noqa: E501 :param label: The label of this BatchFuturesOrder. # noqa: E501 :type: str @@ -261,7 +261,7 @@ def detail(self, detail): def id(self): """Gets the id of this BatchFuturesOrder. # noqa: E501 - Futures order ID. # noqa: E501 + Futures order ID # noqa: E501 :return: The id of this BatchFuturesOrder. # noqa: E501 :rtype: int @@ -272,7 +272,7 @@ def id(self): def id(self, id): """Sets the id of this BatchFuturesOrder. - Futures order ID. # noqa: E501 + Futures order ID # noqa: E501 :param id: The id of this BatchFuturesOrder. # noqa: E501 :type: int @@ -284,7 +284,7 @@ def id(self, id): def user(self): """Gets the user of this BatchFuturesOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this BatchFuturesOrder. # noqa: E501 :rtype: int @@ -295,7 +295,7 @@ def user(self): def user(self, user): """Sets the user of this BatchFuturesOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this BatchFuturesOrder. # noqa: E501 :type: int @@ -307,7 +307,7 @@ def user(self, user): def create_time(self): """Gets the create_time of this BatchFuturesOrder. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this BatchFuturesOrder. # noqa: E501 :rtype: float @@ -318,7 +318,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this BatchFuturesOrder. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this BatchFuturesOrder. # noqa: E501 :type: float @@ -330,7 +330,7 @@ def create_time(self, create_time): def finish_time(self): """Gets the finish_time of this BatchFuturesOrder. # noqa: E501 - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :return: The finish_time of this BatchFuturesOrder. # noqa: E501 :rtype: float @@ -341,7 +341,7 @@ def finish_time(self): def finish_time(self, finish_time): """Sets the finish_time of this BatchFuturesOrder. - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :param finish_time: The finish_time of this BatchFuturesOrder. # noqa: E501 :type: float @@ -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 - 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 - 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 @@ -411,7 +411,7 @@ def status(self, status): def contract(self): """Gets the contract of this BatchFuturesOrder. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this BatchFuturesOrder. # noqa: E501 :rtype: str @@ -422,7 +422,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this BatchFuturesOrder. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract 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 @@ -503,7 +503,7 @@ def price(self, price): def close(self): """Gets the close of this BatchFuturesOrder. # noqa: E501 - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :return: The close of this BatchFuturesOrder. # noqa: E501 :rtype: bool @@ -514,7 +514,7 @@ def close(self): def close(self, close): """Sets the close of this BatchFuturesOrder. - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :param close: The close of this BatchFuturesOrder. # noqa: E501 :type: bool @@ -526,7 +526,7 @@ def close(self, close): def is_close(self): """Gets the is_close of this BatchFuturesOrder. # noqa: E501 - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :return: The is_close of this BatchFuturesOrder. # noqa: E501 :rtype: bool @@ -537,7 +537,7 @@ def is_close(self): def is_close(self, is_close): """Sets the is_close of this BatchFuturesOrder. - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :param is_close: The is_close of this BatchFuturesOrder. # noqa: E501 :type: bool @@ -549,7 +549,7 @@ def is_close(self, is_close): def reduce_only(self): """Gets the reduce_only of this BatchFuturesOrder. # noqa: E501 - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :return: The reduce_only of this BatchFuturesOrder. # noqa: E501 :rtype: bool @@ -560,7 +560,7 @@ def reduce_only(self): def reduce_only(self, reduce_only): """Sets the reduce_only of this BatchFuturesOrder. - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :param reduce_only: The reduce_only of this BatchFuturesOrder. # noqa: E501 :type: bool @@ -572,7 +572,7 @@ def reduce_only(self, reduce_only): def is_reduce_only(self): """Gets the is_reduce_only of this BatchFuturesOrder. # noqa: E501 - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :return: The is_reduce_only of this BatchFuturesOrder. # noqa: E501 :rtype: bool @@ -583,7 +583,7 @@ def is_reduce_only(self): def is_reduce_only(self, is_reduce_only): """Sets the is_reduce_only of this BatchFuturesOrder. - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :param is_reduce_only: The is_reduce_only of this BatchFuturesOrder. # noqa: E501 :type: bool @@ -595,7 +595,7 @@ def is_reduce_only(self, is_reduce_only): def is_liq(self): """Gets the is_liq of this BatchFuturesOrder. # noqa: E501 - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :return: The is_liq of this BatchFuturesOrder. # noqa: E501 :rtype: bool @@ -606,7 +606,7 @@ def is_liq(self): def is_liq(self, is_liq): """Sets the is_liq of this BatchFuturesOrder. - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :param is_liq: The is_liq of this BatchFuturesOrder. # noqa: E501 :type: bool @@ -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 @@ -716,7 +716,7 @@ def text(self, text): def tkfr(self): """Gets the tkfr of this BatchFuturesOrder. # noqa: E501 - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :return: The tkfr of this BatchFuturesOrder. # noqa: E501 :rtype: str @@ -727,7 +727,7 @@ def tkfr(self): def tkfr(self, tkfr): """Sets the tkfr of this BatchFuturesOrder. - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :param tkfr: The tkfr of this BatchFuturesOrder. # noqa: E501 :type: str @@ -739,7 +739,7 @@ def tkfr(self, tkfr): def mkfr(self): """Gets the mkfr of this BatchFuturesOrder. # noqa: E501 - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :return: The mkfr of this BatchFuturesOrder. # noqa: E501 :rtype: str @@ -750,7 +750,7 @@ def mkfr(self): def mkfr(self, mkfr): """Sets the mkfr of this BatchFuturesOrder. - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :param mkfr: The mkfr 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, 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, 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 3a6af81..12d30e9 100644 --- a/gate_api/models/batch_order.py +++ b/gate_api/models/batch_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -237,7 +237,7 @@ def __init__(self, order_id=None, amend_text=None, text=None, succeeded=None, la def order_id(self): """Gets the order_id of this BatchOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this BatchOrder. # noqa: E501 :rtype: str @@ -248,7 +248,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this BatchOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this BatchOrder. # noqa: E501 :type: str @@ -260,7 +260,7 @@ def order_id(self, order_id): def amend_text(self): """Gets the amend_text of this BatchOrder. # noqa: E501 - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :return: The amend_text of this BatchOrder. # noqa: E501 :rtype: str @@ -271,7 +271,7 @@ def amend_text(self): def amend_text(self, amend_text): """Sets the amend_text of this BatchOrder. - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :param amend_text: The amend_text of this BatchOrder. # noqa: E501 :type: str @@ -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 @@ -329,7 +329,7 @@ def succeeded(self, succeeded): def label(self): """Gets the label of this BatchOrder. # noqa: E501 - Error label, if any, otherwise an empty string. # noqa: E501 + Error label, if any, otherwise an empty string # noqa: E501 :return: The label of this BatchOrder. # noqa: E501 :rtype: str @@ -340,7 +340,7 @@ def label(self): def label(self, label): """Sets the label of this BatchOrder. - Error label, if any, otherwise an empty string. # noqa: E501 + Error label, if any, otherwise an empty string # noqa: E501 :param label: The label of this BatchOrder. # noqa: E501 :type: str @@ -352,7 +352,7 @@ def label(self, label): def message(self): """Gets the message of this BatchOrder. # noqa: E501 - Detailed error message, if any, otherwise an empty string. # noqa: E501 + Detailed error message, if any, otherwise an empty string # noqa: E501 :return: The message of this BatchOrder. # noqa: E501 :rtype: str @@ -363,7 +363,7 @@ def message(self): def message(self, message): """Sets the message of this BatchOrder. - Detailed error message, if any, otherwise an empty string. # noqa: E501 + Detailed error message, if any, otherwise an empty string # noqa: E501 :param message: The message of this BatchOrder. # noqa: E501 :type: str @@ -375,7 +375,7 @@ def message(self, message): def id(self): """Gets the id of this BatchOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this BatchOrder. # noqa: E501 :rtype: str @@ -386,7 +386,7 @@ def id(self): def id(self, id): """Sets the id of this BatchOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this BatchOrder. # noqa: E501 :type: str @@ -398,7 +398,7 @@ def id(self, id): def create_time(self): """Gets the create_time of this BatchOrder. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this BatchOrder. # noqa: E501 :rtype: str @@ -409,7 +409,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this BatchOrder. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this BatchOrder. # noqa: E501 :type: str @@ -421,7 +421,7 @@ def create_time(self, create_time): def update_time(self): """Gets the update_time of this BatchOrder. # noqa: E501 - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :return: The update_time of this BatchOrder. # noqa: E501 :rtype: str @@ -432,7 +432,7 @@ def update_time(self): def update_time(self, update_time): """Sets the update_time of this BatchOrder. - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :param update_time: The update_time of this BatchOrder. # noqa: E501 :type: str @@ -444,7 +444,7 @@ def update_time(self, update_time): def create_time_ms(self): """Gets the create_time_ms of this BatchOrder. # noqa: E501 - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :return: The create_time_ms of this BatchOrder. # noqa: E501 :rtype: int @@ -455,7 +455,7 @@ def create_time_ms(self): def create_time_ms(self, create_time_ms): """Sets the create_time_ms of this BatchOrder. - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :param create_time_ms: The create_time_ms of this BatchOrder. # noqa: E501 :type: int @@ -467,7 +467,7 @@ def create_time_ms(self, create_time_ms): def update_time_ms(self): """Gets the update_time_ms of this BatchOrder. # noqa: E501 - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :return: The update_time_ms of this BatchOrder. # noqa: E501 :rtype: int @@ -478,7 +478,7 @@ def update_time_ms(self): def update_time_ms(self, update_time_ms): """Sets the update_time_ms of this BatchOrder. - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :param update_time_ms: The update_time_ms of this BatchOrder. # noqa: E501 :type: int @@ -519,7 +519,7 @@ def status(self, status): def currency_pair(self): """Gets the currency_pair of this BatchOrder. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this BatchOrder. # noqa: E501 :rtype: str @@ -530,7 +530,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this BatchOrder. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 - Buy or sell order. # 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. - Buy or sell order. # noqa: E501 + Buy or sell order # noqa: E501 :param side: The side of this BatchOrder. # noqa: E501 :type: str @@ -629,7 +629,7 @@ def side(self, side): def amount(self): """Gets the amount of this BatchOrder. # noqa: E501 - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :return: The amount of this BatchOrder. # noqa: E501 :rtype: str @@ -640,7 +640,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this BatchOrder. - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :param amount: The amount of this BatchOrder. # noqa: E501 :type: str @@ -652,7 +652,7 @@ def amount(self, amount): def price(self): """Gets the price of this BatchOrder. # noqa: E501 - Order price. # noqa: E501 + Order price # noqa: E501 :return: The price of this BatchOrder. # noqa: E501 :rtype: str @@ -663,7 +663,7 @@ def price(self): def price(self, price): """Sets the price of this BatchOrder. - Order price. # noqa: E501 + Order price # noqa: E501 :param price: The price 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 @@ -773,7 +773,7 @@ def auto_repay(self, auto_repay): def left(self): """Gets the left of this BatchOrder. # noqa: E501 - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :return: The left of this BatchOrder. # noqa: E501 :rtype: str @@ -784,7 +784,7 @@ def left(self): def left(self, left): """Sets the left of this BatchOrder. - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :param left: The left of this BatchOrder. # noqa: E501 :type: str @@ -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 @@ -819,7 +819,7 @@ def filled_amount(self, filled_amount): def fill_price(self): """Gets the fill_price of this BatchOrder. # noqa: E501 - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :return: The fill_price of this BatchOrder. # noqa: E501 :rtype: str @@ -830,7 +830,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this BatchOrder. - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :param fill_price: The fill_price of this BatchOrder. # noqa: E501 :type: str @@ -842,7 +842,7 @@ def fill_price(self, fill_price): def filled_total(self): """Gets the filled_total of this BatchOrder. # noqa: E501 - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :return: The filled_total of this BatchOrder. # noqa: E501 :rtype: str @@ -853,7 +853,7 @@ def filled_total(self): def filled_total(self, filled_total): """Sets the filled_total of this BatchOrder. - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :param filled_total: The filled_total of this BatchOrder. # noqa: E501 :type: str @@ -865,7 +865,7 @@ def filled_total(self, filled_total): def avg_deal_price(self): """Gets the avg_deal_price of this BatchOrder. # noqa: E501 - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :return: The avg_deal_price of this BatchOrder. # noqa: E501 :rtype: str @@ -876,7 +876,7 @@ def avg_deal_price(self): def avg_deal_price(self, avg_deal_price): """Sets the avg_deal_price of this BatchOrder. - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :param avg_deal_price: The avg_deal_price of this BatchOrder. # noqa: E501 :type: str @@ -888,7 +888,7 @@ def avg_deal_price(self, avg_deal_price): def fee(self): """Gets the fee of this BatchOrder. # noqa: E501 - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :return: The fee of this BatchOrder. # noqa: E501 :rtype: str @@ -899,7 +899,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this BatchOrder. - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :param fee: The fee of this BatchOrder. # noqa: E501 :type: str @@ -911,7 +911,7 @@ def fee(self, fee): def fee_currency(self): """Gets the fee_currency of this BatchOrder. # noqa: E501 - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :return: The fee_currency of this BatchOrder. # noqa: E501 :rtype: str @@ -922,7 +922,7 @@ def fee_currency(self): def fee_currency(self, fee_currency): """Sets the fee_currency of this BatchOrder. - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :param fee_currency: The fee_currency of this BatchOrder. # noqa: E501 :type: str @@ -934,7 +934,7 @@ def fee_currency(self, fee_currency): def point_fee(self): """Gets the point_fee of this BatchOrder. # noqa: E501 - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :return: The point_fee of this BatchOrder. # noqa: E501 :rtype: str @@ -945,7 +945,7 @@ def point_fee(self): def point_fee(self, point_fee): """Sets the point_fee of this BatchOrder. - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :param point_fee: The point_fee of this BatchOrder. # noqa: E501 :type: str @@ -957,7 +957,7 @@ def point_fee(self, point_fee): def gt_fee(self): """Gets the gt_fee of this BatchOrder. # noqa: E501 - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :return: The gt_fee of this BatchOrder. # noqa: E501 :rtype: str @@ -968,7 +968,7 @@ def gt_fee(self): def gt_fee(self, gt_fee): """Sets the gt_fee of this BatchOrder. - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :param gt_fee: The gt_fee 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 @@ -1003,7 +1003,7 @@ def gt_discount(self, gt_discount): def rebated_fee(self): """Gets the rebated_fee of this BatchOrder. # noqa: E501 - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :return: The rebated_fee of this BatchOrder. # noqa: E501 :rtype: str @@ -1014,7 +1014,7 @@ def rebated_fee(self): def rebated_fee(self, rebated_fee): """Sets the rebated_fee of this BatchOrder. - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :param rebated_fee: The rebated_fee of this BatchOrder. # noqa: E501 :type: str @@ -1026,7 +1026,7 @@ def rebated_fee(self, rebated_fee): def rebated_fee_currency(self): """Gets the rebated_fee_currency of this BatchOrder. # noqa: E501 - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :return: The rebated_fee_currency of this BatchOrder. # noqa: E501 :rtype: str @@ -1037,7 +1037,7 @@ def rebated_fee_currency(self): def rebated_fee_currency(self, rebated_fee_currency): """Sets the rebated_fee_currency of this BatchOrder. - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :param rebated_fee_currency: The rebated_fee_currency 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 8de8eeb..4c6b514 100644 --- a/gate_api/models/borrow_currency_info.py +++ b/gate_api/models/borrow_currency_info.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, currency=None, index_price=None, left_repay_principal=None, l def currency(self): """Gets the currency of this BorrowCurrencyInfo. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this BorrowCurrencyInfo. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this BorrowCurrencyInfo. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this BorrowCurrencyInfo. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this BorrowCurrencyInfo. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this BorrowCurrencyInfo. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this BorrowCurrencyInfo. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this BorrowCurrencyInfo. # noqa: E501 :type: str @@ -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 db81209..cc6e70a 100644 --- a/gate_api/models/broker_commission.py +++ b/gate_api/models/broker_commission.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, total=None, list=None, local_vars_configuration=None): # noq def total(self): """Gets the total of this BrokerCommission. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this BrokerCommission. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def total(self): def total(self, total): """Sets the total of this BrokerCommission. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this BrokerCommission. # noqa: E501 :type: int @@ -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 88a08f3..71474fc 100644 --- a/gate_api/models/broker_commission1.py +++ b/gate_api/models/broker_commission1.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -107,7 +107,7 @@ def __init__(self, commission_time=None, user_id=None, group_name=None, amount=N 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 @@ -118,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 @@ -130,7 +130,7 @@ def commission_time(self, commission_time): def user_id(self): """Gets the user_id of this BrokerCommission1. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this BrokerCommission1. # noqa: E501 :rtype: int @@ -141,7 +141,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this BrokerCommission1. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this BrokerCommission1. # noqa: E501 :type: int @@ -153,7 +153,7 @@ def user_id(self, user_id): def group_name(self): """Gets the group_name of this BrokerCommission1. # noqa: E501 - Group name. # noqa: E501 + Group name # noqa: E501 :return: The group_name of this BrokerCommission1. # noqa: E501 :rtype: str @@ -164,7 +164,7 @@ def group_name(self): def group_name(self, group_name): """Sets the group_name of this BrokerCommission1. - Group name. # noqa: E501 + Group name # noqa: E501 :param group_name: The group_name of this BrokerCommission1. # noqa: E501 :type: str @@ -176,7 +176,7 @@ def group_name(self, group_name): def amount(self): """Gets the amount of this BrokerCommission1. # noqa: E501 - The amount of commission rebates. # noqa: E501 + The amount of commission rebates # noqa: E501 :return: The amount of this BrokerCommission1. # noqa: E501 :rtype: str @@ -187,7 +187,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this BrokerCommission1. - The amount of commission rebates. # noqa: E501 + The amount of commission rebates # noqa: E501 :param amount: The amount of this BrokerCommission1. # noqa: E501 :type: str @@ -199,7 +199,7 @@ def amount(self, amount): def fee(self): """Gets the fee of this BrokerCommission1. # noqa: E501 - Fee. # noqa: E501 + Fee # noqa: E501 :return: The fee of this BrokerCommission1. # noqa: E501 :rtype: str @@ -210,7 +210,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this BrokerCommission1. - Fee. # noqa: E501 + Fee # noqa: E501 :param fee: The fee of this BrokerCommission1. # noqa: E501 :type: str @@ -222,7 +222,7 @@ def fee(self, fee): def fee_asset(self): """Gets the fee_asset of this BrokerCommission1. # noqa: E501 - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :return: The fee_asset of this BrokerCommission1. # noqa: E501 :rtype: str @@ -233,7 +233,7 @@ def fee_asset(self): def fee_asset(self, fee_asset): """Sets the fee_asset of this BrokerCommission1. - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :param fee_asset: The fee_asset of this BrokerCommission1. # noqa: E501 :type: str @@ -245,7 +245,7 @@ def fee_asset(self, fee_asset): def rebate_fee(self): """Gets the rebate_fee of this BrokerCommission1. # noqa: E501 - The income from rebates, converted to USDT. # noqa: E501 + The income from rebates, converted to USDT # noqa: E501 :return: The rebate_fee of this BrokerCommission1. # noqa: E501 :rtype: str @@ -256,7 +256,7 @@ def rebate_fee(self): def rebate_fee(self, rebate_fee): """Sets the rebate_fee of this BrokerCommission1. - The income from rebates, converted to USDT. # noqa: E501 + The income from rebates, converted to USDT # noqa: E501 :param rebate_fee: The rebate_fee of this BrokerCommission1. # noqa: E501 :type: str @@ -268,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.、Alpha # noqa: E501 + Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501 :return: The source of this BrokerCommission1. # noqa: E501 :rtype: str @@ -279,7 +279,7 @@ def source(self): def source(self, source): """Sets the source of this BrokerCommission1. - Rebate Type: Spot、Futures、Options.、Alpha # noqa: E501 + Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501 :param source: The source of this BrokerCommission1. # noqa: E501 :type: str @@ -291,7 +291,7 @@ def source(self, source): def currency_pair(self): """Gets the currency_pair of this BrokerCommission1. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this BrokerCommission1. # noqa: E501 :rtype: str @@ -302,7 +302,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this BrokerCommission1. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this BrokerCommission1. # noqa: E501 :type: str @@ -335,7 +335,7 @@ def sub_broker_info(self, sub_broker_info): def alpha_contract_addr(self): """Gets the alpha_contract_addr of this BrokerCommission1. # noqa: E501 - Alpha token address # noqa: E501 + Alpha contract address # noqa: E501 :return: The alpha_contract_addr of this BrokerCommission1. # noqa: E501 :rtype: str @@ -346,7 +346,7 @@ def alpha_contract_addr(self): def alpha_contract_addr(self, alpha_contract_addr): """Sets the alpha_contract_addr of this BrokerCommission1. - Alpha token address # noqa: E501 + Alpha contract address # noqa: E501 :param alpha_contract_addr: The alpha_contract_addr of this BrokerCommission1. # noqa: E501 :type: str diff --git a/gate_api/models/broker_commission_sub_broker_info.py b/gate_api/models/broker_commission_sub_broker_info.py index f945318..220166c 100644 --- a/gate_api/models/broker_commission_sub_broker_info.py +++ b/gate_api/models/broker_commission_sub_broker_info.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, user_id=None, original_commission_rate=None, relative_commiss def user_id(self): """Gets the user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501 - The sub broker user ID. # noqa: E501 + Sub-broker user ID # noqa: E501 :return: The user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501 :rtype: int @@ -83,7 +83,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this BrokerCommissionSubBrokerInfo. - The sub broker user ID. # noqa: E501 + Sub-broker user ID # noqa: E501 :param user_id: The user_id of this BrokerCommissionSubBrokerInfo. # noqa: E501 :type: int @@ -95,7 +95,7 @@ def user_id(self, user_id): def original_commission_rate(self): """Gets the original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 - The sub broker original commission rate. # noqa: E501 + Sub-broker original commission rate # noqa: E501 :return: The original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def original_commission_rate(self): def original_commission_rate(self, original_commission_rate): """Sets the original_commission_rate of this BrokerCommissionSubBrokerInfo. - The sub broker original commission rate. # noqa: E501 + Sub-broker original commission rate # noqa: E501 :param original_commission_rate: The original_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :type: str @@ -118,7 +118,7 @@ def original_commission_rate(self, original_commission_rate): def relative_commission_rate(self): """Gets the relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 - The sub broker relative commission rate. # noqa: E501 + Sub-broker relative commission rate # noqa: E501 :return: The relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def relative_commission_rate(self): def relative_commission_rate(self, relative_commission_rate): """Sets the relative_commission_rate of this BrokerCommissionSubBrokerInfo. - The sub broker relative commission rate. # noqa: E501 + Sub-broker relative commission rate # noqa: E501 :param relative_commission_rate: The relative_commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :type: str @@ -141,7 +141,7 @@ def relative_commission_rate(self, relative_commission_rate): def commission_rate(self): """Gets the commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 - The sub broker actual commission rate. # noqa: E501 + Sub-broker actual commission rate # noqa: E501 :return: The commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :rtype: str @@ -152,7 +152,7 @@ def commission_rate(self): def commission_rate(self, commission_rate): """Sets the commission_rate of this BrokerCommissionSubBrokerInfo. - The sub broker actual commission rate. # noqa: E501 + Sub-broker actual commission rate # noqa: E501 :param commission_rate: The commission_rate of this BrokerCommissionSubBrokerInfo. # noqa: E501 :type: str diff --git a/gate_api/models/broker_transaction.py b/gate_api/models/broker_transaction.py index fb67ecd..0a85977 100644 --- a/gate_api/models/broker_transaction.py +++ b/gate_api/models/broker_transaction.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, total=None, list=None, local_vars_configuration=None): # noq def total(self): """Gets the total of this BrokerTransaction. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this BrokerTransaction. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def total(self): def total(self, total): """Sets the total of this BrokerTransaction. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this BrokerTransaction. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def total(self, total): def list(self): """Gets the list of this BrokerTransaction. # noqa: E501 - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :return: The list of this BrokerTransaction. # noqa: E501 :rtype: list[BrokerTransaction1] @@ -96,7 +96,7 @@ def list(self): def list(self, list): """Sets the list of this BrokerTransaction. - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :param list: The list of this BrokerTransaction. # noqa: E501 :type: list[BrokerTransaction1] diff --git a/gate_api/models/broker_transaction1.py b/gate_api/models/broker_transaction1.py index fdbf97b..87a12d0 100644 --- a/gate_api/models/broker_transaction1.py +++ b/gate_api/models/broker_transaction1.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, transaction_time=None, user_id=None, group_name=None, fee=Non def transaction_time(self): """Gets the transaction_time of this BrokerTransaction1. # noqa: E501 - Transaction Time. (unix timestamp). # noqa: E501 + Transaction Time. (unix timestamp) # noqa: E501 :return: The transaction_time of this BrokerTransaction1. # noqa: E501 :rtype: int @@ -113,7 +113,7 @@ def transaction_time(self): def transaction_time(self, transaction_time): """Sets the transaction_time of this BrokerTransaction1. - Transaction Time. (unix timestamp). # noqa: E501 + Transaction Time. (unix timestamp) # noqa: E501 :param transaction_time: The transaction_time of this BrokerTransaction1. # noqa: E501 :type: int @@ -125,7 +125,7 @@ def transaction_time(self, transaction_time): def user_id(self): """Gets the user_id of this BrokerTransaction1. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this BrokerTransaction1. # noqa: E501 :rtype: int @@ -136,7 +136,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this BrokerTransaction1. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this BrokerTransaction1. # noqa: E501 :type: int @@ -148,7 +148,7 @@ def user_id(self, user_id): def group_name(self): """Gets the group_name of this BrokerTransaction1. # noqa: E501 - Group name. # noqa: E501 + Group name # noqa: E501 :return: The group_name of this BrokerTransaction1. # noqa: E501 :rtype: str @@ -159,7 +159,7 @@ def group_name(self): def group_name(self, group_name): """Sets the group_name of this BrokerTransaction1. - Group name. # noqa: E501 + Group name # noqa: E501 :param group_name: The group_name of this BrokerTransaction1. # noqa: E501 :type: str @@ -171,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 @@ -182,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 @@ -194,7 +194,7 @@ def fee(self, fee): def currency_pair(self): """Gets the currency_pair of this BrokerTransaction1. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this BrokerTransaction1. # noqa: E501 :rtype: str @@ -205,7 +205,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this BrokerTransaction1. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this BrokerTransaction1. # noqa: E501 :type: str @@ -217,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 @@ -228,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 @@ -240,7 +240,7 @@ def amount(self, amount): def fee_asset(self): """Gets the fee_asset of this BrokerTransaction1. # noqa: E501 - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :return: The fee_asset of this BrokerTransaction1. # noqa: E501 :rtype: str @@ -251,7 +251,7 @@ def fee_asset(self): def fee_asset(self, fee_asset): """Sets the fee_asset of this BrokerTransaction1. - Fee currency. # noqa: E501 + Fee currency # noqa: E501 :param fee_asset: The fee_asset of this BrokerTransaction1. # noqa: E501 :type: str @@ -263,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.、Alpha # noqa: E501 + Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501 :return: The source of this BrokerTransaction1. # noqa: E501 :rtype: str @@ -274,7 +274,7 @@ def source(self): def source(self, source): """Sets the source of this BrokerTransaction1. - Rebate Type: Spot、Futures、Options.、Alpha # noqa: E501 + Commission transaction type: Spot, Futures, Options, Alpha # noqa: E501 :param source: The source of this BrokerTransaction1. # noqa: E501 :type: str @@ -307,7 +307,7 @@ def sub_broker_info(self, sub_broker_info): def alpha_contract_addr(self): """Gets the alpha_contract_addr of this BrokerTransaction1. # noqa: E501 - Alpha token address # noqa: E501 + Alpha contract address # noqa: E501 :return: The alpha_contract_addr of this BrokerTransaction1. # noqa: E501 :rtype: str @@ -318,7 +318,7 @@ def alpha_contract_addr(self): def alpha_contract_addr(self, alpha_contract_addr): """Sets the alpha_contract_addr of this BrokerTransaction1. - Alpha token address # noqa: E501 + Alpha contract address # noqa: E501 :param alpha_contract_addr: The alpha_contract_addr of this BrokerTransaction1. # noqa: E501 :type: str diff --git a/gate_api/models/cancel_batch_order.py b/gate_api/models/cancel_batch_order.py index 2894fe2..bfc7bd9 100644 --- a/gate_api/models/cancel_batch_order.py +++ b/gate_api/models/cancel_batch_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -70,7 +70,7 @@ def __init__(self, currency_pair=None, id=None, account=None, action_mode=None, def currency_pair(self): """Gets the currency_pair of this CancelBatchOrder. # noqa: E501 - Order currency pair. # noqa: E501 + Order currency pair # noqa: E501 :return: The currency_pair of this CancelBatchOrder. # noqa: E501 :rtype: str @@ -81,7 +81,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this CancelBatchOrder. - Order currency pair. # noqa: E501 + Order currency pair # noqa: E501 :param currency_pair: The currency_pair of this CancelBatchOrder. # noqa: E501 :type: str diff --git a/gate_api/models/cancel_order_result.py b/gate_api/models/cancel_order_result.py index 1017b65..487486a 100644 --- a/gate_api/models/cancel_order_result.py +++ b/gate_api/models/cancel_order_result.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, currency_pair=None, id=None, text=None, succeeded=None, label def currency_pair(self): """Gets the currency_pair of this CancelOrderResult. # noqa: E501 - Order currency pair. # noqa: E501 + Order currency pair # noqa: E501 :return: The currency_pair of this CancelOrderResult. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this CancelOrderResult. - Order currency pair. # noqa: E501 + Order currency pair # noqa: E501 :param currency_pair: The currency_pair of this CancelOrderResult. # noqa: E501 :type: str @@ -110,7 +110,7 @@ def currency_pair(self, currency_pair): def id(self): """Gets the id of this CancelOrderResult. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this CancelOrderResult. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def id(self): def id(self, id): """Sets the id of this CancelOrderResult. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this CancelOrderResult. # noqa: E501 :type: str @@ -133,7 +133,7 @@ def id(self, id): def text(self): """Gets the text of this CancelOrderResult. # noqa: E501 - Custom order information. # noqa: E501 + Custom order information # noqa: E501 :return: The text of this CancelOrderResult. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def text(self): def text(self, text): """Sets the text of this CancelOrderResult. - Custom order information. # noqa: E501 + Custom order information # noqa: E501 :param text: The text of this CancelOrderResult. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def text(self, text): def succeeded(self): """Gets the succeeded of this CancelOrderResult. # noqa: E501 - Whether cancellation succeeded. # noqa: E501 + Whether cancellation succeeded # noqa: E501 :return: The succeeded of this CancelOrderResult. # noqa: E501 :rtype: bool @@ -167,7 +167,7 @@ def succeeded(self): def succeeded(self, succeeded): """Sets the succeeded of this CancelOrderResult. - Whether cancellation succeeded. # noqa: E501 + Whether cancellation succeeded # noqa: E501 :param succeeded: The succeeded of this CancelOrderResult. # noqa: E501 :type: bool @@ -179,7 +179,7 @@ def succeeded(self, succeeded): def label(self): """Gets the label of this CancelOrderResult. # noqa: E501 - Error label when failed to cancel the order; emtpy if succeeded. # noqa: E501 + Error label when failed to cancel the order; emtpy if succeeded # noqa: E501 :return: The label of this CancelOrderResult. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def label(self): def label(self, label): """Sets the label of this CancelOrderResult. - Error label when failed to cancel the order; emtpy if succeeded. # noqa: E501 + Error label when failed to cancel the order; emtpy if succeeded # noqa: E501 :param label: The label of this CancelOrderResult. # noqa: E501 :type: str @@ -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 - Default is empty (deprecated). # 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. - Default is empty (deprecated). # 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 b518256..919556a 100644 --- a/gate_api/models/collateral_adjust.py +++ b/gate_api/models/collateral_adjust.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -65,7 +65,7 @@ def __init__(self, order_id=None, type=None, collaterals=None, local_vars_config def order_id(self): """Gets the order_id of this CollateralAdjust. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CollateralAdjust. # noqa: E501 :rtype: int @@ -76,7 +76,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CollateralAdjust. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CollateralAdjust. # noqa: E501 :type: int @@ -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 ba3cdb6..7cc0044 100644 --- a/gate_api/models/collateral_adjust_res.py +++ b/gate_api/models/collateral_adjust_res.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, order_id=None, collateral_currencies=None, local_vars_configu def order_id(self): """Gets the order_id of this CollateralAdjustRes. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CollateralAdjustRes. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CollateralAdjustRes. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CollateralAdjustRes. # noqa: E501 :type: int @@ -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 66e6d3e..3bc3192 100644 --- a/gate_api/models/collateral_align.py +++ b/gate_api/models/collateral_align.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -68,7 +68,7 @@ def __init__(self, order_id=None, collateral_currency=None, collateral_amount=No def order_id(self): """Gets the order_id of this CollateralAlign. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CollateralAlign. # noqa: E501 :rtype: int @@ -79,7 +79,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CollateralAlign. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CollateralAlign. # noqa: E501 :type: int @@ -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 @@ -118,7 +118,7 @@ def collateral_currency(self, collateral_currency): def collateral_amount(self): """Gets the collateral_amount of this CollateralAlign. # noqa: E501 - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :return: The collateral_amount of this CollateralAlign. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def collateral_amount(self): def collateral_amount(self, collateral_amount): """Sets the collateral_amount of this CollateralAlign. - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :param collateral_amount: The collateral_amount 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 860ad54..08c6811 100644 --- a/gate_api/models/collateral_currency.py +++ b/gate_api/models/collateral_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None): def currency(self): """Gets the currency of this CollateralCurrency. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CollateralCurrency. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CollateralCurrency. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CollateralCurrency. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this CollateralCurrency. # noqa: E501 - Size. # noqa: E501 + Size # noqa: E501 :return: The amount of this CollateralCurrency. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this CollateralCurrency. - Size. # noqa: E501 + Size # noqa: E501 :param amount: The amount of this CollateralCurrency. # noqa: E501 :type: str diff --git a/gate_api/models/collateral_currency_info.py b/gate_api/models/collateral_currency_info.py index da217c4..f555f62 100644 --- a/gate_api/models/collateral_currency_info.py +++ b/gate_api/models/collateral_currency_info.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, index_price=None, left_collateral=None, left_c def currency(self): """Gets the currency of this CollateralCurrencyInfo. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CollateralCurrencyInfo. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CollateralCurrencyInfo. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CollateralCurrencyInfo. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this CollateralCurrencyInfo. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this CollateralCurrencyInfo. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this CollateralCurrencyInfo. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this CollateralCurrencyInfo. # noqa: E501 :type: str @@ -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 754a599..610a406 100644 --- a/gate_api/models/collateral_currency_res.py +++ b/gate_api/models/collateral_currency_res.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, succeeded=None, label=None, message=None, currency=None, amou def succeeded(self): """Gets the succeeded of this CollateralCurrencyRes. # noqa: E501 - Update success status. # noqa: E501 + Update success status # noqa: E501 :return: The succeeded of this CollateralCurrencyRes. # noqa: E501 :rtype: bool @@ -88,7 +88,7 @@ def succeeded(self): def succeeded(self, succeeded): """Sets the succeeded of this CollateralCurrencyRes. - Update success status. # noqa: E501 + Update success status # noqa: E501 :param succeeded: The succeeded of this CollateralCurrencyRes. # noqa: E501 :type: bool @@ -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 @@ -146,7 +146,7 @@ def message(self, message): def currency(self): """Gets the currency of this CollateralCurrencyRes. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CollateralCurrencyRes. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CollateralCurrencyRes. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency 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 1512865..5d00be0 100644 --- a/gate_api/models/collateral_current_rate.py +++ b/gate_api/models/collateral_current_rate.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, current_rate=None, local_vars_configuration=No def currency(self): """Gets the currency of this CollateralCurrentRate. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CollateralCurrentRate. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CollateralCurrentRate. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CollateralCurrentRate. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def current_rate(self): """Gets the current_rate of this CollateralCurrentRate. # noqa: E501 - Currency current interest rate. # noqa: E501 + Currency current interest rate # noqa: E501 :return: The current_rate of this CollateralCurrentRate. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def current_rate(self): def current_rate(self, current_rate): """Sets the current_rate of this CollateralCurrentRate. - Currency current interest rate. # noqa: E501 + Currency current interest rate # noqa: E501 :param current_rate: The current_rate of this CollateralCurrentRate. # noqa: E501 :type: str diff --git a/gate_api/models/collateral_fix_rate.py b/gate_api/models/collateral_fix_rate.py index 92be996..0bdfb45 100644 --- a/gate_api/models/collateral_fix_rate.py +++ b/gate_api/models/collateral_fix_rate.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, rate_7d=None, rate_30d=None, update_time=None, def currency(self): """Gets the currency of this CollateralFixRate. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CollateralFixRate. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CollateralFixRate. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CollateralFixRate. # noqa: E501 :type: str @@ -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 fb1c0f5..67b6713 100644 --- a/gate_api/models/collateral_loan_currency.py +++ b/gate_api/models/collateral_loan_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, loan_currency=None, collateral_currency=None, local_vars_conf def loan_currency(self): """Gets the loan_currency of this CollateralLoanCurrency. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The loan_currency of this CollateralLoanCurrency. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def loan_currency(self): def loan_currency(self, loan_currency): """Sets the loan_currency of this CollateralLoanCurrency. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param loan_currency: The loan_currency of this CollateralLoanCurrency. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def loan_currency(self, loan_currency): def collateral_currency(self): """Gets the collateral_currency of this CollateralLoanCurrency. # noqa: E501 - List of supported collateral currencies. # noqa: E501 + List of supported collateral currencies # noqa: E501 :return: The collateral_currency of this CollateralLoanCurrency. # noqa: E501 :rtype: list[str] @@ -96,7 +96,7 @@ def collateral_currency(self): def collateral_currency(self, collateral_currency): """Sets the collateral_currency of this CollateralLoanCurrency. - List of supported collateral currencies. # noqa: E501 + List of supported collateral currencies # noqa: E501 :param collateral_currency: The collateral_currency of this CollateralLoanCurrency. # noqa: E501 :type: list[str] diff --git a/gate_api/models/collateral_ltv.py b/gate_api/models/collateral_ltv.py index c843fa2..34c8653 100644 --- a/gate_api/models/collateral_ltv.py +++ b/gate_api/models/collateral_ltv.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 fe1271a..f6cac73 100644 --- a/gate_api/models/collateral_order.py +++ b/gate_api/models/collateral_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -132,7 +132,7 @@ def __init__(self, order_id=None, collateral_currency=None, collateral_amount=No def order_id(self): """Gets the order_id of this CollateralOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CollateralOrder. # noqa: E501 :rtype: int @@ -143,7 +143,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CollateralOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CollateralOrder. # noqa: E501 :type: int @@ -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 @@ -178,7 +178,7 @@ def collateral_currency(self, collateral_currency): def collateral_amount(self): """Gets the collateral_amount of this CollateralOrder. # noqa: E501 - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :return: The collateral_amount of this CollateralOrder. # noqa: E501 :rtype: str @@ -189,7 +189,7 @@ def collateral_amount(self): def collateral_amount(self, collateral_amount): """Sets the collateral_amount of this CollateralOrder. - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :param collateral_amount: The collateral_amount of this CollateralOrder. # noqa: E501 :type: str @@ -201,7 +201,7 @@ def collateral_amount(self, collateral_amount): def borrow_currency(self): """Gets the borrow_currency of this CollateralOrder. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this CollateralOrder. # noqa: E501 :rtype: str @@ -212,7 +212,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this CollateralOrder. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_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 @@ -247,7 +247,7 @@ def borrow_amount(self, borrow_amount): def repaid_amount(self): """Gets the repaid_amount of this CollateralOrder. # noqa: E501 - Repaid amount. # noqa: E501 + Repaid amount # noqa: E501 :return: The repaid_amount of this CollateralOrder. # noqa: E501 :rtype: str @@ -258,7 +258,7 @@ def repaid_amount(self): def repaid_amount(self, repaid_amount): """Sets the repaid_amount of this CollateralOrder. - Repaid amount. # noqa: E501 + Repaid amount # noqa: E501 :param repaid_amount: The repaid_amount of this CollateralOrder. # noqa: E501 :type: str @@ -270,7 +270,7 @@ def repaid_amount(self, repaid_amount): def repaid_principal(self): """Gets the repaid_principal of this CollateralOrder. # noqa: E501 - Repaid principal. # noqa: E501 + Repaid principal # noqa: E501 :return: The repaid_principal of this CollateralOrder. # noqa: E501 :rtype: str @@ -281,7 +281,7 @@ def repaid_principal(self): def repaid_principal(self, repaid_principal): """Sets the repaid_principal of this CollateralOrder. - Repaid principal. # noqa: E501 + Repaid principal # noqa: E501 :param repaid_principal: The repaid_principal of this CollateralOrder. # noqa: E501 :type: str @@ -293,7 +293,7 @@ def repaid_principal(self, repaid_principal): def repaid_interest(self): """Gets the repaid_interest of this CollateralOrder. # noqa: E501 - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :return: The repaid_interest of this CollateralOrder. # noqa: E501 :rtype: str @@ -304,7 +304,7 @@ def repaid_interest(self): def repaid_interest(self, repaid_interest): """Sets the repaid_interest of this CollateralOrder. - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :param repaid_interest: The repaid_interest 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 @@ -408,7 +408,7 @@ def status(self, status): def borrow_time(self): """Gets the borrow_time of this CollateralOrder. # noqa: E501 - Borrowing time, timestamp in seconds. # noqa: E501 + Borrowing time, timestamp in seconds # noqa: E501 :return: The borrow_time of this CollateralOrder. # noqa: E501 :rtype: int @@ -419,7 +419,7 @@ def borrow_time(self): def borrow_time(self, borrow_time): """Sets the borrow_time of this CollateralOrder. - Borrowing time, timestamp in seconds. # noqa: E501 + Borrowing time, timestamp in seconds # noqa: E501 :param borrow_time: The borrow_time of this CollateralOrder. # noqa: E501 :type: int @@ -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 24074c2..b5eeb09 100644 --- a/gate_api/models/collateral_record.py +++ b/gate_api/models/collateral_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, order_id=None, record_id=None, borrow_currency=None, borrow_a def order_id(self): """Gets the order_id of this CollateralRecord. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CollateralRecord. # noqa: E501 :rtype: int @@ -113,7 +113,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CollateralRecord. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CollateralRecord. # noqa: E501 :type: int @@ -125,7 +125,7 @@ def order_id(self, order_id): def record_id(self): """Gets the record_id of this CollateralRecord. # noqa: E501 - Collateral record ID. # noqa: E501 + Collateral record ID # noqa: E501 :return: The record_id of this CollateralRecord. # noqa: E501 :rtype: int @@ -136,7 +136,7 @@ def record_id(self): def record_id(self, record_id): """Sets the record_id of this CollateralRecord. - Collateral record ID. # noqa: E501 + Collateral record ID # noqa: E501 :param record_id: The record_id of this CollateralRecord. # noqa: E501 :type: int @@ -148,7 +148,7 @@ def record_id(self, record_id): def borrow_currency(self): """Gets the borrow_currency of this CollateralRecord. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this CollateralRecord. # noqa: E501 :rtype: str @@ -159,7 +159,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this CollateralRecord. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_currency of this CollateralRecord. # noqa: E501 :type: str @@ -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 221a0c9..557f6ce 100644 --- a/gate_api/models/contract.py +++ b/gate_api/models/contract.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -70,7 +70,9 @@ class Contract(object): 'create_time': 'float', 'funding_cap_ratio': 'str', 'status': 'str', - 'launch_time': 'int' + 'launch_time': 'int', + 'delisting_time': 'int', + 'delisted_time': 'int' } attribute_map = { @@ -111,11 +113,13 @@ class Contract(object): 'create_time': 'create_time', 'funding_cap_ratio': 'funding_cap_ratio', 'status': 'status', - 'launch_time': 'launch_time' + '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, status=None, launch_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, 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() @@ -159,6 +163,8 @@ def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=No 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: @@ -237,12 +243,16 @@ def __init__(self, name=None, type=None, quanto_multiplier=None, leverage_min=No 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): """Gets the name of this Contract. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The name of this Contract. # noqa: E501 :rtype: str @@ -253,7 +263,7 @@ def name(self): def name(self, name): """Sets the name of this Contract. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param name: The name of this Contract. # noqa: E501 :type: str @@ -265,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 @@ -276,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 @@ -294,7 +304,7 @@ def type(self, type): def quanto_multiplier(self): """Gets the quanto_multiplier of this Contract. # noqa: E501 - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :return: The quanto_multiplier of this Contract. # noqa: E501 :rtype: str @@ -305,7 +315,7 @@ def quanto_multiplier(self): def quanto_multiplier(self, quanto_multiplier): """Sets the quanto_multiplier of this Contract. - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :param quanto_multiplier: The quanto_multiplier of this Contract. # noqa: E501 :type: str @@ -317,7 +327,7 @@ def quanto_multiplier(self, quanto_multiplier): def leverage_min(self): """Gets the leverage_min of this Contract. # noqa: E501 - Minimum leverage. # noqa: E501 + Minimum leverage # noqa: E501 :return: The leverage_min of this Contract. # noqa: E501 :rtype: str @@ -328,7 +338,7 @@ def leverage_min(self): def leverage_min(self, leverage_min): """Sets the leverage_min of this Contract. - Minimum leverage. # noqa: E501 + Minimum leverage # noqa: E501 :param leverage_min: The leverage_min of this Contract. # noqa: E501 :type: str @@ -340,7 +350,7 @@ def leverage_min(self, leverage_min): def leverage_max(self): """Gets the leverage_max of this Contract. # noqa: E501 - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :return: The leverage_max of this Contract. # noqa: E501 :rtype: str @@ -351,7 +361,7 @@ def leverage_max(self): def leverage_max(self, leverage_max): """Sets the leverage_max of this Contract. - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :param leverage_max: The leverage_max of this Contract. # noqa: E501 :type: str @@ -363,7 +373,7 @@ def leverage_max(self, leverage_max): def maintenance_rate(self): """Gets the maintenance_rate of this Contract. # noqa: E501 - Maintenance rate of margin. # noqa: E501 + Maintenance rate of margin # noqa: E501 :return: The maintenance_rate of this Contract. # noqa: E501 :rtype: str @@ -374,7 +384,7 @@ def maintenance_rate(self): def maintenance_rate(self, maintenance_rate): """Sets the maintenance_rate of this Contract. - Maintenance rate of margin. # noqa: E501 + Maintenance rate of margin # noqa: E501 :param maintenance_rate: The maintenance_rate of this Contract. # noqa: E501 :type: str @@ -386,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, 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 @@ -397,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, 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 @@ -415,7 +425,7 @@ def mark_type(self, mark_type): def mark_price(self): """Gets the mark_price of this Contract. # noqa: E501 - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :return: The mark_price of this Contract. # noqa: E501 :rtype: str @@ -426,7 +436,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this Contract. - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :param mark_price: The mark_price of this Contract. # noqa: E501 :type: str @@ -438,7 +448,7 @@ def mark_price(self, mark_price): def index_price(self): """Gets the index_price of this Contract. # noqa: E501 - Current index price. # noqa: E501 + Current index price # noqa: E501 :return: The index_price of this Contract. # noqa: E501 :rtype: str @@ -449,7 +459,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this Contract. - Current index price. # noqa: E501 + Current index price # noqa: E501 :param index_price: The index_price of this Contract. # noqa: E501 :type: str @@ -461,7 +471,7 @@ def index_price(self, index_price): def last_price(self): """Gets the last_price of this Contract. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last_price of this Contract. # noqa: E501 :rtype: str @@ -472,7 +482,7 @@ def last_price(self): def last_price(self, last_price): """Sets the last_price of this Contract. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last_price: The last_price of this Contract. # noqa: E501 :type: str @@ -484,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 @@ -495,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 @@ -507,7 +517,7 @@ def maker_fee_rate(self, maker_fee_rate): def taker_fee_rate(self): """Gets the taker_fee_rate of this Contract. # noqa: E501 - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :return: The taker_fee_rate of this Contract. # noqa: E501 :rtype: str @@ -518,7 +528,7 @@ def taker_fee_rate(self): def taker_fee_rate(self, taker_fee_rate): """Sets the taker_fee_rate of this Contract. - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :param taker_fee_rate: The taker_fee_rate of this Contract. # noqa: E501 :type: str @@ -530,7 +540,7 @@ def taker_fee_rate(self, taker_fee_rate): def order_price_round(self): """Gets the order_price_round of this Contract. # noqa: E501 - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :return: The order_price_round of this Contract. # noqa: E501 :rtype: str @@ -541,7 +551,7 @@ def order_price_round(self): def order_price_round(self, order_price_round): """Sets the order_price_round of this Contract. - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :param order_price_round: The order_price_round of this Contract. # noqa: E501 :type: str @@ -553,7 +563,7 @@ def order_price_round(self, order_price_round): def mark_price_round(self): """Gets the mark_price_round of this Contract. # noqa: E501 - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :return: The mark_price_round of this Contract. # noqa: E501 :rtype: str @@ -564,7 +574,7 @@ def mark_price_round(self): def mark_price_round(self, mark_price_round): """Sets the mark_price_round of this Contract. - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :param mark_price_round: The mark_price_round of this Contract. # noqa: E501 :type: str @@ -576,7 +586,7 @@ def mark_price_round(self, mark_price_round): def funding_rate(self): """Gets the funding_rate of this Contract. # noqa: E501 - Current funding rate. # noqa: E501 + Current funding rate # noqa: E501 :return: The funding_rate of this Contract. # noqa: E501 :rtype: str @@ -587,7 +597,7 @@ def funding_rate(self): def funding_rate(self, funding_rate): """Sets the funding_rate of this Contract. - Current funding rate. # noqa: E501 + Current funding rate # noqa: E501 :param funding_rate: The funding_rate of this Contract. # noqa: E501 :type: str @@ -599,7 +609,7 @@ def funding_rate(self, funding_rate): def funding_interval(self): """Gets the funding_interval of this Contract. # noqa: E501 - Funding application interval, unit in seconds. # noqa: E501 + Funding application interval, unit in seconds # noqa: E501 :return: The funding_interval of this Contract. # noqa: E501 :rtype: int @@ -610,7 +620,7 @@ def funding_interval(self): def funding_interval(self, funding_interval): """Sets the funding_interval of this Contract. - Funding application interval, unit in seconds. # noqa: E501 + Funding application interval, unit in seconds # noqa: E501 :param funding_interval: The funding_interval of this Contract. # noqa: E501 :type: int @@ -622,7 +632,7 @@ def funding_interval(self, funding_interval): def funding_next_apply(self): """Gets the funding_next_apply of this Contract. # noqa: E501 - Next funding time. # noqa: E501 + Next funding time # noqa: E501 :return: The funding_next_apply of this Contract. # noqa: E501 :rtype: float @@ -633,7 +643,7 @@ def funding_next_apply(self): def funding_next_apply(self, funding_next_apply): """Sets the funding_next_apply of this Contract. - Next funding time. # noqa: E501 + Next funding time # noqa: E501 :param funding_next_apply: The funding_next_apply of this Contract. # noqa: E501 :type: float @@ -645,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 @@ -656,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 @@ -668,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 @@ -679,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 @@ -691,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 @@ -702,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 @@ -714,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 @@ -725,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 @@ -737,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 @@ -748,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 @@ -760,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 @@ -771,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 @@ -783,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 @@ -794,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 @@ -806,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 @@ -817,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 @@ -829,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 @@ -840,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 @@ -852,7 +862,7 @@ def orderbook_id(self, orderbook_id): def trade_id(self): """Gets the trade_id of this Contract. # noqa: E501 - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :return: The trade_id of this Contract. # noqa: E501 :rtype: int @@ -863,7 +873,7 @@ def trade_id(self): def trade_id(self, trade_id): """Sets the trade_id of this Contract. - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :param trade_id: The trade_id of this Contract. # noqa: E501 :type: int @@ -875,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 @@ -886,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 @@ -898,7 +908,7 @@ def trade_size(self, trade_size): def position_size(self): """Gets the position_size of this Contract. # noqa: E501 - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :return: The position_size of this Contract. # noqa: E501 :rtype: int @@ -909,7 +919,7 @@ def position_size(self): def position_size(self, position_size): """Sets the position_size of this Contract. - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :param position_size: The position_size of this Contract. # noqa: E501 :type: int @@ -921,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 @@ -932,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 @@ -944,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` 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 @@ -955,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` 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 @@ -967,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 @@ -978,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 @@ -990,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 @@ -1001,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 @@ -1013,7 +1023,7 @@ def enable_bonus(self, enable_bonus): def enable_credit(self): """Gets the enable_credit of this Contract. # noqa: E501 - Whether portfolio margin account is enabled. # noqa: E501 + Whether portfolio margin account is enabled # noqa: E501 :return: The enable_credit of this Contract. # noqa: E501 :rtype: bool @@ -1024,7 +1034,7 @@ def enable_credit(self): def enable_credit(self, enable_credit): """Sets the enable_credit of this Contract. - Whether portfolio margin account is enabled. # noqa: E501 + Whether portfolio margin account is enabled # noqa: E501 :param enable_credit: The enable_credit of this Contract. # noqa: E501 :type: bool @@ -1036,7 +1046,7 @@ def enable_credit(self, enable_credit): def create_time(self): """Gets the create_time of this Contract. # noqa: E501 - Created time of the contract. # noqa: E501 + Created time of the contract # noqa: E501 :return: The create_time of this Contract. # noqa: E501 :rtype: float @@ -1047,7 +1057,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this Contract. - Created time of the contract. # noqa: E501 + Created time of the contract # noqa: E501 :param create_time: The create_time of this Contract. # noqa: E501 :type: float @@ -1082,7 +1092,7 @@ def funding_cap_ratio(self, funding_cap_ratio): def status(self): """Gets the status of this Contract. # noqa: E501 - Contract Status Types include: prelaunch, trading, delisting, delisted. # 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 @@ -1093,7 +1103,7 @@ def status(self): def status(self, status): """Sets the status of this Contract. - Contract Status Types include: prelaunch, trading, delisting, delisted. # noqa: E501 + 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 @@ -1105,7 +1115,7 @@ def status(self, status): def launch_time(self): """Gets the launch_time of this Contract. # noqa: E501 - Contract expiry timestamp. # noqa: E501 + Contract expiry timestamp # noqa: E501 :return: The launch_time of this Contract. # noqa: E501 :rtype: int @@ -1116,7 +1126,7 @@ def launch_time(self): def launch_time(self, launch_time): """Sets the launch_time of this Contract. - Contract expiry timestamp. # noqa: E501 + Contract expiry timestamp # noqa: E501 :param launch_time: The launch_time of this Contract. # noqa: E501 :type: int @@ -1124,6 +1134,52 @@ def launch_time(self, launch_time): 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 a5b8dca..cac370c 100644 --- a/gate_api/models/contract_stat.py +++ b/gate_api/models/contract_stat.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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,12 +115,14 @@ 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): """Gets the time of this ContractStat. # noqa: E501 - Stat timestamp. # noqa: E501 + Stat timestamp # noqa: E501 :return: The time of this ContractStat. # noqa: E501 :rtype: int @@ -128,7 +133,7 @@ def time(self): def time(self, time): """Sets the time of this ContractStat. - Stat timestamp. # noqa: E501 + Stat timestamp # noqa: E501 :param time: The time of this ContractStat. # noqa: E501 :type: int @@ -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 @@ -370,7 +375,7 @@ def open_interest_usd(self, open_interest_usd): def top_lsr_account(self): """Gets the top_lsr_account of this ContractStat. # noqa: E501 - Top trader long/short account ratio. # noqa: E501 + Top trader long/short account ratio # noqa: E501 :return: The top_lsr_account of this ContractStat. # noqa: E501 :rtype: float @@ -381,7 +386,7 @@ def top_lsr_account(self): def top_lsr_account(self, top_lsr_account): """Sets the top_lsr_account of this ContractStat. - Top trader long/short account ratio. # noqa: E501 + Top trader long/short account ratio # noqa: E501 :param top_lsr_account: The top_lsr_account of this ContractStat. # noqa: E501 :type: float @@ -393,7 +398,7 @@ def top_lsr_account(self, top_lsr_account): def top_lsr_size(self): """Gets the top_lsr_size of this ContractStat. # noqa: E501 - Top trader long/short position ratio. # noqa: E501 + Top trader long/short position ratio # noqa: E501 :return: The top_lsr_size of this ContractStat. # noqa: E501 :rtype: float @@ -404,7 +409,7 @@ def top_lsr_size(self): def top_lsr_size(self, top_lsr_size): """Sets the top_lsr_size of this ContractStat. - Top trader long/short position ratio. # noqa: E501 + Top trader long/short position ratio # noqa: E501 :param top_lsr_size: The top_lsr_size 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 9cd8342..dc47f37 100644 --- a/gate_api/models/convert_small_balance.py +++ b/gate_api/models/convert_small_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 51f7106..c927a3a 100644 --- a/gate_api/models/countdown_cancel_all_futures_task.py +++ b/gate_api/models/countdown_cancel_all_futures_task.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -86,7 +86,7 @@ def timeout(self, timeout): def contract(self): """Gets the contract of this CountdownCancelAllFuturesTask. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this CountdownCancelAllFuturesTask. # noqa: E501 :rtype: str @@ -97,7 +97,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this CountdownCancelAllFuturesTask. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this CountdownCancelAllFuturesTask. # noqa: E501 :type: str diff --git a/gate_api/models/countdown_cancel_all_options_task.py b/gate_api/models/countdown_cancel_all_options_task.py index 44422f8..b221659 100644 --- a/gate_api/models/countdown_cancel_all_options_task.py +++ b/gate_api/models/countdown_cancel_all_options_task.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -91,7 +91,7 @@ def timeout(self, timeout): def contract(self): """Gets the contract of this CountdownCancelAllOptionsTask. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this CountdownCancelAllOptionsTask. # noqa: E501 :rtype: str @@ -102,7 +102,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this CountdownCancelAllOptionsTask. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this CountdownCancelAllOptionsTask. # noqa: E501 :type: str @@ -114,7 +114,7 @@ def contract(self, contract): def underlying(self): """Gets the underlying of this CountdownCancelAllOptionsTask. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this CountdownCancelAllOptionsTask. # noqa: E501 :rtype: str @@ -125,7 +125,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this CountdownCancelAllOptionsTask. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this CountdownCancelAllOptionsTask. # noqa: E501 :type: str diff --git a/gate_api/models/countdown_cancel_all_spot_task.py b/gate_api/models/countdown_cancel_all_spot_task.py index 0e7af6a..2761477 100644 --- a/gate_api/models/countdown_cancel_all_spot_task.py +++ b/gate_api/models/countdown_cancel_all_spot_task.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -86,7 +86,7 @@ def timeout(self, timeout): def currency_pair(self): """Gets the currency_pair of this CountdownCancelAllSpotTask. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this CountdownCancelAllSpotTask. # noqa: E501 :rtype: str @@ -97,7 +97,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this CountdownCancelAllSpotTask. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this CountdownCancelAllSpotTask. # noqa: E501 :type: str diff --git a/gate_api/models/create_collateral_order.py b/gate_api/models/create_collateral_order.py index 85a8524..f570586 100644 --- a/gate_api/models/create_collateral_order.py +++ b/gate_api/models/create_collateral_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -68,7 +68,7 @@ def __init__(self, collateral_amount=None, collateral_currency=None, borrow_amou def collateral_amount(self): """Gets the collateral_amount of this CreateCollateralOrder. # noqa: E501 - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :return: The collateral_amount of this CreateCollateralOrder. # noqa: E501 :rtype: str @@ -79,7 +79,7 @@ def collateral_amount(self): def collateral_amount(self, collateral_amount): """Sets the collateral_amount of this CreateCollateralOrder. - Collateral amount. # noqa: E501 + Collateral amount # noqa: E501 :param collateral_amount: The collateral_amount of this CreateCollateralOrder. # noqa: E501 :type: str @@ -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 @@ -143,7 +143,7 @@ def borrow_amount(self, borrow_amount): def borrow_currency(self): """Gets the borrow_currency of this CreateCollateralOrder. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this CreateCollateralOrder. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this CreateCollateralOrder. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_currency 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 9e3c00b..b3cc035 100644 --- a/gate_api/models/create_multi_collateral_order.py +++ b/gate_api/models/create_multi_collateral_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -95,7 +95,7 @@ def __init__(self, order_id=None, order_type=None, fixed_type=None, fixed_rate=N def order_id(self): """Gets the order_id of this CreateMultiCollateralOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this CreateMultiCollateralOrder. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this CreateMultiCollateralOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this CreateMultiCollateralOrder. # noqa: E501 :type: str @@ -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 @@ -233,7 +233,7 @@ def auto_repay(self, auto_repay): def borrow_currency(self): """Gets the borrow_currency of this CreateMultiCollateralOrder. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this CreateMultiCollateralOrder. # noqa: E501 :rtype: str @@ -244,7 +244,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this CreateMultiCollateralOrder. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_currency of this CreateMultiCollateralOrder. # noqa: E501 :type: str @@ -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 @@ -283,7 +283,7 @@ def borrow_amount(self, borrow_amount): def collateral_currencies(self): """Gets the collateral_currencies of this CreateMultiCollateralOrder. # noqa: E501 - Collateral currency and amount. # noqa: E501 + Collateral currency and amount # noqa: E501 :return: The collateral_currencies of this CreateMultiCollateralOrder. # noqa: E501 :rtype: list[CollateralCurrency] @@ -294,7 +294,7 @@ def collateral_currencies(self): def collateral_currencies(self, collateral_currencies): """Sets the collateral_currencies of this CreateMultiCollateralOrder. - Collateral currency and amount. # noqa: E501 + Collateral currency and amount # noqa: E501 :param collateral_currencies: The collateral_currencies of this CreateMultiCollateralOrder. # noqa: E501 :type: list[CollateralCurrency] diff --git a/gate_api/models/create_uni_lend.py b/gate_api/models/create_uni_lend.py index a0e84e6..ea40615 100644 --- a/gate_api/models/create_uni_lend.py +++ b/gate_api/models/create_uni_lend.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -69,7 +69,7 @@ def __init__(self, currency=None, amount=None, type=None, min_rate=None, local_v def currency(self): """Gets the currency of this CreateUniLend. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this CreateUniLend. # noqa: E501 :rtype: str @@ -80,7 +80,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CreateUniLend. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this CreateUniLend. # noqa: E501 :type: str @@ -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 8b5dd75..708db4a 100644 --- a/gate_api/models/create_uni_loan.py +++ b/gate_api/models/create_uni_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -73,7 +73,7 @@ def __init__(self, currency=None, type=None, amount=None, repaid_all=None, curre def currency(self): """Gets the currency of this CreateUniLoan. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CreateUniLoan. # noqa: E501 :rtype: str @@ -84,7 +84,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CreateUniLoan. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CreateUniLoan. # noqa: E501 :type: str @@ -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 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 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 @@ -177,7 +177,7 @@ def repaid_all(self, repaid_all): def currency_pair(self): """Gets the currency_pair of this CreateUniLoan. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this CreateUniLoan. # noqa: E501 :rtype: str @@ -188,7 +188,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this CreateUniLoan. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this CreateUniLoan. # noqa: E501 :type: str diff --git a/gate_api/models/cross_margin_balance.py b/gate_api/models/cross_margin_balance.py index 9e28312..6b9d284 100644 --- a/gate_api/models/cross_margin_balance.py +++ b/gate_api/models/cross_margin_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, available=None, freeze=None, borrowed=None, interest=None, lo 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 @@ -83,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 @@ -95,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 @@ -106,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 @@ -118,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 @@ -129,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 @@ -141,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 @@ -152,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 diff --git a/gate_api/models/cross_margin_loan.py b/gate_api/models/cross_margin_loan.py index d548e15..b085e67 100644 --- a/gate_api/models/cross_margin_loan.py +++ b/gate_api/models/cross_margin_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -100,7 +100,7 @@ def __init__(self, id=None, create_time=None, update_time=None, currency=None, a def id(self): """Gets the id of this CrossMarginLoan. # noqa: E501 - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :return: The id of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def id(self): def id(self, id): """Sets the id of this CrossMarginLoan. - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :param id: The id of this CrossMarginLoan. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def id(self, id): def create_time(self): """Gets the create_time of this CrossMarginLoan. # noqa: E501 - Creation timestamp, in milliseconds. # noqa: E501 + Creation timestamp, in milliseconds # noqa: E501 :return: The create_time of this CrossMarginLoan. # noqa: E501 :rtype: int @@ -134,7 +134,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this CrossMarginLoan. - Creation timestamp, in milliseconds. # noqa: E501 + Creation timestamp, in milliseconds # noqa: E501 :param create_time: The create_time of this CrossMarginLoan. # noqa: E501 :type: int @@ -146,7 +146,7 @@ def create_time(self, create_time): def update_time(self): """Gets the update_time of this CrossMarginLoan. # noqa: E501 - Update timestamp, in milliseconds. # noqa: E501 + Update timestamp, in milliseconds # noqa: E501 :return: The update_time of this CrossMarginLoan. # noqa: E501 :rtype: int @@ -157,7 +157,7 @@ def update_time(self): def update_time(self, update_time): """Sets the update_time of this CrossMarginLoan. - Update timestamp, in milliseconds. # noqa: E501 + Update timestamp, in milliseconds # noqa: E501 :param update_time: The update_time of this CrossMarginLoan. # noqa: E501 :type: int @@ -169,7 +169,7 @@ def update_time(self, update_time): def currency(self): """Gets the currency of this CrossMarginLoan. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CrossMarginLoan. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this CrossMarginLoan. # noqa: E501 :type: str @@ -194,7 +194,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this CrossMarginLoan. # noqa: E501 - Borrowed amount. # noqa: E501 + Borrowed amount # noqa: E501 :return: The amount of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -205,7 +205,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this CrossMarginLoan. - Borrowed amount. # noqa: E501 + Borrowed amount # noqa: E501 :param amount: The amount of this CrossMarginLoan. # noqa: E501 :type: str @@ -219,7 +219,7 @@ def amount(self, amount): def text(self): """Gets the text of this CrossMarginLoan. # noqa: E501 - User defined custom ID. # noqa: E501 + User defined custom ID # noqa: E501 :return: The text of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -230,7 +230,7 @@ def text(self): def text(self, text): """Sets the text of this CrossMarginLoan. - User defined custom ID. # noqa: E501 + User defined custom ID # noqa: E501 :param text: The text of this CrossMarginLoan. # noqa: E501 :type: str @@ -271,7 +271,7 @@ def status(self, status): def repaid(self): """Gets the repaid of this CrossMarginLoan. # noqa: E501 - Repaid amount. # noqa: E501 + Repaid amount # noqa: E501 :return: The repaid of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -282,7 +282,7 @@ def repaid(self): def repaid(self, repaid): """Sets the repaid of this CrossMarginLoan. - Repaid amount. # noqa: E501 + Repaid amount # noqa: E501 :param repaid: The repaid of this CrossMarginLoan. # noqa: E501 :type: str @@ -294,7 +294,7 @@ def repaid(self, repaid): def repaid_interest(self): """Gets the repaid_interest of this CrossMarginLoan. # noqa: E501 - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :return: The repaid_interest of this CrossMarginLoan. # noqa: E501 :rtype: str @@ -305,7 +305,7 @@ def repaid_interest(self): def repaid_interest(self, repaid_interest): """Sets the repaid_interest of this CrossMarginLoan. - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :param repaid_interest: The repaid_interest of this CrossMarginLoan. # noqa: E501 :type: str @@ -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 62f977d..6e71d54 100644 --- a/gate_api/models/cross_margin_repayment.py +++ b/gate_api/models/cross_margin_repayment.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, id=None, create_time=None, loan_id=None, currency=None, princ def id(self): """Gets the id of this CrossMarginRepayment. # noqa: E501 - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :return: The id of this CrossMarginRepayment. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def id(self): def id(self, id): """Sets the id of this CrossMarginRepayment. - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :param id: The id of this CrossMarginRepayment. # noqa: E501 :type: str @@ -110,7 +110,7 @@ def id(self, id): def create_time(self): """Gets the create_time of this CrossMarginRepayment. # noqa: E501 - Repayment time. # noqa: E501 + Repayment time # noqa: E501 :return: The create_time of this CrossMarginRepayment. # noqa: E501 :rtype: int @@ -121,7 +121,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this CrossMarginRepayment. - Repayment time. # noqa: E501 + Repayment time # noqa: E501 :param create_time: The create_time of this CrossMarginRepayment. # noqa: E501 :type: int @@ -133,7 +133,7 @@ def create_time(self, create_time): def loan_id(self): """Gets the loan_id of this CrossMarginRepayment. # noqa: E501 - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :return: The loan_id of this CrossMarginRepayment. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def loan_id(self): def loan_id(self, loan_id): """Sets the loan_id of this CrossMarginRepayment. - Loan record ID. # noqa: E501 + Loan record ID # noqa: E501 :param loan_id: The loan_id of this CrossMarginRepayment. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def loan_id(self, loan_id): def currency(self): """Gets the currency of this CrossMarginRepayment. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this CrossMarginRepayment. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CrossMarginRepayment. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this CrossMarginRepayment. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def currency(self, currency): def principal(self): """Gets the principal of this CrossMarginRepayment. # noqa: E501 - Repaid principal. # noqa: E501 + Repaid principal # noqa: E501 :return: The principal of this CrossMarginRepayment. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def principal(self): def principal(self, principal): """Sets the principal of this CrossMarginRepayment. - Repaid principal. # noqa: E501 + Repaid principal # noqa: E501 :param principal: The principal of this CrossMarginRepayment. # noqa: E501 :type: str @@ -202,7 +202,7 @@ def principal(self, principal): def interest(self): """Gets the interest of this CrossMarginRepayment. # noqa: E501 - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :return: The interest of this CrossMarginRepayment. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def interest(self): def interest(self, interest): """Sets the interest of this CrossMarginRepayment. - Repaid interest. # noqa: E501 + Repaid interest # noqa: E501 :param interest: The interest of this CrossMarginRepayment. # noqa: E501 :type: str diff --git a/gate_api/models/currency.py b/gate_api/models/currency.py index 546f292..14789cf 100644 --- a/gate_api/models/currency.py +++ b/gate_api/models/currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, currency=None, name=None, delisted=None, withdraw_disabled=No def currency(self): """Gets the currency of this Currency. # noqa: E501 - Currency symbol. # noqa: E501 + Currency symbol # noqa: E501 :return: The currency of this Currency. # noqa: E501 :rtype: str @@ -113,7 +113,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this Currency. - Currency symbol. # noqa: E501 + Currency symbol # noqa: E501 :param currency: The currency of this Currency. # noqa: E501 :type: str @@ -125,7 +125,7 @@ def currency(self, currency): def name(self): """Gets the name of this Currency. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The name of this Currency. # noqa: E501 :rtype: str @@ -136,7 +136,7 @@ def name(self): def name(self, name): """Sets the name of this Currency. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param name: The name of this Currency. # noqa: E501 :type: str @@ -148,7 +148,7 @@ def name(self, name): def delisted(self): """Gets the delisted of this Currency. # noqa: E501 - Whether currency is de-listed. # noqa: E501 + Whether currency is de-listed # noqa: E501 :return: The delisted of this Currency. # noqa: E501 :rtype: bool @@ -159,7 +159,7 @@ def delisted(self): def delisted(self, delisted): """Sets the delisted of this Currency. - Whether currency is de-listed. # noqa: E501 + Whether currency is de-listed # noqa: E501 :param delisted: The delisted of this Currency. # noqa: E501 :type: bool @@ -171,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 (deprecated). # noqa: E501 + Whether currency's withdrawal is disabled (deprecated) # noqa: E501 :return: The withdraw_disabled of this Currency. # noqa: E501 :rtype: bool @@ -182,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 (deprecated). # noqa: E501 + Whether currency's withdrawal is disabled (deprecated) # noqa: E501 :param withdraw_disabled: The withdraw_disabled of this Currency. # noqa: E501 :type: bool @@ -194,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 (deprecated). # noqa: E501 + Whether currency's withdrawal is delayed (deprecated) # noqa: E501 :return: The withdraw_delayed of this Currency. # noqa: E501 :rtype: bool @@ -205,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 (deprecated). # noqa: E501 + Whether currency's withdrawal is delayed (deprecated) # noqa: E501 :param withdraw_delayed: The withdraw_delayed of this Currency. # noqa: E501 :type: bool @@ -217,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 (deprecated). # noqa: E501 + Whether currency's deposit is disabled (deprecated) # noqa: E501 :return: The deposit_disabled of this Currency. # noqa: E501 :rtype: bool @@ -228,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 (deprecated). # noqa: E501 + Whether currency's deposit is disabled (deprecated) # noqa: E501 :param deposit_disabled: The deposit_disabled of this Currency. # noqa: E501 :type: bool @@ -240,7 +240,7 @@ def deposit_disabled(self, deposit_disabled): def trade_disabled(self): """Gets the trade_disabled of this Currency. # noqa: E501 - Whether currency's trading is disabled. # noqa: E501 + Whether currency's trading is disabled # noqa: E501 :return: The trade_disabled of this Currency. # noqa: E501 :rtype: bool @@ -251,7 +251,7 @@ def trade_disabled(self): def trade_disabled(self, trade_disabled): """Sets the trade_disabled of this Currency. - Whether currency's trading is disabled. # noqa: E501 + Whether currency's trading is disabled # noqa: E501 :param trade_disabled: The trade_disabled of this Currency. # noqa: E501 :type: bool @@ -286,7 +286,7 @@ def fixed_rate(self, fixed_rate): def chain(self): """Gets the chain of this Currency. # noqa: E501 - The main chain corresponding to the coin. # noqa: E501 + The main chain corresponding to the coin # noqa: E501 :return: The chain of this Currency. # noqa: E501 :rtype: str @@ -297,7 +297,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this Currency. - The main chain corresponding to the coin. # noqa: E501 + The main chain corresponding to the coin # noqa: E501 :param chain: The chain of this Currency. # noqa: E501 :type: str @@ -309,7 +309,7 @@ def chain(self, chain): def chains(self): """Gets the chains of this Currency. # noqa: E501 - All links corresponding to coins. # noqa: E501 + All links corresponding to coins # noqa: E501 :return: The chains of this Currency. # noqa: E501 :rtype: list[SpotCurrencyChain] @@ -320,7 +320,7 @@ def chains(self): def chains(self, chains): """Sets the chains of this Currency. - All links corresponding to coins. # noqa: E501 + All links corresponding to coins # noqa: E501 :param chains: The chains of this Currency. # noqa: E501 :type: list[SpotCurrencyChain] diff --git a/gate_api/models/currency_chain.py b/gate_api/models/currency_chain.py index bbe35ef..5feb14f 100644 --- a/gate_api/models/currency_chain.py +++ b/gate_api/models/currency_chain.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, chain=None, name_cn=None, name_en=None, contract_address=None def chain(self): """Gets the chain of this CurrencyChain. # noqa: E501 - Chain name. # noqa: E501 + Chain name # noqa: E501 :return: The chain of this CurrencyChain. # noqa: E501 :rtype: str @@ -103,7 +103,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this CurrencyChain. - Chain name. # noqa: E501 + Chain name # noqa: E501 :param chain: The chain of this CurrencyChain. # noqa: E501 :type: str @@ -115,7 +115,7 @@ def chain(self, chain): def name_cn(self): """Gets the name_cn of this CurrencyChain. # noqa: E501 - Chain name in Chinese. # noqa: E501 + Chain name in Chinese # noqa: E501 :return: The name_cn of this CurrencyChain. # noqa: E501 :rtype: str @@ -126,7 +126,7 @@ def name_cn(self): def name_cn(self, name_cn): """Sets the name_cn of this CurrencyChain. - Chain name in Chinese. # noqa: E501 + Chain name in Chinese # noqa: E501 :param name_cn: The name_cn of this CurrencyChain. # noqa: E501 :type: str @@ -138,7 +138,7 @@ def name_cn(self, name_cn): def name_en(self): """Gets the name_en of this CurrencyChain. # noqa: E501 - Chain name in English. # noqa: E501 + Chain name in English # noqa: E501 :return: The name_en of this CurrencyChain. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def name_en(self): def name_en(self, name_en): """Sets the name_en of this CurrencyChain. - Chain name in English. # noqa: E501 + Chain name in English # noqa: E501 :param name_en: The name_en of this CurrencyChain. # noqa: E501 :type: str @@ -184,7 +184,7 @@ def contract_address(self, contract_address): def is_disabled(self): """Gets the is_disabled of this CurrencyChain. # noqa: E501 - If it is disabled. 0 means NOT being disabled. # noqa: E501 + If it is disabled. 0 means NOT being disabled # noqa: E501 :return: The is_disabled of this CurrencyChain. # noqa: E501 :rtype: int @@ -195,7 +195,7 @@ def is_disabled(self): def is_disabled(self, is_disabled): """Sets the is_disabled of this CurrencyChain. - If it is disabled. 0 means NOT being disabled. # noqa: E501 + If it is disabled. 0 means NOT being disabled # noqa: E501 :param is_disabled: The is_disabled of this CurrencyChain. # noqa: E501 :type: int @@ -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 @@ -253,7 +253,7 @@ def is_withdraw_disabled(self, is_withdraw_disabled): def decimal(self): """Gets the decimal of this CurrencyChain. # noqa: E501 - Withdrawal precision. # noqa: E501 + Withdrawal precision # noqa: E501 :return: The decimal of this CurrencyChain. # noqa: E501 :rtype: str @@ -264,7 +264,7 @@ def decimal(self): def decimal(self, decimal): """Sets the decimal of this CurrencyChain. - Withdrawal precision. # noqa: E501 + Withdrawal precision # noqa: E501 :param decimal: The decimal of this CurrencyChain. # noqa: E501 :type: str diff --git a/gate_api/models/currency_pair.py b/gate_api/models/currency_pair.py index a528d77..26e7959 100644 --- a/gate_api/models/currency_pair.py +++ b/gate_api/models/currency_pair.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -147,7 +147,7 @@ def __init__(self, id=None, base=None, base_name=None, quote=None, quote_name=No def id(self): """Gets the id of this CurrencyPair. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The id of this CurrencyPair. # noqa: E501 :rtype: str @@ -158,7 +158,7 @@ def id(self): def id(self, id): """Sets the id of this CurrencyPair. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param id: The id of this CurrencyPair. # noqa: E501 :type: str @@ -170,7 +170,7 @@ def id(self, id): def base(self): """Gets the base of this CurrencyPair. # noqa: E501 - Base currency. # noqa: E501 + Base currency # noqa: E501 :return: The base of this CurrencyPair. # noqa: E501 :rtype: str @@ -181,7 +181,7 @@ def base(self): def base(self, base): """Sets the base of this CurrencyPair. - Base currency. # noqa: E501 + Base currency # noqa: E501 :param base: The base of this CurrencyPair. # noqa: E501 :type: str @@ -193,7 +193,7 @@ def base(self, base): def base_name(self): """Gets the base_name of this CurrencyPair. # noqa: E501 - Transaction currency name. # noqa: E501 + Base currency name # noqa: E501 :return: The base_name of this CurrencyPair. # noqa: E501 :rtype: str @@ -204,7 +204,7 @@ def base_name(self): def base_name(self, base_name): """Sets the base_name of this CurrencyPair. - Transaction currency name. # noqa: E501 + Base currency name # noqa: E501 :param base_name: The base_name of this CurrencyPair. # noqa: E501 :type: str @@ -216,7 +216,7 @@ def base_name(self, base_name): def quote(self): """Gets the quote of this CurrencyPair. # noqa: E501 - Quote currency. # noqa: E501 + Quote currency # noqa: E501 :return: The quote of this CurrencyPair. # noqa: E501 :rtype: str @@ -227,7 +227,7 @@ def quote(self): def quote(self, quote): """Sets the quote of this CurrencyPair. - Quote currency. # noqa: E501 + Quote currency # noqa: E501 :param quote: The quote of this CurrencyPair. # noqa: E501 :type: str @@ -239,7 +239,7 @@ def quote(self, quote): def quote_name(self): """Gets the quote_name of this CurrencyPair. # noqa: E501 - Name of the denominated currency. # noqa: E501 + Quote currency name # noqa: E501 :return: The quote_name of this CurrencyPair. # noqa: E501 :rtype: str @@ -250,7 +250,7 @@ def quote_name(self): def quote_name(self, quote_name): """Sets the quote_name of this CurrencyPair. - Name of the denominated currency. # noqa: E501 + Quote currency name # noqa: E501 :param quote_name: The quote_name of this CurrencyPair. # noqa: E501 :type: str @@ -262,7 +262,7 @@ def quote_name(self, quote_name): 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 @@ -273,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 @@ -285,7 +285,7 @@ def fee(self, fee): def min_base_amount(self): """Gets the min_base_amount of this CurrencyPair. # noqa: E501 - Minimum amount of base currency to trade, `null` means no limit. # noqa: E501 + Minimum amount of base currency to trade, `null` means no limit # noqa: E501 :return: The min_base_amount of this CurrencyPair. # noqa: E501 :rtype: str @@ -296,7 +296,7 @@ def min_base_amount(self): def min_base_amount(self, min_base_amount): """Sets the min_base_amount of this CurrencyPair. - Minimum amount of base currency to trade, `null` means no limit. # noqa: E501 + Minimum amount of base currency to trade, `null` means no limit # noqa: E501 :param min_base_amount: The min_base_amount of this CurrencyPair. # noqa: E501 :type: str @@ -308,7 +308,7 @@ def min_base_amount(self, min_base_amount): def min_quote_amount(self): """Gets the min_quote_amount of this CurrencyPair. # noqa: E501 - Minimum amount of quote currency to trade, `null` means no limit. # noqa: E501 + Minimum amount of quote currency to trade, `null` means no limit # noqa: E501 :return: The min_quote_amount of this CurrencyPair. # noqa: E501 :rtype: str @@ -319,7 +319,7 @@ def min_quote_amount(self): def min_quote_amount(self, min_quote_amount): """Sets the min_quote_amount of this CurrencyPair. - Minimum amount of quote currency to trade, `null` means no limit. # noqa: E501 + Minimum amount of quote currency to trade, `null` means no limit # noqa: E501 :param min_quote_amount: The min_quote_amount of this CurrencyPair. # noqa: E501 :type: str @@ -331,7 +331,7 @@ def min_quote_amount(self, min_quote_amount): def max_base_amount(self): """Gets the max_base_amount of this CurrencyPair. # noqa: E501 - Maximum amount of base currency to trade, `null` means no limit. # noqa: E501 + Maximum amount of base currency to trade, `null` means no limit # noqa: E501 :return: The max_base_amount of this CurrencyPair. # noqa: E501 :rtype: str @@ -342,7 +342,7 @@ def max_base_amount(self): def max_base_amount(self, max_base_amount): """Sets the max_base_amount of this CurrencyPair. - Maximum amount of base currency to trade, `null` means no limit. # noqa: E501 + Maximum amount of base currency to trade, `null` means no limit # noqa: E501 :param max_base_amount: The max_base_amount of this CurrencyPair. # noqa: E501 :type: str @@ -354,7 +354,7 @@ def max_base_amount(self, max_base_amount): def max_quote_amount(self): """Gets the max_quote_amount of this CurrencyPair. # noqa: E501 - Maximum amount of quote currency to trade, `null` means no limit. # noqa: E501 + Maximum amount of quote currency to trade, `null` means no limit # noqa: E501 :return: The max_quote_amount of this CurrencyPair. # noqa: E501 :rtype: str @@ -365,7 +365,7 @@ def max_quote_amount(self): def max_quote_amount(self, max_quote_amount): """Sets the max_quote_amount of this CurrencyPair. - Maximum amount of quote currency to trade, `null` means no limit. # noqa: E501 + Maximum amount of quote currency to trade, `null` means no limit # noqa: E501 :param max_quote_amount: The max_quote_amount of this CurrencyPair. # noqa: E501 :type: str @@ -377,7 +377,7 @@ def max_quote_amount(self, max_quote_amount): def amount_precision(self): """Gets the amount_precision of this CurrencyPair. # noqa: E501 - Amount scale. # noqa: E501 + Amount scale # noqa: E501 :return: The amount_precision of this CurrencyPair. # noqa: E501 :rtype: int @@ -388,7 +388,7 @@ def amount_precision(self): def amount_precision(self, amount_precision): """Sets the amount_precision of this CurrencyPair. - Amount scale. # noqa: E501 + Amount scale # noqa: E501 :param amount_precision: The amount_precision of this CurrencyPair. # noqa: E501 :type: int @@ -400,7 +400,7 @@ def amount_precision(self, amount_precision): def precision(self): """Gets the precision of this CurrencyPair. # noqa: E501 - Price scale. # noqa: E501 + Price scale # noqa: E501 :return: The precision of this CurrencyPair. # noqa: E501 :rtype: int @@ -411,7 +411,7 @@ def precision(self): def precision(self, precision): """Sets the precision of this CurrencyPair. - Price scale. # noqa: E501 + Price scale # noqa: E501 :param precision: The precision of this CurrencyPair. # noqa: E501 :type: int @@ -423,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: 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 @@ -434,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: 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 @@ -452,7 +452,7 @@ def trade_status(self, trade_status): def sell_start(self): """Gets the sell_start of this CurrencyPair. # noqa: E501 - Sell start unix timestamp in seconds. # noqa: E501 + Sell start unix timestamp in seconds # noqa: E501 :return: The sell_start of this CurrencyPair. # noqa: E501 :rtype: int @@ -463,7 +463,7 @@ def sell_start(self): def sell_start(self, sell_start): """Sets the sell_start of this CurrencyPair. - Sell start unix timestamp in seconds. # noqa: E501 + Sell start unix timestamp in seconds # noqa: E501 :param sell_start: The sell_start of this CurrencyPair. # noqa: E501 :type: int @@ -475,7 +475,7 @@ def sell_start(self, sell_start): def buy_start(self): """Gets the buy_start of this CurrencyPair. # noqa: E501 - Buy start unix timestamp in seconds. # noqa: E501 + Buy start unix timestamp in seconds # noqa: E501 :return: The buy_start of this CurrencyPair. # noqa: E501 :rtype: int @@ -486,7 +486,7 @@ def buy_start(self): def buy_start(self, buy_start): """Sets the buy_start of this CurrencyPair. - Buy start unix timestamp in seconds. # noqa: E501 + Buy start unix timestamp in seconds # noqa: E501 :param buy_start: The buy_start of this CurrencyPair. # noqa: E501 :type: int @@ -498,7 +498,7 @@ def buy_start(self, buy_start): 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 + Expected time to remove the shelves, Unix timestamp in seconds # noqa: E501 :return: The delisting_time of this CurrencyPair. # noqa: E501 :rtype: int @@ -509,7 +509,7 @@ def delisting_time(self): 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 + 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 @@ -521,7 +521,7 @@ def delisting_time(self, delisting_time): def type(self): """Gets the type of this CurrencyPair. # noqa: E501 - Trading pair type, normal: normal, premarket: pre-market. # noqa: E501 + Trading pair type, normal: normal, premarket: pre-market # noqa: E501 :return: The type of this CurrencyPair. # noqa: E501 :rtype: str @@ -532,7 +532,7 @@ def type(self): def type(self, type): """Sets the type of this CurrencyPair. - Trading pair type, normal: normal, premarket: pre-market. # noqa: E501 + Trading pair type, normal: normal, premarket: pre-market # noqa: E501 :param type: The type of this CurrencyPair. # noqa: E501 :type: str @@ -544,7 +544,7 @@ def type(self, type): def trade_url(self): """Gets the trade_url of this CurrencyPair. # noqa: E501 - Transaction link. # noqa: E501 + Transaction link # noqa: E501 :return: The trade_url of this CurrencyPair. # noqa: E501 :rtype: str @@ -555,7 +555,7 @@ def trade_url(self): def trade_url(self, trade_url): """Sets the trade_url of this CurrencyPair. - Transaction link. # noqa: E501 + Transaction link # noqa: E501 :param trade_url: The trade_url of this CurrencyPair. # noqa: E501 :type: str @@ -567,7 +567,7 @@ def trade_url(self, trade_url): 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 + 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 @@ -578,7 +578,7 @@ def st_tag(self): 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 + 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 diff --git a/gate_api/models/currency_quota.py b/gate_api/models/currency_quota.py index 2288c09..3ebee02 100644 --- a/gate_api/models/currency_quota.py +++ b/gate_api/models/currency_quota.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, currency=None, index_price=None, min_quota=None, left_quota=N def currency(self): """Gets the currency of this CurrencyQuota. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this CurrencyQuota. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this CurrencyQuota. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this CurrencyQuota. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this CurrencyQuota. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this CurrencyQuota. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this CurrencyQuota. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this CurrencyQuota. # noqa: E501 :type: str @@ -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 @@ -169,7 +169,7 @@ def left_quota(self, left_quota): def left_quote_usdt(self): """Gets the left_quote_usdt of this CurrencyQuota. # noqa: E501 - Remaining currency limit converted to USDT. # noqa: E501 + Remaining currency limit converted to USDT # noqa: E501 :return: The left_quote_usdt of this CurrencyQuota. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def left_quote_usdt(self): def left_quote_usdt(self, left_quote_usdt): """Sets the left_quote_usdt of this CurrencyQuota. - Remaining currency limit converted to USDT. # noqa: E501 + Remaining currency limit converted to USDT # noqa: E501 :param left_quote_usdt: The left_quote_usdt of this CurrencyQuota. # noqa: E501 :type: str diff --git a/gate_api/models/debit_fee.py b/gate_api/models/debit_fee.py index 5919508..d563fe2 100644 --- a/gate_api/models/debit_fee.py +++ b/gate_api/models/debit_fee.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -56,7 +56,7 @@ def __init__(self, enabled=None, local_vars_configuration=None): # noqa: E501 def enabled(self): """Gets the enabled of this DebitFee. # noqa: E501 - Whether GT fee discount is used. # noqa: E501 + Whether GT fee deduction is enabled # noqa: E501 :return: The enabled of this DebitFee. # noqa: E501 :rtype: bool @@ -67,7 +67,7 @@ def enabled(self): def enabled(self, enabled): """Sets the enabled of this DebitFee. - Whether GT fee discount is used. # noqa: E501 + Whether GT fee deduction is enabled # noqa: E501 :param enabled: The enabled of this DebitFee. # noqa: E501 :type: bool diff --git a/gate_api/models/delivery_candlestick.py b/gate_api/models/delivery_candlestick.py index 672129f..83355ce 100644 --- a/gate_api/models/delivery_candlestick.py +++ b/gate_api/models/delivery_candlestick.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, t=None, v=None, c=None, h=None, l=None, o=None, local_vars_co def t(self): """Gets the t of this DeliveryCandlestick. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this DeliveryCandlestick. # noqa: E501 :rtype: float @@ -93,7 +93,7 @@ def t(self): def t(self, t): """Sets the t of this DeliveryCandlestick. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this DeliveryCandlestick. # noqa: E501 :type: float @@ -105,7 +105,7 @@ def t(self, t): def v(self): """Gets the v of this DeliveryCandlestick. # noqa: E501 - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :return: The v of this DeliveryCandlestick. # noqa: E501 :rtype: int @@ -116,7 +116,7 @@ def v(self): def v(self, v): """Sets the v of this DeliveryCandlestick. - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :param v: The v of this DeliveryCandlestick. # noqa: E501 :type: int @@ -128,7 +128,7 @@ def v(self, v): def c(self): """Gets the c of this DeliveryCandlestick. # noqa: E501 - Close price (quote currency). # noqa: E501 + Close price (quote currency) # noqa: E501 :return: The c of this DeliveryCandlestick. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def c(self): def c(self, c): """Sets the c of this DeliveryCandlestick. - Close price (quote currency). # noqa: E501 + Close price (quote currency) # noqa: E501 :param c: The c of this DeliveryCandlestick. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def c(self, c): def h(self): """Gets the h of this DeliveryCandlestick. # noqa: E501 - Highest price (quote currency). # noqa: E501 + Highest price (quote currency) # noqa: E501 :return: The h of this DeliveryCandlestick. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def h(self): def h(self, h): """Sets the h of this DeliveryCandlestick. - Highest price (quote currency). # noqa: E501 + Highest price (quote currency) # noqa: E501 :param h: The h of this DeliveryCandlestick. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def h(self, h): def l(self): """Gets the l of this DeliveryCandlestick. # noqa: E501 - Lowest price (quote currency). # noqa: E501 + Lowest price (quote currency) # noqa: E501 :return: The l of this DeliveryCandlestick. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def l(self): def l(self, l): """Sets the l of this DeliveryCandlestick. - Lowest price (quote currency). # noqa: E501 + Lowest price (quote currency) # noqa: E501 :param l: The l of this DeliveryCandlestick. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def l(self, l): def o(self): """Gets the o of this DeliveryCandlestick. # noqa: E501 - Open price (quote currency). # noqa: E501 + Open price (quote currency) # noqa: E501 :return: The o of this DeliveryCandlestick. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def o(self): def o(self, o): """Sets the o of this DeliveryCandlestick. - Open price (quote currency). # noqa: E501 + Open price (quote currency) # noqa: E501 :param o: The o of this DeliveryCandlestick. # noqa: E501 :type: str diff --git a/gate_api/models/delivery_contract.py b/gate_api/models/delivery_contract.py index b6fa44e..57b228c 100644 --- a/gate_api/models/delivery_contract.py +++ b/gate_api/models/delivery_contract.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -242,7 +242,7 @@ def __init__(self, name=None, underlying=None, cycle=None, type=None, quanto_mul def name(self): """Gets the name of this DeliveryContract. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The name of this DeliveryContract. # noqa: E501 :rtype: str @@ -253,7 +253,7 @@ def name(self): def name(self, name): """Sets the name of this DeliveryContract. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param name: The name of this DeliveryContract. # noqa: E501 :type: str @@ -265,7 +265,7 @@ def name(self, name): def underlying(self): """Gets the underlying of this DeliveryContract. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this DeliveryContract. # noqa: E501 :rtype: str @@ -276,7 +276,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this DeliveryContract. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this DeliveryContract. # noqa: E501 :type: str @@ -288,7 +288,7 @@ def underlying(self, underlying): def cycle(self): """Gets the cycle of this DeliveryContract. # noqa: E501 - Cycle type, e.g. WEEKLY, QUARTERLY. # noqa: E501 + Cycle type, e.g. WEEKLY, QUARTERLY # noqa: E501 :return: The cycle of this DeliveryContract. # noqa: E501 :rtype: str @@ -299,7 +299,7 @@ def cycle(self): def cycle(self, cycle): """Sets the cycle of this DeliveryContract. - Cycle type, e.g. WEEKLY, QUARTERLY. # noqa: E501 + Cycle type, e.g. WEEKLY, QUARTERLY # noqa: E501 :param cycle: The cycle of this DeliveryContract. # noqa: E501 :type: str @@ -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 @@ -346,7 +346,7 @@ def type(self, type): def quanto_multiplier(self): """Gets the quanto_multiplier of this DeliveryContract. # noqa: E501 - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :return: The quanto_multiplier of this DeliveryContract. # noqa: E501 :rtype: str @@ -357,7 +357,7 @@ def quanto_multiplier(self): def quanto_multiplier(self, quanto_multiplier): """Sets the quanto_multiplier of this DeliveryContract. - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :param quanto_multiplier: The quanto_multiplier of this DeliveryContract. # noqa: E501 :type: str @@ -369,7 +369,7 @@ def quanto_multiplier(self, quanto_multiplier): def leverage_min(self): """Gets the leverage_min of this DeliveryContract. # noqa: E501 - Minimum leverage. # noqa: E501 + Minimum leverage # noqa: E501 :return: The leverage_min of this DeliveryContract. # noqa: E501 :rtype: str @@ -380,7 +380,7 @@ def leverage_min(self): def leverage_min(self, leverage_min): """Sets the leverage_min of this DeliveryContract. - Minimum leverage. # noqa: E501 + Minimum leverage # noqa: E501 :param leverage_min: The leverage_min of this DeliveryContract. # noqa: E501 :type: str @@ -392,7 +392,7 @@ def leverage_min(self, leverage_min): def leverage_max(self): """Gets the leverage_max of this DeliveryContract. # noqa: E501 - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :return: The leverage_max of this DeliveryContract. # noqa: E501 :rtype: str @@ -403,7 +403,7 @@ def leverage_max(self): def leverage_max(self, leverage_max): """Sets the leverage_max of this DeliveryContract. - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :param leverage_max: The leverage_max of this DeliveryContract. # noqa: E501 :type: str @@ -415,7 +415,7 @@ def leverage_max(self, leverage_max): def maintenance_rate(self): """Gets the maintenance_rate of this DeliveryContract. # noqa: E501 - Maintenance rate of margin. # noqa: E501 + Maintenance rate of margin # noqa: E501 :return: The maintenance_rate of this DeliveryContract. # noqa: E501 :rtype: str @@ -426,7 +426,7 @@ def maintenance_rate(self): def maintenance_rate(self, maintenance_rate): """Sets the maintenance_rate of this DeliveryContract. - Maintenance rate of margin. # noqa: E501 + Maintenance rate of margin # noqa: E501 :param maintenance_rate: The maintenance_rate 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, 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, 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 @@ -467,7 +467,7 @@ def mark_type(self, mark_type): def mark_price(self): """Gets the mark_price of this DeliveryContract. # noqa: E501 - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :return: The mark_price of this DeliveryContract. # noqa: E501 :rtype: str @@ -478,7 +478,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this DeliveryContract. - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :param mark_price: The mark_price of this DeliveryContract. # noqa: E501 :type: str @@ -490,7 +490,7 @@ def mark_price(self, mark_price): def index_price(self): """Gets the index_price of this DeliveryContract. # noqa: E501 - Current index price. # noqa: E501 + Current index price # noqa: E501 :return: The index_price of this DeliveryContract. # noqa: E501 :rtype: str @@ -501,7 +501,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this DeliveryContract. - Current index price. # noqa: E501 + Current index price # noqa: E501 :param index_price: The index_price of this DeliveryContract. # noqa: E501 :type: str @@ -513,7 +513,7 @@ def index_price(self, index_price): def last_price(self): """Gets the last_price of this DeliveryContract. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last_price of this DeliveryContract. # noqa: E501 :rtype: str @@ -524,7 +524,7 @@ def last_price(self): def last_price(self, last_price): """Sets the last_price of this DeliveryContract. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last_price: The last_price 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 @@ -559,7 +559,7 @@ def maker_fee_rate(self, maker_fee_rate): def taker_fee_rate(self): """Gets the taker_fee_rate of this DeliveryContract. # noqa: E501 - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :return: The taker_fee_rate of this DeliveryContract. # noqa: E501 :rtype: str @@ -570,7 +570,7 @@ def taker_fee_rate(self): def taker_fee_rate(self, taker_fee_rate): """Sets the taker_fee_rate of this DeliveryContract. - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :param taker_fee_rate: The taker_fee_rate of this DeliveryContract. # noqa: E501 :type: str @@ -582,7 +582,7 @@ def taker_fee_rate(self, taker_fee_rate): def order_price_round(self): """Gets the order_price_round of this DeliveryContract. # noqa: E501 - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :return: The order_price_round of this DeliveryContract. # noqa: E501 :rtype: str @@ -593,7 +593,7 @@ def order_price_round(self): def order_price_round(self, order_price_round): """Sets the order_price_round of this DeliveryContract. - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :param order_price_round: The order_price_round of this DeliveryContract. # noqa: E501 :type: str @@ -605,7 +605,7 @@ def order_price_round(self, order_price_round): def mark_price_round(self): """Gets the mark_price_round of this DeliveryContract. # noqa: E501 - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :return: The mark_price_round of this DeliveryContract. # noqa: E501 :rtype: str @@ -616,7 +616,7 @@ def mark_price_round(self): def mark_price_round(self, mark_price_round): """Sets the mark_price_round of this DeliveryContract. - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :param mark_price_round: The mark_price_round of this DeliveryContract. # noqa: E501 :type: str @@ -628,7 +628,7 @@ def mark_price_round(self, mark_price_round): def basis_rate(self): """Gets the basis_rate of this DeliveryContract. # noqa: E501 - Fair basis rate. # noqa: E501 + Fair basis rate # noqa: E501 :return: The basis_rate of this DeliveryContract. # noqa: E501 :rtype: str @@ -639,7 +639,7 @@ def basis_rate(self): def basis_rate(self, basis_rate): """Sets the basis_rate of this DeliveryContract. - Fair basis rate. # noqa: E501 + Fair basis rate # noqa: E501 :param basis_rate: The basis_rate of this DeliveryContract. # noqa: E501 :type: str @@ -651,7 +651,7 @@ def basis_rate(self, basis_rate): def basis_value(self): """Gets the basis_value of this DeliveryContract. # noqa: E501 - Fair basis value. # noqa: E501 + Fair basis value # noqa: E501 :return: The basis_value of this DeliveryContract. # noqa: E501 :rtype: str @@ -662,7 +662,7 @@ def basis_value(self): def basis_value(self, basis_value): """Sets the basis_value of this DeliveryContract. - Fair basis value. # noqa: E501 + Fair basis value # noqa: E501 :param basis_value: The basis_value of this DeliveryContract. # noqa: E501 :type: str @@ -674,7 +674,7 @@ def basis_value(self, basis_value): def basis_impact_value(self): """Gets the basis_impact_value of this DeliveryContract. # noqa: E501 - Funding used for calculating impact bid, ask price. # noqa: E501 + Funding used for calculating impact bid, ask price # noqa: E501 :return: The basis_impact_value of this DeliveryContract. # noqa: E501 :rtype: str @@ -685,7 +685,7 @@ def basis_impact_value(self): def basis_impact_value(self, basis_impact_value): """Sets the basis_impact_value of this DeliveryContract. - Funding used for calculating impact bid, ask price. # noqa: E501 + Funding used for calculating impact bid, ask price # noqa: E501 :param basis_impact_value: The basis_impact_value of this DeliveryContract. # noqa: E501 :type: str @@ -697,7 +697,7 @@ def basis_impact_value(self, basis_impact_value): def settle_price(self): """Gets the settle_price of this DeliveryContract. # noqa: E501 - Settle price. # noqa: E501 + Settle price # noqa: E501 :return: The settle_price of this DeliveryContract. # noqa: E501 :rtype: str @@ -708,7 +708,7 @@ def settle_price(self): def settle_price(self, settle_price): """Sets the settle_price of this DeliveryContract. - Settle price. # noqa: E501 + Settle price # noqa: E501 :param settle_price: The settle_price of this DeliveryContract. # noqa: E501 :type: str @@ -720,7 +720,7 @@ def settle_price(self, settle_price): def settle_price_interval(self): """Gets the settle_price_interval of this DeliveryContract. # noqa: E501 - Settle price update interval. # noqa: E501 + Settle price update interval # noqa: E501 :return: The settle_price_interval of this DeliveryContract. # noqa: E501 :rtype: int @@ -731,7 +731,7 @@ def settle_price_interval(self): def settle_price_interval(self, settle_price_interval): """Sets the settle_price_interval of this DeliveryContract. - Settle price update interval. # noqa: E501 + Settle price update interval # noqa: E501 :param settle_price_interval: The settle_price_interval of this DeliveryContract. # noqa: E501 :type: int @@ -743,7 +743,7 @@ def settle_price_interval(self, settle_price_interval): def settle_price_duration(self): """Gets the settle_price_duration of this DeliveryContract. # noqa: E501 - Settle price update duration in seconds. # noqa: E501 + Settle price update duration in seconds # noqa: E501 :return: The settle_price_duration of this DeliveryContract. # noqa: E501 :rtype: int @@ -754,7 +754,7 @@ def settle_price_duration(self): def settle_price_duration(self, settle_price_duration): """Sets the settle_price_duration of this DeliveryContract. - Settle price update duration in seconds. # noqa: E501 + Settle price update duration in seconds # noqa: E501 :param settle_price_duration: The settle_price_duration of this DeliveryContract. # noqa: E501 :type: int @@ -766,7 +766,7 @@ def settle_price_duration(self, settle_price_duration): def expire_time(self): """Gets the expire_time of this DeliveryContract. # noqa: E501 - Contract expiry timestamp. # noqa: E501 + Contract expiry timestamp # noqa: E501 :return: The expire_time of this DeliveryContract. # noqa: E501 :rtype: int @@ -777,7 +777,7 @@ def expire_time(self): def expire_time(self, expire_time): """Sets the expire_time of this DeliveryContract. - Contract expiry timestamp. # noqa: E501 + Contract expiry timestamp # noqa: E501 :param expire_time: The expire_time of this DeliveryContract. # noqa: E501 :type: int @@ -789,7 +789,7 @@ def expire_time(self, expire_time): def risk_limit_base(self): """Gets the risk_limit_base of this DeliveryContract. # noqa: E501 - Risk limit base. # noqa: E501 + Risk limit base # noqa: E501 :return: The risk_limit_base of this DeliveryContract. # noqa: E501 :rtype: str @@ -800,7 +800,7 @@ def risk_limit_base(self): def risk_limit_base(self, risk_limit_base): """Sets the risk_limit_base of this DeliveryContract. - Risk limit base. # noqa: E501 + Risk limit base # noqa: E501 :param risk_limit_base: The risk_limit_base of this DeliveryContract. # noqa: E501 :type: str @@ -812,7 +812,7 @@ def risk_limit_base(self, risk_limit_base): def risk_limit_step(self): """Gets the risk_limit_step of this DeliveryContract. # noqa: E501 - Step of adjusting risk limit. # noqa: E501 + Step of adjusting risk limit # noqa: E501 :return: The risk_limit_step of this DeliveryContract. # noqa: E501 :rtype: str @@ -823,7 +823,7 @@ def risk_limit_step(self): def risk_limit_step(self, risk_limit_step): """Sets the risk_limit_step of this DeliveryContract. - Step of adjusting risk limit. # noqa: E501 + Step of adjusting risk limit # noqa: E501 :param risk_limit_step: The risk_limit_step of this DeliveryContract. # noqa: E501 :type: str @@ -835,7 +835,7 @@ def risk_limit_step(self, risk_limit_step): def risk_limit_max(self): """Gets the risk_limit_max of this DeliveryContract. # noqa: E501 - Maximum risk limit the contract allowed. # noqa: E501 + Maximum risk limit the contract allowed # noqa: E501 :return: The risk_limit_max of this DeliveryContract. # noqa: E501 :rtype: str @@ -846,7 +846,7 @@ def risk_limit_max(self): def risk_limit_max(self, risk_limit_max): """Sets the risk_limit_max of this DeliveryContract. - Maximum risk limit the contract allowed. # noqa: E501 + Maximum risk limit the contract allowed # noqa: E501 :param risk_limit_max: The risk_limit_max 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 @@ -996,7 +996,7 @@ def orderbook_id(self, orderbook_id): def trade_id(self): """Gets the trade_id of this DeliveryContract. # noqa: E501 - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :return: The trade_id of this DeliveryContract. # noqa: E501 :rtype: int @@ -1007,7 +1007,7 @@ def trade_id(self): def trade_id(self, trade_id): """Sets the trade_id of this DeliveryContract. - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :param trade_id: The trade_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 @@ -1042,7 +1042,7 @@ def trade_size(self, trade_size): def position_size(self): """Gets the position_size of this DeliveryContract. # noqa: E501 - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :return: The position_size of this DeliveryContract. # noqa: E501 :rtype: int @@ -1053,7 +1053,7 @@ def position_size(self): def position_size(self, position_size): """Sets the position_size of this DeliveryContract. - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :param position_size: The position_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 @@ -1088,7 +1088,7 @@ def config_change_time(self, config_change_time): def in_delisting(self): """Gets the in_delisting of this DeliveryContract. # noqa: E501 - Contract is delisting. # noqa: E501 + Contract is delisting # noqa: E501 :return: The in_delisting of this DeliveryContract. # noqa: E501 :rtype: bool @@ -1099,7 +1099,7 @@ def in_delisting(self): def in_delisting(self, in_delisting): """Sets the in_delisting of this DeliveryContract. - Contract is delisting. # noqa: E501 + Contract is delisting # noqa: E501 :param in_delisting: The in_delisting of this DeliveryContract. # noqa: E501 :type: bool @@ -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 a75acae..1985a9b 100644 --- a/gate_api/models/delivery_settlement.py +++ b/gate_api/models/delivery_settlement.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, time=None, contract=None, leverage=None, size=None, margin=No def time(self): """Gets the time of this DeliverySettlement. # noqa: E501 - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :return: The time of this DeliverySettlement. # noqa: E501 :rtype: int @@ -108,7 +108,7 @@ def time(self): def time(self, time): """Sets the time of this DeliverySettlement. - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :param time: The time of this DeliverySettlement. # noqa: E501 :type: int @@ -120,7 +120,7 @@ def time(self, time): def contract(self): """Gets the contract of this DeliverySettlement. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this DeliverySettlement. # noqa: E501 :rtype: str @@ -131,7 +131,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this DeliverySettlement. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this DeliverySettlement. # noqa: E501 :type: str @@ -143,7 +143,7 @@ def contract(self, contract): def leverage(self): """Gets the leverage of this DeliverySettlement. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this DeliverySettlement. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this DeliverySettlement. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage of this DeliverySettlement. # noqa: E501 :type: str @@ -166,7 +166,7 @@ def leverage(self, leverage): def size(self): """Gets the size of this DeliverySettlement. # noqa: E501 - Position size. # noqa: E501 + Position size # noqa: E501 :return: The size of this DeliverySettlement. # noqa: E501 :rtype: int @@ -177,7 +177,7 @@ def size(self): def size(self, size): """Sets the size of this DeliverySettlement. - Position size. # noqa: E501 + Position size # noqa: E501 :param size: The size of this DeliverySettlement. # noqa: E501 :type: int @@ -189,7 +189,7 @@ def size(self, size): def margin(self): """Gets the margin of this DeliverySettlement. # noqa: E501 - Position margin. # noqa: E501 + Position margin # noqa: E501 :return: The margin of this DeliverySettlement. # noqa: E501 :rtype: str @@ -200,7 +200,7 @@ def margin(self): def margin(self, margin): """Sets the margin of this DeliverySettlement. - Position margin. # noqa: E501 + Position margin # noqa: E501 :param margin: The margin of this DeliverySettlement. # noqa: E501 :type: str @@ -212,7 +212,7 @@ def margin(self, margin): def entry_price(self): """Gets the entry_price of this DeliverySettlement. # noqa: E501 - Average entry price. # noqa: E501 + Average entry price # noqa: E501 :return: The entry_price of this DeliverySettlement. # noqa: E501 :rtype: str @@ -223,7 +223,7 @@ def entry_price(self): def entry_price(self, entry_price): """Sets the entry_price of this DeliverySettlement. - Average entry price. # noqa: E501 + Average entry price # noqa: E501 :param entry_price: The entry_price of this DeliverySettlement. # noqa: E501 :type: str @@ -235,7 +235,7 @@ def entry_price(self, entry_price): def settle_price(self): """Gets the settle_price of this DeliverySettlement. # noqa: E501 - Settled price. # noqa: E501 + Settled price # noqa: E501 :return: The settle_price of this DeliverySettlement. # noqa: E501 :rtype: str @@ -246,7 +246,7 @@ def settle_price(self): def settle_price(self, settle_price): """Sets the settle_price of this DeliverySettlement. - Settled price. # noqa: E501 + Settled price # noqa: E501 :param settle_price: The settle_price of this DeliverySettlement. # noqa: E501 :type: str @@ -258,7 +258,7 @@ def settle_price(self, settle_price): def profit(self): """Gets the profit of this DeliverySettlement. # noqa: E501 - Profit. # noqa: E501 + Profit # noqa: E501 :return: The profit of this DeliverySettlement. # noqa: E501 :rtype: str @@ -269,7 +269,7 @@ def profit(self): def profit(self, profit): """Sets the profit of this DeliverySettlement. - Profit. # noqa: E501 + Profit # noqa: E501 :param profit: The profit of this DeliverySettlement. # noqa: E501 :type: str @@ -281,7 +281,7 @@ def profit(self, profit): def fee(self): """Gets the fee of this DeliverySettlement. # noqa: E501 - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :return: The fee of this DeliverySettlement. # noqa: E501 :rtype: str @@ -292,7 +292,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this DeliverySettlement. - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :param fee: The fee of this DeliverySettlement. # noqa: E501 :type: str diff --git a/gate_api/models/delivery_ticker.py b/gate_api/models/delivery_ticker.py index a7692f6..9cf1203 100644 --- a/gate_api/models/delivery_ticker.py +++ b/gate_api/models/delivery_ticker.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -167,7 +167,7 @@ def __init__(self, contract=None, last=None, change_percentage=None, total_size= def contract(self): """Gets the contract of this DeliveryTicker. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this DeliveryTicker. # noqa: E501 :rtype: str @@ -178,7 +178,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this DeliveryTicker. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this DeliveryTicker. # noqa: E501 :type: str @@ -190,7 +190,7 @@ def contract(self, contract): def last(self): """Gets the last of this DeliveryTicker. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last of this DeliveryTicker. # noqa: E501 :rtype: str @@ -201,7 +201,7 @@ def last(self): def last(self, last): """Sets the last of this DeliveryTicker. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last: The last of this DeliveryTicker. # noqa: E501 :type: str @@ -213,7 +213,7 @@ def last(self, last): def change_percentage(self): """Gets the change_percentage of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -224,7 +224,7 @@ def change_percentage(self): def change_percentage(self, change_percentage): """Sets the change_percentage of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -236,7 +236,7 @@ def change_percentage(self, change_percentage): def total_size(self): """Gets the total_size of this DeliveryTicker. # noqa: E501 - Contract total size. # noqa: E501 + Contract total size # noqa: E501 :return: The total_size of this DeliveryTicker. # noqa: E501 :rtype: str @@ -247,7 +247,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this DeliveryTicker. - Contract total size. # noqa: E501 + Contract total size # noqa: E501 :param total_size: The total_size of this DeliveryTicker. # noqa: E501 :type: str @@ -259,7 +259,7 @@ def total_size(self, total_size): def low_24h(self): """Gets the low_24h of this DeliveryTicker. # noqa: E501 - Lowest trading price in recent 24h. # noqa: E501 + 24-hour lowest price # noqa: E501 :return: The low_24h of this DeliveryTicker. # noqa: E501 :rtype: str @@ -270,7 +270,7 @@ def low_24h(self): def low_24h(self, low_24h): """Sets the low_24h of this DeliveryTicker. - Lowest trading price in recent 24h. # noqa: E501 + 24-hour lowest price # noqa: E501 :param low_24h: The low_24h of this DeliveryTicker. # noqa: E501 :type: str @@ -282,7 +282,7 @@ def low_24h(self, low_24h): def high_24h(self): """Gets the high_24h of this DeliveryTicker. # noqa: E501 - Highest trading price in recent 24h. # noqa: E501 + 24-hour highest price # noqa: E501 :return: The high_24h of this DeliveryTicker. # noqa: E501 :rtype: str @@ -293,7 +293,7 @@ def high_24h(self): def high_24h(self, high_24h): """Sets the high_24h of this DeliveryTicker. - Highest trading price in recent 24h. # noqa: E501 + 24-hour highest price # noqa: E501 :param high_24h: The high_24h of this DeliveryTicker. # noqa: E501 :type: str @@ -305,7 +305,7 @@ def high_24h(self, high_24h): def volume_24h(self): """Gets the volume_24h of this DeliveryTicker. # noqa: E501 - Trade size in recent 24h. # noqa: E501 + 24-hour trading volume # noqa: E501 :return: The volume_24h of this DeliveryTicker. # noqa: E501 :rtype: str @@ -316,7 +316,7 @@ def volume_24h(self): def volume_24h(self, volume_24h): """Sets the volume_24h of this DeliveryTicker. - Trade size in recent 24h. # noqa: E501 + 24-hour trading volume # noqa: E501 :param volume_24h: The volume_24h of this DeliveryTicker. # noqa: E501 :type: str @@ -328,7 +328,7 @@ def volume_24h(self, volume_24h): def volume_24h_btc(self): """Gets the volume_24h_btc of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -339,7 +339,7 @@ def volume_24h_btc(self): def volume_24h_btc(self, volume_24h_btc): """Sets the volume_24h_btc of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -351,7 +351,7 @@ def volume_24h_btc(self, volume_24h_btc): def volume_24h_usd(self): """Gets the volume_24h_usd of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -362,7 +362,7 @@ def volume_24h_usd(self): def volume_24h_usd(self, volume_24h_usd): """Sets the volume_24h_usd of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -374,7 +374,7 @@ def volume_24h_usd(self, volume_24h_usd): def volume_24h_base(self): """Gets the volume_24h_base of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -385,7 +385,7 @@ def volume_24h_base(self): def volume_24h_base(self, volume_24h_base): """Sets the volume_24h_base of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -397,7 +397,7 @@ def volume_24h_base(self, volume_24h_base): def volume_24h_quote(self): """Gets the volume_24h_quote of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -408,7 +408,7 @@ def volume_24h_quote(self): def volume_24h_quote(self, volume_24h_quote): """Sets the volume_24h_quote of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -420,7 +420,7 @@ def volume_24h_quote(self, volume_24h_quote): def volume_24h_settle(self): """Gets the volume_24h_settle of this DeliveryTicker. # 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 DeliveryTicker. # noqa: E501 :rtype: str @@ -431,7 +431,7 @@ def volume_24h_settle(self): def volume_24h_settle(self, volume_24h_settle): """Sets the volume_24h_settle of this DeliveryTicker. - 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 DeliveryTicker. # noqa: E501 :type: str @@ -443,7 +443,7 @@ def volume_24h_settle(self, volume_24h_settle): def mark_price(self): """Gets the mark_price of this DeliveryTicker. # noqa: E501 - Recent mark price. # noqa: E501 + Recent mark price # noqa: E501 :return: The mark_price of this DeliveryTicker. # noqa: E501 :rtype: str @@ -454,7 +454,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this DeliveryTicker. - Recent mark price. # noqa: E501 + Recent mark price # noqa: E501 :param mark_price: The mark_price of this DeliveryTicker. # noqa: E501 :type: str @@ -466,7 +466,7 @@ def mark_price(self, mark_price): def funding_rate(self): """Gets the funding_rate of this DeliveryTicker. # noqa: E501 - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :return: The funding_rate of this DeliveryTicker. # noqa: E501 :rtype: str @@ -477,7 +477,7 @@ def funding_rate(self): def funding_rate(self, funding_rate): """Sets the funding_rate of this DeliveryTicker. - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :param funding_rate: The funding_rate of this DeliveryTicker. # noqa: E501 :type: str @@ -489,7 +489,7 @@ def funding_rate(self, funding_rate): 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 + Indicative Funding rate in next period. (deprecated. use `funding_rate`) # noqa: E501 :return: The funding_rate_indicative of this DeliveryTicker. # noqa: E501 :rtype: str @@ -500,7 +500,7 @@ def funding_rate_indicative(self): 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 + 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 @@ -512,7 +512,7 @@ def funding_rate_indicative(self, funding_rate_indicative): def index_price(self): """Gets the index_price of this DeliveryTicker. # noqa: E501 - Index price. # noqa: E501 + Index price # noqa: E501 :return: The index_price of this DeliveryTicker. # noqa: E501 :rtype: str @@ -523,7 +523,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this DeliveryTicker. - Index price. # noqa: E501 + Index price # noqa: E501 :param index_price: The index_price of this DeliveryTicker. # noqa: E501 :type: str @@ -558,7 +558,7 @@ def quanto_base_rate(self, quanto_base_rate): def basis_rate(self): """Gets the basis_rate of this DeliveryTicker. # noqa: E501 - Basis rate. # noqa: E501 + Basis rate # noqa: E501 :return: The basis_rate of this DeliveryTicker. # noqa: E501 :rtype: str @@ -569,7 +569,7 @@ def basis_rate(self): def basis_rate(self, basis_rate): """Sets the basis_rate of this DeliveryTicker. - Basis rate. # noqa: E501 + Basis rate # noqa: E501 :param basis_rate: The basis_rate of this DeliveryTicker. # noqa: E501 :type: str @@ -581,7 +581,7 @@ def basis_rate(self, basis_rate): def basis_value(self): """Gets the basis_value of this DeliveryTicker. # noqa: E501 - Basis value. # noqa: E501 + Basis value # noqa: E501 :return: The basis_value of this DeliveryTicker. # noqa: E501 :rtype: str @@ -592,7 +592,7 @@ def basis_value(self): def basis_value(self, basis_value): """Sets the basis_value of this DeliveryTicker. - Basis value. # noqa: E501 + Basis value # noqa: E501 :param basis_value: The basis_value of this DeliveryTicker. # noqa: E501 :type: str @@ -604,7 +604,7 @@ def basis_value(self, basis_value): def lowest_ask(self): """Gets the lowest_ask of this DeliveryTicker. # noqa: E501 - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :return: The lowest_ask of this DeliveryTicker. # noqa: E501 :rtype: str @@ -615,7 +615,7 @@ def lowest_ask(self): def lowest_ask(self, lowest_ask): """Sets the lowest_ask of this DeliveryTicker. - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :param lowest_ask: The lowest_ask of this DeliveryTicker. # noqa: E501 :type: str @@ -627,7 +627,7 @@ def lowest_ask(self, lowest_ask): def lowest_size(self): """Gets the lowest_size of this DeliveryTicker. # noqa: E501 - The latest seller's lowest price order quantity. # noqa: E501 + The latest seller's lowest price order quantity # noqa: E501 :return: The lowest_size of this DeliveryTicker. # noqa: E501 :rtype: str @@ -638,7 +638,7 @@ def lowest_size(self): def lowest_size(self, lowest_size): """Sets the lowest_size of this DeliveryTicker. - The latest seller's lowest price order quantity. # noqa: E501 + The latest seller's lowest price order quantity # noqa: E501 :param lowest_size: The lowest_size of this DeliveryTicker. # noqa: E501 :type: str @@ -650,7 +650,7 @@ def lowest_size(self, lowest_size): def highest_bid(self): """Gets the highest_bid of this DeliveryTicker. # noqa: E501 - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :return: The highest_bid of this DeliveryTicker. # noqa: E501 :rtype: str @@ -661,7 +661,7 @@ def highest_bid(self): def highest_bid(self, highest_bid): """Sets the highest_bid of this DeliveryTicker. - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :param highest_bid: The highest_bid of this DeliveryTicker. # noqa: E501 :type: str @@ -673,7 +673,7 @@ def highest_bid(self, highest_bid): def highest_size(self): """Gets the highest_size of this DeliveryTicker. # noqa: E501 - The latest buyer's highest price order volume. # noqa: E501 + The latest buyer's highest price order volume # noqa: E501 :return: The highest_size of this DeliveryTicker. # noqa: E501 :rtype: str @@ -684,7 +684,7 @@ def highest_size(self): def highest_size(self, highest_size): """Sets the highest_size of this DeliveryTicker. - The latest buyer's highest price order volume. # noqa: E501 + The latest buyer's highest price order volume # noqa: E501 :param highest_size: The highest_size of this DeliveryTicker. # noqa: E501 :type: str diff --git a/gate_api/models/deposit_address.py b/gate_api/models/deposit_address.py index e957503..01a55df 100644 --- a/gate_api/models/deposit_address.py +++ b/gate_api/models/deposit_address.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -65,7 +65,7 @@ def __init__(self, currency=None, address=None, multichain_addresses=None, local def currency(self): """Gets the currency of this DepositAddress. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this DepositAddress. # noqa: E501 :rtype: str @@ -76,7 +76,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this DepositAddress. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this DepositAddress. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency(self, currency): def address(self): """Gets the address of this DepositAddress. # noqa: E501 - Deposit address. # noqa: E501 + Deposit address # noqa: E501 :return: The address of this DepositAddress. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def address(self): def address(self, address): """Sets the address of this DepositAddress. - Deposit address. # noqa: E501 + Deposit address # noqa: E501 :param address: The address of this DepositAddress. # noqa: E501 :type: str diff --git a/gate_api/models/deposit_record.py b/gate_api/models/deposit_record.py index 814e143..509aa32 100644 --- a/gate_api/models/deposit_record.py +++ b/gate_api/models/deposit_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -99,7 +99,7 @@ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, a def id(self): """Gets the id of this DepositRecord. # noqa: E501 - Record ID. # noqa: E501 + Record ID # noqa: E501 :return: The id of this DepositRecord. # noqa: E501 :rtype: str @@ -110,7 +110,7 @@ def id(self): def id(self, id): """Sets the id of this DepositRecord. - Record ID. # noqa: E501 + Record ID # noqa: E501 :param id: The id of this DepositRecord. # noqa: E501 :type: str @@ -122,7 +122,7 @@ def id(self, id): def txid(self): """Gets the txid of this DepositRecord. # noqa: E501 - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :return: The txid of this DepositRecord. # noqa: E501 :rtype: str @@ -133,7 +133,7 @@ def txid(self): def txid(self, txid): """Sets the txid of this DepositRecord. - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :param txid: The txid of this DepositRecord. # noqa: E501 :type: str @@ -168,7 +168,7 @@ def withdraw_order_id(self, withdraw_order_id): def timestamp(self): """Gets the timestamp of this DepositRecord. # noqa: E501 - Operation time. # noqa: E501 + Operation time # noqa: E501 :return: The timestamp of this DepositRecord. # noqa: E501 :rtype: str @@ -179,7 +179,7 @@ def timestamp(self): def timestamp(self, timestamp): """Sets the timestamp of this DepositRecord. - Operation time. # noqa: E501 + Operation time # noqa: E501 :param timestamp: The timestamp of this DepositRecord. # noqa: E501 :type: str @@ -191,7 +191,7 @@ def timestamp(self, timestamp): def amount(self): """Gets the amount of this DepositRecord. # noqa: E501 - Currency amount. # noqa: E501 + Token amount # noqa: E501 :return: The amount of this DepositRecord. # noqa: E501 :rtype: str @@ -202,7 +202,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this DepositRecord. - Currency amount. # noqa: E501 + Token amount # noqa: E501 :param amount: The amount of this DepositRecord. # noqa: E501 :type: str @@ -216,7 +216,7 @@ def amount(self, amount): def currency(self): """Gets the currency of this DepositRecord. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this DepositRecord. # noqa: E501 :rtype: str @@ -227,7 +227,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this DepositRecord. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this DepositRecord. # noqa: E501 :type: str @@ -241,7 +241,7 @@ def currency(self, currency): def address(self): """Gets the address of this DepositRecord. # noqa: E501 - Withdrawal address. Required for withdrawals. # noqa: E501 + Withdrawal address. Required for withdrawals # noqa: E501 :return: The address of this DepositRecord. # noqa: E501 :rtype: str @@ -252,7 +252,7 @@ def address(self): def address(self, address): """Sets the address of this DepositRecord. - Withdrawal address. Required for withdrawals. # noqa: E501 + Withdrawal address. Required for withdrawals # noqa: E501 :param address: The address of this DepositRecord. # noqa: E501 :type: str @@ -264,7 +264,7 @@ def address(self, address): def memo(self): """Gets the memo of this DepositRecord. # noqa: E501 - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :return: The memo of this DepositRecord. # noqa: E501 :rtype: str @@ -275,7 +275,7 @@ def memo(self): def memo(self, memo): """Sets the memo of this DepositRecord. - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :param memo: The memo of this DepositRecord. # noqa: E501 :type: str @@ -310,7 +310,7 @@ def status(self, status): def chain(self): """Gets the chain of this DepositRecord. # noqa: E501 - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :return: The chain of this DepositRecord. # noqa: E501 :rtype: str @@ -321,7 +321,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this DepositRecord. - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :param chain: The chain of this DepositRecord. # noqa: E501 :type: str diff --git a/gate_api/models/dual_get_orders.py b/gate_api/models/dual_get_orders.py index 40312d5..3734353 100644 --- a/gate_api/models/dual_get_orders.py +++ b/gate_api/models/dual_get_orders.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -137,7 +137,7 @@ def __init__(self, id=None, plan_id=None, copies=None, invest_amount=None, settl def id(self): """Gets the id of this DualGetOrders. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this DualGetOrders. # noqa: E501 :rtype: int @@ -148,7 +148,7 @@ def id(self): def id(self, id): """Sets the id of this DualGetOrders. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this DualGetOrders. # noqa: E501 :type: int @@ -160,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 @@ -171,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 @@ -183,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 @@ -194,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 @@ -206,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 @@ -217,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 @@ -229,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 @@ -240,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 @@ -252,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 @@ -263,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 @@ -275,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 @@ -286,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 @@ -298,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 @@ -309,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 @@ -321,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 @@ -332,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 @@ -344,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 @@ -355,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 @@ -367,7 +367,7 @@ def exercise_currency(self, exercise_currency): def exercise_price(self): """Gets the exercise_price of this DualGetOrders. # noqa: E501 - Strike price. # noqa: E501 + Strike price # noqa: E501 :return: The exercise_price of this DualGetOrders. # noqa: E501 :rtype: str @@ -378,7 +378,7 @@ def exercise_price(self): def exercise_price(self, exercise_price): """Sets the exercise_price of this DualGetOrders. - Strike price. # noqa: E501 + Strike price # noqa: E501 :param exercise_price: The exercise_price of this DualGetOrders. # noqa: E501 :type: str @@ -390,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 @@ -401,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 @@ -413,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 @@ -424,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 @@ -436,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 @@ -447,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 @@ -459,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 @@ -470,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 @@ -482,7 +482,7 @@ def apy_settlement(self, apy_settlement): def delivery_time(self): """Gets the delivery_time of this DualGetOrders. # noqa: E501 - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :return: The delivery_time of this DualGetOrders. # noqa: E501 :rtype: int @@ -493,7 +493,7 @@ def delivery_time(self): def delivery_time(self, delivery_time): """Sets the delivery_time of this DualGetOrders. - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :param delivery_time: The delivery_time of this DualGetOrders. # noqa: E501 :type: int @@ -505,7 +505,7 @@ def delivery_time(self, delivery_time): def text(self): """Gets the text of this DualGetOrders. # noqa: E501 - Custom order information. # noqa: E501 + Custom order information # noqa: E501 :return: The text of this DualGetOrders. # noqa: E501 :rtype: str @@ -516,7 +516,7 @@ def text(self): def text(self, text): """Sets the text of this DualGetOrders. - Custom order information. # noqa: E501 + Custom order information # noqa: E501 :param text: The text of this DualGetOrders. # noqa: E501 :type: str diff --git a/gate_api/models/dual_get_plans.py b/gate_api/models/dual_get_plans.py index f3ad42b..90808a3 100644 --- a/gate_api/models/dual_get_plans.py +++ b/gate_api/models/dual_get_plans.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -209,7 +209,7 @@ def exercise_currency(self, exercise_currency): def exercise_price(self): """Gets the exercise_price of this DualGetPlans. # noqa: E501 - Strike price. # noqa: E501 + Strike price # noqa: E501 :return: The exercise_price of this DualGetPlans. # noqa: E501 :rtype: float @@ -220,7 +220,7 @@ def exercise_price(self): def exercise_price(self, exercise_price): """Sets the exercise_price of this DualGetPlans. - Strike price. # noqa: E501 + Strike price # noqa: E501 :param exercise_price: The exercise_price of this DualGetPlans. # noqa: E501 :type: float @@ -232,7 +232,7 @@ def exercise_price(self, exercise_price): def delivery_time(self): """Gets the delivery_time of this DualGetPlans. # noqa: E501 - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :return: The delivery_time of this DualGetPlans. # noqa: E501 :rtype: int @@ -243,7 +243,7 @@ def delivery_time(self): def delivery_time(self, delivery_time): """Sets the delivery_time of this DualGetPlans. - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :param delivery_time: The delivery_time of this DualGetPlans. # noqa: E501 :type: int @@ -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/eth2_rate_list.py b/gate_api/models/eth2_rate_list.py index c3d3237..c714e00 100644 --- a/gate_api/models/eth2_rate_list.py +++ b/gate_api/models/eth2_rate_list.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, date_time=None, date=None, rate=None, local_vars_configuratio def date_time(self): """Gets the date_time of this Eth2RateList. # noqa: E501 - Date and Time Stamp. # noqa: E501 + Date Timestamp # noqa: E501 :return: The date_time of this Eth2RateList. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def date_time(self): def date_time(self, date_time): """Sets the date_time of this Eth2RateList. - Date and Time Stamp. # noqa: E501 + Date Timestamp # noqa: E501 :param date_time: The date_time of this Eth2RateList. # noqa: E501 :type: int @@ -90,7 +90,7 @@ def date_time(self, date_time): def date(self): """Gets the date of this Eth2RateList. # noqa: E501 - Date. # noqa: E501 + Date # noqa: E501 :return: The date of this Eth2RateList. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def date(self): def date(self, date): """Sets the date of this Eth2RateList. - Date. # noqa: E501 + Date # noqa: E501 :param date: The date of this Eth2RateList. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def date(self, date): def rate(self): """Gets the rate of this Eth2RateList. # noqa: E501 - percentage. # noqa: E501 + Percentage Rate # noqa: E501 :return: The rate of this Eth2RateList. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def rate(self): def rate(self, rate): """Sets the rate of this Eth2RateList. - percentage. # noqa: E501 + Percentage Rate # noqa: E501 :param rate: The rate of this Eth2RateList. # noqa: E501 :type: str diff --git a/gate_api/models/eth2_swap.py b/gate_api/models/eth2_swap.py index d2b6ddf..ac51063 100644 --- a/gate_api/models/eth2_swap.py +++ b/gate_api/models/eth2_swap.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 index 4662668..a73037a 100644 --- a/gate_api/models/find_coin.py +++ b/gate_api/models/find_coin.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -33,59 +33,31 @@ class FindCoin(object): and the value is json key in definition. """ openapi_types = { - 'coin': 'str', 'cointype': 'str' } attribute_map = { - 'coin': 'coin', 'cointype': 'cointype' } - def __init__(self, coin=None, cointype=None, local_vars_configuration=None): # noqa: E501 - # type: (str, str, Configuration) -> None + 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._coin = None self._cointype = None self.discriminator = None - if coin is not None: - self.coin = coin if cointype is not None: self.cointype = cointype - @property - def coin(self): - """Gets the coin of this FindCoin. # noqa: E501 - - Currency. # noqa: E501 - - :return: The coin of this FindCoin. # noqa: E501 - :rtype: str - """ - return self._coin - - @coin.setter - def coin(self, coin): - """Sets the coin of this FindCoin. - - Currency. # noqa: E501 - - :param coin: The coin of this FindCoin. # noqa: E501 - :type: str - """ - - self._coin = coin - @property def cointype(self): """Gets the cointype of this FindCoin. # noqa: E501 - Coin Type swap-Voucher lock-Locked. # 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 @@ -96,7 +68,7 @@ def cointype(self): def cointype(self, cointype): """Sets the cointype of this FindCoin. - Coin Type swap-Voucher lock-Locked. # noqa: E501 + Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. # noqa: E501 :param cointype: The cointype of this FindCoin. # noqa: E501 :type: str diff --git a/gate_api/models/flash_swap_currency_pair.py b/gate_api/models/flash_swap_currency_pair.py index f2e2432..5a9ed86 100644 --- a/gate_api/models/flash_swap_currency_pair.py +++ b/gate_api/models/flash_swap_currency_pair.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 a715330..2be7592 100644 --- a/gate_api/models/flash_swap_order.py +++ b/gate_api/models/flash_swap_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, id=None, create_time=None, user_id=None, sell_currency=None, def id(self): """Gets the id of this FlashSwapOrder. # noqa: E501 - Flash swap order ID. # noqa: E501 + Flash swap order ID # noqa: E501 :return: The id of this FlashSwapOrder. # noqa: E501 :rtype: int @@ -108,7 +108,7 @@ def id(self): def id(self, id): """Sets the id of this FlashSwapOrder. - Flash swap order ID. # noqa: E501 + Flash swap order ID # noqa: E501 :param id: The id of this FlashSwapOrder. # noqa: E501 :type: int @@ -120,7 +120,7 @@ def id(self, id): def create_time(self): """Gets the create_time of this FlashSwapOrder. # noqa: E501 - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :return: The create_time of this FlashSwapOrder. # noqa: E501 :rtype: int @@ -131,7 +131,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this FlashSwapOrder. - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :param create_time: The create_time of this FlashSwapOrder. # noqa: E501 :type: int @@ -143,7 +143,7 @@ def create_time(self, create_time): def user_id(self): """Gets the user_id of this FlashSwapOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this FlashSwapOrder. # noqa: E501 :rtype: int @@ -154,7 +154,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this FlashSwapOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this FlashSwapOrder. # noqa: E501 :type: int @@ -166,7 +166,7 @@ def user_id(self, user_id): def sell_currency(self): """Gets the sell_currency of this FlashSwapOrder. # noqa: E501 - Currency to sell. # noqa: E501 + Currency to sell # noqa: E501 :return: The sell_currency of this FlashSwapOrder. # noqa: E501 :rtype: str @@ -177,7 +177,7 @@ def sell_currency(self): def sell_currency(self, sell_currency): """Sets the sell_currency of this FlashSwapOrder. - Currency to sell. # noqa: E501 + Currency to sell # noqa: E501 :param sell_currency: The sell_currency of this FlashSwapOrder. # noqa: E501 :type: str @@ -189,7 +189,7 @@ def sell_currency(self, sell_currency): def sell_amount(self): """Gets the sell_amount of this FlashSwapOrder. # noqa: E501 - Amount to sell. # noqa: E501 + Amount to sell # noqa: E501 :return: The sell_amount of this FlashSwapOrder. # noqa: E501 :rtype: str @@ -200,7 +200,7 @@ def sell_amount(self): def sell_amount(self, sell_amount): """Sets the sell_amount of this FlashSwapOrder. - Amount to sell. # noqa: E501 + Amount to sell # noqa: E501 :param sell_amount: The sell_amount of this FlashSwapOrder. # noqa: E501 :type: str @@ -212,7 +212,7 @@ def sell_amount(self, sell_amount): def buy_currency(self): """Gets the buy_currency of this FlashSwapOrder. # noqa: E501 - Currency to buy. # noqa: E501 + Currency to buy # noqa: E501 :return: The buy_currency of this FlashSwapOrder. # noqa: E501 :rtype: str @@ -223,7 +223,7 @@ def buy_currency(self): def buy_currency(self, buy_currency): """Sets the buy_currency of this FlashSwapOrder. - Currency to buy. # noqa: E501 + Currency to buy # noqa: E501 :param buy_currency: The buy_currency of this FlashSwapOrder. # noqa: E501 :type: str @@ -235,7 +235,7 @@ def buy_currency(self, buy_currency): def buy_amount(self): """Gets the buy_amount of this FlashSwapOrder. # noqa: E501 - Amount to buy. # noqa: E501 + Amount to buy # noqa: E501 :return: The buy_amount of this FlashSwapOrder. # noqa: E501 :rtype: str @@ -246,7 +246,7 @@ def buy_amount(self): def buy_amount(self, buy_amount): """Sets the buy_amount of this FlashSwapOrder. - Amount to buy. # noqa: E501 + Amount to buy # noqa: E501 :param buy_amount: The buy_amount of this FlashSwapOrder. # noqa: E501 :type: str @@ -258,7 +258,7 @@ def buy_amount(self, buy_amount): def price(self): """Gets the price of this FlashSwapOrder. # noqa: E501 - Price. # noqa: E501 + Price # noqa: E501 :return: The price of this FlashSwapOrder. # noqa: E501 :rtype: str @@ -269,7 +269,7 @@ def price(self): def price(self, price): """Sets the price of this FlashSwapOrder. - Price. # noqa: E501 + Price # noqa: E501 :param price: The price of this FlashSwapOrder. # noqa: E501 :type: str diff --git a/gate_api/models/flash_swap_order_preview.py b/gate_api/models/flash_swap_order_preview.py index ca4413a..d137d5a 100644 --- a/gate_api/models/flash_swap_order_preview.py +++ b/gate_api/models/flash_swap_order_preview.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, preview_id=None, sell_currency=None, sell_amount=None, buy_cu def preview_id(self): """Gets the preview_id of this FlashSwapOrderPreview. # noqa: E501 - Preview result ID. # noqa: E501 + Preview result ID # noqa: E501 :return: The preview_id of this FlashSwapOrderPreview. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def preview_id(self): def preview_id(self, preview_id): """Sets the preview_id of this FlashSwapOrderPreview. - Preview result ID. # noqa: E501 + Preview result ID # noqa: E501 :param preview_id: The preview_id of this FlashSwapOrderPreview. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def sell_currency(self, sell_currency): def sell_amount(self): """Gets the sell_amount of this FlashSwapOrderPreview. # noqa: E501 - Amount to sell. # noqa: E501 + Amount to sell # noqa: E501 :return: The sell_amount of this FlashSwapOrderPreview. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def sell_amount(self): def sell_amount(self, sell_amount): """Sets the sell_amount of this FlashSwapOrderPreview. - Amount to sell. # noqa: E501 + Amount to sell # noqa: E501 :param sell_amount: The sell_amount of this FlashSwapOrderPreview. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def buy_currency(self, buy_currency): def buy_amount(self): """Gets the buy_amount of this FlashSwapOrderPreview. # noqa: E501 - Amount to buy. # noqa: E501 + Amount to buy # noqa: E501 :return: The buy_amount of this FlashSwapOrderPreview. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def buy_amount(self): def buy_amount(self, buy_amount): """Sets the buy_amount of this FlashSwapOrderPreview. - Amount to buy. # noqa: E501 + Amount to buy # noqa: E501 :param buy_amount: The buy_amount of this FlashSwapOrderPreview. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def buy_amount(self, buy_amount): def price(self): """Gets the price of this FlashSwapOrderPreview. # noqa: E501 - Price. # noqa: E501 + Price # noqa: E501 :return: The price of this FlashSwapOrderPreview. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def price(self): def price(self, price): """Sets the price of this FlashSwapOrderPreview. - Price. # noqa: E501 + Price # noqa: E501 :param price: The price 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 5cc1661..d89b46b 100644 --- a/gate_api/models/flash_swap_order_request.py +++ b/gate_api/models/flash_swap_order_request.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, preview_id=None, sell_currency=None, sell_amount=None, buy_cu def preview_id(self): """Gets the preview_id of this FlashSwapOrderRequest. # noqa: E501 - Preview result ID. # noqa: E501 + Preview result ID # noqa: E501 :return: The preview_id of this FlashSwapOrderRequest. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def preview_id(self): def preview_id(self, preview_id): """Sets the preview_id of this FlashSwapOrderRequest. - Preview result ID. # noqa: E501 + Preview result ID # noqa: E501 :param preview_id: The preview_id of this FlashSwapOrderRequest. # noqa: E501 :type: str @@ -122,7 +122,7 @@ def sell_currency(self, sell_currency): def sell_amount(self): """Gets the sell_amount of this FlashSwapOrderRequest. # noqa: E501 - Amount to sell (based on the preview result). # noqa: E501 + Amount to sell (based on the preview result) # noqa: E501 :return: The sell_amount of this FlashSwapOrderRequest. # noqa: E501 :rtype: str @@ -133,7 +133,7 @@ def sell_amount(self): def sell_amount(self, sell_amount): """Sets the sell_amount of this FlashSwapOrderRequest. - Amount to sell (based on the preview result). # noqa: E501 + Amount to sell (based on the preview result) # noqa: E501 :param sell_amount: The sell_amount of this FlashSwapOrderRequest. # noqa: E501 :type: str @@ -172,7 +172,7 @@ def buy_currency(self, buy_currency): def buy_amount(self): """Gets the buy_amount of this FlashSwapOrderRequest. # noqa: E501 - Amount to buy (based on the preview result). # noqa: E501 + Amount to buy (based on the preview result) # noqa: E501 :return: The buy_amount of this FlashSwapOrderRequest. # noqa: E501 :rtype: str @@ -183,7 +183,7 @@ def buy_amount(self): def buy_amount(self, buy_amount): """Sets the buy_amount of this FlashSwapOrderRequest. - Amount to buy (based on the preview result). # noqa: E501 + Amount to buy (based on the preview result) # noqa: E501 :param buy_amount: The buy_amount 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 e04087b..3cfe1d1 100644 --- a/gate_api/models/flash_swap_preview_request.py +++ b/gate_api/models/flash_swap_preview_request.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 6b5016d..9ba5a0f 100644 --- a/gate_api/models/funding_account.py +++ b/gate_api/models/funding_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, currency=None, available=None, locked=None, lent=None, total_ def currency(self): """Gets the currency of this FundingAccount. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this FundingAccount. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this FundingAccount. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this FundingAccount. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def currency(self, currency): def available(self): """Gets the available of this FundingAccount. # noqa: E501 - Available assets to lend, which is identical to spot account `available`. # noqa: E501 + Available assets to lend, which is identical to spot account `available` # noqa: E501 :return: The available of this FundingAccount. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def available(self): def available(self, available): """Sets the available of this FundingAccount. - Available assets to lend, which is identical to spot account `available`. # noqa: E501 + Available assets to lend, which is identical to spot account `available` # noqa: E501 :param available: The available of this FundingAccount. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def available(self, available): def locked(self): """Gets the locked of this FundingAccount. # noqa: E501 - Locked amount. i.e. amount in `open` loans. # noqa: E501 + Locked amount. i.e. amount in `open` loans # noqa: E501 :return: The locked of this FundingAccount. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def locked(self): def locked(self, locked): """Sets the locked of this FundingAccount. - Locked amount. i.e. amount in `open` loans. # noqa: E501 + Locked amount. i.e. amount in `open` loans # noqa: E501 :param locked: The locked of this FundingAccount. # noqa: E501 :type: str @@ -146,7 +146,7 @@ def locked(self, locked): def lent(self): """Gets the lent of this FundingAccount. # noqa: E501 - Outstanding loan amount yet to be repaid. # noqa: E501 + Outstanding loan amount yet to be repaid # noqa: E501 :return: The lent of this FundingAccount. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def lent(self): def lent(self, lent): """Sets the lent of this FundingAccount. - Outstanding loan amount yet to be repaid. # noqa: E501 + Outstanding loan amount yet to be repaid # noqa: E501 :param lent: The lent of this FundingAccount. # noqa: E501 :type: str @@ -169,7 +169,7 @@ def lent(self, lent): def total_lent(self): """Gets the total_lent of this FundingAccount. # noqa: E501 - Amount used for lending. total_lent = lent + locked. # noqa: E501 + Amount used for lending. total_lent = lent + locked # noqa: E501 :return: The total_lent of this FundingAccount. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def total_lent(self): def total_lent(self, total_lent): """Sets the total_lent of this FundingAccount. - Amount used for lending. total_lent = lent + locked. # noqa: E501 + Amount used for lending. total_lent = lent + locked # noqa: E501 :param total_lent: The total_lent of this FundingAccount. # noqa: E501 :type: str diff --git a/gate_api/models/funding_rate_record.py b/gate_api/models/funding_rate_record.py index d3ea258..cf06b1c 100644 --- a/gate_api/models/funding_rate_record.py +++ b/gate_api/models/funding_rate_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, t=None, r=None, local_vars_configuration=None): # noqa: E501 def t(self): """Gets the t of this FundingRateRecord. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this FundingRateRecord. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def t(self): def t(self, t): """Sets the t of this FundingRateRecord. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this FundingRateRecord. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def t(self, t): def r(self): """Gets the r of this FundingRateRecord. # noqa: E501 - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :return: The r of this FundingRateRecord. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def r(self): def r(self, r): """Sets the r of this FundingRateRecord. - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :param r: The r of this FundingRateRecord. # noqa: E501 :type: str diff --git a/gate_api/models/future_cancel_order_result.py b/gate_api/models/future_cancel_order_result.py index 1886a56..7f7ccd4 100644 --- a/gate_api/models/future_cancel_order_result.py +++ b/gate_api/models/future_cancel_order_result.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, id=None, user_id=None, succeeded=None, message=None, local_va def id(self): """Gets the id of this FutureCancelOrderResult. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this FutureCancelOrderResult. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def id(self): def id(self, id): """Sets the id of this FutureCancelOrderResult. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this FutureCancelOrderResult. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def id(self, id): def user_id(self): """Gets the user_id of this FutureCancelOrderResult. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this FutureCancelOrderResult. # noqa: E501 :rtype: int @@ -106,7 +106,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this FutureCancelOrderResult. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this FutureCancelOrderResult. # noqa: E501 :type: int @@ -118,7 +118,7 @@ def user_id(self, user_id): def succeeded(self): """Gets the succeeded of this FutureCancelOrderResult. # noqa: E501 - Whether cancellation succeeded. # noqa: E501 + Whether cancellation succeeded # noqa: E501 :return: The succeeded of this FutureCancelOrderResult. # noqa: E501 :rtype: bool @@ -129,7 +129,7 @@ def succeeded(self): def succeeded(self, succeeded): """Sets the succeeded of this FutureCancelOrderResult. - Whether cancellation succeeded. # noqa: E501 + Whether cancellation succeeded # noqa: E501 :param succeeded: The succeeded of this FutureCancelOrderResult. # noqa: E501 :type: bool @@ -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 029d544..6855e9f 100644 --- a/gate_api/models/futures_account.py +++ b/gate_api/models/futures_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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', @@ -70,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', @@ -90,8 +92,8 @@ class FuturesAccount(object): '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, 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, bool, str, str, str, bool, str, str, str, str, str, str, str, str, str, bool, int, bool, 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() @@ -105,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 @@ -141,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: @@ -205,7 +210,7 @@ def total(self, total): def unrealised_pnl(self): """Gets the unrealised_pnl of this FuturesAccount. # noqa: E501 - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :return: The unrealised_pnl of this FuturesAccount. # noqa: E501 :rtype: str @@ -216,7 +221,7 @@ def unrealised_pnl(self): def unrealised_pnl(self, unrealised_pnl): """Sets the unrealised_pnl of this FuturesAccount. - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :param unrealised_pnl: The unrealised_pnl of this FuturesAccount. # noqa: E501 :type: str @@ -228,7 +233,7 @@ def unrealised_pnl(self, unrealised_pnl): def position_margin(self): """Gets the position_margin of this FuturesAccount. # noqa: E501 - Position margin. # noqa: E501 + Position margin # noqa: E501 :return: The position_margin of this FuturesAccount. # noqa: E501 :rtype: str @@ -239,7 +244,7 @@ def position_margin(self): def position_margin(self, position_margin): """Sets the position_margin of this FuturesAccount. - Position margin. # noqa: E501 + Position margin # noqa: E501 :param position_margin: The position_margin of this FuturesAccount. # noqa: E501 :type: str @@ -251,7 +256,7 @@ def position_margin(self, position_margin): def order_margin(self): """Gets the order_margin of this FuturesAccount. # noqa: E501 - Order margin of unfinished orders. # noqa: E501 + Order margin of unfinished orders # noqa: E501 :return: The order_margin of this FuturesAccount. # noqa: E501 :rtype: str @@ -262,7 +267,7 @@ def order_margin(self): def order_margin(self, order_margin): """Sets the order_margin of this FuturesAccount. - Order margin of unfinished orders. # noqa: E501 + Order margin of unfinished orders # noqa: E501 :param order_margin: The order_margin of this FuturesAccount. # noqa: E501 :type: str @@ -274,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 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 @@ -285,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 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 @@ -297,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 @@ -308,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 @@ -320,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 @@ -331,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 @@ -343,7 +348,7 @@ def currency(self, currency): def in_dual_mode(self): """Gets the in_dual_mode of this FuturesAccount. # noqa: E501 - Whether dual mode is enabled. # noqa: E501 + Whether dual mode is enabled # noqa: E501 :return: The in_dual_mode of this FuturesAccount. # noqa: E501 :rtype: bool @@ -354,7 +359,7 @@ def in_dual_mode(self): def in_dual_mode(self, in_dual_mode): """Sets the in_dual_mode of this FuturesAccount. - Whether dual mode is enabled. # noqa: E501 + Whether dual mode is enabled # noqa: E501 :param in_dual_mode: The in_dual_mode of this FuturesAccount. # noqa: E501 :type: bool @@ -362,11 +367,34 @@ 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 - Whether portfolio margin account mode is enabled. # noqa: E501 + Whether portfolio margin account mode is enabled # noqa: E501 :return: The enable_credit of this FuturesAccount. # noqa: E501 :rtype: bool @@ -377,7 +405,7 @@ def enable_credit(self): def enable_credit(self, enable_credit): """Sets the enable_credit of this FuturesAccount. - Whether portfolio margin account mode is enabled. # noqa: E501 + Whether portfolio margin account mode is enabled # noqa: E501 :param enable_credit: The enable_credit of this FuturesAccount. # noqa: E501 :type: bool @@ -389,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 @@ -400,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 @@ -412,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 @@ -423,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 @@ -435,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 @@ -446,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 @@ -458,7 +486,7 @@ def bonus(self, bonus): def enable_evolved_classic(self): """Gets the enable_evolved_classic of this FuturesAccount. # noqa: E501 - Classic account margin mode, true-new mode, false-old mode. # noqa: E501 + Classic account margin mode, true-new mode, false-old mode # noqa: E501 :return: The enable_evolved_classic of this FuturesAccount. # noqa: E501 :rtype: bool @@ -469,7 +497,7 @@ def enable_evolved_classic(self): def enable_evolved_classic(self, enable_evolved_classic): """Sets the enable_evolved_classic of this FuturesAccount. - Classic account margin mode, true-new mode, false-old mode. # noqa: E501 + Classic account margin mode, true-new mode, false-old mode # noqa: E501 :param enable_evolved_classic: The enable_evolved_classic of this FuturesAccount. # noqa: E501 :type: bool @@ -481,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 @@ -492,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 @@ -504,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 @@ -515,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 @@ -527,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 @@ -538,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 @@ -550,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 @@ -561,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 @@ -573,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 @@ -584,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 @@ -596,7 +624,7 @@ def cross_available(self, cross_available): def cross_margin_balance(self): """Gets the cross_margin_balance of this FuturesAccount. # noqa: E501 - Full margin balance, suitable for the new classic account margin model. # 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 @@ -607,7 +635,7 @@ def cross_margin_balance(self): def cross_margin_balance(self, cross_margin_balance): """Sets the cross_margin_balance of this FuturesAccount. - Full margin balance, suitable for the new classic account margin model. # noqa: E501 + 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 @@ -619,7 +647,7 @@ def cross_margin_balance(self, cross_margin_balance): def cross_mmr(self): """Gets the cross_mmr of this FuturesAccount. # noqa: E501 - Maintain margin ratio for the full position, suitable for the new classic account margin model # 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 @@ -630,7 +658,7 @@ def cross_mmr(self): def cross_mmr(self, cross_mmr): """Sets the cross_mmr of this FuturesAccount. - Maintain margin ratio for the full position, suitable for the new classic account margin model # noqa: E501 + 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 @@ -642,7 +670,7 @@ def cross_mmr(self, cross_mmr): def cross_imr(self): """Gets the cross_imr of this FuturesAccount. # noqa: E501 - The initial margin rate of the full position is suitable for the new classic account margin model # 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 @@ -653,7 +681,7 @@ def cross_imr(self): def cross_imr(self, cross_imr): """Sets the cross_imr of this FuturesAccount. - The initial margin rate of the full position is suitable for the new classic account margin model # noqa: E501 + 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 @@ -665,7 +693,7 @@ def cross_imr(self, cross_imr): 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 @@ -676,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 @@ -688,7 +716,7 @@ def isolated_position_margin(self, isolated_position_margin): def enable_new_dual_mode(self): """Gets the enable_new_dual_mode of this FuturesAccount. # noqa: E501 - Whether to open a new two-way position mode. # noqa: E501 + Whether to open a new two-way position mode # noqa: E501 :return: The enable_new_dual_mode of this FuturesAccount. # noqa: E501 :rtype: bool @@ -699,7 +727,7 @@ def enable_new_dual_mode(self): def enable_new_dual_mode(self, enable_new_dual_mode): """Sets the enable_new_dual_mode of this FuturesAccount. - Whether to open a new two-way position mode. # noqa: E501 + Whether to open a new two-way position mode # noqa: E501 :param enable_new_dual_mode: The enable_new_dual_mode of this FuturesAccount. # noqa: E501 :type: bool @@ -734,7 +762,7 @@ def margin_mode(self, margin_mode): def enable_tiered_mm(self): """Gets the enable_tiered_mm of this FuturesAccount. # noqa: E501 - Whether to enable tiered maintenance margin calculation. # noqa: E501 + Whether to enable tiered maintenance margin calculation # noqa: E501 :return: The enable_tiered_mm of this FuturesAccount. # noqa: E501 :rtype: bool @@ -745,7 +773,7 @@ def enable_tiered_mm(self): 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 + Whether to enable tiered maintenance margin calculation # noqa: E501 :param enable_tiered_mm: The enable_tiered_mm of this FuturesAccount. # noqa: E501 :type: bool diff --git a/gate_api/models/futures_account_book.py b/gate_api/models/futures_account_book.py index c00ae26..ff4e125 100644 --- a/gate_api/models/futures_account_book.py +++ b/gate_api/models/futures_account_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, time=None, change=None, balance=None, type=None, text=None, c def time(self): """Gets the time of this FuturesAccountBook. # noqa: E501 - Change time. # noqa: E501 + Change time # noqa: E501 :return: The time of this FuturesAccountBook. # noqa: E501 :rtype: float @@ -103,7 +103,7 @@ def time(self): def time(self, time): """Sets the time of this FuturesAccountBook. - Change time. # noqa: E501 + Change time # noqa: E501 :param time: The time of this FuturesAccountBook. # noqa: E501 :type: float @@ -115,7 +115,7 @@ def time(self, time): def change(self): """Gets the change of this FuturesAccountBook. # noqa: E501 - Change amount. # noqa: E501 + Change amount # noqa: E501 :return: The change of this FuturesAccountBook. # noqa: E501 :rtype: str @@ -126,7 +126,7 @@ def change(self): def change(self, change): """Sets the change of this FuturesAccountBook. - Change amount. # noqa: E501 + Change amount # noqa: E501 :param change: The change of this FuturesAccountBook. # noqa: E501 :type: str @@ -138,7 +138,7 @@ def change(self, change): def balance(self): """Gets the balance of this FuturesAccountBook. # noqa: E501 - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :return: The balance of this FuturesAccountBook. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def balance(self): def balance(self, balance): """Sets the balance of this FuturesAccountBook. - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :param balance: The balance of this FuturesAccountBook. # noqa: E501 :type: str @@ -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_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_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 @@ -190,7 +190,7 @@ def type(self, type): def text(self): """Gets the text of this FuturesAccountBook. # noqa: E501 - Comment. # noqa: E501 + Comment # noqa: E501 :return: The text of this FuturesAccountBook. # noqa: E501 :rtype: str @@ -201,7 +201,7 @@ def text(self): def text(self, text): """Sets the text of this FuturesAccountBook. - Comment. # noqa: E501 + Comment # noqa: E501 :param text: The text 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 @@ -236,7 +236,7 @@ def contract(self, contract): def trade_id(self): """Gets the trade_id of this FuturesAccountBook. # noqa: E501 - trade id. # noqa: E501 + trade id # noqa: E501 :return: The trade_id of this FuturesAccountBook. # noqa: E501 :rtype: str @@ -247,7 +247,7 @@ def trade_id(self): def trade_id(self, trade_id): """Sets the trade_id of this FuturesAccountBook. - trade id. # noqa: E501 + trade id # noqa: E501 :param trade_id: The trade_id 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 - Account change record 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. - Account change record 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 363e287..6960744 100644 --- a/gate_api/models/futures_account_history.py +++ b/gate_api/models/futures_account_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, dnw=None, pnl=None, fee=None, refr=None, fund=None, point_dnw def dnw(self): """Gets the dnw of this FuturesAccountHistory. # noqa: E501 - total amount of deposit and withdraw. # noqa: E501 + total amount of deposit and withdraw # noqa: E501 :return: The dnw of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -113,7 +113,7 @@ def dnw(self): def dnw(self, dnw): """Sets the dnw of this FuturesAccountHistory. - total amount of deposit and withdraw. # noqa: E501 + total amount of deposit and withdraw # noqa: E501 :param dnw: The dnw of this FuturesAccountHistory. # noqa: E501 :type: str @@ -125,7 +125,7 @@ def dnw(self, dnw): def pnl(self): """Gets the pnl of this FuturesAccountHistory. # noqa: E501 - total amount of trading profit and loss. # noqa: E501 + total amount of trading profit and loss # noqa: E501 :return: The pnl of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -136,7 +136,7 @@ def pnl(self): def pnl(self, pnl): """Sets the pnl of this FuturesAccountHistory. - total amount of trading profit and loss. # noqa: E501 + total amount of trading profit and loss # noqa: E501 :param pnl: The pnl of this FuturesAccountHistory. # noqa: E501 :type: str @@ -148,7 +148,7 @@ def pnl(self, pnl): def fee(self): """Gets the fee of this FuturesAccountHistory. # noqa: E501 - total amount of fee. # noqa: E501 + total amount of fee # noqa: E501 :return: The fee of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -159,7 +159,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this FuturesAccountHistory. - total amount of fee. # noqa: E501 + total amount of fee # noqa: E501 :param fee: The fee of this FuturesAccountHistory. # noqa: E501 :type: str @@ -171,7 +171,7 @@ def fee(self, fee): def refr(self): """Gets the refr of this FuturesAccountHistory. # noqa: E501 - total amount of referrer rebates. # noqa: E501 + total amount of referrer rebates # noqa: E501 :return: The refr of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -182,7 +182,7 @@ def refr(self): def refr(self, refr): """Sets the refr of this FuturesAccountHistory. - total amount of referrer rebates. # noqa: E501 + total amount of referrer rebates # noqa: E501 :param refr: The refr of this FuturesAccountHistory. # noqa: E501 :type: str @@ -194,7 +194,7 @@ def refr(self, refr): def fund(self): """Gets the fund of this FuturesAccountHistory. # noqa: E501 - total amount of funding costs. # noqa: E501 + total amount of funding costs # noqa: E501 :return: The fund of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -205,7 +205,7 @@ def fund(self): def fund(self, fund): """Sets the fund of this FuturesAccountHistory. - total amount of funding costs. # noqa: E501 + total amount of funding costs # noqa: E501 :param fund: The fund of this FuturesAccountHistory. # noqa: E501 :type: str @@ -217,7 +217,7 @@ def fund(self, fund): def point_dnw(self): """Gets the point_dnw of this FuturesAccountHistory. # noqa: E501 - total amount of point deposit and withdraw. # noqa: E501 + total amount of point deposit and withdraw # noqa: E501 :return: The point_dnw of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -228,7 +228,7 @@ def point_dnw(self): def point_dnw(self, point_dnw): """Sets the point_dnw of this FuturesAccountHistory. - total amount of point deposit and withdraw. # noqa: E501 + total amount of point deposit and withdraw # noqa: E501 :param point_dnw: The point_dnw of this FuturesAccountHistory. # noqa: E501 :type: str @@ -240,7 +240,7 @@ def point_dnw(self, point_dnw): def point_fee(self): """Gets the point_fee of this FuturesAccountHistory. # noqa: E501 - total amount of point fee. # noqa: E501 + total amount of point fee # noqa: E501 :return: The point_fee of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -251,7 +251,7 @@ def point_fee(self): def point_fee(self, point_fee): """Sets the point_fee of this FuturesAccountHistory. - total amount of point fee. # noqa: E501 + total amount of point fee # noqa: E501 :param point_fee: The point_fee of this FuturesAccountHistory. # noqa: E501 :type: str @@ -263,7 +263,7 @@ def point_fee(self, point_fee): def point_refr(self): """Gets the point_refr of this FuturesAccountHistory. # noqa: E501 - total amount of referrer rebates of point fee. # noqa: E501 + total amount of referrer rebates of point fee # noqa: E501 :return: The point_refr of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -274,7 +274,7 @@ def point_refr(self): def point_refr(self, point_refr): """Sets the point_refr of this FuturesAccountHistory. - total amount of referrer rebates of point fee. # noqa: E501 + total amount of referrer rebates of point fee # noqa: E501 :param point_refr: The point_refr of this FuturesAccountHistory. # noqa: E501 :type: str @@ -286,7 +286,7 @@ def point_refr(self, point_refr): def bonus_dnw(self): """Gets the bonus_dnw of this FuturesAccountHistory. # noqa: E501 - total amount of perpetual contract bonus transfer. # noqa: E501 + total amount of perpetual contract bonus transfer # noqa: E501 :return: The bonus_dnw of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -297,7 +297,7 @@ def bonus_dnw(self): def bonus_dnw(self, bonus_dnw): """Sets the bonus_dnw of this FuturesAccountHistory. - total amount of perpetual contract bonus transfer. # noqa: E501 + total amount of perpetual contract bonus transfer # noqa: E501 :param bonus_dnw: The bonus_dnw of this FuturesAccountHistory. # noqa: E501 :type: str @@ -309,7 +309,7 @@ def bonus_dnw(self, bonus_dnw): def bonus_offset(self): """Gets the bonus_offset of this FuturesAccountHistory. # noqa: E501 - total amount of perpetual contract bonus deduction. # noqa: E501 + total amount of perpetual contract bonus deduction # noqa: E501 :return: The bonus_offset of this FuturesAccountHistory. # noqa: E501 :rtype: str @@ -320,7 +320,7 @@ def bonus_offset(self): def bonus_offset(self, bonus_offset): """Sets the bonus_offset of this FuturesAccountHistory. - total amount of perpetual contract bonus deduction. # noqa: E501 + total amount of perpetual contract bonus deduction # noqa: E501 :param bonus_offset: The bonus_offset of this FuturesAccountHistory. # noqa: E501 :type: str diff --git a/gate_api/models/futures_auto_deleverage.py b/gate_api/models/futures_auto_deleverage.py index b736dc7..f6064c7 100644 --- a/gate_api/models/futures_auto_deleverage.py +++ b/gate_api/models/futures_auto_deleverage.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, time=None, user=None, order_id=None, contract=None, leverage= def time(self): """Gets the time of this FuturesAutoDeleverage. # noqa: E501 - Automatic deleveraging time. # noqa: E501 + Automatic deleveraging time # noqa: E501 :return: The time of this FuturesAutoDeleverage. # noqa: E501 :rtype: int @@ -113,7 +113,7 @@ def time(self): def time(self, time): """Sets the time of this FuturesAutoDeleverage. - Automatic deleveraging time. # noqa: E501 + Automatic deleveraging time # noqa: E501 :param time: The time of this FuturesAutoDeleverage. # noqa: E501 :type: int @@ -125,7 +125,7 @@ def time(self, time): def user(self): """Gets the user of this FuturesAutoDeleverage. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this FuturesAutoDeleverage. # noqa: E501 :rtype: int @@ -136,7 +136,7 @@ def user(self): def user(self, user): """Sets the user of this FuturesAutoDeleverage. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this FuturesAutoDeleverage. # noqa: E501 :type: int @@ -148,7 +148,7 @@ def user(self, user): def order_id(self): """Gets the order_id of this FuturesAutoDeleverage. # noqa: E501 - Order ID. Order IDs before 2023-02-20 are null. # noqa: E501 + Order ID. Order IDs before 2023-02-20 are null # noqa: E501 :return: The order_id of this FuturesAutoDeleverage. # noqa: E501 :rtype: int @@ -159,7 +159,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this FuturesAutoDeleverage. - Order ID. Order IDs before 2023-02-20 are null. # noqa: E501 + Order ID. Order IDs before 2023-02-20 are null # noqa: E501 :param order_id: The order_id of this FuturesAutoDeleverage. # noqa: E501 :type: int @@ -171,7 +171,7 @@ def order_id(self, order_id): def contract(self): """Gets the contract of this FuturesAutoDeleverage. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesAutoDeleverage. # noqa: E501 :rtype: str @@ -182,7 +182,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesAutoDeleverage. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesAutoDeleverage. # noqa: E501 :type: str @@ -194,7 +194,7 @@ def contract(self, contract): def leverage(self): """Gets the leverage of this FuturesAutoDeleverage. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this FuturesAutoDeleverage. # noqa: E501 :rtype: str @@ -205,7 +205,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this FuturesAutoDeleverage. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage of this FuturesAutoDeleverage. # noqa: E501 :type: str @@ -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 @@ -240,7 +240,7 @@ def cross_leverage_limit(self, cross_leverage_limit): def entry_price(self): """Gets the entry_price of this FuturesAutoDeleverage. # noqa: E501 - Average entry price. # noqa: E501 + Average entry price # noqa: E501 :return: The entry_price of this FuturesAutoDeleverage. # noqa: E501 :rtype: str @@ -251,7 +251,7 @@ def entry_price(self): def entry_price(self, entry_price): """Sets the entry_price of this FuturesAutoDeleverage. - Average entry price. # noqa: E501 + Average entry price # noqa: E501 :param entry_price: The entry_price of this FuturesAutoDeleverage. # noqa: E501 :type: str @@ -263,7 +263,7 @@ def entry_price(self, entry_price): def fill_price(self): """Gets the fill_price of this FuturesAutoDeleverage. # noqa: E501 - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :return: The fill_price of this FuturesAutoDeleverage. # noqa: E501 :rtype: str @@ -274,7 +274,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this FuturesAutoDeleverage. - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :param fill_price: The fill_price of this FuturesAutoDeleverage. # noqa: E501 :type: str @@ -286,7 +286,7 @@ def fill_price(self, fill_price): def trade_size(self): """Gets the trade_size of this FuturesAutoDeleverage. # noqa: E501 - Trading size. # noqa: E501 + Trading size # noqa: E501 :return: The trade_size of this FuturesAutoDeleverage. # noqa: E501 :rtype: int @@ -297,7 +297,7 @@ def trade_size(self): def trade_size(self, trade_size): """Sets the trade_size of this FuturesAutoDeleverage. - Trading size. # noqa: E501 + Trading size # noqa: E501 :param trade_size: The trade_size of this FuturesAutoDeleverage. # noqa: E501 :type: int @@ -309,7 +309,7 @@ def trade_size(self, trade_size): def position_size(self): """Gets the position_size of this FuturesAutoDeleverage. # noqa: E501 - Positions after auto-deleveraging. # noqa: E501 + Positions after auto-deleveraging # noqa: E501 :return: The position_size of this FuturesAutoDeleverage. # noqa: E501 :rtype: int @@ -320,7 +320,7 @@ def position_size(self): def position_size(self, position_size): """Sets the position_size of this FuturesAutoDeleverage. - Positions after auto-deleveraging. # noqa: E501 + Positions after auto-deleveraging # noqa: E501 :param position_size: The position_size of this FuturesAutoDeleverage. # noqa: E501 :type: int diff --git a/gate_api/models/futures_batch_amend_order_request.py b/gate_api/models/futures_batch_amend_order_request.py index 910ba97..c12d869 100644 --- a/gate_api/models/futures_batch_amend_order_request.py +++ b/gate_api/models/futures_batch_amend_order_request.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, order_id=None, text=None, size=None, price=None, amend_text=N def order_id(self): """Gets the order_id of this FuturesBatchAmendOrderRequest. # noqa: E501 - Order id, order_id and text must contain at least one. # noqa: E501 + Order id, order_id and text must contain at least one # noqa: E501 :return: The order_id of this FuturesBatchAmendOrderRequest. # noqa: E501 :rtype: int @@ -88,7 +88,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this FuturesBatchAmendOrderRequest. - Order id, order_id and text must contain at least one. # noqa: E501 + Order id, order_id and text must contain at least one # noqa: E501 :param order_id: The order_id of this FuturesBatchAmendOrderRequest. # noqa: E501 :type: int @@ -100,7 +100,7 @@ def order_id(self, order_id): def text(self): """Gets the text of this FuturesBatchAmendOrderRequest. # noqa: E501 - User-defined order text, at least one of order_id and text must be passed. # noqa: E501 + User-defined order text, at least one of order_id and text must be passed # noqa: E501 :return: The text of this FuturesBatchAmendOrderRequest. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def text(self): def text(self, text): """Sets the text of this FuturesBatchAmendOrderRequest. - User-defined order text, at least one of order_id and text must be passed. # noqa: E501 + User-defined order text, at least one of order_id and text must be passed # noqa: E501 :param text: The text of this FuturesBatchAmendOrderRequest. # noqa: E501 :type: str @@ -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, 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, 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 3094ad9..246d19d 100644 --- a/gate_api/models/futures_candlestick.py +++ b/gate_api/models/futures_candlestick.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, t=None, v=None, c=None, h=None, l=None, o=None, sum=None, loc def t(self): """Gets the t of this FuturesCandlestick. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this FuturesCandlestick. # noqa: E501 :rtype: float @@ -98,7 +98,7 @@ def t(self): def t(self, t): """Sets the t of this FuturesCandlestick. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this FuturesCandlestick. # noqa: E501 :type: float @@ -110,7 +110,7 @@ def t(self, t): def v(self): """Gets the v of this FuturesCandlestick. # noqa: E501 - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :return: The v of this FuturesCandlestick. # noqa: E501 :rtype: int @@ -121,7 +121,7 @@ def v(self): def v(self, v): """Sets the v of this FuturesCandlestick. - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :param v: The v of this FuturesCandlestick. # noqa: E501 :type: int @@ -133,7 +133,7 @@ def v(self, v): def c(self): """Gets the c of this FuturesCandlestick. # noqa: E501 - Close price (quote currency). # noqa: E501 + Close price (quote currency) # noqa: E501 :return: The c of this FuturesCandlestick. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def c(self): def c(self, c): """Sets the c of this FuturesCandlestick. - Close price (quote currency). # noqa: E501 + Close price (quote currency) # noqa: E501 :param c: The c of this FuturesCandlestick. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def c(self, c): def h(self): """Gets the h of this FuturesCandlestick. # noqa: E501 - Highest price (quote currency). # noqa: E501 + Highest price (quote currency) # noqa: E501 :return: The h of this FuturesCandlestick. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def h(self): def h(self, h): """Sets the h of this FuturesCandlestick. - Highest price (quote currency). # noqa: E501 + Highest price (quote currency) # noqa: E501 :param h: The h of this FuturesCandlestick. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def h(self, h): def l(self): """Gets the l of this FuturesCandlestick. # noqa: E501 - Lowest price (quote currency). # noqa: E501 + Lowest price (quote currency) # noqa: E501 :return: The l of this FuturesCandlestick. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def l(self): def l(self, l): """Sets the l of this FuturesCandlestick. - Lowest price (quote currency). # noqa: E501 + Lowest price (quote currency) # noqa: E501 :param l: The l of this FuturesCandlestick. # noqa: E501 :type: str @@ -202,7 +202,7 @@ def l(self, l): def o(self): """Gets the o of this FuturesCandlestick. # noqa: E501 - Open price (quote currency). # noqa: E501 + Open price (quote currency) # noqa: E501 :return: The o of this FuturesCandlestick. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def o(self): def o(self, o): """Sets the o of this FuturesCandlestick. - Open price (quote currency). # noqa: E501 + Open price (quote currency) # noqa: E501 :param o: The o of this FuturesCandlestick. # noqa: E501 :type: str @@ -225,7 +225,7 @@ def o(self, o): def sum(self): """Gets the sum of this FuturesCandlestick. # noqa: E501 - Trading volume (unit: Quote currency). # noqa: E501 + Trading volume (unit: Quote currency) # noqa: E501 :return: The sum of this FuturesCandlestick. # noqa: E501 :rtype: str @@ -236,7 +236,7 @@ def sum(self): def sum(self, sum): """Sets the sum of this FuturesCandlestick. - Trading volume (unit: Quote currency). # noqa: E501 + Trading volume (unit: Quote currency) # noqa: E501 :param sum: The sum of this FuturesCandlestick. # noqa: E501 :type: str diff --git a/gate_api/models/futures_fee.py b/gate_api/models/futures_fee.py index 92a437e..07aa347 100644 --- a/gate_api/models/futures_fee.py +++ b/gate_api/models/futures_fee.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, taker_fee=None, maker_fee=None, local_vars_configuration=None def taker_fee(self): """Gets the taker_fee of this FuturesFee. # noqa: E501 - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :return: The taker_fee of this FuturesFee. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def taker_fee(self): def taker_fee(self, taker_fee): """Sets the taker_fee of this FuturesFee. - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :param taker_fee: The taker_fee of this FuturesFee. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def taker_fee(self, taker_fee): def maker_fee(self): """Gets the maker_fee of this FuturesFee. # noqa: E501 - maker fee. # noqa: E501 + maker fee # noqa: E501 :return: The maker_fee of this FuturesFee. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def maker_fee(self): def maker_fee(self, maker_fee): """Sets the maker_fee of this FuturesFee. - maker fee. # noqa: E501 + maker fee # noqa: E501 :param maker_fee: The maker_fee of this FuturesFee. # noqa: E501 :type: str diff --git a/gate_api/models/futures_index_constituents.py b/gate_api/models/futures_index_constituents.py index 5f6c799..12232a7 100644 --- a/gate_api/models/futures_index_constituents.py +++ b/gate_api/models/futures_index_constituents.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, index=None, constituents=None, local_vars_configuration=None) def index(self): """Gets the index of this FuturesIndexConstituents. # noqa: E501 - Index name. # noqa: E501 + Index name # noqa: E501 :return: The index of this FuturesIndexConstituents. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def index(self): def index(self, index): """Sets the index of this FuturesIndexConstituents. - Index name. # noqa: E501 + Index name # noqa: E501 :param index: The index of this FuturesIndexConstituents. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def index(self, index): def constituents(self): """Gets the constituents of this FuturesIndexConstituents. # noqa: E501 - Constituents. # noqa: E501 + Constituents # noqa: E501 :return: The constituents of this FuturesIndexConstituents. # noqa: E501 :rtype: list[IndexConstituent] @@ -96,7 +96,7 @@ def constituents(self): def constituents(self, constituents): """Sets the constituents of this FuturesIndexConstituents. - Constituents. # noqa: E501 + Constituents # noqa: E501 :param constituents: The constituents of this FuturesIndexConstituents. # noqa: E501 :type: list[IndexConstituent] diff --git a/gate_api/models/futures_initial_order.py b/gate_api/models/futures_initial_order.py index 16a22df..7f3999c 100644 --- a/gate_api/models/futures_initial_order.py +++ b/gate_api/models/futures_initial_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -100,7 +100,7 @@ def __init__(self, contract=None, size=None, price=None, close=False, tif='gtc', def contract(self): """Gets the contract of this FuturesInitialOrder. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesInitialOrder. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesInitialOrder. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesInitialOrder. # noqa: E501 :type: str @@ -148,7 +148,7 @@ def size(self, size): def price(self): """Gets the price of this FuturesInitialOrder. # noqa: E501 - Order price. Set to 0 to use market price. # noqa: E501 + Order price. Set to 0 to use market price # noqa: E501 :return: The price of this FuturesInitialOrder. # noqa: E501 :rtype: str @@ -159,7 +159,7 @@ def price(self): def price(self, price): """Sets the price of this FuturesInitialOrder. - Order price. Set to 0 to use market price. # noqa: E501 + Order price. Set to 0 to use market price # noqa: E501 :param price: The price of this FuturesInitialOrder. # noqa: E501 :type: str @@ -196,7 +196,7 @@ def close(self, close): def tif(self): """Gets the tif of this FuturesInitialOrder. # noqa: E501 - Time in force strategy, default is gtc, market order currently only supports ioc mode mode - 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 strategy, default is gtc, market order currently only supports ioc mode mode - 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 @@ -271,7 +271,7 @@ def reduce_only(self, reduce_only): def auto_size(self): """Gets the auto_size of this FuturesInitialOrder. # noqa: E501 - Do not set auto_size When the dual-position mode is closed all positions (size=0), auto_size, close_long, close_short, short When the double-storey mode partially closes the position (size ≠ 0), there is no need to set auto_size # 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. - Do not set auto_size When the dual-position mode is closed all positions (size=0), auto_size, close_long, close_short, short When the double-storey mode partially closes the position (size ≠ 0), there is no need to set auto_size # 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 @@ -294,7 +294,7 @@ def auto_size(self, auto_size): def is_reduce_only(self): """Gets the is_reduce_only of this FuturesInitialOrder. # noqa: E501 - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :return: The is_reduce_only of this FuturesInitialOrder. # noqa: E501 :rtype: bool @@ -305,7 +305,7 @@ def is_reduce_only(self): def is_reduce_only(self, is_reduce_only): """Sets the is_reduce_only of this FuturesInitialOrder. - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :param is_reduce_only: The is_reduce_only of this FuturesInitialOrder. # noqa: E501 :type: bool @@ -317,7 +317,7 @@ def is_reduce_only(self, is_reduce_only): def is_close(self): """Gets the is_close of this FuturesInitialOrder. # noqa: E501 - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :return: The is_close of this FuturesInitialOrder. # noqa: E501 :rtype: bool @@ -328,7 +328,7 @@ def is_close(self): def is_close(self, is_close): """Sets the is_close of this FuturesInitialOrder. - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :param is_close: The is_close of this FuturesInitialOrder. # noqa: E501 :type: bool diff --git a/gate_api/models/futures_limit_risk_tiers.py b/gate_api/models/futures_limit_risk_tiers.py index 121a550..a636a2e 100644 --- a/gate_api/models/futures_limit_risk_tiers.py +++ b/gate_api/models/futures_limit_risk_tiers.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_ra def tier(self): """Gets the tier of this FuturesLimitRiskTiers. # noqa: E501 - Tier. # noqa: E501 + Tier # noqa: E501 :return: The tier of this FuturesLimitRiskTiers. # noqa: E501 :rtype: int @@ -98,7 +98,7 @@ def tier(self): def tier(self, tier): """Sets the tier of this FuturesLimitRiskTiers. - Tier. # noqa: E501 + Tier # noqa: E501 :param tier: The tier of this FuturesLimitRiskTiers. # noqa: E501 :type: int @@ -110,7 +110,7 @@ def tier(self, tier): def risk_limit(self): """Gets the risk_limit of this FuturesLimitRiskTiers. # noqa: E501 - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :return: The risk_limit of this FuturesLimitRiskTiers. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def risk_limit(self): def risk_limit(self, risk_limit): """Sets the risk_limit of this FuturesLimitRiskTiers. - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :param risk_limit: The risk_limit of this FuturesLimitRiskTiers. # noqa: E501 :type: str @@ -133,7 +133,7 @@ def risk_limit(self, risk_limit): def initial_rate(self): """Gets the initial_rate of this FuturesLimitRiskTiers. # noqa: E501 - Initial margin rate. # noqa: E501 + Initial margin rate # noqa: E501 :return: The initial_rate of this FuturesLimitRiskTiers. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def initial_rate(self): def initial_rate(self, initial_rate): """Sets the initial_rate of this FuturesLimitRiskTiers. - Initial margin rate. # noqa: E501 + Initial margin rate # noqa: E501 :param initial_rate: The initial_rate of this FuturesLimitRiskTiers. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def initial_rate(self, initial_rate): def maintenance_rate(self): """Gets the maintenance_rate of this FuturesLimitRiskTiers. # noqa: E501 - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :return: The maintenance_rate of this FuturesLimitRiskTiers. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def maintenance_rate(self): def maintenance_rate(self, maintenance_rate): """Sets the maintenance_rate of this FuturesLimitRiskTiers. - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :param maintenance_rate: The maintenance_rate of this FuturesLimitRiskTiers. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def maintenance_rate(self, maintenance_rate): def leverage_max(self): """Gets the leverage_max of this FuturesLimitRiskTiers. # noqa: E501 - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :return: The leverage_max of this FuturesLimitRiskTiers. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def leverage_max(self): def leverage_max(self, leverage_max): """Sets the leverage_max of this FuturesLimitRiskTiers. - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :param leverage_max: The leverage_max of this FuturesLimitRiskTiers. # noqa: E501 :type: str @@ -202,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 @@ -213,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 @@ -225,7 +225,7 @@ def contract(self, contract): def deduction(self): """Gets the deduction of this FuturesLimitRiskTiers. # noqa: E501 - Maintenance margin quick calculation deduction. # noqa: E501 + Maintenance margin quick calculation deduction amount # noqa: E501 :return: The deduction of this FuturesLimitRiskTiers. # noqa: E501 :rtype: str @@ -236,7 +236,7 @@ def deduction(self): def deduction(self, deduction): """Sets the deduction of this FuturesLimitRiskTiers. - Maintenance margin quick calculation deduction. # noqa: E501 + Maintenance margin quick calculation deduction amount # noqa: E501 :param deduction: The deduction of this FuturesLimitRiskTiers. # noqa: E501 :type: str diff --git a/gate_api/models/futures_liq_order.py b/gate_api/models/futures_liq_order.py index d57b282..fabcb0a 100644 --- a/gate_api/models/futures_liq_order.py +++ b/gate_api/models/futures_liq_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, time=None, contract=None, size=None, order_size=None, order_p def time(self): """Gets the time of this FuturesLiqOrder. # noqa: E501 - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :return: The time of this FuturesLiqOrder. # noqa: E501 :rtype: int @@ -98,7 +98,7 @@ def time(self): def time(self, time): """Sets the time of this FuturesLiqOrder. - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :param time: The time of this FuturesLiqOrder. # noqa: E501 :type: int @@ -110,7 +110,7 @@ def time(self, time): def contract(self): """Gets the contract of this FuturesLiqOrder. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesLiqOrder. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesLiqOrder. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesLiqOrder. # noqa: E501 :type: str @@ -133,7 +133,7 @@ def contract(self, contract): def size(self): """Gets the size of this FuturesLiqOrder. # noqa: E501 - User position size. # noqa: E501 + User position size # noqa: E501 :return: The size of this FuturesLiqOrder. # noqa: E501 :rtype: int @@ -144,7 +144,7 @@ def size(self): def size(self, size): """Sets the size of this FuturesLiqOrder. - User position size. # noqa: E501 + User position size # noqa: E501 :param size: The size of this FuturesLiqOrder. # noqa: E501 :type: int @@ -156,7 +156,7 @@ def size(self, size): def order_size(self): """Gets the order_size of this FuturesLiqOrder. # noqa: E501 - Number of forced liquidation orders. # noqa: E501 + Number of forced liquidation orders # noqa: E501 :return: The order_size of this FuturesLiqOrder. # noqa: E501 :rtype: int @@ -167,7 +167,7 @@ def order_size(self): def order_size(self, order_size): """Sets the order_size of this FuturesLiqOrder. - Number of forced liquidation orders. # noqa: E501 + Number of forced liquidation orders # noqa: E501 :param order_size: The order_size of this FuturesLiqOrder. # noqa: E501 :type: int @@ -179,7 +179,7 @@ def order_size(self, order_size): def order_price(self): """Gets the order_price of this FuturesLiqOrder. # noqa: E501 - Liquidation order price. # noqa: E501 + Liquidation order price # noqa: E501 :return: The order_price of this FuturesLiqOrder. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def order_price(self): def order_price(self, order_price): """Sets the order_price of this FuturesLiqOrder. - Liquidation order price. # noqa: E501 + Liquidation order price # noqa: E501 :param order_price: The order_price of this FuturesLiqOrder. # noqa: E501 :type: str @@ -202,7 +202,7 @@ def order_price(self, order_price): def fill_price(self): """Gets the fill_price of this FuturesLiqOrder. # noqa: E501 - Liquidation order average taker price. # noqa: E501 + Liquidation order average taker price # noqa: E501 :return: The fill_price of this FuturesLiqOrder. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this FuturesLiqOrder. - Liquidation order average taker price. # noqa: E501 + Liquidation order average taker price # noqa: E501 :param fill_price: The fill_price of this FuturesLiqOrder. # noqa: E501 :type: str @@ -225,7 +225,7 @@ def fill_price(self, fill_price): def left(self): """Gets the left of this FuturesLiqOrder. # noqa: E501 - System liquidation order maker size. # noqa: E501 + System liquidation order maker size # noqa: E501 :return: The left of this FuturesLiqOrder. # noqa: E501 :rtype: int @@ -236,7 +236,7 @@ def left(self): def left(self, left): """Sets the left of this FuturesLiqOrder. - System liquidation order maker size. # noqa: E501 + System liquidation order maker size # noqa: E501 :param left: The left of this FuturesLiqOrder. # noqa: E501 :type: int diff --git a/gate_api/models/futures_liquidate.py b/gate_api/models/futures_liquidate.py index 9e27ab5..549e71f 100644 --- a/gate_api/models/futures_liquidate.py +++ b/gate_api/models/futures_liquidate.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -112,7 +112,7 @@ def __init__(self, time=None, contract=None, leverage=None, size=None, margin=No def time(self): """Gets the time of this FuturesLiquidate. # noqa: E501 - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :return: The time of this FuturesLiquidate. # noqa: E501 :rtype: int @@ -123,7 +123,7 @@ def time(self): def time(self, time): """Sets the time of this FuturesLiquidate. - Liquidation time. # noqa: E501 + Liquidation time # noqa: E501 :param time: The time of this FuturesLiquidate. # noqa: E501 :type: int @@ -135,7 +135,7 @@ def time(self, time): def contract(self): """Gets the contract of this FuturesLiquidate. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesLiquidate. # noqa: E501 :rtype: str @@ -146,7 +146,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesLiquidate. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesLiquidate. # noqa: E501 :type: str @@ -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 @@ -181,7 +181,7 @@ def leverage(self, leverage): def size(self): """Gets the size of this FuturesLiquidate. # noqa: E501 - Position size. # noqa: E501 + Position size # noqa: E501 :return: The size of this FuturesLiquidate. # noqa: E501 :rtype: int @@ -192,7 +192,7 @@ def size(self): def size(self, size): """Sets the size of this FuturesLiquidate. - Position size. # noqa: E501 + Position size # noqa: E501 :param size: The size of this FuturesLiquidate. # noqa: E501 :type: int @@ -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 @@ -319,7 +319,7 @@ def order_id(self, order_id): def order_price(self): """Gets the order_price of this FuturesLiquidate. # noqa: E501 - Liquidation order price. # noqa: E501 + Liquidation order price # noqa: E501 :return: The order_price of this FuturesLiquidate. # noqa: E501 :rtype: str @@ -330,7 +330,7 @@ def order_price(self): def order_price(self, order_price): """Sets the order_price of this FuturesLiquidate. - Liquidation order price. # noqa: E501 + Liquidation order price # noqa: E501 :param order_price: The order_price of this FuturesLiquidate. # noqa: E501 :type: str @@ -342,7 +342,7 @@ def order_price(self, order_price): def fill_price(self): """Gets the fill_price of this FuturesLiquidate. # noqa: E501 - Liquidation order average taker price. # noqa: E501 + Liquidation order average taker price # noqa: E501 :return: The fill_price of this FuturesLiquidate. # noqa: E501 :rtype: str @@ -353,7 +353,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this FuturesLiquidate. - Liquidation order average taker price. # noqa: E501 + Liquidation order average taker price # noqa: E501 :param fill_price: The fill_price of this FuturesLiquidate. # noqa: E501 :type: str @@ -365,7 +365,7 @@ def fill_price(self, fill_price): def left(self): """Gets the left of this FuturesLiquidate. # noqa: E501 - Liquidation order maker size. # noqa: E501 + Liquidation order maker size # noqa: E501 :return: The left of this FuturesLiquidate. # noqa: E501 :rtype: int @@ -376,7 +376,7 @@ def left(self): def left(self, left): """Sets the left of this FuturesLiquidate. - Liquidation order maker size. # noqa: E501 + Liquidation order maker size # noqa: E501 :param left: The left of this FuturesLiquidate. # noqa: E501 :type: int diff --git a/gate_api/models/futures_order.py b/gate_api/models/futures_order.py index 9bd08b7..0f60281 100644 --- a/gate_api/models/futures_order.py +++ b/gate_api/models/futures_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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', @@ -58,13 +59,16 @@ class FuturesOrder(object): 'auto_size': 'str', 'stp_id': 'int', 'stp_act': 'str', - 'amend_text': 'str' + 'amend_text': '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', @@ -87,11 +91,13 @@ class FuturesOrder(object): 'auto_size': 'auto_size', 'stp_id': 'stp_id', 'stp_act': 'stp_act', - 'amend_text': 'amend_text' + 'amend_text': 'amend_text', + '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, 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, 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() @@ -100,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 @@ -123,6 +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._limit_vip = None + self._pid = None self.discriminator = None if id is not None: @@ -131,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: @@ -175,12 +186,16 @@ 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 limit_vip is not None: + self.limit_vip = limit_vip + if pid is not None: + self.pid = pid @property def id(self): """Gets the id of this FuturesOrder. # noqa: E501 - Futures order ID. # noqa: E501 + Futures order ID # noqa: E501 :return: The id of this FuturesOrder. # noqa: E501 :rtype: int @@ -191,7 +206,7 @@ def id(self): def id(self, id): """Sets the id of this FuturesOrder. - Futures order ID. # noqa: E501 + Futures order ID # noqa: E501 :param id: The id of this FuturesOrder. # noqa: E501 :type: int @@ -203,7 +218,7 @@ def id(self, id): def user(self): """Gets the user of this FuturesOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this FuturesOrder. # noqa: E501 :rtype: int @@ -214,7 +229,7 @@ def user(self): def user(self, user): """Sets the user of this FuturesOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this FuturesOrder. # noqa: E501 :type: int @@ -226,7 +241,7 @@ def user(self, user): def create_time(self): """Gets the create_time of this FuturesOrder. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this FuturesOrder. # noqa: E501 :rtype: float @@ -237,7 +252,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this FuturesOrder. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this FuturesOrder. # noqa: E501 :type: float @@ -245,11 +260,34 @@ 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 - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :return: The finish_time of this FuturesOrder. # noqa: E501 :rtype: float @@ -260,7 +298,7 @@ def finish_time(self): def finish_time(self, finish_time): """Sets the finish_time of this FuturesOrder. - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :param finish_time: The finish_time of this FuturesOrder. # noqa: E501 :type: float @@ -272,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 - 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 @@ -283,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 - 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 @@ -301,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 @@ -312,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 @@ -330,7 +368,7 @@ def status(self, status): def contract(self): """Gets the contract of this FuturesOrder. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesOrder. # noqa: E501 :rtype: str @@ -341,7 +379,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesOrder. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesOrder. # noqa: E501 :type: str @@ -355,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 @@ -366,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 @@ -380,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 @@ -391,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 @@ -403,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 @@ -414,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 @@ -426,7 +464,7 @@ def price(self, price): def close(self): """Gets the close of this FuturesOrder. # noqa: E501 - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :return: The close of this FuturesOrder. # noqa: E501 :rtype: bool @@ -437,7 +475,7 @@ def close(self): def close(self, close): """Sets the close of this FuturesOrder. - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :param close: The close of this FuturesOrder. # noqa: E501 :type: bool @@ -449,7 +487,7 @@ def close(self, close): def is_close(self): """Gets the is_close of this FuturesOrder. # noqa: E501 - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :return: The is_close of this FuturesOrder. # noqa: E501 :rtype: bool @@ -460,7 +498,7 @@ def is_close(self): def is_close(self, is_close): """Sets the is_close of this FuturesOrder. - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :param is_close: The is_close of this FuturesOrder. # noqa: E501 :type: bool @@ -472,7 +510,7 @@ def is_close(self, is_close): def reduce_only(self): """Gets the reduce_only of this FuturesOrder. # noqa: E501 - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :return: The reduce_only of this FuturesOrder. # noqa: E501 :rtype: bool @@ -483,7 +521,7 @@ def reduce_only(self): def reduce_only(self, reduce_only): """Sets the reduce_only of this FuturesOrder. - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :param reduce_only: The reduce_only of this FuturesOrder. # noqa: E501 :type: bool @@ -495,7 +533,7 @@ def reduce_only(self, reduce_only): def is_reduce_only(self): """Gets the is_reduce_only of this FuturesOrder. # noqa: E501 - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :return: The is_reduce_only of this FuturesOrder. # noqa: E501 :rtype: bool @@ -506,7 +544,7 @@ def is_reduce_only(self): def is_reduce_only(self, is_reduce_only): """Sets the is_reduce_only of this FuturesOrder. - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :param is_reduce_only: The is_reduce_only of this FuturesOrder. # noqa: E501 :type: bool @@ -518,7 +556,7 @@ def is_reduce_only(self, is_reduce_only): def is_liq(self): """Gets the is_liq of this FuturesOrder. # noqa: E501 - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :return: The is_liq of this FuturesOrder. # noqa: E501 :rtype: bool @@ -529,7 +567,7 @@ def is_liq(self): def is_liq(self, is_liq): """Sets the is_liq of this FuturesOrder. - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :param is_liq: The is_liq of this FuturesOrder. # noqa: E501 :type: bool @@ -570,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 @@ -581,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 @@ -593,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 @@ -604,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 @@ -616,7 +654,7 @@ def fill_price(self, fill_price): def text(self): """Gets the text of this FuturesOrder. # noqa: E501 - Order custom information, users can use this field to set a custom ID, and the user-defined field must meet the following conditions: 1. Must start with `t-` 2. If `t-` is not calculated, the length cannot exceed 28 bytes 3. The input content can only contain numbers, letters, underscores (_), midscores (-) or dots (.) In addition to user-defined information, the following are internal reserved fields that identifies the source of the order: - web: web page - api: API call - app: mobile terminal - auto_deleveraging: Automatic position reduction - liquidation: Liquidation under the classic account’s old liquidation mode - liq-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: 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 @@ -627,7 +665,7 @@ def text(self): def text(self, text): """Sets the text of this FuturesOrder. - Order custom information, users can use this field to set a custom ID, and the user-defined field must meet the following conditions: 1. Must start with `t-` 2. If `t-` is not calculated, the length cannot exceed 28 bytes 3. The input content can only contain numbers, letters, underscores (_), midscores (-) or dots (.) In addition to user-defined information, the following are internal reserved fields that identifies the source of the order: - web: web page - api: API call - app: mobile terminal - auto_deleveraging: Automatic position reduction - liquidation: Liquidation under the classic account’s old liquidation mode - liq-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: 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 @@ -639,7 +677,7 @@ def text(self, text): def tkfr(self): """Gets the tkfr of this FuturesOrder. # noqa: E501 - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :return: The tkfr of this FuturesOrder. # noqa: E501 :rtype: str @@ -650,7 +688,7 @@ def tkfr(self): def tkfr(self, tkfr): """Sets the tkfr of this FuturesOrder. - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :param tkfr: The tkfr of this FuturesOrder. # noqa: E501 :type: str @@ -662,7 +700,7 @@ def tkfr(self, tkfr): def mkfr(self): """Gets the mkfr of this FuturesOrder. # noqa: E501 - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :return: The mkfr of this FuturesOrder. # noqa: E501 :rtype: str @@ -673,7 +711,7 @@ def mkfr(self): def mkfr(self, mkfr): """Sets the mkfr of this FuturesOrder. - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :param mkfr: The mkfr of this FuturesOrder. # noqa: E501 :type: str @@ -685,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 @@ -696,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 @@ -760,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, 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 @@ -771,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, 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 @@ -789,7 +827,7 @@ def stp_act(self, stp_act): def amend_text(self): """Gets the amend_text of this FuturesOrder. # noqa: E501 - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :return: The amend_text of this FuturesOrder. # noqa: E501 :rtype: str @@ -800,7 +838,7 @@ def amend_text(self): def amend_text(self, amend_text): """Sets the amend_text of this FuturesOrder. - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :param amend_text: The amend_text of this FuturesOrder. # noqa: E501 :type: str @@ -808,6 +846,52 @@ def amend_text(self, amend_text): self._amend_text = amend_text + @property + def limit_vip(self): + """Gets the limit_vip of this FuturesOrder. # 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 limit_vip of this FuturesOrder. # noqa: E501 + :rtype: int + """ + return self._limit_vip + + @limit_vip.setter + def limit_vip(self, limit_vip): + """Sets the limit_vip of this FuturesOrder. + + 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 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._pid = pid + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/gate_api/models/futures_order_amendment.py b/gate_api/models/futures_order_amendment.py index 267b361..1232631 100644 --- a/gate_api/models/futures_order_amendment.py +++ b/gate_api/models/futures_order_amendment.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -35,17 +35,19 @@ class FuturesOrderAmendment(object): openapi_types = { 'size': 'int', 'price': 'str', - 'amend_text': 'str' + 'amend_text': 'str', + 'text': 'str' } attribute_map = { 'size': 'size', 'price': 'price', - 'amend_text': 'amend_text' + 'amend_text': 'amend_text', + 'text': 'text' } - def __init__(self, size=None, price=None, amend_text=None, local_vars_configuration=None): # noqa: E501 - # type: (int, 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() @@ -54,6 +56,7 @@ def __init__(self, size=None, price=None, amend_text=None, local_vars_configurat self._size = None self._price = None self._amend_text = None + self._text = None self.discriminator = None if size is not None: @@ -62,6 +65,8 @@ def __init__(self, size=None, price=None, amend_text=None, local_vars_configurat self.price = price if amend_text is not None: self.amend_text = amend_text + if text is not None: + self.text = text @property def size(self): @@ -90,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 @@ -101,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 @@ -113,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 @@ -124,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 @@ -132,6 +137,29 @@ def amend_text(self, amend_text): self._amend_text = amend_text + @property + def text(self): + """Gets the text of this FuturesOrderAmendment. # noqa: E501 + + Internal users can modify information in the text field. # noqa: E501 + + :return: The text of this FuturesOrderAmendment. # noqa: E501 + :rtype: str + """ + return self._text + + @text.setter + def text(self, text): + """Sets the text of this FuturesOrderAmendment. + + Internal users can modify information in the text field. # noqa: E501 + + :param text: The text of this FuturesOrderAmendment. # 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/futures_order_book.py b/gate_api/models/futures_order_book.py index 48e22d5..cc240a6 100644 --- a/gate_api/models/futures_order_book.py +++ b/gate_api/models/futures_order_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -98,7 +98,7 @@ def id(self, id): def current(self): """Gets the current of this FuturesOrderBook. # noqa: E501 - Response data generation timestamp. # noqa: E501 + Response data generation timestamp # noqa: E501 :return: The current of this FuturesOrderBook. # noqa: E501 :rtype: float @@ -109,7 +109,7 @@ def current(self): def current(self, current): """Sets the current of this FuturesOrderBook. - Response data generation timestamp. # noqa: E501 + Response data generation timestamp # noqa: E501 :param current: The current of this FuturesOrderBook. # noqa: E501 :type: float @@ -121,7 +121,7 @@ def current(self, current): def update(self): """Gets the update of this FuturesOrderBook. # noqa: E501 - Order book changed timestamp. # noqa: E501 + Order book changed timestamp # noqa: E501 :return: The update of this FuturesOrderBook. # noqa: E501 :rtype: float @@ -132,7 +132,7 @@ def update(self): def update(self, update): """Sets the update of this FuturesOrderBook. - Order book changed timestamp. # noqa: E501 + Order book changed timestamp # noqa: E501 :param update: The update of this FuturesOrderBook. # noqa: E501 :type: float @@ -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 da75584..4ca4732 100644 --- a/gate_api/models/futures_order_book_item.py +++ b/gate_api/models/futures_order_book_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, p=None, s=None, local_vars_configuration=None): # noqa: E501 def p(self): """Gets the p of this FuturesOrderBookItem. # noqa: E501 - Price (quote currency). # noqa: E501 + Price (quote currency) # noqa: E501 :return: The p of this FuturesOrderBookItem. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def p(self): def p(self, p): """Sets the p of this FuturesOrderBookItem. - Price (quote currency). # noqa: E501 + Price (quote currency) # noqa: E501 :param p: The p of this FuturesOrderBookItem. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def p(self, p): def s(self): """Gets the s of this FuturesOrderBookItem. # noqa: E501 - Size. # noqa: E501 + Size # noqa: E501 :return: The s of this FuturesOrderBookItem. # noqa: E501 :rtype: int @@ -96,7 +96,7 @@ def s(self): def s(self, s): """Sets the s of this FuturesOrderBookItem. - Size. # noqa: E501 + Size # noqa: E501 :param s: The s of this FuturesOrderBookItem. # noqa: E501 :type: int diff --git a/gate_api/models/futures_position_cross_mode.py b/gate_api/models/futures_position_cross_mode.py index 1297bb6..4f4a83c 100644 --- a/gate_api/models/futures_position_cross_mode.py +++ b/gate_api/models/futures_position_cross_mode.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -60,7 +60,7 @@ def __init__(self, mode=None, contract=None, local_vars_configuration=None): # def mode(self): """Gets the mode of this FuturesPositionCrossMode. # noqa: E501 - Full position-by-position model, ISOLATED-by-position, CROSS-full position. # 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 @@ -71,7 +71,7 @@ def mode(self): def mode(self, mode): """Sets the mode of this FuturesPositionCrossMode. - Full position-by-position model, ISOLATED-by-position, CROSS-full position. # noqa: E501 + 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 @@ -85,7 +85,7 @@ def mode(self, mode): def contract(self): """Gets the contract of this FuturesPositionCrossMode. # noqa: E501 - Contract Market. # noqa: E501 + Futures market # noqa: E501 :return: The contract of this FuturesPositionCrossMode. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesPositionCrossMode. - Contract Market. # noqa: E501 + Futures market # noqa: E501 :param contract: The contract of this FuturesPositionCrossMode. # noqa: E501 :type: str diff --git a/gate_api/models/futures_premium_index.py b/gate_api/models/futures_premium_index.py index f4b3a62..f02adc1 100644 --- a/gate_api/models/futures_premium_index.py +++ b/gate_api/models/futures_premium_index.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, t=None, c=None, h=None, l=None, o=None, local_vars_configurat def t(self): """Gets the t of this FuturesPremiumIndex. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this FuturesPremiumIndex. # noqa: E501 :rtype: float @@ -88,7 +88,7 @@ def t(self): def t(self, t): """Sets the t of this FuturesPremiumIndex. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this FuturesPremiumIndex. # noqa: E501 :type: float @@ -100,7 +100,7 @@ def t(self, t): def c(self): """Gets the c of this FuturesPremiumIndex. # noqa: E501 - Close price. # noqa: E501 + Close price # noqa: E501 :return: The c of this FuturesPremiumIndex. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def c(self): def c(self, c): """Sets the c of this FuturesPremiumIndex. - Close price. # noqa: E501 + Close price # noqa: E501 :param c: The c of this FuturesPremiumIndex. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def c(self, c): def h(self): """Gets the h of this FuturesPremiumIndex. # noqa: E501 - Highest price. # noqa: E501 + Highest price # noqa: E501 :return: The h of this FuturesPremiumIndex. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def h(self): def h(self, h): """Sets the h of this FuturesPremiumIndex. - Highest price. # noqa: E501 + Highest price # noqa: E501 :param h: The h of this FuturesPremiumIndex. # noqa: E501 :type: str @@ -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 @@ -169,7 +169,7 @@ def l(self, l): def o(self): """Gets the o of this FuturesPremiumIndex. # noqa: E501 - Open price. # noqa: E501 + Open price # noqa: E501 :return: The o of this FuturesPremiumIndex. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def o(self): def o(self, o): """Sets the o of this FuturesPremiumIndex. - Open price. # noqa: E501 + Open price # noqa: E501 :param o: The o 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 300b245..7dd48a6 100644 --- a/gate_api/models/futures_price_trigger.py +++ b/gate_api/models/futures_price_trigger.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 - Trigger Policy - 0: Price trigger, that is, when the price meets the conditions - 1: Price spread trigger, i.e. the last price specified in `price_type` minus the second-last price difference At present, only 0 is the latest transaction price # 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. - Trigger Policy - 0: Price trigger, that is, when the price meets the conditions - 1: Price spread trigger, i.e. the last price specified in `price_type` minus the second-last price difference At present, only 0 is the latest transaction price # 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 - Price Condition Type - 1: Indicates that the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price` Trigger, while Trigger.Price must > last_price - based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_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. - Price Condition Type - 1: Indicates that the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price` Trigger, while Trigger.Price must > last_price - based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_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 a726c29..14e16ae 100644 --- a/gate_api/models/futures_price_triggered_order.py +++ b/gate_api/models/futures_price_triggered_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -156,7 +156,7 @@ def trigger(self, trigger): def id(self): """Gets the id of this FuturesPriceTriggeredOrder. # noqa: E501 - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :return: The id of this FuturesPriceTriggeredOrder. # noqa: E501 :rtype: int @@ -167,7 +167,7 @@ def id(self): def id(self, id): """Sets the id of this FuturesPriceTriggeredOrder. - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :param id: The id of this FuturesPriceTriggeredOrder. # noqa: E501 :type: int @@ -179,7 +179,7 @@ def id(self, id): def user(self): """Gets the user of this FuturesPriceTriggeredOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this FuturesPriceTriggeredOrder. # noqa: E501 :rtype: int @@ -190,7 +190,7 @@ def user(self): def user(self, user): """Sets the user of this FuturesPriceTriggeredOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this FuturesPriceTriggeredOrder. # noqa: E501 :type: int @@ -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 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 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 - Types of stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: loss, short position - `close-long-position`: Position stop-profit stop loss, used to close long positions - `close-short-position`: Position stop-profit stop loss, used to close all short positions - `plan-close-long-position`: Position plan take profit and stop loss, used to close long positions in all or part of long positions - `plan-close-short-position`: Position plan stop-profit and stop loss, used to close all short positions or partially close short positions The two types of entrusted order stop-profit and stop-loss are read-only and cannot be passed in through requests # 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. - Types of stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: loss, short position - `close-long-position`: Position stop-profit stop loss, used to close long positions - `close-short-position`: Position stop-profit stop loss, used to close all short positions - `plan-close-long-position`: Position plan take profit and stop loss, used to close long positions in all or part of long positions - `plan-close-short-position`: Position plan stop-profit and stop loss, used to close all short positions or partially close short positions The two types of entrusted order stop-profit and stop-loss are read-only and cannot be passed in through requests # 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 index 3946e2e..fcbc314 100644 --- a/gate_api/models/futures_risk_limit_tier.py +++ b/gate_api/models/futures_risk_limit_tier.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, tier=None, risk_limit=None, initial_rate=None, maintenance_ra def tier(self): """Gets the tier of this FuturesRiskLimitTier. # noqa: E501 - Tier. # noqa: E501 + Tier # noqa: E501 :return: The tier of this FuturesRiskLimitTier. # noqa: E501 :rtype: int @@ -93,7 +93,7 @@ def tier(self): def tier(self, tier): """Sets the tier of this FuturesRiskLimitTier. - Tier. # noqa: E501 + Tier # noqa: E501 :param tier: The tier of this FuturesRiskLimitTier. # noqa: E501 :type: int @@ -105,7 +105,7 @@ def tier(self, tier): def risk_limit(self): """Gets the risk_limit of this FuturesRiskLimitTier. # noqa: E501 - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :return: The risk_limit of this FuturesRiskLimitTier. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def risk_limit(self): def risk_limit(self, risk_limit): """Sets the risk_limit of this FuturesRiskLimitTier. - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :param risk_limit: The risk_limit of this FuturesRiskLimitTier. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def risk_limit(self, risk_limit): def initial_rate(self): """Gets the initial_rate of this FuturesRiskLimitTier. # noqa: E501 - Initial margin rate. # noqa: E501 + Initial margin rate # noqa: E501 :return: The initial_rate of this FuturesRiskLimitTier. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def initial_rate(self): def initial_rate(self, initial_rate): """Sets the initial_rate of this FuturesRiskLimitTier. - Initial margin rate. # noqa: E501 + Initial margin rate # noqa: E501 :param initial_rate: The initial_rate of this FuturesRiskLimitTier. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def initial_rate(self, initial_rate): def maintenance_rate(self): """Gets the maintenance_rate of this FuturesRiskLimitTier. # noqa: E501 - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :return: The maintenance_rate of this FuturesRiskLimitTier. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def maintenance_rate(self): def maintenance_rate(self, maintenance_rate): """Sets the maintenance_rate of this FuturesRiskLimitTier. - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :param maintenance_rate: The maintenance_rate of this FuturesRiskLimitTier. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def maintenance_rate(self, maintenance_rate): def leverage_max(self): """Gets the leverage_max of this FuturesRiskLimitTier. # noqa: E501 - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :return: The leverage_max of this FuturesRiskLimitTier. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def leverage_max(self): def leverage_max(self, leverage_max): """Sets the leverage_max of this FuturesRiskLimitTier. - Maximum leverage. # noqa: E501 + Maximum leverage # noqa: E501 :param leverage_max: The leverage_max of this FuturesRiskLimitTier. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def leverage_max(self, leverage_max): def deduction(self): """Gets the deduction of this FuturesRiskLimitTier. # noqa: E501 - Maintenance margin quick calculation deduction. # noqa: E501 + Maintenance margin quick calculation deduction amount # noqa: E501 :return: The deduction of this FuturesRiskLimitTier. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def deduction(self): def deduction(self, deduction): """Sets the deduction of this FuturesRiskLimitTier. - Maintenance margin quick calculation deduction. # noqa: E501 + Maintenance margin quick calculation deduction amount # noqa: E501 :param deduction: The deduction of this FuturesRiskLimitTier. # noqa: E501 :type: str diff --git a/gate_api/models/futures_ticker.py b/gate_api/models/futures_ticker.py index 6ecbc82..37acc8e 100644 --- a/gate_api/models/futures_ticker.py +++ b/gate_api/models/futures_ticker.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -53,7 +53,12 @@ class FuturesTicker(object): '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 = { @@ -77,11 +82,16 @@ class FuturesTicker(object): '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, 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, 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,6 +118,11 @@ def __init__(self, contract=None, last=None, change_percentage=None, total_size= 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: @@ -152,12 +167,22 @@ 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): """Gets the contract of this FuturesTicker. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesTicker. # noqa: E501 :rtype: str @@ -168,7 +193,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesTicker. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesTicker. # noqa: E501 :type: str @@ -180,7 +205,7 @@ def contract(self, contract): def last(self): """Gets the last of this FuturesTicker. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last of this FuturesTicker. # noqa: E501 :rtype: str @@ -191,7 +216,7 @@ def last(self): def last(self, last): """Sets the last of this FuturesTicker. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last: The last of this FuturesTicker. # noqa: E501 :type: str @@ -203,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 @@ -214,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 @@ -226,7 +251,7 @@ def change_percentage(self, change_percentage): def total_size(self): """Gets the total_size of this FuturesTicker. # noqa: E501 - Contract total size. # noqa: E501 + Contract total size # noqa: E501 :return: The total_size of this FuturesTicker. # noqa: E501 :rtype: str @@ -237,7 +262,7 @@ def total_size(self): def total_size(self, total_size): """Sets the total_size of this FuturesTicker. - Contract total size. # noqa: E501 + Contract total size # noqa: E501 :param total_size: The total_size of this FuturesTicker. # noqa: E501 :type: str @@ -249,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 @@ -260,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 @@ -272,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 @@ -283,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 @@ -295,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 @@ -306,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 @@ -318,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 @@ -329,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 @@ -341,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 @@ -352,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 @@ -364,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 @@ -375,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 @@ -387,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 @@ -398,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 @@ -410,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 @@ -421,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 @@ -433,7 +458,7 @@ def volume_24h_settle(self, volume_24h_settle): def mark_price(self): """Gets the mark_price of this FuturesTicker. # noqa: E501 - Recent mark price. # noqa: E501 + Recent mark price # noqa: E501 :return: The mark_price of this FuturesTicker. # noqa: E501 :rtype: str @@ -444,7 +469,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this FuturesTicker. - Recent mark price. # noqa: E501 + Recent mark price # noqa: E501 :param mark_price: The mark_price of this FuturesTicker. # noqa: E501 :type: str @@ -456,7 +481,7 @@ def mark_price(self, mark_price): def funding_rate(self): """Gets the funding_rate of this FuturesTicker. # noqa: E501 - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :return: The funding_rate of this FuturesTicker. # noqa: E501 :rtype: str @@ -467,7 +492,7 @@ def funding_rate(self): def funding_rate(self, funding_rate): """Sets the funding_rate of this FuturesTicker. - Funding rate. # noqa: E501 + Funding rate # noqa: E501 :param funding_rate: The funding_rate of this FuturesTicker. # noqa: E501 :type: str @@ -479,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. (deprecated. use `funding_rate`). # 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 @@ -490,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. (deprecated. use `funding_rate`). # 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 @@ -502,7 +527,7 @@ def funding_rate_indicative(self, funding_rate_indicative): def index_price(self): """Gets the index_price of this FuturesTicker. # noqa: E501 - Index price. # noqa: E501 + Index price # noqa: E501 :return: The index_price of this FuturesTicker. # noqa: E501 :rtype: str @@ -513,7 +538,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this FuturesTicker. - Index price. # noqa: E501 + Index price # noqa: E501 :param index_price: The index_price of this FuturesTicker. # noqa: E501 :type: str @@ -548,7 +573,7 @@ def quanto_base_rate(self, quanto_base_rate): def lowest_ask(self): """Gets the lowest_ask of this FuturesTicker. # noqa: E501 - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :return: The lowest_ask of this FuturesTicker. # noqa: E501 :rtype: str @@ -559,7 +584,7 @@ def lowest_ask(self): def lowest_ask(self, lowest_ask): """Sets the lowest_ask of this FuturesTicker. - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :param lowest_ask: The lowest_ask of this FuturesTicker. # noqa: E501 :type: str @@ -571,7 +596,7 @@ def lowest_ask(self, lowest_ask): def lowest_size(self): """Gets the lowest_size of this FuturesTicker. # noqa: E501 - The latest seller's lowest price order quantity. # noqa: E501 + The latest seller's lowest price order quantity # noqa: E501 :return: The lowest_size of this FuturesTicker. # noqa: E501 :rtype: str @@ -582,7 +607,7 @@ def lowest_size(self): def lowest_size(self, lowest_size): """Sets the lowest_size of this FuturesTicker. - The latest seller's lowest price order quantity. # noqa: E501 + The latest seller's lowest price order quantity # noqa: E501 :param lowest_size: The lowest_size of this FuturesTicker. # noqa: E501 :type: str @@ -594,7 +619,7 @@ def lowest_size(self, lowest_size): def highest_bid(self): """Gets the highest_bid of this FuturesTicker. # noqa: E501 - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :return: The highest_bid of this FuturesTicker. # noqa: E501 :rtype: str @@ -605,7 +630,7 @@ def highest_bid(self): def highest_bid(self, highest_bid): """Sets the highest_bid of this FuturesTicker. - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :param highest_bid: The highest_bid of this FuturesTicker. # noqa: E501 :type: str @@ -617,7 +642,7 @@ def highest_bid(self, highest_bid): def highest_size(self): """Gets the highest_size of this FuturesTicker. # noqa: E501 - The latest buyer's highest price order volume. # noqa: E501 + The latest buyer's highest price order volume # noqa: E501 :return: The highest_size of this FuturesTicker. # noqa: E501 :rtype: str @@ -628,7 +653,7 @@ def highest_size(self): def highest_size(self, highest_size): """Sets the highest_size of this FuturesTicker. - The latest buyer's highest price order volume. # noqa: E501 + The latest buyer's highest price order volume # noqa: E501 :param highest_size: The highest_size of this FuturesTicker. # noqa: E501 :type: str @@ -636,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 d4cd164..66b45c0 100644 --- a/gate_api/models/futures_trade.py +++ b/gate_api/models/futures_trade.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -156,7 +156,7 @@ def create_time_ms(self, create_time_ms): def contract(self): """Gets the contract of this FuturesTrade. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this FuturesTrade. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this FuturesTrade. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this FuturesTrade. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def contract(self, contract): def size(self): """Gets the size of this FuturesTrade. # noqa: E501 - Trading size. # noqa: E501 + Trading size # noqa: E501 :return: The size of this FuturesTrade. # noqa: E501 :rtype: int @@ -190,7 +190,7 @@ def size(self): def size(self, size): """Sets the size of this FuturesTrade. - Trading size. # noqa: E501 + Trading size # noqa: E501 :param size: The size of this FuturesTrade. # noqa: E501 :type: int @@ -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. 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. 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 fac1cc2..7357ff1 100644 --- a/gate_api/models/index_constituent.py +++ b/gate_api/models/index_constituent.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, exchange=None, symbols=None, local_vars_configuration=None): def exchange(self): """Gets the exchange of this IndexConstituent. # noqa: E501 - Exchange. # noqa: E501 + Exchange # noqa: E501 :return: The exchange of this IndexConstituent. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def exchange(self): def exchange(self, exchange): """Sets the exchange of this IndexConstituent. - Exchange. # noqa: E501 + Exchange # noqa: E501 :param exchange: The exchange of this IndexConstituent. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def exchange(self, exchange): def symbols(self): """Gets the symbols of this IndexConstituent. # noqa: E501 - Symbol list. # noqa: E501 + Symbol list # noqa: E501 :return: The symbols of this IndexConstituent. # noqa: E501 :rtype: list[str] @@ -96,7 +96,7 @@ def symbols(self): def symbols(self, symbols): """Sets the symbols of this IndexConstituent. - Symbol list. # noqa: E501 + Symbol list # noqa: E501 :param symbols: The symbols of this IndexConstituent. # noqa: E501 :type: list[str] diff --git a/gate_api/models/inline_object.py b/gate_api/models/inline_object.py new file mode 100644 index 0000000..a034500 --- /dev/null +++ b/gate_api/models/inline_object.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 InlineObject(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 + """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._mode = None + self._contract = None + self.discriminator = None + + self.mode = mode + self.contract = contract + + @property + def mode(self): + """Gets the mode of this InlineObject. # noqa: E501 + + Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501 + + :return: The mode of this InlineObject. # noqa: E501 + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """Sets the mode of this InlineObject. + + Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode # noqa: E501 + + :param mode: The mode of this InlineObject. # 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 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""" + 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, InlineObject): + 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, InlineObject): + return True + + return self.to_dict() != other.to_dict() diff --git a/gate_api/models/inline_response200.py b/gate_api/models/inline_response200.py index 3ab77b7..171fd14 100644 --- a/gate_api/models/inline_response200.py +++ b/gate_api/models/inline_response200.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 diff --git a/gate_api/models/inline_response2001.py b/gate_api/models/inline_response2001.py index d78ad89..e637913 100644 --- a/gate_api/models/inline_response2001.py +++ b/gate_api/models/inline_response2001.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -83,7 +83,7 @@ def currency(self, currency): def est_rate(self): """Gets the est_rate of this InlineResponse2001. # noqa: E501 - Unconverted percentage. # noqa: E501 + Unconverted percentage # noqa: E501 :return: The est_rate of this InlineResponse2001. # noqa: E501 :rtype: str @@ -94,7 +94,7 @@ def est_rate(self): def est_rate(self, est_rate): """Sets the est_rate of this InlineResponse2001. - Unconverted percentage. # noqa: E501 + Unconverted percentage # noqa: E501 :param est_rate: The est_rate of this InlineResponse2001. # noqa: E501 :type: str diff --git a/gate_api/models/insurance_record.py b/gate_api/models/insurance_record.py index 82b0aac..9ee7e93 100644 --- a/gate_api/models/insurance_record.py +++ b/gate_api/models/insurance_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, t=None, b=None, local_vars_configuration=None): # noqa: E501 def t(self): """Gets the t of this InsuranceRecord. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this InsuranceRecord. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def t(self): def t(self, t): """Sets the t of this InsuranceRecord. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this InsuranceRecord. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def t(self, t): def b(self): """Gets the b of this InsuranceRecord. # noqa: E501 - Insurance balance. # noqa: E501 + Insurance balance # noqa: E501 :return: The b of this InsuranceRecord. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def b(self): def b(self, b): """Sets the b of this InsuranceRecord. - Insurance balance. # noqa: E501 + Insurance balance # noqa: E501 :param b: The b of this InsuranceRecord. # noqa: E501 :type: str diff --git a/gate_api/models/ledger_record.py b/gate_api/models/ledger_record.py index ec95174..c1cd314 100644 --- a/gate_api/models/ledger_record.py +++ b/gate_api/models/ledger_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -109,7 +109,7 @@ def __init__(self, id=None, txid=None, withdraw_order_id=None, timestamp=None, a def id(self): """Gets the id of this LedgerRecord. # noqa: E501 - Record ID. # noqa: E501 + Record ID # noqa: E501 :return: The id of this LedgerRecord. # noqa: E501 :rtype: str @@ -120,7 +120,7 @@ def id(self): def id(self, id): """Sets the id of this LedgerRecord. - Record ID. # noqa: E501 + Record ID # noqa: E501 :param id: The id of this LedgerRecord. # noqa: E501 :type: str @@ -132,7 +132,7 @@ def id(self, id): def txid(self): """Gets the txid of this LedgerRecord. # noqa: E501 - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :return: The txid of this LedgerRecord. # noqa: E501 :rtype: str @@ -143,7 +143,7 @@ def txid(self): def txid(self, txid): """Sets the txid of this LedgerRecord. - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :param txid: The txid of this LedgerRecord. # noqa: E501 :type: str @@ -155,7 +155,7 @@ def txid(self, txid): def withdraw_order_id(self): """Gets the withdraw_order_id of this LedgerRecord. # noqa: E501 - User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried # 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 @@ -166,7 +166,7 @@ def withdraw_order_id(self): def withdraw_order_id(self, withdraw_order_id): """Sets the withdraw_order_id of this LedgerRecord. - User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried # 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 @@ -178,7 +178,7 @@ def withdraw_order_id(self, withdraw_order_id): def timestamp(self): """Gets the timestamp of this LedgerRecord. # noqa: E501 - Operation time. # noqa: E501 + Operation time # noqa: E501 :return: The timestamp of this LedgerRecord. # noqa: E501 :rtype: str @@ -189,7 +189,7 @@ def timestamp(self): def timestamp(self, timestamp): """Sets the timestamp of this LedgerRecord. - Operation time. # noqa: E501 + Operation time # noqa: E501 :param timestamp: The timestamp of this LedgerRecord. # noqa: E501 :type: str @@ -201,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 @@ -212,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 @@ -226,7 +226,7 @@ def amount(self, amount): def currency(self): """Gets the currency of this LedgerRecord. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this LedgerRecord. # noqa: E501 :rtype: str @@ -237,7 +237,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this LedgerRecord. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this LedgerRecord. # noqa: E501 :type: str @@ -251,7 +251,7 @@ def currency(self, currency): def address(self): """Gets the address of this LedgerRecord. # noqa: E501 - Withdrawal address. Required for withdrawals. # noqa: E501 + Withdrawal address. Required for withdrawals # noqa: E501 :return: The address of this LedgerRecord. # noqa: E501 :rtype: str @@ -262,7 +262,7 @@ def address(self): def address(self, address): """Sets the address of this LedgerRecord. - Withdrawal address. Required for withdrawals. # noqa: E501 + Withdrawal address. Required for withdrawals # noqa: E501 :param address: The address of this LedgerRecord. # noqa: E501 :type: str @@ -274,7 +274,7 @@ def address(self, address): def memo(self): """Gets the memo of this LedgerRecord. # noqa: E501 - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :return: The memo of this LedgerRecord. # noqa: E501 :rtype: str @@ -285,7 +285,7 @@ def memo(self): def memo(self, memo): """Sets the memo of this LedgerRecord. - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :param memo: The memo of this LedgerRecord. # noqa: E501 :type: str @@ -297,7 +297,7 @@ def memo(self, memo): def withdraw_id(self): """Gets the withdraw_id of this LedgerRecord. # noqa: E501 - The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time # 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 @@ -308,7 +308,7 @@ def withdraw_id(self): def withdraw_id(self, withdraw_id): """Sets the withdraw_id of this LedgerRecord. - The withdrawal record id starts with w, such as: w1879219868. When withdraw_id is not empty, the value querys this withdrawal record and no longer querys according to time # 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 :param withdraw_id: The withdraw_id of this LedgerRecord. # noqa: E501 :type: str @@ -320,7 +320,7 @@ def withdraw_id(self, withdraw_id): def asset_class(self): """Gets the asset_class of this LedgerRecord. # noqa: E501 - The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone # 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 @@ -331,7 +331,7 @@ def asset_class(self): def asset_class(self, asset_class): """Sets the asset_class of this LedgerRecord. - The currency type of withdrawal record is empty by default. It supports users to query the withdrawal records in the main and innovation areas on demand. Value range: SPOT, PILOT SPOT: Main Zone PILOT: Innovation Zone # 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 :param asset_class: The asset_class of this LedgerRecord. # noqa: E501 :type: str @@ -343,7 +343,7 @@ def asset_class(self, asset_class): 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 - REVIEW: Under review # 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 @@ -354,7 +354,7 @@ 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 - REVIEW: Under review # 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 @@ -366,7 +366,7 @@ def status(self, status): def chain(self): """Gets the chain of this LedgerRecord. # noqa: E501 - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :return: The chain of this LedgerRecord. # noqa: E501 :rtype: str @@ -377,7 +377,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this LedgerRecord. - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :param chain: The chain of this LedgerRecord. # noqa: E501 :type: str diff --git a/gate_api/models/liquidate_order.py b/gate_api/models/liquidate_order.py index e573c7d..97214b5 100644 --- a/gate_api/models/liquidate_order.py +++ b/gate_api/models/liquidate_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -97,7 +97,7 @@ def text(self, text): def currency_pair(self): """Gets the currency_pair of this LiquidateOrder. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this LiquidateOrder. # noqa: E501 :rtype: str @@ -108,7 +108,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this LiquidateOrder. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this LiquidateOrder. # noqa: E501 :type: str @@ -122,7 +122,7 @@ def currency_pair(self, currency_pair): def amount(self): """Gets the amount of this LiquidateOrder. # noqa: E501 - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :return: The amount of this LiquidateOrder. # noqa: E501 :rtype: str @@ -133,7 +133,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this LiquidateOrder. - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :param amount: The amount of this LiquidateOrder. # noqa: E501 :type: str @@ -147,7 +147,7 @@ def amount(self, amount): def price(self): """Gets the price of this LiquidateOrder. # noqa: E501 - Order price. # noqa: E501 + Order price # noqa: E501 :return: The price of this LiquidateOrder. # noqa: E501 :rtype: str @@ -158,7 +158,7 @@ def price(self): def price(self, price): """Sets the price of this LiquidateOrder. - Order price. # noqa: E501 + Order price # noqa: E501 :param price: The price 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/margin_account.py b/gate_api/models/margin_account.py index acd3572..45561e7 100644 --- a/gate_api/models/margin_account.py +++ b/gate_api/models/margin_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, currency_pair=None, account_type=None, leverage=None, locked= def currency_pair(self): """Gets the currency_pair of this MarginAccount. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this MarginAccount. # noqa: E501 :rtype: str @@ -103,7 +103,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this MarginAccount. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this MarginAccount. # noqa: E501 :type: str @@ -115,7 +115,7 @@ def currency_pair(self, currency_pair): def account_type(self): """Gets the account_type of this MarginAccount. # noqa: E501 - Account type, risk - risk rate account, mmr - maintenance margin market not activated # 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 @@ -126,7 +126,7 @@ def account_type(self): def account_type(self, account_type): """Sets the account_type of this MarginAccount. - Account type, risk - risk rate account, mmr - maintenance margin market not activated # noqa: E501 + 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 @@ -138,7 +138,7 @@ def account_type(self, account_type): def leverage(self): """Gets the leverage of this MarginAccount. # noqa: E501 - User current market leverage multiple. # noqa: E501 + User's current market leverage multiplier # noqa: E501 :return: The leverage of this MarginAccount. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this MarginAccount. - User current market leverage multiple. # noqa: E501 + User's current market leverage multiplier # noqa: E501 :param leverage: The leverage of this MarginAccount. # noqa: E501 :type: str @@ -161,7 +161,7 @@ def leverage(self, leverage): 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 @@ -172,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 @@ -184,7 +184,7 @@ def locked(self, locked): def risk(self): """Gets the risk of this MarginAccount. # noqa: E501 - Leveraged Account Current Risk Rate (Returned when the Account is a Risk Rate 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 @@ -195,7 +195,7 @@ def risk(self): def risk(self, risk): """Sets the risk of this MarginAccount. - Leveraged Account Current Risk Rate (Returned when the Account is a Risk Rate 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 diff --git a/gate_api/models/margin_account_book.py b/gate_api/models/margin_account_book.py index 7d4839e..1ee6bbd 100644 --- a/gate_api/models/margin_account_book.py +++ b/gate_api/models/margin_account_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, id=None, time=None, time_ms=None, currency=None, currency_pai def id(self): """Gets the id of this MarginAccountBook. # noqa: E501 - Balance change record ID. # noqa: E501 + Balance change record ID # noqa: E501 :return: The id of this MarginAccountBook. # noqa: E501 :rtype: str @@ -103,7 +103,7 @@ def id(self): def id(self, id): """Sets the id of this MarginAccountBook. - Balance change record ID. # noqa: E501 + Balance change record ID # noqa: E501 :param id: The id of this MarginAccountBook. # noqa: E501 :type: str @@ -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 @@ -138,7 +138,7 @@ def time(self, time): def time_ms(self): """Gets the time_ms of this MarginAccountBook. # noqa: E501 - The timestamp of the change (in milliseconds). # noqa: E501 + The timestamp of the change (in milliseconds) # noqa: E501 :return: The time_ms of this MarginAccountBook. # noqa: E501 :rtype: int @@ -149,7 +149,7 @@ def time_ms(self): def time_ms(self, time_ms): """Sets the time_ms of this MarginAccountBook. - The timestamp of the change (in milliseconds). # noqa: E501 + The timestamp of the change (in milliseconds) # noqa: E501 :param time_ms: The time_ms of this MarginAccountBook. # noqa: E501 :type: int @@ -161,7 +161,7 @@ def time_ms(self, time_ms): def currency(self): """Gets the currency of this MarginAccountBook. # noqa: E501 - Currency changed. # noqa: E501 + Currency changed # noqa: E501 :return: The currency of this MarginAccountBook. # noqa: E501 :rtype: str @@ -172,7 +172,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MarginAccountBook. - Currency changed. # noqa: E501 + Currency changed # noqa: E501 :param currency: The currency 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 @@ -207,7 +207,7 @@ def currency_pair(self, currency_pair): def change(self): """Gets the change of this MarginAccountBook. # noqa: E501 - Amount changed. Positive value means transferring in, while negative out. # noqa: E501 + Amount changed. Positive value means transferring in, while negative out # noqa: E501 :return: The change of this MarginAccountBook. # noqa: E501 :rtype: str @@ -218,7 +218,7 @@ def change(self): def change(self, change): """Sets the change of this MarginAccountBook. - Amount changed. Positive value means transferring in, while negative out. # noqa: E501 + Amount changed. Positive value means transferring in, while negative out # noqa: E501 :param change: The change of this MarginAccountBook. # noqa: E501 :type: str @@ -230,7 +230,7 @@ def change(self, change): def balance(self): """Gets the balance of this MarginAccountBook. # noqa: E501 - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :return: The balance of this MarginAccountBook. # noqa: E501 :rtype: str @@ -241,7 +241,7 @@ def balance(self): def balance(self, balance): """Sets the balance of this MarginAccountBook. - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :param balance: The balance 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 cc82db8..cb96b38 100644 --- a/gate_api/models/margin_account_currency.py +++ b/gate_api/models/margin_account_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, currency=None, available=None, locked=None, borrowed=None, in def currency(self): """Gets the currency of this MarginAccountCurrency. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this MarginAccountCurrency. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MarginAccountCurrency. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this MarginAccountCurrency. # noqa: E501 :type: str @@ -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_leverage_tier.py b/gate_api/models/margin_leverage_tier.py index f0032f5..ebf2237 100644 --- a/gate_api/models/margin_leverage_tier.py +++ b/gate_api/models/margin_leverage_tier.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, upper_limit=None, mmr=None, leverage=None, local_vars_configu def upper_limit(self): """Gets the upper_limit of this MarginLeverageTier. # noqa: E501 - Maximum loan limit. # noqa: E501 + Maximum loan limit # noqa: E501 :return: The upper_limit of this MarginLeverageTier. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def upper_limit(self): def upper_limit(self, upper_limit): """Sets the upper_limit of this MarginLeverageTier. - Maximum loan limit. # noqa: E501 + Maximum loan limit # noqa: E501 :param upper_limit: The upper_limit of this MarginLeverageTier. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def upper_limit(self, upper_limit): def mmr(self): """Gets the mmr of this MarginLeverageTier. # noqa: E501 - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :return: The mmr of this MarginLeverageTier. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def mmr(self): def mmr(self, mmr): """Sets the mmr of this MarginLeverageTier. - Maintenance margin rate. # noqa: E501 + Maintenance margin rate # noqa: E501 :param mmr: The mmr of this MarginLeverageTier. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def mmr(self, mmr): def leverage(self): """Gets the leverage of this MarginLeverageTier. # noqa: E501 - Maximum leverage multiple. # noqa: E501 + Maximum leverage multiple # noqa: E501 :return: The leverage of this MarginLeverageTier. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this MarginLeverageTier. - Maximum leverage multiple. # noqa: E501 + Maximum leverage multiple # noqa: E501 :param leverage: The leverage of this MarginLeverageTier. # noqa: E501 :type: str diff --git a/gate_api/models/margin_market_leverage.py b/gate_api/models/margin_market_leverage.py index 2b6197d..f024010 100644 --- a/gate_api/models/margin_market_leverage.py +++ b/gate_api/models/margin_market_leverage.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -61,7 +61,7 @@ def __init__(self, currency_pair=None, leverage=None, local_vars_configuration=N def currency_pair(self): """Gets the currency_pair of this MarginMarketLeverage. # noqa: E501 - Currency pair. # noqa: E501 + Market # noqa: E501 :return: The currency_pair of this MarginMarketLeverage. # noqa: E501 :rtype: str @@ -72,7 +72,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this MarginMarketLeverage. - Currency pair. # noqa: E501 + Market # noqa: E501 :param currency_pair: The currency_pair of this MarginMarketLeverage. # noqa: E501 :type: str @@ -84,7 +84,7 @@ def currency_pair(self, currency_pair): def leverage(self): """Gets the leverage of this MarginMarketLeverage. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this MarginMarketLeverage. # noqa: E501 :rtype: str @@ -95,7 +95,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this MarginMarketLeverage. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage of this MarginMarketLeverage. # noqa: E501 :type: str diff --git a/gate_api/models/margin_tiers.py b/gate_api/models/margin_tiers.py index b2b52d5..a1bb5e7 100644 --- a/gate_api/models/margin_tiers.py +++ b/gate_api/models/margin_tiers.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, tier=None, margin_rate=None, lower_limit=None, upper_limit=No def tier(self): """Gets the tier of this MarginTiers. # noqa: E501 - Tier. # noqa: E501 + Tier # noqa: E501 :return: The tier of this MarginTiers. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def tier(self): def tier(self, tier): """Sets the tier of this MarginTiers. - Tier. # noqa: E501 + Tier # noqa: E501 :param tier: The tier of this MarginTiers. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def tier(self, tier): def margin_rate(self): """Gets the margin_rate of this MarginTiers. # noqa: E501 - Discount. # noqa: E501 + Discount # noqa: E501 :return: The margin_rate of this MarginTiers. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def margin_rate(self): def margin_rate(self, margin_rate): """Sets the margin_rate of this MarginTiers. - Discount. # noqa: E501 + Discount # noqa: E501 :param margin_rate: The margin_rate of this MarginTiers. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def margin_rate(self, margin_rate): def lower_limit(self): """Gets the lower_limit of this MarginTiers. # noqa: E501 - Lower limit. # noqa: E501 + Lower limit # noqa: E501 :return: The lower_limit of this MarginTiers. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def lower_limit(self): def lower_limit(self, lower_limit): """Sets the lower_limit of this MarginTiers. - Lower limit. # noqa: E501 + Lower limit # noqa: E501 :param lower_limit: The lower_limit of this MarginTiers. # noqa: E501 :type: str @@ -146,7 +146,7 @@ def lower_limit(self, lower_limit): def upper_limit(self): """Gets the upper_limit of this MarginTiers. # noqa: E501 - Upper limit, \"\" indicates greater than (the last tier). # noqa: E501 + Upper limit, \"\" indicates greater than (the last tier) # noqa: E501 :return: The upper_limit of this MarginTiers. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def upper_limit(self): def upper_limit(self, upper_limit): """Sets the upper_limit of this MarginTiers. - Upper limit, \"\" indicates greater than (the last tier). # noqa: E501 + Upper limit, \"\" indicates greater than (the last tier) # noqa: E501 :param upper_limit: The upper_limit of this MarginTiers. # noqa: E501 :type: str @@ -169,7 +169,7 @@ def upper_limit(self, upper_limit): def leverage(self): """Gets the leverage of this MarginTiers. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this MarginTiers. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this MarginTiers. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage of this MarginTiers. # noqa: E501 :type: str diff --git a/gate_api/models/margin_transferable.py b/gate_api/models/margin_transferable.py index cf3f320..4031c74 100644 --- a/gate_api/models/margin_transferable.py +++ b/gate_api/models/margin_transferable.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency=None, currency_pair=None, amount=None, local_vars_co def currency(self): """Gets the currency of this MarginTransferable. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this MarginTransferable. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MarginTransferable. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this MarginTransferable. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency(self, currency): def currency_pair(self): """Gets the currency_pair of this MarginTransferable. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this MarginTransferable. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this MarginTransferable. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this MarginTransferable. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def currency_pair(self, currency_pair): def amount(self): """Gets the amount of this MarginTransferable. # noqa: E501 - Max transferable amount. # noqa: E501 + Max transferable amount # noqa: E501 :return: The amount of this MarginTransferable. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this MarginTransferable. - Max transferable amount. # noqa: E501 + Max transferable amount # noqa: E501 :param amount: The amount of this MarginTransferable. # noqa: E501 :type: str diff --git a/gate_api/models/max_uni_borrowable.py b/gate_api/models/max_uni_borrowable.py index c72038b..5ac2d09 100644 --- a/gate_api/models/max_uni_borrowable.py +++ b/gate_api/models/max_uni_borrowable.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -65,7 +65,7 @@ def __init__(self, currency=None, currency_pair=None, borrowable=None, local_var def currency(self): """Gets the currency of this MaxUniBorrowable. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this MaxUniBorrowable. # noqa: E501 :rtype: str @@ -76,7 +76,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MaxUniBorrowable. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this MaxUniBorrowable. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency(self, currency): def currency_pair(self): """Gets the currency_pair of this MaxUniBorrowable. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this MaxUniBorrowable. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this MaxUniBorrowable. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this MaxUniBorrowable. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def currency_pair(self, currency_pair): def borrowable(self): """Gets the borrowable of this MaxUniBorrowable. # noqa: E501 - Maximum borrowable. # noqa: E501 + Maximum borrowable # noqa: E501 :return: The borrowable of this MaxUniBorrowable. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def borrowable(self): def borrowable(self, borrowable): """Sets the borrowable of this MaxUniBorrowable. - Maximum borrowable. # noqa: E501 + Maximum borrowable # noqa: E501 :param borrowable: The borrowable of this MaxUniBorrowable. # noqa: E501 :type: str diff --git a/gate_api/models/mock_futures_order.py b/gate_api/models/mock_futures_order.py index a9e9674..3adadb8 100644 --- a/gate_api/models/mock_futures_order.py +++ b/gate_api/models/mock_futures_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -114,7 +114,7 @@ def size(self, size): def left(self): """Gets the left of this MockFuturesOrder. # noqa: E501 - Unfilled contract quantity, involved in actual calculation. # noqa: E501 + Unfilled contract quantity, involved in actual calculation # noqa: E501 :return: The left of this MockFuturesOrder. # noqa: E501 :rtype: str @@ -125,7 +125,7 @@ def left(self): def left(self, left): """Sets the left of this MockFuturesOrder. - Unfilled contract quantity, involved in actual calculation. # noqa: E501 + Unfilled contract quantity, involved in actual calculation # noqa: E501 :param left: The left 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 dc054da..158c6a7 100644 --- a/gate_api/models/mock_futures_position.py +++ b/gate_api/models/mock_futures_position.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 d323423..7181f58 100644 --- a/gate_api/models/mock_margin_result.py +++ b/gate_api/models/mock_margin_result.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, type=None, profit_loss_ranges=None, max_loss=None, mr1=None, def type(self): """Gets the type of this MockMarginResult. # noqa: E501 - Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` position # noqa: E501 + Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position # noqa: E501 :return: The type of this MockMarginResult. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def type(self): def type(self, type): """Sets the type of this MockMarginResult. - Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` position # noqa: E501 + Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position # noqa: E501 :param type: The type of this MockMarginResult. # noqa: E501 :type: str @@ -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 3 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 3 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] @@ -156,7 +156,7 @@ def max_loss(self, max_loss): def mr1(self): """Gets the mr1 of this MockMarginResult. # noqa: E501 - Stress testing. # noqa: E501 + Stress testing # noqa: E501 :return: The mr1 of this MockMarginResult. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def mr1(self): def mr1(self, mr1): """Sets the mr1 of this MockMarginResult. - Stress testing. # noqa: E501 + Stress testing # noqa: E501 :param mr1: The mr1 of this MockMarginResult. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def mr1(self, mr1): def mr2(self): """Gets the mr2 of this MockMarginResult. # noqa: E501 - Basis spread risk. # noqa: E501 + Basis spread risk # noqa: E501 :return: The mr2 of this MockMarginResult. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def mr2(self): def mr2(self, mr2): """Sets the mr2 of this MockMarginResult. - Basis spread risk. # noqa: E501 + Basis spread risk # noqa: E501 :param mr2: The mr2 of this MockMarginResult. # noqa: E501 :type: str @@ -202,7 +202,7 @@ def mr2(self, mr2): def mr3(self): """Gets the mr3 of this MockMarginResult. # noqa: E501 - Volatility spread risk. # noqa: E501 + Volatility spread risk # noqa: E501 :return: The mr3 of this MockMarginResult. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def mr3(self): def mr3(self, mr3): """Sets the mr3 of this MockMarginResult. - Volatility spread risk. # noqa: E501 + Volatility spread risk # noqa: E501 :param mr3: The mr3 of this MockMarginResult. # noqa: E501 :type: str @@ -225,7 +225,7 @@ def mr3(self, mr3): def mr4(self): """Gets the mr4 of this MockMarginResult. # noqa: E501 - Option short risk. # noqa: E501 + Option short risk # noqa: E501 :return: The mr4 of this MockMarginResult. # noqa: E501 :rtype: str @@ -236,7 +236,7 @@ def mr4(self): def mr4(self, mr4): """Sets the mr4 of this MockMarginResult. - Option short risk. # noqa: E501 + Option short risk # noqa: E501 :param mr4: The mr4 of this MockMarginResult. # noqa: E501 :type: str diff --git a/gate_api/models/mock_options_order.py b/gate_api/models/mock_options_order.py index ea77569..7a5193c 100644 --- a/gate_api/models/mock_options_order.py +++ b/gate_api/models/mock_options_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -89,7 +89,7 @@ def options_name(self, options_name): def size(self): """Gets the size of this MockOptionsOrder. # noqa: E501 - Initial order quantity, not involved in actual calculation. # noqa: E501 + Initial order quantity, not involved in actual calculation # noqa: E501 :return: The size of this MockOptionsOrder. # noqa: E501 :rtype: str @@ -100,7 +100,7 @@ def size(self): def size(self, size): """Sets the size of this MockOptionsOrder. - Initial order quantity, not involved in actual calculation. # noqa: E501 + Initial order quantity, not involved in actual calculation # noqa: E501 :param size: The size of this MockOptionsOrder. # noqa: E501 :type: str @@ -114,7 +114,7 @@ def size(self, size): def left(self): """Gets the left of this MockOptionsOrder. # noqa: E501 - Unfilled contract quantity, involved in actual calculation. # noqa: E501 + Unfilled contract quantity, involved in actual calculation # noqa: E501 :return: The left of this MockOptionsOrder. # noqa: E501 :rtype: str @@ -125,7 +125,7 @@ def left(self): def left(self, left): """Sets the left of this MockOptionsOrder. - Unfilled contract quantity, involved in actual calculation. # noqa: E501 + Unfilled contract quantity, involved in actual calculation # noqa: E501 :param left: The left 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 ebe07f1..3d27436 100644 --- a/gate_api/models/mock_options_position.py +++ b/gate_api/models/mock_options_position.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 cf5b251..7ae22d4 100644 --- a/gate_api/models/mock_risk_unit.py +++ b/gate_api/models/mock_risk_unit.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, symbol=None, spot_in_use=None, maintain_margin=None, initial_ def symbol(self): """Gets the symbol of this MockRiskUnit. # noqa: E501 - Risk unit name. # noqa: E501 + Risk unit name # noqa: E501 :return: The symbol of this MockRiskUnit. # noqa: E501 :rtype: str @@ -108,7 +108,7 @@ def symbol(self): def symbol(self, symbol): """Sets the symbol of this MockRiskUnit. - Risk unit name. # noqa: E501 + Risk unit name # noqa: E501 :param symbol: The symbol of this MockRiskUnit. # noqa: E501 :type: str @@ -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 @@ -143,7 +143,7 @@ def spot_in_use(self, spot_in_use): def maintain_margin(self): """Gets the maintain_margin of this MockRiskUnit. # noqa: E501 - Maintenance margin. # noqa: E501 + Maintenance margin # noqa: E501 :return: The maintain_margin of this MockRiskUnit. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def maintain_margin(self): def maintain_margin(self, maintain_margin): """Sets the maintain_margin of this MockRiskUnit. - Maintenance margin. # noqa: E501 + Maintenance margin # noqa: E501 :param maintain_margin: The maintain_margin of this MockRiskUnit. # noqa: E501 :type: str @@ -166,7 +166,7 @@ def maintain_margin(self, maintain_margin): def initial_margin(self): """Gets the initial_margin of this MockRiskUnit. # noqa: E501 - Initial margin. # noqa: E501 + Initial margin # noqa: E501 :return: The initial_margin of this MockRiskUnit. # noqa: E501 :rtype: str @@ -177,7 +177,7 @@ def initial_margin(self): def initial_margin(self, initial_margin): """Sets the initial_margin of this MockRiskUnit. - Initial margin. # noqa: E501 + Initial margin # noqa: E501 :param initial_margin: The initial_margin of this MockRiskUnit. # noqa: E501 :type: str @@ -189,7 +189,7 @@ def initial_margin(self, initial_margin): def margin_result(self): """Gets the margin_result of this MockRiskUnit. # noqa: E501 - Margin result. # noqa: E501 + Margin result # noqa: E501 :return: The margin_result of this MockRiskUnit. # noqa: E501 :rtype: list[MockMarginResult] @@ -200,7 +200,7 @@ def margin_result(self): def margin_result(self, margin_result): """Sets the margin_result of this MockRiskUnit. - Margin result. # noqa: E501 + Margin result # noqa: E501 :param margin_result: The margin_result of this MockRiskUnit. # noqa: E501 :type: list[MockMarginResult] @@ -212,7 +212,7 @@ def margin_result(self, margin_result): def delta(self): """Gets the delta of this MockRiskUnit. # noqa: E501 - Total Delta of risk unit. # noqa: E501 + Total Delta of risk unit # noqa: E501 :return: The delta of this MockRiskUnit. # noqa: E501 :rtype: str @@ -223,7 +223,7 @@ def delta(self): def delta(self, delta): """Sets the delta of this MockRiskUnit. - Total Delta of risk unit. # noqa: E501 + Total Delta of risk unit # noqa: E501 :param delta: The delta of this MockRiskUnit. # noqa: E501 :type: str @@ -235,7 +235,7 @@ def delta(self, delta): def gamma(self): """Gets the gamma of this MockRiskUnit. # noqa: E501 - Total Gamma of risk unit. # noqa: E501 + Total Gamma of risk unit # noqa: E501 :return: The gamma of this MockRiskUnit. # noqa: E501 :rtype: str @@ -246,7 +246,7 @@ def gamma(self): def gamma(self, gamma): """Sets the gamma of this MockRiskUnit. - Total Gamma of risk unit. # noqa: E501 + Total Gamma of risk unit # noqa: E501 :param gamma: The gamma of this MockRiskUnit. # noqa: E501 :type: str @@ -258,7 +258,7 @@ def gamma(self, gamma): def theta(self): """Gets the theta of this MockRiskUnit. # noqa: E501 - Total Theta of risk unit. # noqa: E501 + Total Theta of risk unit # noqa: E501 :return: The theta of this MockRiskUnit. # noqa: E501 :rtype: str @@ -269,7 +269,7 @@ def theta(self): def theta(self, theta): """Sets the theta of this MockRiskUnit. - Total Theta of risk unit. # noqa: E501 + Total Theta of risk unit # noqa: E501 :param theta: The theta of this MockRiskUnit. # noqa: E501 :type: str @@ -281,7 +281,7 @@ def theta(self, theta): def vega(self): """Gets the vega of this MockRiskUnit. # noqa: E501 - Total Vega of risk unit. # noqa: E501 + Total Vega of risk unit # noqa: E501 :return: The vega of this MockRiskUnit. # noqa: E501 :rtype: str @@ -292,7 +292,7 @@ def vega(self): def vega(self, vega): """Sets the vega of this MockRiskUnit. - Total Vega of risk unit. # noqa: E501 + Total Vega of risk unit # noqa: E501 :param vega: The vega 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 3631ab7..721cf0b 100644 --- a/gate_api/models/mock_spot_balance.py +++ b/gate_api/models/mock_spot_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -60,7 +60,7 @@ def __init__(self, currency=None, equity=None, local_vars_configuration=None): def currency(self): """Gets the currency of this MockSpotBalance. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this MockSpotBalance. # noqa: E501 :rtype: str @@ -71,7 +71,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MockSpotBalance. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this MockSpotBalance. # noqa: E501 :type: str @@ -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 a6fd363..d8f70cb 100644 --- a/gate_api/models/mock_spot_order.py +++ b/gate_api/models/mock_spot_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -98,7 +98,7 @@ def currency_pairs(self, currency_pairs): def order_price(self): """Gets the order_price of this MockSpotOrder. # noqa: E501 - Price. # noqa: E501 + Price # noqa: E501 :return: The order_price of this MockSpotOrder. # noqa: E501 :rtype: str @@ -109,7 +109,7 @@ def order_price(self): def order_price(self, order_price): """Sets the order_price of this MockSpotOrder. - Price. # noqa: E501 + Price # noqa: E501 :param order_price: The order_price 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 f96d2fa..a18243c 100644 --- a/gate_api/models/multi_chain_address_item.py +++ b/gate_api/models/multi_chain_address_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, chain=None, address=None, payment_id=None, payment_name=None, def chain(self): """Gets the chain of this MultiChainAddressItem. # noqa: E501 - Name of the chain. # noqa: E501 + Name of the chain # noqa: E501 :return: The chain of this MultiChainAddressItem. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this MultiChainAddressItem. - Name of the chain. # noqa: E501 + Name of the chain # noqa: E501 :param chain: The chain of this MultiChainAddressItem. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def chain(self, chain): def address(self): """Gets the address of this MultiChainAddressItem. # noqa: E501 - Deposit address. # noqa: E501 + Deposit address # noqa: E501 :return: The address of this MultiChainAddressItem. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def address(self): def address(self, address): """Sets the address of this MultiChainAddressItem. - Deposit address. # noqa: E501 + Deposit address # noqa: E501 :param address: The address of this MultiChainAddressItem. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def address(self, address): def payment_id(self): """Gets the payment_id of this MultiChainAddressItem. # noqa: E501 - Notes that some currencies required(e.g., Tag, Memo) when depositing. # noqa: E501 + Notes that some currencies required(e.g., Tag, Memo) when depositing # noqa: E501 :return: The payment_id of this MultiChainAddressItem. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def payment_id(self): def payment_id(self, payment_id): """Sets the payment_id of this MultiChainAddressItem. - Notes that some currencies required(e.g., Tag, Memo) when depositing. # noqa: E501 + Notes that some currencies required(e.g., Tag, Memo) when depositing # noqa: E501 :param payment_id: The payment_id of this MultiChainAddressItem. # noqa: E501 :type: str @@ -146,7 +146,7 @@ def payment_id(self, payment_id): def payment_name(self): """Gets the payment_name of this MultiChainAddressItem. # noqa: E501 - Note type, `Tag` or `Memo`. # noqa: E501 + Note type, `Tag` or `Memo` # noqa: E501 :return: The payment_name of this MultiChainAddressItem. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def payment_name(self): def payment_name(self, payment_name): """Sets the payment_name of this MultiChainAddressItem. - Note type, `Tag` or `Memo`. # noqa: E501 + Note type, `Tag` or `Memo` # noqa: E501 :param payment_name: The payment_name of this MultiChainAddressItem. # noqa: E501 :type: str diff --git a/gate_api/models/multi_collateral_currency.py b/gate_api/models/multi_collateral_currency.py index e427bc1..95e5482 100644 --- a/gate_api/models/multi_collateral_currency.py +++ b/gate_api/models/multi_collateral_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, loan_currencies=None, collateral_currencies=None, local_vars_ def loan_currencies(self): """Gets the loan_currencies of this MultiCollateralCurrency. # noqa: E501 - List of supported borrowing currencies. # noqa: E501 + List of supported borrowing currencies # noqa: E501 :return: The loan_currencies of this MultiCollateralCurrency. # noqa: E501 :rtype: list[MultiLoanItem] @@ -73,7 +73,7 @@ def loan_currencies(self): def loan_currencies(self, loan_currencies): """Sets the loan_currencies of this MultiCollateralCurrency. - List of supported borrowing currencies. # noqa: E501 + List of supported borrowing currencies # noqa: E501 :param loan_currencies: The loan_currencies of this MultiCollateralCurrency. # noqa: E501 :type: list[MultiLoanItem] @@ -85,7 +85,7 @@ def loan_currencies(self, loan_currencies): def collateral_currencies(self): """Gets the collateral_currencies of this MultiCollateralCurrency. # noqa: E501 - List of supported collateral currencies. # noqa: E501 + List of supported collateral currencies # noqa: E501 :return: The collateral_currencies of this MultiCollateralCurrency. # noqa: E501 :rtype: list[MultiCollateralItem] @@ -96,7 +96,7 @@ def collateral_currencies(self): def collateral_currencies(self, collateral_currencies): """Sets the collateral_currencies of this MultiCollateralCurrency. - List of supported collateral currencies. # noqa: E501 + List of supported collateral currencies # noqa: E501 :param collateral_currencies: The collateral_currencies of this MultiCollateralCurrency. # noqa: E501 :type: list[MultiCollateralItem] diff --git a/gate_api/models/multi_collateral_item.py b/gate_api/models/multi_collateral_item.py index 6061d1a..82cd1e4 100644 --- a/gate_api/models/multi_collateral_item.py +++ b/gate_api/models/multi_collateral_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency=None, index_price=None, discount=None, local_vars_co def currency(self): """Gets the currency of this MultiCollateralItem. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this MultiCollateralItem. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MultiCollateralItem. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this MultiCollateralItem. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this MultiCollateralItem. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this MultiCollateralItem. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this MultiCollateralItem. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this MultiCollateralItem. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def index_price(self, index_price): def discount(self): """Gets the discount of this MultiCollateralItem. # noqa: E501 - Discount. # noqa: E501 + Discount # noqa: E501 :return: The discount of this MultiCollateralItem. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def discount(self): def discount(self, discount): """Sets the discount of this MultiCollateralItem. - Discount. # noqa: E501 + Discount # noqa: E501 :param discount: The discount of this MultiCollateralItem. # noqa: E501 :type: str diff --git a/gate_api/models/multi_collateral_order.py b/gate_api/models/multi_collateral_order.py index 7102914..24365fa 100644 --- a/gate_api/models/multi_collateral_order.py +++ b/gate_api/models/multi_collateral_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -122,7 +122,7 @@ def __init__(self, order_id=None, order_type=None, fixed_type=None, fixed_rate=N def order_id(self): """Gets the order_id of this MultiCollateralOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this MultiCollateralOrder. # noqa: E501 :rtype: str @@ -133,7 +133,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this MultiCollateralOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this MultiCollateralOrder. # noqa: E501 :type: str @@ -145,7 +145,7 @@ def order_id(self, order_id): def order_type(self): """Gets the order_type of this MultiCollateralOrder. # noqa: E501 - current - current, fixed - fixed. # noqa: E501 + current - current, fixed - fixed # noqa: E501 :return: The order_type of this MultiCollateralOrder. # noqa: E501 :rtype: str @@ -156,7 +156,7 @@ def order_type(self): def order_type(self, order_type): """Sets the order_type of this MultiCollateralOrder. - current - current, fixed - fixed. # noqa: E501 + current - current, fixed - fixed # noqa: E501 :param order_type: The order_type of this MultiCollateralOrder. # noqa: E501 :type: str @@ -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 @@ -191,7 +191,7 @@ def fixed_type(self, fixed_type): def fixed_rate(self): """Gets the fixed_rate of this MultiCollateralOrder. # noqa: E501 - Fixed interest rate. # noqa: E501 + Fixed interest rate # noqa: E501 :return: The fixed_rate of this MultiCollateralOrder. # noqa: E501 :rtype: str @@ -202,7 +202,7 @@ def fixed_rate(self): def fixed_rate(self, fixed_rate): """Sets the fixed_rate of this MultiCollateralOrder. - Fixed interest rate. # noqa: E501 + Fixed interest rate # noqa: E501 :param fixed_rate: The fixed_rate 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 @@ -329,7 +329,7 @@ def status(self, status): def borrow_time(self): """Gets the borrow_time of this MultiCollateralOrder. # noqa: E501 - Borrowing time, timestamp in seconds. # noqa: E501 + Borrowing time, timestamp in seconds # noqa: E501 :return: The borrow_time of this MultiCollateralOrder. # noqa: E501 :rtype: int @@ -340,7 +340,7 @@ def borrow_time(self): def borrow_time(self, borrow_time): """Sets the borrow_time of this MultiCollateralOrder. - Borrowing time, timestamp in seconds. # noqa: E501 + Borrowing time, timestamp in seconds # noqa: E501 :param borrow_time: The borrow_time of this MultiCollateralOrder. # noqa: E501 :type: int @@ -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 @@ -398,7 +398,7 @@ def total_left_collateral_usdt(self, total_left_collateral_usdt): def borrow_currencies(self): """Gets the borrow_currencies of this MultiCollateralOrder. # noqa: E501 - Borrowing Currency List. # noqa: E501 + Borrowing Currency List # noqa: E501 :return: The borrow_currencies of this MultiCollateralOrder. # noqa: E501 :rtype: list[BorrowCurrencyInfo] @@ -409,7 +409,7 @@ def borrow_currencies(self): def borrow_currencies(self, borrow_currencies): """Sets the borrow_currencies of this MultiCollateralOrder. - Borrowing Currency List. # noqa: E501 + Borrowing Currency List # noqa: E501 :param borrow_currencies: The borrow_currencies of this MultiCollateralOrder. # noqa: E501 :type: list[BorrowCurrencyInfo] @@ -421,7 +421,7 @@ def borrow_currencies(self, borrow_currencies): def collateral_currencies(self): """Gets the collateral_currencies of this MultiCollateralOrder. # noqa: E501 - Collateral Currency List. # noqa: E501 + Collateral Currency List # noqa: E501 :return: The collateral_currencies of this MultiCollateralOrder. # noqa: E501 :rtype: list[CollateralCurrencyInfo] @@ -432,7 +432,7 @@ def collateral_currencies(self): def collateral_currencies(self, collateral_currencies): """Sets the collateral_currencies of this MultiCollateralOrder. - Collateral Currency List. # noqa: E501 + Collateral Currency List # noqa: E501 :param collateral_currencies: The collateral_currencies of this MultiCollateralOrder. # noqa: E501 :type: list[CollateralCurrencyInfo] diff --git a/gate_api/models/multi_collateral_record.py b/gate_api/models/multi_collateral_record.py index 934366a..a4bb4a3 100644 --- a/gate_api/models/multi_collateral_record.py +++ b/gate_api/models/multi_collateral_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, order_id=None, record_id=None, before_ltv=None, after_ltv=Non def order_id(self): """Gets the order_id of this MultiCollateralRecord. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this MultiCollateralRecord. # noqa: E501 :rtype: int @@ -98,7 +98,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this MultiCollateralRecord. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this MultiCollateralRecord. # noqa: E501 :type: int @@ -110,7 +110,7 @@ def order_id(self, order_id): def record_id(self): """Gets the record_id of this MultiCollateralRecord. # noqa: E501 - Collateral record ID. # noqa: E501 + Collateral record ID # noqa: E501 :return: The record_id of this MultiCollateralRecord. # noqa: E501 :rtype: int @@ -121,7 +121,7 @@ def record_id(self): def record_id(self, record_id): """Sets the record_id of this MultiCollateralRecord. - Collateral record ID. # noqa: E501 + Collateral record ID # noqa: E501 :param record_id: The record_id of this MultiCollateralRecord. # noqa: E501 :type: int @@ -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 @@ -202,7 +202,7 @@ def operate_time(self, operate_time): def borrow_currencies(self): """Gets the borrow_currencies of this MultiCollateralRecord. # noqa: E501 - Borrowing Currency List. # noqa: E501 + Borrowing Currency List # noqa: E501 :return: The borrow_currencies of this MultiCollateralRecord. # noqa: E501 :rtype: list[MultiCollateralRecordCurrency] @@ -213,7 +213,7 @@ def borrow_currencies(self): def borrow_currencies(self, borrow_currencies): """Sets the borrow_currencies of this MultiCollateralRecord. - Borrowing Currency List. # noqa: E501 + Borrowing Currency List # noqa: E501 :param borrow_currencies: The borrow_currencies of this MultiCollateralRecord. # noqa: E501 :type: list[MultiCollateralRecordCurrency] @@ -225,7 +225,7 @@ def borrow_currencies(self, borrow_currencies): def collateral_currencies(self): """Gets the collateral_currencies of this MultiCollateralRecord. # noqa: E501 - Collateral Currency List. # noqa: E501 + Collateral Currency List # noqa: E501 :return: The collateral_currencies of this MultiCollateralRecord. # noqa: E501 :rtype: list[MultiCollateralRecordCurrency] @@ -236,7 +236,7 @@ def collateral_currencies(self): def collateral_currencies(self, collateral_currencies): """Sets the collateral_currencies of this MultiCollateralRecord. - Collateral Currency List. # noqa: E501 + Collateral Currency List # noqa: E501 :param collateral_currencies: The collateral_currencies of this MultiCollateralRecord. # noqa: E501 :type: list[MultiCollateralRecordCurrency] diff --git a/gate_api/models/multi_collateral_record_currency.py b/gate_api/models/multi_collateral_record_currency.py index f8228fd..c585d49 100644 --- a/gate_api/models/multi_collateral_record_currency.py +++ b/gate_api/models/multi_collateral_record_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, index_price=None, before_amount=None, before_a def currency(self): """Gets the currency of this MultiCollateralRecordCurrency. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this MultiCollateralRecordCurrency. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MultiCollateralRecordCurrency. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this MultiCollateralRecordCurrency. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this MultiCollateralRecordCurrency. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this MultiCollateralRecordCurrency. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this MultiCollateralRecordCurrency. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this MultiCollateralRecordCurrency. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def index_price(self, index_price): def before_amount(self): """Gets the before_amount of this MultiCollateralRecordCurrency. # noqa: E501 - Amount before the operation. # noqa: E501 + Amount before the operation # noqa: E501 :return: The before_amount of this MultiCollateralRecordCurrency. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def before_amount(self): def before_amount(self, before_amount): """Sets the before_amount of this MultiCollateralRecordCurrency. - Amount before the operation. # noqa: E501 + Amount before the operation # noqa: E501 :param before_amount: The before_amount of this MultiCollateralRecordCurrency. # noqa: E501 :type: str @@ -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 4fa410c..02c2dd5 100644 --- a/gate_api/models/multi_loan_item.py +++ b/gate_api/models/multi_loan_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, price=None, local_vars_configuration=None): # def currency(self): """Gets the currency of this MultiLoanItem. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this MultiLoanItem. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MultiLoanItem. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this MultiLoanItem. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def price(self): """Gets the price of this MultiLoanItem. # noqa: E501 - Latest price of the currency. # noqa: E501 + Latest price of the currency # noqa: E501 :return: The price of this MultiLoanItem. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def price(self): def price(self, price): """Sets the price of this MultiLoanItem. - Latest price of the currency. # noqa: E501 + Latest price of the currency # noqa: E501 :param price: The price of this MultiLoanItem. # noqa: E501 :type: str diff --git a/gate_api/models/multi_loan_repay_item.py b/gate_api/models/multi_loan_repay_item.py index d95fb06..40d09f8 100644 --- a/gate_api/models/multi_loan_repay_item.py +++ b/gate_api/models/multi_loan_repay_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -60,14 +60,13 @@ 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): """Gets the currency of this MultiLoanRepayItem. # noqa: E501 - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :return: The currency of this MultiLoanRepayItem. # noqa: E501 :rtype: str @@ -78,7 +77,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this MultiLoanRepayItem. - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :param currency: The currency of this MultiLoanRepayItem. # noqa: E501 :type: str @@ -90,7 +89,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this MultiLoanRepayItem. # noqa: E501 - Size. # noqa: E501 + Size # noqa: E501 :return: The amount of this MultiLoanRepayItem. # noqa: E501 :rtype: str @@ -101,7 +100,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this MultiLoanRepayItem. - Size. # noqa: E501 + Size # noqa: E501 :param amount: The amount of this MultiLoanRepayItem. # noqa: E501 :type: str @@ -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 e648539..82e18fc 100644 --- a/gate_api/models/multi_repay_record.py +++ b/gate_api/models/multi_repay_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -112,7 +112,7 @@ def __init__(self, order_id=None, record_id=None, init_ltv=None, before_ltv=None def order_id(self): """Gets the order_id of this MultiRepayRecord. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this MultiRepayRecord. # noqa: E501 :rtype: int @@ -123,7 +123,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this MultiRepayRecord. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this MultiRepayRecord. # noqa: E501 :type: int @@ -135,7 +135,7 @@ def order_id(self, order_id): def record_id(self): """Gets the record_id of this MultiRepayRecord. # noqa: E501 - Repayment record ID. # noqa: E501 + Repayment record ID # noqa: E501 :return: The record_id of this MultiRepayRecord. # noqa: E501 :rtype: int @@ -146,7 +146,7 @@ def record_id(self): def record_id(self, record_id): """Sets the record_id of this MultiRepayRecord. - Repayment record ID. # noqa: E501 + Repayment record ID # noqa: E501 :param record_id: The record_id of this MultiRepayRecord. # noqa: E501 :type: int @@ -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 @@ -181,7 +181,7 @@ def init_ltv(self, init_ltv): def before_ltv(self): """Gets the before_ltv of this MultiRepayRecord. # noqa: E501 - Ltv before the operation. # noqa: E501 + Ltv before the operation # noqa: E501 :return: The before_ltv of this MultiRepayRecord. # noqa: E501 :rtype: str @@ -192,7 +192,7 @@ def before_ltv(self): def before_ltv(self, before_ltv): """Sets the before_ltv of this MultiRepayRecord. - Ltv before the operation. # noqa: E501 + Ltv before the operation # noqa: E501 :param before_ltv: The before_ltv of this MultiRepayRecord. # noqa: E501 :type: str @@ -204,7 +204,7 @@ def before_ltv(self, before_ltv): def after_ltv(self): """Gets the after_ltv of this MultiRepayRecord. # noqa: E501 - Ltv after the operation. # noqa: E501 + Ltv after the operation # noqa: E501 :return: The after_ltv of this MultiRepayRecord. # noqa: E501 :rtype: str @@ -215,7 +215,7 @@ def after_ltv(self): def after_ltv(self, after_ltv): """Sets the after_ltv of this MultiRepayRecord. - Ltv after the operation. # noqa: E501 + Ltv after the operation # noqa: E501 :param after_ltv: The after_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 @@ -273,7 +273,7 @@ def repay_time(self, repay_time): def borrow_currencies(self): """Gets the borrow_currencies of this MultiRepayRecord. # noqa: E501 - List of borrowing information. # noqa: E501 + List of borrowing information # noqa: E501 :return: The borrow_currencies of this MultiRepayRecord. # noqa: E501 :rtype: list[RepayRecordCurrency] @@ -284,7 +284,7 @@ def borrow_currencies(self): def borrow_currencies(self, borrow_currencies): """Sets the borrow_currencies of this MultiRepayRecord. - List of borrowing information. # noqa: E501 + List of borrowing information # noqa: E501 :param borrow_currencies: The borrow_currencies of this MultiRepayRecord. # noqa: E501 :type: list[RepayRecordCurrency] @@ -296,7 +296,7 @@ def borrow_currencies(self, borrow_currencies): def collateral_currencies(self): """Gets the collateral_currencies of this MultiRepayRecord. # noqa: E501 - List of collateral information. # noqa: E501 + List of collateral information # noqa: E501 :return: The collateral_currencies of this MultiRepayRecord. # noqa: E501 :rtype: list[RepayRecordCurrency] @@ -307,7 +307,7 @@ def collateral_currencies(self): def collateral_currencies(self, collateral_currencies): """Sets the collateral_currencies of this MultiRepayRecord. - List of collateral information. # noqa: E501 + List of collateral information # noqa: E501 :param collateral_currencies: The collateral_currencies of this MultiRepayRecord. # noqa: E501 :type: list[RepayRecordCurrency] @@ -319,7 +319,7 @@ def collateral_currencies(self, collateral_currencies): def repaid_currencies(self): """Gets the repaid_currencies of this MultiRepayRecord. # noqa: E501 - Repay Currency List. # noqa: E501 + Repay Currency List # noqa: E501 :return: The repaid_currencies of this MultiRepayRecord. # noqa: E501 :rtype: list[RepayRecordRepaidCurrency] @@ -330,7 +330,7 @@ def repaid_currencies(self): def repaid_currencies(self, repaid_currencies): """Sets the repaid_currencies of this MultiRepayRecord. - Repay Currency List. # noqa: E501 + Repay Currency List # noqa: E501 :param repaid_currencies: The repaid_currencies of this MultiRepayRecord. # noqa: E501 :type: list[RepayRecordRepaidCurrency] @@ -342,7 +342,7 @@ def repaid_currencies(self, repaid_currencies): def total_interest_list(self): """Gets the total_interest_list of this MultiRepayRecord. # noqa: E501 - Total Interest List. # noqa: E501 + Total Interest List # noqa: E501 :return: The total_interest_list of this MultiRepayRecord. # noqa: E501 :rtype: list[RepayRecordTotalInterest] @@ -353,7 +353,7 @@ def total_interest_list(self): def total_interest_list(self, total_interest_list): """Sets the total_interest_list of this MultiRepayRecord. - Total Interest List. # noqa: E501 + Total Interest List # noqa: E501 :param total_interest_list: The total_interest_list of this MultiRepayRecord. # noqa: E501 :type: list[RepayRecordTotalInterest] @@ -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 ec33cf0..bb2f880 100644 --- a/gate_api/models/multi_repay_resp.py +++ b/gate_api/models/multi_repay_resp.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, order_id=None, repaid_currencies=None, local_vars_configurati def order_id(self): """Gets the order_id of this MultiRepayResp. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this MultiRepayResp. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this MultiRepayResp. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this MultiRepayResp. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def order_id(self, order_id): def repaid_currencies(self): """Gets the repaid_currencies of this MultiRepayResp. # noqa: E501 - Repay Currency List. # noqa: E501 + Repay Currency List # noqa: E501 :return: The repaid_currencies of this MultiRepayResp. # noqa: E501 :rtype: list[RepayCurrencyRes] @@ -96,7 +96,7 @@ def repaid_currencies(self): def repaid_currencies(self, repaid_currencies): """Sets the repaid_currencies of this MultiRepayResp. - Repay Currency List. # noqa: E501 + Repay Currency List # noqa: E501 :param repaid_currencies: The repaid_currencies of this MultiRepayResp. # noqa: E501 :type: list[RepayCurrencyRes] diff --git a/gate_api/models/my_futures_trade.py b/gate_api/models/my_futures_trade.py index 59af70c..4066f32 100644 --- a/gate_api/models/my_futures_trade.py +++ b/gate_api/models/my_futures_trade.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -153,7 +153,7 @@ def create_time(self, create_time): def contract(self): """Gets the contract of this MyFuturesTrade. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this MyFuturesTrade. # noqa: E501 :rtype: str @@ -164,7 +164,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this MyFuturesTrade. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this MyFuturesTrade. # noqa: E501 :type: str @@ -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 @@ -199,7 +199,7 @@ def order_id(self, order_id): def size(self): """Gets the size of this MyFuturesTrade. # noqa: E501 - Trading size. # noqa: E501 + Trading size # noqa: E501 :return: The size of this MyFuturesTrade. # noqa: E501 :rtype: int @@ -210,7 +210,7 @@ def size(self): def size(self, size): """Sets the size of this MyFuturesTrade. - Trading size. # noqa: E501 + Trading size # noqa: E501 :param size: The size of this MyFuturesTrade. # noqa: E501 :type: int @@ -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 > 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 > 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 a6589ca..81e915b 100644 --- a/gate_api/models/my_futures_trade_time_range.py +++ b/gate_api/models/my_futures_trade_time_range.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -153,7 +153,7 @@ def create_time(self, create_time): def contract(self): """Gets the contract of this MyFuturesTradeTimeRange. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this MyFuturesTradeTimeRange. # noqa: E501 :rtype: str @@ -164,7 +164,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this MyFuturesTradeTimeRange. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this MyFuturesTradeTimeRange. # noqa: E501 :type: str @@ -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 @@ -199,7 +199,7 @@ def order_id(self, order_id): def size(self): """Gets the size of this MyFuturesTradeTimeRange. # noqa: E501 - Trading size. # noqa: E501 + Trading size # noqa: E501 :return: The size of this MyFuturesTradeTimeRange. # noqa: E501 :rtype: int @@ -210,7 +210,7 @@ def size(self): def size(self, size): """Sets the size of this MyFuturesTradeTimeRange. - Trading size. # noqa: E501 + Trading size # noqa: E501 :param size: The size of this MyFuturesTradeTimeRange. # noqa: E501 :type: int @@ -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 > 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 > 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 46f20a4..4d856f3 100644 --- a/gate_api/models/open_orders.py +++ b/gate_api/models/open_orders.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency_pair=None, total=None, orders=None, local_vars_confi def currency_pair(self): """Gets the currency_pair of this OpenOrders. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this OpenOrders. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this OpenOrders. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this OpenOrders. # noqa: E501 :type: str @@ -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 051f2bb..e05a45c 100644 --- a/gate_api/models/options_account.py +++ b/gate_api/models/options_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -147,7 +147,7 @@ def __init__(self, user=None, total=None, position_value=None, equity=None, shor def user(self): """Gets the user of this OptionsAccount. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this OptionsAccount. # noqa: E501 :rtype: int @@ -158,7 +158,7 @@ def user(self): def user(self, user): """Sets the user of this OptionsAccount. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this OptionsAccount. # noqa: E501 :type: int @@ -170,7 +170,7 @@ def user(self, user): def total(self): """Gets the total of this OptionsAccount. # noqa: E501 - Account balance. # 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. - Account balance. # noqa: E501 + Account Balance # noqa: E501 :param total: The total 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 - Account equity, the sum of account balance and position value. # 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. - Account equity, the sum of account balance and position value. # 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 @@ -239,7 +239,7 @@ def equity(self, equity): def short_enabled(self): """Gets the short_enabled of this OptionsAccount. # noqa: E501 - If the account is allowed to short. # noqa: E501 + If the account is allowed to short # noqa: E501 :return: The short_enabled of this OptionsAccount. # noqa: E501 :rtype: bool @@ -250,7 +250,7 @@ def short_enabled(self): def short_enabled(self, short_enabled): """Sets the short_enabled of this OptionsAccount. - If the account is allowed to short. # noqa: E501 + If the account is allowed to short # noqa: E501 :param short_enabled: The short_enabled of this OptionsAccount. # noqa: E501 :type: bool @@ -262,7 +262,7 @@ def short_enabled(self, short_enabled): def mmp_enabled(self): """Gets the mmp_enabled of this OptionsAccount. # noqa: E501 - Whether to enable 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. - Whether to enable 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 - Whether to trigger position liquidation. # 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. - Whether to trigger position liquidation. # noqa: E501 + Whether to trigger position liquidation # noqa: E501 :param liq_triggered: The liq_triggered of this OptionsAccount. # noqa: E501 :type: bool @@ -337,7 +337,7 @@ def margin_mode(self, margin_mode): def unrealised_pnl(self): """Gets the unrealised_pnl of this OptionsAccount. # noqa: E501 - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :return: The unrealised_pnl of this OptionsAccount. # noqa: E501 :rtype: str @@ -348,7 +348,7 @@ def unrealised_pnl(self): def unrealised_pnl(self, unrealised_pnl): """Sets the unrealised_pnl of this OptionsAccount. - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :param unrealised_pnl: The unrealised_pnl of this OptionsAccount. # noqa: E501 :type: str @@ -360,7 +360,7 @@ def unrealised_pnl(self, unrealised_pnl): def init_margin(self): """Gets the init_margin of this OptionsAccount. # noqa: E501 - Initial position margin. # noqa: E501 + Initial position margin # noqa: E501 :return: The init_margin of this OptionsAccount. # noqa: E501 :rtype: str @@ -371,7 +371,7 @@ def init_margin(self): def init_margin(self, init_margin): """Sets the init_margin of this OptionsAccount. - Initial position margin. # noqa: E501 + Initial position margin # noqa: E501 :param init_margin: The init_margin of this OptionsAccount. # noqa: E501 :type: str @@ -383,7 +383,7 @@ def init_margin(self, init_margin): def maint_margin(self): """Gets the maint_margin of this OptionsAccount. # noqa: E501 - Position maintenance margin. # noqa: E501 + Position maintenance margin # noqa: E501 :return: The maint_margin of this OptionsAccount. # noqa: E501 :rtype: str @@ -394,7 +394,7 @@ def maint_margin(self): def maint_margin(self, maint_margin): """Sets the maint_margin of this OptionsAccount. - Position maintenance margin. # noqa: E501 + Position maintenance margin # noqa: E501 :param maint_margin: The maint_margin of this OptionsAccount. # noqa: E501 :type: str @@ -406,7 +406,7 @@ def maint_margin(self, maint_margin): def order_margin(self): """Gets the order_margin of this OptionsAccount. # noqa: E501 - Order margin of unfinished orders. # noqa: E501 + Order margin of unfinished orders # noqa: E501 :return: The order_margin of this OptionsAccount. # noqa: E501 :rtype: str @@ -417,7 +417,7 @@ def order_margin(self): def order_margin(self, order_margin): """Sets the order_margin of this OptionsAccount. - Order margin of unfinished orders. # noqa: E501 + Order margin of unfinished orders # noqa: E501 :param order_margin: The order_margin of this OptionsAccount. # noqa: E501 :type: str @@ -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 - Margin for outstanding sell orders. # 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. - Margin for outstanding sell orders. # 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 - Margin for outstanding buy orders. # 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. - Margin for outstanding buy orders. # noqa: E501 + Margin for outstanding buy orders # noqa: E501 :param bid_order_margin: The bid_order_margin of this OptionsAccount. # noqa: E501 :type: str @@ -475,7 +475,7 @@ def bid_order_margin(self, bid_order_margin): def available(self): """Gets the available of this OptionsAccount. # noqa: E501 - Available balance to transfer out or trade. # noqa: E501 + Available balance to transfer out or trade # noqa: E501 :return: The available of this OptionsAccount. # noqa: E501 :rtype: str @@ -486,7 +486,7 @@ def available(self): def available(self, available): """Sets the available of this OptionsAccount. - Available balance to transfer out or trade. # noqa: E501 + Available balance to transfer out or trade # noqa: E501 :param available: The available 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 - Maximum number of outstanding orders. # 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. - Maximum number of outstanding orders. # noqa: E501 + Maximum number of outstanding orders # noqa: E501 :param orders_limit: The orders_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 e2947b8..e2809e2 100644 --- a/gate_api/models/options_account_book.py +++ b/gate_api/models/options_account_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, time=None, change=None, balance=None, type=None, text=None, l def time(self): """Gets the time of this OptionsAccountBook. # noqa: E501 - Change time. # noqa: E501 + Change time # noqa: E501 :return: The time of this OptionsAccountBook. # noqa: E501 :rtype: float @@ -88,7 +88,7 @@ def time(self): def time(self, time): """Sets the time of this OptionsAccountBook. - Change time. # noqa: E501 + Change time # noqa: E501 :param time: The time of this OptionsAccountBook. # noqa: E501 :type: float @@ -100,7 +100,7 @@ def time(self, time): def change(self): """Gets the change of this OptionsAccountBook. # noqa: E501 - Amount changed (USDT). # noqa: E501 + Amount changed (USDT) # noqa: E501 :return: The change of this OptionsAccountBook. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def change(self): def change(self, change): """Sets the change of this OptionsAccountBook. - Amount changed (USDT). # noqa: E501 + Amount changed (USDT) # noqa: E501 :param change: The change of this OptionsAccountBook. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def change(self, change): def balance(self): """Gets the balance of this OptionsAccountBook. # noqa: E501 - Account total balance after change (USDT). # noqa: E501 + Account total balance after change (USDT) # noqa: E501 :return: The balance of this OptionsAccountBook. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def balance(self): def balance(self, balance): """Sets the balance of this OptionsAccountBook. - Account total balance after change (USDT). # noqa: E501 + Account total balance after change (USDT) # noqa: E501 :param balance: The balance 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 8dae262..a41ffe9 100644 --- a/gate_api/models/options_candlestick.py +++ b/gate_api/models/options_candlestick.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, t=None, v=None, c=None, h=None, l=None, o=None, local_vars_co def t(self): """Gets the t of this OptionsCandlestick. # noqa: E501 - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :return: The t of this OptionsCandlestick. # noqa: E501 :rtype: float @@ -93,7 +93,7 @@ def t(self): def t(self, t): """Sets the t of this OptionsCandlestick. - Unix timestamp in seconds. # noqa: E501 + Unix timestamp in seconds # noqa: E501 :param t: The t of this OptionsCandlestick. # noqa: E501 :type: float @@ -105,7 +105,7 @@ def t(self, t): def v(self): """Gets the v of this OptionsCandlestick. # noqa: E501 - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :return: The v of this OptionsCandlestick. # noqa: E501 :rtype: int @@ -116,7 +116,7 @@ def v(self): def v(self, v): """Sets the v of this OptionsCandlestick. - size volume (contract size). Only returned if `contract` is not prefixed. # noqa: E501 + size volume (contract size). Only returned if `contract` is not prefixed # noqa: E501 :param v: The v of this OptionsCandlestick. # noqa: E501 :type: int @@ -128,7 +128,7 @@ def v(self, v): def c(self): """Gets the c of this OptionsCandlestick. # noqa: E501 - Close price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Close price (quote currency, unit: underlying corresponding option price) # noqa: E501 :return: The c of this OptionsCandlestick. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def c(self): def c(self, c): """Sets the c of this OptionsCandlestick. - Close price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Close price (quote currency, unit: underlying corresponding option price) # noqa: E501 :param c: The c of this OptionsCandlestick. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def h(self, h): def l(self): """Gets the l of this OptionsCandlestick. # noqa: E501 - Lowest price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Lowest price (quote currency, unit: underlying corresponding option price) # noqa: E501 :return: The l of this OptionsCandlestick. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def l(self): def l(self, l): """Sets the l of this OptionsCandlestick. - Lowest price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Lowest price (quote currency, unit: underlying corresponding option price) # noqa: E501 :param l: The l of this OptionsCandlestick. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def l(self, l): def o(self): """Gets the o of this OptionsCandlestick. # noqa: E501 - Open price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Open price (quote currency, unit: underlying corresponding option price) # noqa: E501 :return: The o of this OptionsCandlestick. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def o(self): def o(self, o): """Sets the o of this OptionsCandlestick. - Open price (quote currency, unit: underlying corresponding option price). # noqa: E501 + Open price (quote currency, unit: underlying corresponding option price) # noqa: E501 :param o: The o of this OptionsCandlestick. # noqa: E501 :type: str diff --git a/gate_api/models/options_contract.py b/gate_api/models/options_contract.py index 52c7883..2aec77e 100644 --- a/gate_api/models/options_contract.py +++ b/gate_api/models/options_contract.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -177,7 +177,7 @@ def __init__(self, name=None, tag=None, create_time=None, expiration_time=None, def name(self): """Gets the name of this OptionsContract. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The name of this OptionsContract. # noqa: E501 :rtype: str @@ -188,7 +188,7 @@ def name(self): def name(self, name): """Sets the name of this OptionsContract. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param name: The name of this OptionsContract. # noqa: E501 :type: str @@ -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 @@ -246,7 +246,7 @@ def create_time(self, create_time): def expiration_time(self): """Gets the expiration_time of this OptionsContract. # noqa: E501 - Expiration time. # noqa: E501 + Expiration time # noqa: E501 :return: The expiration_time of this OptionsContract. # noqa: E501 :rtype: float @@ -257,7 +257,7 @@ def expiration_time(self): def expiration_time(self, expiration_time): """Sets the expiration_time of this OptionsContract. - Expiration time. # noqa: E501 + Expiration time # noqa: E501 :param expiration_time: The expiration_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 @@ -292,7 +292,7 @@ def is_call(self, is_call): def multiplier(self): """Gets the multiplier of this OptionsContract. # noqa: E501 - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :return: The multiplier of this OptionsContract. # noqa: E501 :rtype: str @@ -303,7 +303,7 @@ def multiplier(self): def multiplier(self, multiplier): """Sets the multiplier of this OptionsContract. - Multiplier used in converting from invoicing to settlement currency. # noqa: E501 + Multiplier used in converting from invoicing to settlement currency # noqa: E501 :param multiplier: The multiplier of this OptionsContract. # noqa: E501 :type: str @@ -315,7 +315,7 @@ def multiplier(self, multiplier): def underlying(self): """Gets the underlying of this OptionsContract. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this OptionsContract. # noqa: E501 :rtype: str @@ -326,7 +326,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this OptionsContract. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this OptionsContract. # noqa: E501 :type: str @@ -338,7 +338,7 @@ def underlying(self, underlying): def underlying_price(self): """Gets the underlying_price of this OptionsContract. # noqa: E501 - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :return: The underlying_price of this OptionsContract. # noqa: E501 :rtype: str @@ -349,7 +349,7 @@ def underlying_price(self): def underlying_price(self, underlying_price): """Sets the underlying_price of this OptionsContract. - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :param underlying_price: The underlying_price of this OptionsContract. # noqa: E501 :type: str @@ -361,7 +361,7 @@ def underlying_price(self, underlying_price): def last_price(self): """Gets the last_price of this OptionsContract. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last_price of this OptionsContract. # noqa: E501 :rtype: str @@ -372,7 +372,7 @@ def last_price(self): def last_price(self, last_price): """Sets the last_price of this OptionsContract. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last_price: The last_price of this OptionsContract. # noqa: E501 :type: str @@ -384,7 +384,7 @@ def last_price(self, last_price): def mark_price(self): """Gets the mark_price of this OptionsContract. # noqa: E501 - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :return: The mark_price of this OptionsContract. # noqa: E501 :rtype: str @@ -395,7 +395,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this OptionsContract. - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :param mark_price: The mark_price of this OptionsContract. # noqa: E501 :type: str @@ -407,7 +407,7 @@ def mark_price(self, mark_price): def index_price(self): """Gets the index_price of this OptionsContract. # noqa: E501 - Current index price (quote currency). # noqa: E501 + Current index price (quote currency) # noqa: E501 :return: The index_price of this OptionsContract. # noqa: E501 :rtype: str @@ -418,7 +418,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this OptionsContract. - Current index price (quote currency). # noqa: E501 + Current index price (quote currency) # noqa: E501 :param index_price: The index_price of this OptionsContract. # noqa: E501 :type: str @@ -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 @@ -453,7 +453,7 @@ def maker_fee_rate(self, maker_fee_rate): def taker_fee_rate(self): """Gets the taker_fee_rate of this OptionsContract. # noqa: E501 - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :return: The taker_fee_rate of this OptionsContract. # noqa: E501 :rtype: str @@ -464,7 +464,7 @@ def taker_fee_rate(self): def taker_fee_rate(self, taker_fee_rate): """Sets the taker_fee_rate of this OptionsContract. - Taker fee rate. # noqa: E501 + Taker fee rate # noqa: E501 :param taker_fee_rate: The taker_fee_rate of this OptionsContract. # noqa: E501 :type: str @@ -476,7 +476,7 @@ def taker_fee_rate(self, taker_fee_rate): def order_price_round(self): """Gets the order_price_round of this OptionsContract. # noqa: E501 - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :return: The order_price_round of this OptionsContract. # noqa: E501 :rtype: str @@ -487,7 +487,7 @@ def order_price_round(self): def order_price_round(self, order_price_round): """Sets the order_price_round of this OptionsContract. - Minimum order price increment. # noqa: E501 + Minimum order price increment # noqa: E501 :param order_price_round: The order_price_round of this OptionsContract. # noqa: E501 :type: str @@ -499,7 +499,7 @@ def order_price_round(self, order_price_round): def mark_price_round(self): """Gets the mark_price_round of this OptionsContract. # noqa: E501 - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :return: The mark_price_round of this OptionsContract. # noqa: E501 :rtype: str @@ -510,7 +510,7 @@ def mark_price_round(self): def mark_price_round(self, mark_price_round): """Sets the mark_price_round of this OptionsContract. - Minimum mark price increment. # noqa: E501 + Minimum mark price increment # noqa: E501 :param mark_price_round: The mark_price_round 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 `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 `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 @@ -660,7 +660,7 @@ def orderbook_id(self, orderbook_id): def trade_id(self): """Gets the trade_id of this OptionsContract. # noqa: E501 - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :return: The trade_id of this OptionsContract. # noqa: E501 :rtype: int @@ -671,7 +671,7 @@ def trade_id(self): def trade_id(self, trade_id): """Sets the trade_id of this OptionsContract. - Current trade ID. # noqa: E501 + Current trade ID # noqa: E501 :param trade_id: The trade_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 @@ -706,7 +706,7 @@ def trade_size(self, trade_size): def position_size(self): """Gets the position_size of this OptionsContract. # noqa: E501 - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :return: The position_size of this OptionsContract. # noqa: E501 :rtype: int @@ -717,7 +717,7 @@ def position_size(self): def position_size(self, position_size): """Sets the position_size of this OptionsContract. - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :param position_size: The position_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 44c0790..5594392 100644 --- a/gate_api/models/options_mmp.py +++ b/gate_api/models/options_mmp.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, underlying=None, window=None, frozen_period=None, qty_limit=N def underlying(self): """Gets the underlying of this OptionsMMP. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this OptionsMMP. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this OptionsMMP. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this OptionsMMP. # noqa: E501 :type: str @@ -107,7 +107,7 @@ def underlying(self, underlying): def window(self): """Gets the window of this OptionsMMP. # noqa: E501 - Time window (milliseconds), between 1-5000, 0 means disabling 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. - Time window (milliseconds), between 1-5000, 0 means disabling 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 @@ -157,7 +157,7 @@ def frozen_period(self, frozen_period): def qty_limit(self): """Gets the qty_limit of this OptionsMMP. # noqa: E501 - Trading volume upper limit (positive number, up to 2 decimal places). # 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. - Trading volume upper limit (positive number, up to 2 decimal places). # 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 - Upper limit of net delta value (positive number, up to 2 decimal places). # 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. - Upper limit of net delta value (positive number, up to 2 decimal places). # 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 - Trigger freeze time (milliseconds), 0 means no freeze is triggered. # 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. - Trigger freeze time (milliseconds), 0 means no freeze is triggered. # 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 - Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. # 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. - Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. # 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 31678d9..78658ba 100644 --- a/gate_api/models/options_mmp_reset.py +++ b/gate_api/models/options_mmp_reset.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -86,7 +86,7 @@ def __init__(self, underlying=None, window=None, frozen_period=None, qty_limit=N def underlying(self): """Gets the underlying of this OptionsMMPReset. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this OptionsMMPReset. # noqa: E501 :rtype: str @@ -97,7 +97,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this OptionsMMPReset. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this OptionsMMPReset. # noqa: E501 :type: str @@ -111,7 +111,7 @@ def underlying(self, underlying): def window(self): """Gets the window of this OptionsMMPReset. # noqa: E501 - Time window (milliseconds), between 1-5000, 0 means disabling 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. - Time window (milliseconds), between 1-5000, 0 means disabling 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 @@ -157,7 +157,7 @@ def frozen_period(self, frozen_period): def qty_limit(self): """Gets the qty_limit of this OptionsMMPReset. # noqa: E501 - Trading volume upper limit (positive number, up to 2 decimal places). # 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. - Trading volume upper limit (positive number, up to 2 decimal places). # 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 - Upper limit of net delta value (positive number, up to 2 decimal places). # 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. - Upper limit of net delta value (positive number, up to 2 decimal places). # 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 - Trigger freeze time (milliseconds), 0 means no freeze is triggered. # 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. - Trigger freeze time (milliseconds), 0 means no freeze is triggered. # 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 - Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. # 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. - Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. # 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 c02472e..24db92e 100644 --- a/gate_api/models/options_my_settlements.py +++ b/gate_api/models/options_my_settlements.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, time=None, underlying=None, contract=None, strike_price=None, def time(self): """Gets the time of this OptionsMySettlements. # noqa: E501 - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :return: The time of this OptionsMySettlements. # noqa: E501 :rtype: float @@ -108,7 +108,7 @@ def time(self): def time(self, time): """Sets the time of this OptionsMySettlements. - Settlement time. # noqa: E501 + Settlement time # noqa: E501 :param time: The time of this OptionsMySettlements. # noqa: E501 :type: float @@ -120,7 +120,7 @@ def time(self, time): def underlying(self): """Gets the underlying of this OptionsMySettlements. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this OptionsMySettlements. # noqa: E501 :rtype: str @@ -131,7 +131,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this OptionsMySettlements. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this OptionsMySettlements. # noqa: E501 :type: str @@ -143,7 +143,7 @@ def underlying(self, underlying): def contract(self): """Gets the contract of this OptionsMySettlements. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this OptionsMySettlements. # noqa: E501 :rtype: str @@ -154,7 +154,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this OptionsMySettlements. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this OptionsMySettlements. # noqa: E501 :type: str @@ -166,7 +166,7 @@ def contract(self, contract): def strike_price(self): """Gets the strike_price of this OptionsMySettlements. # noqa: E501 - Strike price (quote currency). # noqa: E501 + Strike price (quote currency) # noqa: E501 :return: The strike_price of this OptionsMySettlements. # noqa: E501 :rtype: str @@ -177,7 +177,7 @@ def strike_price(self): def strike_price(self, strike_price): """Sets the strike_price of this OptionsMySettlements. - Strike price (quote currency). # noqa: E501 + Strike price (quote currency) # noqa: E501 :param strike_price: The strike_price of this OptionsMySettlements. # noqa: E501 :type: str @@ -189,7 +189,7 @@ def strike_price(self, strike_price): def settle_price(self): """Gets the settle_price of this OptionsMySettlements. # noqa: E501 - Settlement price (quote currency). # noqa: E501 + Settlement price (quote currency) # noqa: E501 :return: The settle_price of this OptionsMySettlements. # noqa: E501 :rtype: str @@ -200,7 +200,7 @@ def settle_price(self): def settle_price(self, settle_price): """Sets the settle_price of this OptionsMySettlements. - Settlement price (quote currency). # noqa: E501 + Settlement price (quote currency) # noqa: E501 :param settle_price: The settle_price of this OptionsMySettlements. # noqa: E501 :type: str @@ -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 @@ -235,7 +235,7 @@ def size(self, size): def settle_profit(self): """Gets the settle_profit of this OptionsMySettlements. # noqa: E501 - Settlement profit (quote currency). # noqa: E501 + Settlement profit (quote currency) # noqa: E501 :return: The settle_profit of this OptionsMySettlements. # noqa: E501 :rtype: str @@ -246,7 +246,7 @@ def settle_profit(self): def settle_profit(self, settle_profit): """Sets the settle_profit of this OptionsMySettlements. - Settlement profit (quote currency). # noqa: E501 + Settlement profit (quote currency) # noqa: E501 :param settle_profit: The settle_profit of this OptionsMySettlements. # noqa: E501 :type: str @@ -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 0b0769f..55435f0 100644 --- a/gate_api/models/options_my_trade.py +++ b/gate_api/models/options_my_trade.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -138,7 +138,7 @@ def create_time(self, create_time): def contract(self): """Gets the contract of this OptionsMyTrade. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this OptionsMyTrade. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this OptionsMyTrade. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this OptionsMyTrade. # noqa: E501 :type: str @@ -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 @@ -184,7 +184,7 @@ def order_id(self, order_id): def size(self): """Gets the size of this OptionsMyTrade. # noqa: E501 - Trading size. # noqa: E501 + Trading size # noqa: E501 :return: The size of this OptionsMyTrade. # noqa: E501 :rtype: int @@ -195,7 +195,7 @@ def size(self): def size(self, size): """Sets the size of this OptionsMyTrade. - Trading size. # noqa: E501 + Trading size # noqa: E501 :param size: The size 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 @@ -230,7 +230,7 @@ def price(self, price): def underlying_price(self): """Gets the underlying_price of this OptionsMyTrade. # noqa: E501 - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :return: The underlying_price of this OptionsMyTrade. # noqa: E501 :rtype: str @@ -241,7 +241,7 @@ def underlying_price(self): def underlying_price(self, underlying_price): """Sets the underlying_price of this OptionsMyTrade. - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :param underlying_price: The underlying_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 4f8dbbb..1f28133 100644 --- a/gate_api/models/options_order.py +++ b/gate_api/models/options_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -175,7 +175,7 @@ def __init__(self, id=None, user=None, create_time=None, finish_time=None, finis def id(self): """Gets the id of this OptionsOrder. # noqa: E501 - Options order ID. # noqa: E501 + Options order ID # noqa: E501 :return: The id of this OptionsOrder. # noqa: E501 :rtype: int @@ -186,7 +186,7 @@ def id(self): def id(self, id): """Sets the id of this OptionsOrder. - Options order ID. # noqa: E501 + Options order ID # noqa: E501 :param id: The id of this OptionsOrder. # noqa: E501 :type: int @@ -198,7 +198,7 @@ def id(self, id): def user(self): """Gets the user of this OptionsOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this OptionsOrder. # noqa: E501 :rtype: int @@ -209,7 +209,7 @@ def user(self): def user(self, user): """Sets the user of this OptionsOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this OptionsOrder. # noqa: E501 :type: int @@ -221,7 +221,7 @@ def user(self, user): def create_time(self): """Gets the create_time of this OptionsOrder. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this OptionsOrder. # noqa: E501 :rtype: float @@ -232,7 +232,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this OptionsOrder. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this OptionsOrder. # noqa: E501 :type: float @@ -244,7 +244,7 @@ def create_time(self, create_time): def finish_time(self): """Gets the finish_time of this OptionsOrder. # noqa: E501 - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :return: The finish_time of this OptionsOrder. # noqa: E501 :rtype: float @@ -255,7 +255,7 @@ def finish_time(self): def finish_time(self, finish_time): """Sets the finish_time of this OptionsOrder. - Order finished time. Not returned if order is open. # noqa: E501 + Order finished time. Not returned if order is open # noqa: E501 :param finish_time: The finish_time of this OptionsOrder. # noqa: E501 :type: float @@ -267,7 +267,7 @@ def finish_time(self, finish_time): def finish_as(self): """Gets the finish_as of this OptionsOrder. # noqa: E501 - Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled # 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. - Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled # 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 @@ -421,7 +421,7 @@ def price(self, price): def close(self): """Gets the close of this OptionsOrder. # noqa: E501 - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :return: The close of this OptionsOrder. # noqa: E501 :rtype: bool @@ -432,7 +432,7 @@ def close(self): def close(self, close): """Sets the close of this OptionsOrder. - Set as `true` to close the position, with `size` set to 0. # noqa: E501 + Set as `true` to close the position, with `size` set to 0 # noqa: E501 :param close: The close of this OptionsOrder. # noqa: E501 :type: bool @@ -444,7 +444,7 @@ def close(self, close): def is_close(self): """Gets the is_close of this OptionsOrder. # noqa: E501 - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :return: The is_close of this OptionsOrder. # noqa: E501 :rtype: bool @@ -455,7 +455,7 @@ def is_close(self): def is_close(self, is_close): """Sets the is_close of this OptionsOrder. - Is the order to close position. # noqa: E501 + Is the order to close position # noqa: E501 :param is_close: The is_close of this OptionsOrder. # noqa: E501 :type: bool @@ -467,7 +467,7 @@ def is_close(self, is_close): def reduce_only(self): """Gets the reduce_only of this OptionsOrder. # noqa: E501 - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :return: The reduce_only of this OptionsOrder. # noqa: E501 :rtype: bool @@ -478,7 +478,7 @@ def reduce_only(self): def reduce_only(self, reduce_only): """Sets the reduce_only of this OptionsOrder. - Set as `true` to be reduce-only order. # noqa: E501 + Set as `true` to be reduce-only order # noqa: E501 :param reduce_only: The reduce_only of this OptionsOrder. # noqa: E501 :type: bool @@ -490,7 +490,7 @@ def reduce_only(self, reduce_only): def is_reduce_only(self): """Gets the is_reduce_only of this OptionsOrder. # noqa: E501 - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :return: The is_reduce_only of this OptionsOrder. # noqa: E501 :rtype: bool @@ -501,7 +501,7 @@ def is_reduce_only(self): def is_reduce_only(self, is_reduce_only): """Sets the is_reduce_only of this OptionsOrder. - Is the order reduce-only. # noqa: E501 + Is the order reduce-only # noqa: E501 :param is_reduce_only: The is_reduce_only of this OptionsOrder. # noqa: E501 :type: bool @@ -513,7 +513,7 @@ def is_reduce_only(self, is_reduce_only): def is_liq(self): """Gets the is_liq of this OptionsOrder. # noqa: E501 - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :return: The is_liq of this OptionsOrder. # noqa: E501 :rtype: bool @@ -524,7 +524,7 @@ def is_liq(self): def is_liq(self, is_liq): """Sets the is_liq of this OptionsOrder. - Is the order for liquidation. # noqa: E501 + Is the order for liquidation # noqa: E501 :param is_liq: The is_liq of this OptionsOrder. # noqa: E501 :type: bool @@ -536,7 +536,7 @@ def is_liq(self, is_liq): def mmp(self): """Gets the mmp of this OptionsOrder. # noqa: E501 - When set to true, delegate to 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. - When set to true, delegate to 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 - Whether it is MMP delegation. Corresponds to `mmp` in the request. # 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. - Whether it is MMP delegation. Corresponds to `mmp` in the request. # 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 @@ -680,7 +680,7 @@ def text(self, text): def tkfr(self): """Gets the tkfr of this OptionsOrder. # noqa: E501 - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :return: The tkfr of this OptionsOrder. # noqa: E501 :rtype: str @@ -691,7 +691,7 @@ def tkfr(self): def tkfr(self, tkfr): """Sets the tkfr of this OptionsOrder. - Taker fee. # noqa: E501 + Taker fee # noqa: E501 :param tkfr: The tkfr of this OptionsOrder. # noqa: E501 :type: str @@ -703,7 +703,7 @@ def tkfr(self, tkfr): def mkfr(self): """Gets the mkfr of this OptionsOrder. # noqa: E501 - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :return: The mkfr of this OptionsOrder. # noqa: E501 :rtype: str @@ -714,7 +714,7 @@ def mkfr(self): def mkfr(self, mkfr): """Sets the mkfr of this OptionsOrder. - Maker fee. # noqa: E501 + Maker fee # noqa: E501 :param mkfr: The mkfr 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 @@ -749,7 +749,7 @@ def refu(self, refu): def refr(self): """Gets the refr of this OptionsOrder. # noqa: E501 - Referrer rebate. # noqa: E501 + Referrer rebate # noqa: E501 :return: The refr of this OptionsOrder. # noqa: E501 :rtype: str @@ -760,7 +760,7 @@ def refr(self): def refr(self, refr): """Sets the refr of this OptionsOrder. - Referrer rebate. # noqa: E501 + Referrer rebate # noqa: E501 :param refr: The refr of this OptionsOrder. # noqa: E501 :type: str diff --git a/gate_api/models/options_position.py b/gate_api/models/options_position.py index 999715a..b20a575 100644 --- a/gate_api/models/options_position.py +++ b/gate_api/models/options_position.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -131,7 +131,7 @@ def __init__(self, user=None, underlying=None, underlying_price=None, contract=N def user(self): """Gets the user of this OptionsPosition. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this OptionsPosition. # noqa: E501 :rtype: int @@ -142,7 +142,7 @@ def user(self): def user(self, user): """Sets the user of this OptionsPosition. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this OptionsPosition. # noqa: E501 :type: int @@ -154,7 +154,7 @@ def user(self, user): def underlying(self): """Gets the underlying of this OptionsPosition. # noqa: E501 - Underlying. # noqa: E501 + Underlying # noqa: E501 :return: The underlying of this OptionsPosition. # noqa: E501 :rtype: str @@ -165,7 +165,7 @@ def underlying(self): def underlying(self, underlying): """Sets the underlying of this OptionsPosition. - Underlying. # noqa: E501 + Underlying # noqa: E501 :param underlying: The underlying of this OptionsPosition. # noqa: E501 :type: str @@ -177,7 +177,7 @@ def underlying(self, underlying): def underlying_price(self): """Gets the underlying_price of this OptionsPosition. # noqa: E501 - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :return: The underlying_price of this OptionsPosition. # noqa: E501 :rtype: str @@ -188,7 +188,7 @@ def underlying_price(self): def underlying_price(self, underlying_price): """Sets the underlying_price of this OptionsPosition. - Underlying price (quote currency). # noqa: E501 + Underlying price (quote currency) # noqa: E501 :param underlying_price: The underlying_price of this OptionsPosition. # noqa: E501 :type: str @@ -200,7 +200,7 @@ def underlying_price(self, underlying_price): def contract(self): """Gets the contract of this OptionsPosition. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this OptionsPosition. # noqa: E501 :rtype: str @@ -211,7 +211,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this OptionsPosition. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this OptionsPosition. # noqa: E501 :type: str @@ -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 @@ -246,7 +246,7 @@ def size(self, size): def entry_price(self): """Gets the entry_price of this OptionsPosition. # noqa: E501 - Entry size (quote currency). # noqa: E501 + Entry size (quote currency) # noqa: E501 :return: The entry_price of this OptionsPosition. # noqa: E501 :rtype: str @@ -257,7 +257,7 @@ def entry_price(self): def entry_price(self, entry_price): """Sets the entry_price of this OptionsPosition. - Entry size (quote currency). # noqa: E501 + Entry size (quote currency) # noqa: E501 :param entry_price: The entry_price of this OptionsPosition. # noqa: E501 :type: str @@ -269,7 +269,7 @@ def entry_price(self, entry_price): def mark_price(self): """Gets the mark_price of this OptionsPosition. # noqa: E501 - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :return: The mark_price of this OptionsPosition. # noqa: E501 :rtype: str @@ -280,7 +280,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this OptionsPosition. - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :param mark_price: The mark_price of this OptionsPosition. # noqa: E501 :type: str @@ -292,7 +292,7 @@ def mark_price(self, mark_price): def mark_iv(self): """Gets the mark_iv of this OptionsPosition. # noqa: E501 - Implied volatility. # noqa: E501 + Implied volatility # noqa: E501 :return: The mark_iv of this OptionsPosition. # noqa: E501 :rtype: str @@ -303,7 +303,7 @@ def mark_iv(self): def mark_iv(self, mark_iv): """Sets the mark_iv of this OptionsPosition. - Implied volatility. # noqa: E501 + Implied volatility # noqa: E501 :param mark_iv: The mark_iv of this OptionsPosition. # noqa: E501 :type: str @@ -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 @@ -338,7 +338,7 @@ def realised_pnl(self, realised_pnl): def unrealised_pnl(self): """Gets the unrealised_pnl of this OptionsPosition. # noqa: E501 - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :return: The unrealised_pnl of this OptionsPosition. # noqa: E501 :rtype: str @@ -349,7 +349,7 @@ def unrealised_pnl(self): def unrealised_pnl(self, unrealised_pnl): """Sets the unrealised_pnl of this OptionsPosition. - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :param unrealised_pnl: The unrealised_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 616c81b..2cc0fbb 100644 --- a/gate_api/models/options_position_close.py +++ b/gate_api/models/options_position_close.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, time=None, contract=None, side=None, pnl=None, text=None, set def time(self): """Gets the time of this OptionsPositionClose. # noqa: E501 - Position close time. # noqa: E501 + Position close time # noqa: E501 :return: The time of this OptionsPositionClose. # noqa: E501 :rtype: float @@ -93,7 +93,7 @@ def time(self): def time(self, time): """Sets the time of this OptionsPositionClose. - Position close time. # noqa: E501 + Position close time # noqa: E501 :param time: The time of this OptionsPositionClose. # noqa: E501 :type: float @@ -105,7 +105,7 @@ def time(self, time): def contract(self): """Gets the contract of this OptionsPositionClose. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this OptionsPositionClose. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this OptionsPositionClose. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this OptionsPositionClose. # noqa: E501 :type: str @@ -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 94bd440..31449b1 100644 --- a/gate_api/models/options_position_close_order.py +++ b/gate_api/models/options_position_close_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 4ecc7c0..d199ae4 100644 --- a/gate_api/models/options_settlement.py +++ b/gate_api/models/options_settlement.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -105,7 +105,7 @@ def time(self, time): def contract(self): """Gets the contract of this OptionsSettlement. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The contract of this OptionsSettlement. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this OptionsSettlement. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param contract: The contract of this OptionsSettlement. # noqa: E501 :type: str @@ -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 @@ -174,7 +174,7 @@ def fee(self, fee): def strike_price(self): """Gets the strike_price of this OptionsSettlement. # noqa: E501 - Strike price (quote currency). # noqa: E501 + Strike price (quote currency) # noqa: E501 :return: The strike_price of this OptionsSettlement. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def strike_price(self): def strike_price(self, strike_price): """Sets the strike_price of this OptionsSettlement. - Strike price (quote currency). # noqa: E501 + Strike price (quote currency) # noqa: E501 :param strike_price: The strike_price of this OptionsSettlement. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def strike_price(self, strike_price): def settle_price(self): """Gets the settle_price of this OptionsSettlement. # noqa: E501 - Settlement price (quote currency). # noqa: E501 + Settlement price (quote currency) # noqa: E501 :return: The settle_price of this OptionsSettlement. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def settle_price(self): def settle_price(self, settle_price): """Sets the settle_price of this OptionsSettlement. - Settlement price (quote currency). # noqa: E501 + Settlement price (quote currency) # noqa: E501 :param settle_price: The settle_price of this OptionsSettlement. # noqa: E501 :type: str diff --git a/gate_api/models/options_ticker.py b/gate_api/models/options_ticker.py index d71ba0f..8a645f8 100644 --- a/gate_api/models/options_ticker.py +++ b/gate_api/models/options_ticker.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -142,7 +142,7 @@ def __init__(self, name=None, last_price=None, mark_price=None, index_price=None def name(self): """Gets the name of this OptionsTicker. # noqa: E501 - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :return: The name of this OptionsTicker. # noqa: E501 :rtype: str @@ -153,7 +153,7 @@ def name(self): def name(self, name): """Sets the name of this OptionsTicker. - Options contract name. # noqa: E501 + Options contract name # noqa: E501 :param name: The name of this OptionsTicker. # noqa: E501 :type: str @@ -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 @@ -188,7 +188,7 @@ def last_price(self, last_price): def mark_price(self): """Gets the mark_price of this OptionsTicker. # noqa: E501 - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :return: The mark_price of this OptionsTicker. # noqa: E501 :rtype: str @@ -199,7 +199,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this OptionsTicker. - Current mark price (quote currency). # noqa: E501 + Current mark price (quote currency) # noqa: E501 :param mark_price: The mark_price of this OptionsTicker. # noqa: E501 :type: str @@ -211,7 +211,7 @@ def mark_price(self, mark_price): def index_price(self): """Gets the index_price of this OptionsTicker. # noqa: E501 - Current index price (quote currency). # noqa: E501 + Current index price (quote currency) # noqa: E501 :return: The index_price of this OptionsTicker. # noqa: E501 :rtype: str @@ -222,7 +222,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this OptionsTicker. - Current index price (quote currency). # noqa: E501 + Current index price (quote currency) # noqa: E501 :param index_price: The index_price of this OptionsTicker. # noqa: E501 :type: str @@ -234,7 +234,7 @@ def index_price(self, index_price): def ask1_size(self): """Gets the ask1_size of this OptionsTicker. # noqa: E501 - Best ask size. # noqa: E501 + Best ask size # noqa: E501 :return: The ask1_size of this OptionsTicker. # noqa: E501 :rtype: int @@ -245,7 +245,7 @@ def ask1_size(self): def ask1_size(self, ask1_size): """Sets the ask1_size of this OptionsTicker. - Best ask size. # noqa: E501 + Best ask size # noqa: E501 :param ask1_size: The ask1_size of this OptionsTicker. # noqa: E501 :type: int @@ -257,7 +257,7 @@ def ask1_size(self, ask1_size): def ask1_price(self): """Gets the ask1_price of this OptionsTicker. # noqa: E501 - Best ask price. # noqa: E501 + Best ask price # noqa: E501 :return: The ask1_price of this OptionsTicker. # noqa: E501 :rtype: str @@ -268,7 +268,7 @@ def ask1_price(self): def ask1_price(self, ask1_price): """Sets the ask1_price of this OptionsTicker. - Best ask price. # noqa: E501 + Best ask price # noqa: E501 :param ask1_price: The ask1_price of this OptionsTicker. # noqa: E501 :type: str @@ -280,7 +280,7 @@ def ask1_price(self, ask1_price): def bid1_size(self): """Gets the bid1_size of this OptionsTicker. # noqa: E501 - Best bid size. # noqa: E501 + Best bid size # noqa: E501 :return: The bid1_size of this OptionsTicker. # noqa: E501 :rtype: int @@ -291,7 +291,7 @@ def bid1_size(self): def bid1_size(self, bid1_size): """Sets the bid1_size of this OptionsTicker. - Best bid size. # noqa: E501 + Best bid size # noqa: E501 :param bid1_size: The bid1_size of this OptionsTicker. # noqa: E501 :type: int @@ -303,7 +303,7 @@ def bid1_size(self, bid1_size): def bid1_price(self): """Gets the bid1_price of this OptionsTicker. # noqa: E501 - Best bid price. # noqa: E501 + Best bid price # noqa: E501 :return: The bid1_price of this OptionsTicker. # noqa: E501 :rtype: str @@ -314,7 +314,7 @@ def bid1_price(self): def bid1_price(self, bid1_price): """Sets the bid1_price of this OptionsTicker. - Best bid price. # noqa: E501 + Best bid price # noqa: E501 :param bid1_price: The bid1_price of this OptionsTicker. # noqa: E501 :type: str @@ -326,7 +326,7 @@ def bid1_price(self, bid1_price): def position_size(self): """Gets the position_size of this OptionsTicker. # noqa: E501 - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :return: The position_size of this OptionsTicker. # noqa: E501 :rtype: int @@ -337,7 +337,7 @@ def position_size(self): def position_size(self, position_size): """Sets the position_size of this OptionsTicker. - Current total long position size. # noqa: E501 + Current total long position size # noqa: E501 :param position_size: The position_size of this OptionsTicker. # noqa: E501 :type: int @@ -349,7 +349,7 @@ def position_size(self, position_size): def mark_iv(self): """Gets the mark_iv of this OptionsTicker. # noqa: E501 - Implied volatility. # noqa: E501 + Implied volatility # noqa: E501 :return: The mark_iv of this OptionsTicker. # noqa: E501 :rtype: str @@ -360,7 +360,7 @@ def mark_iv(self): def mark_iv(self, mark_iv): """Sets the mark_iv of this OptionsTicker. - Implied volatility. # noqa: E501 + Implied volatility # noqa: E501 :param mark_iv: The mark_iv of this OptionsTicker. # noqa: E501 :type: str @@ -372,7 +372,7 @@ def mark_iv(self, mark_iv): def bid_iv(self): """Gets the bid_iv of this OptionsTicker. # noqa: E501 - Bid side implied volatility. # noqa: E501 + Bid side implied volatility # noqa: E501 :return: The bid_iv of this OptionsTicker. # noqa: E501 :rtype: str @@ -383,7 +383,7 @@ def bid_iv(self): def bid_iv(self, bid_iv): """Sets the bid_iv of this OptionsTicker. - Bid side implied volatility. # noqa: E501 + Bid side implied volatility # noqa: E501 :param bid_iv: The bid_iv of this OptionsTicker. # noqa: E501 :type: str @@ -395,7 +395,7 @@ def bid_iv(self, bid_iv): def ask_iv(self): """Gets the ask_iv of this OptionsTicker. # noqa: E501 - Ask side implied volatility. # noqa: E501 + Ask side implied volatility # noqa: E501 :return: The ask_iv of this OptionsTicker. # noqa: E501 :rtype: str @@ -406,7 +406,7 @@ def ask_iv(self): def ask_iv(self, ask_iv): """Sets the ask_iv of this OptionsTicker. - Ask side implied volatility. # noqa: E501 + Ask side implied volatility # noqa: E501 :param ask_iv: The ask_iv of this OptionsTicker. # noqa: E501 :type: str @@ -418,7 +418,7 @@ def ask_iv(self, ask_iv): def leverage(self): """Gets the leverage of this OptionsTicker. # noqa: E501 - Current leverage. Formula: underlying_price / mark_price * delta. # noqa: E501 + Current leverage. Formula: underlying_price / mark_price * delta # noqa: E501 :return: The leverage of this OptionsTicker. # noqa: E501 :rtype: str @@ -429,7 +429,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this OptionsTicker. - Current leverage. Formula: underlying_price / mark_price * delta. # noqa: E501 + Current leverage. Formula: underlying_price / mark_price * delta # noqa: E501 :param leverage: The leverage 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 @@ -533,7 +533,7 @@ def theta(self, theta): def rho(self): """Gets the rho of this OptionsTicker. # noqa: E501 - Rho. # noqa: E501 + Rho # noqa: E501 :return: The rho of this OptionsTicker. # noqa: E501 :rtype: str @@ -544,7 +544,7 @@ def rho(self): def rho(self, rho): """Sets the rho of this OptionsTicker. - Rho. # noqa: E501 + Rho # noqa: E501 :param rho: The rho of this OptionsTicker. # noqa: E501 :type: str diff --git a/gate_api/models/options_underlying.py b/gate_api/models/options_underlying.py index 45d86f5..89abb3f 100644 --- a/gate_api/models/options_underlying.py +++ b/gate_api/models/options_underlying.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, name=None, index_price=None, local_vars_configuration=None): def name(self): """Gets the name of this OptionsUnderlying. # noqa: E501 - Underlying name. # noqa: E501 + Underlying name # noqa: E501 :return: The name of this OptionsUnderlying. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def name(self): def name(self, name): """Sets the name of this OptionsUnderlying. - Underlying name. # noqa: E501 + Underlying name # noqa: E501 :param name: The name of this OptionsUnderlying. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def name(self, name): def index_price(self): """Gets the index_price of this OptionsUnderlying. # noqa: E501 - Spot index price (quote currency). # noqa: E501 + Spot index price (quote currency) # noqa: E501 :return: The index_price of this OptionsUnderlying. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this OptionsUnderlying. - Spot index price (quote currency). # noqa: E501 + Spot index price (quote currency) # noqa: E501 :param index_price: The index_price of this OptionsUnderlying. # noqa: E501 :type: str diff --git a/gate_api/models/options_underlying_ticker.py b/gate_api/models/options_underlying_ticker.py index 0a4683a..8ce402e 100644 --- a/gate_api/models/options_underlying_ticker.py +++ b/gate_api/models/options_underlying_ticker.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, trade_put=None, trade_call=None, index_price=None, local_vars def trade_put(self): """Gets the trade_put of this OptionsUnderlyingTicker. # noqa: E501 - Total put options trades amount in last 24h. # noqa: E501 + Total put options trades amount in last 24h # noqa: E501 :return: The trade_put of this OptionsUnderlyingTicker. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def trade_put(self): def trade_put(self, trade_put): """Sets the trade_put of this OptionsUnderlyingTicker. - Total put options trades amount in last 24h. # noqa: E501 + Total put options trades amount in last 24h # noqa: E501 :param trade_put: The trade_put of this OptionsUnderlyingTicker. # noqa: E501 :type: int @@ -90,7 +90,7 @@ def trade_put(self, trade_put): def trade_call(self): """Gets the trade_call of this OptionsUnderlyingTicker. # noqa: E501 - Total call options trades amount in last 24h. # noqa: E501 + Total call options trades amount in last 24h # noqa: E501 :return: The trade_call of this OptionsUnderlyingTicker. # noqa: E501 :rtype: int @@ -101,7 +101,7 @@ def trade_call(self): def trade_call(self, trade_call): """Sets the trade_call of this OptionsUnderlyingTicker. - Total call options trades amount in last 24h. # noqa: E501 + Total call options trades amount in last 24h # noqa: E501 :param trade_call: The trade_call of this OptionsUnderlyingTicker. # noqa: E501 :type: int @@ -113,7 +113,7 @@ def trade_call(self, trade_call): def index_price(self): """Gets the index_price of this OptionsUnderlyingTicker. # noqa: E501 - Index price (quote currency). # noqa: E501 + Index price (quote currency) # noqa: E501 :return: The index_price of this OptionsUnderlyingTicker. # noqa: E501 :rtype: str @@ -124,7 +124,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this OptionsUnderlyingTicker. - Index price (quote currency). # noqa: E501 + Index price (quote currency) # noqa: E501 :param index_price: The index_price of this OptionsUnderlyingTicker. # noqa: E501 :type: str diff --git a/gate_api/models/order.py b/gate_api/models/order.py index a4aabea..7555321 100644 --- a/gate_api/models/order.py +++ b/gate_api/models/order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -229,7 +229,7 @@ def __init__(self, id=None, text=None, amend_text=None, create_time=None, update def id(self): """Gets the id of this Order. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this Order. # noqa: E501 :rtype: str @@ -240,7 +240,7 @@ def id(self): def id(self, id): """Sets the id of this Order. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this Order. # noqa: E501 :type: str @@ -275,7 +275,7 @@ def text(self, text): def amend_text(self): """Gets the amend_text of this Order. # noqa: E501 - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :return: The amend_text of this Order. # noqa: E501 :rtype: str @@ -286,7 +286,7 @@ def amend_text(self): def amend_text(self, amend_text): """Sets the amend_text of this Order. - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :param amend_text: The amend_text of this Order. # noqa: E501 :type: str @@ -298,7 +298,7 @@ def amend_text(self, amend_text): def create_time(self): """Gets the create_time of this Order. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this Order. # noqa: E501 :rtype: str @@ -309,7 +309,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this Order. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this Order. # noqa: E501 :type: str @@ -321,7 +321,7 @@ def create_time(self, create_time): def update_time(self): """Gets the update_time of this Order. # noqa: E501 - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :return: The update_time of this Order. # noqa: E501 :rtype: str @@ -332,7 +332,7 @@ def update_time(self): def update_time(self, update_time): """Sets the update_time of this Order. - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :param update_time: The update_time of this Order. # noqa: E501 :type: str @@ -344,7 +344,7 @@ def update_time(self, update_time): def create_time_ms(self): """Gets the create_time_ms of this Order. # noqa: E501 - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :return: The create_time_ms of this Order. # noqa: E501 :rtype: int @@ -355,7 +355,7 @@ def create_time_ms(self): def create_time_ms(self, create_time_ms): """Sets the create_time_ms of this Order. - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :param create_time_ms: The create_time_ms of this Order. # noqa: E501 :type: int @@ -367,7 +367,7 @@ def create_time_ms(self, create_time_ms): def update_time_ms(self): """Gets the update_time_ms of this Order. # noqa: E501 - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :return: The update_time_ms of this Order. # noqa: E501 :rtype: int @@ -378,7 +378,7 @@ def update_time_ms(self): def update_time_ms(self, update_time_ms): """Sets the update_time_ms of this Order. - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :param update_time_ms: The update_time_ms of this Order. # noqa: E501 :type: int @@ -419,7 +419,7 @@ def status(self, status): def currency_pair(self): """Gets the currency_pair of this Order. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this Order. # noqa: E501 :rtype: str @@ -430,7 +430,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this Order. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 - Buy or sell order. # 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. - Buy or sell order. # 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 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 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 @@ -673,7 +673,7 @@ def auto_repay(self, auto_repay): def left(self): """Gets the left of this Order. # noqa: E501 - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :return: The left of this Order. # noqa: E501 :rtype: str @@ -684,7 +684,7 @@ def left(self): def left(self, left): """Sets the left of this Order. - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :param left: The left of this Order. # noqa: E501 :type: str @@ -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 @@ -719,7 +719,7 @@ def filled_amount(self, filled_amount): def fill_price(self): """Gets the fill_price of this Order. # noqa: E501 - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :return: The fill_price of this Order. # noqa: E501 :rtype: str @@ -730,7 +730,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this Order. - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :param fill_price: The fill_price of this Order. # noqa: E501 :type: str @@ -742,7 +742,7 @@ def fill_price(self, fill_price): def filled_total(self): """Gets the filled_total of this Order. # noqa: E501 - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :return: The filled_total of this Order. # noqa: E501 :rtype: str @@ -753,7 +753,7 @@ def filled_total(self): def filled_total(self, filled_total): """Sets the filled_total of this Order. - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :param filled_total: The filled_total of this Order. # noqa: E501 :type: str @@ -765,7 +765,7 @@ def filled_total(self, filled_total): def avg_deal_price(self): """Gets the avg_deal_price of this Order. # noqa: E501 - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :return: The avg_deal_price of this Order. # noqa: E501 :rtype: str @@ -776,7 +776,7 @@ def avg_deal_price(self): def avg_deal_price(self, avg_deal_price): """Sets the avg_deal_price of this Order. - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :param avg_deal_price: The avg_deal_price of this Order. # noqa: E501 :type: str @@ -788,7 +788,7 @@ def avg_deal_price(self, avg_deal_price): def fee(self): """Gets the fee of this Order. # noqa: E501 - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :return: The fee of this Order. # noqa: E501 :rtype: str @@ -799,7 +799,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this Order. - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :param fee: The fee of this Order. # noqa: E501 :type: str @@ -811,7 +811,7 @@ def fee(self, fee): def fee_currency(self): """Gets the fee_currency of this Order. # noqa: E501 - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :return: The fee_currency of this Order. # noqa: E501 :rtype: str @@ -822,7 +822,7 @@ def fee_currency(self): def fee_currency(self, fee_currency): """Sets the fee_currency of this Order. - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :param fee_currency: The fee_currency of this Order. # noqa: E501 :type: str @@ -834,7 +834,7 @@ def fee_currency(self, fee_currency): def point_fee(self): """Gets the point_fee of this Order. # noqa: E501 - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :return: The point_fee of this Order. # noqa: E501 :rtype: str @@ -845,7 +845,7 @@ def point_fee(self): def point_fee(self, point_fee): """Sets the point_fee of this Order. - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :param point_fee: The point_fee of this Order. # noqa: E501 :type: str @@ -857,7 +857,7 @@ def point_fee(self, point_fee): def gt_fee(self): """Gets the gt_fee of this Order. # noqa: E501 - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :return: The gt_fee of this Order. # noqa: E501 :rtype: str @@ -868,7 +868,7 @@ def gt_fee(self): def gt_fee(self, gt_fee): """Sets the gt_fee of this Order. - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :param gt_fee: The gt_fee 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 @@ -949,7 +949,7 @@ def gt_discount(self, gt_discount): def rebated_fee(self): """Gets the rebated_fee of this Order. # noqa: E501 - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :return: The rebated_fee of this Order. # noqa: E501 :rtype: str @@ -960,7 +960,7 @@ def rebated_fee(self): def rebated_fee(self, rebated_fee): """Sets the rebated_fee of this Order. - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :param rebated_fee: The rebated_fee of this Order. # noqa: E501 :type: str @@ -972,7 +972,7 @@ def rebated_fee(self, rebated_fee): def rebated_fee_currency(self): """Gets the rebated_fee_currency of this Order. # noqa: E501 - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :return: The rebated_fee_currency of this Order. # noqa: E501 :rtype: str @@ -983,7 +983,7 @@ def rebated_fee_currency(self): def rebated_fee_currency(self, rebated_fee_currency): """Sets the rebated_fee_currency of this Order. - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :param rebated_fee_currency: The rebated_fee_currency of this Order. # noqa: E501 :type: str @@ -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, 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, 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 diff --git a/gate_api/models/order_book.py b/gate_api/models/order_book.py index 946e68e..a469fe7 100644 --- a/gate_api/models/order_book.py +++ b/gate_api/models/order_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -98,7 +98,7 @@ def id(self, id): def current(self): """Gets the current of this OrderBook. # noqa: E501 - The timestamp of the response data being generated (in milliseconds). # noqa: E501 + The timestamp of the response data being generated (in milliseconds) # noqa: E501 :return: The current of this OrderBook. # noqa: E501 :rtype: int @@ -109,7 +109,7 @@ def current(self): def current(self, current): """Sets the current of this OrderBook. - The timestamp of the response data being generated (in milliseconds). # noqa: E501 + The timestamp of the response data being generated (in milliseconds) # noqa: E501 :param current: The current of this OrderBook. # noqa: E501 :type: int @@ -121,7 +121,7 @@ def current(self, current): def update(self): """Gets the update of this OrderBook. # noqa: E501 - The timestamp of when the orderbook last changed (in milliseconds). # noqa: E501 + The timestamp of when the orderbook last changed (in milliseconds) # noqa: E501 :return: The update of this OrderBook. # noqa: E501 :rtype: int @@ -132,7 +132,7 @@ def update(self): def update(self, update): """Sets the update of this OrderBook. - The timestamp of when the orderbook last changed (in milliseconds). # noqa: E501 + The timestamp of when the orderbook last changed (in milliseconds) # noqa: E501 :param update: The update of this OrderBook. # noqa: E501 :type: int @@ -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 9f3bd10..ba1457e 100644 --- a/gate_api/models/order_cancel.py +++ b/gate_api/models/order_cancel.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -244,7 +244,7 @@ def __init__(self, id=None, text=None, amend_text=None, succeeded=None, label=No def id(self): """Gets the id of this OrderCancel. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this OrderCancel. # noqa: E501 :rtype: str @@ -255,7 +255,7 @@ def id(self): def id(self, id): """Sets the id of this OrderCancel. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this OrderCancel. # noqa: E501 :type: str @@ -290,7 +290,7 @@ def text(self, text): def amend_text(self): """Gets the amend_text of this OrderCancel. # noqa: E501 - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :return: The amend_text of this OrderCancel. # noqa: E501 :rtype: str @@ -301,7 +301,7 @@ def amend_text(self): def amend_text(self, amend_text): """Sets the amend_text of this OrderCancel. - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :param amend_text: The amend_text of this OrderCancel. # noqa: E501 :type: str @@ -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 @@ -336,7 +336,7 @@ def succeeded(self, succeeded): def label(self): """Gets the label of this OrderCancel. # noqa: E501 - Error label, if any, otherwise an empty string. # noqa: E501 + Error label, if any, otherwise an empty string # noqa: E501 :return: The label of this OrderCancel. # noqa: E501 :rtype: str @@ -347,7 +347,7 @@ def label(self): def label(self, label): """Sets the label of this OrderCancel. - Error label, if any, otherwise an empty string. # noqa: E501 + Error label, if any, otherwise an empty string # noqa: E501 :param label: The label of this OrderCancel. # noqa: E501 :type: str @@ -359,7 +359,7 @@ def label(self, label): def message(self): """Gets the message of this OrderCancel. # noqa: E501 - Detailed error message, if any, otherwise an empty string. # noqa: E501 + Detailed error message, if any, otherwise an empty string # noqa: E501 :return: The message of this OrderCancel. # noqa: E501 :rtype: str @@ -370,7 +370,7 @@ def message(self): def message(self, message): """Sets the message of this OrderCancel. - Detailed error message, if any, otherwise an empty string. # noqa: E501 + Detailed error message, if any, otherwise an empty string # noqa: E501 :param message: The message of this OrderCancel. # noqa: E501 :type: str @@ -382,7 +382,7 @@ def message(self, message): def create_time(self): """Gets the create_time of this OrderCancel. # noqa: E501 - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :return: The create_time of this OrderCancel. # noqa: E501 :rtype: str @@ -393,7 +393,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this OrderCancel. - Creation time of order. # noqa: E501 + Creation time of order # noqa: E501 :param create_time: The create_time of this OrderCancel. # noqa: E501 :type: str @@ -405,7 +405,7 @@ def create_time(self, create_time): def update_time(self): """Gets the update_time of this OrderCancel. # noqa: E501 - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :return: The update_time of this OrderCancel. # noqa: E501 :rtype: str @@ -416,7 +416,7 @@ def update_time(self): def update_time(self, update_time): """Sets the update_time of this OrderCancel. - Last modification time of order. # noqa: E501 + Last modification time of order # noqa: E501 :param update_time: The update_time of this OrderCancel. # noqa: E501 :type: str @@ -428,7 +428,7 @@ def update_time(self, update_time): def create_time_ms(self): """Gets the create_time_ms of this OrderCancel. # noqa: E501 - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :return: The create_time_ms of this OrderCancel. # noqa: E501 :rtype: int @@ -439,7 +439,7 @@ def create_time_ms(self): def create_time_ms(self, create_time_ms): """Sets the create_time_ms of this OrderCancel. - Creation time of order (in milliseconds). # noqa: E501 + Creation time of order (in milliseconds) # noqa: E501 :param create_time_ms: The create_time_ms of this OrderCancel. # noqa: E501 :type: int @@ -451,7 +451,7 @@ def create_time_ms(self, create_time_ms): def update_time_ms(self): """Gets the update_time_ms of this OrderCancel. # noqa: E501 - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :return: The update_time_ms of this OrderCancel. # noqa: E501 :rtype: int @@ -462,7 +462,7 @@ def update_time_ms(self): def update_time_ms(self, update_time_ms): """Sets the update_time_ms of this OrderCancel. - Last modification time of order (in milliseconds). # noqa: E501 + Last modification time of order (in milliseconds) # noqa: E501 :param update_time_ms: The update_time_ms of this OrderCancel. # noqa: E501 :type: int @@ -503,7 +503,7 @@ def status(self, status): def currency_pair(self): """Gets the currency_pair of this OrderCancel. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this OrderCancel. # noqa: E501 :rtype: str @@ -514,7 +514,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this OrderCancel. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 - Buy or sell order. # 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. - Buy or sell order. # 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 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 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 @@ -757,7 +757,7 @@ def auto_repay(self, auto_repay): def left(self): """Gets the left of this OrderCancel. # noqa: E501 - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :return: The left of this OrderCancel. # noqa: E501 :rtype: str @@ -768,7 +768,7 @@ def left(self): def left(self, left): """Sets the left of this OrderCancel. - Amount left to fill. # noqa: E501 + Amount left to fill # noqa: E501 :param left: The left of this OrderCancel. # noqa: E501 :type: str @@ -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 @@ -803,7 +803,7 @@ def filled_amount(self, filled_amount): def fill_price(self): """Gets the fill_price of this OrderCancel. # noqa: E501 - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :return: The fill_price of this OrderCancel. # noqa: E501 :rtype: str @@ -814,7 +814,7 @@ def fill_price(self): def fill_price(self, fill_price): """Sets the fill_price of this OrderCancel. - Total filled in quote currency. Deprecated in favor of `filled_total`. # noqa: E501 + Total filled in quote currency. Deprecated in favor of `filled_total` # noqa: E501 :param fill_price: The fill_price of this OrderCancel. # noqa: E501 :type: str @@ -826,7 +826,7 @@ def fill_price(self, fill_price): def filled_total(self): """Gets the filled_total of this OrderCancel. # noqa: E501 - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :return: The filled_total of this OrderCancel. # noqa: E501 :rtype: str @@ -837,7 +837,7 @@ def filled_total(self): def filled_total(self, filled_total): """Sets the filled_total of this OrderCancel. - Total filled in quote currency. # noqa: E501 + Total filled in quote currency # noqa: E501 :param filled_total: The filled_total of this OrderCancel. # noqa: E501 :type: str @@ -849,7 +849,7 @@ def filled_total(self, filled_total): def avg_deal_price(self): """Gets the avg_deal_price of this OrderCancel. # noqa: E501 - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :return: The avg_deal_price of this OrderCancel. # noqa: E501 :rtype: str @@ -860,7 +860,7 @@ def avg_deal_price(self): def avg_deal_price(self, avg_deal_price): """Sets the avg_deal_price of this OrderCancel. - Average fill price. # noqa: E501 + Average fill price # noqa: E501 :param avg_deal_price: The avg_deal_price of this OrderCancel. # noqa: E501 :type: str @@ -872,7 +872,7 @@ def avg_deal_price(self, avg_deal_price): def fee(self): """Gets the fee of this OrderCancel. # noqa: E501 - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :return: The fee of this OrderCancel. # noqa: E501 :rtype: str @@ -883,7 +883,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this OrderCancel. - Fee deducted. # noqa: E501 + Fee deducted # noqa: E501 :param fee: The fee of this OrderCancel. # noqa: E501 :type: str @@ -895,7 +895,7 @@ def fee(self, fee): def fee_currency(self): """Gets the fee_currency of this OrderCancel. # noqa: E501 - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :return: The fee_currency of this OrderCancel. # noqa: E501 :rtype: str @@ -906,7 +906,7 @@ def fee_currency(self): def fee_currency(self, fee_currency): """Sets the fee_currency of this OrderCancel. - Fee currency unit. # noqa: E501 + Fee currency unit # noqa: E501 :param fee_currency: The fee_currency of this OrderCancel. # noqa: E501 :type: str @@ -918,7 +918,7 @@ def fee_currency(self, fee_currency): def point_fee(self): """Gets the point_fee of this OrderCancel. # noqa: E501 - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :return: The point_fee of this OrderCancel. # noqa: E501 :rtype: str @@ -929,7 +929,7 @@ def point_fee(self): def point_fee(self, point_fee): """Sets the point_fee of this OrderCancel. - Points used to deduct fee. # noqa: E501 + Points used to deduct fee # noqa: E501 :param point_fee: The point_fee of this OrderCancel. # noqa: E501 :type: str @@ -941,7 +941,7 @@ def point_fee(self, point_fee): def gt_fee(self): """Gets the gt_fee of this OrderCancel. # noqa: E501 - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :return: The gt_fee of this OrderCancel. # noqa: E501 :rtype: str @@ -952,7 +952,7 @@ def gt_fee(self): def gt_fee(self, gt_fee): """Sets the gt_fee of this OrderCancel. - GT used to deduct fee. # noqa: E501 + GT used to deduct fee # noqa: E501 :param gt_fee: The gt_fee 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 @@ -1033,7 +1033,7 @@ def gt_discount(self, gt_discount): def rebated_fee(self): """Gets the rebated_fee of this OrderCancel. # noqa: E501 - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :return: The rebated_fee of this OrderCancel. # noqa: E501 :rtype: str @@ -1044,7 +1044,7 @@ def rebated_fee(self): def rebated_fee(self, rebated_fee): """Sets the rebated_fee of this OrderCancel. - Rebated fee. # noqa: E501 + Rebated fee # noqa: E501 :param rebated_fee: The rebated_fee of this OrderCancel. # noqa: E501 :type: str @@ -1056,7 +1056,7 @@ def rebated_fee(self, rebated_fee): def rebated_fee_currency(self): """Gets the rebated_fee_currency of this OrderCancel. # noqa: E501 - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :return: The rebated_fee_currency of this OrderCancel. # noqa: E501 :rtype: str @@ -1067,7 +1067,7 @@ def rebated_fee_currency(self): def rebated_fee_currency(self, rebated_fee_currency): """Sets the rebated_fee_currency of this OrderCancel. - Rebated fee currency unit. # noqa: E501 + Rebated fee currency unit # noqa: E501 :param rebated_fee_currency: The rebated_fee_currency of this OrderCancel. # noqa: E501 :type: str @@ -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, 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, 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 fcba399..8e59035 100644 --- a/gate_api/models/order_patch.py +++ b/gate_api/models/order_patch.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency_pair=None, account=None, amount=None, price=None, am def currency_pair(self): """Gets the currency_pair of this OrderPatch. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this OrderPatch. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this OrderPatch. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this OrderPatch. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency_pair(self, currency_pair): def account(self): """Gets the account of this OrderPatch. # noqa: E501 - Specify query account. # 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. - Specify query account. # 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 - Trading Quantity. Either amountor pricemust be specified. # 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. - Trading Quantity. Either amountor pricemust be specified. # 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 - Trading Price. Either amountor pricemust be specified. # 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. - Trading Price. Either amountor pricemust be specified. # 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 74219a0..c95612a 100644 --- a/gate_api/models/order_resp.py +++ b/gate_api/models/order_resp.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, order_id=None, local_vars_configuration=None): # noqa: E501 def order_id(self): """Gets the order_id of this OrderResp. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this OrderResp. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this OrderResp. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this OrderResp. # noqa: E501 :type: int diff --git a/gate_api/models/partner_commission_history.py b/gate_api/models/partner_commission_history.py index 87e129a..77c0d2f 100644 --- a/gate_api/models/partner_commission_history.py +++ b/gate_api/models/partner_commission_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, total=None, list=None, local_vars_configuration=None): # noq def total(self): """Gets the total of this PartnerCommissionHistory. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this PartnerCommissionHistory. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def total(self): def total(self, total): """Sets the total of this PartnerCommissionHistory. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this PartnerCommissionHistory. # noqa: E501 :type: int @@ -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 e2ef8fd..c82d656 100644 --- a/gate_api/models/partner_sub.py +++ b/gate_api/models/partner_sub.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, user_id=None, user_join_time=None, type=None, local_vars_conf def user_id(self): """Gets the user_id of this PartnerSub. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this PartnerSub. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this PartnerSub. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this PartnerSub. # noqa: E501 :type: int @@ -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 ef5fe38..9dec1e4 100644 --- a/gate_api/models/partner_sub_list.py +++ b/gate_api/models/partner_sub_list.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, total=None, list=None, local_vars_configuration=None): # noq def total(self): """Gets the total of this PartnerSubList. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this PartnerSubList. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def total(self): def total(self, total): """Sets the total of this PartnerSubList. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this PartnerSubList. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def total(self, total): def list(self): """Gets the list of this PartnerSubList. # noqa: E501 - Subordinate list. # noqa: E501 + Subordinate list # noqa: E501 :return: The list of this PartnerSubList. # noqa: E501 :rtype: list[PartnerSub] @@ -96,7 +96,7 @@ def list(self): def list(self, list): """Sets the list of this PartnerSubList. - Subordinate list. # noqa: E501 + Subordinate list # noqa: E501 :param list: The list of this PartnerSubList. # noqa: E501 :type: list[PartnerSub] diff --git a/gate_api/models/partner_transaction_history.py b/gate_api/models/partner_transaction_history.py index b21c729..3939e41 100644 --- a/gate_api/models/partner_transaction_history.py +++ b/gate_api/models/partner_transaction_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, total=None, list=None, local_vars_configuration=None): # noq def total(self): """Gets the total of this PartnerTransactionHistory. # noqa: E501 - Total. # noqa: E501 + Total # noqa: E501 :return: The total of this PartnerTransactionHistory. # noqa: E501 :rtype: int @@ -73,7 +73,7 @@ def total(self): def total(self, total): """Sets the total of this PartnerTransactionHistory. - Total. # noqa: E501 + Total # noqa: E501 :param total: The total of this PartnerTransactionHistory. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def total(self, total): def list(self): """Gets the list of this PartnerTransactionHistory. # noqa: E501 - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :return: The list of this PartnerTransactionHistory. # noqa: E501 :rtype: list[AgencyTransaction] @@ -96,7 +96,7 @@ def list(self): def list(self, list): """Sets the list of this PartnerTransactionHistory. - List of transaction history. # noqa: E501 + List of transaction history # noqa: E501 :param list: The list of this PartnerTransactionHistory. # noqa: E501 :type: list[AgencyTransaction] diff --git a/gate_api/models/patch_uni_lend.py b/gate_api/models/patch_uni_lend.py index c076441..82e3a19 100644 --- a/gate_api/models/patch_uni_lend.py +++ b/gate_api/models/patch_uni_lend.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, min_rate=None, local_vars_configuration=None): def currency(self): """Gets the currency of this PatchUniLend. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this PatchUniLend. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this PatchUniLend. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this PatchUniLend. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def min_rate(self): """Gets the min_rate of this PatchUniLend. # noqa: E501 - Minimum interest rate. # noqa: E501 + Minimum interest rate # noqa: E501 :return: The min_rate of this PatchUniLend. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def min_rate(self): def min_rate(self, min_rate): """Sets the min_rate of this PatchUniLend. - Minimum interest rate. # noqa: E501 + Minimum interest rate # noqa: E501 :param min_rate: The min_rate of this PatchUniLend. # noqa: E501 :type: str diff --git a/gate_api/models/place_dual_investment_order.py b/gate_api/models/place_dual_investment_order.py index 701708f..46346c1 100644 --- a/gate_api/models/place_dual_investment_order.py +++ b/gate_api/models/place_dual_investment_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -65,7 +65,7 @@ def __init__(self, plan_id=None, amount=None, text=None, local_vars_configuratio 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 @@ -76,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 @@ -90,7 +90,7 @@ def plan_id(self, plan_id): def amount(self): """Gets the amount of this PlaceDualInvestmentOrder. # noqa: E501 - Subscription amount, mutually exclusive with the copies field. # noqa: E501 + Subscription amount, mutually exclusive with copies field # noqa: E501 :return: The amount of this PlaceDualInvestmentOrder. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this PlaceDualInvestmentOrder. - Subscription amount, mutually exclusive with the copies field. # noqa: E501 + Subscription amount, mutually exclusive with copies field # noqa: E501 :param amount: The amount of this PlaceDualInvestmentOrder. # noqa: E501 :type: str @@ -115,7 +115,7 @@ def amount(self, amount): def text(self): """Gets the text of this PlaceDualInvestmentOrder. # 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 PlaceDualInvestmentOrder. # noqa: E501 :rtype: str @@ -126,7 +126,7 @@ def text(self): def text(self, text): """Sets the text of this PlaceDualInvestmentOrder. - 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 PlaceDualInvestmentOrder. # noqa: E501 :type: str diff --git a/gate_api/models/position.py b/gate_api/models/position.py index 9195ee8..2951397 100644 --- a/gate_api/models/position.py +++ b/gate_api/models/position.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -65,7 +65,8 @@ class Position(object): 'update_id': 'int', 'open_time': 'int', 'risk_limit_table': 'str', - 'average_maintenance_rate': 'str' + 'average_maintenance_rate': 'str', + 'pid': 'int' } attribute_map = { @@ -101,11 +102,12 @@ class Position(object): 'update_id': 'update_id', 'open_time': 'open_time', 'risk_limit_table': 'risk_limit_table', - 'average_maintenance_rate': 'average_maintenance_rate' + '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, risk_limit_table=None, average_maintenance_rate=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, 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() @@ -144,6 +146,7 @@ def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limi 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: @@ -211,12 +214,14 @@ def __init__(self, user=None, contract=None, size=None, leverage=None, risk_limi 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): """Gets the user of this Position. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this Position. # noqa: E501 :rtype: int @@ -227,7 +232,7 @@ def user(self): def user(self, user): """Sets the user of this Position. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this Position. # noqa: E501 :type: int @@ -239,7 +244,7 @@ def user(self, user): def contract(self): """Gets the contract of this Position. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this Position. # noqa: E501 :rtype: str @@ -250,7 +255,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this Position. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this Position. # noqa: E501 :type: str @@ -262,7 +267,7 @@ def contract(self, contract): def size(self): """Gets the size of this Position. # noqa: E501 - Position size. # noqa: E501 + Position size # noqa: E501 :return: The size of this Position. # noqa: E501 :rtype: int @@ -273,7 +278,7 @@ def size(self): def size(self, size): """Sets the size of this Position. - Position size. # noqa: E501 + Position size # noqa: E501 :param size: The size of this Position. # noqa: E501 :type: int @@ -308,7 +313,7 @@ def leverage(self, leverage): def risk_limit(self): """Gets the risk_limit of this Position. # noqa: E501 - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :return: The risk_limit of this Position. # noqa: E501 :rtype: str @@ -319,7 +324,7 @@ def risk_limit(self): def risk_limit(self, risk_limit): """Sets the risk_limit of this Position. - Position risk limit. # noqa: E501 + Position risk limit # noqa: E501 :param risk_limit: The risk_limit of this Position. # noqa: E501 :type: str @@ -331,7 +336,7 @@ def risk_limit(self, risk_limit): def leverage_max(self): """Gets the leverage_max of this Position. # noqa: E501 - Maximum leverage under current risk limit. # noqa: E501 + Maximum leverage under current risk limit # noqa: E501 :return: The leverage_max of this Position. # noqa: E501 :rtype: str @@ -342,7 +347,7 @@ def leverage_max(self): def leverage_max(self, leverage_max): """Sets the leverage_max of this Position. - Maximum leverage under current risk limit. # noqa: E501 + Maximum leverage under current risk limit # noqa: E501 :param leverage_max: The leverage_max of this Position. # noqa: E501 :type: str @@ -354,7 +359,7 @@ def leverage_max(self, leverage_max): def maintenance_rate(self): """Gets the maintenance_rate of this Position. # noqa: E501 - Maintenance rate under current risk limit. # noqa: E501 + Maintenance rate under current risk limit # noqa: E501 :return: The maintenance_rate of this Position. # noqa: E501 :rtype: str @@ -365,7 +370,7 @@ def maintenance_rate(self): def maintenance_rate(self, maintenance_rate): """Sets the maintenance_rate of this Position. - Maintenance rate under current risk limit. # noqa: E501 + Maintenance rate under current risk limit # noqa: E501 :param maintenance_rate: The maintenance_rate of this Position. # noqa: E501 :type: str @@ -377,7 +382,7 @@ def maintenance_rate(self, maintenance_rate): def value(self): """Gets the value of this Position. # noqa: E501 - Position value calculated in settlement currency. # noqa: E501 + Position value calculated in settlement currency # noqa: E501 :return: The value of this Position. # noqa: E501 :rtype: str @@ -388,7 +393,7 @@ def value(self): def value(self, value): """Sets the value of this Position. - Position value calculated in settlement currency. # noqa: E501 + Position value calculated in settlement currency # noqa: E501 :param value: The value of this Position. # noqa: E501 :type: str @@ -400,7 +405,7 @@ def value(self, value): def margin(self): """Gets the margin of this Position. # noqa: E501 - Position margin. # noqa: E501 + Position margin # noqa: E501 :return: The margin of this Position. # noqa: E501 :rtype: str @@ -411,7 +416,7 @@ def margin(self): def margin(self, margin): """Sets the margin of this Position. - Position margin. # noqa: E501 + Position margin # noqa: E501 :param margin: The margin of this Position. # noqa: E501 :type: str @@ -423,7 +428,7 @@ def margin(self, margin): def entry_price(self): """Gets the entry_price of this Position. # noqa: E501 - Entry price. # noqa: E501 + Entry price # noqa: E501 :return: The entry_price of this Position. # noqa: E501 :rtype: str @@ -434,7 +439,7 @@ def entry_price(self): def entry_price(self, entry_price): """Sets the entry_price of this Position. - Entry price. # noqa: E501 + Entry price # noqa: E501 :param entry_price: The entry_price of this Position. # noqa: E501 :type: str @@ -446,7 +451,7 @@ def entry_price(self, entry_price): def liq_price(self): """Gets the liq_price of this Position. # noqa: E501 - Liquidation price. # noqa: E501 + Liquidation price # noqa: E501 :return: The liq_price of this Position. # noqa: E501 :rtype: str @@ -457,7 +462,7 @@ def liq_price(self): def liq_price(self, liq_price): """Sets the liq_price of this Position. - Liquidation price. # noqa: E501 + Liquidation price # noqa: E501 :param liq_price: The liq_price of this Position. # noqa: E501 :type: str @@ -469,7 +474,7 @@ def liq_price(self, liq_price): def mark_price(self): """Gets the mark_price of this Position. # noqa: E501 - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :return: The mark_price of this Position. # noqa: E501 :rtype: str @@ -480,7 +485,7 @@ def mark_price(self): def mark_price(self, mark_price): """Sets the mark_price of this Position. - Current mark price. # noqa: E501 + Current mark price # noqa: E501 :param mark_price: The mark_price of this Position. # noqa: E501 :type: str @@ -538,7 +543,7 @@ def maintenance_margin(self, maintenance_margin): def unrealised_pnl(self): """Gets the unrealised_pnl of this Position. # noqa: E501 - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :return: The unrealised_pnl of this Position. # noqa: E501 :rtype: str @@ -549,7 +554,7 @@ def unrealised_pnl(self): def unrealised_pnl(self, unrealised_pnl): """Sets the unrealised_pnl of this Position. - Unrealized PNL. # noqa: E501 + Unrealized PNL # noqa: E501 :param unrealised_pnl: The unrealised_pnl of this Position. # noqa: E501 :type: str @@ -561,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 @@ -572,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 @@ -584,7 +589,7 @@ def realised_pnl(self, realised_pnl): def pnl_pnl(self): """Gets the pnl_pnl of this Position. # noqa: E501 - Realized PNL - Position P/L. # noqa: E501 + Realized PNL - Position P/L # noqa: E501 :return: The pnl_pnl of this Position. # noqa: E501 :rtype: str @@ -595,7 +600,7 @@ def pnl_pnl(self): def pnl_pnl(self, pnl_pnl): """Sets the pnl_pnl of this Position. - Realized PNL - Position P/L. # noqa: E501 + Realized PNL - Position P/L # noqa: E501 :param pnl_pnl: The pnl_pnl of this Position. # noqa: E501 :type: str @@ -607,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 @@ -618,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 @@ -630,7 +635,7 @@ def pnl_fund(self, pnl_fund): def pnl_fee(self): """Gets the pnl_fee of this Position. # noqa: E501 - Realized PNL - Transaction Fees. # noqa: E501 + Realized PNL - Transaction Fees # noqa: E501 :return: The pnl_fee of this Position. # noqa: E501 :rtype: str @@ -641,7 +646,7 @@ def pnl_fee(self): def pnl_fee(self, pnl_fee): """Sets the pnl_fee of this Position. - Realized PNL - Transaction Fees. # noqa: E501 + Realized PNL - Transaction Fees # noqa: E501 :param pnl_fee: The pnl_fee of this Position. # noqa: E501 :type: str @@ -653,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 @@ -664,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 @@ -676,7 +681,7 @@ def history_pnl(self, history_pnl): def last_close_pnl(self): """Gets the last_close_pnl of this Position. # noqa: E501 - PNL of last position close. # noqa: E501 + PNL of last position close # noqa: E501 :return: The last_close_pnl of this Position. # noqa: E501 :rtype: str @@ -687,7 +692,7 @@ def last_close_pnl(self): def last_close_pnl(self, last_close_pnl): """Sets the last_close_pnl of this Position. - PNL of last position close. # noqa: E501 + PNL of last position close # noqa: E501 :param last_close_pnl: The last_close_pnl of this Position. # noqa: E501 :type: str @@ -699,7 +704,7 @@ def last_close_pnl(self, last_close_pnl): def realised_point(self): """Gets the realised_point of this Position. # noqa: E501 - Realized POINT PNL. # noqa: E501 + Realized POINT PNL # noqa: E501 :return: The realised_point of this Position. # noqa: E501 :rtype: str @@ -710,7 +715,7 @@ def realised_point(self): def realised_point(self, realised_point): """Sets the realised_point of this Position. - Realized POINT PNL. # noqa: E501 + Realized POINT PNL # noqa: E501 :param realised_point: The realised_point of this Position. # noqa: E501 :type: str @@ -722,7 +727,7 @@ def realised_point(self, realised_point): def history_point(self): """Gets the history_point of this Position. # noqa: E501 - History realized POINT PNL. # noqa: E501 + History realized POINT PNL # noqa: E501 :return: The history_point of this Position. # noqa: E501 :rtype: str @@ -733,7 +738,7 @@ def history_point(self): def history_point(self, history_point): """Sets the history_point of this Position. - History realized POINT PNL. # noqa: E501 + History realized POINT PNL # noqa: E501 :param history_point: The history_point of this Position. # noqa: E501 :type: str @@ -768,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 @@ -779,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 @@ -812,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`: 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 @@ -823,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`: 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 @@ -841,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 @@ -852,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 @@ -864,7 +869,7 @@ def cross_leverage_limit(self, cross_leverage_limit): def update_time(self): """Gets the update_time of this Position. # noqa: E501 - Last update time. # noqa: E501 + Last update time # noqa: E501 :return: The update_time of this Position. # noqa: E501 :rtype: int @@ -875,7 +880,7 @@ def update_time(self): def update_time(self, update_time): """Sets the update_time of this Position. - Last update time. # noqa: E501 + Last update time # noqa: E501 :param update_time: The update_time of this Position. # noqa: E501 :type: int @@ -887,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 @@ -898,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 @@ -910,7 +915,7 @@ def update_id(self, update_id): def open_time(self): """Gets the open_time of this Position. # noqa: E501 - First Open Time. # noqa: E501 + First Open Time # noqa: E501 :return: The open_time of this Position. # noqa: E501 :rtype: int @@ -921,7 +926,7 @@ def open_time(self): def open_time(self, open_time): """Sets the open_time of this Position. - First Open Time. # noqa: E501 + First Open Time # noqa: E501 :param open_time: The open_time of this Position. # noqa: E501 :type: int @@ -933,7 +938,7 @@ def open_time(self, open_time): def risk_limit_table(self): """Gets the risk_limit_table of this Position. # noqa: E501 - Risk limit table ID. # noqa: E501 + Risk limit table ID # noqa: E501 :return: The risk_limit_table of this Position. # noqa: E501 :rtype: str @@ -944,7 +949,7 @@ def risk_limit_table(self): def risk_limit_table(self, risk_limit_table): """Sets the risk_limit_table of this Position. - Risk limit table ID. # noqa: E501 + Risk limit table ID # noqa: E501 :param risk_limit_table: The risk_limit_table of this Position. # noqa: E501 :type: str @@ -956,7 +961,7 @@ def risk_limit_table(self, risk_limit_table): def average_maintenance_rate(self): """Gets the average_maintenance_rate of this Position. # noqa: E501 - Average maintenance margin rate. # noqa: E501 + Average maintenance margin rate # noqa: E501 :return: The average_maintenance_rate of this Position. # noqa: E501 :rtype: str @@ -967,7 +972,7 @@ def average_maintenance_rate(self): def average_maintenance_rate(self, average_maintenance_rate): """Sets the average_maintenance_rate of this Position. - Average maintenance margin rate. # noqa: E501 + Average maintenance margin rate # noqa: E501 :param average_maintenance_rate: The average_maintenance_rate of this Position. # noqa: E501 :type: str @@ -975,6 +980,29 @@ def average_maintenance_rate(self, average_maintenance_rate): 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 95c4614..3ab116d 100644 --- a/gate_api/models/position_close.py +++ b/gate_api/models/position_close.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -117,7 +117,7 @@ def __init__(self, time=None, contract=None, side=None, pnl=None, pnl_pnl=None, def time(self): """Gets the time of this PositionClose. # noqa: E501 - Position close time. # noqa: E501 + Position close time # noqa: E501 :return: The time of this PositionClose. # noqa: E501 :rtype: float @@ -128,7 +128,7 @@ def time(self): def time(self, time): """Sets the time of this PositionClose. - Position close time. # noqa: E501 + Position close time # noqa: E501 :param time: The time of this PositionClose. # noqa: E501 :type: float @@ -140,7 +140,7 @@ def time(self, time): def contract(self): """Gets the contract of this PositionClose. # noqa: E501 - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :return: The contract of this PositionClose. # noqa: E501 :rtype: str @@ -151,7 +151,7 @@ def contract(self): def contract(self, contract): """Sets the contract of this PositionClose. - Futures contract. # noqa: E501 + Futures contract # noqa: E501 :param contract: The contract of this PositionClose. # noqa: E501 :type: str @@ -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 @@ -215,7 +215,7 @@ def pnl(self, pnl): def pnl_pnl(self): """Gets the pnl_pnl of this PositionClose. # noqa: E501 - PNL - Position P/L. # noqa: E501 + PNL - Position P/L # noqa: E501 :return: The pnl_pnl of this PositionClose. # noqa: E501 :rtype: str @@ -226,7 +226,7 @@ def pnl_pnl(self): def pnl_pnl(self, pnl_pnl): """Sets the pnl_pnl of this PositionClose. - PNL - Position P/L. # noqa: E501 + PNL - Position P/L # noqa: E501 :param pnl_pnl: The pnl_pnl of this PositionClose. # noqa: E501 :type: str @@ -238,7 +238,7 @@ def pnl_pnl(self, pnl_pnl): def pnl_fund(self): """Gets the pnl_fund of this PositionClose. # noqa: E501 - PNL - Funding Fees. # noqa: E501 + PNL - Funding Fees # noqa: E501 :return: The pnl_fund of this PositionClose. # noqa: E501 :rtype: str @@ -249,7 +249,7 @@ def pnl_fund(self): def pnl_fund(self, pnl_fund): """Sets the pnl_fund of this PositionClose. - PNL - Funding Fees. # noqa: E501 + PNL - Funding Fees # noqa: E501 :param pnl_fund: The pnl_fund of this PositionClose. # noqa: E501 :type: str @@ -261,7 +261,7 @@ def pnl_fund(self, pnl_fund): def pnl_fee(self): """Gets the pnl_fee of this PositionClose. # noqa: E501 - PNL - Transaction Fees. # noqa: E501 + PNL - Transaction Fees # noqa: E501 :return: The pnl_fee of this PositionClose. # noqa: E501 :rtype: str @@ -272,7 +272,7 @@ def pnl_fee(self): def pnl_fee(self, pnl_fee): """Sets the pnl_fee of this PositionClose. - PNL - Transaction Fees. # noqa: E501 + PNL - Transaction Fees # noqa: E501 :param pnl_fee: The pnl_fee 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 @@ -307,7 +307,7 @@ def text(self, text): def max_size(self): """Gets the max_size of this PositionClose. # noqa: E501 - Max Trade Size. # noqa: E501 + Max Trade Size # noqa: E501 :return: The max_size of this PositionClose. # noqa: E501 :rtype: str @@ -318,7 +318,7 @@ def max_size(self): def max_size(self, max_size): """Sets the max_size of this PositionClose. - Max Trade Size. # noqa: E501 + Max Trade Size # noqa: E501 :param max_size: The max_size of this PositionClose. # noqa: E501 :type: str @@ -330,7 +330,7 @@ def max_size(self, max_size): def accum_size(self): """Gets the accum_size of this PositionClose. # noqa: E501 - Cumulative closed position volume. # noqa: E501 + Cumulative closed position volume # noqa: E501 :return: The accum_size of this PositionClose. # noqa: E501 :rtype: str @@ -341,7 +341,7 @@ def accum_size(self): def accum_size(self, accum_size): """Sets the accum_size of this PositionClose. - Cumulative closed position volume. # noqa: E501 + Cumulative closed position volume # noqa: E501 :param accum_size: The accum_size of this PositionClose. # noqa: E501 :type: str @@ -353,7 +353,7 @@ def accum_size(self, accum_size): def first_open_time(self): """Gets the first_open_time of this PositionClose. # noqa: E501 - First Open Time. # noqa: E501 + First Open Time # noqa: E501 :return: The first_open_time of this PositionClose. # noqa: E501 :rtype: int @@ -364,7 +364,7 @@ def first_open_time(self): def first_open_time(self, first_open_time): """Sets the first_open_time of this PositionClose. - First Open Time. # noqa: E501 + First Open Time # noqa: E501 :param first_open_time: The first_open_time of this PositionClose. # noqa: E501 :type: int @@ -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 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 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 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 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 cc975f5..575f3cd 100644 --- a/gate_api/models/position_close_order.py +++ b/gate_api/models/position_close_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 b5566c3..9f6b1e0 100644 --- a/gate_api/models/profit_loss_range.py +++ b/gate_api/models/profit_loss_range.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, price_percentage=None, implied_volatility_percentage=None, pr def price_percentage(self): """Gets the price_percentage of this ProfitLossRange. # noqa: E501 - Percentage change in price. # noqa: E501 + Percentage change in price # noqa: E501 :return: The price_percentage of this ProfitLossRange. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def price_percentage(self): def price_percentage(self, price_percentage): """Sets the price_percentage of this ProfitLossRange. - Percentage change in price. # noqa: E501 + Percentage change in price # noqa: E501 :param price_percentage: The price_percentage of this ProfitLossRange. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def price_percentage(self, price_percentage): def implied_volatility_percentage(self): """Gets the implied_volatility_percentage of this ProfitLossRange. # noqa: E501 - Percentage change in implied volatility. # noqa: E501 + Percentage change in implied volatility # noqa: E501 :return: The implied_volatility_percentage of this ProfitLossRange. # noqa: E501 :rtype: str @@ -101,7 +101,7 @@ def implied_volatility_percentage(self): def implied_volatility_percentage(self, implied_volatility_percentage): """Sets the implied_volatility_percentage of this ProfitLossRange. - Percentage change in implied volatility. # noqa: E501 + Percentage change in implied volatility # noqa: E501 :param implied_volatility_percentage: The implied_volatility_percentage of this ProfitLossRange. # noqa: E501 :type: str @@ -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 a9ed683..c93d182 100644 --- a/gate_api/models/rebate_user_info.py +++ b/gate_api/models/rebate_user_info.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, invite_uid=None, local_vars_configuration=None): # noqa: E50 def invite_uid(self): """Gets the invite_uid of this RebateUserInfo. # noqa: E501 - My inviter's UID. # noqa: E501 + My inviter's UID # noqa: E501 :return: The invite_uid of this RebateUserInfo. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def invite_uid(self): def invite_uid(self, invite_uid): """Sets the invite_uid of this RebateUserInfo. - My inviter's UID. # noqa: E501 + My inviter's UID # noqa: E501 :param invite_uid: The invite_uid of this RebateUserInfo. # noqa: E501 :type: int diff --git a/gate_api/models/repay_currency_res.py b/gate_api/models/repay_currency_res.py index 1137fa0..f818b19 100644 --- a/gate_api/models/repay_currency_res.py +++ b/gate_api/models/repay_currency_res.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -151,7 +151,7 @@ def message(self, message): def currency(self): """Gets the currency of this RepayCurrencyRes. # noqa: E501 - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :return: The currency of this RepayCurrencyRes. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this RepayCurrencyRes. - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :param currency: The currency of this RepayCurrencyRes. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def currency(self, currency): def repaid_principal(self): """Gets the repaid_principal of this RepayCurrencyRes. # noqa: E501 - Principal. # noqa: E501 + Principal # noqa: E501 :return: The repaid_principal of this RepayCurrencyRes. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def repaid_principal(self): def repaid_principal(self, repaid_principal): """Sets the repaid_principal of this RepayCurrencyRes. - Principal. # noqa: E501 + Principal # noqa: E501 :param repaid_principal: The repaid_principal of this RepayCurrencyRes. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def repaid_principal(self, repaid_principal): def repaid_interest(self): """Gets the repaid_interest of this RepayCurrencyRes. # noqa: E501 - Principal. # noqa: E501 + Principal # noqa: E501 :return: The repaid_interest of this RepayCurrencyRes. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def repaid_interest(self): def repaid_interest(self, repaid_interest): """Sets the repaid_interest of this RepayCurrencyRes. - Principal. # noqa: E501 + Principal # noqa: E501 :param repaid_interest: The repaid_interest of this RepayCurrencyRes. # noqa: E501 :type: str diff --git a/gate_api/models/repay_loan.py b/gate_api/models/repay_loan.py index c683b0a..f8d97d6 100644 --- a/gate_api/models/repay_loan.py +++ b/gate_api/models/repay_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -64,7 +64,7 @@ def __init__(self, order_id=None, repay_amount=None, repaid_all=None, local_vars def order_id(self): """Gets the order_id of this RepayLoan. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this RepayLoan. # noqa: E501 :rtype: int @@ -75,7 +75,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this RepayLoan. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this RepayLoan. # noqa: E501 :type: int @@ -89,7 +89,7 @@ def order_id(self, order_id): def repay_amount(self): """Gets the repay_amount of this RepayLoan. # noqa: E501 - Repayment amount, it is mandatory when making partial repayments. # noqa: E501 + Repayment amount, it is mandatory when making partial repayments # noqa: E501 :return: The repay_amount of this RepayLoan. # noqa: E501 :rtype: str @@ -100,7 +100,7 @@ def repay_amount(self): def repay_amount(self, repay_amount): """Sets the repay_amount of this RepayLoan. - Repayment amount, it is mandatory when making partial repayments. # noqa: E501 + Repayment amount, it is mandatory when making partial repayments # noqa: E501 :param repay_amount: The repay_amount of this RepayLoan. # noqa: E501 :type: str diff --git a/gate_api/models/repay_multi_loan.py b/gate_api/models/repay_multi_loan.py index 9052f77..20c2385 100644 --- a/gate_api/models/repay_multi_loan.py +++ b/gate_api/models/repay_multi_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -60,7 +60,7 @@ def __init__(self, order_id=None, repay_items=None, local_vars_configuration=Non def order_id(self): """Gets the order_id of this RepayMultiLoan. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this RepayMultiLoan. # noqa: E501 :rtype: int @@ -71,7 +71,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this RepayMultiLoan. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this RepayMultiLoan. # noqa: E501 :type: int @@ -85,7 +85,7 @@ def order_id(self, order_id): def repay_items(self): """Gets the repay_items of this RepayMultiLoan. # noqa: E501 - Repay Currency Item. # noqa: E501 + Repay Currency Item # noqa: E501 :return: The repay_items of this RepayMultiLoan. # noqa: E501 :rtype: list[MultiLoanRepayItem] @@ -96,7 +96,7 @@ def repay_items(self): def repay_items(self, repay_items): """Sets the repay_items of this RepayMultiLoan. - Repay Currency Item. # noqa: E501 + Repay Currency Item # noqa: E501 :param repay_items: The repay_items of this RepayMultiLoan. # noqa: E501 :type: list[MultiLoanRepayItem] diff --git a/gate_api/models/repay_record.py b/gate_api/models/repay_record.py index 37e3b9c..faef08c 100644 --- a/gate_api/models/repay_record.py +++ b/gate_api/models/repay_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -117,7 +117,7 @@ def __init__(self, order_id=None, record_id=None, repaid_amount=None, borrow_cur def order_id(self): """Gets the order_id of this RepayRecord. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The order_id of this RepayRecord. # noqa: E501 :rtype: int @@ -128,7 +128,7 @@ def order_id(self): def order_id(self, order_id): """Sets the order_id of this RepayRecord. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param order_id: The order_id of this RepayRecord. # noqa: E501 :type: int @@ -140,7 +140,7 @@ def order_id(self, order_id): def record_id(self): """Gets the record_id of this RepayRecord. # noqa: E501 - Repayment record ID. # noqa: E501 + Repayment record ID # noqa: E501 :return: The record_id of this RepayRecord. # noqa: E501 :rtype: int @@ -151,7 +151,7 @@ def record_id(self): def record_id(self, record_id): """Sets the record_id of this RepayRecord. - Repayment record ID. # noqa: E501 + Repayment record ID # noqa: E501 :param record_id: The record_id of this RepayRecord. # noqa: E501 :type: int @@ -163,7 +163,7 @@ def record_id(self, record_id): def repaid_amount(self): """Gets the repaid_amount of this RepayRecord. # noqa: E501 - Repayment amount. # noqa: E501 + Repayment amount # noqa: E501 :return: The repaid_amount of this RepayRecord. # noqa: E501 :rtype: str @@ -174,7 +174,7 @@ def repaid_amount(self): def repaid_amount(self, repaid_amount): """Sets the repaid_amount of this RepayRecord. - Repayment amount. # noqa: E501 + Repayment amount # noqa: E501 :param repaid_amount: The repaid_amount of this RepayRecord. # noqa: E501 :type: str @@ -186,7 +186,7 @@ def repaid_amount(self, repaid_amount): def borrow_currency(self): """Gets the borrow_currency of this RepayRecord. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this RepayRecord. # noqa: E501 :rtype: str @@ -197,7 +197,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this RepayRecord. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_currency of this RepayRecord. # noqa: E501 :type: str @@ -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 @@ -255,7 +255,7 @@ def init_ltv(self, init_ltv): def borrow_time(self): """Gets the borrow_time of this RepayRecord. # noqa: E501 - Borrowing time, timestamp. # noqa: E501 + Borrowing time, timestamp # noqa: E501 :return: The borrow_time of this RepayRecord. # noqa: E501 :rtype: int @@ -266,7 +266,7 @@ def borrow_time(self): def borrow_time(self, borrow_time): """Sets the borrow_time of this RepayRecord. - Borrowing time, timestamp. # noqa: E501 + Borrowing time, timestamp # noqa: E501 :param borrow_time: The borrow_time of this RepayRecord. # noqa: E501 :type: int @@ -278,7 +278,7 @@ def borrow_time(self, borrow_time): def repay_time(self): """Gets the repay_time of this RepayRecord. # noqa: E501 - Repayment time, timestamp. # noqa: E501 + Repayment time, timestamp # noqa: E501 :return: The repay_time of this RepayRecord. # noqa: E501 :rtype: int @@ -289,7 +289,7 @@ def repay_time(self): def repay_time(self, repay_time): """Sets the repay_time of this RepayRecord. - Repayment time, timestamp. # noqa: E501 + Repayment time, timestamp # noqa: E501 :param repay_time: The repay_time of this RepayRecord. # noqa: E501 :type: int @@ -301,7 +301,7 @@ def repay_time(self, repay_time): def total_interest(self): """Gets the total_interest of this RepayRecord. # noqa: E501 - Total interest. # noqa: E501 + Total interest # noqa: E501 :return: The total_interest of this RepayRecord. # noqa: E501 :rtype: str @@ -312,7 +312,7 @@ def total_interest(self): def total_interest(self, total_interest): """Sets the total_interest of this RepayRecord. - Total interest. # noqa: E501 + Total interest # noqa: E501 :param total_interest: The total_interest of this RepayRecord. # noqa: E501 :type: str @@ -324,7 +324,7 @@ def total_interest(self, total_interest): def before_left_principal(self): """Gets the before_left_principal of this RepayRecord. # noqa: E501 - Principal to be repaid before repayment. # noqa: E501 + Principal to be repaid before repayment # noqa: E501 :return: The before_left_principal of this RepayRecord. # noqa: E501 :rtype: str @@ -335,7 +335,7 @@ def before_left_principal(self): def before_left_principal(self, before_left_principal): """Sets the before_left_principal of this RepayRecord. - Principal to be repaid before repayment. # noqa: E501 + Principal to be repaid before repayment # noqa: E501 :param before_left_principal: The before_left_principal of this RepayRecord. # noqa: E501 :type: str @@ -347,7 +347,7 @@ def before_left_principal(self, before_left_principal): def after_left_principal(self): """Gets the after_left_principal of this RepayRecord. # noqa: E501 - Principal to be repaid after repayment. # noqa: E501 + Principal to be repaid after repayment # noqa: E501 :return: The after_left_principal of this RepayRecord. # noqa: E501 :rtype: str @@ -358,7 +358,7 @@ def after_left_principal(self): def after_left_principal(self, after_left_principal): """Sets the after_left_principal of this RepayRecord. - Principal to be repaid after repayment. # noqa: E501 + Principal to be repaid after repayment # noqa: E501 :param after_left_principal: The after_left_principal 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 2200f99..1f175bc 100644 --- a/gate_api/models/repay_record_currency.py +++ b/gate_api/models/repay_record_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, index_price=None, before_amount=None, before_a def currency(self): """Gets the currency of this RepayRecordCurrency. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this RepayRecordCurrency. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this RepayRecordCurrency. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this RepayRecordCurrency. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this RepayRecordCurrency. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this RepayRecordCurrency. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this RepayRecordCurrency. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this RepayRecordCurrency. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def index_price(self, index_price): def before_amount(self): """Gets the before_amount of this RepayRecordCurrency. # noqa: E501 - Amount before the operation. # noqa: E501 + Amount before the operation # noqa: E501 :return: The before_amount of this RepayRecordCurrency. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def before_amount(self): def before_amount(self, before_amount): """Sets the before_amount of this RepayRecordCurrency. - Amount before the operation. # noqa: E501 + Amount before the operation # noqa: E501 :param before_amount: The before_amount of this RepayRecordCurrency. # noqa: E501 :type: str @@ -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 05a50b7..604dd12 100644 --- a/gate_api/models/repay_record_left_interest.py +++ b/gate_api/models/repay_record_left_interest.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, index_price=None, before_amount=None, before_a def currency(self): """Gets the currency of this RepayRecordLeftInterest. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this RepayRecordLeftInterest. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this RepayRecordLeftInterest. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this RepayRecordLeftInterest. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this RepayRecordLeftInterest. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this RepayRecordLeftInterest. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this RepayRecordLeftInterest. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this RepayRecordLeftInterest. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def index_price(self, index_price): def before_amount(self): """Gets the before_amount of this RepayRecordLeftInterest. # noqa: E501 - Interest amount before repayment. # noqa: E501 + Interest amount before repayment # noqa: E501 :return: The before_amount of this RepayRecordLeftInterest. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def before_amount(self): def before_amount(self, before_amount): """Sets the before_amount of this RepayRecordLeftInterest. - Interest amount before repayment. # noqa: E501 + Interest amount before repayment # noqa: E501 :param before_amount: The before_amount of this RepayRecordLeftInterest. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def before_amount(self, before_amount): def before_amount_usdt(self): """Gets the before_amount_usdt of this RepayRecordLeftInterest. # noqa: E501 - Converted value of interest before repayment in USDT. # noqa: E501 + Converted value of interest before repayment in USDT # noqa: E501 :return: The before_amount_usdt of this RepayRecordLeftInterest. # 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 RepayRecordLeftInterest. - Converted value of interest before repayment in USDT. # noqa: E501 + Converted value of interest before repayment in USDT # noqa: E501 :param before_amount_usdt: The before_amount_usdt of this RepayRecordLeftInterest. # 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 RepayRecordLeftInterest. # noqa: E501 - Interest amount after repayment. # noqa: E501 + Interest amount after repayment # noqa: E501 :return: The after_amount of this RepayRecordLeftInterest. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def after_amount(self): def after_amount(self, after_amount): """Sets the after_amount of this RepayRecordLeftInterest. - Interest amount after repayment. # noqa: E501 + Interest amount after repayment # noqa: E501 :param after_amount: The after_amount of this RepayRecordLeftInterest. # 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 RepayRecordLeftInterest. # noqa: E501 - Converted value of interest after repayment in USDT. # noqa: E501 + Converted value of interest after repayment in USDT # noqa: E501 :return: The after_amount_usdt of this RepayRecordLeftInterest. # 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 RepayRecordLeftInterest. - Converted value of interest after repayment in USDT. # noqa: E501 + Converted value of interest after repayment in USDT # noqa: E501 :param after_amount_usdt: The after_amount_usdt of this RepayRecordLeftInterest. # noqa: E501 :type: str diff --git a/gate_api/models/repay_record_repaid_currency.py b/gate_api/models/repay_record_repaid_currency.py index b681dd7..5aa54fd 100644 --- a/gate_api/models/repay_record_repaid_currency.py +++ b/gate_api/models/repay_record_repaid_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, index_price=None, repaid_amount=None, repaid_p def currency(self): """Gets the currency of this RepayRecordRepaidCurrency. # noqa: E501 - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :return: The currency of this RepayRecordRepaidCurrency. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this RepayRecordRepaidCurrency. - Repayment currency. # noqa: E501 + Repayment currency # noqa: E501 :param currency: The currency of this RepayRecordRepaidCurrency. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this RepayRecordRepaidCurrency. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this RepayRecordRepaidCurrency. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this RepayRecordRepaidCurrency. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this RepayRecordRepaidCurrency. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def index_price(self, index_price): def repaid_amount(self): """Gets the repaid_amount of this RepayRecordRepaidCurrency. # noqa: E501 - Repayment amount. # noqa: E501 + Repayment amount # noqa: E501 :return: The repaid_amount of this RepayRecordRepaidCurrency. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def repaid_amount(self): def repaid_amount(self, repaid_amount): """Sets the repaid_amount of this RepayRecordRepaidCurrency. - Repayment amount. # noqa: E501 + Repayment amount # noqa: E501 :param repaid_amount: The repaid_amount of this RepayRecordRepaidCurrency. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def repaid_amount(self, repaid_amount): def repaid_principal(self): """Gets the repaid_principal of this RepayRecordRepaidCurrency. # noqa: E501 - Principal. # noqa: E501 + Principal # noqa: E501 :return: The repaid_principal of this RepayRecordRepaidCurrency. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def repaid_principal(self): def repaid_principal(self, repaid_principal): """Sets the repaid_principal of this RepayRecordRepaidCurrency. - Principal. # noqa: E501 + Principal # noqa: E501 :param repaid_principal: The repaid_principal of this RepayRecordRepaidCurrency. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def repaid_principal(self, repaid_principal): def repaid_interest(self): """Gets the repaid_interest of this RepayRecordRepaidCurrency. # noqa: E501 - Interest. # noqa: E501 + Interest # noqa: E501 :return: The repaid_interest of this RepayRecordRepaidCurrency. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def repaid_interest(self): def repaid_interest(self, repaid_interest): """Sets the repaid_interest of this RepayRecordRepaidCurrency. - Interest. # noqa: E501 + Interest # noqa: E501 :param repaid_interest: The repaid_interest of this RepayRecordRepaidCurrency. # noqa: E501 :type: str @@ -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 0d8a839..11e31c4 100644 --- a/gate_api/models/repay_record_total_interest.py +++ b/gate_api/models/repay_record_total_interest.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, index_price=None, amount=None, amount_usdt=Non def currency(self): """Gets the currency of this RepayRecordTotalInterest. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this RepayRecordTotalInterest. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this RepayRecordTotalInterest. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this RepayRecordTotalInterest. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def currency(self, currency): def index_price(self): """Gets the index_price of this RepayRecordTotalInterest. # noqa: E501 - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :return: The index_price of this RepayRecordTotalInterest. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def index_price(self): def index_price(self, index_price): """Sets the index_price of this RepayRecordTotalInterest. - Currency Index Price. # noqa: E501 + Currency Index Price # noqa: E501 :param index_price: The index_price of this RepayRecordTotalInterest. # noqa: E501 :type: str @@ -118,7 +118,7 @@ def index_price(self, index_price): def amount(self): """Gets the amount of this RepayRecordTotalInterest. # noqa: E501 - Interest Amount. # noqa: E501 + Interest Amount # noqa: E501 :return: The amount of this RepayRecordTotalInterest. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this RepayRecordTotalInterest. - Interest Amount. # noqa: E501 + Interest Amount # noqa: E501 :param amount: The amount of this RepayRecordTotalInterest. # noqa: E501 :type: str @@ -141,7 +141,7 @@ def amount(self, amount): def amount_usdt(self): """Gets the amount_usdt of this RepayRecordTotalInterest. # noqa: E501 - Interest amount converted to USDT. # noqa: E501 + Interest amount converted to USDT # noqa: E501 :return: The amount_usdt of this RepayRecordTotalInterest. # noqa: E501 :rtype: str @@ -152,7 +152,7 @@ def amount_usdt(self): def amount_usdt(self, amount_usdt): """Sets the amount_usdt of this RepayRecordTotalInterest. - Interest amount converted to USDT. # noqa: E501 + Interest amount converted to USDT # noqa: E501 :param amount_usdt: The amount_usdt of this RepayRecordTotalInterest. # noqa: E501 :type: str diff --git a/gate_api/models/repay_resp.py b/gate_api/models/repay_resp.py index 2446ead..f35f6bc 100644 --- a/gate_api/models/repay_resp.py +++ b/gate_api/models/repay_resp.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, repaid_principal=None, repaid_interest=None, local_vars_confi def repaid_principal(self): """Gets the repaid_principal of this RepayResp. # noqa: E501 - Principal. # noqa: E501 + Principal # noqa: E501 :return: The repaid_principal of this RepayResp. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def repaid_principal(self): def repaid_principal(self, repaid_principal): """Sets the repaid_principal of this RepayResp. - Principal. # noqa: E501 + Principal # noqa: E501 :param repaid_principal: The repaid_principal of this RepayResp. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def repaid_principal(self, repaid_principal): def repaid_interest(self): """Gets the repaid_interest of this RepayResp. # noqa: E501 - Interest. # noqa: E501 + Interest # noqa: E501 :return: The repaid_interest of this RepayResp. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def repaid_interest(self): def repaid_interest(self, repaid_interest): """Sets the repaid_interest of this RepayResp. - Interest. # noqa: E501 + Interest # noqa: E501 :param repaid_interest: The repaid_interest of this RepayResp. # noqa: E501 :type: str diff --git a/gate_api/models/risk_units.py b/gate_api/models/risk_units.py index 69c1549..9ab5a17 100644 --- a/gate_api/models/risk_units.py +++ b/gate_api/models/risk_units.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, symbol=None, spot_in_use=None, maintain_margin=None, initial_ def symbol(self): """Gets the symbol of this RiskUnits. # noqa: E501 - Risk unit flag. # noqa: E501 + Risk unit flag # noqa: E501 :return: The symbol of this RiskUnits. # noqa: E501 :rtype: str @@ -103,7 +103,7 @@ def symbol(self): def symbol(self, symbol): """Sets the symbol of this RiskUnits. - Risk unit flag. # noqa: E501 + Risk unit flag # noqa: E501 :param symbol: The symbol of this RiskUnits. # noqa: E501 :type: str @@ -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 @@ -138,7 +138,7 @@ def spot_in_use(self, spot_in_use): def maintain_margin(self): """Gets the maintain_margin of this RiskUnits. # noqa: E501 - Maintenance margin for risk unit. # noqa: E501 + Maintenance margin for risk unit # noqa: E501 :return: The maintain_margin of this RiskUnits. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def maintain_margin(self): def maintain_margin(self, maintain_margin): """Sets the maintain_margin of this RiskUnits. - Maintenance margin for risk unit. # noqa: E501 + Maintenance margin for risk unit # noqa: E501 :param maintain_margin: The maintain_margin of this RiskUnits. # noqa: E501 :type: str @@ -161,7 +161,7 @@ def maintain_margin(self, maintain_margin): def initial_margin(self): """Gets the initial_margin of this RiskUnits. # noqa: E501 - Initial margin for risk unit. # noqa: E501 + Initial margin for risk unit # noqa: E501 :return: The initial_margin of this RiskUnits. # noqa: E501 :rtype: str @@ -172,7 +172,7 @@ def initial_margin(self): def initial_margin(self, initial_margin): """Sets the initial_margin of this RiskUnits. - Initial margin for risk unit. # noqa: E501 + Initial margin for risk unit # noqa: E501 :param initial_margin: The initial_margin of this RiskUnits. # noqa: E501 :type: str @@ -184,7 +184,7 @@ def initial_margin(self, initial_margin): def delta(self): """Gets the delta of this RiskUnits. # noqa: E501 - Total Delta of risk unit. # noqa: E501 + Total Delta of risk unit # noqa: E501 :return: The delta of this RiskUnits. # noqa: E501 :rtype: str @@ -195,7 +195,7 @@ def delta(self): def delta(self, delta): """Sets the delta of this RiskUnits. - Total Delta of risk unit. # noqa: E501 + Total Delta of risk unit # noqa: E501 :param delta: The delta of this RiskUnits. # noqa: E501 :type: str @@ -207,7 +207,7 @@ def delta(self, delta): def gamma(self): """Gets the gamma of this RiskUnits. # noqa: E501 - Total Gamma of risk unit. # noqa: E501 + Total Gamma of risk unit # noqa: E501 :return: The gamma of this RiskUnits. # noqa: E501 :rtype: str @@ -218,7 +218,7 @@ def gamma(self): def gamma(self, gamma): """Sets the gamma of this RiskUnits. - Total Gamma of risk unit. # noqa: E501 + Total Gamma of risk unit # noqa: E501 :param gamma: The gamma of this RiskUnits. # noqa: E501 :type: str @@ -230,7 +230,7 @@ def gamma(self, gamma): def theta(self): """Gets the theta of this RiskUnits. # noqa: E501 - Total Theta of risk unit. # noqa: E501 + Total Theta of risk unit # noqa: E501 :return: The theta of this RiskUnits. # noqa: E501 :rtype: str @@ -241,7 +241,7 @@ def theta(self): def theta(self, theta): """Sets the theta of this RiskUnits. - Total Theta of risk unit. # noqa: E501 + Total Theta of risk unit # noqa: E501 :param theta: The theta of this RiskUnits. # noqa: E501 :type: str @@ -253,7 +253,7 @@ def theta(self, theta): def vega(self): """Gets the vega of this RiskUnits. # noqa: E501 - Total Vega of risk unit. # noqa: E501 + Total Vega of risk unit # noqa: E501 :return: The vega of this RiskUnits. # noqa: E501 :rtype: str @@ -264,7 +264,7 @@ def vega(self): def vega(self, vega): """Sets the vega of this RiskUnits. - Total Vega of risk unit. # noqa: E501 + Total Vega of risk unit # noqa: E501 :param vega: The vega of this RiskUnits. # noqa: E501 :type: str diff --git a/gate_api/models/saved_address.py b/gate_api/models/saved_address.py index 180f0ca..d82f14d 100644 --- a/gate_api/models/saved_address.py +++ b/gate_api/models/saved_address.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, chain=None, address=None, name=None, tag=None, def currency(self): """Gets the currency of this SavedAddress. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this SavedAddress. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SavedAddress. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this SavedAddress. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def chain(self): """Gets the chain of this SavedAddress. # noqa: E501 - Chain name. # noqa: E501 + Chain name # noqa: E501 :return: The chain of this SavedAddress. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this SavedAddress. - Chain name. # noqa: E501 + Chain name # noqa: E501 :param chain: The chain of this SavedAddress. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def chain(self, chain): def address(self): """Gets the address of this SavedAddress. # noqa: E501 - Address. # noqa: E501 + Address # noqa: E501 :return: The address of this SavedAddress. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def address(self): def address(self, address): """Sets the address of this SavedAddress. - Address. # noqa: E501 + Address # noqa: E501 :param address: The address of this SavedAddress. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def address(self, address): def name(self): """Gets the name of this SavedAddress. # noqa: E501 - Name. # noqa: E501 + Name # noqa: E501 :return: The name of this SavedAddress. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def name(self): def name(self, name): """Sets the name of this SavedAddress. - Name. # noqa: E501 + Name # noqa: E501 :param name: The name of this SavedAddress. # noqa: E501 :type: str @@ -174,7 +174,7 @@ def name(self, name): def tag(self): """Gets the tag of this SavedAddress. # noqa: E501 - Tag. # noqa: E501 + Tag # noqa: E501 :return: The tag of this SavedAddress. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def tag(self): def tag(self, tag): """Sets the tag of this SavedAddress. - Tag. # noqa: E501 + Tag # noqa: E501 :param tag: The tag of this SavedAddress. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def tag(self, tag): def verified(self): """Gets the verified of this SavedAddress. # noqa: E501 - Whether to pass the verification 0-unverified, 1-verified. # noqa: E501 + Whether to pass the verification 0-unverified, 1-verified # noqa: E501 :return: The verified of this SavedAddress. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def verified(self): def verified(self, verified): """Sets the verified of this SavedAddress. - Whether to pass the verification 0-unverified, 1-verified. # noqa: E501 + Whether to pass the verification 0-unverified, 1-verified # noqa: E501 :param verified: The verified of this SavedAddress. # noqa: E501 :type: str diff --git a/gate_api/models/small_balance.py b/gate_api/models/small_balance.py index bb5ff42..a31cd14 100644 --- a/gate_api/models/small_balance.py +++ b/gate_api/models/small_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, available_balance=None, estimated_as_btc=None, def currency(self): """Gets the currency of this SmallBalance. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this SmallBalance. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SmallBalance. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this SmallBalance. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def currency(self, currency): def available_balance(self): """Gets the available_balance of this SmallBalance. # noqa: E501 - Available balance. # noqa: E501 + Available balance # noqa: E501 :return: The available_balance of this SmallBalance. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def available_balance(self): def available_balance(self, available_balance): """Sets the available_balance of this SmallBalance. - Available balance. # noqa: E501 + Available balance # noqa: E501 :param available_balance: The available_balance of this SmallBalance. # noqa: E501 :type: str @@ -118,7 +118,7 @@ def available_balance(self, available_balance): def estimated_as_btc(self): """Gets the estimated_as_btc of this SmallBalance. # noqa: E501 - Estimated as BTC. # noqa: E501 + Estimated as BTC # noqa: E501 :return: The estimated_as_btc of this SmallBalance. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def estimated_as_btc(self): def estimated_as_btc(self, estimated_as_btc): """Sets the estimated_as_btc of this SmallBalance. - Estimated as BTC. # noqa: E501 + Estimated as BTC # noqa: E501 :param estimated_as_btc: The estimated_as_btc of this SmallBalance. # noqa: E501 :type: str @@ -141,7 +141,7 @@ def estimated_as_btc(self, estimated_as_btc): def convertible_to_gt(self): """Gets the convertible_to_gt of this SmallBalance. # noqa: E501 - Estimated conversion to GT. # noqa: E501 + Estimated conversion to GT # noqa: E501 :return: The convertible_to_gt of this SmallBalance. # noqa: E501 :rtype: str @@ -152,7 +152,7 @@ def convertible_to_gt(self): def convertible_to_gt(self, convertible_to_gt): """Sets the convertible_to_gt of this SmallBalance. - Estimated conversion to GT. # noqa: E501 + Estimated conversion to GT # noqa: E501 :param convertible_to_gt: The convertible_to_gt of this SmallBalance. # noqa: E501 :type: str diff --git a/gate_api/models/small_balance_history.py b/gate_api/models/small_balance_history.py index b7a420a..da3a1d3 100644 --- a/gate_api/models/small_balance_history.py +++ b/gate_api/models/small_balance_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, id=None, currency=None, amount=None, gt_amount=None, create_t def id(self): """Gets the id of this SmallBalanceHistory. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this SmallBalanceHistory. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def id(self): def id(self, id): """Sets the id of this SmallBalanceHistory. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this SmallBalanceHistory. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def id(self, id): def currency(self): """Gets the currency of this SmallBalanceHistory. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this SmallBalanceHistory. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SmallBalanceHistory. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this SmallBalanceHistory. # noqa: E501 :type: str @@ -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 @@ -146,7 +146,7 @@ def amount(self, amount): def gt_amount(self): """Gets the gt_amount of this SmallBalanceHistory. # noqa: E501 - GT amount. # noqa: E501 + GT amount # noqa: E501 :return: The gt_amount of this SmallBalanceHistory. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def gt_amount(self): def gt_amount(self, gt_amount): """Sets the gt_amount of this SmallBalanceHistory. - GT amount. # noqa: E501 + GT amount # noqa: E501 :param gt_amount: The gt_amount of this SmallBalanceHistory. # noqa: E501 :type: str @@ -169,7 +169,7 @@ def gt_amount(self, gt_amount): def create_time(self): """Gets the create_time of this SmallBalanceHistory. # noqa: E501 - Exchange time (in seconds). # noqa: E501 + Exchange time (in seconds) # noqa: E501 :return: The create_time of this SmallBalanceHistory. # noqa: E501 :rtype: int @@ -180,7 +180,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this SmallBalanceHistory. - Exchange time (in seconds). # noqa: E501 + Exchange time (in seconds) # noqa: E501 :param create_time: The create_time of this SmallBalanceHistory. # noqa: E501 :type: int diff --git a/gate_api/models/spot_account.py b/gate_api/models/spot_account.py index 79f3eb8..e4f1aba 100644 --- a/gate_api/models/spot_account.py +++ b/gate_api/models/spot_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, available=None, locked=None, update_id=None, l def currency(self): """Gets the currency of this SpotAccount. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this SpotAccount. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SpotAccount. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this SpotAccount. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def currency(self, currency): def available(self): """Gets the available of this SpotAccount. # noqa: E501 - Available amount. # noqa: E501 + Available amount # noqa: E501 :return: The available of this SpotAccount. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def available(self): def available(self, available): """Sets the available of this SpotAccount. - Available amount. # noqa: E501 + Available amount # noqa: E501 :param available: The available of this SpotAccount. # noqa: E501 :type: str @@ -118,7 +118,7 @@ def available(self, available): def locked(self): """Gets the locked of this SpotAccount. # noqa: E501 - Locked amount, used in trading. # noqa: E501 + Locked amount, used in trading # noqa: E501 :return: The locked of this SpotAccount. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def locked(self): def locked(self, locked): """Sets the locked of this SpotAccount. - Locked amount, used in trading. # noqa: E501 + Locked amount, used in trading # noqa: E501 :param locked: The locked of this SpotAccount. # noqa: E501 :type: str @@ -141,7 +141,7 @@ def locked(self, locked): def update_id(self): """Gets the update_id of this SpotAccount. # noqa: E501 - Version number. # noqa: E501 + Version number # noqa: E501 :return: The update_id of this SpotAccount. # noqa: E501 :rtype: int @@ -152,7 +152,7 @@ def update_id(self): def update_id(self, update_id): """Sets the update_id of this SpotAccount. - Version number. # noqa: E501 + Version number # noqa: E501 :param update_id: The update_id of this SpotAccount. # noqa: E501 :type: int diff --git a/gate_api/models/spot_account_book.py b/gate_api/models/spot_account_book.py index 7f3d6f6..081b281 100644 --- a/gate_api/models/spot_account_book.py +++ b/gate_api/models/spot_account_book.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -92,7 +92,7 @@ def __init__(self, id=None, time=None, currency=None, change=None, balance=None, def id(self): """Gets the id of this SpotAccountBook. # noqa: E501 - Balance change record ID. # noqa: E501 + Balance change record ID # noqa: E501 :return: The id of this SpotAccountBook. # noqa: E501 :rtype: str @@ -103,7 +103,7 @@ def id(self): def id(self, id): """Sets the id of this SpotAccountBook. - Balance change record ID. # noqa: E501 + Balance change record ID # noqa: E501 :param id: The id of this SpotAccountBook. # noqa: E501 :type: str @@ -115,7 +115,7 @@ def id(self, id): def time(self): """Gets the time of this SpotAccountBook. # noqa: E501 - The timestamp of the change (in milliseconds). # noqa: E501 + The timestamp of the change (in milliseconds) # noqa: E501 :return: The time of this SpotAccountBook. # noqa: E501 :rtype: int @@ -126,7 +126,7 @@ def time(self): def time(self, time): """Sets the time of this SpotAccountBook. - The timestamp of the change (in milliseconds). # noqa: E501 + The timestamp of the change (in milliseconds) # noqa: E501 :param time: The time of this SpotAccountBook. # noqa: E501 :type: int @@ -138,7 +138,7 @@ def time(self, time): def currency(self): """Gets the currency of this SpotAccountBook. # noqa: E501 - Currency changed. # noqa: E501 + Currency changed # noqa: E501 :return: The currency of this SpotAccountBook. # noqa: E501 :rtype: str @@ -149,7 +149,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SpotAccountBook. - Currency changed. # noqa: E501 + Currency changed # noqa: E501 :param currency: The currency of this SpotAccountBook. # noqa: E501 :type: str @@ -161,7 +161,7 @@ def currency(self, currency): def change(self): """Gets the change of this SpotAccountBook. # noqa: E501 - Amount changed. Positive value means transferring in, while negative out. # noqa: E501 + Amount changed. Positive value means transferring in, while negative out # noqa: E501 :return: The change of this SpotAccountBook. # noqa: E501 :rtype: str @@ -172,7 +172,7 @@ def change(self): def change(self, change): """Sets the change of this SpotAccountBook. - Amount changed. Positive value means transferring in, while negative out. # noqa: E501 + Amount changed. Positive value means transferring in, while negative out # noqa: E501 :param change: The change of this SpotAccountBook. # noqa: E501 :type: str @@ -184,7 +184,7 @@ def change(self, change): def balance(self): """Gets the balance of this SpotAccountBook. # noqa: E501 - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :return: The balance of this SpotAccountBook. # noqa: E501 :rtype: str @@ -195,7 +195,7 @@ def balance(self): def balance(self, balance): """Sets the balance of this SpotAccountBook. - Balance after change. # noqa: E501 + Balance after change # noqa: E501 :param balance: The balance of this SpotAccountBook. # noqa: E501 :type: str @@ -230,7 +230,7 @@ def type(self, type): def code(self): """Gets the code of this SpotAccountBook. # noqa: E501 - Account change code, see [Asset Record Code] (Asset Record Code). # noqa: E501 + Account change code, see [Asset Record Code] (Asset Record Code) # noqa: E501 :return: The code of this SpotAccountBook. # noqa: E501 :rtype: str @@ -241,7 +241,7 @@ def code(self): def code(self, code): """Sets the code of this SpotAccountBook. - Account change code, see [Asset Record Code] (Asset Record Code). # noqa: E501 + Account change code, see [Asset Record Code] (Asset Record Code) # noqa: E501 :param code: The code of this SpotAccountBook. # noqa: E501 :type: str @@ -253,7 +253,7 @@ def code(self, code): def text(self): """Gets the text of this SpotAccountBook. # noqa: E501 - Additional information. # noqa: E501 + Additional information # noqa: E501 :return: The text of this SpotAccountBook. # noqa: E501 :rtype: str @@ -264,7 +264,7 @@ def text(self): def text(self, text): """Sets the text of this SpotAccountBook. - Additional information. # noqa: E501 + Additional information # noqa: E501 :param text: The text of this SpotAccountBook. # noqa: E501 :type: str diff --git a/gate_api/models/spot_currency_chain.py b/gate_api/models/spot_currency_chain.py index 418cd6f..7dc9a48 100644 --- a/gate_api/models/spot_currency_chain.py +++ b/gate_api/models/spot_currency_chain.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, name=None, addr=None, withdraw_disabled=None, withdraw_delaye def name(self): """Gets the name of this SpotCurrencyChain. # noqa: E501 - Chain name. # noqa: E501 + Blockchain name # noqa: E501 :return: The name of this SpotCurrencyChain. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def name(self): def name(self, name): """Sets the name of this SpotCurrencyChain. - Chain name. # noqa: E501 + Blockchain name # noqa: E501 :param name: The name of this SpotCurrencyChain. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def name(self, name): def addr(self): """Gets the addr of this SpotCurrencyChain. # noqa: E501 - token address. # noqa: E501 + token address # noqa: E501 :return: The addr of this SpotCurrencyChain. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def addr(self): def addr(self, addr): """Sets the addr of this SpotCurrencyChain. - token address. # noqa: E501 + token address # noqa: E501 :param addr: The addr of this SpotCurrencyChain. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def addr(self, addr): def withdraw_disabled(self): """Gets the withdraw_disabled of this SpotCurrencyChain. # noqa: E501 - Whether currency's withdrawal is disabled. # noqa: E501 + Whether currency's withdrawal is disabled # noqa: E501 :return: The withdraw_disabled of this SpotCurrencyChain. # noqa: E501 :rtype: bool @@ -134,7 +134,7 @@ def withdraw_disabled(self): def withdraw_disabled(self, withdraw_disabled): """Sets the withdraw_disabled of this SpotCurrencyChain. - Whether currency's withdrawal is disabled. # noqa: E501 + Whether currency's withdrawal is disabled # noqa: E501 :param withdraw_disabled: The withdraw_disabled of this SpotCurrencyChain. # noqa: E501 :type: bool @@ -146,7 +146,7 @@ def withdraw_disabled(self, withdraw_disabled): def withdraw_delayed(self): """Gets the withdraw_delayed of this SpotCurrencyChain. # noqa: E501 - Whether currency's withdrawal is delayed. # noqa: E501 + Whether currency's withdrawal is delayed # noqa: E501 :return: The withdraw_delayed of this SpotCurrencyChain. # noqa: E501 :rtype: bool @@ -157,7 +157,7 @@ def withdraw_delayed(self): def withdraw_delayed(self, withdraw_delayed): """Sets the withdraw_delayed of this SpotCurrencyChain. - Whether currency's withdrawal is delayed. # noqa: E501 + Whether currency's withdrawal is delayed # noqa: E501 :param withdraw_delayed: The withdraw_delayed of this SpotCurrencyChain. # noqa: E501 :type: bool @@ -169,7 +169,7 @@ def withdraw_delayed(self, withdraw_delayed): def deposit_disabled(self): """Gets the deposit_disabled of this SpotCurrencyChain. # noqa: E501 - Whether currency's deposit is disabled. # noqa: E501 + Whether currency's deposit is disabled # noqa: E501 :return: The deposit_disabled of this SpotCurrencyChain. # noqa: E501 :rtype: bool @@ -180,7 +180,7 @@ def deposit_disabled(self): def deposit_disabled(self, deposit_disabled): """Sets the deposit_disabled of this SpotCurrencyChain. - Whether currency's deposit is disabled. # noqa: E501 + Whether currency's deposit is disabled # noqa: E501 :param deposit_disabled: The deposit_disabled of this SpotCurrencyChain. # noqa: E501 :type: bool diff --git a/gate_api/models/spot_fee.py b/gate_api/models/spot_fee.py index c9c322f..0d5327c 100644 --- a/gate_api/models/spot_fee.py +++ b/gate_api/models/spot_fee.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, user_id=None, taker_fee=None, maker_fee=None, gt_discount=Non def user_id(self): """Gets the user_id of this SpotFee. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this SpotFee. # noqa: E501 :rtype: int @@ -113,7 +113,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this SpotFee. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this SpotFee. # noqa: E501 :type: int @@ -125,7 +125,7 @@ def user_id(self, user_id): def taker_fee(self): """Gets the taker_fee of this SpotFee. # noqa: E501 - taker fee rate. # noqa: E501 + taker fee rate # noqa: E501 :return: The taker_fee of this SpotFee. # noqa: E501 :rtype: str @@ -136,7 +136,7 @@ def taker_fee(self): def taker_fee(self, taker_fee): """Sets the taker_fee of this SpotFee. - taker fee rate. # noqa: E501 + taker fee rate # noqa: E501 :param taker_fee: The taker_fee of this SpotFee. # noqa: E501 :type: str @@ -148,7 +148,7 @@ def taker_fee(self, taker_fee): def maker_fee(self): """Gets the maker_fee of this SpotFee. # noqa: E501 - maker fee rate. # noqa: E501 + maker fee rate # noqa: E501 :return: The maker_fee of this SpotFee. # noqa: E501 :rtype: str @@ -159,7 +159,7 @@ def maker_fee(self): def maker_fee(self, maker_fee): """Sets the maker_fee of this SpotFee. - maker fee rate. # noqa: E501 + maker fee rate # noqa: E501 :param maker_fee: The maker_fee of this SpotFee. # noqa: E501 :type: str @@ -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 @@ -240,7 +240,7 @@ def gt_maker_fee(self, gt_maker_fee): def loan_fee(self): """Gets the loan_fee of this SpotFee. # noqa: E501 - Loan fee rate of margin lending. # noqa: E501 + Loan fee rate of margin lending # noqa: E501 :return: The loan_fee of this SpotFee. # noqa: E501 :rtype: str @@ -251,7 +251,7 @@ def loan_fee(self): def loan_fee(self, loan_fee): """Sets the loan_fee of this SpotFee. - Loan fee rate of margin lending. # noqa: E501 + Loan fee rate of margin lending # noqa: E501 :param loan_fee: The loan_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 @@ -286,7 +286,7 @@ def point_type(self, point_type): def currency_pair(self): """Gets the currency_pair of this SpotFee. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this SpotFee. # noqa: E501 :rtype: str @@ -297,7 +297,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this SpotFee. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 3c8df1b..249bc6d 100644 --- a/gate_api/models/spot_insurance_history.py +++ b/gate_api/models/spot_insurance_history.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, currency=None, balance=None, time=None, local_vars_configurat def currency(self): """Gets the currency of this SpotInsuranceHistory. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this SpotInsuranceHistory. # noqa: E501 :rtype: str @@ -78,7 +78,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SpotInsuranceHistory. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this SpotInsuranceHistory. # noqa: E501 :type: str @@ -90,7 +90,7 @@ def currency(self, currency): def balance(self): """Gets the balance of this SpotInsuranceHistory. # noqa: E501 - balance. # 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. - balance. # noqa: E501 + Balance # noqa: E501 :param balance: The balance of this SpotInsuranceHistory. # noqa: E501 :type: str @@ -113,7 +113,7 @@ def balance(self, balance): def time(self): """Gets the time of this SpotInsuranceHistory. # noqa: E501 - Creation time, timestamp, milliseconds. # noqa: E501 + Creation time, timestamp, milliseconds # noqa: E501 :return: The time of this SpotInsuranceHistory. # noqa: E501 :rtype: int @@ -124,7 +124,7 @@ def time(self): def time(self, time): """Sets the time of this SpotInsuranceHistory. - Creation time, timestamp, milliseconds. # noqa: E501 + Creation time, timestamp, milliseconds # noqa: E501 :param time: The time of this SpotInsuranceHistory. # noqa: E501 :type: int diff --git a/gate_api/models/spot_price_put_order.py b/gate_api/models/spot_price_put_order.py index 3059392..72cfa78 100644 --- a/gate_api/models/spot_price_put_order.py +++ b/gate_api/models/spot_price_put_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -153,7 +153,7 @@ def side(self, side): def price(self): """Gets the price of this SpotPricePutOrder. # noqa: E501 - Order price. # noqa: E501 + Order price # noqa: E501 :return: The price of this SpotPricePutOrder. # noqa: E501 :rtype: str @@ -164,7 +164,7 @@ def price(self): def price(self, price): """Sets the price of this SpotPricePutOrder. - Order price. # noqa: E501 + Order price # noqa: E501 :param price: The price of this SpotPricePutOrder. # noqa: E501 :type: str @@ -178,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 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 @@ -189,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 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 @@ -203,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 `unified` -normal: spot trading - margin: margin trading - unified: unified 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 @@ -214,7 +214,7 @@ def account(self): def account(self, account): """Sets the account of this SpotPricePutOrder. - Trading account type. Portfolio margin account must set to `unified` -normal: spot trading - margin: margin trading - unified: unified 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 @@ -263,7 +263,7 @@ def time_in_force(self, time_in_force): def auto_borrow(self): """Gets the auto_borrow of this SpotPricePutOrder. # noqa: E501 - Whether to borrow coins automatically. # noqa: E501 + Whether to borrow coins automatically # noqa: E501 :return: The auto_borrow of this SpotPricePutOrder. # noqa: E501 :rtype: bool @@ -274,7 +274,7 @@ def auto_borrow(self): def auto_borrow(self, auto_borrow): """Sets the auto_borrow of this SpotPricePutOrder. - Whether to borrow coins automatically. # noqa: E501 + Whether to borrow coins automatically # noqa: E501 :param auto_borrow: The auto_borrow of this SpotPricePutOrder. # noqa: E501 :type: bool @@ -286,7 +286,7 @@ def auto_borrow(self, auto_borrow): def auto_repay(self): """Gets the auto_repay of this SpotPricePutOrder. # noqa: E501 - Whether to repay the loan automatically. # noqa: E501 + Whether to repay the loan automatically # noqa: E501 :return: The auto_repay of this SpotPricePutOrder. # noqa: E501 :rtype: bool @@ -297,7 +297,7 @@ def auto_repay(self): def auto_repay(self, auto_repay): """Sets the auto_repay of this SpotPricePutOrder. - Whether to repay the loan automatically. # noqa: E501 + Whether to repay the loan automatically # noqa: E501 :param auto_repay: The auto_repay of this SpotPricePutOrder. # noqa: E501 :type: bool @@ -309,7 +309,7 @@ def auto_repay(self, auto_repay): 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 @@ -320,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 3eba96a..5e49da6 100644 --- a/gate_api/models/spot_price_trigger.py +++ b/gate_api/models/spot_price_trigger.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -64,7 +64,7 @@ def __init__(self, price=None, rule=None, expiration=None, local_vars_configurat def price(self): """Gets the price of this SpotPriceTrigger. # noqa: E501 - Trigger price. # noqa: E501 + Trigger price # noqa: E501 :return: The price of this SpotPriceTrigger. # noqa: E501 :rtype: str @@ -75,7 +75,7 @@ def price(self): def price(self, price): """Sets the price of this SpotPriceTrigger. - Trigger price. # noqa: E501 + Trigger price # noqa: E501 :param price: The price of this SpotPriceTrigger. # noqa: E501 :type: str @@ -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 - `<=`: 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 - `<=`: 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 0fc0e29..69e14df 100644 --- a/gate_api/models/spot_price_triggered_order.py +++ b/gate_api/models/spot_price_triggered_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -145,7 +145,7 @@ def put(self, put): def id(self): """Gets the id of this SpotPriceTriggeredOrder. # noqa: E501 - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :return: The id of this SpotPriceTriggeredOrder. # noqa: E501 :rtype: int @@ -156,7 +156,7 @@ def id(self): def id(self, id): """Sets the id of this SpotPriceTriggeredOrder. - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :param id: The id of this SpotPriceTriggeredOrder. # noqa: E501 :type: int @@ -168,7 +168,7 @@ def id(self, id): def user(self): """Gets the user of this SpotPriceTriggeredOrder. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user of this SpotPriceTriggeredOrder. # noqa: E501 :rtype: int @@ -179,7 +179,7 @@ def user(self): def user(self, user): """Sets the user of this SpotPriceTriggeredOrder. - User ID. # noqa: E501 + User ID # noqa: E501 :param user: The user of this SpotPriceTriggeredOrder. # noqa: E501 :type: int @@ -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 5e73856..52ba304 100644 --- a/gate_api/models/stp_group.py +++ b/gate_api/models/stp_group.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -71,7 +71,7 @@ def __init__(self, id=None, name=None, creator_id=None, create_time=None, local_ def id(self): """Gets the id of this StpGroup. # noqa: E501 - STP Group ID. # noqa: E501 + STP Group ID # noqa: E501 :return: The id of this StpGroup. # noqa: E501 :rtype: int @@ -82,7 +82,7 @@ def id(self): def id(self, id): """Sets the id of this StpGroup. - STP Group ID. # noqa: E501 + STP Group ID # noqa: E501 :param id: The id of this StpGroup. # noqa: E501 :type: int @@ -94,7 +94,7 @@ def id(self, id): def name(self): """Gets the name of this StpGroup. # noqa: E501 - STP Group name. # noqa: E501 + STP Group name # noqa: E501 :return: The name of this StpGroup. # noqa: E501 :rtype: str @@ -105,7 +105,7 @@ def name(self): def name(self, name): """Sets the name of this StpGroup. - STP Group name. # noqa: E501 + STP Group name # noqa: E501 :param name: The name of this StpGroup. # noqa: E501 :type: str @@ -119,7 +119,7 @@ def name(self, name): def creator_id(self): """Gets the creator_id of this StpGroup. # noqa: E501 - Creator ID. # noqa: E501 + Creator ID # noqa: E501 :return: The creator_id of this StpGroup. # noqa: E501 :rtype: int @@ -130,7 +130,7 @@ def creator_id(self): def creator_id(self, creator_id): """Sets the creator_id of this StpGroup. - Creator ID. # noqa: E501 + Creator ID # noqa: E501 :param creator_id: The creator_id of this StpGroup. # noqa: E501 :type: int @@ -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 cac81e2..e6584f3 100644 --- a/gate_api/models/stp_group_user.py +++ b/gate_api/models/stp_group_user.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, user_id=None, stp_id=None, create_time=None, local_vars_confi def user_id(self): """Gets the user_id of this StpGroupUser. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this StpGroupUser. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this StpGroupUser. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this StpGroupUser. # noqa: E501 :type: int @@ -90,7 +90,7 @@ def user_id(self, user_id): def stp_id(self): """Gets the stp_id of this StpGroupUser. # noqa: E501 - STP Group ID. # noqa: E501 + STP Group ID # noqa: E501 :return: The stp_id of this StpGroupUser. # noqa: E501 :rtype: int @@ -101,7 +101,7 @@ def stp_id(self): def stp_id(self, stp_id): """Sets the stp_id of this StpGroupUser. - STP Group ID. # noqa: E501 + STP Group ID # noqa: E501 :param stp_id: The stp_id of this StpGroupUser. # noqa: E501 :type: int @@ -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 e0d8727..285adf7 100644 --- a/gate_api/models/structured_buy.py +++ b/gate_api/models/structured_buy.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 2d469a5..664a021 100644 --- a/gate_api/models/structured_get_project_list.py +++ b/gate_api/models/structured_get_project_list.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 6c7caba..4f75222 100644 --- a/gate_api/models/structured_order_list.py +++ b/gate_api/models/structured_order_list.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, id=None, pid=None, lock_coin=None, amount=None, status=None, def id(self): """Gets the id of this StructuredOrderList. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this StructuredOrderList. # noqa: E501 :rtype: int @@ -98,7 +98,7 @@ def id(self): def id(self, id): """Sets the id of this StructuredOrderList. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this StructuredOrderList. # noqa: E501 :type: int @@ -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 @@ -133,7 +133,7 @@ def pid(self, pid): def lock_coin(self): """Gets the lock_coin of this StructuredOrderList. # noqa: E501 - Locked coin. # noqa: E501 + Locked coin # noqa: E501 :return: The lock_coin of this StructuredOrderList. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def lock_coin(self): def lock_coin(self, lock_coin): """Sets the lock_coin of this StructuredOrderList. - Locked coin. # noqa: E501 + Locked coin # noqa: E501 :param lock_coin: The lock_coin of this StructuredOrderList. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def lock_coin(self, lock_coin): def amount(self): """Gets the amount of this StructuredOrderList. # noqa: E501 - Locked amount. # noqa: E501 + Locked amount # noqa: E501 :return: The amount of this StructuredOrderList. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this StructuredOrderList. - Locked amount. # noqa: E501 + Locked amount # noqa: E501 :param amount: The amount of this StructuredOrderList. # noqa: E501 :type: str @@ -202,7 +202,7 @@ def status(self, status): def income(self): """Gets the income of this StructuredOrderList. # noqa: E501 - Income. # noqa: E501 + Income # noqa: E501 :return: The income of this StructuredOrderList. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def income(self): def income(self, income): """Sets the income of this StructuredOrderList. - Income. # noqa: E501 + Income # noqa: E501 :param income: The income of this StructuredOrderList. # noqa: E501 :type: str @@ -225,7 +225,7 @@ def income(self, income): def create_time(self): """Gets the create_time of this StructuredOrderList. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this StructuredOrderList. # noqa: E501 :rtype: int @@ -236,7 +236,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this StructuredOrderList. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this StructuredOrderList. # noqa: E501 :type: int diff --git a/gate_api/models/sub_account.py b/gate_api/models/sub_account.py index bac5c96..ad8b79e 100644 --- a/gate_api/models/sub_account.py +++ b/gate_api/models/sub_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -139,7 +139,7 @@ def login_name(self, login_name): def password(self): """Gets the password of this SubAccount. # noqa: E501 - The sub-account's password. (Default: the same as main account's password). # noqa: E501 + The sub-account's password. (Default: the same as main account's password) # noqa: E501 :return: The password of this SubAccount. # noqa: E501 :rtype: str @@ -150,7 +150,7 @@ def password(self): def password(self, password): """Sets the password of this SubAccount. - The sub-account's password. (Default: the same as main account's password). # noqa: E501 + The sub-account's password. (Default: the same as main account's password) # noqa: E501 :param password: The password 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 @@ -254,7 +254,7 @@ def user_id(self, user_id): def create_time(self): """Gets the create_time of this SubAccount. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this SubAccount. # noqa: E501 :rtype: int @@ -265,7 +265,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this SubAccount. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time 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 fa82fa7..7af2fb8 100644 --- a/gate_api/models/sub_account_balance.py +++ b/gate_api/models/sub_account_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, uid=None, available=None, local_vars_configuration=None): # def uid(self): """Gets the uid of this SubAccountBalance. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this SubAccountBalance. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SubAccountBalance. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this SubAccountBalance. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def uid(self, uid): def available(self): """Gets the available of this SubAccountBalance. # noqa: E501 - Available balances of currencies. # noqa: E501 + Available balances of currencies # noqa: E501 :return: The available of this SubAccountBalance. # noqa: E501 :rtype: dict(str, str) @@ -96,7 +96,7 @@ def available(self): def available(self, available): """Sets the available of this SubAccountBalance. - Available balances of currencies. # noqa: E501 + Available balances of currencies # noqa: E501 :param available: The available of this SubAccountBalance. # noqa: E501 :type: dict(str, str) diff --git a/gate_api/models/sub_account_cross_margin_balance.py b/gate_api/models/sub_account_cross_margin_balance.py index 69d1352..524294f 100644 --- a/gate_api/models/sub_account_cross_margin_balance.py +++ b/gate_api/models/sub_account_cross_margin_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, uid=None, available=None, local_vars_configuration=None): # def uid(self): """Gets the uid of this SubAccountCrossMarginBalance. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this SubAccountCrossMarginBalance. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SubAccountCrossMarginBalance. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this SubAccountCrossMarginBalance. # noqa: E501 :type: str diff --git a/gate_api/models/sub_account_futures_balance.py b/gate_api/models/sub_account_futures_balance.py index b783058..c499b88 100644 --- a/gate_api/models/sub_account_futures_balance.py +++ b/gate_api/models/sub_account_futures_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, uid=None, available=None, local_vars_configuration=None): # def uid(self): """Gets the uid of this SubAccountFuturesBalance. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this SubAccountFuturesBalance. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SubAccountFuturesBalance. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this SubAccountFuturesBalance. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def uid(self, uid): def available(self): """Gets the available of this SubAccountFuturesBalance. # noqa: E501 - Futures account balances. # noqa: E501 + Futures account balances # noqa: E501 :return: The available of this SubAccountFuturesBalance. # noqa: E501 :rtype: dict(str, FuturesAccount) @@ -96,7 +96,7 @@ def available(self): def available(self, available): """Sets the available of this SubAccountFuturesBalance. - Futures account balances. # noqa: E501 + Futures account balances # noqa: E501 :param available: The available of this SubAccountFuturesBalance. # noqa: E501 :type: dict(str, FuturesAccount) diff --git a/gate_api/models/sub_account_key.py b/gate_api/models/sub_account_key.py index 139a0fe..c644eb6 100644 --- a/gate_api/models/sub_account_key.py +++ b/gate_api/models/sub_account_key.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, user_id=None, mode=None, name=None, perms=None, ip_whitelist= def user_id(self): """Gets the user_id of this SubAccountKey. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this SubAccountKey. # noqa: E501 :rtype: int @@ -113,7 +113,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this SubAccountKey. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this SubAccountKey. # noqa: E501 :type: int @@ -125,7 +125,7 @@ def user_id(self, user_id): def mode(self): """Gets the mode of this SubAccountKey. # noqa: E501 - Mode: 1 - classic 2 - portfolio account. # noqa: E501 + Mode: 1 - classic 2 - portfolio account # noqa: E501 :return: The mode of this SubAccountKey. # noqa: E501 :rtype: int @@ -136,7 +136,7 @@ def mode(self): def mode(self, mode): """Sets the mode of this SubAccountKey. - Mode: 1 - classic 2 - portfolio account. # noqa: E501 + Mode: 1 - classic 2 - portfolio account # noqa: E501 :param mode: The mode of this SubAccountKey. # noqa: E501 :type: int @@ -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] @@ -215,7 +215,7 @@ def ip_whitelist(self, ip_whitelist): def key(self): """Gets the key of this SubAccountKey. # noqa: E501 - API Key. # noqa: E501 + API Key # noqa: E501 :return: The key of this SubAccountKey. # noqa: E501 :rtype: str @@ -226,7 +226,7 @@ def key(self): def key(self, key): """Sets the key of this SubAccountKey. - API Key. # noqa: E501 + API Key # noqa: E501 :param key: The key of this SubAccountKey. # noqa: E501 :type: 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 f0a9f32..fa9a9f3 100644 --- a/gate_api/models/sub_account_key_perms.py +++ b/gate_api/models/sub_account_key_perms.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 ed03b66..22d8025 100644 --- a/gate_api/models/sub_account_margin_balance.py +++ b/gate_api/models/sub_account_margin_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, uid=None, available=None, local_vars_configuration=None): # def uid(self): """Gets the uid of this SubAccountMarginBalance. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this SubAccountMarginBalance. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SubAccountMarginBalance. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this SubAccountMarginBalance. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def uid(self, uid): def available(self): """Gets the available of this SubAccountMarginBalance. # noqa: E501 - Margin account balances. # noqa: E501 + Margin account balances # noqa: E501 :return: The available of this SubAccountMarginBalance. # noqa: E501 :rtype: list[MarginAccount] @@ -96,7 +96,7 @@ def available(self): def available(self, available): """Sets the available of this SubAccountMarginBalance. - Margin account balances. # noqa: E501 + Margin account balances # noqa: E501 :param available: The available of this SubAccountMarginBalance. # noqa: E501 :type: list[MarginAccount] diff --git a/gate_api/models/sub_account_to_sub_account.py b/gate_api/models/sub_account_to_sub_account.py index ff353ad..c082521 100644 --- a/gate_api/models/sub_account_to_sub_account.py +++ b/gate_api/models/sub_account_to_sub_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -81,7 +81,7 @@ def __init__(self, currency=None, sub_account_type=None, sub_account_from=None, def currency(self): """Gets the currency of this SubAccountToSubAccount. # noqa: E501 - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :return: The currency of this SubAccountToSubAccount. # noqa: E501 :rtype: str @@ -92,7 +92,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SubAccountToSubAccount. - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :param currency: The currency of this SubAccountToSubAccount. # noqa: E501 :type: str @@ -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 @@ -129,7 +129,7 @@ def sub_account_type(self, sub_account_type): def sub_account_from(self): """Gets the sub_account_from of this SubAccountToSubAccount. # noqa: E501 - Transfer from the user id of the sub-account. # noqa: E501 + Transfer from the user id of the sub-account # noqa: E501 :return: The sub_account_from of this SubAccountToSubAccount. # noqa: E501 :rtype: str @@ -140,7 +140,7 @@ def sub_account_from(self): def sub_account_from(self, sub_account_from): """Sets the sub_account_from of this SubAccountToSubAccount. - Transfer from the user id of the sub-account. # noqa: E501 + Transfer from the user id of the sub-account # noqa: E501 :param sub_account_from: The sub_account_from 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 @@ -179,7 +179,7 @@ def sub_account_from_type(self, sub_account_from_type): def sub_account_to(self): """Gets the sub_account_to of this SubAccountToSubAccount. # noqa: E501 - Transfer to the user id of the sub-account. # noqa: E501 + Transfer to the user id of the sub-account # noqa: E501 :return: The sub_account_to of this SubAccountToSubAccount. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def sub_account_to(self): def sub_account_to(self, sub_account_to): """Sets the sub_account_to of this SubAccountToSubAccount. - Transfer to the user id of the sub-account. # noqa: E501 + Transfer to the user id of the sub-account # noqa: E501 :param sub_account_to: The sub_account_to 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 - Transferred sub-account 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. - Transferred sub-account 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 @@ -229,7 +229,7 @@ def sub_account_to_type(self, sub_account_to_type): def amount(self): """Gets the amount of this SubAccountToSubAccount. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this SubAccountToSubAccount. # noqa: E501 :rtype: str @@ -240,7 +240,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this SubAccountToSubAccount. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount 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 09ff172..9ab7c79 100644 --- a/gate_api/models/sub_account_transfer.py +++ b/gate_api/models/sub_account_transfer.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -78,7 +78,7 @@ def __init__(self, sub_account=None, sub_account_type='spot', currency=None, amo def sub_account(self): """Gets the sub_account of this SubAccountTransfer. # noqa: E501 - Sub account user ID. # noqa: E501 + Sub account user ID # noqa: E501 :return: The sub_account of this SubAccountTransfer. # noqa: E501 :rtype: str @@ -89,7 +89,7 @@ def sub_account(self): def sub_account(self, sub_account): """Sets the sub_account of this SubAccountTransfer. - Sub account user ID. # noqa: E501 + Sub account user ID # noqa: E501 :param sub_account: The sub_account of this SubAccountTransfer. # noqa: E501 :type: str @@ -103,7 +103,7 @@ def sub_account(self, sub_account): 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 + 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 SubAccountTransfer. # noqa: E501 :rtype: str @@ -114,7 +114,7 @@ def sub_account_type(self): 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 + 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 SubAccountTransfer. # noqa: E501 :type: str @@ -126,7 +126,7 @@ def sub_account_type(self, sub_account_type): def currency(self): """Gets the currency of this SubAccountTransfer. # noqa: E501 - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :return: The currency of this SubAccountTransfer. # noqa: E501 :rtype: str @@ -137,7 +137,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SubAccountTransfer. - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :param currency: The currency of this SubAccountTransfer. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this SubAccountTransfer. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this SubAccountTransfer. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this SubAccountTransfer. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount of this SubAccountTransfer. # noqa: E501 :type: str @@ -176,7 +176,7 @@ def amount(self, amount): def direction(self): """Gets the direction of this SubAccountTransfer. # noqa: E501 - Transfer direction. to - transfer into sub account; from - transfer out from sub account # noqa: E501 + Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501 :return: The direction of this SubAccountTransfer. # noqa: E501 :rtype: str @@ -187,7 +187,7 @@ def direction(self): def direction(self, direction): """Sets the direction of this SubAccountTransfer. - Transfer direction. to - transfer into sub account; from - transfer out from sub account # noqa: E501 + Transfer direction: to - transfer into sub-account, from - transfer out from sub-account # noqa: E501 :param direction: The direction of this SubAccountTransfer. # noqa: E501 :type: str @@ -201,7 +201,7 @@ def direction(self, direction): 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 @@ -212,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 diff --git a/gate_api/models/sub_account_transfer_record_item.py b/gate_api/models/sub_account_transfer_record_item.py index ed02651..650a595 100644 --- a/gate_api/models/sub_account_transfer_record_item.py +++ b/gate_api/models/sub_account_transfer_record_item.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -98,7 +98,7 @@ def __init__(self, timest=None, uid=None, sub_account=None, sub_account_type='sp def timest(self): """Gets the timest of this SubAccountTransferRecordItem. # noqa: E501 - Transfer timestamp. # noqa: E501 + Transfer timestamp # noqa: E501 :return: The timest of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -109,7 +109,7 @@ def timest(self): def timest(self, timest): """Sets the timest of this SubAccountTransferRecordItem. - Transfer timestamp. # noqa: E501 + Transfer timestamp # noqa: E501 :param timest: The timest of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -121,7 +121,7 @@ def timest(self, timest): def uid(self): """Gets the uid of this SubAccountTransferRecordItem. # noqa: E501 - Main account user ID. # noqa: E501 + Main account user ID # noqa: E501 :return: The uid of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -132,7 +132,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SubAccountTransferRecordItem. - Main account user ID. # noqa: E501 + Main account user ID # noqa: E501 :param uid: The uid of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -144,7 +144,7 @@ def uid(self, uid): def sub_account(self): """Gets the sub_account of this SubAccountTransferRecordItem. # noqa: E501 - Sub account user ID. # noqa: E501 + Sub account user ID # noqa: E501 :return: The sub_account of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -155,7 +155,7 @@ def sub_account(self): def sub_account(self, sub_account): """Sets the sub_account of this SubAccountTransferRecordItem. - Sub account user ID. # noqa: E501 + Sub account user ID # noqa: E501 :param sub_account: The sub_account of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -169,7 +169,7 @@ def sub_account(self, sub_account): def sub_account_type(self): """Gets the sub_account_type of this SubAccountTransferRecordItem. # noqa: E501 - Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 sub_account_type of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def sub_account_type(self): def sub_account_type(self, sub_account_type): """Sets the sub_account_type of this SubAccountTransferRecordItem. - Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 sub_account_type: The sub_account_type of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -192,7 +192,7 @@ def sub_account_type(self, sub_account_type): def currency(self): """Gets the currency of this SubAccountTransferRecordItem. # noqa: E501 - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :return: The currency of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -203,7 +203,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this SubAccountTransferRecordItem. - Transfer currency name. # noqa: E501 + Transfer currency name # noqa: E501 :param currency: The currency of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -217,7 +217,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this SubAccountTransferRecordItem. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -228,7 +228,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this SubAccountTransferRecordItem. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -242,7 +242,7 @@ def amount(self, amount): 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 + 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 @@ -253,7 +253,7 @@ def direction(self): 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 + 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 @@ -267,7 +267,7 @@ def direction(self, direction): def source(self): """Gets the source of this SubAccountTransferRecordItem. # noqa: E501 - Where the operation is initiated from. # noqa: E501 + Source of the transfer operation # noqa: E501 :return: The source of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -278,7 +278,7 @@ def source(self): def source(self, source): """Sets the source of this SubAccountTransferRecordItem. - Where the operation is initiated from. # noqa: E501 + Source of the transfer operation # noqa: E501 :param source: The source of this SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -290,7 +290,7 @@ def source(self, source): def client_order_id(self): """Gets the client_order_id of this SubAccountTransferRecordItem. # 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 SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -301,7 +301,7 @@ def client_order_id(self): def client_order_id(self, client_order_id): """Sets the client_order_id of this SubAccountTransferRecordItem. - 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 SubAccountTransferRecordItem. # noqa: E501 :type: str @@ -313,7 +313,7 @@ def client_order_id(self, client_order_id): def status(self): """Gets the status of this SubAccountTransferRecordItem. # noqa: E501 - Sub-account transfer record status, currently only success. # noqa: E501 + Sub-account transfer record status, currently only 'success' # noqa: E501 :return: The status of this SubAccountTransferRecordItem. # noqa: E501 :rtype: str @@ -324,7 +324,7 @@ def status(self): def status(self, status): """Sets the status of this SubAccountTransferRecordItem. - Sub-account transfer record status, currently only success. # noqa: E501 + Sub-account transfer record status, currently only 'success' # noqa: E501 :param status: The status of this SubAccountTransferRecordItem. # noqa: E501 :type: str diff --git a/gate_api/models/sub_cross_margin_account.py b/gate_api/models/sub_cross_margin_account.py index 3f877de..0e43bca 100644 --- a/gate_api/models/sub_cross_margin_account.py +++ b/gate_api/models/sub_cross_margin_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -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 @@ -268,7 +268,7 @@ def borrowed_net(self, borrowed_net): def net(self): """Gets the net of this SubCrossMarginAccount. # noqa: E501 - Total net assets in USDT. # noqa: E501 + Total net assets in USDT # noqa: E501 :return: The net of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -279,7 +279,7 @@ def net(self): def net(self, net): """Sets the net of this SubCrossMarginAccount. - Total net assets in USDT. # noqa: E501 + Total net assets in USDT # noqa: E501 :param net: The net of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -291,7 +291,7 @@ def net(self, net): def leverage(self): """Gets the leverage of this SubCrossMarginAccount. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -302,7 +302,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this SubCrossMarginAccount. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage 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 @@ -360,7 +360,7 @@ def risk(self, risk): def total_initial_margin(self): """Gets the total_initial_margin of this SubCrossMarginAccount. # noqa: E501 - Total initial margin. # noqa: E501 + Total initial margin # noqa: E501 :return: The total_initial_margin of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -371,7 +371,7 @@ def total_initial_margin(self): def total_initial_margin(self, total_initial_margin): """Sets the total_initial_margin of this SubCrossMarginAccount. - Total initial margin. # noqa: E501 + Total initial margin # noqa: E501 :param total_initial_margin: The total_initial_margin of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -383,7 +383,7 @@ def total_initial_margin(self, total_initial_margin): def total_margin_balance(self): """Gets the total_margin_balance of this SubCrossMarginAccount. # noqa: E501 - Total margin balance. # noqa: E501 + Total margin balance # noqa: E501 :return: The total_margin_balance of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -394,7 +394,7 @@ def total_margin_balance(self): def total_margin_balance(self, total_margin_balance): """Sets the total_margin_balance of this SubCrossMarginAccount. - Total margin balance. # noqa: E501 + Total margin balance # noqa: E501 :param total_margin_balance: The total_margin_balance of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -406,7 +406,7 @@ def total_margin_balance(self, total_margin_balance): def total_maintenance_margin(self): """Gets the total_maintenance_margin of this SubCrossMarginAccount. # noqa: E501 - Total maintenance margin. # noqa: E501 + Total maintenance margin # noqa: E501 :return: The total_maintenance_margin of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -417,7 +417,7 @@ def total_maintenance_margin(self): def total_maintenance_margin(self, total_maintenance_margin): """Sets the total_maintenance_margin of this SubCrossMarginAccount. - Total maintenance margin. # noqa: E501 + Total maintenance margin # noqa: E501 :param total_maintenance_margin: The total_maintenance_margin of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -429,7 +429,7 @@ def total_maintenance_margin(self, total_maintenance_margin): def total_initial_margin_rate(self): """Gets the total_initial_margin_rate of this SubCrossMarginAccount. # noqa: E501 - Total initial margin rate. # noqa: E501 + Total initial margin rate # noqa: E501 :return: The total_initial_margin_rate of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -440,7 +440,7 @@ def total_initial_margin_rate(self): def total_initial_margin_rate(self, total_initial_margin_rate): """Sets the total_initial_margin_rate of this SubCrossMarginAccount. - Total initial margin rate. # noqa: E501 + Total initial margin rate # noqa: E501 :param total_initial_margin_rate: The total_initial_margin_rate of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -452,7 +452,7 @@ def total_initial_margin_rate(self, total_initial_margin_rate): def total_maintenance_margin_rate(self): """Gets the total_maintenance_margin_rate of this SubCrossMarginAccount. # noqa: E501 - Total maintenance margin rate. # noqa: E501 + Total maintenance margin rate # noqa: E501 :return: The total_maintenance_margin_rate of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -463,7 +463,7 @@ def total_maintenance_margin_rate(self): def total_maintenance_margin_rate(self, total_maintenance_margin_rate): """Sets the total_maintenance_margin_rate of this SubCrossMarginAccount. - Total maintenance margin rate. # noqa: E501 + Total maintenance margin rate # noqa: E501 :param total_maintenance_margin_rate: The total_maintenance_margin_rate of this SubCrossMarginAccount. # noqa: E501 :type: str @@ -475,7 +475,7 @@ def total_maintenance_margin_rate(self, total_maintenance_margin_rate): def total_available_margin(self): """Gets the total_available_margin of this SubCrossMarginAccount. # noqa: E501 - Total available margin. # noqa: E501 + Total available margin # noqa: E501 :return: The total_available_margin of this SubCrossMarginAccount. # noqa: E501 :rtype: str @@ -486,7 +486,7 @@ def total_available_margin(self): def total_available_margin(self, total_available_margin): """Sets the total_available_margin of this SubCrossMarginAccount. - Total available margin. # noqa: E501 + Total available margin # noqa: E501 :param total_available_margin: The total_available_margin 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 e9ba6cf..2c73505 100644 --- a/gate_api/models/sub_user_mode.py +++ b/gate_api/models/sub_user_mode.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, user_id=None, is_unified=None, mode=None, local_vars_configur def user_id(self): """Gets the user_id of this SubUserMode. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this SubUserMode. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this SubUserMode. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this SubUserMode. # noqa: E501 :type: int @@ -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 index c32db80..14d56e4 100644 --- a/gate_api/models/swap_coin.py +++ b/gate_api/models/swap_coin.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -69,7 +69,7 @@ def __init__(self, coin=None, side=None, amount=None, pid=None, local_vars_confi def coin(self): """Gets the coin of this SwapCoin. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The coin of this SwapCoin. # noqa: E501 :rtype: str @@ -80,7 +80,7 @@ def coin(self): def coin(self, coin): """Sets the coin of this SwapCoin. - Currency. # noqa: E501 + Currency # noqa: E501 :param coin: The coin of this SwapCoin. # noqa: E501 :type: str @@ -94,7 +94,7 @@ def coin(self, coin): def side(self): """Gets the side of this SwapCoin. # noqa: E501 - 0 - Stake 1 - Redeem. # noqa: E501 + 0 - Stake 1 - Redeem # noqa: E501 :return: The side of this SwapCoin. # noqa: E501 :rtype: str @@ -105,7 +105,7 @@ def side(self): def side(self, side): """Sets the side of this SwapCoin. - 0 - Stake 1 - Redeem. # noqa: E501 + 0 - Stake 1 - Redeem # noqa: E501 :param side: The side of this SwapCoin. # noqa: E501 :type: str @@ -119,7 +119,7 @@ def side(self, side): def amount(self): """Gets the amount of this SwapCoin. # noqa: E501 - Size. # noqa: E501 + Size # noqa: E501 :return: The amount of this SwapCoin. # noqa: E501 :rtype: str @@ -130,7 +130,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this SwapCoin. - Size. # noqa: E501 + Size # noqa: E501 :param amount: The amount of this SwapCoin. # noqa: E501 :type: str @@ -144,7 +144,7 @@ def amount(self, amount): def pid(self): """Gets the pid of this SwapCoin. # noqa: E501 - DeFi-type Mining Protocol Identifier. # noqa: E501 + DeFi-type Mining Protocol Identifier # noqa: E501 :return: The pid of this SwapCoin. # noqa: E501 :rtype: int @@ -155,7 +155,7 @@ def pid(self): def pid(self, pid): """Sets the pid of this SwapCoin. - DeFi-type Mining Protocol Identifier. # noqa: E501 + DeFi-type Mining Protocol Identifier # noqa: E501 :param pid: The pid of this SwapCoin. # noqa: E501 :type: int diff --git a/gate_api/models/swap_coin_struct.py b/gate_api/models/swap_coin_struct.py index a1d13f6..8a7ae01 100644 --- a/gate_api/models/swap_coin_struct.py +++ b/gate_api/models/swap_coin_struct.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -127,7 +127,7 @@ def __init__(self, id=None, pid=None, uid=None, coin=None, type=None, subtype=No def id(self): """Gets the id of this SwapCoinStruct. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -138,7 +138,7 @@ def id(self): def id(self, id): """Sets the id of this SwapCoinStruct. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this SwapCoinStruct. # noqa: E501 :type: int @@ -150,7 +150,7 @@ def id(self, id): def pid(self): """Gets the pid of this SwapCoinStruct. # noqa: E501 - Plan ID. # noqa: E501 + Product ID # noqa: E501 :return: The pid of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -161,7 +161,7 @@ def pid(self): def pid(self, pid): """Sets the pid of this SwapCoinStruct. - Plan ID. # noqa: E501 + Product ID # noqa: E501 :param pid: The pid of this SwapCoinStruct. # noqa: E501 :type: int @@ -173,7 +173,7 @@ def pid(self, pid): def uid(self): """Gets the uid of this SwapCoinStruct. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -184,7 +184,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this SwapCoinStruct. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this SwapCoinStruct. # noqa: E501 :type: int @@ -196,7 +196,7 @@ def uid(self, uid): def coin(self): """Gets the coin of this SwapCoinStruct. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The coin of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -207,7 +207,7 @@ def coin(self): def coin(self, coin): """Sets the coin of this SwapCoinStruct. - Currency. # noqa: E501 + Currency # noqa: E501 :param coin: The coin of this SwapCoinStruct. # noqa: E501 :type: str @@ -219,7 +219,7 @@ def coin(self, coin): def type(self): """Gets the type of this SwapCoinStruct. # noqa: E501 - 类型 0-质押 1-赎回 # noqa: E501 + Type 0-Staking 1-Redemption # noqa: E501 :return: The type of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -230,7 +230,7 @@ def type(self): def type(self, type): """Sets the type of this SwapCoinStruct. - 类型 0-质押 1-赎回 # noqa: E501 + Type 0-Staking 1-Redemption # noqa: E501 :param type: The type of this SwapCoinStruct. # noqa: E501 :type: int @@ -242,7 +242,7 @@ def type(self, type): def subtype(self): """Gets the subtype of this SwapCoinStruct. # noqa: E501 - 子类型 # noqa: E501 + SubType # noqa: E501 :return: The subtype of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -253,7 +253,7 @@ def subtype(self): def subtype(self, subtype): """Sets the subtype of this SwapCoinStruct. - 子类型 # noqa: E501 + SubType # noqa: E501 :param subtype: The subtype of this SwapCoinStruct. # noqa: E501 :type: str @@ -265,7 +265,7 @@ def subtype(self, subtype): def amount(self): """Gets the amount of this SwapCoinStruct. # noqa: E501 - Amount. # noqa: E501 + Amount # noqa: E501 :return: The amount of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -276,7 +276,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this SwapCoinStruct. - Amount. # noqa: E501 + Amount # noqa: E501 :param amount: The amount of this SwapCoinStruct. # noqa: E501 :type: str @@ -288,7 +288,7 @@ def amount(self, amount): def exchange_rate(self): """Gets the exchange_rate of this SwapCoinStruct. # noqa: E501 - Exchange Ratio. # noqa: E501 + Exchange ratio # noqa: E501 :return: The exchange_rate of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -299,7 +299,7 @@ def exchange_rate(self): def exchange_rate(self, exchange_rate): """Sets the exchange_rate of this SwapCoinStruct. - Exchange Ratio. # noqa: E501 + Exchange ratio # noqa: E501 :param exchange_rate: The exchange_rate of this SwapCoinStruct. # noqa: E501 :type: str @@ -311,7 +311,7 @@ def exchange_rate(self, exchange_rate): def exchange_amount(self): """Gets the exchange_amount of this SwapCoinStruct. # noqa: E501 - 兑换金额 # noqa: E501 + Redemption Amount # noqa: E501 :return: The exchange_amount of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -322,7 +322,7 @@ def exchange_amount(self): def exchange_amount(self, exchange_amount): """Sets the exchange_amount of this SwapCoinStruct. - 兑换金额 # noqa: E501 + Redemption Amount # noqa: E501 :param exchange_amount: The exchange_amount of this SwapCoinStruct. # noqa: E501 :type: str @@ -334,7 +334,7 @@ def exchange_amount(self, exchange_amount): def update_stamp(self): """Gets the update_stamp of this SwapCoinStruct. # noqa: E501 - 更新时间戳 # noqa: E501 + UpdateTimestamp # noqa: E501 :return: The update_stamp of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -345,7 +345,7 @@ def update_stamp(self): def update_stamp(self, update_stamp): """Sets the update_stamp of this SwapCoinStruct. - 更新时间戳 # noqa: E501 + UpdateTimestamp # noqa: E501 :param update_stamp: The update_stamp of this SwapCoinStruct. # noqa: E501 :type: int @@ -357,7 +357,7 @@ def update_stamp(self, update_stamp): def create_stamp(self): """Gets the create_stamp of this SwapCoinStruct. # noqa: E501 - Transaction timestamp. # noqa: E501 + Transaction timestamp # noqa: E501 :return: The create_stamp of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -368,7 +368,7 @@ def create_stamp(self): def create_stamp(self, create_stamp): """Sets the create_stamp of this SwapCoinStruct. - Transaction timestamp. # noqa: E501 + Transaction timestamp # noqa: E501 :param create_stamp: The create_stamp of this SwapCoinStruct. # noqa: E501 :type: int @@ -380,7 +380,7 @@ def create_stamp(self, create_stamp): def status(self): """Gets the status of this SwapCoinStruct. # noqa: E501 - status 1-success. # noqa: E501 + status 1-success # noqa: E501 :return: The status of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -391,7 +391,7 @@ def status(self): def status(self, status): """Sets the status of this SwapCoinStruct. - status 1-success. # noqa: E501 + status 1-success # noqa: E501 :param status: The status of this SwapCoinStruct. # noqa: E501 :type: int @@ -403,7 +403,7 @@ def status(self, status): def protocol_type(self): """Gets the protocol_type of this SwapCoinStruct. # noqa: E501 - DEFI协议类型 # noqa: E501 + DEFI Protocol Type # noqa: E501 :return: The protocol_type of this SwapCoinStruct. # noqa: E501 :rtype: int @@ -414,7 +414,7 @@ def protocol_type(self): def protocol_type(self, protocol_type): """Sets the protocol_type of this SwapCoinStruct. - DEFI协议类型 # noqa: E501 + DEFI Protocol Type # noqa: E501 :param protocol_type: The protocol_type of this SwapCoinStruct. # noqa: E501 :type: int @@ -426,7 +426,7 @@ def protocol_type(self, protocol_type): def client_order_id(self): """Gets the client_order_id of this SwapCoinStruct. # noqa: E501 - 参考ID # noqa: E501 + Reference ID # noqa: E501 :return: The client_order_id of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -437,7 +437,7 @@ def client_order_id(self): def client_order_id(self, client_order_id): """Sets the client_order_id of this SwapCoinStruct. - 参考ID # noqa: E501 + Reference ID # noqa: E501 :param client_order_id: The client_order_id of this SwapCoinStruct. # noqa: E501 :type: str @@ -449,7 +449,7 @@ def client_order_id(self, client_order_id): def source(self): """Gets the source of this SwapCoinStruct. # noqa: E501 - Order source. # noqa: E501 + Order Origin # noqa: E501 :return: The source of this SwapCoinStruct. # noqa: E501 :rtype: str @@ -460,7 +460,7 @@ def source(self): def source(self, source): """Sets the source of this SwapCoinStruct. - Order source. # noqa: E501 + Order Origin # noqa: E501 :param source: The source of this SwapCoinStruct. # noqa: E501 :type: str diff --git a/gate_api/models/system_time.py b/gate_api/models/system_time.py index df6d7cb..285a0e7 100644 --- a/gate_api/models/system_time.py +++ b/gate_api/models/system_time.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, server_time=None, local_vars_configuration=None): # noqa: E5 def server_time(self): """Gets the server_time of this SystemTime. # noqa: E501 - Server current time(ms). # noqa: E501 + Server current time(ms) # noqa: E501 :return: The server_time of this SystemTime. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def server_time(self): def server_time(self, server_time): """Sets the server_time of this SystemTime. - Server current time(ms). # noqa: E501 + Server current time(ms) # noqa: E501 :param server_time: The server_time of this SystemTime. # noqa: E501 :type: int diff --git a/gate_api/models/ticker.py b/gate_api/models/ticker.py index 64172b5..289c557 100644 --- a/gate_api/models/ticker.py +++ b/gate_api/models/ticker.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -134,7 +134,7 @@ def __init__(self, currency_pair=None, last=None, lowest_ask=None, lowest_size=N def currency_pair(self): """Gets the currency_pair of this Ticker. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this Ticker. # noqa: E501 :rtype: str @@ -145,7 +145,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this Ticker. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this Ticker. # noqa: E501 :type: str @@ -157,7 +157,7 @@ def currency_pair(self, currency_pair): def last(self): """Gets the last of this Ticker. # noqa: E501 - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :return: The last of this Ticker. # noqa: E501 :rtype: str @@ -168,7 +168,7 @@ def last(self): def last(self, last): """Sets the last of this Ticker. - Last trading price. # noqa: E501 + Last trading price # noqa: E501 :param last: The last of this Ticker. # noqa: E501 :type: str @@ -180,7 +180,7 @@ def last(self, last): def lowest_ask(self): """Gets the lowest_ask of this Ticker. # noqa: E501 - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :return: The lowest_ask of this Ticker. # noqa: E501 :rtype: str @@ -191,7 +191,7 @@ def lowest_ask(self): def lowest_ask(self, lowest_ask): """Sets the lowest_ask of this Ticker. - Recent lowest ask. # noqa: E501 + Recent lowest ask # noqa: E501 :param lowest_ask: The lowest_ask of this Ticker. # noqa: E501 :type: str @@ -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 @@ -226,7 +226,7 @@ def lowest_size(self, lowest_size): def highest_bid(self): """Gets the highest_bid of this Ticker. # noqa: E501 - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :return: The highest_bid of this Ticker. # noqa: E501 :rtype: str @@ -237,7 +237,7 @@ def highest_bid(self): def highest_bid(self, highest_bid): """Sets the highest_bid of this Ticker. - Recent highest bid. # noqa: E501 + Recent highest bid # noqa: E501 :param highest_bid: The highest_bid 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 @@ -433,7 +433,7 @@ def low_24h(self, low_24h): def etf_net_value(self): """Gets the etf_net_value of this Ticker. # noqa: E501 - ETF net value. # noqa: E501 + ETF net value # noqa: E501 :return: The etf_net_value of this Ticker. # noqa: E501 :rtype: str @@ -444,7 +444,7 @@ def etf_net_value(self): def etf_net_value(self, etf_net_value): """Sets the etf_net_value of this Ticker. - ETF net value. # noqa: E501 + ETF net value # noqa: E501 :param etf_net_value: The etf_net_value 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 @@ -502,7 +502,7 @@ def etf_pre_timestamp(self, etf_pre_timestamp): def etf_leverage(self): """Gets the etf_leverage of this Ticker. # noqa: E501 - ETF current leverage. # noqa: E501 + ETF current leverage # noqa: E501 :return: The etf_leverage of this Ticker. # noqa: E501 :rtype: str @@ -513,7 +513,7 @@ def etf_leverage(self): def etf_leverage(self, etf_leverage): """Sets the etf_leverage of this Ticker. - ETF current leverage. # noqa: E501 + ETF current leverage # noqa: E501 :param etf_leverage: The etf_leverage of this Ticker. # noqa: E501 :type: str diff --git a/gate_api/models/total_balance.py b/gate_api/models/total_balance.py index 5fb5d87..9dd8b78 100644 --- a/gate_api/models/total_balance.py +++ b/gate_api/models/total_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 481440f..7fbeff8 100644 --- a/gate_api/models/trade.py +++ b/gate_api/models/trade.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -178,7 +178,7 @@ def create_time(self, create_time): def create_time_ms(self): """Gets the create_time_ms of this Trade. # noqa: E501 - Trading time, with millisecond precision. # noqa: E501 + Trading time, with millisecond precision # noqa: E501 :return: The create_time_ms of this Trade. # noqa: E501 :rtype: str @@ -189,7 +189,7 @@ def create_time_ms(self): def create_time_ms(self, create_time_ms): """Sets the create_time_ms of this Trade. - Trading time, with millisecond precision. # noqa: E501 + Trading time, with millisecond precision # noqa: E501 :param create_time_ms: The create_time_ms of this Trade. # noqa: E501 :type: str @@ -201,7 +201,7 @@ def create_time_ms(self, create_time_ms): def currency_pair(self): """Gets the currency_pair of this Trade. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this Trade. # noqa: E501 :rtype: str @@ -212,7 +212,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this Trade. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair 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 - Buy or sell order. # 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. - Buy or sell order. # 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 @@ -282,7 +282,7 @@ def role(self, role): def amount(self): """Gets the amount of this Trade. # noqa: E501 - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :return: The amount of this Trade. # noqa: E501 :rtype: str @@ -293,7 +293,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this Trade. - Trade amount. # noqa: E501 + Trade amount # noqa: E501 :param amount: The amount of this Trade. # noqa: E501 :type: str @@ -305,7 +305,7 @@ def amount(self, amount): def price(self): """Gets the price of this Trade. # noqa: E501 - Order price. # noqa: E501 + Order price # noqa: E501 :return: The price of this Trade. # noqa: E501 :rtype: str @@ -316,7 +316,7 @@ def price(self): def price(self, price): """Sets the price of this Trade. - Order price. # noqa: E501 + Order price # noqa: E501 :param price: The price 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 @@ -443,7 +443,7 @@ def gt_fee(self, gt_fee): def amend_text(self): """Gets the amend_text of this Trade. # noqa: E501 - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :return: The amend_text of this Trade. # noqa: E501 :rtype: str @@ -454,7 +454,7 @@ def amend_text(self): def amend_text(self, amend_text): """Sets the amend_text of this Trade. - The custom data that the user remarked when amending the order. # noqa: E501 + The custom data that the user remarked when amending the order # noqa: E501 :param amend_text: The amend_text 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 6edf8a6..7b3fd5a 100644 --- a/gate_api/models/trade_fee.py +++ b/gate_api/models/trade_fee.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -117,7 +117,7 @@ def __init__(self, user_id=None, taker_fee=None, maker_fee=None, gt_discount=Non def user_id(self): """Gets the user_id of this TradeFee. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this TradeFee. # noqa: E501 :rtype: int @@ -128,7 +128,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this TradeFee. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this TradeFee. # noqa: E501 :type: int @@ -140,7 +140,7 @@ def user_id(self, user_id): def taker_fee(self): """Gets the taker_fee of this TradeFee. # noqa: E501 - taker fee rate. # noqa: E501 + taker fee rate # noqa: E501 :return: The taker_fee of this TradeFee. # noqa: E501 :rtype: str @@ -151,7 +151,7 @@ def taker_fee(self): def taker_fee(self, taker_fee): """Sets the taker_fee of this TradeFee. - taker fee rate. # noqa: E501 + taker fee rate # noqa: E501 :param taker_fee: The taker_fee of this TradeFee. # noqa: E501 :type: str @@ -163,7 +163,7 @@ def taker_fee(self, taker_fee): def maker_fee(self): """Gets the maker_fee of this TradeFee. # noqa: E501 - maker fee rate. # noqa: E501 + maker fee rate # noqa: E501 :return: The maker_fee of this TradeFee. # noqa: E501 :rtype: str @@ -174,7 +174,7 @@ def maker_fee(self): def maker_fee(self, maker_fee): """Sets the maker_fee of this TradeFee. - maker fee rate. # noqa: E501 + maker fee rate # noqa: E501 :param maker_fee: The maker_fee of this TradeFee. # noqa: E501 :type: str @@ -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 @@ -255,7 +255,7 @@ def gt_maker_fee(self, gt_maker_fee): def loan_fee(self): """Gets the loan_fee of this TradeFee. # noqa: E501 - Loan fee rate of margin lending. # noqa: E501 + Loan fee rate of margin lending # noqa: E501 :return: The loan_fee of this TradeFee. # noqa: E501 :rtype: str @@ -266,7 +266,7 @@ def loan_fee(self): def loan_fee(self, loan_fee): """Sets the loan_fee of this TradeFee. - Loan fee rate of margin lending. # noqa: E501 + Loan fee rate of margin lending # noqa: E501 :param loan_fee: The loan_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 9c0e435..d902340 100644 --- a/gate_api/models/transaction_id.py +++ b/gate_api/models/transaction_id.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 1cd1b15..aaf2469 100644 --- a/gate_api/models/transfer.py +++ b/gate_api/models/transfer.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -103,7 +103,7 @@ def currency(self, currency): def _from(self): """Gets the _from of this Transfer. # noqa: E501 - Account to transfer from. # noqa: E501 + Account to transfer from # noqa: E501 :return: The _from of this Transfer. # noqa: E501 :rtype: str @@ -114,7 +114,7 @@ def _from(self): def _from(self, _from): """Sets the _from of this Transfer. - Account to transfer from. # noqa: E501 + Account to transfer from # noqa: E501 :param _from: The _from of this Transfer. # noqa: E501 :type: str @@ -134,7 +134,7 @@ def _from(self, _from): def to(self): """Gets the to of this Transfer. # noqa: E501 - Account to transfer to. # noqa: E501 + Account to transfer to # noqa: E501 :return: The to of this Transfer. # noqa: E501 :rtype: str @@ -145,7 +145,7 @@ def to(self): def to(self, to): """Sets the to of this Transfer. - Account to transfer to. # noqa: E501 + Account to transfer to # noqa: E501 :param to: The to of this Transfer. # noqa: E501 :type: str @@ -165,7 +165,7 @@ def to(self, to): def amount(self): """Gets the amount of this Transfer. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this Transfer. # noqa: E501 :rtype: str @@ -176,7 +176,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this Transfer. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount 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/transfer_order_status.py b/gate_api/models/transfer_order_status.py index a9ffd50..527b77a 100644 --- a/gate_api/models/transfer_order_status.py +++ b/gate_api/models/transfer_order_status.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, tx_id=None, status=None, local_vars_configuration=None): # n def tx_id(self): """Gets the tx_id of this TransferOrderStatus. # noqa: E501 - Order id. # noqa: E501 + Order ID # noqa: E501 :return: The tx_id of this TransferOrderStatus. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def tx_id(self): def tx_id(self, tx_id): """Sets the tx_id of this TransferOrderStatus. - Order id. # noqa: E501 + Order ID # noqa: E501 :param tx_id: The tx_id of this TransferOrderStatus. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def tx_id(self, tx_id): def status(self): """Gets the status of this TransferOrderStatus. # 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 + 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 TransferOrderStatus. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def status(self): def status(self, status): """Sets the status of this TransferOrderStatus. - 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 + 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 TransferOrderStatus. # noqa: E501 :type: str diff --git a/gate_api/models/transferables_result.py b/gate_api/models/transferables_result.py index 897dda6..a2659ba 100644 --- a/gate_api/models/transferables_result.py +++ b/gate_api/models/transferables_result.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None): def currency(self): """Gets the currency of this TransferablesResult. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this TransferablesResult. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this TransferablesResult. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this TransferablesResult. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this TransferablesResult. # noqa: E501 - The maximum amount that can be transferred out. # noqa: E501 + Maximum transferable amount # noqa: E501 :return: The amount of this TransferablesResult. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this TransferablesResult. - The maximum amount that can be transferred out. # noqa: E501 + Maximum transferable amount # noqa: E501 :param amount: The amount of this TransferablesResult. # noqa: E501 :type: str diff --git a/gate_api/models/trigger_order_response.py b/gate_api/models/trigger_order_response.py index 1d7bf67..2e0b560 100644 --- a/gate_api/models/trigger_order_response.py +++ b/gate_api/models/trigger_order_response.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, id=None, local_vars_configuration=None): # noqa: E501 def id(self): """Gets the id of this TriggerOrderResponse. # noqa: E501 - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :return: The id of this TriggerOrderResponse. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def id(self): def id(self, id): """Sets the id of this TriggerOrderResponse. - Auto order ID. # noqa: E501 + Auto order ID # noqa: E501 :param id: The id of this TriggerOrderResponse. # noqa: E501 :type: int diff --git a/gate_api/models/trigger_time.py b/gate_api/models/trigger_time.py index 481dbdc..6b7c80d 100644 --- a/gate_api/models/trigger_time.py +++ b/gate_api/models/trigger_time.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 d84d7a2..eb36625 100644 --- a/gate_api/models/uid_push_order.py +++ b/gate_api/models/uid_push_order.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -97,7 +97,7 @@ def __init__(self, id=None, push_uid=None, receive_uid=None, currency=None, amou def id(self): """Gets the id of this UidPushOrder. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this UidPushOrder. # noqa: E501 :rtype: int @@ -108,7 +108,7 @@ def id(self): def id(self, id): """Sets the id of this UidPushOrder. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this UidPushOrder. # noqa: E501 :type: int @@ -120,7 +120,7 @@ def id(self, id): def push_uid(self): """Gets the push_uid of this UidPushOrder. # noqa: E501 - Initiator User ID. # noqa: E501 + Initiator User ID # noqa: E501 :return: The push_uid of this UidPushOrder. # noqa: E501 :rtype: int @@ -131,7 +131,7 @@ def push_uid(self): def push_uid(self, push_uid): """Sets the push_uid of this UidPushOrder. - Initiator User ID. # noqa: E501 + Initiator User ID # noqa: E501 :param push_uid: The push_uid of this UidPushOrder. # noqa: E501 :type: int @@ -143,7 +143,7 @@ def push_uid(self, push_uid): def receive_uid(self): """Gets the receive_uid of this UidPushOrder. # noqa: E501 - Recipient User ID. # noqa: E501 + Recipient User ID # noqa: E501 :return: The receive_uid of this UidPushOrder. # noqa: E501 :rtype: int @@ -154,7 +154,7 @@ def receive_uid(self): def receive_uid(self, receive_uid): """Sets the receive_uid of this UidPushOrder. - Recipient User ID. # noqa: E501 + Recipient User ID # noqa: E501 :param receive_uid: The receive_uid of this UidPushOrder. # noqa: E501 :type: int @@ -166,7 +166,7 @@ def receive_uid(self, receive_uid): def currency(self): """Gets the currency of this UidPushOrder. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UidPushOrder. # noqa: E501 :rtype: str @@ -177,7 +177,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UidPushOrder. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UidPushOrder. # noqa: E501 :type: str @@ -189,7 +189,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this UidPushOrder. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this UidPushOrder. # noqa: E501 :rtype: str @@ -200,7 +200,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this UidPushOrder. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount of this UidPushOrder. # noqa: E501 :type: str @@ -212,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 @@ -223,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 @@ -235,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 @@ -246,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 @@ -258,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 @@ -269,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 @@ -281,7 +281,7 @@ def message(self, message): def transaction_type(self): """Gets the transaction_type of this UidPushOrder. # noqa: E501 - Order Type. # noqa: E501 + Order Type # noqa: E501 :return: The transaction_type of this UidPushOrder. # noqa: E501 :rtype: str @@ -292,7 +292,7 @@ def transaction_type(self): def transaction_type(self, transaction_type): """Sets the transaction_type of this UidPushOrder. - Order Type. # noqa: E501 + Order Type # noqa: E501 :param transaction_type: The transaction_type of this UidPushOrder. # noqa: E501 :type: str diff --git a/gate_api/models/uid_push_withdrawal.py b/gate_api/models/uid_push_withdrawal.py index 023be07..da15f5c 100644 --- a/gate_api/models/uid_push_withdrawal.py +++ b/gate_api/models/uid_push_withdrawal.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -64,7 +64,7 @@ def __init__(self, receive_uid=None, currency=None, amount=None, local_vars_conf def receive_uid(self): """Gets the receive_uid of this UidPushWithdrawal. # noqa: E501 - Recipient UID. # noqa: E501 + Recipient UID # noqa: E501 :return: The receive_uid of this UidPushWithdrawal. # noqa: E501 :rtype: int @@ -75,7 +75,7 @@ def receive_uid(self): def receive_uid(self, receive_uid): """Sets the receive_uid of this UidPushWithdrawal. - Recipient UID. # noqa: E501 + Recipient UID # noqa: E501 :param receive_uid: The receive_uid of this UidPushWithdrawal. # noqa: E501 :type: int @@ -89,7 +89,7 @@ def receive_uid(self, receive_uid): def currency(self): """Gets the currency of this UidPushWithdrawal. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UidPushWithdrawal. # noqa: E501 :rtype: str @@ -100,7 +100,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UidPushWithdrawal. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UidPushWithdrawal. # noqa: E501 :type: str @@ -114,7 +114,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this UidPushWithdrawal. # noqa: E501 - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :return: The amount of this UidPushWithdrawal. # noqa: E501 :rtype: str @@ -125,7 +125,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this UidPushWithdrawal. - Transfer amount. # noqa: E501 + Transfer amount # noqa: E501 :param amount: The amount of this UidPushWithdrawal. # noqa: E501 :type: str diff --git a/gate_api/models/uid_push_withdrawal_resp.py b/gate_api/models/uid_push_withdrawal_resp.py index 464885e..7afe6eb 100644 --- a/gate_api/models/uid_push_withdrawal_resp.py +++ b/gate_api/models/uid_push_withdrawal_resp.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, id=None, local_vars_configuration=None): # noqa: E501 def id(self): """Gets the id of this UidPushWithdrawalResp. # noqa: E501 - Order ID. # noqa: E501 + Order ID # noqa: E501 :return: The id of this UidPushWithdrawalResp. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def id(self): def id(self, id): """Sets the id of this UidPushWithdrawalResp. - Order ID. # noqa: E501 + Order ID # noqa: E501 :param id: The id of this UidPushWithdrawalResp. # noqa: E501 :type: int diff --git a/gate_api/models/uni_currency.py b/gate_api/models/uni_currency.py index 5f9accf..eee7b2c 100644 --- a/gate_api/models/uni_currency.py +++ b/gate_api/models/uni_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, currency=None, min_lend_amount=None, max_lend_amount=None, ma def currency(self): """Gets the currency of this UniCurrency. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UniCurrency. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniCurrency. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UniCurrency. # noqa: E501 :type: str @@ -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 @@ -123,7 +123,7 @@ def min_lend_amount(self, min_lend_amount): def max_lend_amount(self): """Gets the max_lend_amount of this UniCurrency. # noqa: E501 - The total maximum lending amount, in USDT. # noqa: E501 + The total maximum lending amount, in USDT # noqa: E501 :return: The max_lend_amount of this UniCurrency. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def max_lend_amount(self): def max_lend_amount(self, max_lend_amount): """Sets the max_lend_amount of this UniCurrency. - The total maximum lending amount, in USDT. # noqa: E501 + The total maximum lending amount, in USDT # noqa: E501 :param max_lend_amount: The max_lend_amount of this UniCurrency. # noqa: E501 :type: str @@ -146,7 +146,7 @@ def max_lend_amount(self, max_lend_amount): def max_rate(self): """Gets the max_rate of this UniCurrency. # noqa: E501 - Maximum rate (Hourly). # noqa: E501 + Maximum rate (Hourly) # noqa: E501 :return: The max_rate of this UniCurrency. # noqa: E501 :rtype: str @@ -157,7 +157,7 @@ def max_rate(self): def max_rate(self, max_rate): """Sets the max_rate of this UniCurrency. - Maximum rate (Hourly). # noqa: E501 + Maximum rate (Hourly) # noqa: E501 :param max_rate: The max_rate of this UniCurrency. # noqa: E501 :type: str @@ -169,7 +169,7 @@ def max_rate(self, max_rate): def min_rate(self): """Gets the min_rate of this UniCurrency. # noqa: E501 - Minimum rate (Hourly). # noqa: E501 + Minimum rate (Hourly) # noqa: E501 :return: The min_rate of this UniCurrency. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def min_rate(self): def min_rate(self, min_rate): """Sets the min_rate of this UniCurrency. - Minimum rate (Hourly). # noqa: E501 + Minimum rate (Hourly) # noqa: E501 :param min_rate: The min_rate 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 9511bf7..525ec59 100644 --- a/gate_api/models/uni_currency_interest.py +++ b/gate_api/models/uni_currency_interest.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, interest_status=None, local_vars_configuration def currency(self): """Gets the currency of this UniCurrencyInterest. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniCurrencyInterest. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniCurrencyInterest. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency 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 3e39ad9..362d6b1 100644 --- a/gate_api/models/uni_currency_pair.py +++ b/gate_api/models/uni_currency_pair.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency_pair=None, base_min_borrow_amount=None, quote_min_bo def currency_pair(self): """Gets the currency_pair of this UniCurrencyPair. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this UniCurrencyPair. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this UniCurrencyPair. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this UniCurrencyPair. # noqa: E501 :type: str @@ -95,7 +95,7 @@ def currency_pair(self, currency_pair): def base_min_borrow_amount(self): """Gets the base_min_borrow_amount of this UniCurrencyPair. # noqa: E501 - Minimum borrow amount of base currency. # noqa: E501 + Minimum borrow amount of base currency # noqa: E501 :return: The base_min_borrow_amount of this UniCurrencyPair. # noqa: E501 :rtype: str @@ -106,7 +106,7 @@ def base_min_borrow_amount(self): def base_min_borrow_amount(self, base_min_borrow_amount): """Sets the base_min_borrow_amount of this UniCurrencyPair. - Minimum borrow amount of base currency. # noqa: E501 + Minimum borrow amount of base currency # noqa: E501 :param base_min_borrow_amount: The base_min_borrow_amount of this UniCurrencyPair. # noqa: E501 :type: str @@ -118,7 +118,7 @@ def base_min_borrow_amount(self, base_min_borrow_amount): def quote_min_borrow_amount(self): """Gets the quote_min_borrow_amount of this UniCurrencyPair. # noqa: E501 - Minimum borrow amount of quote currency. # noqa: E501 + Minimum borrow amount of quote currency # noqa: E501 :return: The quote_min_borrow_amount of this UniCurrencyPair. # noqa: E501 :rtype: str @@ -129,7 +129,7 @@ def quote_min_borrow_amount(self): def quote_min_borrow_amount(self, quote_min_borrow_amount): """Sets the quote_min_borrow_amount of this UniCurrencyPair. - Minimum borrow amount of quote currency. # noqa: E501 + Minimum borrow amount of quote currency # noqa: E501 :param quote_min_borrow_amount: The quote_min_borrow_amount of this UniCurrencyPair. # noqa: E501 :type: str @@ -141,7 +141,7 @@ def quote_min_borrow_amount(self, quote_min_borrow_amount): def leverage(self): """Gets the leverage of this UniCurrencyPair. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this UniCurrencyPair. # noqa: E501 :rtype: str @@ -152,7 +152,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this UniCurrencyPair. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage of this UniCurrencyPair. # noqa: E501 :type: str diff --git a/gate_api/models/uni_interest_record.py b/gate_api/models/uni_interest_record.py index 0be8bec..f06d5fd 100644 --- a/gate_api/models/uni_interest_record.py +++ b/gate_api/models/uni_interest_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, status=None, currency=None, actual_rate=None, interest=None, def status(self): """Gets the status of this UniInterestRecord. # noqa: E501 - Status: 0 - fail, 1 - success. # noqa: E501 + Status: 0 - fail, 1 - success # noqa: E501 :return: The status of this UniInterestRecord. # noqa: E501 :rtype: int @@ -93,7 +93,7 @@ def status(self): def status(self, status): """Sets the status of this UniInterestRecord. - Status: 0 - fail, 1 - success. # noqa: E501 + Status: 0 - fail, 1 - success # noqa: E501 :param status: The status of this UniInterestRecord. # noqa: E501 :type: int @@ -105,7 +105,7 @@ def status(self, status): def currency(self): """Gets the currency of this UniInterestRecord. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniInterestRecord. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniInterestRecord. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this UniInterestRecord. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def currency(self, currency): def actual_rate(self): """Gets the actual_rate of this UniInterestRecord. # noqa: E501 - Actual Rate. # noqa: E501 + Actual Rate # noqa: E501 :return: The actual_rate of this UniInterestRecord. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def actual_rate(self): def actual_rate(self, actual_rate): """Sets the actual_rate of this UniInterestRecord. - Actual Rate. # noqa: E501 + Actual Rate # noqa: E501 :param actual_rate: The actual_rate of this UniInterestRecord. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def actual_rate(self, actual_rate): def interest(self): """Gets the interest of this UniInterestRecord. # noqa: E501 - Interest. # noqa: E501 + Interest # noqa: E501 :return: The interest of this UniInterestRecord. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def interest(self): def interest(self, interest): """Sets the interest of this UniInterestRecord. - Interest. # noqa: E501 + Interest # noqa: E501 :param interest: The interest of this UniInterestRecord. # noqa: E501 :type: str @@ -197,7 +197,7 @@ def interest_status(self, interest_status): def create_time(self): """Gets the create_time of this UniInterestRecord. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UniInterestRecord. # noqa: E501 :rtype: int @@ -208,7 +208,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UniInterestRecord. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UniInterestRecord. # noqa: E501 :type: int diff --git a/gate_api/models/uni_lend.py b/gate_api/models/uni_lend.py index 16bd0ae..8c00a50 100644 --- a/gate_api/models/uni_lend.py +++ b/gate_api/models/uni_lend.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -102,7 +102,7 @@ def __init__(self, currency=None, current_amount=None, amount=None, lent_amount= def currency(self): """Gets the currency of this UniLend. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniLend. # noqa: E501 :rtype: str @@ -113,7 +113,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLend. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this UniLend. # noqa: E501 :type: str @@ -125,7 +125,7 @@ def currency(self, currency): def current_amount(self): """Gets the current_amount of this UniLend. # noqa: E501 - Current amount. # noqa: E501 + Current amount # noqa: E501 :return: The current_amount of this UniLend. # noqa: E501 :rtype: str @@ -136,7 +136,7 @@ def current_amount(self): def current_amount(self, current_amount): """Sets the current_amount of this UniLend. - Current amount. # noqa: E501 + Current amount # noqa: E501 :param current_amount: The current_amount of this UniLend. # noqa: E501 :type: str @@ -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 @@ -217,7 +217,7 @@ def frozen_amount(self, frozen_amount): def min_rate(self): """Gets the min_rate of this UniLend. # noqa: E501 - Minimum interest rate. # noqa: E501 + Minimum interest rate # noqa: E501 :return: The min_rate of this UniLend. # noqa: E501 :rtype: str @@ -228,7 +228,7 @@ def min_rate(self): def min_rate(self, min_rate): """Sets the min_rate of this UniLend. - Minimum interest rate. # noqa: E501 + Minimum interest rate # noqa: E501 :param min_rate: The min_rate 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 f6375ee..80f3a0a 100644 --- a/gate_api/models/uni_lend_interest.py +++ b/gate_api/models/uni_lend_interest.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, interest=None, local_vars_configuration=None): def currency(self): """Gets the currency of this UniLendInterest. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniLendInterest. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLendInterest. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this UniLendInterest. # noqa: E501 :type: str @@ -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 bf2d677..a435111 100644 --- a/gate_api/models/uni_lend_record.py +++ b/gate_api/models/uni_lend_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, currency=None, amount=None, last_wallet_amount=None, last_len def currency(self): """Gets the currency of this UniLendRecord. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UniLendRecord. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLendRecord. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UniLendRecord. # noqa: E501 :type: str @@ -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 @@ -225,7 +225,7 @@ def type(self, type): def create_time(self): """Gets the create_time of this UniLendRecord. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UniLendRecord. # noqa: E501 :rtype: int @@ -236,7 +236,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UniLendRecord. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UniLendRecord. # noqa: E501 :type: int diff --git a/gate_api/models/uni_loan.py b/gate_api/models/uni_loan.py index c132dfe..0010ef5 100644 --- a/gate_api/models/uni_loan.py +++ b/gate_api/models/uni_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, currency=None, currency_pair=None, amount=None, type=None, cr def currency(self): """Gets the currency of this UniLoan. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniLoan. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLoan. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this UniLoan. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def currency(self, currency): def currency_pair(self): """Gets the currency_pair of this UniLoan. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this UniLoan. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this UniLoan. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this UniLoan. # noqa: E501 :type: str @@ -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 @@ -174,7 +174,7 @@ def type(self, type): def create_time(self): """Gets the create_time of this UniLoan. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UniLoan. # noqa: E501 :rtype: int @@ -185,7 +185,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UniLoan. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UniLoan. # noqa: E501 :type: int @@ -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 4a28393..537866f 100644 --- a/gate_api/models/uni_loan_interest_record.py +++ b/gate_api/models/uni_loan_interest_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, currency=None, currency_pair=None, actual_rate=None, interest def currency(self): """Gets the currency of this UniLoanInterestRecord. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UniLoanInterestRecord. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLoanInterestRecord. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UniLoanInterestRecord. # noqa: E501 :type: str @@ -110,7 +110,7 @@ def currency(self, currency): def currency_pair(self): """Gets the currency_pair of this UniLoanInterestRecord. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this UniLoanInterestRecord. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this UniLoanInterestRecord. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this UniLoanInterestRecord. # noqa: E501 :type: str @@ -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 @@ -156,7 +156,7 @@ def actual_rate(self, actual_rate): def interest(self): """Gets the interest of this UniLoanInterestRecord. # noqa: E501 - Interest. # noqa: E501 + Interest # noqa: E501 :return: The interest of this UniLoanInterestRecord. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def interest(self): def interest(self, interest): """Sets the interest of this UniLoanInterestRecord. - Interest. # noqa: E501 + Interest # noqa: E501 :param interest: The interest of this UniLoanInterestRecord. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def interest(self, interest): def status(self): """Gets the status of this UniLoanInterestRecord. # noqa: E501 - Status: 0 - fail, 1 - success. # noqa: E501 + Status: 0 - fail, 1 - success # noqa: E501 :return: The status of this UniLoanInterestRecord. # noqa: E501 :rtype: int @@ -190,7 +190,7 @@ def status(self): def status(self, status): """Sets the status of this UniLoanInterestRecord. - Status: 0 - fail, 1 - success. # noqa: E501 + Status: 0 - fail, 1 - success # noqa: E501 :param status: The status of this UniLoanInterestRecord. # noqa: E501 :type: int @@ -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 @@ -225,7 +225,7 @@ def type(self, type): def create_time(self): """Gets the create_time of this UniLoanInterestRecord. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UniLoanInterestRecord. # noqa: E501 :rtype: int @@ -236,7 +236,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UniLoanInterestRecord. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UniLoanInterestRecord. # noqa: E501 :type: int diff --git a/gate_api/models/uni_loan_record.py b/gate_api/models/uni_loan_record.py index 4aa5d73..460120b 100644 --- a/gate_api/models/uni_loan_record.py +++ b/gate_api/models/uni_loan_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -100,7 +100,7 @@ def type(self, type): def currency_pair(self): """Gets the currency_pair of this UniLoanRecord. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this UniLoanRecord. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this UniLoanRecord. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this UniLoanRecord. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def currency_pair(self, currency_pair): def currency(self): """Gets the currency of this UniLoanRecord. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UniLoanRecord. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UniLoanRecord. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency 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 @@ -169,7 +169,7 @@ def amount(self, amount): def create_time(self): """Gets the create_time of this UniLoanRecord. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UniLoanRecord. # noqa: E501 :rtype: int @@ -180,7 +180,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UniLoanRecord. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UniLoanRecord. # noqa: E501 :type: int diff --git a/gate_api/models/unified_account.py b/gate_api/models/unified_account.py index 7c2dfe7..7c3f5e4 100644 --- a/gate_api/models/unified_account.py +++ b/gate_api/models/unified_account.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -152,7 +152,7 @@ def __init__(self, user_id=None, refresh_time=None, locked=None, balances=None, def user_id(self): """Gets the user_id of this UnifiedAccount. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this UnifiedAccount. # noqa: E501 :rtype: int @@ -163,7 +163,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this UnifiedAccount. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this UnifiedAccount. # noqa: E501 :type: int @@ -175,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 @@ -186,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 @@ -242,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 @@ -253,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 @@ -265,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 @@ -276,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 @@ -426,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 @@ -437,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 @@ -449,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 @@ -460,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 @@ -472,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 @@ -483,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 @@ -495,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 @@ -506,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 @@ -541,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 @@ -552,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 @@ -564,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 @@ -575,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 @@ -587,7 +587,7 @@ def use_funding(self, use_funding): def is_all_collateral(self): """Gets the is_all_collateral of this UnifiedAccount. # noqa: E501 - Whether all currencies are used as margin, true - false - No # 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 @@ -598,7 +598,7 @@ def is_all_collateral(self): def is_all_collateral(self, is_all_collateral): """Sets the is_all_collateral of this UnifiedAccount. - Whether all currencies are used as margin, true - false - No # noqa: E501 + 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 diff --git a/gate_api/models/unified_balance.py b/gate_api/models/unified_balance.py index cd39662..1d7171a 100644 --- a/gate_api/models/unified_balance.py +++ b/gate_api/models/unified_balance.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -152,7 +152,7 @@ def __init__(self, available=None, freeze=None, borrowed=None, negative_liab=Non 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 @@ -163,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 @@ -175,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 @@ -186,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 @@ -198,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 @@ -209,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 @@ -221,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 @@ -232,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 @@ -290,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 @@ -301,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 @@ -313,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 @@ -324,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 @@ -382,7 +382,7 @@ def funding(self, funding): def funding_version(self): """Gets the funding_version of this UnifiedBalance. # noqa: E501 - Funding version. # noqa: E501 + Funding version # noqa: E501 :return: The funding_version of this UnifiedBalance. # noqa: E501 :rtype: str @@ -393,7 +393,7 @@ def funding_version(self): def funding_version(self, funding_version): """Sets the funding_version of this UnifiedBalance. - Funding version. # noqa: E501 + Funding version # noqa: E501 :param funding_version: The funding_version of this UnifiedBalance. # noqa: E501 :type: str @@ -474,7 +474,7 @@ def im(self, im): def mm(self): """Gets the mm of this UnifiedBalance. # noqa: E501 - The full position maintains margin, which is valid in the single currency margin mode, and other cross-currency margin combination margin mode is 0. # 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 @@ -485,7 +485,7 @@ def mm(self): def mm(self, mm): """Sets the mm of this UnifiedBalance. - The full position maintains margin, which is valid in the single currency margin mode, and other cross-currency margin combination margin mode is 0. # 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 @@ -566,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 @@ -577,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 @@ -589,7 +589,7 @@ def available_margin(self, available_margin): def enabled_collateral(self): """Gets the enabled_collateral of this UnifiedBalance. # noqa: E501 - Currency enabled as margin: true - Enabled, false - Disabled. # noqa: E501 + Currency enabled as margin: true - Enabled, false - Disabled # noqa: E501 :return: The enabled_collateral of this UnifiedBalance. # noqa: E501 :rtype: bool @@ -600,7 +600,7 @@ def enabled_collateral(self): def enabled_collateral(self, enabled_collateral): """Sets the enabled_collateral of this UnifiedBalance. - Currency enabled as margin: true - Enabled, false - Disabled. # noqa: E501 + Currency enabled as margin: true - Enabled, false - Disabled # noqa: E501 :param enabled_collateral: The enabled_collateral of this UnifiedBalance. # noqa: E501 :type: bool diff --git a/gate_api/models/unified_borrowable.py b/gate_api/models/unified_borrowable.py index 51ac569..7201c76 100644 --- a/gate_api/models/unified_borrowable.py +++ b/gate_api/models/unified_borrowable.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None): def currency(self): """Gets the currency of this UnifiedBorrowable. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this UnifiedBorrowable. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedBorrowable. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this UnifiedBorrowable. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this UnifiedBorrowable. # noqa: E501 - Max borrowable amount. # noqa: E501 + Max borrowable amount # noqa: E501 :return: The amount of this UnifiedBorrowable. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this UnifiedBorrowable. - Max borrowable amount. # noqa: E501 + Max borrowable amount # noqa: E501 :param amount: The amount of this UnifiedBorrowable. # noqa: E501 :type: str diff --git a/gate_api/models/unified_borrowable1.py b/gate_api/models/unified_borrowable1.py index 88aea59..626d1af 100644 --- a/gate_api/models/unified_borrowable1.py +++ b/gate_api/models/unified_borrowable1.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None): def currency(self): """Gets the currency of this UnifiedBorrowable1. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this UnifiedBorrowable1. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedBorrowable1. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this UnifiedBorrowable1. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def amount(self): """Gets the amount of this UnifiedBorrowable1. # noqa: E501 - The maximum amount to borrow. # noqa: E501 + Maximum borrowable amount # noqa: E501 :return: The amount of this UnifiedBorrowable1. # noqa: E501 :rtype: str @@ -96,7 +96,7 @@ def amount(self): def amount(self, amount): """Sets the amount of this UnifiedBorrowable1. - The maximum amount to borrow. # noqa: E501 + Maximum borrowable amount # noqa: E501 :param amount: The amount of this UnifiedBorrowable1. # noqa: E501 :type: str diff --git a/gate_api/models/unified_collateral_req.py b/gate_api/models/unified_collateral_req.py index 16b276b..6e4c9c2 100644 --- a/gate_api/models/unified_collateral_req.py +++ b/gate_api/models/unified_collateral_req.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, collateral_type=None, enable_list=None, disable_list=None, lo def collateral_type(self): """Gets the collateral_type of this UnifiedCollateralReq. # noqa: E501 - User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid # 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 @@ -78,7 +78,7 @@ def collateral_type(self): def collateral_type(self, collateral_type): """Sets the collateral_type of this UnifiedCollateralReq. - User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid # 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 :param collateral_type: The collateral_type of this UnifiedCollateralReq. # noqa: E501 :type: int @@ -96,7 +96,7 @@ def collateral_type(self, collateral_type): def enable_list(self): """Gets the enable_list of this UnifiedCollateralReq. # noqa: E501 - Currency list, where collateral_type=1(custom) indicates the logic of addition # 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] @@ -107,7 +107,7 @@ def enable_list(self): def enable_list(self, enable_list): """Sets the enable_list of this UnifiedCollateralReq. - Currency list, where collateral_type=1(custom) indicates the logic of addition # noqa: E501 + 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] @@ -119,7 +119,7 @@ def enable_list(self, enable_list): def disable_list(self): """Gets the disable_list of this UnifiedCollateralReq. # noqa: E501 - Cancellation list, indicating the logic of cancellation. # noqa: E501 + Disable list, indicating the disable logic # noqa: E501 :return: The disable_list of this UnifiedCollateralReq. # noqa: E501 :rtype: list[str] @@ -130,7 +130,7 @@ def disable_list(self): def disable_list(self, disable_list): """Sets the disable_list of this UnifiedCollateralReq. - Cancellation list, indicating the logic of cancellation. # noqa: E501 + Disable list, indicating the disable logic # noqa: E501 :param disable_list: The disable_list of this UnifiedCollateralReq. # noqa: E501 :type: list[str] diff --git a/gate_api/models/unified_collateral_res.py b/gate_api/models/unified_collateral_res.py index 39aca87..a1cd842 100644 --- a/gate_api/models/unified_collateral_res.py +++ b/gate_api/models/unified_collateral_res.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, is_success=None, local_vars_configuration=None): # noqa: E50 def is_success(self): """Gets the is_success of this UnifiedCollateralRes. # noqa: E501 - Whether the setting was successful. # noqa: E501 + Whether the setting was successful # noqa: E501 :return: The is_success of this UnifiedCollateralRes. # noqa: E501 :rtype: bool @@ -68,7 +68,7 @@ def is_success(self): def is_success(self, is_success): """Sets the is_success of this UnifiedCollateralRes. - Whether the setting was successful. # noqa: E501 + Whether the setting was successful # noqa: E501 :param is_success: The is_success of this UnifiedCollateralRes. # noqa: E501 :type: bool diff --git a/gate_api/models/unified_currency.py b/gate_api/models/unified_currency.py index 38ee3db..1039e91 100644 --- a/gate_api/models/unified_currency.py +++ b/gate_api/models/unified_currency.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -82,7 +82,7 @@ def __init__(self, name=None, prec=None, min_borrow_amount=None, user_max_borrow def name(self): """Gets the name of this UnifiedCurrency. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The name of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -93,7 +93,7 @@ def name(self): def name(self, name): """Sets the name of this UnifiedCurrency. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param name: The name of this UnifiedCurrency. # noqa: E501 :type: str @@ -105,7 +105,7 @@ def name(self, name): def prec(self): """Gets the prec of this UnifiedCurrency. # noqa: E501 - Currency precision. # noqa: E501 + Currency precision # noqa: E501 :return: The prec of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -116,7 +116,7 @@ def prec(self): def prec(self, prec): """Sets the prec of this UnifiedCurrency. - Currency precision. # noqa: E501 + Currency precision # noqa: E501 :param prec: The prec of this UnifiedCurrency. # noqa: E501 :type: str @@ -128,7 +128,7 @@ def prec(self, prec): def min_borrow_amount(self): """Gets the min_borrow_amount of this UnifiedCurrency. # noqa: E501 - The minimum debit limit is the unit of currency. # noqa: E501 + Minimum borrowable limit, in currency units # noqa: E501 :return: The min_borrow_amount of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -139,7 +139,7 @@ def min_borrow_amount(self): def min_borrow_amount(self, min_borrow_amount): """Sets the min_borrow_amount of this UnifiedCurrency. - The minimum debit limit is the unit of currency. # noqa: E501 + Minimum borrowable limit, in currency units # noqa: E501 :param min_borrow_amount: The min_borrow_amount of this UnifiedCurrency. # noqa: E501 :type: str @@ -151,7 +151,7 @@ def min_borrow_amount(self, min_borrow_amount): def user_max_borrow_amount(self): """Gets the user_max_borrow_amount of this UnifiedCurrency. # noqa: E501 - The minimum debit limit is the unit of currency. # noqa: E501 + User's maximum borrowable limit, in USDT # noqa: E501 :return: The user_max_borrow_amount of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -162,7 +162,7 @@ def user_max_borrow_amount(self): def user_max_borrow_amount(self, user_max_borrow_amount): """Sets the user_max_borrow_amount of this UnifiedCurrency. - The minimum debit limit is the unit of currency. # noqa: E501 + 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 @@ -174,7 +174,7 @@ def user_max_borrow_amount(self, user_max_borrow_amount): def total_max_borrow_amount(self): """Gets the total_max_borrow_amount of this UnifiedCurrency. # noqa: E501 - The maximum debit limit for the platform is USDT. # noqa: E501 + Platform's maximum borrowable limit, in USDT # noqa: E501 :return: The total_max_borrow_amount of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -185,7 +185,7 @@ def total_max_borrow_amount(self): def total_max_borrow_amount(self, total_max_borrow_amount): """Sets the total_max_borrow_amount of this UnifiedCurrency. - The maximum debit limit for the platform is USDT. # noqa: E501 + 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 @@ -197,7 +197,7 @@ def total_max_borrow_amount(self, total_max_borrow_amount): def loan_status(self): """Gets the loan_status of this UnifiedCurrency. # noqa: E501 - Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending # noqa: E501 + Lending status - `disable` : Lending prohibited - `enable` : Lending supported # noqa: E501 :return: The loan_status of this UnifiedCurrency. # noqa: E501 :rtype: str @@ -208,7 +208,7 @@ def loan_status(self): def loan_status(self, loan_status): """Sets the loan_status of this UnifiedCurrency. - Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending # noqa: E501 + Lending status - `disable` : Lending prohibited - `enable` : Lending supported # noqa: E501 :param loan_status: The loan_status of this UnifiedCurrency. # noqa: E501 :type: str diff --git a/gate_api/models/unified_discount.py b/gate_api/models/unified_discount.py index 77cb853..27cad2c 100644 --- a/gate_api/models/unified_discount.py +++ b/gate_api/models/unified_discount.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, discount_tiers=None, local_vars_configuration= def currency(self): """Gets the currency of this UnifiedDiscount. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UnifiedDiscount. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedDiscount. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UnifiedDiscount. # noqa: E501 :type: str @@ -85,7 +85,7 @@ def currency(self, currency): def discount_tiers(self): """Gets the discount_tiers of this UnifiedDiscount. # noqa: E501 - Tiered discount. # noqa: E501 + Tiered discount # noqa: E501 :return: The discount_tiers of this UnifiedDiscount. # noqa: E501 :rtype: list[UnifiedDiscountTiers] @@ -96,7 +96,7 @@ def discount_tiers(self): def discount_tiers(self, discount_tiers): """Sets the discount_tiers of this UnifiedDiscount. - Tiered discount. # noqa: E501 + Tiered discount # noqa: E501 :param discount_tiers: The discount_tiers of this UnifiedDiscount. # noqa: E501 :type: list[UnifiedDiscountTiers] diff --git a/gate_api/models/unified_discount_tiers.py b/gate_api/models/unified_discount_tiers.py index 7834158..1487ce8 100644 --- a/gate_api/models/unified_discount_tiers.py +++ b/gate_api/models/unified_discount_tiers.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -77,7 +77,7 @@ def __init__(self, tier=None, discount=None, lower_limit=None, upper_limit=None, def tier(self): """Gets the tier of this UnifiedDiscountTiers. # noqa: E501 - Tier. # noqa: E501 + Tier # noqa: E501 :return: The tier of this UnifiedDiscountTiers. # noqa: E501 :rtype: str @@ -88,7 +88,7 @@ def tier(self): def tier(self, tier): """Sets the tier of this UnifiedDiscountTiers. - Tier. # noqa: E501 + Tier # noqa: E501 :param tier: The tier of this UnifiedDiscountTiers. # noqa: E501 :type: str @@ -100,7 +100,7 @@ def tier(self, tier): def discount(self): """Gets the discount of this UnifiedDiscountTiers. # noqa: E501 - Discount. # noqa: E501 + Discount # noqa: E501 :return: The discount of this UnifiedDiscountTiers. # noqa: E501 :rtype: str @@ -111,7 +111,7 @@ def discount(self): def discount(self, discount): """Sets the discount of this UnifiedDiscountTiers. - Discount. # noqa: E501 + Discount # noqa: E501 :param discount: The discount of this UnifiedDiscountTiers. # noqa: E501 :type: str @@ -123,7 +123,7 @@ def discount(self, discount): def lower_limit(self): """Gets the lower_limit of this UnifiedDiscountTiers. # noqa: E501 - Lower limit. # noqa: E501 + Lower limit # noqa: E501 :return: The lower_limit of this UnifiedDiscountTiers. # noqa: E501 :rtype: str @@ -134,7 +134,7 @@ def lower_limit(self): def lower_limit(self, lower_limit): """Sets the lower_limit of this UnifiedDiscountTiers. - Lower limit. # noqa: E501 + Lower limit # noqa: E501 :param lower_limit: The lower_limit of this UnifiedDiscountTiers. # noqa: E501 :type: str @@ -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 @@ -169,7 +169,7 @@ def upper_limit(self, upper_limit): def leverage(self): """Gets the leverage of this UnifiedDiscountTiers. # noqa: E501 - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :return: The leverage of this UnifiedDiscountTiers. # noqa: E501 :rtype: str @@ -180,7 +180,7 @@ def leverage(self): def leverage(self, leverage): """Sets the leverage of this UnifiedDiscountTiers. - Position leverage. # noqa: E501 + Position leverage # noqa: E501 :param leverage: The leverage 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 2dddf84..dd3edd2 100644 --- a/gate_api/models/unified_history_loan_rate.py +++ b/gate_api/models/unified_history_loan_rate.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, currency=None, tier=None, tier_up_rate=None, rates=None, loca def currency(self): """Gets the currency of this UnifiedHistoryLoanRate. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UnifiedHistoryLoanRate. # noqa: E501 :rtype: str @@ -83,7 +83,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedHistoryLoanRate. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UnifiedHistoryLoanRate. # noqa: E501 :type: str @@ -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 e468266..100221f 100644 --- a/gate_api/models/unified_history_loan_rate_rates.py +++ b/gate_api/models/unified_history_loan_rate_rates.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 0def7ee..1e4bf22 100644 --- a/gate_api/models/unified_leverage_config.py +++ b/gate_api/models/unified_leverage_config.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, current_leverage=None, min_leverage=None, max_leverage=None, def current_leverage(self): """Gets the current_leverage of this UnifiedLeverageConfig. # noqa: E501 - Current leverage ratio. # noqa: E501 + Current leverage ratio # noqa: E501 :return: The current_leverage of this UnifiedLeverageConfig. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def current_leverage(self): def current_leverage(self, current_leverage): """Sets the current_leverage of this UnifiedLeverageConfig. - Current leverage ratio. # noqa: E501 + Current leverage ratio # noqa: E501 :param current_leverage: The current_leverage of this UnifiedLeverageConfig. # noqa: E501 :type: str @@ -110,7 +110,7 @@ def current_leverage(self, current_leverage): def min_leverage(self): """Gets the min_leverage of this UnifiedLeverageConfig. # noqa: E501 - Minimum adjustable leverage ratio. # noqa: E501 + Minimum adjustable leverage ratio # noqa: E501 :return: The min_leverage of this UnifiedLeverageConfig. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def min_leverage(self): def min_leverage(self, min_leverage): """Sets the min_leverage of this UnifiedLeverageConfig. - Minimum adjustable leverage ratio. # noqa: E501 + Minimum adjustable leverage ratio # noqa: E501 :param min_leverage: The min_leverage of this UnifiedLeverageConfig. # noqa: E501 :type: str @@ -133,7 +133,7 @@ def min_leverage(self, min_leverage): def max_leverage(self): """Gets the max_leverage of this UnifiedLeverageConfig. # noqa: E501 - Maximum adjustable leverage ratio. # noqa: E501 + Maximum adjustable leverage ratio # noqa: E501 :return: The max_leverage of this UnifiedLeverageConfig. # noqa: E501 :rtype: str @@ -144,7 +144,7 @@ def max_leverage(self): def max_leverage(self, max_leverage): """Sets the max_leverage of this UnifiedLeverageConfig. - Maximum adjustable leverage ratio. # noqa: E501 + Maximum adjustable leverage ratio # noqa: E501 :param max_leverage: The max_leverage of this UnifiedLeverageConfig. # noqa: E501 :type: str @@ -156,7 +156,7 @@ def max_leverage(self, max_leverage): def debit(self): """Gets the debit of this UnifiedLeverageConfig. # noqa: E501 - Current liabilities. # noqa: E501 + Current liabilities # noqa: E501 :return: The debit of this UnifiedLeverageConfig. # noqa: E501 :rtype: str @@ -167,7 +167,7 @@ def debit(self): def debit(self, debit): """Sets the debit of this UnifiedLeverageConfig. - Current liabilities. # noqa: E501 + Current liabilities # noqa: E501 :param debit: The debit of this UnifiedLeverageConfig. # noqa: E501 :type: str @@ -179,7 +179,7 @@ def debit(self, debit): def available_margin(self): """Gets the available_margin of this UnifiedLeverageConfig. # noqa: E501 - Available Margin. # noqa: E501 + Available Margin # noqa: E501 :return: The available_margin of this UnifiedLeverageConfig. # noqa: E501 :rtype: str @@ -190,7 +190,7 @@ def available_margin(self): def available_margin(self, available_margin): """Sets the available_margin of this UnifiedLeverageConfig. - Available Margin. # noqa: E501 + Available Margin # noqa: E501 :param available_margin: The available_margin of this UnifiedLeverageConfig. # noqa: E501 :type: str @@ -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 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 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 a2acf90..4ac92bb 100644 --- a/gate_api/models/unified_leverage_setting.py +++ b/gate_api/models/unified_leverage_setting.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -60,7 +60,7 @@ def __init__(self, currency=None, leverage=None, local_vars_configuration=None): def currency(self): """Gets the currency of this UnifiedLeverageSetting. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UnifiedLeverageSetting. # noqa: E501 :rtype: str @@ -71,7 +71,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedLeverageSetting. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UnifiedLeverageSetting. # noqa: E501 :type: str @@ -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,7 +96,7 @@ 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 diff --git a/gate_api/models/unified_loan.py b/gate_api/models/unified_loan.py index a404fd0..d8d000c 100644 --- a/gate_api/models/unified_loan.py +++ b/gate_api/models/unified_loan.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -74,7 +74,7 @@ def __init__(self, currency=None, type=None, amount=None, repaid_all=None, text= def currency(self): """Gets the currency of this UnifiedLoan. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UnifiedLoan. # noqa: E501 :rtype: str @@ -85,7 +85,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedLoan. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this UnifiedLoan. # noqa: E501 :type: str @@ -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 @@ -178,7 +178,7 @@ def repaid_all(self, repaid_all): def text(self): """Gets the text of this UnifiedLoan. # noqa: E501 - User defined custom ID. # noqa: E501 + User defined custom ID # noqa: E501 :return: The text of this UnifiedLoan. # noqa: E501 :rtype: str @@ -189,7 +189,7 @@ def text(self): def text(self, text): """Sets the text of this UnifiedLoan. - User defined custom ID. # noqa: E501 + User defined custom ID # noqa: E501 :param text: The text of this UnifiedLoan. # noqa: E501 :type: str diff --git a/gate_api/models/unified_loan_record.py b/gate_api/models/unified_loan_record.py index fb868f1..4cce938 100644 --- a/gate_api/models/unified_loan_record.py +++ b/gate_api/models/unified_loan_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 after withdrawal, different_currencies_repayment - Different currency repayment # 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 after withdrawal, different_currencies_repayment - Different currency repayment # 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 @@ -184,7 +184,7 @@ def borrow_type(self, borrow_type): def currency_pair(self): """Gets the currency_pair of this UnifiedLoanRecord. # noqa: E501 - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :return: The currency_pair of this UnifiedLoanRecord. # noqa: E501 :rtype: str @@ -195,7 +195,7 @@ def currency_pair(self): def currency_pair(self, currency_pair): """Sets the currency_pair of this UnifiedLoanRecord. - Currency pair. # noqa: E501 + Currency pair # noqa: E501 :param currency_pair: The currency_pair of this UnifiedLoanRecord. # noqa: E501 :type: str @@ -207,7 +207,7 @@ def currency_pair(self, currency_pair): def currency(self): """Gets the currency of this UnifiedLoanRecord. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this UnifiedLoanRecord. # noqa: E501 :rtype: str @@ -218,7 +218,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedLoanRecord. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency 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 @@ -253,7 +253,7 @@ def amount(self, amount): def create_time(self): """Gets the create_time of this UnifiedLoanRecord. # noqa: E501 - Created time. # noqa: E501 + Created time # noqa: E501 :return: The create_time of this UnifiedLoanRecord. # noqa: E501 :rtype: int @@ -264,7 +264,7 @@ def create_time(self): def create_time(self, create_time): """Sets the create_time of this UnifiedLoanRecord. - Created time. # noqa: E501 + Created time # noqa: E501 :param create_time: The create_time of this UnifiedLoanRecord. # noqa: E501 :type: int diff --git a/gate_api/models/unified_loan_result.py b/gate_api/models/unified_loan_result.py index cac2485..58dced5 100644 --- a/gate_api/models/unified_loan_result.py +++ b/gate_api/models/unified_loan_result.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, tran_id=None, local_vars_configuration=None): # noqa: E501 def tran_id(self): """Gets the tran_id of this UnifiedLoanResult. # noqa: E501 - Transaction id. # noqa: E501 + Transaction ID # noqa: E501 :return: The tran_id of this UnifiedLoanResult. # noqa: E501 :rtype: int @@ -68,7 +68,7 @@ def tran_id(self): def tran_id(self, tran_id): """Sets the tran_id of this UnifiedLoanResult. - Transaction id. # noqa: E501 + Transaction ID # noqa: E501 :param tran_id: The tran_id of this UnifiedLoanResult. # noqa: E501 :type: int diff --git a/gate_api/models/unified_margin_tiers.py b/gate_api/models/unified_margin_tiers.py index d516c89..8e61cbe 100644 --- a/gate_api/models/unified_margin_tiers.py +++ b/gate_api/models/unified_margin_tiers.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, margin_tiers=None, local_vars_configuration=No def currency(self): """Gets the currency of this UnifiedMarginTiers. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this UnifiedMarginTiers. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedMarginTiers. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this UnifiedMarginTiers. # noqa: E501 :type: str @@ -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 e30c760..8fe6a71 100644 --- a/gate_api/models/unified_mode_set.py +++ b/gate_api/models/unified_mode_set.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 4c22e43..57ca957 100644 --- a/gate_api/models/unified_portfolio_input.py +++ b/gate_api/models/unified_portfolio_input.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -87,7 +87,7 @@ def __init__(self, spot_balances=None, spot_orders=None, futures_positions=None, def spot_balances(self): """Gets the spot_balances of this UnifiedPortfolioInput. # noqa: E501 - Spot. # noqa: E501 + Spot # noqa: E501 :return: The spot_balances of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockSpotBalance] @@ -98,7 +98,7 @@ def spot_balances(self): def spot_balances(self, spot_balances): """Sets the spot_balances of this UnifiedPortfolioInput. - Spot. # noqa: E501 + Spot # noqa: E501 :param spot_balances: The spot_balances of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockSpotBalance] @@ -110,7 +110,7 @@ def spot_balances(self, spot_balances): def spot_orders(self): """Gets the spot_orders of this UnifiedPortfolioInput. # noqa: E501 - Spot orders. # noqa: E501 + Spot orders # noqa: E501 :return: The spot_orders of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockSpotOrder] @@ -121,7 +121,7 @@ def spot_orders(self): def spot_orders(self, spot_orders): """Sets the spot_orders of this UnifiedPortfolioInput. - Spot orders. # noqa: E501 + Spot orders # noqa: E501 :param spot_orders: The spot_orders of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockSpotOrder] @@ -133,7 +133,7 @@ def spot_orders(self, spot_orders): def futures_positions(self): """Gets the futures_positions of this UnifiedPortfolioInput. # noqa: E501 - Futures positions. # noqa: E501 + Futures positions # noqa: E501 :return: The futures_positions of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockFuturesPosition] @@ -144,7 +144,7 @@ def futures_positions(self): def futures_positions(self, futures_positions): """Sets the futures_positions of this UnifiedPortfolioInput. - Futures positions. # noqa: E501 + Futures positions # noqa: E501 :param futures_positions: The futures_positions of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockFuturesPosition] @@ -156,7 +156,7 @@ def futures_positions(self, futures_positions): def futures_orders(self): """Gets the futures_orders of this UnifiedPortfolioInput. # noqa: E501 - Futures order. # noqa: E501 + Futures order # noqa: E501 :return: The futures_orders of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockFuturesOrder] @@ -167,7 +167,7 @@ def futures_orders(self): def futures_orders(self, futures_orders): """Sets the futures_orders of this UnifiedPortfolioInput. - Futures order. # noqa: E501 + Futures order # noqa: E501 :param futures_orders: The futures_orders of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockFuturesOrder] @@ -179,7 +179,7 @@ def futures_orders(self, futures_orders): def options_positions(self): """Gets the options_positions of this UnifiedPortfolioInput. # noqa: E501 - Options positions. # noqa: E501 + Options positions # noqa: E501 :return: The options_positions of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockOptionsPosition] @@ -190,7 +190,7 @@ def options_positions(self): def options_positions(self, options_positions): """Sets the options_positions of this UnifiedPortfolioInput. - Options positions. # noqa: E501 + Options positions # noqa: E501 :param options_positions: The options_positions of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockOptionsPosition] @@ -202,7 +202,7 @@ def options_positions(self, options_positions): def options_orders(self): """Gets the options_orders of this UnifiedPortfolioInput. # noqa: E501 - Option orders. # noqa: E501 + Option orders # noqa: E501 :return: The options_orders of this UnifiedPortfolioInput. # noqa: E501 :rtype: list[MockOptionsOrder] @@ -213,7 +213,7 @@ def options_orders(self): def options_orders(self, options_orders): """Sets the options_orders of this UnifiedPortfolioInput. - Option orders. # noqa: E501 + Option orders # noqa: E501 :param options_orders: The options_orders of this UnifiedPortfolioInput. # noqa: E501 :type: list[MockOptionsOrder] @@ -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 2bb0605..ed08278 100644 --- a/gate_api/models/unified_portfolio_output.py +++ b/gate_api/models/unified_portfolio_output.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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, 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, 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 @@ -141,7 +141,7 @@ def calculate_time(self, calculate_time): def risk_unit(self): """Gets the risk_unit of this UnifiedPortfolioOutput. # noqa: E501 - Risk unit. # noqa: E501 + Risk unit # noqa: E501 :return: The risk_unit of this UnifiedPortfolioOutput. # noqa: E501 :rtype: list[MockRiskUnit] @@ -152,7 +152,7 @@ def risk_unit(self): def risk_unit(self, risk_unit): """Sets the risk_unit of this UnifiedPortfolioOutput. - Risk unit. # noqa: E501 + Risk unit # noqa: E501 :param risk_unit: The risk_unit of this UnifiedPortfolioOutput. # noqa: E501 :type: list[MockRiskUnit] diff --git a/gate_api/models/unified_risk_units.py b/gate_api/models/unified_risk_units.py index 32eebfa..7197a7e 100644 --- a/gate_api/models/unified_risk_units.py +++ b/gate_api/models/unified_risk_units.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -67,7 +67,7 @@ def __init__(self, user_id=None, spot_hedge=None, risk_units=None, local_vars_co def user_id(self): """Gets the user_id of this UnifiedRiskUnits. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The user_id of this UnifiedRiskUnits. # noqa: E501 :rtype: int @@ -78,7 +78,7 @@ def user_id(self): def user_id(self, user_id): """Sets the user_id of this UnifiedRiskUnits. - User ID. # noqa: E501 + User ID # noqa: E501 :param user_id: The user_id of this UnifiedRiskUnits. # noqa: E501 :type: int @@ -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 @@ -113,7 +113,7 @@ def spot_hedge(self, spot_hedge): def risk_units(self): """Gets the risk_units of this UnifiedRiskUnits. # noqa: E501 - Risk unit. # noqa: E501 + Risk unit # noqa: E501 :return: The risk_units of this UnifiedRiskUnits. # noqa: E501 :rtype: list[RiskUnits] @@ -124,7 +124,7 @@ def risk_units(self): def risk_units(self, risk_units): """Sets the risk_units of this UnifiedRiskUnits. - Risk unit. # noqa: E501 + Risk unit # noqa: E501 :param risk_units: The risk_units of this UnifiedRiskUnits. # noqa: E501 :type: list[RiskUnits] diff --git a/gate_api/models/unified_settings.py b/gate_api/models/unified_settings.py index abddea0..7ab84b4 100644 --- a/gate_api/models/unified_settings.py +++ b/gate_api/models/unified_settings.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 - Spot hedging switch. # 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. - Spot hedging switch. # 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 - switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds 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. - switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds 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 a9ec826..e4b5311 100644 --- a/gate_api/models/unified_transferable.py +++ b/gate_api/models/unified_transferable.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -62,7 +62,7 @@ def __init__(self, currency=None, amount=None, local_vars_configuration=None): def currency(self): """Gets the currency of this UnifiedTransferable. # noqa: E501 - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :return: The currency of this UnifiedTransferable. # noqa: E501 :rtype: str @@ -73,7 +73,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this UnifiedTransferable. - Currency detail. # noqa: E501 + Currency detail # noqa: E501 :param currency: The currency of this UnifiedTransferable. # noqa: E501 :type: str @@ -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 e8341c0..e56f15a 100644 --- a/gate_api/models/user_ltv_info.py +++ b/gate_api/models/user_ltv_info.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 @@ -110,7 +110,7 @@ def collateral_currency(self, collateral_currency): def borrow_currency(self): """Gets the borrow_currency of this UserLtvInfo. # noqa: E501 - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :return: The borrow_currency of this UserLtvInfo. # noqa: E501 :rtype: str @@ -121,7 +121,7 @@ def borrow_currency(self): def borrow_currency(self, borrow_currency): """Sets the borrow_currency of this UserLtvInfo. - Borrowed currency. # noqa: E501 + Borrowed currency # noqa: E501 :param borrow_currency: The borrow_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 @@ -202,7 +202,7 @@ def liquidate_ltv(self, liquidate_ltv): def min_borrow_amount(self): """Gets the min_borrow_amount of this UserLtvInfo. # noqa: E501 - Minimum borrowable amount for the loan currency. # noqa: E501 + Minimum borrowable amount for the loan currency # noqa: E501 :return: The min_borrow_amount of this UserLtvInfo. # noqa: E501 :rtype: str @@ -213,7 +213,7 @@ def min_borrow_amount(self): def min_borrow_amount(self, min_borrow_amount): """Sets the min_borrow_amount of this UserLtvInfo. - Minimum borrowable amount for the loan currency. # noqa: E501 + Minimum borrowable amount for the loan currency # noqa: E501 :param min_borrow_amount: The min_borrow_amount of this UserLtvInfo. # noqa: E501 :type: str @@ -225,7 +225,7 @@ def min_borrow_amount(self, min_borrow_amount): def left_borrowable_amount(self): """Gets the left_borrowable_amount of this UserLtvInfo. # noqa: E501 - Remaining borrowable amount for the loan currency. # noqa: E501 + Remaining borrowable amount for the loan currency # noqa: E501 :return: The left_borrowable_amount of this UserLtvInfo. # noqa: E501 :rtype: str @@ -236,7 +236,7 @@ def left_borrowable_amount(self): def left_borrowable_amount(self, left_borrowable_amount): """Sets the left_borrowable_amount of this UserLtvInfo. - Remaining borrowable amount for the loan currency. # noqa: E501 + Remaining borrowable amount for the loan currency # noqa: E501 :param left_borrowable_amount: The left_borrowable_amount of this UserLtvInfo. # noqa: E501 :type: str diff --git a/gate_api/models/user_sub.py b/gate_api/models/user_sub.py index b43ed57..d3728b1 100644 --- a/gate_api/models/user_sub.py +++ b/gate_api/models/user_sub.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -72,7 +72,7 @@ def __init__(self, uid=None, belong=None, type=None, ref_uid=None, local_vars_co def uid(self): """Gets the uid of this UserSub. # noqa: E501 - User ID. # noqa: E501 + User ID # noqa: E501 :return: The uid of this UserSub. # noqa: E501 :rtype: int @@ -83,7 +83,7 @@ def uid(self): def uid(self, uid): """Sets the uid of this UserSub. - User ID. # noqa: E501 + User ID # noqa: E501 :param uid: The uid of this UserSub. # noqa: E501 :type: int @@ -95,7 +95,7 @@ def uid(self, uid): def belong(self): """Gets the belong of this UserSub. # noqa: E501 - The system to which the user belongs (partner referral). If empty, it means not belonging to any system. # 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 @@ -106,7 +106,7 @@ def belong(self): def belong(self, belong): """Sets the belong of this UserSub. - The system to which the user belongs (partner referral). If empty, it means not belonging to any system. # noqa: E501 + 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 @@ -118,7 +118,7 @@ def belong(self, belong): def type(self): """Gets the type of this UserSub. # noqa: E501 - Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct customer 4-indirect direct customer 5-ordinary user) # 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 @@ -129,7 +129,7 @@ def type(self): def type(self, type): """Sets the type of this UserSub. - Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct customer 4-indirect direct customer 5-ordinary user) # 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 :param type: The type of this UserSub. # noqa: E501 :type: int @@ -141,7 +141,7 @@ def type(self, type): def ref_uid(self): """Gets the ref_uid of this UserSub. # noqa: E501 - Inviter user ID. # noqa: E501 + Inviter user ID # noqa: E501 :return: The ref_uid of this UserSub. # noqa: E501 :rtype: int @@ -152,7 +152,7 @@ def ref_uid(self): def ref_uid(self, ref_uid): """Sets the ref_uid of this UserSub. - Inviter user ID. # noqa: E501 + Inviter user ID # noqa: E501 :param ref_uid: The ref_uid of this UserSub. # noqa: E501 :type: int diff --git a/gate_api/models/user_sub_relation.py b/gate_api/models/user_sub_relation.py index c233960..533e250 100644 --- a/gate_api/models/user_sub_relation.py +++ b/gate_api/models/user_sub_relation.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -57,7 +57,7 @@ def __init__(self, list=None, local_vars_configuration=None): # noqa: E501 def list(self): """Gets the list of this UserSubRelation. # noqa: E501 - Subordinate relationship list. # noqa: E501 + Subordinate relationship list # noqa: E501 :return: The list of this UserSubRelation. # noqa: E501 :rtype: list[UserSub] @@ -68,7 +68,7 @@ def list(self): def list(self, list): """Sets the list of this UserSubRelation. - Subordinate relationship list. # noqa: E501 + Subordinate relationship list # noqa: E501 :param list: The list of this UserSubRelation. # noqa: E501 :type: list[UserSub] diff --git a/gate_api/models/user_total_amount.py b/gate_api/models/user_total_amount.py index eff80a1..759f31e 100644 --- a/gate_api/models/user_total_amount.py +++ b/gate_api/models/user_total_amount.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -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 f47c4cb..8803fc9 100644 --- a/gate_api/models/withdraw_status.py +++ b/gate_api/models/withdraw_status.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -112,7 +112,7 @@ def __init__(self, currency=None, name=None, name_cn=None, deposit=None, withdra def currency(self): """Gets the currency of this WithdrawStatus. # noqa: E501 - Currency. # noqa: E501 + Currency # noqa: E501 :return: The currency of this WithdrawStatus. # noqa: E501 :rtype: str @@ -123,7 +123,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this WithdrawStatus. - Currency. # noqa: E501 + Currency # noqa: E501 :param currency: The currency of this WithdrawStatus. # noqa: E501 :type: str @@ -135,7 +135,7 @@ def currency(self, currency): def name(self): """Gets the name of this WithdrawStatus. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The name of this WithdrawStatus. # noqa: E501 :rtype: str @@ -146,7 +146,7 @@ def name(self): def name(self, name): """Sets the name of this WithdrawStatus. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param name: The name of this WithdrawStatus. # noqa: E501 :type: str @@ -158,7 +158,7 @@ def name(self, name): def name_cn(self): """Gets the name_cn of this WithdrawStatus. # noqa: E501 - Currency Chinese name. # noqa: E501 + Currency Chinese name # noqa: E501 :return: The name_cn of this WithdrawStatus. # noqa: E501 :rtype: str @@ -169,7 +169,7 @@ def name_cn(self): def name_cn(self, name_cn): """Sets the name_cn of this WithdrawStatus. - Currency Chinese name. # noqa: E501 + Currency Chinese name # noqa: E501 :param name_cn: The name_cn of this WithdrawStatus. # noqa: E501 :type: str @@ -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 @@ -204,7 +204,7 @@ def deposit(self, deposit): def withdraw_percent(self): """Gets the withdraw_percent of this WithdrawStatus. # noqa: E501 - Withdrawal fee rate percentage. # noqa: E501 + Withdrawal fee rate percentage # noqa: E501 :return: The withdraw_percent of this WithdrawStatus. # noqa: E501 :rtype: str @@ -215,7 +215,7 @@ def withdraw_percent(self): def withdraw_percent(self, withdraw_percent): """Sets the withdraw_percent of this WithdrawStatus. - Withdrawal fee rate percentage. # noqa: E501 + Withdrawal fee rate percentage # noqa: E501 :param withdraw_percent: The withdraw_percent of this WithdrawStatus. # noqa: E501 :type: str @@ -227,7 +227,7 @@ def withdraw_percent(self, withdraw_percent): def withdraw_fix(self): """Gets the withdraw_fix of this WithdrawStatus. # noqa: E501 - Fixed withdrawal fee. # noqa: E501 + Fixed withdrawal fee # noqa: E501 :return: The withdraw_fix of this WithdrawStatus. # noqa: E501 :rtype: str @@ -238,7 +238,7 @@ def withdraw_fix(self): def withdraw_fix(self, withdraw_fix): """Sets the withdraw_fix of this WithdrawStatus. - Fixed withdrawal fee. # noqa: E501 + Fixed withdrawal fee # noqa: E501 :param withdraw_fix: The withdraw_fix of this WithdrawStatus. # noqa: E501 :type: str @@ -250,7 +250,7 @@ def withdraw_fix(self, withdraw_fix): def withdraw_day_limit(self): """Gets the withdraw_day_limit of this WithdrawStatus. # noqa: E501 - Daily allowed withdrawal amount. # noqa: E501 + Daily allowed withdrawal amount # noqa: E501 :return: The withdraw_day_limit of this WithdrawStatus. # noqa: E501 :rtype: str @@ -261,7 +261,7 @@ def withdraw_day_limit(self): def withdraw_day_limit(self, withdraw_day_limit): """Sets the withdraw_day_limit of this WithdrawStatus. - Daily allowed withdrawal amount. # noqa: E501 + Daily allowed withdrawal amount # noqa: E501 :param withdraw_day_limit: The withdraw_day_limit of this WithdrawStatus. # noqa: E501 :type: str @@ -273,7 +273,7 @@ def withdraw_day_limit(self, withdraw_day_limit): def withdraw_amount_mini(self): """Gets the withdraw_amount_mini of this WithdrawStatus. # noqa: E501 - Minimum withdrawal amount. # noqa: E501 + Minimum withdrawal amount # noqa: E501 :return: The withdraw_amount_mini of this WithdrawStatus. # noqa: E501 :rtype: str @@ -284,7 +284,7 @@ def withdraw_amount_mini(self): def withdraw_amount_mini(self, withdraw_amount_mini): """Sets the withdraw_amount_mini of this WithdrawStatus. - Minimum withdrawal amount. # noqa: E501 + Minimum withdrawal amount # noqa: E501 :param withdraw_amount_mini: The withdraw_amount_mini of this WithdrawStatus. # noqa: E501 :type: str @@ -296,7 +296,7 @@ def withdraw_amount_mini(self, withdraw_amount_mini): def withdraw_day_limit_remain(self): """Gets the withdraw_day_limit_remain of this WithdrawStatus. # noqa: E501 - Daily withdrawal amount left. # noqa: E501 + Daily withdrawal amount left # noqa: E501 :return: The withdraw_day_limit_remain of this WithdrawStatus. # noqa: E501 :rtype: str @@ -307,7 +307,7 @@ def withdraw_day_limit_remain(self): def withdraw_day_limit_remain(self, withdraw_day_limit_remain): """Sets the withdraw_day_limit_remain of this WithdrawStatus. - Daily withdrawal amount left. # noqa: E501 + Daily withdrawal amount left # noqa: E501 :param withdraw_day_limit_remain: The withdraw_day_limit_remain of this WithdrawStatus. # noqa: E501 :type: str @@ -319,7 +319,7 @@ def withdraw_day_limit_remain(self, withdraw_day_limit_remain): def withdraw_eachtime_limit(self): """Gets the withdraw_eachtime_limit of this WithdrawStatus. # noqa: E501 - Maximum amount for each withdrawal. # noqa: E501 + Maximum amount for each withdrawal # noqa: E501 :return: The withdraw_eachtime_limit of this WithdrawStatus. # noqa: E501 :rtype: str @@ -330,7 +330,7 @@ def withdraw_eachtime_limit(self): def withdraw_eachtime_limit(self, withdraw_eachtime_limit): """Sets the withdraw_eachtime_limit of this WithdrawStatus. - Maximum amount for each withdrawal. # noqa: E501 + Maximum amount for each withdrawal # noqa: E501 :param withdraw_eachtime_limit: The withdraw_eachtime_limit of this WithdrawStatus. # noqa: E501 :type: str @@ -342,7 +342,7 @@ def withdraw_eachtime_limit(self, withdraw_eachtime_limit): def withdraw_fix_on_chains(self): """Gets the withdraw_fix_on_chains of this WithdrawStatus. # noqa: E501 - Fixed withdrawal fee on multiple chains. # noqa: E501 + Fixed withdrawal fee on multiple chains # noqa: E501 :return: The withdraw_fix_on_chains of this WithdrawStatus. # noqa: E501 :rtype: dict(str, str) @@ -353,7 +353,7 @@ def withdraw_fix_on_chains(self): def withdraw_fix_on_chains(self, withdraw_fix_on_chains): """Sets the withdraw_fix_on_chains of this WithdrawStatus. - Fixed withdrawal fee on multiple chains. # noqa: E501 + Fixed withdrawal fee on multiple chains # noqa: E501 :param withdraw_fix_on_chains: The withdraw_fix_on_chains of this WithdrawStatus. # noqa: E501 :type: dict(str, str) @@ -365,7 +365,7 @@ def withdraw_fix_on_chains(self, withdraw_fix_on_chains): def withdraw_percent_on_chains(self): """Gets the withdraw_percent_on_chains of this WithdrawStatus. # noqa: E501 - Percentage withdrawal fee on multiple chains. # noqa: E501 + Percentage withdrawal fee on multiple chains # noqa: E501 :return: The withdraw_percent_on_chains of this WithdrawStatus. # noqa: E501 :rtype: dict(str, str) @@ -376,7 +376,7 @@ def withdraw_percent_on_chains(self): def withdraw_percent_on_chains(self, withdraw_percent_on_chains): """Sets the withdraw_percent_on_chains of this WithdrawStatus. - Percentage withdrawal fee on multiple chains. # noqa: E501 + Percentage withdrawal fee on multiple chains # noqa: E501 :param withdraw_percent_on_chains: The withdraw_percent_on_chains of this WithdrawStatus. # noqa: E501 :type: dict(str, str) diff --git a/gate_api/models/withdrawal_record.py b/gate_api/models/withdrawal_record.py index 680a75b..ee0cf4c 100644 --- a/gate_api/models/withdrawal_record.py +++ b/gate_api/models/withdrawal_record.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -119,7 +119,7 @@ def __init__(self, id=None, txid=None, block_number=None, withdraw_order_id=None def id(self): """Gets the id of this WithdrawalRecord. # noqa: E501 - Record ID. # noqa: E501 + Record ID # noqa: E501 :return: The id of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -130,7 +130,7 @@ def id(self): def id(self, id): """Sets the id of this WithdrawalRecord. - Record ID. # noqa: E501 + Record ID # noqa: E501 :param id: The id of this WithdrawalRecord. # noqa: E501 :type: str @@ -142,7 +142,7 @@ def id(self, id): def txid(self): """Gets the txid of this WithdrawalRecord. # noqa: E501 - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :return: The txid of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -153,7 +153,7 @@ def txid(self): def txid(self, txid): """Sets the txid of this WithdrawalRecord. - Hash record of the withdrawal. # noqa: E501 + Hash record of the withdrawal # noqa: E501 :param txid: The txid of this WithdrawalRecord. # noqa: E501 :type: str @@ -165,7 +165,7 @@ def txid(self, txid): def block_number(self): """Gets the block_number of this WithdrawalRecord. # noqa: E501 - Block Number. # noqa: E501 + Block Number # noqa: E501 :return: The block_number of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -176,7 +176,7 @@ def block_number(self): def block_number(self, block_number): """Sets the block_number of this WithdrawalRecord. - Block Number. # noqa: E501 + Block Number # noqa: E501 :param block_number: The block_number of this WithdrawalRecord. # noqa: E501 :type: str @@ -211,7 +211,7 @@ def withdraw_order_id(self, withdraw_order_id): def timestamp(self): """Gets the timestamp of this WithdrawalRecord. # noqa: E501 - Operation time. # noqa: E501 + Operation time # noqa: E501 :return: The timestamp of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -222,7 +222,7 @@ def timestamp(self): def timestamp(self, timestamp): """Sets the timestamp of this WithdrawalRecord. - Operation time. # noqa: E501 + Operation time # noqa: E501 :param timestamp: The timestamp of this WithdrawalRecord. # noqa: E501 :type: str @@ -234,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 @@ -245,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 @@ -259,7 +259,7 @@ def amount(self, amount): def fee(self): """Gets the fee of this WithdrawalRecord. # noqa: E501 - fee. # noqa: E501 + fee # noqa: E501 :return: The fee of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -270,7 +270,7 @@ def fee(self): def fee(self, fee): """Sets the fee of this WithdrawalRecord. - fee. # noqa: E501 + fee # noqa: E501 :param fee: The fee of this WithdrawalRecord. # noqa: E501 :type: str @@ -282,7 +282,7 @@ def fee(self, fee): def currency(self): """Gets the currency of this WithdrawalRecord. # noqa: E501 - Currency name. # noqa: E501 + Currency name # noqa: E501 :return: The currency of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -293,7 +293,7 @@ def currency(self): def currency(self, currency): """Sets the currency of this WithdrawalRecord. - Currency name. # noqa: E501 + Currency name # noqa: E501 :param currency: The currency of this WithdrawalRecord. # noqa: E501 :type: str @@ -307,7 +307,7 @@ def currency(self, currency): def address(self): """Gets the address of this WithdrawalRecord. # noqa: E501 - Withdrawal address. # noqa: E501 + Withdrawal address # noqa: E501 :return: The address of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -318,7 +318,7 @@ def address(self): def address(self, address): """Sets the address of this WithdrawalRecord. - Withdrawal address. # noqa: E501 + Withdrawal address # noqa: E501 :param address: The address of this WithdrawalRecord. # noqa: E501 :type: str @@ -330,7 +330,7 @@ def address(self, address): def fail_reason(self): """Gets the fail_reason of this WithdrawalRecord. # noqa: E501 - The reason for withdrawal failure is that there is a value when status = CANCEL, and the rest of the state is empty # 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 @@ -341,7 +341,7 @@ def fail_reason(self): def fail_reason(self, fail_reason): """Sets the fail_reason of this WithdrawalRecord. - The reason for withdrawal failure is that there is a value when status = CANCEL, and the rest of the state is empty # noqa: E501 + 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 @@ -353,7 +353,7 @@ def fail_reason(self, fail_reason): def timestamp2(self): """Gets the timestamp2 of this WithdrawalRecord. # noqa: E501 - The withdrawal end time, i.e.: withdrawal cancel time or withdrawal success time When status = CANCEL, the corresponding cancel time When status = DONE and block_number > 0, it is the # 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 @@ -364,7 +364,7 @@ def timestamp2(self): def timestamp2(self, timestamp2): """Sets the timestamp2 of this WithdrawalRecord. - The withdrawal end time, i.e.: withdrawal cancel time or withdrawal success time When status = CANCEL, the corresponding cancel time When status = DONE and block_number > 0, it is the # 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 :param timestamp2: The timestamp2 of this WithdrawalRecord. # noqa: E501 :type: str @@ -376,7 +376,7 @@ def timestamp2(self, timestamp2): def memo(self): """Gets the memo of this WithdrawalRecord. # noqa: E501 - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :return: The memo of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -387,7 +387,7 @@ def memo(self): def memo(self, memo): """Sets the memo of this WithdrawalRecord. - Additional remarks with regards to the withdrawal. # noqa: E501 + Additional remarks with regards to the withdrawal # noqa: E501 :param memo: The memo of this WithdrawalRecord. # noqa: E501 :type: str @@ -422,7 +422,7 @@ def status(self, status): def chain(self): """Gets the chain of this WithdrawalRecord. # noqa: E501 - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :return: The chain of this WithdrawalRecord. # noqa: E501 :rtype: str @@ -433,7 +433,7 @@ def chain(self): def chain(self, chain): """Sets the chain of this WithdrawalRecord. - Name of the chain used in withdrawals. # noqa: E501 + Name of the chain used in withdrawals # noqa: E501 :param chain: The chain of this WithdrawalRecord. # noqa: E501 :type: str diff --git a/gate_api/rest.py b/gate_api/rest.py index 755fbe1..8781e1b 100644 --- a/gate_api/rest.py +++ b/gate_api/rest.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 diff --git a/setup.py b/setup.py index a0b4e42..d0fc88e 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ """ 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 + Welcome to Gate API APIv4 provides operations related to spot, margin, and contract 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 @@ -13,7 +13,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "gate-api" -VERSION = "6.102.6" +VERSION = "7.1.8" # To install the library, run the following # # python setup.py install